Skip to content

Update documentation to match json 3.0 API #1073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
byroot merged 1 commit into from
Sep 8, 2026
+41 −41
Merged

Update documentation to match json 3.0 API #1073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 37 additions & 37 deletions lib/json.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@
#
# 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
Expand Down Expand Up @@ -102,7 +102,7 @@
# ruby # => 1.0
# ruby.class # => Float
# ruby = JSON.parse('2.0e2')
# ruby # => 200
# ruby # => 200.0
# ruby.class # => Float
# Boolean:
# ruby = JSON.parse('true')
Expand Down Expand Up @@ -131,22 +131,22 @@
# 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)
#
# ---
#
# Option +allow_duplicate_key+ specifies whether duplicate keys in objects
# 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}
#
# ---
#
Expand All @@ -155,15 +155,15 @@
# 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]
#
# ---
Expand All @@ -185,10 +185,10 @@
# 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}
#
# ---
#
Expand All @@ -197,7 +197,7 @@
# 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"
Expand All @@ -209,7 +209,7 @@
# 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"
Expand All @@ -228,8 +228,8 @@
# 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}
#
# ---
#
Expand All @@ -242,7 +242,7 @@
# 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>
#
# ---
Expand All @@ -256,8 +256,8 @@
# 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
#
Expand Down Expand Up @@ -319,22 +319,22 @@
# 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:
Expand All @@ -345,14 +345,14 @@
#
# 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}'
#
# ---
Expand All @@ -365,13 +365,13 @@
# 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
Expand Down Expand Up @@ -410,7 +410,7 @@
# 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.
Expand Down Expand Up @@ -439,7 +439,7 @@
# "foo" : [
# "bar",
# "baz"
# ],
# ],
# "bat" : {
# "bam" : 0,
# "bad" : 1
Expand Down
8 changes: 4 additions & 4 deletions lib/json/common.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,11 @@ class JSONError < StandardError; end
# 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
Expand Down Expand Up @@ -290,7 +290,7 @@ def to_json(state = nil, *)
# ---
#
# 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)
Expand Down Expand Up @@ -372,7 +372,7 @@ def load_file!(filespec, **options)
#
# 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)
Expand Down