oj 3.4.0 → 3.5.0

data/lib/oj/version.rb

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

data/pages/Encoding.md

@@ -10,7 +10,7 @@ in a JSON document. The formatting follows these rules.
  * JSON native types, true, false, nil, String, Hash, Array, and Number are
    encoded normally.
 
- * A Symbol is encoded as a JSON string with a preceeding `':'` character.
+ * A Symbol is encoded as a JSON string with a preceding `':'` character.
 
  * The `'^'` character denotes a special key value when in a JSON Object sequence.
 
@@ -28,7 +28,7 @@ in a JSON document. The formatting follows these rules.
  * A `"^o"` JSON Object key indicates the value should be converted to a Ruby
    Object. The first entry in the JSON Object must be a class with the `"^o"`
    key. After that each entry is treated as a variable of the Object where the
-   key is the variable name without the preceeding `'@'`. An example is
+   key is the variable name without the preceding `'@'`. An example is
    `{"^o":"Oj::Bag","x":58,"y":"marbles"}`. `"^O"`is the same except that it
    is for built in or odd classes that don't obey the normal Ruby
    rules. Examples are Rational, Date, and DateTime.
@@ -40,7 +40,7 @@ in a JSON document. The formatting follows these rules.
    `{"^u":["Range",1,7,false]}`.
 
  * When encoding an Object, if the variable name does not begin with an
-   `'@'`character then the name preceeded by a `'~'` character. This occurs in
+   `'@'`character then the name preceded by a `'~'` character. This occurs in
    the Exception class. An example is `{"^o":"StandardError","~mesg":"A
    Message","~bt":[".\/tests.rb:345:in 'test_exception'"]}`.
 

data/pages/Modes.md

@@ -120,6 +120,7 @@ information.
     | :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 |         |

data/pages/Options.md

@@ -80,7 +80,7 @@ dynamically modifying classes or reloading classes then don't use this.
 
 ### :create_additions
 
-A flag indicating the :create_id key when encounterd during parsing should
+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.
 
@@ -226,6 +226,11 @@ compatibility. Using just indent as an integer gives better performance.
 
 Use symbols instead of strings for hash keys. :symbolize_names is an alias.
 
+### :trace
+
+When true dump and load functions are traced by printing beginning and ending
+of blocks and of specific calls.
+
 ### :time_format [Symbol]
 
 The :time_format when dumping.

data/pages/Rails.md

@@ -20,6 +20,11 @@ or simply call
 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
@@ -73,7 +78,7 @@ Oj::Rails.optimize is called with no arguments are:
  * 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 equivelant.
+Oj::Rails.set_decoder() method replaces that method with the Oj equivalent.
 
 ### Notes:
 
@@ -88,6 +93,24 @@ Oj::Rails.set_decoder() method replaces that method with the Oj equivelant.
    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 trace and then set the
-   `Tracer.display_c_call = true` to see calls to C extensions.
-   
+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/test/activesupport5/encoding_test.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'activesupport5/test_helper'
 require 'securerandom'
 require 'active_support/core_ext/string/inflections'

data/test/foo.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+$: << '.'
+$: << '../lib'
+$: << '../ext'
+
+require 'oj'
+require 'sample'
+
+#obj = sample_doc(1)
+
+class Foo
+  def initialize()
+    @x = 'abc'
+    @y = 123
+    @a = [{}]
+  end
+end
+
+obj = Foo.new
+obj = {
+  x: 'abc',
+  y: 123,
+  a: [{}]
+}
+
+j = Oj.dump(obj, mode: :rails, trace: true)
+#j = Oj.dump(obj, mode: :compat)
+
+puts j
+
+Oj.load(j, mode: :rails, trace: true)

data/test/test_various.rb

@@ -155,6 +155,7 @@ class Juice < Minitest::Test
       :allow_nan=>true,
       :array_class=>Array,
       :ignore=>nil,
+      :trace=>true,
     }
     Oj.default_options = alt
     #keys = alt.keys

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oj
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Peter Ohler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -137,6 +137,8 @@ files:
 - ext/oj/stream_writer.c
 - ext/oj/strict.c
 - ext/oj/string_writer.c
+- ext/oj/trace.c
+- ext/oj/trace.h
 - ext/oj/val_stack.c
 - ext/oj/val_stack.h
 - ext/oj/wab.c
@@ -173,6 +175,7 @@ files:
 - test/activesupport5/test_helper.rb
 - test/activesupport5/time_zone_test_helpers.rb
 - test/files.rb
+- test/foo.rb
 - test/helper.rb
 - test/isolated/shared.rb
 - test/isolated/test_mimic_after.rb
@@ -238,7 +241,13 @@ files:
 homepage: http://www.ohler.com/oj
 licenses:
 - MIT
-metadata: {}
+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
 post_install_message: 
 rdoc_options:
 - "--title"
@@ -258,8 +267,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: oj
-rubygems_version: 2.6.11
+rubyforge_project: 
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A fast JSON parser and serializer.
@@ -321,6 +330,7 @@ test_files:
 - test/activesupport4/encoding_test.rb
 - test/test_wab.rb
 - test/perf_file.rb
+- test/foo.rb
 - test/perf_compat.rb
 - test/test_various.rb
 - test/test_strict.rb