module PSON
Constants
- Infinity
- MinusInfinity
- NaN
- PSON_LOADED
- UnparserError
This exception is raised, if a generator or unparser error occurs.
- VERSION
PSON
version
Attributes
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'.
Returns the PSON
generator modul, that is used by PSON
. This might be either PSON::Ext::Generator or PSON::Pure::Generator
.
Returns the PSON
parser class, that is used by PSON
. This might be either PSON::Ext::Parser or PSON::Pure::Parser
.
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
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/octocatalog-diff/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
# File lib/octocatalog-diff/external/pson/common.rb, line 260 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
Public Instance Methods
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/octocatalog-diff/external/pson/common.rb, line 290 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", $!.backtrace end
# File lib/octocatalog-diff/external/pson/common.rb, line 315 def encode(to, from, string) string.encode(to, from) end
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/octocatalog-diff/external/pson/common.rb, line 195 def fast_generate(obj) obj.to_pson(nil) end
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/octocatalog-diff/external/pson/common.rb, line 173 def generate(obj, state = nil) if state state = State.from_state(state) else state = State.new end obj.to_pson(state) end
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/octocatalog-diff/external/pson/common.rb, line 247 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 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/octocatalog-diff/external/pson/common.rb, line 120 def parse(source, opts = {}) PSON.parser.new(source, opts).parse end
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/octocatalog-diff/external/pson/common.rb, line 136 def parse!(source, opts = {}) opts = { :max_nesting => false, :allow_nan => true }.update(opts) PSON.parser.new(source, opts).parse end
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/octocatalog-diff/external/pson/common.rb, line 210 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
Private Instance Methods
# File lib/octocatalog-diff/external/pson/common.rb, line 260 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