module Puppet::Util::PsychSupport

This module should be included when a class can be serialized to yaml and needs to handle the deserialization from Psych with more control. Psych normally pokes values directly into an instance using `instance_variable_set` which completely bypasses encapsulation.

The class that includes this module must implement an instance method `initialize_from_hash` that is given a hash with attribute to value mappings.

Public Instance Methods

encode_with(psych_encoder) click to toggle source

This method is called from the Psych Yaml serializer The serializer will call this method to create a hash that will be serialized to YAML. Instead of using the object itself during the mapping process we use what is returned by calling `to_data_hash` on the object itself since some of the objects we manage have asymmetrical serialization and deserialization.

   # File lib/puppet/util/psych_support.rb
27 def encode_with(psych_encoder)
28   tag = Psych.dump_tags[self.class] || "!ruby/object:#{self.class.name}"
29   psych_encoder.represent_map(tag, to_data_hash)
30 end

init_with(psych_coder) click to toggle source

This method is called from the Psych Yaml deserializer when it encounters a tag in the form !ruby/object:<class name>.

   # File lib/puppet/util/psych_support.rb
14 def init_with(psych_coder)
15   # The PsychCoder has a hashmap of instance variable name (sans the @ symbol) to values
16   # to set, and can thus directly be fed to initialize_from_hash.
17   #
18   initialize_from_hash(psych_coder.map)
19 end