oj 3.9.1 → 3.16.11

data/lib/oj/active_support_helper.rb

@@ -1,16 +1,14 @@
+# frozen_string_literal: true
 
 require 'active_support/time'
 
 module Oj
-
   # Exists only to handle the ActiveSupport::TimeWithZone.
   class ActiveSupportHelper
-
     def self.createTimeWithZone(utc, zone)
       ActiveSupport::TimeWithZone.new(utc - utc.gmt_offset, ActiveSupport::TimeZone[zone])
     end
   end
-
 end
 
 Oj.register_odd(ActiveSupport::TimeWithZone, Oj::ActiveSupportHelper, :createTimeWithZone, :utc, 'time_zone.name')

data/lib/oj/bag.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Oj
 
@@ -14,7 +15,7 @@ module Oj
     # @example Oj::Bag.new(:@x => 42, :@y => 57)
     # @param [Hash] args instance variable symbols and their values
     def initialize(args = {})
-      args.each do |k,v|
+      args.each do |k, v|
         self.instance_variable_set(k, v)
       end
     end
@@ -25,6 +26,7 @@ module Oj
     #                   variable reader, otherwise false.
     def respond_to?(m)
       return true if super
+
       instance_variables.include?(:"@#{m}")
     end
 
@@ -36,8 +38,10 @@ module Oj
     # @raise [NoMethodError] if the instance variable is not defined.
     def method_missing(m, *args, &block)
       raise ArgumentError.new("wrong number of arguments (#{args.size} for 0) to method #{m}") unless args.nil? or args.empty?
+
       at_m = :"@#{m}"
       raise NoMethodError.new("undefined method #{m}", m) unless instance_variable_defined?(at_m)
+
       instance_variable_get(at_m)
     end
 
@@ -46,9 +50,11 @@ module Oj
     # @return [Boolean] true if each variable and value are the same, otherwise false.
     def eql?(other)
       return false if (other.nil? or self.class != other.class)
+
       ova = other.instance_variables
       iv = instance_variables
       return false if ova.size != iv.size
+
       iv.all? { |vid| instance_variable_get(vid) != other.instance_variable_get(vid) }
     end
     alias == eql?
@@ -64,6 +70,7 @@ module Oj
       classname = classname.to_s unless classname.is_a?(String)
       tokens = classname.split('::').map(&:to_sym)
       raise NameError.new("Invalid classname '#{classname}") if tokens.empty?
+
       m = Object
       tokens[0..-2].each do |sym|
         if m.const_defined?(sym)

data/lib/oj/easy_hash.rb

@@ -1,4 +1,3 @@
-
 module Oj
 
   # A Hash subclass that normalizes the hash keys to allow lookup by the
@@ -6,24 +5,23 @@ module Oj
   # that match the keys.
   class EasyHash < Hash
 
-    # Initializes the instance to an empty Hash.
-    def initialize()
-    end
-
     # Replaces the Object.respond_to?() method.
     # @param [Symbol] m method symbol
+    # @param [Boolean] include_all whether to include private and protected methods in the search
     # @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)
+      return true if has_key?(m)
+      return true if has_key?(m.to_s)
+
+      has_key?(m.to_sym)
     end
 
     def [](key)
       return fetch(key, nil) if has_key?(key)
       return fetch(key.to_s, nil) if has_key?(key.to_s)
+
       fetch(key.to_sym, nil)
     end
 
@@ -35,9 +33,11 @@ module Oj
     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[0..-2]
         return store(m.to_s, args[0]) if has_key?(m.to_s)
         return store(m.to_sym, args[0]) if has_key?(m.to_sym)
+
         return store(m, args[0])
       else
         raise ArgumentError.new("wrong number of arguments (#{args.size} for 0 with #{m}) to method #{m}") unless args.nil? or args.empty?

data/lib/oj/error.rb

@@ -1,4 +1,3 @@
-
 module Oj
 
   # Inherit Error class from StandardError.
@@ -16,7 +15,7 @@ module Oj
   # An Exception that is raised if a file fails to load.
   LoadError = Class.new(Error)
 
-  # An Exception that is raised if there is a conflict with mimicing JSON
+  # An Exception that is raised if there is a conflict with mimicking JSON
   MimicError = Class.new(Error)
 
 end # Oj

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,13 +1,56 @@
+# frozen_string_literal: false
 
 require 'bigdecimal'
-begin
-  require 'ostruct'
-rescue Exception
-  # ignore
-end
+require 'ostruct'
 
 module Oj
 
+  ##
+  # Custom mode can be used to emulate the compat mode with some minor
+  # differences. These are the options that setup the custom mode to be like
+  # the compat mode.
+  CUSTOM_MIMIC_JSON_OPTIONS = {
+    allow_gc: true,
+    allow_invalid_unicode: false,
+    allow_nan: false,
+    array_class: nil,
+    array_nl: nil,
+    auto_define: false,
+    bigdecimal_as_decimal: false,
+    bigdecimal_load: :auto,
+    circular: false,
+    class_cache: false,
+    cache_keys: true,
+    cache_str: 5,
+    create_additions: false,
+    create_id: "json_class",
+    empty_string: false,
+    escape_mode: :unicode_xss,
+    float_precision: 0,
+    hash_class: nil,
+    ignore: nil,
+    ignore_under: false,
+    indent: 0,
+    integer_range: nil,
+    mode: :custom,
+    nan: :raise,
+    nilnil: false,
+    object_nl: nil,
+    omit_nil: false,
+    quirks_mode: true,
+    safe: false,
+    second_precision: 3,
+    space: nil,
+    space_before: nil,
+    symbol_keys: false,
+    time_format: :ruby,
+    trace: false,
+    use_as_json: false,
+    use_raw_json: false,
+    use_to_hash: false,
+    use_to_json: true,
+  }
+
   # A bit hack-ish but does the trick. The JSON.dump_default_options is a Hash
   # but in mimic we use a C struct to store defaults. This class creates a view
   # onto that struct.
@@ -18,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)
@@ -38,7 +83,7 @@ module Oj
 
       jfile = File.join(d, 'json.rb')
       $LOADED_FEATURES << jfile unless $LOADED_FEATURES.include?(jfile) if File.exist?(jfile)
-      
+
       Dir.glob(File.join(d, 'json', '**', '*.rb')).each do |file|
         # allow json/add/xxx to be loaded. User can override with Oj.add_to_json(xxx).
         $LOADED_FEATURES << file unless $LOADED_FEATURES.include?(file) unless file.include?('add')
@@ -56,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
@@ -89,18 +135,6 @@ module Oj
       end
     end
 
-    Date.class_eval do
-      # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
-      unless defined?(self.as_json)
-        def as_json(*)
-          { JSON.create_id => 'Date', 'y' => year, 'm' => month, 'd' => day, 'sg' => start }
-        end
-      end
-      def self.json_create(h)
-        civil(h['y'], h['m'], h['d'], h['sg'])
-      end
-    end
-
     DateTime.class_eval do
       # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
       unless defined?(self.as_json)
@@ -198,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
@@ -229,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)
@@ -239,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
   #