json 2.18.1 → 3.0.0

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

@@ -9,7 +9,7 @@ module JSON
         # Instantiates a new State object, configured by _opts_.
         #
         # Argument +opts+, if given, contains a \Hash of options for the generation.
-        # See {Generating Options}[#module-JSON-label-Generating+Options].
+        # See {Generating Options}[rdoc-ref:JSON@Generating+Options].
         def initialize(opts = nil)
           if opts && !opts.empty?
             configure(opts)
@@ -54,6 +54,7 @@ module JSON
             strict: strict?,
             depth: depth,
             buffer_initial_length: buffer_initial_length,
+            sort_keys: sort_keys
           }
 
           allow_duplicate_key = allow_duplicate_key?
@@ -70,33 +71,6 @@ module JSON
         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

@@ -41,5 +41,29 @@ module JSON
     end
   end
 
-  JSON_LOADED = true unless defined?(JSON::JSON_LOADED)
+  if defined?(ResumableParser) # Not yet available on JRuby
+    class ResumableParser
+      # Returns whether the parser is entirely done: no unconsumed bytes in
+      # the buffer, no document under construction and no parsed value
+      # awaiting retrieval.
+      #
+      # The main use case is detecting a truncated stream once the input is
+      # exhausted:
+      #
+      #   loop do
+      #     begin
+      #       parser << socket.readpartial(4096)
+      #     rescue EOFError
+      #       break
+      #     end
+      #     while parser.parse
+      #       process(parser.value)
+      #     end
+      #   end
+      #   warn "stream was truncated" unless parser.empty?
+      def empty?
+        eos? && !partial_value? && !value?
+      end
+    end
+  end
 end

data/lib/json/truffle_ruby/generator.rb

@@ -48,7 +48,7 @@ module JSON
       SCRIPT_SAFE_ESCAPE_PATTERN = /[\/"\\\x0-\x1f\u2028-\u2029]/
 
       def self.native_type?(value) # :nodoc:
-        (false == value || true == value || nil == value || String === value || Array === value || Hash === value || Integer === value || Float === value || Fragment === value)
+        (false == value || true == value || nil == value || String === value || Symbol === value || Array === value || Hash === value || Integer === value || Float === value || Fragment === value)
       end
 
       def self.native_key?(key) # :nodoc:
@@ -111,6 +111,8 @@ module JSON
       # This class is used to create State instances, that are use to hold data
       # while generating a JSON text from a Ruby data structure.
       class State
+        singleton_class.attr_accessor :default_sort_keys_proc # :nodoc:
+
         def self.generate(obj, opts = nil, io = nil)
           new(opts).generate(obj, io)
         end
@@ -164,7 +166,9 @@ module JSON
           @script_safe           = false
           @strict                = false
           @max_nesting           = 100
-          configure(opts) if opts
+          @sort_keys             = false
+          @allow_duplicate_key   = false
+          _configure(**opts) if opts
         end
 
         # This string is used to indent levels in the JSON text.
@@ -199,6 +203,33 @@ module JSON
         # supported by the JSON spec will raise a JSON::GeneratorError
         attr_accessor :strict
 
+        # Controls key sorting in the generated JSON. If set to +true+, object
+        # keys are sorted by key lexicographically. If set to a Proc, it
+        # receives the entire Hash and must return a Hash with its pairs in the
+        # desired order.
+        attr_reader :sort_keys
+
+        def sort_keys=(value) # :nodoc:
+          type_error = false
+          @sort_keys = case value
+          when Proc
+            value
+          when true
+            State.default_sort_keys_proc
+          when nil, false
+            false
+          else
+            type_error = true
+            false
+          end
+
+          if type_error
+            raise TypeError, "The `sort_keys` argument must be a boolean or a Proc"
+          end
+
+          @sort_keys
+        end
+
         # :stopdoc:
         attr_reader :buffer_initial_length
 
@@ -211,7 +242,14 @@ module JSON
 
         # This integer returns the current depth data structure nesting in the
         # generated JSON.
-        attr_accessor :depth
+        attr_reader :depth
+
+        def depth=(depth)
+          if depth.negative?
+            raise ArgumentError, "depth must be >= 0 (got #{depth})"
+          end
+          @depth = depth
+        end
 
         def check_max_nesting # :nodoc:
           return if @max_nesting.zero?
@@ -252,56 +290,48 @@ module JSON
 
         # 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
-          opts.each do |key, value|
-            instance_variable_set "@#{key}", value
+        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)
-          @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
+        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
+        )
+          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]
-            @max_nesting = opts[:max_nesting]
-          else
-            @max_nesting = 0
-          end
+          @indent = indent || ''
+          @space = space || ''
+          @space_before = space_before || ''
+          @object_nl = object_nl || ''
+          @array_nl = array_nl || ''
+          @allow_nan = allow_nan || false
+          @as_json = as_json || false
+          @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
         end
-        alias merge configure
 
         def allow_duplicate_key? # :nodoc:
           @allow_duplicate_key
@@ -316,10 +346,6 @@ module JSON
             result[key.to_sym] = instance_variable_get(iv)
           end
 
-          if result[:allow_duplicate_key].nil?
-            result.delete(:allow_duplicate_key)
-          end
-
           result
         end
 
@@ -334,9 +360,13 @@ module JSON
 
           depth = @depth
           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)
+              !@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(
@@ -366,7 +396,7 @@ module JSON
               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
@@ -433,28 +463,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
@@ -505,11 +513,11 @@ module JSON
 
             if empty?
               state.depth -= 1
-              return '{}'
+              return +'{}'
             end
 
             delim = ",#{state.object_nl}"
-            result = +"{#{state.object_nl}"
+            result = "{#{state.object_nl}"
             first = true
             key_type = nil
             indent = !state.object_nl.empty?
@@ -519,7 +527,7 @@ module JSON
               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, self)
                 end
                 result << delim
               end
@@ -546,7 +554,7 @@ module JSON
                 raise TypeError, "#{key.class}#to_s returns an instance of #{key_str.class}, expected a String"
               end
 
-              result = +"#{result}#{key_json}#{state.space_before}:#{state.space}"
+              result = "#{result}#{key_json}#{state.space_before}:#{state.space}"
               if state.strict? && !Generator.native_type?(value)
                 if state.as_json
                   value = state.as_json.call(value, false)
@@ -597,7 +605,7 @@ module JSON
 
             if empty?
               state.depth -= 1
-              return '[]'
+              return +'[]'
             end
 
             result = '['.dup
@@ -722,17 +730,17 @@ module JSON
 
         module TrueClass
           # Returns a JSON string for true: 'true'.
-          def to_json(*) 'true' end
+          def to_json(*) +'true' end
         end
 
         module FalseClass
           # Returns a JSON string for false: 'false'.
-          def to_json(*) 'false' end
+          def to_json(*) +'false' end
         end
 
         module NilClass
           # Returns a JSON string for nil: 'null'.
-          def to_json(*) 'null' end
+          def to_json(*) +'null' end
         end
       end
     end

data/lib/json/version.rb

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