oj 3.10.1 → 3.11.1

data/pages/Options.md

@@ -66,6 +66,18 @@ 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.
+
+### :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.
+
 ### :circular [Boolean]
 
 Detect circular references while dumping. In :compat mode raise a
@@ -80,16 +92,16 @@ dynamically modifying classes or reloading classes then don't use this.
 
 ### :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,
+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.
 
@@ -179,7 +191,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
 
@@ -252,7 +264,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.
@@ -262,16 +274,16 @@ 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 mode even though it is not
+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 mean
+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.
@@ -279,9 +291,9 @@ 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.

data/pages/Rails.md

@@ -80,6 +80,45 @@ The classes that can be put in optimized mode and are optimized when
 The ActiveSupport decoder is the `JSON.parse()` method. Calling the
 `Oj::Rails.set_decoder()` method replaces that method with the Oj equivalent.
 
+### Usage in Rails 3
+
+To support Rails 3 you can create a new module mixin to prepend to controllers:
+
+```ruby
+require 'oj'
+
+module OjJsonEncoder
+  def render(options = nil, extra_options = {}, &block)
+    if options && options.is_a?(Hash) && options[:json]
+      obj = options.delete(:json)
+      obj = Oj.dump(obj, :mode => :rails) unless obj.is_a?(String)
+      options[:text] = obj
+      response.content_type ||= Mime::JSON
+    end
+    super
+  end
+end
+```
+
+Usage:
+
+```ruby
+class MyController < ApplicationController
+  prepend OjJsonEncoder
+  def index
+    render :json => { :hello => 'world' }
+  end
+end
+```
+
+### Older Ruby Version Support (Pre 2.3.0)
+
+If you are using an older version of Ruby, you can pin `oj` to an earlier version in your Gemfile:
+
+```ruby
+gem 'oj', '3.7.12'
+```
+
 ### Notes:
 
 1. Optimized Floats set the significant digits to 16. This is different than

data/test/bar.rb

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# encoding: UTF-8
 
 $: << File.dirname(__FILE__)
 $oj_dir = File.dirname(File.expand_path(File.dirname(__FILE__)))
@@ -7,16 +6,30 @@ $oj_dir = File.dirname(File.expand_path(File.dirname(__FILE__)))
   $: << File.join($oj_dir, dir)
 end
 
-require 'rails'
 require 'active_support'
-require 'active_support/json'
+require "active_support/json"
 
-require 'oj'
+$s = "\u2014 & \n \u{1F618}"
+
+=begin
+def check(label)
+  puts "\n--- #{label} --------------------"
+
+  ActiveSupport::JSON::Encoding.use_standard_json_time_format = true
+  puts "with standard_json == true: t.to_json - #{$t.to_json}"
+  ActiveSupport::JSON::Encoding.use_standard_json_time_format = false
+  puts "with standard_json == false: t.to_json - #{$t.to_json}"
+end
+
+check('Before Oj')
+=end
 
-puts Rails::VERSION::STRING
+require 'oj'
 
-#Oj.optimize_rails
+ActiveSupport::JSON::Encoding.escape_html_entities_in_json = false
+puts "ActiveSupport.encode(s) - #{ActiveSupport::JSON.encode($s)}"
 
-h = {foo: "bar"}
+Oj.optimize_rails
+Oj.default_options = { mode: :rails }
 
-puts Oj.dump(h, mode: :rails)
+puts "Oj.dump(s) - #{Oj.dump($s)}"

data/test/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+#
 # Ubuntu does not accept arguments to ruby when called using env. To get warnings to show up the -w options is
 # required. That can be set in the RUBYOPT environment variable.
 # export RUBYOPT=-w
@@ -16,6 +18,14 @@ require 'bigdecimal'
 require 'pp'
 require 'oj'
 
+
+if defined?(GC.verify_compaction_references) == 'method'
+  # This method was added in Ruby 3.0.0. Calling it this way asks the GC to
+  # move objects around, helping to find object movement bugs.
+  GC.verify_compaction_references(double_heap: true, toward: :empty)
+end
+
+
 $ruby = RUBY_DESCRIPTION.split(' ')[0]
 $ruby = 'ree' if 'ruby' == $ruby && RUBY_DESCRIPTION.include?('Ruby Enterprise Edition')
 

data/test/json_gem/json_common_interface_test.rb

@@ -15,7 +15,7 @@ class JSONCommonInterfaceTest < Test::Unit::TestCase
   def setup
     @hash = {
       'a' => 2,
-      'b' => 3.141,
+      #'b' => 5.23683071,
       'c' => 'c',
       'd' => [ 1, "b", 3.14 ],
       'e' => { 'foo' => 'bar' },
@@ -23,8 +23,13 @@ class JSONCommonInterfaceTest < Test::Unit::TestCase
       'h' => 1000.0,
       'i' => 0.001
     }
-    @json = '{"a":2,"b":3.141,"c":"c","d":[1,"b",3.14],"e":{"foo":"bar"},'\
-      '"g":"\\"\\u0000\\u001f","h":1000.0,"i":0.001}'
+    # Tired of chasing floating point rounding and precision. Oj now uses the
+    # Ruby float parser in compat mode yet on i386 machines there are issues
+    # with this test when the float is included.
+    #@json = '{"a":2,"b":5.23683071,"c":"c","d":[1,"b",3.14],"e":{"foo":"bar"},'\
+    #'"g":"\\"\\u0000\\u001f","h":1000.0,"i":0.001}'
+    @json = '{"a":2,"c":"c","d":[1,"b",3.14],"e":{"foo":"bar"},'\
+	    '"g":"\\"\\u0000\\u001f","h":1000.0,"i":0.001}'
   end
 
   def test_index

data/test/json_gem/json_generator_test.rb

@@ -136,6 +136,10 @@ EOT
 
   def test_pretty_state
     state = JSON::PRETTY_STATE_PROTOTYPE.dup
+    # In come cases in Ruby 3.0 an :escape_slash is included in the state. It
+    # seems to occur on travis but not locally.
+    actual = state.to_h
+    actual.delete(:escape_slash)
     assert_equal({
       :allow_nan             => false,
       :array_nl              => "\n",
@@ -147,11 +151,15 @@ EOT
       :object_nl             => "\n",
       :space                 => " ",
       :space_before          => "",
-    }.sort_by { |n,| n.to_s }, state.to_h.sort_by { |n,| n.to_s })
+    }.sort_by { |n,| n.to_s }, actual.sort_by { |n,| n.to_s })
   end
 
   def test_safe_state
     state = JSON::SAFE_STATE_PROTOTYPE.dup
+    # In come cases in Ruby 3.0 an :escape_slash is included in the state. It
+    # seems to occur on travis but not locally.
+    actual = state.to_h
+    actual.delete(:escape_slash)
     assert_equal({
       :allow_nan             => false,
       :array_nl              => "",
@@ -163,11 +171,15 @@ EOT
       :object_nl             => "",
       :space                 => "",
       :space_before          => "",
-    }.sort_by { |n,| n.to_s }, state.to_h.sort_by { |n,| n.to_s })
+    }.sort_by { |n,| n.to_s }, actual.sort_by { |n,| n.to_s })
   end
 
   def test_fast_state
     state = JSON::FAST_STATE_PROTOTYPE.dup
+    # In come cases in Ruby 3.0 an :escape_slash is included in the state. It
+    # seems to occur on travis but not locally.
+    actual = state.to_h
+    actual.delete(:escape_slash)
     assert_equal({
       :allow_nan             => false,
       :array_nl              => "",
@@ -179,7 +191,7 @@ EOT
       :object_nl             => "",
       :space                 => "",
       :space_before          => "",
-    }.sort_by { |n,| n.to_s }, state.to_h.sort_by { |n,| n.to_s })
+    }.sort_by { |n,| n.to_s }, actual.sort_by { |n,| n.to_s })
   end
 
   def test_allow_nan

data/test/json_gem/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $: << File.dirname(__FILE__)
 $oj_dir = File.dirname(File.dirname(File.expand_path(File.dirname(__FILE__))))
 %w(lib ext).each do |dir|
@@ -12,6 +14,12 @@ if ENV['REAL_JSON_GEM']
 else
   require 'oj'
   Oj.mimic_JSON
+
+  if defined?(GC.verify_compaction_references) == 'method'
+    # This method was added in Ruby 3.0.0. Calling it this way asks the GC to
+    # move objects around, helping to find object movement bugs.
+    GC.verify_compaction_references(double_heap: true, toward: :empty)
+  end
 end
 
 NaN = JSON::NaN if defined?(JSON::NaN)

data/test/prec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'oj'
+
+extras = {"locationLng" => -97.14690769100295}
+
+Oj.default_options = {float_precision: 17}
+
+encoded = Oj.dump(extras)
+puts encoded
+puts Oj.load(encoded)
+
+require "active_record"
+
+Oj::Rails.set_encoder()
+Oj::Rails.set_decoder()
+
+Oj.default_options = {float_precision: 17}
+# Using Oj rails encoder, gets the correct value: {"locationLng":-97.14690769100295}
+encoded = ActiveSupport::JSON.encode(extras)
+puts encoded
+puts ActiveSupport::JSON.decode(encoded)
+puts Oj.load(encoded)

data/test/sample_json.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby -wW2
+#!/usr/bin/env ruby
 
 if $0 == __FILE__
   $: << '.'

data/test/test_compat.rb

@@ -178,7 +178,7 @@ class CompatJuice < Minitest::Test
     assert_equal('"abc"', json)
   end
 
-  def test_time
+  def test_time_xml_schema
     t = Time.xmlschema("2012-01-05T23:58:07.123456000+09:00")
     #t = Time.local(2012, 1, 5, 23, 58, 7, 123456)
     json = Oj.dump(t, :mode => :compat)
@@ -236,6 +236,12 @@ class CompatJuice < Minitest::Test
     assert_equal({"a\nb" => true, "c\td" => false}, obj)
   end
 
+  def test_invalid_escapes_handled
+    json = '{"subtext":"\"404er\” \w \k \3 \a"}'
+    obj = Oj.compat_load(json)
+    assert_equal({"subtext" => "\"404er” w k 3 a"}, obj)
+  end
+
   def test_hash_escaping
     json = Oj.to_json({'<>' => '<>'}, mode: :compat)
     assert_equal(json, '{"<>":"<>"}')
@@ -271,12 +277,19 @@ class CompatJuice < Minitest::Test
   # BigDecimal
   def test_bigdecimal
     # BigDecimals are dumped as strings and can not be restored to the
-    # original value.
+    # original value without using an undocumented feature of the JSON gem.
     json = Oj.dump(BigDecimal('3.14159265358979323846'))
     # 2.4.0 changes the exponent to lowercase
     assert_equal('"0.314159265358979323846e1"', json.downcase)
   end
 
+  def test_decimal_class
+    big = BigDecimal('3.14159265358979323846')
+    # :decimal_class is the undocumented feature.
+    json = Oj.load('3.14159265358979323846', mode: :compat, decimal_class: BigDecimal)
+    assert_equal(big, json)
+  end
+
   def test_infinity
     assert_raises(Oj::ParseError) { Oj.load('Infinity', :mode => :strict) }
     x = Oj.load('Infinity', :mode => :compat)
@@ -284,7 +297,7 @@ class CompatJuice < Minitest::Test
   end
 
   # Time
-  def test_time
+  def test_time_from_time_object
     t = Time.new(2015, 1, 5, 21, 37, 7.123456, -8 * 3600)
     expect = '"' + t.to_s + '"'
     json = Oj.dump(t)

data/test/test_custom.rb

@@ -118,6 +118,17 @@ class CustomJuice < Minitest::Test
     dump_and_load(-2.48e100 * 1.0e10, false)
   end
 
+  def test_float_parse
+    f = Oj.load("12.123456789012345678", mode: :custom, bigdecimal_load: :float);
+    assert_equal(Float, f.class)
+  end
+
+  def test_float_parse_fast
+    f = Oj.load("12.123456789012345678", mode: :custom, bigdecimal_load: :fast);
+    assert_equal(Float, f.class)
+    assert(12.12345678901234 <= f && f < 12.12345678901236)
+  end
+
   def test_nan_dump
     assert_equal('null', Oj.dump(0/0.0, :nan => :null))
     assert_equal('3.3e14159265358979323846', Oj.dump(0/0.0, :nan => :huge))

data/test/test_object.rb

@@ -869,6 +869,14 @@ class ObjectJuice < Minitest::Test
     assert_equal(a2[1].__id__, a2.__id__)
   end
 
+  def test_circular_array3
+    a = ['^r1']
+    json = Oj.dump(a, mode: :object, circular: true)
+    assert_equal(%{["^i1","\\u005er1"]}, json)
+    a2 = Oj.load(json, mode: :object, circular: true)
+    assert_equal(a, a2)
+  end
+
   def test_circular_hash2
     h = { 'a' => 7 }
     h['b'] = h

data/test/test_rails.rb

@@ -23,4 +23,13 @@ class RailsJuice < Minitest::Test
     assert_equal('0.123e3', json.downcase)
   end
 
+  def test_invalid_encoding
+    assert_raises(EncodingError) {
+      Oj.dump("\"\xf3j", mode: :rails)
+    }
+    assert_raises(EncodingError) {
+      Oj.dump("\xf3j", mode: :rails)
+    }
+  end
+
 end

data/test/test_various.rb

@@ -120,6 +120,7 @@ class Juice < Minitest::Test
       escape_mode: :ascii,
       time_format: :unix_zone,
       bigdecimal_load: :float,
+      compat_bigdecimal: true,
       create_id: 'classy',
       create_additions: true,
       space: 'z',
@@ -185,7 +186,6 @@ class Juice < Minitest::Test
     n = Oj.load('-0.000012345678901234567')
     assert_equal(BigDecimal, n.class)
     assert_equal('-0.12345678901234567E-4', n.to_s.upcase)
-
   end
 
 =begin
@@ -671,7 +671,7 @@ class Juice < Minitest::Test
 	raise e
       end
     }
-    assert_equal('first[2].third', msg.split('(')[1].split(')')[0])
+    assert_equal('after first[2].third', msg.split('(')[1].split(')')[0])
   end
 
   def test_bad_bignum