json 2.21.2 → 3.1.0

data/lib/json/ext/generator/state.rb

@@ -54,7 +54,8 @@ module JSON
             strict: strict?,
             depth: depth,
             buffer_initial_length: buffer_initial_length,
-            sort_keys: sort_keys
+            sort_keys: sort_keys,
+            rfc8785: rfc8785?,
           }
 
           allow_duplicate_key = allow_duplicate_key?
@@ -62,42 +63,10 @@ module JSON
             result[:allow_duplicate_key] = allow_duplicate_key
           end
 
-          instance_variables.each do |iv|
-            iv = iv.to_s[1..-1]
-            result[iv.to_sym] = self[iv]
-          end
-
           result
         end
 
         alias_method :to_hash, :to_h
-
-        # call-seq: [](name)
-        #
-        # Returns the value returned by method +name+.
-        def [](name)
-          ::JSON.deprecation_warning("JSON::State#[] is deprecated and will be removed in json 3.0.0")
-
-          if respond_to?(name)
-            __send__(name)
-          else
-            instance_variable_get("@#{name}") if
-              instance_variables.include?("@#{name}".to_sym) # avoid warning
-          end
-        end
-
-        # call-seq: []=(name, value)
-        #
-        # Sets the attribute name to value.
-        def []=(name, value)
-          ::JSON.deprecation_warning("JSON::State#[]= is deprecated and will be removed in json 3.0.0")
-
-          if respond_to?(name_writer = "#{name}=")
-            __send__ name_writer, value
-          else
-            instance_variable_set "@#{name}", value
-          end
-        end
       end
     end
   end

data/lib/json/ext.rb

@@ -28,17 +28,143 @@ module JSON
       end
     end
 
+    class << self
+      if defined?(::Ractor) && Ractor.respond_to?(:shareable_lambda)
+        def shareable_lambda(block) # :nodoc:
+          Ractor.shareable_lambda(&block)
+        end
+      else
+        def shareable_lambda(block) # :nodoc:
+          block
+        end
+      end
+
+      def valid_encoding?(str) # :nodoc:
+        str.ascii_only? || (str.encoding == Encoding::UTF_8 && str.valid_encoding?)
+      end
+
+      def coerce_key(key, as_json) # :nodoc:
+        as_json_called = false
+
+        unless String === key || Symbol === key
+          key = as_json.call(key, true)
+          as_json_called = true
+        end
+
+        if Symbol === key
+          key = key.to_s
+        end
+
+        unless String === key
+          raise GeneratorError.new("#{key.class} not allowed as object key in JSON", key)
+        end
+
+        unless valid_encoding?(key)
+          if as_json_called
+            raise GeneratorError.new("source sequence is illegal/malformed utf-8", key)
+          end
+
+          key = as_json.call(key, true)
+          unless String === key
+            raise GeneratorError.new("#{key.class} not allowed as object key in JSON", key)
+          end
+
+          unless Ext.valid_encoding?(key)
+            raise GeneratorError.new("source sequence is illegal/malformed utf-8", key)
+          end
+        end
+
+        key
+      end
+
+      def on_duplicate_key(hash, as_json)
+        set = {}
+        hash.each_key do |key|
+          key = coerce_key(key, as_json)
+          if set[key]
+            raise GeneratorError.new("detected duplicate key #{key.inspect}", key)
+          else
+            set[key] = true
+          end
+        end
+      end
+    end
+
     require 'json/ext/parser'
     Ext::Parser::Config = Ext::ParserConfig
     JSON.parser = Ext::Parser
 
-    if RUBY_ENGINE == 'truffleruby'
+    generator = if RUBY_ENGINE == 'truffleruby'
       require 'json/truffle_ruby/generator'
-      JSON.generator = JSON::TruffleRuby::Generator
+      JSON::TruffleRuby::Generator
     else
       require 'json/ext/generator'
-      JSON.generator = Generator
+      Generator
     end
+
+    # The default proc used when the +sort_keys+ generation option is +true+.
+    # It returns a new hash with the entries sorted by their keys.
+    generator::State.default_sort_keys_proc = shareable_lambda(->(hash) {
+      hash.sort.to_h
+    })
+
+    # Directly lifted from Gregg Kellogg's json-canonicalization
+    generator::State.rfc8785_number_formatter_proc = shareable_lambda(->(num) {
+      if Integer === num
+        if num > Float::MAX || num < -Float::MAX
+          raise GeneratorError.new("Integer out of range for RFC 8785", num)
+        end
+        num = num.to_f
+      end
+      if num.zero?
+        "0"
+      else
+        if num < 0
+          num, sign = -num, '-'
+        end
+        native_rep = num.to_s
+        decimal, exponential = native_rep.split('e')
+        exp_val = exponential.to_i
+        exponential = exp_val > 0 ? ('+' + exp_val.to_s) : exp_val.to_s
+
+        integral, fractional = decimal.split('.')
+        fractional = fractional.sub(/0+$/, '')  # Remove trailing zeros
+
+        if exp_val > 0 && exp_val < 21
+          while exp_val > 0
+            integral += fractional.to_s[0] || '0'
+            fractional = fractional.to_s[1..-1]
+            exp_val -= 1
+          end
+          exponential = nil
+        elsif exp_val == 0
+          exponential = nil
+        elsif exp_val < 0 && exp_val > -7
+          # Small numbers are shown as 0.etc with e-6 as lower limit
+          fractional, integral, exponential = integral + fractional.to_s, '0', nil
+          fractional = ("0" * (-exp_val - 1)) + fractional
+        end
+
+        fractional = nil if fractional.to_s.empty?
+        sign.to_s + integral + (fractional ? ".#{fractional}" : '') + (exponential ? "e#{exponential}" : '')
+      end
+    })
+
+    generator::State.rfc8785_sort_keys_proc = shareable_lambda(->(hash, as_json) {
+      converted = if as_json
+        hash.transform_keys { |k| Ext.coerce_key(k, as_json) }
+      else
+        hash.transform_keys(&:to_s)
+      end
+
+      if converted.size < hash.size
+        Ext.on_duplicate_key(hash, as_json)
+      end
+
+      converted.sort_by { |k,| k.encode(Encoding::UTF_16) }.to_h
+    })
+
+    JSON.generator = generator
   end
 
   if defined?(ResumableParser) # Not yet available on JRuby
@@ -66,6 +192,4 @@ module JSON
       end
     end
   end
-
-  JSON_LOADED = true unless defined?(JSON::JSON_LOADED)
 end

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)
@@ -167,7 +169,9 @@ module JSON
           @strict                = false
           @max_nesting           = 100
           @sort_keys             = false
-          configure(opts) if opts
+          @allow_duplicate_key   = false
+          @rfc8785               = false
+          _configure(**opts) if opts
         end
 
         # This string is used to indent levels in the JSON text.
@@ -188,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.
@@ -208,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
@@ -287,67 +303,80 @@ module JSON
           @strict
         end
 
-        # Configure this State instance with the Hash _opts_, and return
-        # itself.
-        def configure(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
+        # Returns true, if RFC8785 (canonicalization) mode is enabled. Otherwise returns false.
+        def rfc8785?
+          @rfc8785
+        end
 
-          if opts[:depth]&.negative?
-            raise ArgumentError, "depth must be >= 0 (got #{opts[:depth]})"
+        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
 
-          opts.each do |key, value|
-            instance_variable_set "@#{key}", value
+        # Configure this State instance with the Hash _opts_, and return
+        # itself.
+        def configure(options)
+          unless Hash == options
+            if options.respond_to?(:to_hash)
+              options = options.to_hash
+            elsif options.respond_to?(:to_h)
+              options = options.to_h
+            end
           end
+          _configure(**options)
+        end
+        alias merge configure
 
-          # NOTE: If adding new instance variables here, check whether #generate should check them for #generate_json
-          @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)
-          @allow_nan             = !!opts[:allow_nan]         if opts.key?(:allow_nan)
-          @as_json               = opts[:as_json].to_proc     if opts[:as_json]
-          @ascii_only            = opts[:ascii_only]          if opts.key?(:ascii_only)
-          self.sort_keys         = opts[:sort_keys]           if opts.key?(:sort_keys)
-          @depth                 = opts[:depth] || 0
-          @buffer_initial_length ||= opts[:buffer_initial_length]
-
-          @script_safe = if opts.key?(:script_safe)
-            !!opts[:script_safe]
-          elsif opts.key?(:escape_slash)
-            !!opts[:escape_slash]
-          else
-            false
+        # Defaults are the current values so that #configure only writes what it was given.
+        private def _configure(
+          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})"
           end
 
-          if opts.key?(:allow_duplicate_key)
-            @allow_duplicate_key = !!opts[:allow_duplicate_key]
-          else
-            @allow_duplicate_key = nil # nil is deprecation
+          if max_nesting && !(Integer === max_nesting)
+            raise TypeError, ":max_nesting must be `false` or an Integer, got: #{max_nesting.class}"
           end
 
-          @strict                = !!opts[:strict] if opts.key?(:strict)
-
-          if !opts.key?(:max_nesting) # defaults to 100
-            @max_nesting = 100
-          elsif opts[:max_nesting]
-            unless opts[:max_nesting].is_a?(Integer)
-              raise TypeError, ":max_nesting must be an Integer, got: #{opts[:max_nesting].class}"
-            end
-            @max_nesting = opts[:max_nesting]
+          @indent = indent || ''
+          @space = space || ''
+          @space_before = space_before || ''
+          @object_nl = object_nl || ''
+          @array_nl = array_nl || ''
+          @allow_nan = allow_nan || false
+          if as_json
+            self.as_json = as_json
           else
-            @max_nesting = 0
+            @as_json = false
           end
-          self
+          @ascii_only = ascii_only || false
+          self.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 || 0
+          self.rfc8785 = rfc8785
+
+          validate_rfc8785
         end
-        alias merge configure
 
         def allow_duplicate_key? # :nodoc:
           @allow_duplicate_key
@@ -356,17 +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
-
-          if result[:allow_duplicate_key].nil?
-            result.delete(:allow_duplicate_key)
-          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
@@ -379,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
@@ -410,13 +444,18 @@ 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
               else
                 if key_type && !@allow_duplicate_key && key_type != k.class
                   key_type = nil # stop checking
-                  JSON.send(:on_mixed_keys_hash, obj, !@allow_duplicate_key.nil?)
+                  JSON.send(:on_mixed_keys_hash, obj)
                 end
                 buf << ','
               end
@@ -451,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)
@@ -483,28 +522,6 @@ module JSON
           end
           buf << '"'
         end
-
-        # Return the value returned by method +name+.
-        def [](name)
-          ::JSON.deprecation_warning("JSON::State#[] is deprecated and will be removed in json 3.0.0")
-
-          if respond_to?(name)
-            __send__(name)
-          else
-            instance_variable_get("@#{name}") if
-              instance_variables.include?("@#{name}".to_sym) # avoid warning
-          end
-        end
-
-        def []=(name, value)
-          ::JSON.deprecation_warning("JSON::State#[]= is deprecated and will be removed in json 3.0.0")
-
-          if respond_to?(name_writer = "#{name}=")
-            __send__ name_writer, value
-          else
-            instance_variable_set "@#{name}", value
-          end
-        end
       end
 
       module GeneratorMethods
@@ -542,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
@@ -563,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, state.allow_duplicate_key? == false)
+                  JSON.send(:on_mixed_keys_hash, hash)
                 end
                 result << delim
               end
@@ -634,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
@@ -690,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
@@ -718,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 = '2.21.2'
+  VERSION = '3.1.0'
 end