module PSON

PSON is a vendored version of pure_json v1.1.9 plus puppet patches. It is deprecated and should not be used for future work. Use JSON instead.

@deprecated

Constants

Infinity
MinusInfinity
NaN
PSON_LOADED
UnparserError

This exception is raised, if a generator or unparser error occurs.

VERSION

PSON version

Attributes

create_id[RW]

This is create identifier, that is used to decide, if the pson_create hook of a class should be called. It defaults to 'document_type'.

generator[R]

Returns the PSON generator modul, that is used by PSON. This might be either PSON::Ext::Generator or PSON::Pure::Generator.

parser[R]

Returns the PSON parser class, that is used by PSON. This might be either PSON::Ext::Parser or PSON::Pure::Parser.

state[RW]

Returns the PSON generator state class, that is used by PSON. This might be either PSON::Ext::Generator::State or PSON::Pure::Generator::State.

Public Class Methods

[](object, opts = {}) click to toggle source

If object is string-like parse the string and return the parsed result as a Ruby data structure. Otherwise generate a PSON text from the Ruby data structure object and return it.

The opts argument is passed through to generate/parse respectively, see generate and parse for their documentation.

   # File lib/puppet/external/pson/common.rb
15 def [](object, opts = {})
16   if object.respond_to? :to_str
17     PSON.parse(object.to_str, opts => {})
18   else
19     PSON.generate(object, opts => {})
20   end
21 end
recurse_proc(result, &proc) click to toggle source
    # File lib/puppet/external/pson/common.rb
264 def recurse_proc(result, &proc)
265   case result
266   when Array
267     result.each { |x| recurse_proc x, &proc }
268     proc.call result
269   when Hash
270     result.each { |x, y| recurse_proc x, &proc; recurse_proc y, &proc }
271     proc.call result
272   else
273     proc.call result
274   end
275 end
restore(source, proc = nil)
Alias for: load

Public Instance Methods

dump(obj, anIO = nil, limit = nil) click to toggle source

Dumps obj as a PSON string, i.e. calls generate on the object and returns the result.

If anIO (an IO like object or an object that responds to the write method) was given, the resulting PSON is written to it.

If the number of nested arrays or objects exceeds limit an ArgumentError exception is raised. This argument is similar (but not exactly the same!) to the limit argument in Marshal.dump.

This method is part of the implementation of the load/dump interface of Marshal and YAML.

    # File lib/puppet/external/pson/common.rb
294 def dump(obj, anIO = nil, limit = nil)
295   if anIO and limit.nil?
296     anIO = anIO.to_io if anIO.respond_to?(:to_io)
297     unless anIO.respond_to?(:write)
298       limit = anIO
299       anIO = nil
300     end
301   end
302   limit ||= 0
303   result = generate(obj, :allow_nan => true, :max_nesting => limit)
304   if anIO
305     anIO.write result
306     anIO
307   else
308     result
309   end
310 rescue PSON::NestingError
311   raise ArgumentError, _("exceed depth limit"), $!.backtrace
312 end
encode(to, from, string) click to toggle source
    # File lib/puppet/external/pson/common.rb
319 def encode(to, from, string)
320   string.encode(to, from)
321 end
fast_generate(obj) click to toggle source

Unparse the Ruby data structure obj into a single line PSON string and return it. This method disables the checks for circles in Ruby objects, and also generates NaN, Infinity, and, -Infinity float values.

WARNING: Be careful not to pass any Ruby data structures with circles as obj argument, because this will cause PSON to go into an infinite loop.

    # File lib/puppet/external/pson/common.rb
199 def fast_generate(obj)
200   obj.to_pson(nil)
201 end
generate(obj, state = nil) click to toggle source

Unparse the Ruby data structure obj into a single line PSON string and return it. state is

  • a PSON::State object,

  • or a Hash like object (responding to to_hash),

  • an object convertible into a hash by a to_h method,

that is used as or to configure a State object.

It defaults to a state object, that creates the shortest possible PSON text in one line, checks for circular data structures and doesn't allow NaN, Infinity, and -Infinity.

A state hash can have the following keys:

  • indent: a string used to indent levels (default: ''),

  • space: a string that is put after, a : or , delimiter (default: ''),

  • space_before: a string that is put before a : pair delimiter (default: ''),

  • object_nl: a string that is put at the end of a PSON object (default: ''),

  • array_nl: a string that is put at the end of a PSON array (default: ''),

  • check_circular: true if checking for circular data structures should be done (the default), false otherwise.

  • allow_nan: true if NaN, Infinity, and -Infinity should be generated, otherwise an exception is thrown, if these values are encountered. This options defaults to false.

  • max_nesting: The maximum depth of nesting allowed in the data structures from which PSON is to be generated. Disable depth checking with :max_nesting => false, it defaults to 19.

See also the fast_generate for the fastest creation method with the least amount of sanity checks, and the pretty_generate method for some defaults for a pretty output.

    # File lib/puppet/external/pson/common.rb
177 def generate(obj, state = nil)
178   if state
179     state = State.from_state(state)
180   else
181     state = State.new
182   end
183   obj.to_pson(state)
184 end
load(source, proc = nil) click to toggle source

Load a ruby data structure from a PSON source and return it. A source can either be a string-like object, an IO like object, or an object responding to the read method. If proc was given, it will be called with any nested Ruby object as an argument recursively in depth first order.

This method is part of the implementation of the load/dump interface of Marshal and YAML.

    # File lib/puppet/external/pson/common.rb
251 def load(source, proc = nil)
252   if source.respond_to? :to_str
253     source = source.to_str
254   elsif source.respond_to? :to_io
255     source = source.to_io.read
256   else
257     source = source.read
258   end
259   result = parse(source, :max_nesting => false, :allow_nan => true)
260   recurse_proc(result, &proc) if proc
261   result
262 end
Also aliased as: restore
parse(source, opts = {}) click to toggle source

Parse the PSON string source into a Ruby data structure and return it.

opts can have the following keys:

  • max_nesting: The maximum depth of nesting allowed in the parsed data structures. Disable depth checking with :max_nesting => false, it defaults to 19.

  • allow_nan: If set to true, allow NaN, Infinity and -Infinity in defiance of RFC 4627 to be parsed by the Parser. This option defaults to false.

    # File lib/puppet/external/pson/common.rb
124 def parse(source, opts = {})
125   PSON.parser.new(source, opts).parse
126 end
parse!(source, opts = {}) click to toggle source

Parse the PSON string source into a Ruby data structure and return it. The bang version of the parse method, defaults to the more dangerous values for the opts hash, so be sure only to parse trusted source strings.

opts can have the following keys:

  • max_nesting: The maximum depth of nesting allowed in the parsed data structures. Enable depth checking with :max_nesting => anInteger. The parse! methods defaults to not doing max depth checking: This can be dangerous, if someone wants to fill up your stack.

  • allow_nan: If set to true, allow NaN, Infinity, and -Infinity in defiance of RFC 4627 to be parsed by the Parser. This option defaults to true.

    # File lib/puppet/external/pson/common.rb
140 def parse!(source, opts = {})
141   opts = {
142     :max_nesting => false,
143     :allow_nan => true
144   }.update(opts)
145   PSON.parser.new(source, opts).parse
146 end
pretty_generate(obj, opts = nil) click to toggle source

Unparse the Ruby data structure obj into a PSON string and return it. The returned string is a prettier form of the string returned by unparse.

The opts argument can be used to configure the generator, see the generate method for a more detailed explanation.

    # File lib/puppet/external/pson/common.rb
214 def pretty_generate(obj, opts = nil)
215 
216   state = PSON.state.new(
217 
218     :indent     => '  ',
219     :space      => ' ',
220     :object_nl  => "\n",
221     :array_nl   => "\n",
222 
223     :check_circular => true
224   )
225   if opts
226     if opts.respond_to? :to_hash
227       opts = opts.to_hash
228     elsif opts.respond_to? :to_h
229       opts = opts.to_h
230     else
231       raise TypeError, "can't convert #{opts.class} into Hash"
232     end
233     state.configure(opts)
234   end
235   obj.to_pson(state)
236 end

Private Instance Methods

recurse_proc(result, &proc) click to toggle source
    # File lib/puppet/external/pson/common.rb
264 def recurse_proc(result, &proc)
265   case result
266   when Array
267     result.each { |x| recurse_proc x, &proc }
268     proc.call result
269   when Hash
270     result.each { |x, y| recurse_proc x, &proc; recurse_proc y, &proc }
271     proc.call result
272   else
273     proc.call result
274   end
275 end
restore(source, proc = nil)
Alias for: load