diff options
author | naruse <naruse@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2007-07-07 17:15:30 +0000 |
---|---|---|
committer | naruse <naruse@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2007-07-07 17:15:30 +0000 |
commit | 322003ef8f2c36d24f1d009eda5408102f5658ae (patch) | |
tree | a7a8a5c2ed9fc9c94759cb02fc9a789d9885387e /lib | |
parent | acbffce267b63bb06281f3ebe6a8bb0d897d4566 (diff) | |
download | ruby-322003ef8f2c36d24f1d009eda5408102f5658ae.tar.gz |
* lib/json.rb, lib/json/, ext/json/:
import JSON 1.1.1
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@12723 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
-rw-r--r-- | lib/json.rb | 23 | ||||
-rw-r--r-- | lib/json/common.rb | 189 | ||||
-rw-r--r-- | lib/json/pure/generator.rb | 93 | ||||
-rw-r--r-- | lib/json/pure/parser.rb | 16 | ||||
-rw-r--r-- | lib/json/version.rb | 2 |
5 files changed, 284 insertions, 39 deletions
diff --git a/lib/json.rb b/lib/json.rb index 1700e0654b..bb711c1724 100644 --- a/lib/json.rb +++ b/lib/json.rb @@ -47,6 +47,27 @@ require 'json/common' # # * http://json.rubyforge.org # +# == Usage +# +# To use JSON you can +# require 'json' +# to load the installed variant (either the extension 'json' or the pure +# variant 'json_pure'). If you have installed the extension variant, you can +# pick either the extension variant or the pure variant by typing +# require 'json/ext' +# or +# require 'json/pure' +# +# You can choose to load a set of common additions to ruby core's objects if +# you +# require 'json/add/core' +# +# To get the best compatibility to rails' JSON implementation, you can +# require 'json/add/rails' +# +# Both of the additions attempt to require 'json' (like above) first, if it has +# not been required yet. +# # == Speed Comparisons # # I have created some benchmark results (see the benchmarks subdir of the @@ -207,4 +228,6 @@ module JSON require 'json/pure' end end + + JSON_LOADED = true end diff --git a/lib/json/common.rb b/lib/json/common.rb index 0967aed8c2..c988677a1d 100644 --- a/lib/json/common.rb +++ b/lib/json/common.rb @@ -2,14 +2,17 @@ require 'json/version' module JSON class << self - # If object is string like parse the string and return the parsed result as a - # Ruby data structure. Otherwise generate a JSON text from the Ruby data - # structure object and return it. - def [](object) + # If _object_ is string like parse the string and return the parsed result + # as a Ruby data structure. Otherwise generate a JSON 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. + def [](object, opts = {}) if object.respond_to? :to_str - JSON.parse(object.to_str) + JSON.parse(object.to_str, opts => {}) else - JSON.generate(object) + JSON.generate(object, opts => {}) end end @@ -71,6 +74,12 @@ module JSON end self.create_id = 'json_class' + NaN = (-1.0) ** 0.5 + + Infinity = 1.0/0 + + MinusInfinity = -Infinity + # The base exception for JSON errors. class JSONError < StandardError; end @@ -101,45 +110,79 @@ module JSON # _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. This value - # defaults to 19. + # 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. def parse(source, opts = {}) JSON.parser.new(source, opts).parse end # Parse the JSON 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: + # _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. def parse!(source, opts = {}) opts = { - :max_nesting => false + :max_nesting => false, + :allow_nan => true }.update(opts) JSON.parser.new(source, opts).parse end # Unparse the Ruby data structure _obj_ into a single line JSON string and - # return it. _state_ is a JSON::State object, that can be used to configure - # the output further. + # return it. _state_ is + # * a JSON::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 JSON text - # in one line and only checks for circular data structures. If you are sure, - # that the objects don't contain any circles, you can set _state_ to nil, to - # disable these checks in order to create the JSON text faster. See also - # fast_generate. - def generate(obj, state = JSON.state.new) + # 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 JSON object (default: ''), + # * *array_nl*: a string that is put at the end of a JSON 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. + # + # 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. + def generate(obj, state = nil) + if state + state = State.from_state(state) + else + state = State.new + end obj.to_json(state) end + # :stopdoc: + # I want to deprecate these later, so I'll first be silent about them, and later delete them. alias unparse generate module_function :unparse + # :startdoc: # Unparse the Ruby data structure _obj_ into a single line JSON string and - # return it. This method disables the checks for circles in Ruby objects. + # 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 JSON to go into an infinite loop. @@ -147,12 +190,18 @@ module JSON obj.to_json(nil) end + # :stopdoc: + # I want to deprecate these later, so I'll first be silent about them, and later delete them. alias fast_unparse fast_generate module_function :fast_unparse + # :startdoc: # Unparse the Ruby data structure _obj_ into a JSON string and return it. The # returned string is a prettier form of the string returned by #unparse. - def pretty_generate(obj) + # + # The _opts_ argument can be used to configure the generator, see the + # generate method for a more detailed explanation. + def pretty_generate(obj, opts = nil) state = JSON.state.new( :indent => ' ', :space => ' ', @@ -160,11 +209,94 @@ module JSON :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_json(state) end + # :stopdoc: + # I want to deprecate these later, so I'll first be silent about them, and later delete them. alias pretty_unparse pretty_generate module_function :pretty_unparse + # :startdoc: + + # Load a ruby data structure from a JSON _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. + 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 + + 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 + private :recurse_proc + module_function :recurse_proc + + alias restore load + module_function :restore + + # Dumps _obj_ as a JSON 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 JSON 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. + 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 JSON::NestingError + raise ArgumentError, "exceed depth limit" + end end module ::Kernel @@ -172,7 +304,7 @@ module ::Kernel # one line. def j(*objs) objs.each do |obj| - puts JSON::generate(obj) + puts JSON::generate(obj, :allow_nan => true, :max_nesting => false) end nil end @@ -181,19 +313,22 @@ module ::Kernel # indentation and over many lines. def jj(*objs) objs.each do |obj| - puts JSON::pretty_generate(obj) + puts JSON::pretty_generate(obj, :allow_nan => true, :max_nesting => false) end nil end - # If object is string like parse the string and return the parsed result as a - # Ruby data structure. Otherwise generate a JSON text from the Ruby data + # If _object_ is string like parse the string and return the parsed result as + # a Ruby data structure. Otherwise generate a JSON text from the Ruby data # structure object and return it. - def JSON(object) + # + # The _opts_ argument is passed through to generate/parse respectively, see + # generate and parse for their documentation. + def JSON(object, opts = {}) if object.respond_to? :to_str - JSON.parse(object.to_str) + JSON.parse(object.to_str, opts) else - JSON.generate(object) + JSON.generate(object, opts) end end end diff --git a/lib/json/pure/generator.rb b/lib/json/pure/generator.rb index 498d78a660..0fe73be41a 100644 --- a/lib/json/pure/generator.rb +++ b/lib/json/pure/generator.rb @@ -89,15 +89,22 @@ module JSON # * *object_nl*: a string that is put at the end of a JSON object (default: ''), # * *array_nl*: a string that is put at the end of a JSON array (default: ''), # * *check_circular*: true if checking for circular data structures + # should be done (the default), false otherwise. + # * *check_circular*: true if checking for circular data structures # should be done, false (the default) 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. def initialize(opts = {}) - @indent = opts[:indent] || '' - @space = opts[:space] || '' - @space_before = opts[:space_before] || '' - @object_nl = opts[:object_nl] || '' - @array_nl = opts[:array_nl] || '' - @check_circular = !!(opts[:check_circular] || false) - @seen = {} + @seen = {} + @indent = '' + @space = '' + @space_before = '' + @object_nl = '' + @array_nl = '' + @check_circular = true + @allow_nan = false + configure opts end # This string is used to indent levels in the JSON text. @@ -117,12 +124,29 @@ module JSON # This string is put at the end of a line that holds a JSON array. attr_accessor :array_nl + # This integer returns the maximum level of data structure nesting in + # the generated JSON, max_nesting = 0 if no maximum is checked. + attr_accessor :max_nesting + + def check_max_nesting(depth) # :nodoc: + return if @max_nesting.zero? + current_nesting = depth + 1 + current_nesting > @max_nesting and + raise NestingError, "nesting of #{current_nesting} is too deep" + end + # Returns true, if circular data structures should be checked, # otherwise returns false. def check_circular? @check_circular end + # Returns true if NaN, Infinity, and -Infinity should be considered as + # valid JSON and output. + def allow_nan? + @allow_nan + end + # Returns _true_, if _object_ was already seen during this generating # run. def seen?(object) @@ -139,6 +163,36 @@ module JSON def forget(object) @seen.delete object.__id__ end + + # Configure this State instance with the Hash _opts_, and return + # itself. + def configure(opts) + @indent = opts[:indent] if opts.key?(:indent) + @space = opts[:space] if opts.key?(:space) + @space_before = opts[:space_before] if opts.key?(:space_before) + @object_nl = opts[:object_nl] if opts.key?(:object_nl) + @array_nl = opts[:array_nl] if opts.key?(:array_nl) + @check_circular = !!opts[:check_circular] if opts.key?(:check_circular) + @allow_nan = !!opts[:allow_nan] if opts.key?(:allow_nan) + if !opts.key?(:max_nesting) # defaults to 19 + @max_nesting = 19 + elsif opts[:max_nesting] + @max_nesting = opts[:max_nesting] + else + @max_nesting = 0 + end + self + end + + # Returns the configuration instance variables as a hash, that can be + # passed to the configure method. + def to_h + result = {} + for iv in %w[indent space space_before object_nl array_nl check_circular allow_nan max_nesting] + result[iv.intern] = instance_variable_get("@#{iv}") + end + result + end end module GeneratorMethods @@ -158,6 +212,7 @@ module JSON def to_json(state = nil, depth = 0, *) if state state = JSON.state.from_state(state) + state.check_max_nesting(depth) json_check_circular(state) { json_transform(state, depth) } else json_transform(state, depth) @@ -167,7 +222,7 @@ module JSON private def json_check_circular(state) - if state + if state and state.check_circular? state.seen?(self) and raise JSON::CircularDatastructure, "circular data structures not supported!" state.remember self @@ -211,6 +266,7 @@ module JSON def to_json(state = nil, depth = 0, *) if state state = JSON.state.from_state(state) + state.check_max_nesting(depth) json_check_circular(state) { json_transform(state, depth) } else json_transform(state, depth) @@ -220,7 +276,7 @@ module JSON private def json_check_circular(state) - if state + if state and state.check_circular? state.seen?(self) and raise JSON::CircularDatastructure, "circular data structures not supported!" state.remember self @@ -257,7 +313,24 @@ module JSON module Float # Returns a JSON string representation for this Float number. - def to_json(*) to_s end + def to_json(state = nil, *) + case + when infinite? + if !state || state.allow_nan? + to_s + else + raise GeneratorError, "#{self} not allowed in JSON" + end + when nan? + if !state || state.allow_nan? + to_s + else + raise GeneratorError, "#{self} not allowed in JSON" + end + else + to_s + end + end end module String diff --git a/lib/json/pure/parser.rb b/lib/json/pure/parser.rb index 6118fe489e..4d63464320 100644 --- a/lib/json/pure/parser.rb +++ b/lib/json/pure/parser.rb @@ -19,6 +19,9 @@ module JSON (?i:e[+-]?\d+) ) )/x + NAN = /NaN/ + INFINITY = /Infinity/ + MINUS_INFINITY = /-Infinity/ OBJECT_OPEN = /\{/ OBJECT_CLOSE = /\}/ ARRAY_OPEN = /\[/ @@ -50,7 +53,11 @@ module JSON # It will be configured by the _opts_ hash. _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. + # structures. Disable depth checking with :max_nesting => false|nil|0, + # 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. def initialize(source, opts = {}) super if !opts.key?(:max_nesting) # defaults to 19 @@ -60,6 +67,7 @@ module JSON else @max_nesting = 0 end + @allow_nan = !!opts[:allow_nan] @create_id = JSON.create_id end @@ -153,6 +161,12 @@ module JSON obj = parse_object @current_nesting -= 1 obj + when @allow_nan && scan(NAN) + NaN + when @allow_nan && scan(INFINITY) + Infinity + when @allow_nan && scan(MINUS_INFINITY) + MinusInfinity else UNPARSED end diff --git a/lib/json/version.rb b/lib/json/version.rb index 464bb60ee3..2e12c8c9e0 100644 --- a/lib/json/version.rb +++ b/lib/json/version.rb @@ -1,6 +1,6 @@ module JSON # JSON version - VERSION = '1.1.0' + VERSION = '1.1.1' VERSION_ARRAY = VERSION.split(/\./).map { |x| x.to_i } # :nodoc: VERSION_MAJOR = VERSION_ARRAY[0] # :nodoc: VERSION_MINOR = VERSION_ARRAY[1] # :nodoc: |