Module: PSON

Defined in:
lib/vendor/puppet/external/pson/pure.rb,
lib/vendor/puppet/external/pson/common.rb,
lib/vendor/puppet/external/pson/version.rb,
lib/vendor/puppet/external/pson/pure/parser.rb,
lib/vendor/puppet/external/pson/pure/generator.rb

Defined Under Namespace

Modules: Pure Classes: CircularDatastructure, GeneratorError, MissingUnicodeSupport, NestingError, PSONError, ParserError

Constant Summary collapse

PSON_LOADED = 
true
NaN = 
(-1.0) ** 0.5
Infinity = 
1.0/0
MinusInfinity = 
-Infinity
UnparserError =

For backwards compatibility

GeneratorError
VERSION =

PSON version

'1.1.9'
VERSION_ARRAY =

:nodoc:

VERSION.split(/\./).map { |x| x.to_i }
VERSION_MAJOR =

:nodoc:

VERSION_ARRAY[0]
VERSION_MINOR =

:nodoc:

VERSION_ARRAY[1]
VERSION_BUILD =

:nodoc:

VERSION_ARRAY[2]
MAP = 
{
  "\x0" => '\u0000',
  "\x1" => '\u0001',
  "\x2" => '\u0002',
  "\x3" => '\u0003',
  "\x4" => '\u0004',
  "\x5" => '\u0005',
  "\x6" => '\u0006',
  "\x7" => '\u0007',
  "\b"  =>  '\b',
  "\t"  =>  '\t',
  "\n"  =>  '\n',
  "\xb" => '\u000b',
  "\f"  =>  '\f',
  "\r"  =>  '\r',
  "\xe" => '\u000e',
  "\xf" => '\u000f',
  "\x10" => '\u0010',
  "\x11" => '\u0011',
  "\x12" => '\u0012',
  "\x13" => '\u0013',
  "\x14" => '\u0014',
  "\x15" => '\u0015',
  "\x16" => '\u0016',
  "\x17" => '\u0017',
  "\x18" => '\u0018',
  "\x19" => '\u0019',
  "\x1a" => '\u001a',
  "\x1b" => '\u001b',
  "\x1c" => '\u001c',
  "\x1d" => '\u001d',
  "\x1e" => '\u001e',
  "\x1f" => '\u001f',
  '"'   =>  '\"',
  '\\'  =>  '\\\\',
}

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.create_id ⇒ Object

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’.



84
85
86
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 84

def create_id
  @create_id
end

.generator ⇒ Object

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



76
77
78
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 76

def generator
  @generator
end

.parser ⇒ Object

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



21
22
23
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 21

def parser
  @parser
end

.state ⇒ Object

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



80
81
82
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 80

def state
  @state
end

Class Method Details

.[](object, opts = {}) ⇒ Object

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.



11
12
13
14
15
16
17
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 11

def [](object, opts = {})
  if object.respond_to? :to_str
    PSON.parse(object.to_str, opts => {})
  else
    PSON.generate(object, opts => {})
  end
end

.deep_const_get(path) ⇒ Object

Return the constant located at path. Anything may be registered as a path by calling register_path, above. Otherwise, the format of path has to be either ::A::B::C or A::B::C. In either of these cases A has to be defined in Object (e.g. the path must be an absolute namespace path. If the constant doesn’t exist at the given path, an ArgumentError is raised.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 45

def deep_const_get(path) # :nodoc:
  path = path.to_s
  registered_document_types[path] || path.split(/::/).inject(Object) do |p, c|
    case
    when c.empty?             then p
    when p.const_defined?(c)  then p.const_get(c)
    else                      raise ArgumentError, "can't find const for unregistered document type #{path}"
    end
  end
end

.dump(obj, anIO = nil, limit = nil) ⇒ Object

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.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 305

def dump(obj, anIO = nil, limit = nil)
  if anIO and limit.nil?
    anIO = anIO.to_io if anIO.respond_to?(:to_io)
    unless anIO.respond_to?(:write)
      limit = anIO
      anIO = nil
    end
  end
  limit ||= 0
  result = generate(obj, :allow_nan => true, :max_nesting => limit)
  if anIO
    anIO.write result
    anIO
  else
    result
  end
rescue PSON::NestingError
  raise ArgumentError, "exceed depth limit"
end

.fast_generate(obj) ⇒ Object Also known as: fast_unparse

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.



210
211
212
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 210

def fast_generate(obj)
  obj.to_pson(nil)
end

.generate(obj, state = nil) ⇒ Object Also known as: unparse

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.



188
189
190
191
192
193
194
195
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 188

def generate(obj, state = nil)
  if state
    state = State.from_state(state)
  else
    state = State.new
  end
  obj.to_pson(state)
end

.load(source, proc = nil) ⇒ Object Also known as: restore

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.



262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 262

def load(source, proc = nil)
  if source.respond_to? :to_str
    source = source.to_str
  elsif source.respond_to? :to_io
    source = source.to_io.read
  else
    source = source.read
  end
  result = parse(source, :max_nesting => false, :allow_nan => true)
  recurse_proc(result, &proc) if proc
  result
end

.parse(source, opts = {}) ⇒ Object

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.

  • create_additions: If set to false, the Parser doesn’t create additions even if a matchin class and create_id was found. This option defaults to true.



132
133
134
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 132

def parse(source, opts = {})
  PSON.parser.new(source, opts).parse
end

.parse!(source, opts = {}) ⇒ Object

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.

  • create_additions: If set to false, the Parser doesn’t create additions even if a matchin class and create_id was found. This option defaults to true.



151
152
153
154
155
156
157
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 151

def parse!(source, opts = {})
  opts = {
    :max_nesting => false,
    :allow_nan => true
  }.update(opts)
  PSON.parser.new(source, opts).parse
end

.pretty_generate(obj, opts = nil) ⇒ Object Also known as: pretty_unparse

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.



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 225

def pretty_generate(obj, opts = nil)

  state = PSON.state.new(

    :indent     => '  ',
    :space      => ' ',
    :object_nl  => "\n",
    :array_nl   => "\n",

    :check_circular => true
  )
  if opts
    if opts.respond_to? :to_hash
      opts = opts.to_hash
    elsif opts.respond_to? :to_h
      opts = opts.to_h
    else
      raise TypeError, "can't convert #{opts.class} into Hash"
    end
    state.configure(opts)
  end
  obj.to_pson(state)
end

.recurse_proc(result, &proc) ⇒ Object 



275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 275

def recurse_proc(result, &proc)
  case result
  when Array
    result.each { |x| recurse_proc x, &proc }
    proc.call result
  when Hash
    result.each { |x, y| recurse_proc x, &proc; recurse_proc y, &proc }
    proc.call result
  else
    proc.call result
  end
end

.register_document_type(name, klass) ⇒ Object

Register a class-constant for deserializaion.



35
36
37
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 35

def register_document_type(name,klass)
  registered_document_types[name.to_s] = klass
end

.registered_document_types ⇒ Object 



30
31
32
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 30

def registered_document_types
  @registered_document_types ||= {}
end

.utf8_to_pson(string) ⇒ Object

:nodoc:



42
43
44
45
46
47
48
49
50
 
# File 'lib/vendor/puppet/external/pson/pure/generator.rb', line 42

def utf8_to_pson(string) # :nodoc:
  string = string.dup
  string << '' # XXX workaround: avoid buffer sharing
  string.force_encoding(Encoding::ASCII_8BIT)
  string.gsub!(/["\\\x0-\x1f]/) { MAP[$MATCH] }
  string
rescue => e
  raise GeneratorError, "Caught #{e.class}: #{e}"
end

Instance Method Details

#encode(to, from, string) ⇒ Object 



330
331
332
 
# File 'lib/vendor/puppet/external/pson/common.rb', line 330

def encode(to, from, string)
  string.encode(to, from)
end