oj 2.18.5 → 3.16.11

data/pages/Rails.md

@@ -0,0 +1,167 @@
+# Rails Quickstart
+
+To universally replace Rails' use of the json gem with Oj, and also
+have Oj "take over" many methods on the JSON constant (`load`, `parse`, etc.) with
+their faster Oj counterparts, add this to an initializer:
+
+```ruby
+Oj.optimize_rails()
+```
+
+For more details and options, read on...
+
+# Oj Rails Compatibility
+
+The `:rails` mode mimics the ActiveSupport version 5 encoder. Rails and
+ActiveSupport are built around the use of the `as_json(*)` method defined for
+a class. Oj attempts to provide the same functionality by being a drop in
+replacement with a few exceptions.
+
+```ruby
+require 'oj'
+
+Oj::Rails.set_encoder()
+Oj::Rails.set_decoder()
+Oj::Rails.optimize()
+Oj::Rails.mimic_JSON()
+```
+
+or simply call
+
+```ruby
+Oj.optimize_rails()
+```
+
+Either of those steps will setup Oj to mimic Rails but it will not change the
+default mode type as the mode type is only used when calling the Oj encoding
+directly. If Rails mode is also desired then use the `Oj.default_options` to
+change the default mode.
+
+Some of the Oj options are supported as arguments to the encoder if called
+from `Oj::Rails.encode()` but when using the `Oj::Rails::Encoder` class the
+`encode()` method does not support optional arguments as required by the
+ActiveSupport compliance guidelines. The general approach Rails takes for
+configuring encoding options is to either set global values or to create a new
+instance of the Encoder class and provide options in the initializer.
+
+The globals that ActiveSupport uses for encoding are:
+
+ * `ActiveSupport::JSON::Encoding.use_standard_json_time_format`
+ * `ActiveSupport::JSON::Encoding.escape_html_entities_in_json`
+ * `ActiveSupport::JSON::Encoding.time_precision`
+ * `ActiveSupport::JSON::Encoding.json_encoder`
+
+Those globals are aliased to also be accessed from the ActiveSupport module
+directly so `ActiveSupport::JSON::Encoding.time_precision` can also be accessed
+from `ActiveSupport.time_precision`. Oj makes use of these globals in mimicking
+Rails after the `Oj::Rails.set_encode()` method is called. That also sets the
+`ActiveSupport.json_encoder` to the `Oj::Rails::Encoder` class.
+
+Options passed into a call to `to_json()` are passed to the `as_json()`
+methods. These are mostly ignored by Oj and simply passed on without
+modifications as per the guidelines. The exception to this are the options
+specific to Oj such as the `:circular` option which it used to detect circular
+references while encoding.
+
+By default Oj acts like the ActiveSupport encoder and honors any changes in
+the `as_json()` methods. There are some optimized Oj encoders for some
+classes. When the optimized encoder it toggled the `as_json()` methods will not
+be called for that class but instead the optimized version will be called. The
+optimized version is the same as the ActiveSupport default encoding for a
+given class. The optimized versions are toggled with the `optimize()` and
+`deoptimize()` methods. There is a default optimized version for every class
+that takes the visible attributes and encodes them but that may not be the
+same as what Rails uses. Trial and error is the best approach for classes not
+listed here.
+
+The classes that can be put in optimized mode and are optimized when
+`Oj::Rails.optimize` is called with no arguments are:
+
+ * Array
+ * BigDecimal
+ * Float
+ * Hash
+ * Range
+ * Regexp
+ * Time
+ * ActiveSupport::TimeWithZone
+ * ActionController::Parameters
+ * any class inheriting from ActiveRecord::Base
+ * any other class where all attributes should be dumped
+
+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
+   Ruby which is used by the json gem and by Rails. Ruby varies the
+   significant digits which can be either 16 or 17 depending on the value.
+
+2. Optimized Hashes do not collapse keys that become the same in the output. As
+   an example, a non-String object that has a `to_s()` method will become the
+   return value of the `to_s()` method in the output without checking to see if
+   that has already been used. This could occur is a mix of String and Symbols
+   are used as keys or if a other non-String objects such as Numerics are mixed
+   with numbers as Strings.
+
+3. To verify Oj is being used turn on the Oj `:trace` option. Similar to the
+   Ruby Tracer Oj will then print out trace information. Another approach is
+   to turn on C extension tracing.  Set `tracer = TracePoint.new(:c_call) do
+   |tp| p [tp.lineno, tp.event, tp.defined_class, tp.method_id] end` or, in
+   older Rubies, set `Tracer.display_c_call = true`.
+
+   For example:
+
+     ```
+     require 'active_support/core_ext'
+     require 'active_support/json'
+     require 'oj'
+     Oj.optimize_rails
+     tracer.enable { Time.now.to_json }
+     # prints output including
+     ....
+     [20, :c_call, #<Class:Oj::Rails::Encoder>, :new]
+     [20, :c_call, Oj::Rails::Encoder, :encode]
+     ....
+     => "\"2018-02-23T12:13:42.493-06:00\""
+     ```

data/pages/Security.md

@@ -0,0 +1,20 @@
+# Security and Optimization
+
+Two settings in Oj are useful for parsing but do expose a vulnerability if used
+from an untrusted source. Symbolized keys can cause memory to be filled with
+previous versions of ruby. Ruby 2.1 and below does not garbage collect
+Symbols. The same is true for auto defining classes in all versions of ruby;
+memory will also be exhausted if too many classes are automatically
+defined. Auto defining is a useful feature during development and from trusted
+sources but it allows too many classes to be created in the object load mode and
+auto defined is used with an untrusted source. The `Oj.safe_load()` method
+sets and uses the most strict and safest options. It should be used by
+developers who find it difficult to understand the options available in Oj.
+
+The options in Oj are designed to provide flexibility to the developer. This
+flexibility allows Objects to be serialized and deserialized. No methods are
+ever called on these created Objects but that does not stop the developer from
+calling methods on them. As in any system, check your inputs before working with
+them. Taking an arbitrary `String` from a user and evaluating it is never a good
+idea from an unsecure source. The same is true for `Object` attributes as they
+are not more than `String`s. Always check inputs from untrusted sources.

data/pages/WAB.md

@@ -0,0 +1,13 @@
+# WAB mode
+
+The `:wab` mode ignores all options except the indent option. Performance of
+this mode is slightly faster than the :strict and :null modes. It is included
+to support the [WABuR](https://github.com/ohler55/wabur) project.
+
+Options other than the indentation are not supported since the encoding and
+formats are defined by the API that is used to encode data being passed from
+one components in a WAB system and allowing an option that would break the
+data exchange is best not supported.
+
+The mode encodes like the strict mode except the URI, Time, WAB::UUID, and
+BigDecimal are supported.

metadata

@@ -1,29 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: oj
 version: !ruby/object:Gem::Version
-  version: 2.18.5
+  version: 3.16.11
 platform: ruby
 authors:
 - Peter Ohler
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2025-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -39,44 +52,95 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
-  name: wwtd
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: 'The fastest JSON parser and object serializer. '
+        version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The fastest JSON parser and object serializer.
 email: peter@ohler.com
 executables: []
 extensions:
 - ext/oj/extconf.rb
 extra_rdoc_files:
 - README.md
+- LICENSE
+- CHANGELOG.md
+- RELEASE_NOTES.md
+- pages/Advanced.md
+- pages/Compatibility.md
+- pages/Custom.md
+- pages/Encoding.md
+- pages/InstallOptions.md
+- pages/JsonGem.md
+- pages/Modes.md
+- pages/Options.md
+- pages/Parser.md
+- pages/Rails.md
+- pages/Security.md
+- pages/WAB.md
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
+- RELEASE_NOTES.md
 - ext/oj/buf.h
+- ext/oj/cache.c
+- ext/oj/cache.h
 - ext/oj/cache8.c
 - ext/oj/cache8.h
 - ext/oj/circarray.c
 - ext/oj/circarray.h
+- ext/oj/code.c
+- ext/oj/code.h
 - ext/oj/compat.c
+- ext/oj/custom.c
+- ext/oj/debug.c
 - ext/oj/dump.c
+- ext/oj/dump.h
+- ext/oj/dump_compat.c
+- ext/oj/dump_leaf.c
+- ext/oj/dump_object.c
+- ext/oj/dump_strict.c
 - ext/oj/encode.h
+- ext/oj/encoder.c
 - ext/oj/err.c
 - ext/oj/err.h
 - ext/oj/extconf.rb
 - ext/oj/fast.c
-- ext/oj/hash.c
-- ext/oj/hash.h
-- ext/oj/hash_test.c
+- ext/oj/intern.c
+- ext/oj/intern.h
+- ext/oj/mem.c
+- ext/oj/mem.h
+- ext/oj/mimic_json.c
 - ext/oj/object.c
 - ext/oj/odd.c
 - ext/oj/odd.h
@@ -84,101 +148,72 @@ files:
 - ext/oj/oj.h
 - ext/oj/parse.c
 - ext/oj/parse.h
+- ext/oj/parser.c
+- ext/oj/parser.h
+- ext/oj/rails.c
+- ext/oj/rails.h
 - ext/oj/reader.c
 - ext/oj/reader.h
 - ext/oj/resolve.c
 - ext/oj/resolve.h
+- ext/oj/rxclass.c
+- ext/oj/rxclass.h
 - ext/oj/saj.c
+- ext/oj/saj2.c
+- ext/oj/saj2.h
 - ext/oj/scp.c
+- ext/oj/simd.h
 - ext/oj/sparse.c
+- ext/oj/stream_writer.c
 - ext/oj/strict.c
+- ext/oj/string_writer.c
+- ext/oj/trace.c
+- ext/oj/trace.h
+- ext/oj/usual.c
+- ext/oj/usual.h
+- ext/oj/util.c
+- ext/oj/util.h
 - ext/oj/val_stack.c
 - ext/oj/val_stack.h
+- ext/oj/validate.c
+- ext/oj/wab.c
 - lib/oj.rb
 - lib/oj/active_support_helper.rb
 - lib/oj/bag.rb
 - lib/oj/easy_hash.rb
 - lib/oj/error.rb
+- lib/oj/json.rb
 - lib/oj/mimic.rb
 - lib/oj/saj.rb
 - lib/oj/schandler.rb
+- lib/oj/state.rb
 - lib/oj/version.rb
-- test/_test_active.rb
-- test/_test_active_mimic.rb
-- test/_test_mimic_rails.rb
-- test/activesupport_datetime_test.rb
-- test/bug.rb
-- test/bug2.rb
-- test/bug3.rb
-- test/bug_fast.rb
-- test/bug_load.rb
-- test/crash.rb
-- test/curl/curl_oj.rb
-- test/curl/get_oj.rb
-- test/curl/just_curl.rb
-- test/curl/just_oj.rb
-- test/example.rb
-- test/files.rb
-- test/foo.rb
-- test/helper.rb
-- test/io.rb
-- test/isolated/shared.rb
-- test/isolated/test_mimic_after.rb
-- test/isolated/test_mimic_alone.rb
-- test/isolated/test_mimic_as_json.rb
-- test/isolated/test_mimic_before.rb
-- test/isolated/test_mimic_define.rb
-- test/isolated/test_mimic_rails_after.rb
-- test/isolated/test_mimic_rails_before.rb
-- test/isolated/test_mimic_rails_datetime.rb
-- test/isolated/test_mimic_redefine.rb
-- test/mod.rb
-- test/perf.rb
-- test/perf_compat.rb
-- test/perf_fast.rb
-- test/perf_file.rb
-- test/perf_object.rb
-- test/perf_saj.rb
-- test/perf_scp.rb
-- test/perf_simple.rb
-- test/perf_strict.rb
-- test/rails.rb
-- test/russian.rb
-- test/sample.rb
-- test/sample/change.rb
-- test/sample/dir.rb
-- test/sample/doc.rb
-- test/sample/file.rb
-- test/sample/group.rb
-- test/sample/hasprops.rb
-- test/sample/layer.rb
-- test/sample/line.rb
-- test/sample/oval.rb
-- test/sample/rect.rb
-- test/sample/shape.rb
-- test/sample/text.rb
-- test/sample_json.rb
-- test/struct.rb
-- test/test_compat.rb
-- test/test_debian.rb
-- test/test_fast.rb
-- test/test_file.rb
-- test/test_gc.rb
-- test/test_hash.rb
-- test/test_object.rb
-- test/test_saj.rb
-- test/test_scp.rb
-- test/test_serializer.rb
-- test/test_strict.rb
-- test/test_various.rb
-- test/test_writer.rb
-- test/write_timebars.rb
+- pages/Advanced.md
+- pages/Compatibility.md
+- pages/Custom.md
+- pages/Encoding.md
+- pages/InstallOptions.md
+- pages/JsonGem.md
+- pages/Modes.md
+- pages/Options.md
+- pages/Parser.md
+- pages/Rails.md
+- pages/Security.md
+- pages/WAB.md
 homepage: http://www.ohler.com/oj
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/ohler55/oj/issues
+  changelog_uri: https://github.com/ohler55/oj/blob/master/CHANGELOG.md
+  documentation_uri: http://www.ohler.com/oj/doc/index.html
+  homepage_uri: http://www.ohler.com/oj/
+  source_code_uri: https://github.com/ohler55/oj
+  wiki_uri: https://github.com/ohler55/oj/wiki
+  rubygems_mfa_required: 'true'
 rdoc_options:
+- "--title"
+- Oj
 - "--main"
 - README.md
 require_paths:
@@ -187,86 +222,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: oj
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A fast JSON parser and serializer.
-test_files:
-- test/_test_active.rb
-- test/_test_active_mimic.rb
-- test/_test_mimic_rails.rb
-- test/activesupport_datetime_test.rb
-- test/bug.rb
-- test/bug2.rb
-- test/bug3.rb
-- test/bug_fast.rb
-- test/bug_load.rb
-- test/crash.rb
-- test/curl/curl_oj.rb
-- test/curl/get_oj.rb
-- test/curl/just_curl.rb
-- test/curl/just_oj.rb
-- test/example.rb
-- test/files.rb
-- test/foo.rb
-- test/helper.rb
-- test/io.rb
-- test/isolated/shared.rb
-- test/isolated/test_mimic_after.rb
-- test/isolated/test_mimic_alone.rb
-- test/isolated/test_mimic_as_json.rb
-- test/isolated/test_mimic_before.rb
-- test/isolated/test_mimic_define.rb
-- test/isolated/test_mimic_rails_after.rb
-- test/isolated/test_mimic_rails_before.rb
-- test/isolated/test_mimic_rails_datetime.rb
-- test/isolated/test_mimic_redefine.rb
-- test/mod.rb
-- test/perf.rb
-- test/perf_compat.rb
-- test/perf_fast.rb
-- test/perf_file.rb
-- test/perf_object.rb
-- test/perf_saj.rb
-- test/perf_scp.rb
-- test/perf_simple.rb
-- test/perf_strict.rb
-- test/rails.rb
-- test/russian.rb
-- test/sample/change.rb
-- test/sample/dir.rb
-- test/sample/doc.rb
-- test/sample/file.rb
-- test/sample/group.rb
-- test/sample/hasprops.rb
-- test/sample/layer.rb
-- test/sample/line.rb
-- test/sample/oval.rb
-- test/sample/rect.rb
-- test/sample/shape.rb
-- test/sample/text.rb
-- test/sample.rb
-- test/sample_json.rb
-- test/struct.rb
-- test/test_compat.rb
-- test/test_debian.rb
-- test/test_fast.rb
-- test/test_file.rb
-- test/test_gc.rb
-- test/test_hash.rb
-- test/test_object.rb
-- test/test_saj.rb
-- test/test_scp.rb
-- test/test_serializer.rb
-- test/test_strict.rb
-- test/test_various.rb
-- test/test_writer.rb
-- test/write_timebars.rb
+test_files: []