json 3.0.1 → 3.1.0

data/lib/json/truffle_ruby/generator.rb

@@ -112,6 +112,8 @@ module JSON
       # while generating a JSON text from a Ruby data structure.
       class State
         singleton_class.attr_accessor :default_sort_keys_proc # :nodoc:
+        singleton_class.attr_accessor :rfc8785_number_formatter_proc # :nodoc:
+        singleton_class.attr_accessor :rfc8785_sort_keys_proc # :nodoc:
 
         def self.generate(obj, opts = nil, io = nil)
           new(opts).generate(obj, io)
@@ -125,7 +127,7 @@ module JSON
           if opts
             case
             when self === opts
-              return opts
+              return opts.validate_rfc8785
             when opts.respond_to?(:to_hash)
               return new(opts.to_hash)
             when opts.respond_to?(:to_h)
@@ -168,6 +170,7 @@ module JSON
           @max_nesting           = 100
           @sort_keys             = false
           @allow_duplicate_key   = false
+          @rfc8785               = false
           _configure(**opts) if opts
         end
 
@@ -189,7 +192,16 @@ module JSON
         attr_accessor :array_nl
 
         # This proc converts unsupported types into native JSON types.
-        attr_accessor :as_json
+        attr_reader :as_json
+
+        def as_json=(value)
+          raise FrozenError, "can't modify frozen #{self.class}: #{inspect}" if frozen?
+          value = value.to_proc if !(Proc === value) && value.respond_to?(:to_proc)
+          unless Proc === value
+            raise TypeError, "as_json must be a Proc"
+          end
+          @as_json = value
+        end
 
         # This integer returns the maximum level of data structure nesting in
         # the generated JSON, max_nesting = 0 if no maximum is checked.
@@ -209,6 +221,9 @@ module JSON
         # desired order.
         attr_reader :sort_keys
 
+        # Controls whether RFC8785 (canonicalization) mode is enabled. Otherwise returns false.
+        attr_writer :rfc8785
+
         def sort_keys=(value) # :nodoc:
           type_error = false
           @sort_keys = case value
@@ -288,6 +303,27 @@ module JSON
           @strict
         end
 
+        # Returns true, if RFC8785 (canonicalization) mode is enabled. Otherwise returns false.
+        def rfc8785?
+          @rfc8785
+        end
+
+        def validate_rfc8785 # :nodoc:
+          if @rfc8785
+            option = if !@indent.empty? then :indent
+                     elsif !@space.empty? then :space
+                     elsif !@space_before.empty? then :space_before
+                     elsif !@object_nl.empty? then :object_nl
+                     elsif !@array_nl.empty? then :array_nl
+                     elsif @ascii_only then :ascii_only
+                     elsif @script_safe then :script_safe
+                     elsif @allow_nan then :allow_nan
+                     end
+            raise ArgumentError, "#{option} cannot be used with rfc8785" if option
+          end
+          self
+        end
+
         # Configure this State instance with the Hash _opts_, and return
         # itself.
         def configure(options)
@@ -302,10 +338,13 @@ module JSON
         end
         alias merge configure
 
+        # Defaults are the current values so that #configure only writes what it was given.
         private def _configure(
-          indent: '', space: '', space_before: '', object_nl: '', array_nl: '', allow_nan: false,
-          as_json: false, ascii_only: false, sort_keys: false, depth: 0, buffer_initial_length: 1024,
-          allow_duplicate_key: false, script_safe: false, strict: false, max_nesting: 100
+          indent: @indent, space: @space, space_before: @space_before, object_nl: @object_nl,
+          array_nl: @array_nl, allow_nan: @allow_nan, as_json: @as_json, ascii_only: @ascii_only,
+          sort_keys: @sort_keys, depth: @depth, buffer_initial_length: @buffer_initial_length,
+          allow_duplicate_key: @allow_duplicate_key, script_safe: @script_safe, strict: @strict,
+          max_nesting: @max_nesting, rfc8785: @rfc8785
         )
           if depth.negative?
             raise ArgumentError, "depth must be >= 0 (got #{depth})"
@@ -321,7 +360,11 @@ module JSON
           @object_nl = object_nl || ''
           @array_nl = array_nl || ''
           @allow_nan = allow_nan || false
-          @as_json = as_json || false
+          if as_json
+            self.as_json = as_json
+          else
+            @as_json = false
+          end
           @ascii_only = ascii_only || false
           self.sort_keys = sort_keys
           @depth = depth
@@ -330,7 +373,9 @@ module JSON
           @script_safe = script_safe
           @strict = strict
           @max_nesting = max_nesting || 0
-          self
+          self.rfc8785 = rfc8785
+
+          validate_rfc8785
         end
 
         def allow_duplicate_key? # :nodoc:
@@ -340,13 +385,24 @@ module JSON
         # Returns the configuration instance variables as a hash, that can be
         # passed to the configure method.
         def to_h
-          result = {}
-          instance_variables.each do |iv|
-            key = iv.to_s[1..-1]
-            result[key.to_sym] = instance_variable_get(iv)
-          end
-
-          result
+          {
+            indent: @indent,
+            space: @space,
+            space_before: @space_before,
+            object_nl: @object_nl,
+            array_nl: @array_nl,
+            as_json: @as_json,
+            allow_nan: @allow_nan,
+            ascii_only: @ascii_only,
+            max_nesting: @max_nesting,
+            script_safe: @script_safe,
+            strict: @strict,
+            depth: @depth,
+            buffer_initial_length: @buffer_initial_length,
+            sort_keys: @sort_keys,
+            allow_duplicate_key: @allow_duplicate_key,
+            rfc8785: @rfc8785,
+          }
         end
 
         alias to_hash to_h
@@ -359,16 +415,14 @@ module JSON
           return dup.generate(obj, anIO) if frozen?
 
           depth = @depth
+          validate_rfc8785
           if @indent.empty? and @space.empty? and @space_before.empty? and @object_nl.empty? and @array_nl.empty? and
               !@ascii_only and !@script_safe and @max_nesting == 0 and (!@strict || Symbol === obj) and !@sort_keys
             result = generate_json(obj, ''.dup)
           else
-            if @sort_keys
-              obj = @sort_keys.call(obj)
-            end
-
             result = obj.to_json(self)
           end
+
           JSON::TruffleRuby::Generator.valid_utf8?(result) or raise GeneratorError.new(
             "source sequence #{result.inspect} is illegal/malformed utf-8",
             obj
@@ -390,6 +444,11 @@ module JSON
             buf << '{'
             first = true
             key_type = nil
+            if @rfc8785
+              obj = State.rfc8785_sort_keys_proc.call(obj, @strict && @as_json)
+            elsif @sort_keys
+              obj = @sort_keys.call(obj)
+            end
             obj.each_pair do |k,v|
               if first
                 key_type = k.class
@@ -431,7 +490,7 @@ module JSON
               buf << obj.to_json(self)
             end
           when Integer
-            buf << obj.to_s
+            buf << (@rfc8785 ? State.rfc8785_number_formatter_proc.call(obj) : obj.to_s)
           when Symbol
             if @strict
               fast_serialize_string(obj.name, buf)
@@ -500,10 +559,12 @@ module JSON
           def to_json(state = nil, *)
             state = State.from_state(state)
             depth = state.depth
-            state.check_max_nesting
-            json_transform(state)
-          ensure
-            state.depth = depth
+            begin
+              state.check_max_nesting
+              json_transform(state)
+            ensure
+              state.depth = depth
+            end
           end
 
           private
@@ -521,13 +582,21 @@ module JSON
             first = true
             key_type = nil
             indent = !state.object_nl.empty?
-            each { |key, value|
+            hash = self
+
+            if state.rfc8785?
+              hash = State.rfc8785_sort_keys_proc.call(hash, state.strict? && state.as_json)
+            elsif state.sort_keys
+              hash = state.sort_keys.call(hash)
+            end
+
+            hash.each { |key, value|
               if first
                 key_type = key.class
               else
                 if key_type && !state.allow_duplicate_key? && key_type != key.class
                   key_type = nil # stop checking
-                  JSON.send(:on_mixed_keys_hash, self)
+                  JSON.send(:on_mixed_keys_hash, hash)
                 end
                 result << delim
               end
@@ -592,10 +661,12 @@ module JSON
           def to_json(state = nil, *)
             state = State.from_state(state)
             depth = state.depth
-            state.check_max_nesting
-            json_transform(state)
-          ensure
-            state.depth = depth
+            begin
+              state.check_max_nesting
+              json_transform(state)
+            ensure
+              state.depth = depth
+            end
           end
 
           private
@@ -648,13 +719,20 @@ module JSON
 
         module Integer
           # Returns a JSON string representation for this Integer number.
-          def to_json(*) to_s end
+          def to_json(state = nil, *)
+            if state && State.from_state(state).rfc8785?
+              State.rfc8785_number_formatter_proc.call(self)
+            else
+              to_s
+            end
+          end
         end
 
         module Float
           # Returns a JSON string representation for this Float number.
           def to_json(state = nil, *args)
             state = State.from_state(state)
+
             if infinite? || nan?
               if state.allow_nan?
                 to_s
@@ -676,6 +754,8 @@ module JSON
               else
                 raise GeneratorError.new("#{self} not allowed in JSON", self)
               end
+            elsif state.rfc8785?
+              State.rfc8785_number_formatter_proc.call(self)
             else
               to_s
             end

data/lib/json/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JSON
-  VERSION = '3.0.1'
+  VERSION = '3.1.0'
 end

data/lib/json.rb

@@ -44,13 +44,13 @@ require 'json/common'
 #
 # You can parse a \String containing \JSON data using
 # either of two methods:
-# - <tt>JSON.parse(source, opts)</tt>
-# - <tt>JSON.parse!(source, opts)</tt>
+# - <tt>JSON.parse(source, **opts)</tt>
+# - <tt>JSON.parse!(source, **opts)</tt>
 #
 # where
 # - +source+ is a Ruby object.
-# - +opts+ is a \Hash object containing options
-#   that control both input allowed and output formatting.
+# - +opts+ are keyword arguments that control both input
+#   allowed and output formatting.
 #
 # The difference between the two methods
 # is that JSON.parse! omits some checks
@@ -102,7 +102,7 @@ require 'json/common'
 #   ruby # => 1.0
 #   ruby.class # => Float
 #   ruby = JSON.parse('2.0e2')
-#   ruby # => 200
+#   ruby # => 200.0
 #   ruby.class # => Float
 # Boolean:
 #   ruby = JSON.parse('true')
@@ -131,10 +131,10 @@ require 'json/common'
 #   ruby # => [0, [1, [2, [3]]]]
 # Too deep:
 #   # Raises JSON::NestingError (nesting of 2 is too deep):
-#   JSON.parse(source, {max_nesting: 1})
+#   JSON.parse(source, max_nesting: 1)
 # Bad value:
-#   # Raises TypeError (wrong argument type Symbol (expected Fixnum)):
-#   JSON.parse(source, {max_nesting: :foo})
+#   # Raises TypeError (no implicit conversion of Symbol into Integer):
+#   JSON.parse(source, max_nesting: :foo)
 #
 # ---
 #
@@ -142,11 +142,11 @@ require 'json/common'
 # should be ignored or cause an error to be raised:
 #
 # When set to +false+, the default:
-#   JSON.parse('{"a": 1, "a":2}') => duplicate key at line 1 column 1 (JSON::ParserError)
+#   JSON.parse('{"a": 1, "a": 2}') # duplicate key "a" at line 1 column 1 (JSON::ParserError)
 #
 # When set to +true+:
 #   # The last value is used.
-#   JSON.parse('{"a": 1, "a":2}', allow_duplicate_key: true) => {"a" => 2}
+#   JSON.parse('{"a": 1, "a": 2}', allow_duplicate_key: true) # => {"a" => 2}
 #
 # ---
 #
@@ -155,15 +155,15 @@ require 'json/common'
 # defaults to +false+.
 #
 # With the default, +false+:
-#   # Raises JSON::ParserError (225: unexpected token at '[NaN]'):
+#   # Raises JSON::ParserError (unexpected token 'NaN]' at line 1 column 2):
 #   JSON.parse('[NaN]')
-#   # Raises JSON::ParserError (232: unexpected token at '[Infinity]'):
+#   # Raises JSON::ParserError (unexpected token 'Infinity]' at line 1 column 2):
 #   JSON.parse('[Infinity]')
-#   # Raises JSON::ParserError (248: unexpected token at '[-Infinity]'):
+#   # Raises JSON::ParserError (invalid number: '-Infinity]' at line 1 column 2):
 #   JSON.parse('[-Infinity]')
 # Allow:
 #   source = '[NaN, Infinity, -Infinity]'
-#   ruby = JSON.parse(source, {allow_nan: true})
+#   ruby = JSON.parse(source, allow_nan: true)
 #   ruby # => [NaN, Infinity, -Infinity]
 #
 # ---
@@ -185,10 +185,10 @@ require 'json/common'
 # defaults to +false+.
 #
 # When set to +false+, the default:
-#   JSON.parse('/* comment */ {"a": 1, "a":2}') # unexpected character: '/' at line 1 column 1 (JSON::ParserError)
+#   JSON.parse('/* comment */ {"a": 1, "a": 2}') # unexpected token '/*' at line 1 column 1 (JSON::ParserError)
 #
 # When set to +true+, comments are ignored:
-#   JSON.parse('/* comment */ {"a": 1, "a":2} // more comment') # => {"a" => 2}
+#   JSON.parse('/* comment */ {"a": 1} // more comment', allow_comments: true) # => {"a" => 1}
 #
 # ---
 #
@@ -197,7 +197,7 @@ require 'json/common'
 # defaults to +false+.
 #
 # With the default, +false+:
-#   JSON.parse(%{"Hello\nWorld"}) # invalid ASCII control character in string (JSON::ParserError)
+#   JSON.parse(%{"Hello\nWorld"}) # invalid ASCII control character in string: \nWorld" at line 2 column 0 (JSON::ParserError)
 #
 # When enabled:
 #   JSON.parse(%{"Hello\nWorld"}, allow_control_characters: true) # => "Hello\nWorld"
@@ -209,7 +209,7 @@ require 'json/common'
 # defaults to +false+.
 #
 # With the default, +false+:
-#   JSON.parse('"Hell\o"') # invalid escape character in string (JSON::ParserError)
+#   JSON.parse('"Hell\o"') # invalid escape character in string: '\o"' at line 1 column 6 (JSON::ParserError)
 #
 # When enabled:
 #   JSON.parse('"Hell\o"', allow_invalid_escape: true) # => "Hello"
@@ -228,8 +228,8 @@ require 'json/common'
 #   ruby = JSON.parse(source)
 #   ruby # => {"a"=>"foo", "b"=>1.0, "c"=>true, "d"=>false, "e"=>nil}
 # Use Symbols:
-#   ruby = JSON.parse(source, {symbolize_names: true})
-#   ruby # => {:a=>"foo", :b=>1.0, :c=>true, :d=>false, :e=>nil}
+#   ruby = JSON.parse(source, symbolize_names: true)
+#   ruby # => {a: "foo", b: 1.0, c: true, d: false, e: nil}
 #
 # ---
 #
@@ -242,7 +242,7 @@ require 'json/common'
 #   ruby = JSON.parse(source)
 #   ruby.class # => Hash
 # Use class \OpenStruct:
-#   ruby = JSON.parse(source, {object_class: OpenStruct})
+#   ruby = JSON.parse(source, object_class: OpenStruct)
 #   ruby # => #<OpenStruct a="foo", b=1.0, c=true, d=false, e=nil>
 #
 # ---
@@ -256,8 +256,8 @@ require 'json/common'
 #   ruby = JSON.parse(source)
 #   ruby.class # => Array
 # Use class \Set:
-#   ruby = JSON.parse(source, {array_class: Set})
-#   ruby # => #<Set: {"foo", 1.0, true, false, nil}>
+#   ruby = JSON.parse(source, array_class: Set)
+#   ruby # => Set["foo", 1.0, true, false, nil]
 #
 # === Generating \JSON
 #
@@ -319,22 +319,22 @@ require 'json/common'
 # a \String containing a \JSON string representation of the source:
 #   JSON.generate(:foo) # => '"foo"'
 #   JSON.generate(Complex(0, 0)) # => '"0+0i"'
-#   JSON.generate(Dir.new('.')) # => '"#<Dir>"'
+#   JSON.generate(Dir.new('.')) # => '"#<Dir:0x...>"'
 #
 # ==== Generating Options
 #
 # ====== Input Options
 #
 # Option +allow_nan+ (boolean) specifies whether
-# +NaN+, +Infinity+, and <tt>-Infinity</tt> may be generated;
+# +NaN+, +Infinity+, and +-Infinity+ may be generated;
 # defaults to +false+.
 #
 # With the default, +false+:
-#   # Raises JSON::GeneratorError (920: NaN not allowed in JSON):
+#   # Raises JSON::GeneratorError (NaN not allowed in JSON):
 #   JSON.generate(JSON::NaN)
-#   # Raises JSON::GeneratorError (917: Infinity not allowed in JSON):
+#   # Raises JSON::GeneratorError (Infinity not allowed in JSON):
 #   JSON.generate(JSON::Infinity)
-#   # Raises JSON::GeneratorError (917: -Infinity not allowed in JSON):
+#   # Raises JSON::GeneratorError (-Infinity not allowed in JSON):
 #   JSON.generate(JSON::MinusInfinity)
 #
 # Allow:
@@ -345,14 +345,14 @@ require 'json/common'
 #
 # Option +allow_duplicate_key+ (boolean) specifies whether
 # hashes with duplicate keys should be allowed or produce an error.
-# defaults to emit a deprecation warning.
+# Defaults to +false+, which raises an error.
 #
-# With the default, <tt>false</tt>:
-#   JSON.generate({ foo: 1, "foo" => 2 })
+# With the default, +false+:
+#   JSON.generate({foo: 1, "foo" => 2})
 #   # detected duplicate key "foo" in {foo: 1, "foo" => 2} (JSON::GeneratorError)
 #
-# With <tt>true</tt>
-#   JSON.generate({ foo: 1, "foo" => 2 }, allow_duplicate_key: true)
+# With +true+:
+#   JSON.generate({foo: 1, "foo" => 2}, allow_duplicate_key: true)
 #   # => '{"foo":1,"foo":2}'
 #
 # ---
@@ -365,13 +365,13 @@ require 'json/common'
 #   JSON.generate(obj) # => '[[[[[[0]]]]]]'
 #
 # Too deep:
-#   # Raises JSON::NestingError (nesting of 2 is too deep):
+#   # Raises JSON::NestingError (nesting of 2 is too deep. Did you try to serialize objects with circular references?):
 #   JSON.generate(obj, max_nesting: 2)
 #
 # With +false+:
 #   obj = []
 #   obj[0] = obj
-#   # Raises  SystemStackError: stack level too deep
+#   # Raises SystemStackError (stack level too deep):
 #   JSON.generate(obj, max_nesting: false)
 #
 # Setting +max_nesting+ to +false+ or a very large number can lead to a stack overflow
@@ -410,10 +410,18 @@ require 'json/common'
 #   inserted before the colon in each \JSON object's pair;
 #   defaults to the empty \String, <tt>''</tt>.
 # - Option +sort_keys+ (boolean or \Proc) controls whether and how the keys of a
-#   hash are sorted when generating the output; defaults to <tt>false</tt>.
+#   hash are sorted when generating the output; defaults to +false+.
 #   When +true+, keys are sorted lexicographically. When a \Proc, it receives
 #   the entire \Hash and must return a \Hash with its pairs in the desired
 #   order, allowing for arbitrary sort orders.
+# - Option +rfc8785+ (boolean) controls whether the generated JSON will be canonicalized
+#   as defined in RFC8785.
+#   Integers are converted to Float before formatting and may be rounded.
+#   Integers outside the finite Float range raise JSON::GeneratorError.
+#   Nonempty +indent+, +space+, +space_before+, +object_nl+, or +array_nl+,
+#   and enabled +ascii_only+, +script_safe+, or +allow_nan+ raise ArgumentError.
+#   JSON.dump defaults +allow_nan+ to +false+ when +rfc8785+ is enabled.
+#   JSON::Fragment contents are inserted as is; the caller must ensure they are canonical.
 #
 # In this example, +obj+ is used first to generate the shortest
 # \JSON data (no whitespace), then again with all formatting options
@@ -439,7 +447,7 @@ require 'json/common'
 #     "foo" : [
 #       "bar",
 #       "baz"
-#   ],
+#     ],
 #     "bat" : {
 #       "bam" : 0,
 #       "bad" : 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Florian Frank
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: JSON Implementation for Ruby
 test_files: []