json 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4a457db7bd0eba155736808c796e81741e7ea72438768e183a7b7a795e8de4e
-  data.tar.gz: 61bb013e78224c5c91f620d3097986735411befd5139f33eaecb2c3c510ababe
+  metadata.gz: 8462d78f66ef2dde1fbece04f33a916b97b753e1593af7ffbe27113199fe6078
+  data.tar.gz: 27509e760c57f937fe6e6278eebd7989d160e5779b9fce498b0afb9451de54d3
 SHA512:
-  metadata.gz: 6e0b4b4a8160235dcef28c7924ecda754a7ae792a714e6b5fbc5baa810fd358129c4340dd1056d31df823bf139f2b42bccb9c2d400c7282079d3dcf3b2f8c2c8
-  data.tar.gz: e67782447e1934dcada56b848982e6bb15708997b9eca220f7b631470734e0b14b2b227ac82612b03b8eb6b3d54b7686d4627a6d551d05b8252da40203f07087
+  metadata.gz: 6414753f43c5b3a7b97405acc7c7a732468eb0648e560eb472f04cc3880f933e5138b4dfe6af81893683603dcf511c7051dcb74ef5b8631c30a50e236ac88408
+  data.tar.gz: e05816e7fbdd58ab2e18cb2cee29d4354087de200f24ece9e348f05b979e62f6d69a0ab6b60ddabaf3d6cef0d0b5e00e0c0499dbdc608ddb49fc6b4d374f681c

data/CHANGES.md

@@ -2,6 +2,14 @@
 
 ### Unreleased
 
+### 2026-09-09 (3.0.2)
+
+* Fix `JSON.load_file` and `JSON.load_file!` to load on Ruby 2.7.0 through 2.7.2, which cannot parse a leading parameter before `...`.
+
+### 2026-09-08 (3.0.1)
+
+* Restore the `limit` positional argument of `JSON.dump`.
+
 ### 2026-09-07 (3.0.0)
 
 * Add `JSON::ParserError#json_path` to locate parse errors in the document as a JSONPath-style string (e.g. `$.foo[0].bar`). For duplicate key errors it points at the duplicated key itself.

data/lib/json/common.rb

@@ -143,11 +143,11 @@ module JSON
   # This exception is raised if a parser error occurs.
   class ParserError < JSONError
     # Line number where the parser encountered an error.
-    # Is <tt>nil</tt> when raised by JSON::ResumableParser.
+    # Is +nil+ when raised by JSON::ResumableParser.
     attr_reader :line
 
     # Column number where the parser encountered an error.
-    # Is <tt>nil</tt> when raised by JSON::ResumableParser.
+    # Is +nil+ when raised by JSON::ResumableParser.
     attr_reader :column
 
     # Returns a best effort JSONPath string representing where in the document
@@ -290,7 +290,7 @@ module JSON
   # ---
   #
   # Raises an exception if +source+ is not valid JSON:
-  #   # Raises JSON::ParserError unexpected character: 'invalid' at line 1 column 1 :
+  #   # Raises JSON::ParserError (unexpected character: 'invalid' at line 1 column 1):
   #   JSON.parse('invalid')
   #
   def parse(source, on_load: nil, object_class: nil, array_class: nil, **options)
@@ -324,8 +324,8 @@ module JSON
   #   parse(File.read(path), **)
   #
   # See method #parse.
-  def load_file(filespec, ...)
-    parse(File.read(filespec, encoding: Encoding::UTF_8), ...)
+  def load_file(filespec, **options)
+    parse(File.read(filespec, encoding: Encoding::UTF_8), **options)
   end
 
   # :call-seq:
@@ -335,8 +335,8 @@ module JSON
   #   JSON.parse!(File.read(path), **)
   #
   # See method #parse!
-  def load_file!(filespec, ...)
-    parse!(File.read(filespec, encoding: Encoding::UTF_8), ...)
+  def load_file!(filespec, **options)
+    parse!(File.read(filespec, encoding: Encoding::UTF_8), **options)
   end
 
   # :call-seq:
@@ -372,7 +372,7 @@ module JSON
   #
   # Raises an exception if +obj+ contains circular references:
   #   a = []; b = []; a.push(b); b.push(a)
-  #   # Raises JSON::NestingError (nesting of 100 is too deep):
+  #   # Raises JSON::NestingError (nesting of 100 is too deep. Did you try to serialize objects with circular references?):
   #   JSON.generate(a)
   #
   def generate(obj, opts = nil)
@@ -726,16 +726,14 @@ module JSON
   end
 
   # :call-seq:
-  #   JSON.dump(obj, io = nil, options = nil)
+  #   JSON.dump(obj, io = nil, _deprecated_limit = nil, options = nil)
   #
   # Dumps +obj+ as a \JSON string, i.e. calls generate on the object and returns the result.
   #
-  # The default options can be changed via method JSON.dump_default_options.
-  #
   # - Argument +io+, if given, should respond to method +write+;
   #   the \JSON \String is written to +io+, and +io+ is returned.
   #   If +io+ is not given, the \JSON \String is returned.
-  #
+  # - Argument +_deprecated_limit+ is deprecated, pass the +:max_nesting+ option instead.
   # ---
   #
   # When argument +io+ is not given, returns the \JSON \String generated from +obj+:
@@ -751,21 +749,31 @@ module JSON
   #   puts File.read(path)
   # Output:
   #   {"foo":[0,1],"bar":{"baz":2,"bat":3},"bam":"bad"}
-  def dump(obj, anIO = nil, kwargs = nil)
+  def dump(obj, anIO = nil, _deprecated_limit = nil, kwargs = nil)
     if kwargs.nil?
-      if anIO.is_a?(Hash)
-        kwargs = anIO
-        anIO = nil
+      if _deprecated_limit.nil?
+        if anIO.is_a?(Hash)
+          kwargs = anIO
+          anIO = nil
+        end
+      elsif _deprecated_limit.is_a?(Hash)
+        kwargs = _deprecated_limit
+        _deprecated_limit = nil
       end
     end
 
-    if anIO&.respond_to?(:to_io)
-      anIO = anIO.to_io
+    unless anIO.nil?
+      if anIO.respond_to?(:to_io)
+        anIO = anIO.to_io
+      elsif _deprecated_limit.nil? && !anIO.respond_to?(:write)
+        anIO, _deprecated_limit = nil, anIO
+      end
     end
 
     opts = {
       allow_nan: true,
     }
+    opts[:max_nesting] = _deprecated_limit if _deprecated_limit
     opts.merge!(kwargs) if kwargs
 
     State.generate(obj, opts, anIO)
@@ -804,9 +812,9 @@ module JSON
     private_constant :EXCLUDED_GENERATOR_OPTIONS
 
     # :call-seq:
-    #   JSON.new(options = nil, &block)
+    #   JSON::Coder.new(**options, &block)
     #
-    # Argument +options+, if given, contains a \Hash of options for both parsing and generating.
+    # Keyword arguments +options+, if given, are options for both parsing and generating.
     # See {Parsing Options}[rdoc-ref:JSON@Parsing+Options],
     # and {Generating Options}[rdoc-ref:JSON@Generating+Options].
     #

data/lib/json/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JSON
-  VERSION = '3.0.0'
+  VERSION = '3.0.2'
 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,7 +410,7 @@ 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.
@@ -439,7 +439,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.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Florian Frank