RubyGems - oj - Versions diffs - 3.7.4 → 3.13.21 - Mend

oj 3.7.4 → 3.13.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (142) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +1352 -0
data/README.md +29 -8
data/RELEASE_NOTES.md +61 -0
data/ext/oj/buf.h +53 -72
data/ext/oj/cache.c +326 -0
data/ext/oj/cache.h +21 -0
data/ext/oj/cache8.c +61 -64
data/ext/oj/cache8.h +12 -39
data/ext/oj/circarray.c +37 -43
data/ext/oj/circarray.h +16 -17
data/ext/oj/code.c +165 -179
data/ext/oj/code.h +27 -29
data/ext/oj/compat.c +174 -194
data/ext/oj/custom.c +809 -866
data/ext/oj/debug.c +132 -0
data/ext/oj/dump.c +848 -863
data/ext/oj/dump.h +81 -67
data/ext/oj/dump_compat.c +85 -123
data/ext/oj/dump_leaf.c +100 -188
data/ext/oj/dump_object.c +527 -656
data/ext/oj/dump_strict.c +315 -338
data/ext/oj/encode.h +7 -34
data/ext/oj/encoder.c +43 -0
data/ext/oj/err.c +40 -29
data/ext/oj/err.h +48 -48
data/ext/oj/extconf.rb +17 -4
data/ext/oj/fast.c +1070 -1087
data/ext/oj/intern.c +301 -0
data/ext/oj/intern.h +26 -0
data/ext/oj/mimic_json.c +469 -436
data/ext/oj/object.c +525 -593
data/ext/oj/odd.c +154 -138
data/ext/oj/odd.h +37 -38
data/ext/oj/oj.c +1325 -986
data/ext/oj/oj.h +333 -316
data/ext/oj/parse.c +1002 -846
data/ext/oj/parse.h +92 -87
data/ext/oj/parser.c +1557 -0
data/ext/oj/parser.h +91 -0
data/ext/oj/rails.c +888 -878
data/ext/oj/rails.h +11 -14
data/ext/oj/reader.c +141 -147
data/ext/oj/reader.h +73 -89
data/ext/oj/resolve.c +41 -62
data/ext/oj/resolve.h +7 -9
data/ext/oj/rxclass.c +71 -75
data/ext/oj/rxclass.h +18 -19
data/ext/oj/saj.c +443 -486
data/ext/oj/saj2.c +602 -0
data/ext/oj/scp.c +88 -113
data/ext/oj/sparse.c +787 -709
data/ext/oj/stream_writer.c +133 -159
data/ext/oj/strict.c +127 -118
data/ext/oj/string_writer.c +230 -249
data/ext/oj/trace.c +34 -41
data/ext/oj/trace.h +19 -19
data/ext/oj/usual.c +1254 -0
data/ext/oj/util.c +136 -0
data/ext/oj/util.h +20 -0
data/ext/oj/val_stack.c +59 -67
data/ext/oj/val_stack.h +91 -129
data/ext/oj/validate.c +46 -0
data/ext/oj/wab.c +342 -353
data/lib/oj/bag.rb +1 -0
data/lib/oj/easy_hash.rb +5 -4
data/lib/oj/error.rb +1 -1
data/lib/oj/json.rb +1 -1
data/lib/oj/mimic.rb +48 -14
data/lib/oj/saj.rb +20 -6
data/lib/oj/state.rb +8 -7
data/lib/oj/version.rb +2 -2
data/lib/oj.rb +0 -8
data/pages/Compatibility.md +1 -1
data/pages/JsonGem.md +15 -0
data/pages/Modes.md +53 -46
data/pages/Options.md +72 -11
data/pages/Parser.md +309 -0
data/pages/Rails.md +73 -22
data/pages/Security.md +1 -1
data/test/activerecord/result_test.rb +7 -2
data/test/activesupport5/abstract_unit.rb +45 -0
data/test/activesupport5/decoding_test.rb +68 -60
data/test/activesupport5/encoding_test.rb +111 -96
data/test/activesupport5/encoding_test_cases.rb +33 -25
data/test/activesupport5/test_helper.rb +43 -21
data/test/activesupport5/time_zone_test_helpers.rb +18 -3
data/test/activesupport6/abstract_unit.rb +44 -0
data/test/activesupport6/decoding_test.rb +133 -0
data/test/activesupport6/encoding_test.rb +507 -0
data/test/activesupport6/encoding_test_cases.rb +98 -0
data/test/activesupport6/test_common.rb +17 -0
data/test/activesupport6/test_helper.rb +163 -0
data/test/activesupport6/time_zone_test_helpers.rb +39 -0
data/test/activesupport7/abstract_unit.rb +49 -0
data/test/activesupport7/decoding_test.rb +125 -0
data/test/activesupport7/encoding_test.rb +486 -0
data/test/activesupport7/encoding_test_cases.rb +104 -0
data/test/activesupport7/time_zone_test_helpers.rb +47 -0
data/test/bar.rb +6 -12
data/test/baz.rb +16 -0
data/test/bug.rb +16 -0
data/test/foo.rb +69 -75
data/test/helper.rb +16 -0
data/test/json_gem/json_common_interface_test.rb +8 -3
data/test/json_gem/json_generator_test.rb +18 -4
data/test/json_gem/json_parser_test.rb +9 -0
data/test/json_gem/test_helper.rb +12 -0
data/test/mem.rb +33 -0
data/test/perf.rb +1 -1
data/test/perf_dump.rb +50 -0
data/test/perf_once.rb +58 -0
data/test/perf_parser.rb +189 -0
data/test/perf_scp.rb +11 -10
data/test/perf_strict.rb +17 -23
data/test/prec.rb +23 -0
data/test/sample_json.rb +1 -1
data/test/test_compat.rb +46 -10
data/test/test_custom.rb +147 -8
data/test/test_fast.rb +62 -2
data/test/test_file.rb +25 -2
data/test/test_gc.rb +13 -0
data/test/test_generate.rb +21 -0
data/test/test_hash.rb +11 -1
data/test/test_integer_range.rb +7 -2
data/test/test_object.rb +85 -9
data/test/test_parser.rb +27 -0
data/test/test_parser_saj.rb +335 -0
data/test/test_parser_usual.rb +217 -0
data/test/test_rails.rb +35 -0
data/test/test_saj.rb +1 -1
data/test/test_scp.rb +5 -5
data/test/test_strict.rb +26 -1
data/test/test_various.rb +87 -65
data/test/test_wab.rb +2 -0
data/test/test_writer.rb +19 -2
data/test/tests.rb +1 -1
data/test/zoo.rb +13 -0
metadata +60 -110
data/ext/oj/hash.c +0 -163
data/ext/oj/hash.h +0 -46
data/ext/oj/hash_test.c +0 -512

data/lib/oj/bag.rb CHANGED Viewed

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Oj

data/lib/oj/easy_hash.rb CHANGED Viewed

@@ -12,13 +12,14 @@ module Oj
     # 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)

data/lib/oj/error.rb CHANGED Viewed

@@ -16,7 +16,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 CHANGED Viewed

@@ -95,7 +95,7 @@ module JSON
   State = ::JSON::Ext::Generator::State unless defined?(::JSON::State)
   begin
-    Object.send(:remove_const, :Parser)
+    send(:remove_const, :Parser)
   rescue
   end
   Parser = ::JSON::Ext::Parser unless defined?(::JSON::Parser)

data/lib/oj/mimic.rb CHANGED Viewed

@@ -8,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.
@@ -31,14 +77,14 @@ module Oj
   end
   # Loads mimic-ed JSON paths. Used by Oj.mimic_JSON().
-  # @param mimic_path [Array] additional paths to add to the Ruby loaded features.
+  # @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|
         # 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')
@@ -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)

data/lib/oj/saj.rb CHANGED Viewed

@@ -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/state.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 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 +44,11 @@ module JSON
           def to_h()
             return @attrs.dup
           end
           def to_hash()
             return @attrs.dup
           end
           def allow_nan?()
             @attrs[:allow_nan]
           end
@@ -104,7 +104,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.
@@ -116,11 +116,12 @@ module JSON
               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)
+	    end
+	    return @attrs.send(m, *args, &block)
           end
         end # State

data/lib/oj/version.rb CHANGED Viewed

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

data/lib/oj.rb CHANGED Viewed

@@ -2,14 +2,6 @@
 module Oj
 end
-begin
-  # This require exists to get around Rubinius failing to load bigdecimal from
-  # the C extension.
-  require 'bigdecimal'
-rescue Exception
-  # ignore
-end
 require 'oj/version'
 require 'oj/bag'
 require 'oj/easy_hash'

data/pages/Compatibility.md CHANGED Viewed

@@ -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/JsonGem.md CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -14,7 +14,7 @@ modes are:
  - `:object`
  - `:custom`
-Since modes detemine what the JSON output will look like and alternatively
+Since modes determine what the JSON output will look like and alternatively
 what Oj expects when the `Oj.load()` method is called, mixing the output and
 input mode formats will most likely not behave as intended. If the object mode
 is used for producing JSON then use object mode for reading. The same is true
@@ -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
@@ -84,49 +85,54 @@ options available in each mode. An `x` in the matrix indicates the option is
 supported in that mode. A number indicates the footnotes describe additional
 information.
-    | Option                 | type    | :null   | :strict | :compat | :rails  | :object | :custom |  :wab   |
-    | ---------------------- | ------- | ------- | ------- | ------- | ------- | ------- | ------- | ------- |
-    | :allow_blank           | Boolean |         |         |       1 |       1 |         |       x |         |
-    | :allow_gc              | Boolean |       x |       x |       x |       x |       x |       x |         |
-    | :allow_invalid_unicode | Boolean |         |         |         |         |       x |       x |         |
-    | :allow_nan             | Boolean |         |         |       x |         |       x |       x |         |
-    | :array_class           | Class   |         |         |       x |       x |         |       x |         |
-    | :array_nl              | String  |         |         |         |         |         |       x |         |
-    | :ascii_only            | Boolean |       x |       x |       2 |       2 |       x |       x |         |
-    | :auto_define           | Boolean |         |         |         |         |       x |       x |         |
-    | :bigdecimal_as_decimal | Boolean |         |         |         |       3 |       x |       x |         |
-    | :bigdecimal_load       | Boolean |         |         |         |         |         |       x |         |
-    | :circular              | Boolean |       x |       x |       x |       x |       x |       x |         |
-    | :class_cache           | Boolean |         |         |         |         |       x |       x |         |
-    | :create_additions      | Boolean |         |         |       x |       x |         |       x |         |
-    | :create_id             | String  |         |         |       x |       x |         |       x |         |
-    | :empty_string          | Boolean |         |         |         |         |         |       x |         |
-    | :escape_mode           | Symbol  |         |         |         |         |         |       x |         |
-    | :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_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 |         |
-    | :mode                  | Symbol  |       - |       - |       - |       - |       - |       - |         |
-    | :nan                   | Symbol  |         |         |         |         |         |       x |         |
-    | :nilnil                | Boolean |         |         |         |         |         |       x |         |
-    | :object_class          | Class   |         |         |       x |         |         |       x |         |
-    | :object_nl             | String  |         |         |       x |       x |         |       x |         |
-    | :omit_nil              | Boolean |       x |       x |       x |       x |       x |       x |         |
-    | :quirks_mode           | Boolean |         |         |       6 |         |         |       x |         |
-    | :second_precision      | Fixnum  |         |         |         |         |       x |       x |         |
-    | :space                 | String  |         |         |       x |       x |         |       x |         |
-    | :space_before          | String  |         |         |       x |       x |         |       x |         |
-    | :symbol_keys           | Boolean |       x |       x |       x |       x |       x |       x |         |
-    | :trace                 | Boolean |       x |       x |       x |       x |       x |       x |       x |
-    | :time_format           | Symbol  |         |         |         |         |       x |       x |         |
-    | :use_as_json           | Boolean |         |         |         |         |         |       x |         |
-    | :use_to_hash           | Boolean |         |         |         |         |         |       x |         |
-    | :use_to_json           | Boolean |         |         |         |         |         |       x |         |
-     --------------------------------------------------------------------------------------------------------
+| Option                 | type    | :null   | :strict | :compat | :rails  | :object | :custom |  :wab   |
+| ---------------------- | ------- | ------- | ------- | ------- | ------- | ------- | ------- | ------- |
+| :allow_blank           | Boolean |         |         |       1 |       1 |         |       x |         |
+| :allow_gc              | Boolean |       x |       x |       x |       x |       x |       x |         |
+| :allow_invalid_unicode | Boolean |         |         |         |         |       x |       x |         |
+| :allow_nan             | Boolean |         |         |       x |         |       x |       x |         |
+| :array_class           | Class   |         |         |       x |       x |         |       x |         |
+| :array_nl              | String  |         |         |         |         |         |       x |         |
+| :ascii_only            | Boolean |       x |       x |       2 |       2 |       x |       x |         |
+| :auto_define           | Boolean |         |         |         |         |       x |       x |         |
+| :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 |         |
+| :create_id             | String  |         |         |       x |       x |         |       x |         |
+| :empty_string          | Boolean |         |         |         |         |         |       x |         |
+| :escape_mode           | Symbol  |         |         |         |         |         |       x |         |
+| :float_precision       | Fixnum  |       x |       x |         |         |         |       x |         |
+| :hash_class            | Class   |         |         |       x |       x |         |       x |         |
+| :ignore                | Array   |         |         |         |         |       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  |       5 |       5 |       x |         |       5 |       5 |         |
+| :mode                  | Symbol  |       - |       - |       - |       - |       - |       - |         |
+| :nan                   | Symbol  |         |         |         |         |         |       x |         |
+| :nilnil                | Boolean |         |         |         |         |         |       x |         |
+| :object_class          | Class   |         |         |       x |         |         |       x |         |
+| :object_nl             | String  |         |         |       x |       x |         |       x |         |
+| :omit_nil              | Boolean |       x |       x |       x |       x |       x |       x |         |
+| :quirks_mode           | Boolean |         |         |       6 |         |         |       x |         |
+| :safe                  | String  |         |         |       x |         |         |         |         |
+| :second_precision      | Fixnum  |         |         |         |         |       x |       x |         |
+| :space                 | String  |         |         |       x |       x |         |       x |         |
+| :space_before          | String  |         |         |       x |       x |         |       x |         |
+| :symbol_keys           | Boolean |       x |       x |       x |       x |       x |       x |         |
+| :trace                 | Boolean |       x |       x |       x |       x |       x |       x |       x |
+| :time_format           | Symbol  |         |         |         |         |       x |       x |         |
+| :use_as_json           | Boolean |         |         |         |         |         |       x |         |
+| :use_raw_json          | Boolean |         |         |       x |       x |       x |       x |         |
+| :use_to_hash           | Boolean |         |         |         |         |         |       x |         |
+| :use_to_json           | Boolean |         |         |         |         |         |       x |         |
+ --------------------------------------------------------------------------------------------------------
  1. :allow_blank an alias for :nilnil.
@@ -135,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()',
@@ -151,4 +159,3 @@ information.
  6. The quirks mode option is no longer supported in the most recent json
     gem. It is supported by Oj for backward compatibility with older json gem
     versions.

data/pages/Options.md CHANGED Viewed

@@ -66,6 +66,32 @@ Determines how to load decimals.
  - `:auto` the most precise for the number of digits is used.
+This can also be set with `:decimal_class` when used as a load or
+parse option to match the JSON gem. In that case either `Float`,
+`BigDecimal`, or `nil` can be provided.
+### :cache_keys [Boolean]
+If true Hash keys are cached or interned. There are trade-offs with
+caching keys. Large caches will use more memory and in extreme cases
+(like over a million) the cache may be slower than not using
+it. Repeated parsing of similar JSON docs is where cache_keys shines
+especially with symbol keys.
+There is a maximum length for cached keys. Any key longer than 34
+bytes is not cached. Everything still works but the key is not cached.
+### :cache_strings [Int]
+Shorter strings can be cached for better performance. A limit,
+cache_strings, defines the upper limit on what strings are cached. As
+with cached keys only strings less than 35 bytes are cached even if
+the limit is set higher. Setting the limit to zero effectively
+disables the caching of string values.
+Note that caching for strings is for string values and not Hash keys
+or Object attributes.
 ### :circular [Boolean]
 Detect circular references while dumping. In :compat mode raise a
@@ -78,17 +104,29 @@ recreate the looped references on load.
 Cache classes for faster parsing. This option should not be used if
 dynamically modifying classes or reloading classes then don't use this.
+### :compat_bigdecimal [Boolean]
+Determines how to load decimals when in `:compat` mode.
+ - `true` convert all decimal numbers to BigDecimal.
+ - `false` convert all decimal numbers to Float.
 ### :create_additions
-A flag indicating the :create_id key when encountered during parsing should
-creating an Object mactching the class name specified in the value associated
-with the key.
+A flag indicating that the :create_id key, when encountered during parsing,
+should create an Object matching the class name specified in the value
+associated with the key.
 ### :create_id [String]
 The :create_id option specifies that key is used for dumping and loading when
 specifying the class for an encoded object. The default is `json_create`.
+In the `:custom` mode, setting the `:create_id` to nil will cause Complex,
+Rational, Range, and Regexp to be output as strings instead of as JSON
+objects.
 ### :empty_string [Boolean]
 If true an empty or all whitespace input will not raise an Exception. The
@@ -149,7 +187,7 @@ integer gives better performance.
 ### :integer_range [Range]
-Dump integers outside range as strings.
+Dump integers outside range as strings.
 Note: range bounds must be Fixnum.
 ### :match_string
@@ -175,7 +213,7 @@ customization.
 ### :nan [Symbol]
 How to dump Infinity, -Infinity, and NaN in :null, :strict, and :compat
-mode. Default is :auto but is ignored in the :compat and :rails mode.
+mode. Default is :auto but is ignored in the :compat and :rails modes.
  - `:null` places a null
@@ -211,6 +249,12 @@ Allow single JSON values instead of documents, default is true (allow). This
 can also be used in :compat mode to be backward compatible with older versions
 of the json gem.
+### :safe
+The JSON gem includes the complete JSON in parse errors with no limit
+on size. To break from the JSON gem behavior for this case set `:safe`
+to true.
 ### :second_precision [Fixnum]
 The number of digits after the decimal when dumping the seconds of time.
@@ -229,7 +273,13 @@ compatibility. Using just indent as an integer gives better performance.
 ### :symbol_keys [Boolean]
-Use symbols instead of strings for hash keys. :symbolize_names is an alias.
+Use symbols instead of strings for hash keys.
+### :symbolize_names [Boolean]
+Like :symbol_keys has keys are made into symbols but only when
+mimicking the JSON gem and then only as the JSON gem honors it so
+JSON.parse honors the option but JSON.load does not.
 ### :trace
@@ -242,7 +292,7 @@ The :time_format when dumping.
  - `:unix` time is output as a decimal number in seconds since epoch including fractions of a second.
- - `:unix_zone` similar to the `:unix` format but with the timezone encoded in
+ - `:unix_zone` is similar to the `:unix` format but with the timezone encoded in
    the exponent of the decimal number of seconds since epoch.
  - `:xmlschema` time is output as a string that follows the XML schema definition.
@@ -252,15 +302,26 @@ The :time_format when dumping.
 ### :use_as_json [Boolean]
 Call `as_json()` methods on dump, default is false. The option is ignored in
-the :compat and :rails mode.
+the :compat and :rails modes.
+### :use_raw_json [Boolean]
+Call `raw_json()` methods on dump, default is false. The option is
+accepted in the :compat and :rails modes even though it is not
+supported by other JSON gems. It provides a means to optimize dump or
+generate performance. The `raw_json(depth, indent)` method should be
+called only by Oj. It is not intended for any other use. This is meant
+to replace the abused `to_json` methods. Calling `Oj.dump` inside the
+`raw_json` with the object itself when `:use_raw_json` is true will
+result in an infinite loop.
 ### :use_to_hash [Boolean]
 Call `to_hash()` methods on dump, default is false. The option is ignored in
-the :compat and :rails mode.
+the :compat and :rails modes.
 ### :use_to_json [Boolean]
 Call `to_json()` methods on dump, default is false. The option is ignored in
-the :compat and :rails mode.
+the :compat and :rails modes.