oj 2.18.3 → 3.13.14

data/lib/oj/json.rb

@@ -0,0 +1,176 @@
+
+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
+    end
+  end
+
+  def self.parser=(p)
+    @@parser = p
+  end
+
+  def self.parser()
+    @@parser
+  end
+
+  def self.generator=(g)
+    @@generator = g
+  end
+
+  def self.generator()
+    @@generator
+  end
+
+  module Ext
+    class Parser
+      def initialize(src)
+        raise TypeError.new("already initialized") unless @source.nil?
+        @source = src
+      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
+
+      attr_writer :json_creatable
+
+      def json_create(data)
+        data = data.dup
+        data.delete JSON.create_id
+        self[data]
+      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 load(source, proc = nil, opts = {})
+        result = ::JSON.load(source, proc, opts.merge(:object_class => self))
+        result.nil? ? new : result
+      end
+
+      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 # JSON

data/lib/oj/mimic.rb

@@ -1,4 +1,5 @@
 
+require 'bigdecimal'
 begin
   require 'ostruct'
 rescue Exception
@@ -7,6 +8,52 @@ end
 
 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.
@@ -29,20 +76,25 @@ module Oj
     end
   end
 
+  # Loads mimic-ed JSON paths. Used by Oj.mimic_JSON().
+  # @param mimic_paths [Array] additional paths to add to the Ruby loaded features.
   def self.mimic_loaded(mimic_paths=[])
     $LOAD_PATH.each do |d|
       next unless File.exist?(d)
 
       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|
-        $LOADED_FEATURES << file unless $LOADED_FEATURES.include?(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')
       end
     end
     mimic_paths.each { |p| $LOADED_FEATURES << p }
     $LOADED_FEATURES << 'json' unless $LOADED_FEATURES.include?('json')
 
+    require 'oj/json'
+
     if Object.const_defined?('OpenStruct')
       OpenStruct.class_eval do
         # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
@@ -54,8 +106,87 @@ module Oj
           end
         end
         def self.json_create(h)
-          new(h['t'])
+          new(h['t'] || h[:t])
+        end
+      end
+    end
+
+    BigDecimal.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 => 'BigDecimal', 'b' => _dump }
+        end
+      end
+      def self.json_create(h)
+        BigDecimal._load(h['b'])
+      end
+    end
+
+    Complex.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 => 'Complex', 'r' => real, 'i' => imag }
+        end
+      end
+      def self.json_create(h)
+        Complex(h['r'], h['i'])
+      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)
+        def as_json(*)
+          { JSON.create_id => 'DateTime',
+            'y' => year,
+            'm' => month,
+            'd' => day,
+            'H' => hour,
+            'M' => min,
+            'S' => sec,
+            'of' => offset.to_s,
+            'sg' => start }
+        end
+      end
+      def self.json_create(h)
+        # offset is a rational as a string
+        as, bs = h['of'].split('/')
+        a = as.to_i
+        b = bs.to_i
+        if 0 == b
+          off = a
+        else
+          off = Rational(a, b)
         end
+        civil(h['y'], h['m'], h['d'], h['H'], h['M'], h['S'], off, h['sg'])
+      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
+
+    Exception.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 => self.class.name, 'm' => message, 'b' => backtrace }
+        end
+      end
+      def self.json_create(h)
+        e = new(h['m'])
+        e.set_backtrace(h['b'])
+        e
       end
     end
 
@@ -67,7 +198,7 @@ module Oj
         end
       end
       def self.json_create(h)
-        new(h['a'])
+        new(*h['a'])
       end
     end
 
@@ -105,7 +236,7 @@ module Oj
         end
       end
       def self.json_create(h)
-        new(h['v'])
+        new(*h['v'])
       end
     end
 
@@ -125,7 +256,6 @@ module Oj
       # 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 => 'Symbol', 's' => to_s }
           nsecs = [ tv_usec * 1000 ]
           nsecs << tv_nsec if respond_to?(:tv_nsec)
           nsecs = nsecs.max
@@ -144,19 +274,28 @@ module Oj
       end
     end
 
-    JSON.module_eval do
-      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
-        end
-      end
-    end
-
   end # self.mimic_loaded
 
 end # Oj
+
+# More monkey patches.
+class String
+  def to_json_raw_object
+    {
+      JSON.create_id => self.class.name,
+      'raw' => self.bytes
+    }
+  end
+  def to_json_raw(*)
+   to_json_raw_object().to_json()
+  end
+  def self.json_create(obj)
+    s = ''
+    s.encode!(Encoding::ASCII_8BIT) if s.respond_to?(:encode!)
+    raw = obj['raw']
+    if raw.is_a? Array
+      raw.each { |v| s << v }
+    end
+    s
+  end
+end

data/lib/oj/state.rb

@@ -0,0 +1,132 @@
+
+module JSON
+  module Ext
+    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
+        # recommended as it is simpler and performs better. The only bit
+        # missing by not using a state object is the depth availability which
+        # may be the depth during dumping or maybe not since it can be set and
+        # the docs for depth= is the same as max_nesting. Note: Had to make
+        # this a subclass of Object instead of Hash like EashyHash due to
+        # conflicts with the json gem.
+        class State
+
+          def self.from_state(opts)
+            s = self.new()
+            s.clear()
+            s.merge(opts)
+            s
+          end
+
+          def initialize(opts = {})
+            @attrs = {}
+
+            # Populate with all vars then merge in opts. This class deviates from
+            # the json gem in that any of the options can be set with the opts
+            # argument. The json gem limits the opts use to 7 of the options.
+            @attrs[:indent] = ''
+            @attrs[:space] = ''
+            @attrs[:space_before] = ''
+            @attrs[:array_nl] = ''
+            @attrs[:object_nl] = ''
+            @attrs[:allow_nan] = false
+            @attrs[:buffer_initial_length] = 1024 # completely ignored by Oj
+            @attrs[:depth] = 0
+            @attrs[:max_nesting] = 100
+            @attrs[:check_circular?] = true
+            @attrs[:ascii_only] = false
+
+            @attrs.merge!(opts)
+          end
+
+          def to_h()
+            return @attrs.dup
+          end
+
+          def to_hash()
+            return @attrs.dup
+          end
+
+          def allow_nan?()
+            @attrs[:allow_nan]
+          end
+
+          def ascii_only?()
+            @attrs[:ascii_only]
+          end
+
+          def configure(opts)
+            raise TypeError.new('expected a Hash') unless opts.respond_to?(:to_h)
+            @attrs.merge!(opts.to_h)
+          end
+
+          def generate(obj)
+            JSON.generate(obj)
+          end
+
+          def merge(opts)
+            @attrs.merge!(opts)
+          end
+
+          # special rule for this.
+          def buffer_initial_length=(len)
+            len = 1024 if 0 >= len
+            @attrs[:buffer_initial_length] = len
+          end
+
+          # Replaces the Object.respond_to?() method.
+          # @param [Symbol] m method symbol
+          # @return [Boolean] true for any method that matches an instance
+          #                   variable reader, otherwise false.
+          def respond_to?(m)
+            return true if super
+            return true if has_key?(key)
+            return true if has_key?(key.to_s)
+            has_key?(key.to_sym)
+          end
+
+          def [](key)
+            key = key.to_sym
+            @attrs.fetch(key, nil)
+          end
+
+          def []=(key, value)
+            key = key.to_sym
+            @attrs[key] = value
+          end
+
+          def clear()
+            @attrs.clear()
+          end
+
+          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.
+          # @raise [ArgumentError] if an argument is given. Zero arguments expected.
+          # @raise [NoMethodError] if the instance variable is not defined.
+          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])
+	    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
+	    return @attrs.send(m, *args, &block)
+          end
+
+        end # State
+      end # defined check
+    end # Generator
+  end # Ext
+
+end # JSON

data/lib/oj/version.rb

@@ -1,5 +1,5 @@
 
 module Oj
-  # Current version of the module. 
-  VERSION = '2.18.3'
+  # Current version of the module.
+  VERSION = '3.13.14'
 end

data/lib/oj.rb

@@ -1,35 +1,5 @@
-# Optimized JSON (Oj), as the name implies was written to provide speed
-# optimized JSON handling.
-# 
-# Oj has several dump or serialization modes which control how Objects are
-# converted to JSON. These modes are set with the :mode option in either the
-# default options or as one of the options to the dump() method.
-# 
-# - :strict mode will only allow the 7 basic JSON types to be serialized. Any other Object
-#   will raise and Exception. 
-# 
-# - :null mode replaces any Object that is not one of the JSON types is replaced by a JSON null.
-# 
-# - :object mode will dump any Object as a JSON Object with keys that match
-#   the Ruby Object's variable names without the '@' character. This is the
-#   highest performance mode.
-# 
-# - :compat mode is is the compatible with other systems. It will serialize
-#   any Object but will check to see if the Object implements a to_hash() or
-#   to_json() method. If either exists that method is used for serializing the
-#   Object. The to_hash() is more flexible and produces more consistent output
-#   so it has a preference over the to_json() method. If neither the to_json()
-#   or to_hash() methods exist then the Oj internal Object variable encoding
-#   is used.
-module Oj
-end
 
-begin
-  # This require exists to get around Rubinius failing to load bigdecimal from
-  # the C extension.
-  require 'bigdecimal'
-rescue Exception
-  # ignore
+module Oj
 end
 
 require 'oj/version'

data/pages/Advanced.md

@@ -0,0 +1,22 @@
+# Advanced Features
+
+Optimized JSON (Oj), as the name implies, was written to provide speed optimized
+JSON handling. It was designed as a faster alternative to Yajl and other
+common Ruby JSON parsers. So far it has achieved that, and is about 2 times faster
+than any other Ruby JSON parser, and 3 or more times faster at serializing JSON.
+
+Oj has several `dump` or serialization modes which control how Ruby `Object`s are
+converted to JSON. These modes are set with the `:mode` option in either the
+default options or as one of the options to the `dump` method. In addition to
+the various options there are also alternative APIs for parsing JSON.
+
+The fastest alternative parser API is the `Oj::Doc` API. The `Oj::Doc` API takes
+a completely different approach by opening a JSON document and providing calls
+to navigate around the JSON while it is open. With this approach, JSON access
+can be well over 20 times faster than conventional JSON parsing.
+
+The `Oj::Saj` and `Oj::ScHandler` APIs are callback parsers that
+walk the JSON document depth first and makes callbacks for each element.
+Both callback parser are useful when only portions of the JSON are of
+interest. Performance up to 20 times faster than conventional JSON is
+possible if only a few elements of the JSON are of interest.

data/pages/Compatibility.md

@@ -0,0 +1,25 @@
+# Compatibility
+
+**Ruby**
+
+Oj is compatible with Ruby 2.0.0, 2.1, 2.2, 2.3, 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.
+
+**Rails**
+
+Although up until 4.1 Rails uses [multi_json](https://github.com/intridea/multi_json), an [issue in Rails](https://github.com/rails/rails/issues/9212) causes ActiveSupport to fail to make use Oj for JSON handling.
+There is a
+[gem to patch this](https://github.com/GoodLife/rails-patch-json-encode) for
+Rails 3.2 and 4.0. As of the Oj 2.6.0 release the default behavior is to not use
+the `to_json()` method unless the `:use_to_json` option is set. This provides
+another work around to the rails older and newer behavior.
+
+The latest ActiveRecord is able to work with Oj by simply using the line:
+
+```
+serialize :metadata, Oj
+```
+
+In version Rails 4.1, multi_json has been removed, and this patch is unnecessary and will no longer work.
+See {file:Rails.md}.

data/pages/Custom.md

@@ -0,0 +1,23 @@
+# Custom mode
+
+The `:custom` mode is the most configurable mode and honors almost all
+options. It provides the most flexibility although it can not be configured to
+be exactly like any of the other modes. Each mode has some special aspect that
+makes it unique. For example, the `:object` mode has it's own unique format
+for object dumping and loading. The `:compat` mode mimic the json gem
+including methods called for encoding and inconsistencies between
+`JSON.dump()`, `JSON.generate()`, and `JSON()`.
+
+The `:custom` mode is the default mode. It can be configured either by passing
+options to the `Oj.dump()` and `Oj.load()` methods or by modifying the default
+options.
+
+The ability to create objects from JSON object elements is supported and
+considers the `:create_additions` option. Special treatment is given to the
+`:create_id` though. If the `:create_id` is set to `"^o"` then the Oj internal
+encoding and decoding is used. These are more efficient than calling out to a
+`to_json` method or `create_json` method on the classes. Those method do not
+have to exist for the `"^o"` behavior to be utilized. Any other `:create_id`
+value behaves similar to the json gem by calling `to_json` and `create_json`
+as appropriate.
+