oj 3.11.5 → 3.16.5

data/lib/oj/json.rb

@@ -1,176 +1,188 @@
-
 require 'ostruct'
 require 'oj/state'
 
-module JSON
-  NaN = 0.0/0.0 unless defined?(::JSON::NaN)
-  Infinity = 1.0/0.0 unless defined?(::JSON::Infinity)
-  MinusInfinity = -1.0/0.0 unless defined?(::JSON::MinusInfinity)
-  # Taken from the unit test. Note that items like check_circular? are not
-  # present.
-  PRETTY_STATE_PROTOTYPE = Ext::Generator::State.from_state({
-                                              :allow_nan             => false,
-                                              :array_nl              => "\n",
-                                              :ascii_only            => false,
-                                              :buffer_initial_length => 1024,
-                                              :depth                 => 0,
-                                              :indent                => "  ",
-                                              :max_nesting           => 100,
-                                              :object_nl             => "\n",
-                                              :space                 => " ",
-                                              :space_before          => "",
-                                            }) unless defined?(::JSON::PRETTY_STATE_PROTOTYPE)
-  SAFE_STATE_PROTOTYPE = Ext::Generator::State.from_state({
-                                            :allow_nan             => false,
-                                            :array_nl              => "",
-                                            :ascii_only            => false,
-                                            :buffer_initial_length => 1024,
-                                            :depth                 => 0,
-                                            :indent                => "",
-                                            :max_nesting           => 100,
-                                            :object_nl             => "",
-                                            :space                 => "",
-                                            :space_before          => "",
-                                            }) unless defined?(::JSON::SAFE_STATE_PROTOTYPE)
-  FAST_STATE_PROTOTYPE = Ext::Generator::State.from_state({
-                                            :allow_nan             => false,
-                                            :array_nl              => "",
-                                            :ascii_only            => false,
-                                            :buffer_initial_length => 1024,
-                                            :depth                 => 0,
-                                            :indent                => "",
-                                            :max_nesting           => 0,
-                                            :object_nl             => "",
-                                            :space                 => "",
-                                            :space_before          => "",
-                                            }) unless defined?(::JSON::FAST_STATE_PROTOTYPE)
-
-  def self.dump_default_options
-    Oj::MimicDumpOption.new
-  end
-
-  def self.dump_default_options=(h)
-    m = Oj::MimicDumpOption.new
-    h.each do |k,v|
-      m[k] = v
+if defined?(JSON::PRETTY_STATE_PROTOTYPE)
+  # There are enough people that try to use both the json gen and oj in mimic
+  # mode so don't display the warning.
+
+  # warn "WARNING: oj/json is a compatability shim used by Oj. Requiring the file explicitly is not recommended."
+end
+
+unless defined?(JSON::PRETTY_STATE_PROTOTYPE)
+  module JSON
+    NaN = 0.0/0.0 unless defined?(::JSON::NaN)
+    Infinity = 1.0/0.0 unless defined?(::JSON::Infinity)
+    MinusInfinity = -1.0/0.0 unless defined?(::JSON::MinusInfinity)
+    # Taken from the unit test. Note that items like check_circular? are not
+    # present.
+    PRETTY_STATE_PROTOTYPE = Ext::Generator::State.from_state({
+                                                                :allow_nan             => false,
+                                                                :array_nl              => "\n",
+                                                                :ascii_only            => false,
+                                                                :buffer_initial_length => 1024,
+                                                                :depth                 => 0,
+                                                                :indent                => "  ",
+                                                                :max_nesting           => 100,
+                                                                :object_nl             => "\n",
+                                                                :space                 => " ",
+                                                                :space_before          => "",
+                                                              }) unless defined?(::JSON::PRETTY_STATE_PROTOTYPE)
+    SAFE_STATE_PROTOTYPE = Ext::Generator::State.from_state({
+                                                              :allow_nan             => false,
+                                                              :array_nl              => "",
+                                                              :ascii_only            => false,
+                                                              :buffer_initial_length => 1024,
+                                                              :depth                 => 0,
+                                                              :indent                => "",
+                                                              :max_nesting           => 100,
+                                                              :object_nl             => "",
+                                                              :space                 => "",
+                                                              :space_before          => "",
+                                                            }) unless defined?(::JSON::SAFE_STATE_PROTOTYPE)
+    FAST_STATE_PROTOTYPE = Ext::Generator::State.from_state({
+                                                              :allow_nan             => false,
+                                                              :array_nl              => "",
+                                                              :ascii_only            => false,
+                                                              :buffer_initial_length => 1024,
+                                                              :depth                 => 0,
+                                                              :indent                => "",
+                                                              :max_nesting           => 0,
+                                                              :object_nl             => "",
+                                                              :space                 => "",
+                                                              :space_before          => "",
+                                                            }) unless defined?(::JSON::FAST_STATE_PROTOTYPE)
+
+    def self.dump_default_options
+      Oj::MimicDumpOption.new
     end
-  end
 
-  def self.parser=(p)
-    @@parser = p
-  end
+    def self.dump_default_options=(h)
+      m = Oj::MimicDumpOption.new
+      h.each do |k, v|
+        m[k] = v
+      end
+    end
 
-  def self.parser()
-    @@parser
-  end
+    def self.parser=(p)
+      @@parser = p
+    end
 
-  def self.generator=(g)
-    @@generator = g
-  end
+    def self.parser()
+      @@parser
+    end
 
-  def self.generator()
-    @@generator
-  end
+    def self.generator=(g)
+      @@generator = g
+    end
 
-  module Ext
-    class Parser
-      def initialize(src)
-        raise TypeError.new("already initialized") unless @source.nil?
-        @source = src
-      end
+    def self.generator()
+      @@generator
+    end
 
-      def source()
-        raise TypeError.new("already initialized") if @source.nil?
-        @source
-      end
-      
-      def parse()
-        raise TypeError.new("already initialized") if @source.nil?
-        JSON.parse(@source)
-      end
-      
-    end # Parser
-  end # Ext
-  
-  State = ::JSON::Ext::Generator::State unless defined?(::JSON::State)
-
-  begin
-    send(:remove_const, :Parser)
-  rescue
-  end
-  Parser = ::JSON::Ext::Parser unless defined?(::JSON::Parser)
-  self.parser = ::JSON::Ext::Parser
-  self.generator = ::JSON::Ext::Generator
-
-  # Taken directly from the json gem. Shamelessly copied. It is similar in
-  # some ways to the Oj::Bag class or the Oj::EasyHash class.
-  class GenericObject < OpenStruct
-    class << self
-      alias [] new
-      
-      def json_creatable?
-        @json_creatable
-      end
+    module Ext
+      class Parser
+        def initialize(src)
+          raise TypeError.new("already initialized") unless @source.nil?
 
-      attr_writer :json_creatable
+          @source = src
+        end
 
-      def json_create(data)
-        data = data.dup
-        data.delete JSON.create_id
-        self[data]
-      end
+        def source()
+          raise TypeError.new("already initialized") if @source.nil?
 
-      def from_hash(object)
-        case
-        when object.respond_to?(:to_hash)
-          result = new
-          object.to_hash.each do |key, value|
-            result[key] = from_hash(value)
-          end
-          result
-        when object.respond_to?(:to_ary)
-          object.to_ary.map { |a| from_hash(a) }
-        else
-          object
+          @source
         end
-      end
 
-      def load(source, proc = nil, opts = {})
-        result = ::JSON.load(source, proc, opts.merge(:object_class => self))
-        result.nil? ? new : result
-      end
+        def parse()
+          raise TypeError.new("already initialized") if @source.nil?
 
-      def dump(obj, *args)
-        ::JSON.dump(obj, *args)
-      end
+          JSON.parse(@source)
+        end
 
-    end # self
+      end # Parser
+    end # Ext
 
-    self.json_creatable = false
+    State = ::JSON::Ext::Generator::State unless defined?(::JSON::State)
 
-    def to_hash
-      table
+    begin
+      send(:remove_const, :Parser)
+    rescue
+      # ignore and move on
     end
+    Parser = ::JSON::Ext::Parser unless defined?(::JSON::Parser)
+    self.parser = ::JSON::Ext::Parser
+    self.generator = ::JSON::Ext::Generator
+
+    # Taken directly from the json gem. Shamelessly copied. It is similar in
+    # some ways to the Oj::Bag class or the Oj::EasyHash class.
+    class GenericObject < OpenStruct
+      class << self
+        alias [] new
+
+        def json_creatable?
+          @json_creatable
+        end
 
-    def [](name)
-      __send__(name)
-    end unless method_defined?(:[])
+        attr_writer :json_creatable
 
-    def []=(name, value)
-      __send__("#{name}=", value)
-    end unless method_defined?(:[]=)
+        def json_create(data)
+          data = data.dup
+          data.delete JSON.create_id
+          self[data]
+        end
 
-    def |(other)
-      self.class[other.to_hash.merge(to_hash)]
-    end
+        def from_hash(object)
+          case
+          when object.respond_to?(:to_hash)
+            result = new
+            object.to_hash.each do |key, value|
+              result[key] = from_hash(value)
+            end
+            result
+          when object.respond_to?(:to_ary)
+            object.to_ary.map { |a| from_hash(a) }
+          else
+            object
+          end
+        end
 
-    def as_json(*)
-      { JSON.create_id => self.class.name }.merge to_hash
-    end
+        def load(source, proc = nil, opts = {})
+          result = ::JSON.load(source, proc, opts.merge(:object_class => self))
+          result.nil? ? new : result
+        end
 
-    def to_json(*a)
-      as_json.to_json(*a)
+        def dump(obj, *args)
+          ::JSON.dump(obj, *args)
+        end
+
+      end # self
+
+      self.json_creatable = false
+
+      def to_hash
+        table
+      end
+
+      def [](name)
+        __send__(name)
+      end unless method_defined?(:[])
+
+      def []=(name, value)
+        __send__("#{name}=", value)
+      end unless method_defined?(:[]=)
+
+      def |(other)
+        self.class[other.to_hash.merge(to_hash)]
+      end
+
+      def as_json(*)
+        { JSON.create_id => self.class.name }.merge to_hash
+      end
+
+      def to_json(*a)
+        as_json.to_json(*a)
+      end
     end
-  end
-  
-end # JSON
+
+  end # JSON
+end

data/lib/oj/mimic.rb

@@ -1,10 +1,7 @@
+# frozen_string_literal: false
 
 require 'bigdecimal'
-begin
-  require 'ostruct'
-rescue Exception
-  # ignore
-end
+require 'ostruct'
 
 module Oj
 
@@ -23,6 +20,8 @@ module Oj
     bigdecimal_load: :auto,
     circular: false,
     class_cache: false,
+    cache_keys: true,
+    cache_str: 5,
     create_additions: false,
     create_id: "json_class",
     empty_string: false,
@@ -62,6 +61,8 @@ module Oj
       self.store(:allow_nan, true)
       self.store(:quirks_mode, oo[:quirks_mode])
       self.store(:ascii_only, (:ascii == oo[:escape_mode]))
+
+      super
     end
 
     def []=(key, value)
@@ -100,6 +101,7 @@ module Oj
           def as_json(*)
             name = self.class.name.to_s
             raise JSON::JSONError, "Only named structs are supported!" if 0 == name.length
+
             { JSON.create_id => name, 't' => table }
           end
         end
@@ -230,6 +232,7 @@ module Oj
         def as_json(*)
           name = self.class.name.to_s
           raise JSON::JSONError, "Only named structs are supported!" if 0 == name.length
+
           { JSON.create_id => name, 'v' => values }
         end
       end
@@ -261,7 +264,7 @@ module Oj
         end
       end
       def self.json_create(h)
-        if usec = h.delete('u')
+        if (usec = h.delete('u'))
           h['n'] = usec * 1000
         end
         if instance_methods.include?(:tv_nsec)
@@ -271,7 +274,6 @@ module Oj
         end
       end
     end
-
   end # self.mimic_loaded
 
 end # Oj

data/lib/oj/saj.rb

@@ -1,11 +1,17 @@
 module Oj
-  # A SAX style parse handler for JSON hence the acronym SAJ for Simple API for
-  # JSON. The Oj::Saj handler class should be subclassed and then used with the
-  # Oj::Saj key_parse() method. The Saj methods will then be called as the file
-  # is parsed.
+  # A SAX style parse handler for JSON hence the acronym SAJ for Simple API
+  # for JSON. The Oj::Saj handler class can be subclassed and then used with
+  # the Oj::Saj key_parse() method or with the more resent
+  # Oj::Parser.new(:saj). The Saj methods will then be called as the file is
+  # parsed.
+  #
+  # With Oj::Parser.new(:saj) each method can also include a line and column
+  # argument so hash_start(key) could also be hash_start(key, line,
+  # column). The error() method is no used with Oj::Parser.new(:saj) so it
+  # will never be called.
   #
   # @example
-  # 
+  #
   #  require 'oj'
   #
   #  class MySaj < ::Oj::Saj
@@ -23,6 +29,14 @@ module Oj
   #    Oj.saj_parse(cnt, f)
   #  end
   #
+  # or
+  #
+  #  p = Oj::Parser.new(:saj)
+  #  p.handler = MySaj.new()
+  #  File.open('any.json', 'r') do |f|
+  #    p.parse(f.read)
+  #  end
+  #
   # To make the desired methods active while parsing the desired method should
   # be made public in the subclasses. If the methods remain private they will
   # not be called during parsing.
@@ -61,6 +75,6 @@ module Oj
 
     def error(message, line, column)
     end
-    
+
   end # Saj
 end # Oj

data/lib/oj/schandler.rb

@@ -64,13 +64,14 @@ module Oj
   #
   #    hash_end
   #
-  # When a hash key is encountered the hash_key method is called with the parsed
-  # hash value key. The return value from the call is then used as the key in
-  # the key-value pair that follows.
+  #  At the end of a JSON object element the hash_end() callback is called if
+  #  public.
   #
   #    hash_key
   #
-  # At the end of a JSON object element the hash_end() callback is called if public.
+  # When a hash key is encountered the hash_key() method is called with the
+  # parsed hash value key. The return value from the call is then used as the
+  # key in the key-value pair that follows.
   #
   #    hash_set
   #

data/lib/oj/state.rb

@@ -1,7 +1,6 @@
-
 module JSON
   module Ext
-    module Generator 
+    module Generator
       unless defined?(::JSON::Ext::Generator::State)
         # This class exists for json gem compatibility only. While it can be
         # used as the options for other than compatibility a simple Hash is
@@ -44,11 +43,11 @@ module JSON
           def to_h()
             return @attrs.dup
           end
-          
+
           def to_hash()
             return @attrs.dup
           end
-          
+
           def allow_nan?()
             @attrs[:allow_nan]
           end
@@ -59,6 +58,7 @@ module JSON
 
           def configure(opts)
             raise TypeError.new('expected a Hash') unless opts.respond_to?(:to_h)
+
             @attrs.merge!(opts.to_h)
           end
 
@@ -80,10 +80,11 @@ module JSON
           # @param [Symbol] m method symbol
           # @return [Boolean] true for any method that matches an instance
           #                   variable reader, otherwise false.
-          def respond_to?(m)
+          def respond_to?(m, include_all = false)
             return true if super
             return true if has_key?(key)
             return true if has_key?(key.to_s)
+
             has_key?(key.to_sym)
           end
 
@@ -104,7 +105,7 @@ module JSON
           def has_key?(k)
             @attrs.has_key?(key.to_sym)
           end
-          
+
           # Handles requests for Hash values. Others cause an Exception to be raised.
           # @param [Symbol|String] m method symbol
           # @return [Boolean] the value of the specified instance variable.
@@ -113,14 +114,17 @@ module JSON
           def method_missing(m, *args, &block)
             if m.to_s.end_with?('=')
               raise ArgumentError.new("wrong number of arguments (#{args.size} for 1 with #{m}) to method #{m}") if args.nil? or 1 != args.length
+
               m = m.to_s[0..-2]
               m = m.to_sym
               return @attrs.store(m, args[0])
-            else
+            end
+            if @attrs.has_key?(m.to_sym)
               raise ArgumentError.new("wrong number of arguments (#{args.size} for 0 with #{m}) to method #{m}") unless args.nil? or args.empty?
+
               return @attrs[m.to_sym]
             end
-            raise NoMethodError.new("undefined method #{m}", m)
+            return @attrs.send(m, *args, &block)
           end
 
         end # State

data/lib/oj/version.rb

@@ -1,5 +1,4 @@
-
 module Oj
   # Current version of the module.
-  VERSION = '3.11.5'
+  VERSION = '3.16.5'
 end

data/lib/oj.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 
+# Oj module is defined in oj.c.
 module Oj
 end
 

data/pages/Compatibility.md

@@ -2,7 +2,7 @@
 
 **Ruby**
 
-Oj is compatible with Ruby 2.0.0, 2.1, 2.2, 2.3, 2.4 and RBX.
+Oj is compatible with Ruby 2.4+ and RBX.
 Support for JRuby has been removed as JRuby no longer supports C extensions and
 there are bugs in the older versions that are not being fixed.
 

data/pages/InstallOptions.md

@@ -0,0 +1,20 @@
+# Oj Install Options
+
+### Enable trace log
+
+```
+$ gem install oj -- --enable-trace-log
+```
+
+To enable Oj trace feature, it uses `--enable-trace-log` option when installing the gem.
+Then, the trace logs will be displayed when `:trace` option is set to `true`.
+
+
+### Enable SIMD instructions
+
+```
+$ gem install oj -- --with-sse42
+```
+
+To enable the use of SIMD instructions in Oj, it uses the `--with-sse42` option when installing the gem.
+This will enable the use of the SSE4.2 instructions in the internal.

data/pages/JsonGem.md

@@ -1,3 +1,18 @@
+# JSON Quickstart
+
+To have Oj universally "take over" many methods on the JSON constant (`load`, `parse`, etc.) with
+their faster Oj counterparts, in a mode that is compatible with the json gem:
+
+```ruby
+Oj.mimic_JSON()
+```
+
+If the project does not already use the json gem, `JSON` will become available.
+If the project does require the json gem, `Oj.mimic_JSON()` should be invoked after the
+json gem has been required.
+
+For more details and options, read on...
+
 # Oj JSON Gem Compatibility
 
 The `:compat` mode mimics the json gem. The json gem is built around the use

data/pages/Modes.md

@@ -39,7 +39,8 @@ if a non-native type is encountered instead of raising an Exception.
 The `:compat` mode mimics the json gem. The json gem is built around the use
 of the `to_json(*)` method defined for a class. Oj attempts to provide the
 same functionality by being a drop in replacement with a few
-exceptions. [{file:JsonGem.md}](JsonGem.md) includes more details on
+exceptions. To universally replace many `JSON` methods with their faster Oj counterparts,
+simply run `Oj.mimic_json`. [{file:JsonGem.md}](JsonGem.md) includes more details on
 compatibility and use.
 
 ## :rails Mode
@@ -97,6 +98,8 @@ information.
 | :bigdecimal_as_decimal | Boolean |         |         |         |       3 |       x |       x |         |
 | :bigdecimal_load       | Boolean |         |         |         |         |         |       x |         |
 | :compat_bigdecimal     | Boolean |         |         |       x |         |         |       x |         |
+| :cache_keys            | Boolean |       x |       x |       x |       x |         |       x |         |
+| :cache_strings         | Fixnum  |       x |       x |       x |       x |         |       x |         |
 | :circular              | Boolean |       x |       x |       x |       x |       x |       x |         |
 | :class_cache           | Boolean |         |         |         |         |       x |       x |         |
 | :create_additions      | Boolean |         |         |       x |       x |         |       x |         |
@@ -106,11 +109,11 @@ information.
 | :float_precision       | Fixnum  |       x |       x |         |         |         |       x |         |
 | :hash_class            | Class   |         |         |       x |       x |         |       x |         |
 | :ignore                | Array   |         |         |         |         |       x |       x |         |
-| :indent                | Integer |       x |       x |       3 |       4 |       x |       x |       x |
+| :indent                | Integer |       x |       x |       4 |       4 |       x |       x |       x |
 | :indent_str            | String  |         |         |       x |       x |         |       x |         |
 | :integer_range         | Range   |       x |       x |       x |       x |       x |       x |       x |
 | :match_string          | Hash    |         |         |       x |       x |         |       x |         |
-| :max_nesting           | Fixnum  |       4 |       4 |       x |         |       5 |       4 |         |
+| :max_nesting           | Fixnum  |       5 |       5 |       x |         |       5 |       5 |         |
 | :mode                  | Symbol  |       - |       - |       - |       - |       - |       - |         |
 | :nan                   | Symbol  |         |         |         |         |         |       x |         |
 | :nilnil                | Boolean |         |         |         |         |         |       x |         |
@@ -138,6 +141,8 @@ information.
  3. By default the bigdecimal_as decimal is not set and the default encoding
     for Rails is as a string. Setting the value to true will encode a
     BigDecimal as a number which breaks compatibility.
+    Note: after version 3.11.3 both `Oj.generate` and `JSON.generate`
+    will not honour this option in Rails Mode, detais on https://github.com/ohler55/oj/pull/716.
 
  4. The integer indent value in the default options will be honored by since
     the json gem expects a String type the indent in calls to 'to_json()',