oj 3.13.11 → 3.15.0

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

@@ -1,4 +1,3 @@
-
 module JSON
   module Ext
     module Generator
@@ -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
 
@@ -113,15 +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])
-	    end
-	    if @attrs.has_key?(m.to_sym)
+            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
+            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.13.11'
+  VERSION = '3.15.0'
 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/Options.md

@@ -66,6 +66,10 @@ Determines how to load decimals.
 
  - `:auto` the most precise for the number of digits is used.
 
+ - `:fast` faster conversion to Float.
+
+ - `:ruby` convert to Float using the Ruby `to_f` conversion.
+
 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.
@@ -154,6 +158,8 @@ Determines the characters to escape when dumping. Only the :ascii and
 
  - `:json` follows the JSON specification. This is the default mode.
 
+ - `:slash` escapes `/` characters.
+
  - `:xss_safe` escapes HTML and XML characters such as `&` and `<`.
 
  - `:ascii` escapes all non-ascii or characters with the hi-bit set.
@@ -259,6 +265,10 @@ to true.
 
 The number of digits after the decimal when dumping the seconds of time.
 
+### :skip_null_byte [Boolean]
+
+If true, null bytes in strings will be omitted when dumping.
+
 ### :space
 
 String inserted after the ':' character when dumping a JSON object. The

data/test/_test_active.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
-# encoding: UTF-8
+# frozen_string_literal: true
 
-$: << File.dirname(__FILE__)
+$LOAD_PATH << __dir__
 %w(lib ext test).each do |dir|
   $LOAD_PATH.unshift File.expand_path("../../#{dir}", __FILE__)
 end
@@ -13,14 +13,14 @@ require 'sqlite3'
 require 'active_record'
 require 'oj'
 
-#Oj.mimic_JSON()
+# Oj.mimic_JSON()
 Oj.default_options = {mode: :compat, indent: 2}
 
-#ActiveRecord::Base.logger = Logger.new(STDERR)
+# ActiveRecord::Base.logger = Logger.new(STDERR)
 
 ActiveRecord::Base.establish_connection(
-  :adapter => "sqlite3",
-  :database => ":memory:"
+  :adapter => 'sqlite3',
+  :database => ':memory:'
 )
 
 ActiveRecord::Schema.define do
@@ -37,8 +37,8 @@ end
 class ActiveTest < Minitest::Test
 
   def test_active
-    User.find_or_create_by(first_name: "John", last_name: "Smith", email: "john@example.com")
-    User.find_or_create_by(first_name: "Joan", last_name: "Smith", email: "joan@example.com")
+    User.find_or_create_by(first_name: 'John', last_name: 'Smith', email: 'john@example.com')
+    User.find_or_create_by(first_name: 'Joan', last_name: 'Smith', email: 'joan@example.com')
 
     # Single instance.
     assert_equal(%|{
@@ -71,6 +71,5 @@ class ActiveTest < Minitest::Test
 
     # Array of instances as json. (not Oj)
     assert_equal(%|[{"id":1,"first_name":"John","last_name":"Smith","email":"john@example.com"},{"id":2,"first_name":"Joan","last_name":"Smith","email":"joan@example.com"}]|, User.all.to_json)
-
   end
 end

data/test/_test_active_mimic.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
-# encoding: UTF-8
+# frozen_string_literal: true
 
-$: << File.dirname(__FILE__)
+$LOAD_PATH << __dir__
 %w(lib ext test).each do |dir|
   $LOAD_PATH.unshift File.expand_path("../../#{dir}", __FILE__)
 end
@@ -16,11 +16,11 @@ require 'oj'
 Oj.mimic_JSON()
 Oj.default_options = {mode: :compat, indent: 2}
 
-#ActiveRecord::Base.logger = Logger.new(STDERR)
+# ActiveRecord::Base.logger = Logger.new(STDERR)
 
 ActiveRecord::Base.establish_connection(
-  :adapter => "sqlite3",
-  :database => ":memory:"
+  :adapter => 'sqlite3',
+  :database => ':memory:'
 )
 
 ActiveRecord::Schema.define do
@@ -37,8 +37,8 @@ end
 class ActiveTest < Minitest::Test
 
   def test_active
-    User.find_or_create_by(first_name: "John", last_name: "Smith", email: "john@example.com")
-    User.find_or_create_by(first_name: "Joan", last_name: "Smith", email: "joan@example.com")
+    User.find_or_create_by(first_name: 'John', last_name: 'Smith', email: 'john@example.com')
+    User.find_or_create_by(first_name: 'Joan', last_name: 'Smith', email: 'joan@example.com')
 
     # Single instance.
     assert_equal(%|{
@@ -91,6 +91,5 @@ class ActiveTest < Minitest::Test
   }
 ]
 |, User.all.to_json)
-
   end
 end

data/test/_test_mimic_rails.rb

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
-# encoding: UTF-8
+# frozen_string_literal: true
 
-$: << File.dirname(__FILE__)
+$LOAD_PATH << __dir__
 
 require 'helper'
-#Oj.mimic_JSON
+# Oj.mimic_JSON
 require 'rails/all'
 
 require 'active_model'
@@ -36,14 +36,12 @@ end
 class MimicRails < Minitest::Test
 
   def test_mimic_exception
-    begin
-      ActiveSupport::JSON.decode("{")
-      puts "Failed"
-    rescue ActiveSupport::JSON.parse_error
-      assert(true)
-    rescue Exception
-      assert(false, 'Expected a JSON::ParserError')
-    end
+    ActiveSupport::JSON.decode('{')
+    puts 'Failed'
+  rescue ActiveSupport::JSON.parse_error
+    assert(true)
+  rescue Exception
+    assert(false, 'Expected a JSON::ParserError')
   end
 
   def test_dump_string
@@ -84,18 +82,17 @@ class MimicRails < Minitest::Test
     category = Category.new(1, 'test')
     serializer = CategorySerializer.new(category)
 
-    json = serializer.to_json()
+    serializer.to_json()
     puts "*** serializer.to_json() #{serializer.to_json()}"
-    json = serializer.as_json()
+    serializer.as_json()
     puts "*** serializer.as_json() #{serializer.as_json()}"
-    json = JSON.dump(serializer)
+    JSON.dump(serializer)
     puts "*** JSON.dump(serializer) #{JSON.dump(serializer)}"
 
     puts "*** category.to_json() #{category.to_json()}"
     puts "*** category.as_json() #{category.as_json()}"
     puts "*** JSON.dump(serializer) #{JSON.dump(category)}"
     puts "*** Oj.dump(serializer) #{Oj.dump(category)}"
-
   end
 
   def test_dump_object_array
@@ -104,7 +101,7 @@ class MimicRails < Minitest::Test
     cat2 = Category.new(2, 'test')
     a = Array.wrap([cat1, cat2])
 
-    #serializer = CategorySerializer.new(a)
+    # serializer = CategorySerializer.new(a)
 
     puts "*** a.to_json() #{a.to_json()}"
     puts "*** a.as_json() #{a.as_json()}"
@@ -114,13 +111,13 @@ class MimicRails < Minitest::Test
 
   def test_dump_time
     Oj.default_options= {:indent => 2}
-    now = ActiveSupport::TimeZone['America/Chicago'].parse("2014-11-01 13:20:47")
+    now = ActiveSupport::TimeZone['America/Chicago'].parse('2014-11-01 13:20:47')
     json = Oj.dump(now, mode: :object, time_format: :xmlschema)
-    #puts "*** json: #{json}"
+    # puts "*** json: #{json}"
 
     oj_dump = Oj.load(json, mode: :object, time_format: :xmlschema)
-    #puts "Now: #{now}\n Oj: #{oj_dump}"
-    assert_equal("2014-11-01T13:20:47-05:00", oj_dump.xmlschema)
+    # puts "Now: #{now}\n Oj: #{oj_dump}"
+    assert_equal('2014-11-01T13:20:47-05:00', oj_dump.xmlschema)
   end
 
 end # MimicRails

data/test/activerecord/result_test.rb

@@ -13,13 +13,12 @@ Oj.default_options = { mode: :rails }
 
 class ActiveRecordResultTest < Minitest::Test
   def test_hash_rows
-
     result = ActiveRecord::Result.new(["one", "two"],
-				      [
-					["row 1 col 1", "row 1 col 2"],
-					["row 2 col 1", "row 2 col 2"],
-					["row 3 col 1", "row 3 col 2"],
-				      ])
+                                      [
+                                        ["row 1 col 1", "row 1 col 2"],
+                                        ["row 2 col 1", "row 2 col 2"],
+                                        ["row 3 col 1", "row 3 col 2"],
+                                      ])
     #puts "*** result: #{Oj.dump(result, indent: 2)}"
     json_result = if ActiveRecord.version >= Gem::Version.new("6")
                     result.to_a

data/test/{activesupport5 → activesupport7}/abstract_unit.rb

@@ -2,6 +2,7 @@
 
 ORIG_ARGV = ARGV.dup
 
+require "bundler/setup"
 require "active_support/core_ext/kernel/reporting"
 
 silence_warnings do
@@ -27,19 +28,22 @@ ActiveSupport.to_time_preserves_timezone = ENV["PRESERVE_TIMEZONES"] == "1"
 I18n.enforce_available_locales = false
 
 class ActiveSupport::TestCase
-  include ActiveSupport::Testing::MethodCallAssertions
-
-  # Skips the current run on Rubinius using Minitest::Assertions#skip
-  private def rubinius_skip(message = "")
-    skip message if RUBY_ENGINE == "rbx"
+  if Process.respond_to?(:fork) && !Gem.win_platform?
+    parallelize
+  else
+    parallelize(with: :threads)
   end
 
-  # Skips the current run on JRuby using Minitest::Assertions#skip
-  private def jruby_skip(message = "")
-    skip message if defined?(JRUBY_VERSION)
-  end
+  include ActiveSupport::Testing::MethodCallAssertions
 
-  def frozen_error_class
-    Object.const_defined?(:FrozenError) ? FrozenError : RuntimeError
-  end
+  private
+    # Skips the current run on Rubinius using Minitest::Assertions#skip
+    def rubinius_skip(message = "")
+      skip message if RUBY_ENGINE == "rbx"
+    end
+
+    # Skips the current run on JRuby using Minitest::Assertions#skip
+    def jruby_skip(message = "")
+      skip message if defined?(JRUBY_VERSION)
+    end
 end

data/test/{activesupport5 → activesupport7}/decoding_test.rb

@@ -5,18 +5,9 @@ require "active_support/json"
 require "active_support/time"
 require_relative "time_zone_test_helpers"
 
-require 'oj'
-
-Oj::Rails.set_decoder()
-
 class TestJSONDecoding < ActiveSupport::TestCase
   include TimeZoneTestHelpers
 
-  # Added for testing if Oj is used.
-  test "oj is used as an encoder" do
-    assert_equal ActiveSupport.json_encoder, Oj::Rails::Encoder
-  end
-
   class Foo
     def self.json_create(object)
       "Foo"
@@ -49,6 +40,8 @@ class TestJSONDecoding < ActiveSupport::TestCase
     # needs to be *exact*
     %({"a": " 2007-01-01 01:12:34 Z "})          => { "a" => " 2007-01-01 01:12:34 Z " },
     %({"a": "2007-01-01 : it's your birthday"})  => { "a" => "2007-01-01 : it's your birthday" },
+    %({"a": "Today is:\\n2020-05-21"})           => { "a" => "Today is:\n2020-05-21" },
+    %({"a": "2007-01-01 01:12:34 Z\\nwas my birthday"}) => { "a" => "2007-01-01 01:12:34 Z\nwas my birthday" },
     %([])    => [],
     %({})    => {},
     %({"a":1}) => { "a" => 1 },
@@ -122,7 +115,6 @@ class TestJSONDecoding < ActiveSupport::TestCase
   end
 
   private
-
     def with_parse_json_times(value)
       old_value = ActiveSupport.parse_json_times
       ActiveSupport.parse_json_times = value

data/test/{activesupport5 → activesupport7}/encoding_test.rb

@@ -3,28 +3,14 @@
 require "securerandom"
 require_relative "abstract_unit"
 require "active_support/core_ext/string/inflections"
-require "active_support/core_ext/regexp"
 require "active_support/json"
 require "active_support/time"
 require_relative "time_zone_test_helpers"
 require_relative "encoding_test_cases"
 
-require 'oj'
-
-# Sets the ActiveSupport encoder to be Oj and also wraps the setting of
-# globals.
-Oj::Rails.set_encoder()
-#Oj::Rails.optimize(Hash, Array, BigDecimal, Time, Range, Regexp, ActiveSupport::TimeWithZone)
-Oj::Rails.optimize()
-
 class TestJSONEncoding < ActiveSupport::TestCase
   include TimeZoneTestHelpers
 
-  # Added for testing if Oj is used.
-  test "oj is used as an encoder" do
-    assert_equal ActiveSupport.json_encoder, Oj::Rails::Encoder
-  end
-
   def sorted_json(json)
     if json.start_with?("{") && json.end_with?("}")
       "{" + json[1..-2].split(",").sort.join(",") + "}"
@@ -35,20 +21,18 @@ class TestJSONEncoding < ActiveSupport::TestCase
 
   JSONTest::EncodingTestCases.constants.each do |class_tests|
     define_method("test_#{class_tests[0..-6].underscore}") do
-      begin
-        prev = ActiveSupport.use_standard_json_time_format
-
-        standard_class_tests = /Standard/.match?(class_tests)
-
-        ActiveSupport.escape_html_entities_in_json  = !standard_class_tests
-        ActiveSupport.use_standard_json_time_format = standard_class_tests
-        JSONTest::EncodingTestCases.const_get(class_tests).each do |pair|
-          assert_equal pair.last, sorted_json(ActiveSupport::JSON.encode(pair.first))
-        end
-      ensure
-        ActiveSupport.escape_html_entities_in_json  = false
-        ActiveSupport.use_standard_json_time_format = prev
+      prev = ActiveSupport.use_standard_json_time_format
+
+      standard_class_tests = /Standard/.match?(class_tests)
+
+      ActiveSupport.escape_html_entities_in_json  = !standard_class_tests
+      ActiveSupport.use_standard_json_time_format = standard_class_tests
+      JSONTest::EncodingTestCases.const_get(class_tests).each do |pair|
+        assert_equal pair.last, sorted_json(ActiveSupport::JSON.encode(pair.first))
       end
+    ensure
+      ActiveSupport.escape_html_entities_in_json  = false
+      ActiveSupport.use_standard_json_time_format = prev
     end
   end
 
@@ -78,12 +62,6 @@ class TestJSONEncoding < ActiveSupport::TestCase
   end
 
   def test_utf8_string_encoded_properly
-    # The original test seems to expect that
-    # ActiveSupport.escape_html_entities_in_json reverts to true even after
-    # being set to false. I haven't been able to figure that out so the value is
-    # set to true, the default, before running the test. This might be wrong but
-    # for now it will have to do.
-    ActiveSupport.escape_html_entities_in_json = true
     result = ActiveSupport::JSON.encode("€2.99")
     assert_equal '"€2.99"', result
     assert_equal(Encoding::UTF_8, result.encoding)
@@ -177,6 +155,15 @@ class TestJSONEncoding < ActiveSupport::TestCase
     assert_equal({ "foo" => "hello" }, JSON.parse(json))
   end
 
+  def test_struct_to_json_with_options_nested
+    klass = Struct.new(:foo, :bar)
+    struct = klass.new "hello", "world"
+    parent_struct = klass.new struct, "world"
+    json = parent_struct.to_json only: [:foo]
+
+    assert_equal({ "foo" => { "foo" => "hello" } }, JSON.parse(json))
+  end
+
   def test_hash_should_pass_encoding_options_to_children_in_as_json
     person = {
       name: "John",
@@ -478,7 +465,6 @@ EXPECTED
   end
 
   private
-
     def object_keys(json_object)
       json_object[1..-2].scan(/([^{}:,\s]+):/).flatten.sort
     end

data/test/{activesupport5 → activesupport7}/encoding_test_cases.rb

@@ -68,6 +68,10 @@ module JSONTest
                      [ :this,  %("this") ],
                      [ :"a b", %("a b")  ]]
 
+    ModuleTests   = [[ Module, %("Module") ],
+                     [ Class,  %("Class")  ],
+                     [ ActiveSupport,                   %("ActiveSupport")                   ],
+                     [ ActiveSupport::MessageEncryptor, %("ActiveSupport::MessageEncryptor") ]]
     ObjectTests   = [[ Foo.new(1, 2), %({\"a\":1,\"b\":2}) ]]
     HashlikeTests = [[ Hashlike.new, %({\"bar\":\"world\",\"foo\":\"hello\"}) ]]
     StructTests   = [[ MyStruct.new(:foo, "bar"), %({\"name\":\"foo\",\"value\":\"bar\"}) ],
@@ -86,6 +90,8 @@ module JSONTest
 
     PathnameTests = [[ Pathname.new("lib/index.rb"), %("lib/index.rb") ]]
 
+    IPAddrTests   = [[  IPAddr.new("127.0.0.1"), %("127.0.0.1") ]]
+
     DateTests     = [[ Date.new(2005, 2, 1), %("2005/02/01") ]]
     TimeTests     = [[ Time.utc(2005, 2, 1, 15, 15, 10), %("2005/02/01 15:15:10 +0000") ]]
     DateTimeTests = [[ DateTime.civil(2005, 2, 1, 15, 15, 10), %("2005/02/01 15:15:10 +0000") ]]

data/test/{activesupport5 → activesupport7}/time_zone_test_helpers.rb

@@ -36,4 +36,12 @@ module TimeZoneTestHelpers
     ActiveSupport::TimeZone::MAPPING.clear
     ActiveSupport::TimeZone::MAPPING.merge!(old_mappings)
   end
+
+  def with_utc_to_local_returns_utc_offset_times(value)
+    old_tzinfo2_format = ActiveSupport.utc_to_local_returns_utc_offset_times
+    ActiveSupport.utc_to_local_returns_utc_offset_times = value
+    yield
+  ensure
+    ActiveSupport.utc_to_local_returns_utc_offset_times = old_tzinfo2_format
+  end
 end

data/test/files.rb

@@ -1,29 +1,29 @@
 #!/usr/bin/env ruby -wW2
+# frozen_string_literal: true
 
-if $0 == __FILE__
-  $: << '.'
-  $: << '..'
-  $: << '../lib'
-  $: << '../ext'
+if $PROGRAM_NAME == __FILE__
+  $LOAD_PATH << '.'
+  $LOAD_PATH << '..'
+  $LOAD_PATH << '../lib'
+  $LOAD_PATH << '../ext'
 end
 
-require 'pp'
 require 'sample/file'
 require 'sample/dir'
 
 def files(dir)
-  d = ::Sample::Dir.new(dir)
+  d = Sample::Dir.new(dir)
   Dir.new(dir).each do |fn|
     next if fn.start_with?('.')
+
     filename = File.join(dir, fn)
-    #filename = '.' == dir ? fn : File.join(dir, fn)
-    if File.directory?(filename)
-      d << files(filename)
-    else
-      d << ::Sample::File.new(filename)
-    end
+    # filename = '.' == dir ? fn : File.join(dir, fn)
+    d << if File.directory?(filename)
+           files(filename)
+         else
+           Sample::File.new(filename)
+         end
   end
-  #pp d
+  # pp d
   d
 end
-