json 1.8.6-java → 2.11.1-java

data/lib/json/add/exception.rb

@@ -1,20 +1,31 @@
+# frozen_string_literal: true
 unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
   require 'json'
 end
 
-# Exception serialization/deserialization
 class Exception
 
-  # Deserializes JSON string by constructing new Exception object with message
-  # <tt>m</tt> and backtrace <tt>b</tt> serialized with <tt>to_json</tt>
+  # See #as_json.
   def self.json_create(object)
     result = new(object['m'])
     result.set_backtrace object['b']
     result
   end
 
-  # Returns a hash, that will be turned into a JSON object and represent this
-  # object.
+  # Methods <tt>Exception#as_json</tt> and +Exception.json_create+ may be used
+  # to serialize and deserialize a \Exception object;
+  # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
+  #
+  # \Method <tt>Exception#as_json</tt> serializes +self+,
+  # returning a 2-element hash representing +self+:
+  #
+  #   require 'json/add/exception'
+  #   x = Exception.new('Foo').as_json # => {"json_class"=>"Exception", "m"=>"Foo", "b"=>nil}
+  #
+  # \Method +JSON.create+ deserializes such a hash, returning a \Exception object:
+  #
+  #   Exception.json_create(x) # => #<Exception: Foo>
+  #
   def as_json(*)
     {
       JSON.create_id => self.class.name,
@@ -23,8 +34,15 @@ class Exception
     }
   end
 
-  # Stores class name (Exception) with message <tt>m</tt> and backtrace array
-  # <tt>b</tt> as JSON string
+  # Returns a JSON string representing +self+:
+  #
+  #   require 'json/add/exception'
+  #   puts Exception.new('Foo').to_json
+  #
+  # Output:
+  #
+  #   {"json_class":"Exception","m":"Foo","b":null}
+  #
   def to_json(*args)
     as_json.to_json(*args)
   end

data/lib/json/add/ostruct.rb

@@ -1,19 +1,35 @@
+# frozen_string_literal: true
 unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
   require 'json'
 end
-require 'ostruct'
+begin
+  require 'ostruct'
+rescue LoadError
+end
 
-# OpenStruct serialization/deserialization
 class OpenStruct
 
-  # Deserializes JSON string by constructing new Struct object with values
-  # <tt>v</tt> serialized by <tt>to_json</tt>.
+  # See #as_json.
   def self.json_create(object)
     new(object['t'] || object[:t])
   end
 
-  # Returns a hash, that will be turned into a JSON object and represent this
-  # object.
+  # Methods <tt>OpenStruct#as_json</tt> and +OpenStruct.json_create+ may be used
+  # to serialize and deserialize a \OpenStruct object;
+  # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
+  #
+  # \Method <tt>OpenStruct#as_json</tt> serializes +self+,
+  # returning a 2-element hash representing +self+:
+  #
+  #   require 'json/add/ostruct'
+  #   x = OpenStruct.new('name' => 'Rowdy', :age => nil).as_json
+  #   # => {"json_class"=>"OpenStruct", "t"=>{:name=>'Rowdy', :age=>nil}}
+  #
+  # \Method +JSON.create+ deserializes such a hash, returning a \OpenStruct object:
+  #
+  #   OpenStruct.json_create(x)
+  #   # => #<OpenStruct name='Rowdy', age=nil>
+  #
   def as_json(*)
     klass = self.class.name
     klass.to_s.empty? and raise JSON::JSONError, "Only named structs are supported!"
@@ -23,9 +39,16 @@ class OpenStruct
     }
   end
 
-  # Stores class name (OpenStruct) with this struct's values <tt>v</tt> as a
-  # JSON string.
+  # Returns a JSON string representing +self+:
+  #
+  #   require 'json/add/ostruct'
+  #   puts OpenStruct.new('name' => 'Rowdy', :age => nil).to_json
+  #
+  # Output:
+  #
+  #   {"json_class":"OpenStruct","t":{'name':'Rowdy',"age":null}}
+  #
   def to_json(*args)
     as_json.to_json(*args)
   end
-end
+end if defined?(::OpenStruct)

data/lib/json/add/range.rb

@@ -1,18 +1,33 @@
+# frozen_string_literal: true
 unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
   require 'json'
 end
 
-# Range serialization/deserialization
 class Range
 
-  # Deserializes JSON string by constructing new Range object with arguments
-  # <tt>a</tt> serialized by <tt>to_json</tt>.
+  # See #as_json.
   def self.json_create(object)
     new(*object['a'])
   end
 
-  # Returns a hash, that will be turned into a JSON object and represent this
-  # object.
+  # Methods <tt>Range#as_json</tt> and +Range.json_create+ may be used
+  # to serialize and deserialize a \Range object;
+  # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
+  #
+  # \Method <tt>Range#as_json</tt> serializes +self+,
+  # returning a 2-element hash representing +self+:
+  #
+  #   require 'json/add/range'
+  #   x = (1..4).as_json     # => {"json_class"=>"Range", "a"=>[1, 4, false]}
+  #   y = (1...4).as_json    # => {"json_class"=>"Range", "a"=>[1, 4, true]}
+  #   z = ('a'..'d').as_json # => {"json_class"=>"Range", "a"=>["a", "d", false]}
+  #
+  # \Method +JSON.create+ deserializes such a hash, returning a \Range object:
+  #
+  #   Range.json_create(x) # => 1..4
+  #   Range.json_create(y) # => 1...4
+  #   Range.json_create(z) # => "a".."d"
+  #
   def as_json(*)
     {
       JSON.create_id  => self.class.name,
@@ -20,9 +35,19 @@ class Range
     }
   end
 
-  # Stores class name (Range) with JSON array of arguments <tt>a</tt> which
-  # include <tt>first</tt> (integer), <tt>last</tt> (integer), and
-  # <tt>exclude_end?</tt> (boolean) as JSON string.
+  # Returns a JSON string representing +self+:
+  #
+  #   require 'json/add/range'
+  #   puts (1..4).to_json
+  #   puts (1...4).to_json
+  #   puts ('a'..'d').to_json
+  #
+  # Output:
+  #
+  #   {"json_class":"Range","a":[1,4,false]}
+  #   {"json_class":"Range","a":[1,4,true]}
+  #   {"json_class":"Range","a":["a","d",false]}
+  #
   def to_json(*args)
     as_json.to_json(*args)
   end

data/lib/json/add/rational.rb

@@ -1,17 +1,31 @@
+# frozen_string_literal: true
 unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
   require 'json'
 end
-defined?(::Rational) or require 'rational'
 
 class Rational
-  # Deserializes JSON string by converting numerator value <tt>n</tt>,
-  # denominator value <tt>d</tt>, to a Rational object.
+
+  # See #as_json.
   def self.json_create(object)
     Rational(object['n'], object['d'])
   end
 
-  # Returns a hash, that will be turned into a JSON object and represent this
-  # object.
+  # Methods <tt>Rational#as_json</tt> and +Rational.json_create+ may be used
+  # to serialize and deserialize a \Rational object;
+  # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
+  #
+  # \Method <tt>Rational#as_json</tt> serializes +self+,
+  # returning a 2-element hash representing +self+:
+  #
+  #   require 'json/add/rational'
+  #   x = Rational(2, 3).as_json
+  #   # => {"json_class"=>"Rational", "n"=>2, "d"=>3}
+  #
+  # \Method +JSON.create+ deserializes such a hash, returning a \Rational object:
+  #
+  #   Rational.json_create(x)
+  #   # => (2/3)
+  #
   def as_json(*)
     {
       JSON.create_id => self.class.name,
@@ -20,8 +34,16 @@ class Rational
     }
   end
 
-  # Stores class name (Rational) along with numerator value <tt>n</tt> and denominator value <tt>d</tt> as JSON string
-  def to_json(*)
-    as_json.to_json
+  # Returns a JSON string representing +self+:
+  #
+  #   require 'json/add/rational'
+  #   puts Rational(2, 3).to_json
+  #
+  # Output:
+  #
+  #   {"json_class":"Rational","n":2,"d":3}
+  #
+  def to_json(*args)
+    as_json.to_json(*args)
   end
 end

data/lib/json/add/regexp.rb

@@ -1,19 +1,30 @@
+# frozen_string_literal: true
 unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
   require 'json'
 end
 
-# Regexp serialization/deserialization
 class Regexp
 
-  # Deserializes JSON string by constructing new Regexp object with source
-  # <tt>s</tt> (Regexp or String) and options <tt>o</tt> serialized by
-  # <tt>to_json</tt>
+  # See #as_json.
   def self.json_create(object)
     new(object['s'], object['o'])
   end
 
-  # Returns a hash, that will be turned into a JSON object and represent this
-  # object.
+  # Methods <tt>Regexp#as_json</tt> and +Regexp.json_create+ may be used
+  # to serialize and deserialize a \Regexp object;
+  # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
+  #
+  # \Method <tt>Regexp#as_json</tt> serializes +self+,
+  # returning a 2-element hash representing +self+:
+  #
+  #   require 'json/add/regexp'
+  #   x = /foo/.as_json
+  #   # => {"json_class"=>"Regexp", "o"=>0, "s"=>"foo"}
+  #
+  # \Method +JSON.create+ deserializes such a hash, returning a \Regexp object:
+  #
+  #   Regexp.json_create(x) # => /foo/
+  #
   def as_json(*)
     {
       JSON.create_id => self.class.name,
@@ -22,9 +33,16 @@ class Regexp
     }
   end
 
-  # Stores class name (Regexp) with options <tt>o</tt> and source <tt>s</tt>
-  # (Regexp or String) as JSON string
-  def to_json(*)
-    as_json.to_json
+  # Returns a JSON string representing +self+:
+  #
+  #   require 'json/add/regexp'
+  #   puts /foo/.to_json
+  #
+  # Output:
+  #
+  #    {"json_class":"Regexp","o":0,"s":"foo"}
+  #
+  def to_json(*args)
+    as_json.to_json(*args)
   end
 end

data/lib/json/add/set.rb

@@ -0,0 +1,48 @@
+unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
+  require 'json'
+end
+defined?(::Set) or require 'set'
+
+class Set
+
+  # See #as_json.
+  def self.json_create(object)
+    new object['a']
+  end
+
+  # Methods <tt>Set#as_json</tt> and +Set.json_create+ may be used
+  # to serialize and deserialize a \Set object;
+  # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
+  #
+  # \Method <tt>Set#as_json</tt> serializes +self+,
+  # returning a 2-element hash representing +self+:
+  #
+  #   require 'json/add/set'
+  #   x = Set.new(%w/foo bar baz/).as_json
+  #   # => {"json_class"=>"Set", "a"=>["foo", "bar", "baz"]}
+  #
+  # \Method +JSON.create+ deserializes such a hash, returning a \Set object:
+  #
+  #   Set.json_create(x) # => #<Set: {"foo", "bar", "baz"}>
+  #
+  def as_json(*)
+    {
+      JSON.create_id => self.class.name,
+      'a'            => to_a,
+    }
+  end
+
+  # Returns a JSON string representing +self+:
+  #
+  #   require 'json/add/set'
+  #   puts Set.new(%w/foo bar baz/).to_json
+  #
+  # Output:
+  #
+  #   {"json_class":"Set","a":["foo","bar","baz"]}
+  #
+  def to_json(*args)
+    as_json.to_json(*args)
+  end
+end
+

data/lib/json/add/struct.rb

@@ -1,18 +1,32 @@
+# frozen_string_literal: true
 unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
   require 'json'
 end
 
-# Struct serialization/deserialization
 class Struct
 
-  # Deserializes JSON string by constructing new Struct object with values
-  # <tt>v</tt> serialized by <tt>to_json</tt>.
+  # See #as_json.
   def self.json_create(object)
     new(*object['v'])
   end
 
-  # Returns a hash, that will be turned into a JSON object and represent this
-  # object.
+  # Methods <tt>Struct#as_json</tt> and +Struct.json_create+ may be used
+  # to serialize and deserialize a \Struct object;
+  # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
+  #
+  # \Method <tt>Struct#as_json</tt> serializes +self+,
+  # returning a 2-element hash representing +self+:
+  #
+  #   require 'json/add/struct'
+  #   Customer = Struct.new('Customer', :name, :address, :zip)
+  #   x = Struct::Customer.new.as_json
+  #   # => {"json_class"=>"Struct::Customer", "v"=>[nil, nil, nil]}
+  #
+  # \Method +JSON.create+ deserializes such a hash, returning a \Struct object:
+  #
+  #   Struct::Customer.json_create(x)
+  #   # => #<struct Struct::Customer name=nil, address=nil, zip=nil>
+  #
   def as_json(*)
     klass = self.class.name
     klass.to_s.empty? and raise JSON::JSONError, "Only named structs are supported!"
@@ -22,8 +36,16 @@ class Struct
     }
   end
 
-  # Stores class name (Struct) with Struct values <tt>v</tt> as a JSON string.
-  # Only named structs are supported.
+  # Returns a JSON string representing +self+:
+  #
+  #   require 'json/add/struct'
+  #   Customer = Struct.new('Customer', :name, :address, :zip)
+  #   puts Struct::Customer.new.to_json
+  #
+  # Output:
+  #
+  #   {"json_class":"Struct","t":{'name':'Rowdy',"age":null}}
+  #
   def to_json(*args)
     as_json.to_json(*args)
   end

data/lib/json/add/symbol.rb

@@ -1,11 +1,25 @@
+# frozen_string_literal: true
 unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
   require 'json'
 end
 
-# Symbol serialization/deserialization
 class Symbol
-  # Returns a hash, that will be turned into a JSON object and represent this
-  # object.
+
+  # Methods <tt>Symbol#as_json</tt> and +Symbol.json_create+ may be used
+  # to serialize and deserialize a \Symbol object;
+  # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
+  #
+  # \Method <tt>Symbol#as_json</tt> serializes +self+,
+  # returning a 2-element hash representing +self+:
+  #
+  #   require 'json/add/symbol'
+  #   x = :foo.as_json
+  #   # => {"json_class"=>"Symbol", "s"=>"foo"}
+  #
+  # \Method +JSON.create+ deserializes such a hash, returning a \Symbol object:
+  #
+  #   Symbol.json_create(x) # => :foo
+  #
   def as_json(*)
     {
       JSON.create_id => self.class.name,
@@ -13,12 +27,25 @@ class Symbol
     }
   end
 
-  # Stores class name (Symbol) with String representation of Symbol as a JSON string.
-  def to_json(*a)
-    as_json.to_json(*a)
+  # Returns a JSON string representing +self+:
+  #
+  #   require 'json/add/symbol'
+  #   puts :foo.to_json
+  #
+  # Output:
+  #
+  #   # {"json_class":"Symbol","s":"foo"}
+  #
+  def to_json(state = nil, *a)
+    state = ::JSON::State.from_state(state)
+    if state.strict?
+      super
+    else
+      as_json.to_json(state, *a)
+    end
   end
 
-  # Deserializes JSON string by converting the <tt>string</tt> value stored in the object to a Symbol
+  # See #as_json.
   def self.json_create(o)
     o['s'].to_sym
   end

data/lib/json/add/time.rb

@@ -1,37 +1,51 @@
+# frozen_string_literal: true
 unless defined?(::JSON::JSON_LOADED) and ::JSON::JSON_LOADED
   require 'json'
 end
 
-# Time serialization/deserialization
 class Time
 
-  # Deserializes JSON string by converting time since epoch to Time
+  # See #as_json.
   def self.json_create(object)
     if usec = object.delete('u') # used to be tv_usec -> tv_nsec
       object['n'] = usec * 1000
     end
-    if method_defined?(:tv_nsec)
-      at(object['s'], Rational(object['n'], 1000))
-    else
-      at(object['s'], object['n'] / 1000)
-    end
+    at(object['s'], Rational(object['n'], 1000))
   end
 
-  # Returns a hash, that will be turned into a JSON object and represent this
-  # object.
+  # Methods <tt>Time#as_json</tt> and +Time.json_create+ may be used
+  # to serialize and deserialize a \Time object;
+  # see Marshal[https://docs.ruby-lang.org/en/master/Marshal.html].
+  #
+  # \Method <tt>Time#as_json</tt> serializes +self+,
+  # returning a 2-element hash representing +self+:
+  #
+  #   require 'json/add/time'
+  #   x = Time.now.as_json
+  #   # => {"json_class"=>"Time", "s"=>1700931656, "n"=>472846644}
+  #
+  # \Method +JSON.create+ deserializes such a hash, returning a \Time object:
+  #
+  #    Time.json_create(x)
+  #    # => 2023-11-25 11:00:56.472846644 -0600
+  #
   def as_json(*)
-    nanoseconds = [ tv_usec * 1000 ]
-    respond_to?(:tv_nsec) and nanoseconds << tv_nsec
-    nanoseconds = nanoseconds.max
     {
       JSON.create_id => self.class.name,
       's'            => tv_sec,
-      'n'            => nanoseconds,
+      'n'            => tv_nsec,
     }
   end
 
-  # Stores class name (Time) with number of seconds since epoch and number of
-  # microseconds for Time as JSON string
+  # Returns a JSON string representing +self+:
+  #
+  #   require 'json/add/time'
+  #   puts Time.now.to_json
+  #
+  # Output:
+  #
+  #   {"json_class":"Time","s":1700931678,"n":980650786}
+  #
   def to_json(*args)
     as_json.to_json(*args)
   end