oj_windows 3.16.15

data/pages/Parser.md

@@ -0,0 +1,134 @@
+# Oj::Parser API
+
+The `Oj::Parser` API provides high-performance JSON parsing with isolated configuration.
+
+## Overview
+
+Unlike `Oj.load()` which uses global default options, `Oj::Parser` allows creating
+separate parser instances, each with its own configuration. This provides:
+
+- **No option leakage** between different use cases
+- **Better performance** by avoiding per-call option processing
+- **Cleaner API** with method-based option setting
+
+## Creating Parsers
+
+```ruby
+require 'oj_windows'
+
+# Validation parser
+validator = Oj::Parser.new(:validate)
+
+# Callback parser (SAJ-style)
+saj_parser = Oj::Parser.new(:saj)
+
+# Object builder parser
+usual_parser = Oj::Parser.new(:usual)
+```
+
+## Parser Types
+
+### :validate
+
+Validates JSON without building Ruby objects. Fastest option when you only need
+to check if JSON is well-formed.
+
+```ruby
+parser = Oj::Parser.new(:validate)
+parser.parse('{"valid": true}')  # Returns nil, no exception = valid
+```
+
+### :saj (Callback)
+
+Provides callbacks for each JSON element. Compatible with `Oj::Saj` handlers.
+
+```ruby
+class MyHandler < Oj::Saj
+  def hash_start(key); end
+  def hash_end(key); end
+  def array_start(key); end
+  def array_end(key); end
+  def add_value(value, key); end
+end
+
+parser = Oj::Parser.new(:saj)
+parser.handler = MyHandler.new
+parser.parse(json_string)
+```
+
+### :usual
+
+Builds Ruby objects from JSON. The most common parser type.
+
+```ruby
+parser = Oj::Parser.new(:usual)
+parser.symbol_keys = true
+parser.cache_keys = true
+
+data = parser.parse('{"name": "test"}')
+# => {:name => "test"}
+```
+
+## Configuration Options
+
+Set options as methods on the parser instance:
+
+```ruby
+parser = Oj::Parser.new(:usual)
+parser.symbol_keys = true      # Use Symbol keys instead of String
+parser.cache_keys = true       # Cache frequently used keys
+parser.cache_strings = 6       # Cache strings up to length 6
+parser.create_id = '^o'        # Object creation identifier
+```
+
+## Performance
+
+Benchmarks on Windows with Ruby 3.4.8 MSVC (50,000 iterations):
+
+### Validation
+```
+             System  time (secs)  rate (ops/sec)
+-------------------  -----------  --------------
+       Oj::Saj.none       0.087      575904.833
+Oj::Parser.validate       0.093      535818.388
+```
+
+### Callback (SAJ)
+```
+        System  time (secs)  rate (ops/sec)
+--------------  -----------  --------------
+Oj::Parser.saj       0.623       80316.627
+   Oj::Saj.all       0.893       55984.415
+```
+
+`Oj::Parser.new(:saj)` is **1.43x** faster than `Oj.saj_parse`.
+
+### Parse to Primitives
+```
+          System  time (secs)  rate (ops/sec)
+----------------  -----------  --------------
+Oj::Parser.usual       0.329      152133.829
+       JSON::Ext       0.337      148264.387
+ Oj::strict_load       0.528       94769.267
+```
+
+`Oj::Parser.new(:usual)` is **1.03x** faster than JSON::Ext.
+
+### Object Parsing
+```
+          System  time (secs)  rate (ops/sec)
+----------------  -----------  --------------
+Oj::Parser.usual       0.054      921939.392
+       JSON::Ext       0.076      656601.405
+ Oj::compat_load       0.142      352839.974
+```
+
+`Oj::Parser.new(:usual)` is **1.40x** faster than JSON::Ext and
+**2.61x** faster than `Oj.compat_load`.
+
+## Summary
+
+On Windows MSVC Ruby 3.4.8, `Oj::Parser` provides:
+- Up to **2.6x faster** parsing than legacy Oj methods
+- Isolated configuration per parser instance
+- Better memory efficiency through caching

data/pages/Rails.md

@@ -0,0 +1,85 @@
+# Rails Integration
+
+`oj_windows` provides seamless integration with Rails and ActiveSupport on Windows MSVC Ruby.
+
+## Quick Start
+
+Add this to a Rails initializer to replace Rails' JSON handling with `oj_windows`:
+
+```ruby
+require 'oj_windows'
+
+Oj.optimize_rails()
+```
+
+This single call:
+- Sets `oj_windows` as the JSON encoder
+- Sets `oj_windows` as the JSON decoder
+- Optimizes common Rails types
+- Mimics the JSON gem interface
+
+## Manual Setup
+
+For more control, configure each component separately:
+
+```ruby
+require 'oj_windows'
+
+Oj::Rails.set_encoder()   # Use Oj for encoding
+Oj::Rails.set_decoder()   # Use Oj for decoding
+Oj::Rails.optimize()      # Optimize common types
+Oj::Rails.mimic_JSON()    # Mimic JSON gem interface
+```
+
+## Optimized Types
+
+When `Oj::Rails.optimize()` is called, these types use fast native encoding:
+
+| Type | Description |
+|------|-------------|
+| Array | Ruby arrays |
+| BigDecimal | Arbitrary precision decimals |
+| Float | Floating point numbers |
+| Hash | Ruby hashes |
+| Range | Range objects |
+| Regexp | Regular expressions |
+| Time | Time objects |
+| ActiveSupport::TimeWithZone | Rails time zones |
+| ActionController::Parameters | Controller params |
+| ActiveRecord::Base subclasses | Model instances |
+
+## ActiveSupport Globals
+
+`oj_windows` honors these ActiveSupport encoding globals:
+
+```ruby
+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
+```
+
+## Verifying Oj is Active
+
+To confirm `oj_windows` is handling JSON encoding, enable tracing:
+
+```ruby
+require 'oj_windows'
+
+Oj.default_options = { trace: true }
+Oj.optimize_rails()
+
+Time.now.to_json  # Will output trace information
+```
+
+## Notes
+
+1. **Float Precision**: Optimized floats use 16 significant digits (Ruby's json gem may use 16 or 17 depending on value)
+
+2. **Hash Key Collisions**: Optimized hashes don't check for duplicate keys after `to_s()` conversion
+
+3. **Rails Mode**: Calling `Oj.optimize_rails()` doesn't change the default Oj mode. To also use Rails mode for direct Oj calls:
+
+```ruby
+Oj.default_options = { mode: :rails }
+```

data/pages/Security.md

@@ -0,0 +1,43 @@
+# Security Considerations
+
+When parsing JSON from untrusted sources, certain `oj_windows` options should be used with caution.
+
+## Potential Vulnerabilities
+
+### Symbol Keys
+The `:symbol_keys` option converts JSON keys to Ruby Symbols. In Ruby versions before 2.2, Symbols are not garbage collected, which could lead to memory exhaustion from malicious input.
+
+### Auto-Define Classes
+The `:auto_define` option automatically creates Ruby classes from JSON. While useful during development, this can exhaust memory if an attacker sends JSON with many unique class names.
+
+## Safe Parsing
+
+For untrusted input, use `Oj.safe_load()` which applies the strictest, safest options:
+
+```ruby
+require 'oj_windows'
+
+# Safe parsing of untrusted JSON
+data = Oj.safe_load(untrusted_json_string)
+```
+
+## Best Practices
+
+1. **Use `safe_load()` for untrusted input** - applies safest defaults
+2. **Avoid `:symbol_keys` with untrusted data** - prevents Symbol table exhaustion
+3. **Disable `:auto_define` in production** - prevents arbitrary class creation
+4. **Validate parsed data** - always validate structure and types after parsing
+5. **Set `:max_nesting`** - limit depth to prevent stack overflow attacks
+
+## Object Mode Considerations
+
+In `:object` mode, `oj_windows` can deserialize Ruby objects from JSON. While no methods are called during deserialization, you should always validate the resulting objects before using them.
+
+```ruby
+# Safe: strict mode only creates native JSON types
+data = Oj.strict_load(json_string)
+
+# Caution: object mode creates Ruby objects
+obj = Oj.object_load(json_string)
+# Validate obj before using
+```

data/pages/WAB.md

@@ -0,0 +1,12 @@
+# 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 designed for Web Application Builder (WAB) style data exchange.
+
+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 component 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

@@ -0,0 +1,242 @@
+--- !ruby/object:Gem::Specification
+name: oj_windows
+version: !ruby/object:Gem::Version
+  version: 3.16.15
+platform: ruby
+authors:
+- tigel
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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.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: oj_windows is a Windows-exclusive fork of the Oj gem, optimized for Ruby
+  compiled with MSVC (Visual Studio). Provides fast JSON parsing/serialization with
+  full Rails and JSON gem compatibility. Requires Ruby 3.4+ built with MSVC toolchain.
+email: tigel-agm@tigel.com
+executables: []
+extensions:
+- ext/oj_windows/extconf.rb
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.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
+- ext/oj_windows/buf.h
+- ext/oj_windows/cache.c
+- ext/oj_windows/cache.h
+- ext/oj_windows/cache8.c
+- ext/oj_windows/cache8.h
+- ext/oj_windows/circarray.c
+- ext/oj_windows/circarray.h
+- ext/oj_windows/code.c
+- ext/oj_windows/code.h
+- ext/oj_windows/compat.c
+- ext/oj_windows/custom.c
+- ext/oj_windows/debug.c
+- ext/oj_windows/dump.c
+- ext/oj_windows/dump.h
+- ext/oj_windows/dump_compat.c
+- ext/oj_windows/dump_leaf.c
+- ext/oj_windows/dump_object.c
+- ext/oj_windows/dump_strict.c
+- ext/oj_windows/encode.h
+- ext/oj_windows/err.c
+- ext/oj_windows/err.h
+- ext/oj_windows/extconf.rb
+- ext/oj_windows/fast.c
+- ext/oj_windows/intern.c
+- ext/oj_windows/intern.h
+- ext/oj_windows/mem.c
+- ext/oj_windows/mem.h
+- ext/oj_windows/mimic_json.c
+- ext/oj_windows/object.c
+- ext/oj_windows/odd.c
+- ext/oj_windows/odd.h
+- ext/oj_windows/oj.c
+- ext/oj_windows/oj.h
+- ext/oj_windows/parse.c
+- ext/oj_windows/parse.h
+- ext/oj_windows/parser.c
+- ext/oj_windows/parser.h
+- ext/oj_windows/rails.c
+- ext/oj_windows/rails.h
+- ext/oj_windows/reader.c
+- ext/oj_windows/reader.h
+- ext/oj_windows/resolve.c
+- ext/oj_windows/resolve.h
+- ext/oj_windows/rxclass.c
+- ext/oj_windows/rxclass.h
+- ext/oj_windows/saj.c
+- ext/oj_windows/saj2.c
+- ext/oj_windows/saj2.h
+- ext/oj_windows/scp.c
+- ext/oj_windows/simd.h
+- ext/oj_windows/sparse.c
+- ext/oj_windows/stream_writer.c
+- ext/oj_windows/strict.c
+- ext/oj_windows/string_writer.c
+- ext/oj_windows/trace.c
+- ext/oj_windows/trace.h
+- ext/oj_windows/usual.c
+- ext/oj_windows/usual.h
+- ext/oj_windows/util.c
+- ext/oj_windows/util.h
+- ext/oj_windows/val_stack.c
+- ext/oj_windows/val_stack.h
+- ext/oj_windows/validate.c
+- ext/oj_windows/wab.c
+- 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
+- lib/oj_windows.rb
+- lib/oj_windows/active_support_helper.rb
+- lib/oj_windows/bag.rb
+- lib/oj_windows/easy_hash.rb
+- lib/oj_windows/error.rb
+- lib/oj_windows/json.rb
+- lib/oj_windows/mimic.rb
+- lib/oj_windows/saj.rb
+- lib/oj_windows/schandler.rb
+- lib/oj_windows/state.rb
+- lib/oj_windows/version.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: https://github.com/tigel-agm/oj_windows
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/tigel-agm/oj_windows/issues
+  changelog_uri: https://github.com/tigel-agm/oj_windows/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/tigel-agm/oj_windows/blob/main/README.md
+  source_code_uri: https://github.com/tigel-agm/oj_windows
+  rubygems_mfa_required: 'true'
+rdoc_options:
+- "--title"
+- oj_windows
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: High-performance JSON parser for Windows MSVC Ruby
+test_files: []