module Oj - Oj

# module Oj

Optimized JSON (Oj), as the name implies was written to provide speed optimized JSON handling.

Oj uses modes to control how object are encoded and decoded. In addition global and options to methods allow additional behavior modifications. The modes are:

- :strict mode will only allow the 7 basic JSON types to be serialized. Any other Object will raise an Exception.

- :null mode is similar to the :strict mode except any Object that is not one of the JSON base types is replaced by a JSON null.

- :object mode will dump any Object as a JSON Object with keys that match the Ruby Object's variable names without the '@' character. This is the highest performance mode.

- :compat or :json mode is the compatible mode for the json gem. It mimics the json gem including the options, defaults, and restrictions.

- :rails is the compatibility mode for Rails or Active support.

- :custom is the most configurable mode.

- :wab specifically for WAB data exchange.

### Constants

VERSION

  Current version of the module.

### Public Class Methods

add_to_json(*args)

Override simple to_s dump behavior in :compat mode to instead use an optimized dump that includes the classname and attributes so that the object can be re-created on load. The format is the same as the json gem but does not use the ruby methods for encoding.

The classes supported for optimization are: Array, BigDecimal, Complex, Date, DateTime, Exception, Hash, Integer, OpenStruct, Range, Rational, Regexp, Struct, and Time. Providing no classes will result in all those classes being optimized.q

- *args( [Class] zero or more classes to optimize.

compat_load(json, options) { _|_obj, start, len_|_ }

Parses a JSON document String into an Object, Hash, Array, String, Fixnum, Float, true, false, or nil. It parses using a mode that is generally compatible with other Ruby JSON parsers in that it will create objects based on the :create_id value. It is not compatible in every way to every other parser though as each parser has it's own variations.

When used with a document that has multiple JSON elements the block, if any, will be yielded to. If no block then the last element read will be returned.

Raises an exception if the JSON is malformed or the classes specified are not valid. If the input is not a valid JSON document (an empty string is not a valid JSON document) an exception is raised.

A block can be provided with a single argument. That argument will be the parsed JSON document. This is useful when parsing a string that includes multiple JSON documents. The block can take up to 3 arguments, the parsed object, the position in the string or stream of the start of the JSON for that object, and the length of the JSON for that object plus trailing whitespace.

- json [String|IO] JSON String or an Object that responds to read().

- options [Hash] load options (same as ::default_options).

  - -

- obj [Hash|Array|String|Fixnum|Float|Boolean|nil] parsed object.

- start [_optional, Integer] start position of parsed JSON for obj.

- len [_optional, Integer] length of parsed JSON for obj.

Returns [Hash|Array|String|Fixnum|Float|Boolean|nil]

default_options() click to toggle source

()

Returns the default load and dump options as a Hash. The options are

- :indent [Fixnum|String|nil] number of spaces to indent each element in an JSON document, zero or nil is no newline between JSON elements, negative indicates no newline between top level JSON elements in a stream, a String indicates the string should be used for indentation

- :circular [Boolean|nil] support circular references while dumping

- :auto_define [Boolean|nil] automatically define classes if they do not exist

- :symbol_keys [Boolean|nil] use symbols instead of strings for hash keys

- :escape_mode [:newline|:json|:xss_safe|:ascii|unicode_xss|nil] determines the characters to escape

- :class_cache [Boolean|nil] cache classes for faster parsing (if dynamically modifying classes or reloading classes then don't use this)

- :mode [:object|:strict|:compat|:null|:custom|:rails|:wab] load and dump modes to use for JSON

- :time_format [:unix|:unix_zone|:xmlschema|:ruby] time format when dumping in :compat and :object mode

- :bigdecimal_as_decimal [Boolean|nil] dump BigDecimal as a decimal number or as a String

- :bigdecimal_load [:bigdecimal|:float|:auto] load decimals as BigDecimal instead of as a Float. :auto pick the most precise for the number of digits.

- :create_id [String|nil] create id for json compatible object encoding, default is 'json_class'

- :second_precision [Fixnum|nil] number of digits after the decimal when dumping the seconds portion of time

- :float_precision [Fixnum|nil] number of digits of precision when dumping floats, 0 indicates use Ruby

- :use_to_json [Boolean|nil] call ::to_json() methods on dump, default is false

- :use_as_json [Boolean|nil] call #as_json() methods on dump, default is false

- :nilnil [Boolean|nil] if true a nil input to load will return nil and not raise an Exception

- :empty_string [Boolean|nil] if true an empty input will not raise an Exception

- :allow_gc [Boolean|nil] allow or prohibit GC during parsing, default is true (allow)

- :quirks_mode [true,|false|nil] Allow single JSON values instead of documents, default is true (allow)

- :allow_invalid_unicode [true,|false|nil] Allow invalid unicode, default is false (don't allow)

- :allow_nan [true,|false|nil] Allow Nan, Infinity, and -Infinity to be parsed, default is true (allow)

- :indent_str [String|nil] String to use for indentation, overriding the indent option is not nil

- :space [String|nil] String to use for the space after the colon in JSON object fields

- :space_before [String|nil] String to use before the colon separator in JSON object fields

- :object_nl [String|nil] String to use after a JSON object field value

- :array_nl [String|nil] String to use after a JSON array value

- :nan [:null|:huge|:word|:raise|:auto] how to dump Infinity and NaN in null, strict, and compat mode. :null places a null, :huge places a huge number, :word places Infinity or NaN, :raise raises and exception, :auto uses default for each mode.

- :hash_class [Class|nil] Class to use instead of Hash on load, :object_class can also be used

- :array_class [Class|nil] Class to use instead of Array on load

- :omit_nil [true|false] if true Hash and Object attributes with nil values are omitted

Return [Hash] all current option settings.

    static VALUE
    get_def_opts(VALUE self) {
        VALUE       opts = rb_hash_new();

        if (0 == oj_default_options.dump_opts.indent_size) {
            rb_hash_aset(opts, oj_indent_sym, INT2FIX(oj_default_options.indent));
        } else {
            rb_hash_aset(opts, oj_indent_sym, rb_str_new2(oj_default_options.dump_opts.indent_str));
        }
        rb_hash_aset(opts, sec_prec_sym, INT2FIX(oj_default_options.sec_prec));
        rb_hash_aset(opts, circular_sym, (Yes == oj_default_options.circular) ? Qtrue : ((No == oj_default_options.circular) ? Qfalse : Qnil));
        rb_hash_aset(opts, class_cache_sym, (Yes == oj_default_options.class_cache) ? Qtrue : ((No == oj_default_options.class_cache) ? Qfalse : Qnil));
        rb_hash_aset(opts, auto_define_sym, (Yes == oj_default_options.auto_define) ? Qtrue : ((No == oj_default_options.auto_define) ? Qfalse : Qnil));
        rb_hash_aset(opts, symbol_keys_sym, (Yes == oj_default_options.sym_key) ? Qtrue : ((No == oj_default_options.sym_key) ? Qfalse : Qnil));
        rb_hash_aset(opts, bigdecimal_as_decimal_sym, (Yes == oj_default_options.bigdec_as_num) ? Qtrue : ((No == oj_default_options.bigdec_as_num) ? Qfalse : Qnil));
        rb_hash_aset(opts, use_to_json_sym, (Yes == oj_default_options.to_json) ? Qtrue : ((No == oj_default_options.to_json) ? Qfalse : Qnil));
        rb_hash_aset(opts, use_to_hash_sym, (Yes == oj_default_options.to_hash) ? Qtrue : ((No == oj_default_options.to_hash) ? Qfalse : Qnil));
        rb_hash_aset(opts, use_as_json_sym, (Yes == oj_default_options.as_json) ? Qtrue : ((No == oj_default_options.as_json) ? Qfalse : Qnil));
        rb_hash_aset(opts, nilnil_sym, (Yes == oj_default_options.nilnil) ? Qtrue : ((No == oj_default_options.nilnil) ? Qfalse : Qnil));
        rb_hash_aset(opts, empty_string_sym, (Yes == oj_default_options.empty_string) ? Qtrue : ((No == oj_default_options.empty_string) ? Qfalse : Qnil));
        rb_hash_aset(opts, allow_gc_sym, (Yes == oj_default_options.allow_gc) ? Qtrue : ((No == oj_default_options.allow_gc) ? Qfalse : Qnil));
        rb_hash_aset(opts, oj_quirks_mode_sym, (Yes == oj_default_options.quirks_mode) ? Qtrue : ((No == oj_default_options.quirks_mode) ? Qfalse : Qnil));
        rb_hash_aset(opts, allow_invalid_unicode_sym, (Yes == oj_default_options.allow_invalid) ? Qtrue : ((No == oj_default_options.allow_invalid) ? Qfalse : Qnil));
        rb_hash_aset(opts, oj_allow_nan_sym, (Yes == oj_default_options.allow_nan) ? Qtrue : ((No == oj_default_options.allow_nan) ? Qfalse : Qnil));
        rb_hash_aset(opts, float_prec_sym, INT2FIX(oj_default_options.float_prec));
        switch (oj_default_options.mode) {
        case StrictMode:    rb_hash_aset(opts, mode_sym, strict_sym);  break;
        case CompatMode:    rb_hash_aset(opts, mode_sym, compat_sym);  break;
        case NullMode:      rb_hash_aset(opts, mode_sym, null_sym);              break;
        case ObjectMode:    rb_hash_aset(opts, mode_sym, object_sym);  break;
        case CustomMode:    rb_hash_aset(opts, mode_sym, custom_sym);  break;
        case RailsMode:     rb_hash_aset(opts, mode_sym, rails_sym);    break;
        case WabMode:       rb_hash_aset(opts, mode_sym, wab_sym);                break;
        default:            rb_hash_aset(opts, mode_sym, object_sym); break;
        }
        switch (oj_default_options.escape_mode) {
        case NLEsc:         rb_hash_aset(opts, escape_mode_sym, newline_sym);      break;
        case JSONEsc:       rb_hash_aset(opts, escape_mode_sym, json_sym);                break;
        case XSSEsc:        rb_hash_aset(opts, escape_mode_sym, xss_safe_sym);     break;
        case ASCIIEsc:      rb_hash_aset(opts, escape_mode_sym, ascii_sym);              break;
        case JXEsc:         rb_hash_aset(opts, escape_mode_sym, unicode_xss_sym);  break;
        default:            rb_hash_aset(opts, escape_mode_sym, json_sym);            break;
        }
        switch (oj_default_options.time_format) {
        case XmlTime:       rb_hash_aset(opts, time_format_sym, xmlschema_sym);   break;
        case RubyTime:      rb_hash_aset(opts, time_format_sym, ruby_sym);               break;
        case UnixZTime:     rb_hash_aset(opts, time_format_sym, unix_zone_sym); break;
        case UnixTime:
        default:            rb_hash_aset(opts, time_format_sym, unix_sym);            break;
        }
        switch (oj_default_options.bigdec_load) {
        case BigDec:        rb_hash_aset(opts, bigdecimal_load_sym, bigdecimal_sym);break;
        case FloatDec:      rb_hash_aset(opts, bigdecimal_load_sym, float_sym);  break;
        case AutoDec:
        default:            rb_hash_aset(opts, bigdecimal_load_sym, auto_sym);        break;
        }
        rb_hash_aset(opts, create_id_sym, (0 == oj_default_options.create_id) ? Qnil : rb_str_new2(oj_default_options.create_id));
        rb_hash_aset(opts, oj_space_sym, (0 == oj_default_options.dump_opts.after_size) ? Qnil : rb_str_new2(oj_default_options.dump_opts.after_sep));
        rb_hash_aset(opts, oj_space_before_sym, (0 == oj_default_options.dump_opts.before_size) ? Qnil : rb_str_new2(oj_default_options.dump_opts.before_sep));
        rb_hash_aset(opts, oj_object_nl_sym, (0 == oj_default_options.dump_opts.hash_size) ? Qnil : rb_str_new2(oj_default_options.dump_opts.hash_nl));
        rb_hash_aset(opts, oj_array_nl_sym, (0 == oj_default_options.dump_opts.array_size) ? Qnil : rb_str_new2(oj_default_options.dump_opts.array_nl));

        switch (oj_default_options.dump_opts.nan_dump) {
        case NullNan:       rb_hash_aset(opts, nan_sym, null_sym);        break;
        case RaiseNan:      rb_hash_aset(opts, nan_sym, raise_sym);      break;
        case WordNan:       rb_hash_aset(opts, nan_sym, word_sym);        break;
        case HugeNan:       rb_hash_aset(opts, nan_sym, huge_sym);        break;
        case AutoNan:
        default:            rb_hash_aset(opts, nan_sym, auto_sym);    break;
        }
        rb_hash_aset(opts, omit_nil_sym, oj_default_options.dump_opts.omit_nil ? Qtrue : Qfalse);
        rb_hash_aset(opts, oj_hash_class_sym, oj_default_options.hash_class);
        rb_hash_aset(opts, oj_array_class_sym, oj_default_options.array_class);

        return opts;
    }

default_options=(opts) click to toggle source

Sets the default options for load and dump.

- opts [Hash] options to change

  - :indent [Fixnum|String|nil] number of spaces to indent each element in a JSON document or the String to use for identation.

  - :circular [Boolean|nil] support circular references while dumping.

  - :auto_define [Boolean|nil] automatically define classes if they do not exist.

  - :symbol_keys [Boolean|nil] convert hash keys to symbols.

  - :class_cache [Boolean|nil] cache classes for faster parsing.

  - :escape [:newline|:json|:xss_safe|:ascii|unicode_xss|nil] mode encodes all high-bit characters as escaped sequences if :ascii, :json is standand UTF-8 JSON encoding, :newline is the same as :json but newlines are not escaped, :unicode_xss allows unicode but escapes &, <, and >, and any u20xx characters along with some others, and :xss_safe escapes &, <, and >, and some others.

  - :bigdecimal_as_decimal [Boolean|nil] dump BigDecimal as a decimal number or as a String.

  - :bigdecimal_load [:bigdecimal|:float|:auto|nil] load decimals as BigDecimal instead of as a Float. :auto pick the most precise for the number of digits.

  - :mode [:object|:strict|:compat|:null|:custom|:rails|:wab] load and dump mode to use for JSON :strict raises an exception when a non-supported Object is encountered. :compat attempts to extract variable values from an Object using ::to_json() or to_hash() then it walks the Object's variables if neither is found. The :object mode ignores to_hash() and ::to_json() methods and encodes variables using code internal to the Oj gem. The :null mode ignores non-supported Objects and replaces them with a null. The :custom mode honors all dump options. The :rails more mimics rails and Active behavior.

  - :time_format [:unix|:xmlschema|:ruby] time format when dumping in :compat mode :unix decimal number denoting the number of seconds since 1/1/1970, :unix_zone decimal number denoting the number of seconds since 1/1/1970 plus the utc_offset in the exponent, :xmlschema date-time format taken from XML Schema as a String, :ruby Time.to_s formatted String.

  - :create_id [String|nil] create id for json compatible object encoding

  - :second_precision [Fixnum|nil] number of digits after the decimal when dumping the seconds portion of time.

  - :float_precision [Fixnum|nil] number of digits of precision when dumping floats, 0 indicates use Ruby.

  - :use_to_json [Boolean|nil] call ::to_json() methods on dump, default is false.

  - :use_as_json [Boolean|nil] call #as_json() methods on dump, default is false.

  - :use_to_hash [Boolean|nil] call to_hash() methods on dump, default is false.

  - :nilnil [Boolean|nil] if true a nil input to load will return nil and not raise an Exception.

  - :allow_gc [Boolean|nil] allow or prohibit GC during parsing, default is true (allow).

  - :quirks_mode [Boolean|nil] allow single JSON values instead of documents, default is true (allow).

  - :allow_invalid_unicode [Boolean|nil] allow invalid unicode, default is false (don't allow).

  - :allow_nan [Boolean|nil] allow Nan, Infinity, and -Infinity, default is true (allow).

  - :space [String|nil] String to use for the space after the colon in JSON object fields.

  - :space_before [String|nil] String to use before the colon separator in JSON object fields.

  - :object_nl [String|nil] String to use after a JSON object field value.

  - :array_nl [String|nil] String to use after a JSON array value

  - :nan [:null|:huge|:word|:raise] how to dump Infinity and NaN in null, strict, and compat mode. :null places a null, :huge places a huge number, :word places Infinity or NaN, :raise raises and exception, :auto uses default for each mode.

  - :hash_class [Class|nil] Class to use instead of Hash on load, :object_class can also be used.

  - :array_class [Class|nil] Class to use instead of Array on load.

  - :omit_nil [true|false] if true Hash and Object attributes with nil values are omitted.

    static VALUE
    set_def_opts(VALUE self, VALUE opts) {
        Check_Type(opts, T_HASH);
        oj_parse_options(opts, &oj_default_options);

        return Qnil;
    }

dump(obj, options) click to toggle source

Dumps an Object (obj) to a string.

- obj [Object] Object to serialize as an JSON document String

- options [Hash] same as ::default_options

    static VALUE
    dump(int argc, VALUE *argv, VALUE self) {
        char                buf[4096];
        struct _Out         out;
        struct _Options     copts = oj_default_options;
        VALUE               rstr;

        if (1 > argc) {
            rb_raise(rb_eArgError, "wrong number of arguments (0 for 1).");
        }
        if (CompatMode == copts.mode) {
            copts.dump_opts.nan_dump = WordNan;
        }
        if (2 == argc) {
            oj_parse_options(argv[1], &copts);
        }
        out.buf = buf;
        out.end = buf + sizeof(buf) - 10;
        out.allocated = false;
        out.omit_nil = copts.dump_opts.omit_nil;
        out.caller = CALLER_DUMP;
        oj_dump_obj_to_json_using_params(*argv, &copts, &out, argc - 1,argv + 1);
        if (0 == out.buf) {
            rb_raise(rb_eNoMemError, "Not enough memory.");
        }
        rstr = rb_str_new2(out.buf);
        rstr = oj_encode(rstr);
        if (out.allocated) {
            xfree(out.buf);
        }
        return rstr;
    }

generate(obj, opts=nil)

Encode obj as a JSON String. The obj argument must be a Hash, Array, or respond to to_h or to_json. Options other than those listed such as `:allow_nan` or `:max_nesting` are ignored.

- obj [Object_|Hash|Array] object to convert to a JSON String

- opts [Hash] options

- - :indent [String] String to use for indentation.

  - :space [String] String placed after a , or : delimiter

  - *:space * _before [String] String placed before a : delimiter

  - :object_nl [String] String placed after a JSON object

  - :array_nl [String] String placed after a JSON array

  - :ascii_only [Boolean] if not nil or false then use only ascii characters in the output. Note JSON.generate does support this even if it is not documented.

Returns [String]generated JSON.

json_create(h) click to toggle source

    # File lib/oj/mimic.rb, line 62
    def self.json_create(h)
      new(h['t'] || h[:t])
    end

load(json, options) { _|_obj, start, len_|_ } click to toggle source

Parses a JSON document String into a Object, Hash, Array, String, Fixnum, Float, true, false, or nil according to the default mode or the mode specified. Raises an exception if the JSON is malformed or the classes specified are not valid. If the string input is not a valid JSON document (an empty string is not a valid JSON document) an exception is raised.

When used with a document that has multiple JSON elements the block, if any, will be yielded to. If no block then the last element read will be returned.

This parser operates on string and will attempt to load files into memory if a file object is passed as the first argument. A stream input will be parsed using a stream parser but others use the slightly faster string parser.

A block can be provided with a single argument. That argument will be the parsed JSON document. This is useful when parsing a string that includes multiple JSON documents. The block can take up to 3 arguments, the parsed object, the position in the string or stream of the start of the JSON for that object, and the length of the JSON for that object plus trailing whitespace.

- json [String|IO] JSON String or an Object that responds to read()

- options [Hash] load options (same as ::default_options)

  - -

- obj [Hash|Array|String|Fixnum|Float|Boolean|nil] parsed object.

- start [_optional, Integer] start position of parsed JSON for obj.

- len [_optional, Integer] length of parsed JSON for obj.

Returns [Hash|Array|String|Fixnum|Float|Boolean|nil]

    static VALUE
    load(int argc, VALUE *argv, VALUE self) {
        Mode        mode = oj_default_options.mode;

        if (1 > argc) {
            rb_raise(rb_eArgError, "Wrong number of arguments to load().");
        }
        if (2 <= argc) {
            VALUE  ropts = argv[1];
            VALUE  v;

            if (Qnil != ropts || CompatMode != mode) {
                Check_Type(ropts, T_HASH);
                if (Qnil != (v = rb_hash_lookup(ropts, mode_sym))) {
                    if (object_sym == v) {
                        mode = ObjectMode;
                    } else if (strict_sym == v) {
                        mode = StrictMode;
                    } else if (compat_sym == v || json_sym == v) {
                        mode = CompatMode;
                    } else if (null_sym == v) {
                        mode = NullMode;
                    } else if (custom_sym == v) {
                        mode = CustomMode;
                    } else if (rails_sym == v) {
                        mode = RailsMode;
                    } else if (wab_sym == v) {
                        mode = WabMode;
                    } else {
                        rb_raise(rb_eArgError, ":mode must be :object, :strict, :compat, :null, :custom, :rails, or :wab.");
                    }
                }
            }
        }
        switch (mode) {
        case StrictMode:
        case NullMode:
            return oj_strict_parse(argc, argv, self);
        case CompatMode:
        case RailsMode:
            return oj_compat_parse(argc, argv, self);
        case CustomMode:
            return oj_custom_parse(argc, argv, self);
        case WabMode:
            return oj_wab_parse(argc, argv, self);
        case ObjectMode:
        default:
            break;
        }
        return oj_object_parse(argc, argv, self);
    }

load_file(path, options) { _|_obj, start, len_|_ } click to toggle source

Parses a JSON document String into a Object, Hash, Array, String, Fixnum, Float, true, false, or nil according to the default mode or the mode specified. Raises an exception if the JSON is malformed or the classes specified are not valid. If the string input is not a valid JSON document (an empty string is not a valid JSON document) an exception is raised.

When used with a document that has multiple JSON elements the block, if any, will be yielded to. If no block then the last element read will be returned.

If the input file is not a valid JSON document (an empty file is not a valid JSON document) an exception is raised.

This is a stream based parser which allows a large or huge file to be loaded without pulling the whole file into memory.

A block can be provided with a single argument. That argument will be the parsed JSON document. This is useful when parsing a string that includes multiple JSON documents. The block can take up to 3 arguments, the parsed object, the position in the string or stream of the start of the JSON for that object, and the length of the JSON for that object plus trailing whitespace.

- path [String] to a file containing a JSON document

- options [Hash] load options (same as ::default_options)

  - -

- obj [Hash|Array|String|Fixnum|Float|Boolean|nil] parsed object.

- start [_optional, Integer] start position of parsed JSON for obj.

- len [_optional, Integer] length of parsed JSON for obj.

Returns [Object|Hash|Array|String|Fixnum|Float|Boolean|nil]

    static VALUE
    load_file(int argc, VALUE *argv, VALUE self) {
        char                *path;
        int                 fd;
        Mode                mode = oj_default_options.mode;
        struct _ParseInfo   pi;

        if (1 > argc) {
            rb_raise(rb_eArgError, "Wrong number of arguments to load().");
        }
        Check_Type(*argv, T_STRING);
        parse_info_init(&pi);
        pi.options = oj_default_options;
        pi.handler = Qnil;
        pi.err_class = Qnil;
        pi.max_depth = 0;
        if (2 <= argc) {
            VALUE  ropts = argv[1];
            VALUE  v;

            Check_Type(ropts, T_HASH);
            if (Qnil != (v = rb_hash_lookup(ropts, mode_sym))) {
                if (object_sym == v) {
                    mode = ObjectMode;
                } else if (strict_sym == v) {
                    mode = StrictMode;
                } else if (compat_sym == v || json_sym == v) {
                    mode = CompatMode;
                } else if (null_sym == v) {
                    mode = NullMode;
                } else if (custom_sym == v) {
                    mode = CustomMode;
                } else if (rails_sym == v) {
                    mode = RailsMode;
                } else if (wab_sym == v) {
                    mode = WabMode;
                } else {
                    rb_raise(rb_eArgError, ":mode must be :object, :strict, :compat, :null, :custom, :rails, or :wab.");
                }
            }
        }
        path = StringValuePtr(*argv);
        if (0 == (fd = open(path, O_RDONLY))) {
            rb_raise(rb_eIOError, "%s", strerror(errno));
        }
        switch (mode) {
        case StrictMode:
            oj_set_strict_callbacks(&pi);
            return oj_pi_sparse(argc, argv, &pi, fd);
        case NullMode:
        case CompatMode:
        case CustomMode:
        case RailsMode:
            oj_set_compat_callbacks(&pi);
            return oj_pi_sparse(argc, argv, &pi, fd);
        case WabMode:
            oj_set_wab_callbacks(&pi);
            return oj_pi_sparse(argc, argv, &pi, fd);
        case ObjectMode:
        default:
            break;
        }
        oj_set_object_callbacks(&pi);

        return oj_pi_sparse(argc, argv, &pi, fd);
    }

mimic_JSON()

Creates the JSON module with methods and classes to mimic the JSON gem. After this method is invoked calls that expect the JSON module will use Oj instead and be faster than the original JSON. Most options that could be passed to the JSON methods are supported. The calls to set parser or generator will not raise an Exception but will not have any effect. The method can also be called after the json gem is loaded. The necessary methods on the json gem will be replaced with Oj methods.

Note that this also sets the default options of :mode to :compat and :encoding to :unicode_xss.

Returns [Module] the JSON module.

mimic_loaded(mimic_paths=[]) click to toggle source

Loads mimic-ed JSON paths. Used by ::mimic_JSON. @param mimic_path [Array] additional paths to add to the Ruby loaded features.

    # File lib/oj/mimic.rb, line 35
    def self.mimic_loaded(mimic_paths=[])
      $LOAD_PATH.each do |d|
        next unless File.exist?(d)

        jfile = File.join(d, 'json.rb')
        $LOADED_FEATURES << jfile unless $LOADED_FEATURES.include?(jfile) if File.exist?(jfile)

        Dir.glob(File.join(d, 'json', '**', '*.rb')).each do |file|
          # allow json/add/xxx to be loaded. User can override with Oj.add_to_json(xxx).
          $LOADED_FEATURES << file unless $LOADED_FEATURES.include?(file) unless file.include?('add')
        end
      end
      mimic_paths.each { |p| $LOADED_FEATURES << p }
      $LOADED_FEATURES << 'json' unless $LOADED_FEATURES.include?('json')

      require 'oj/json'

      if Object.const_defined?('OpenStruct')
        OpenStruct.class_eval do
          # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
          unless defined?(self.as_json)
            def as_json(*)
              name = self.class.name.to_s
              raise JSON::JSONError, "Only named structs are supported!" if 0 == name.length
              { JSON.create_id => name, 't' => table }
            end
          end
          def self.json_create(h)
            new(h['t'] || h[:t])
          end
        end
      end

      BigDecimal.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            {JSON.create_id => 'BigDecimal', 'b' => _dump }
          end
        end
        def self.json_create(h)
          BigDecimal._load(h['b'])
        end
      end

      Complex.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            {JSON.create_id => 'Complex', 'r' => real, 'i' => imag }
          end
        end
        def self.json_create(h)
          Complex(h['r'], h['i'])
        end
      end

      Date.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            { JSON.create_id => 'Date', 'y' => year, 'm' => month, 'd' => day, 'sg' => start }
          end
        end
        def self.json_create(h)
          civil(h['y'], h['m'], h['d'], h['sg'])
        end
      end

      DateTime.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            { JSON.create_id => 'DateTime',
              'y' => year,
              'm' => month,
              'd' => day,
              'H' => hour,
              'M' => min,
              'S' => sec,
              'of' => offset.to_s,
              'sg' => start }
          end
        end
        def self.json_create(h)
          # offset is a rational as a string
          as, bs = h['of'].split('/')
          a = as.to_i
          b = bs.to_i
          if 0 == b
            off = a
          else
            off = Rational(a, b)
          end
          civil(h['y'], h['m'], h['d'], h['H'], h['M'], h['S'], off, h['sg'])
        end
      end

      Date.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            { JSON.create_id => 'Date', 'y' => year, 'm' => month, 'd' => day, 'sg' => start }
          end
        end
        def self.json_create(h)
          civil(h['y'], h['m'], h['d'], h['sg'])
        end
      end

      Exception.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            {JSON.create_id => self.class.name, 'm' => message, 'b' => backtrace }
          end
        end
        def self.json_create(h)
          e = new(h['m'])
          e.set_backtrace(h['b'])
          e
        end
      end

      Range.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            {JSON.create_id => 'Range', 'a' => [first, last, exclude_end?]}
          end
        end
        def self.json_create(h)
          new(*h['a'])
        end
      end

      Rational.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            {JSON.create_id => 'Rational', 'n' => numerator, 'd' => denominator }
          end
        end
        def self.json_create(h)
          Rational(h['n'], h['d'])
        end
      end

      Regexp.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            {JSON.create_id => 'Regexp', 'o' => options, 's' => source }
          end
        end
        def self.json_create(h)
          new(h['s'], h['o'])
        end
      end

      Struct.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            name = self.class.name.to_s
            raise JSON::JSONError, "Only named structs are supported!" if 0 == name.length
            { JSON.create_id => name, 'v' => values }
          end
        end
        def self.json_create(h)
          new(*h['v'])
        end
      end

      Symbol.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            {JSON.create_id => 'Symbol', 's' => to_s }
          end
        end
        def self.json_create(h)
          h['s'].to_sym
        end
      end

      Time.class_eval do
        # Both the JSON gem and Rails monkey patch as_json. Let them battle it out.
        unless defined?(self.as_json)
          def as_json(*)
            nsecs = [ tv_usec * 1000 ]
            nsecs << tv_nsec if respond_to?(:tv_nsec)
            nsecs = nsecs.max
            { JSON.create_id => 'Time', 's' => tv_sec, 'n' => nsecs }
          end
        end
        def self.json_create(h)
          if usec = h.delete('u')
            h['n'] = usec * 1000
          end
          if instance_methods.include?(:tv_nsec)
            at(h['s'], Rational(h['n'], 1000))
          else
            at(h['s'], h['n'] / 1000)
          end
        end
      end

    end

object_load(json, options) { _|_obj, start, len_|_ }

Parses a JSON document String into an Object, Hash, Array, String, Fixnum, Float, true, false, or nil. In the :object mode the JSON should have been generated by ::dump. The parser will reconstitute the original marshalled or dumped Object. The :auto_define and :circular options have meaning with this parsing mode.

Raises an exception if the JSON is malformed or the classes specified are not valid. If the input is not a valid JSON document (an empty string is not a valid JSON document) an exception is raised.

Note: Oj is not able to automatically deserialize all classes that are a subclass of a Ruby Exception. Only exception that take one required string argument in the initialize() method are supported. This is an example of how to write an Exception subclass that supports both a single string intializer and an Exception as an argument. Additional optional arguments can be added as well.

The reason for this restriction has to do with a design decision on the part of the Ruby developers. Exceptions are special Objects. They do not follow the rules of other Objects. Exceptions have 'mesg' and a 'bt' attribute. Note that these are not '@mesg' and '@bt'. They can not be set using the normal C or Ruby calls. The only way I have found to set the 'mesg' attribute is through the initializer. Unfortunately that means any subclass that provides a different initializer can not be automatically decoded. A way around this is to use a create function but this example shows an alternative.

A block can be provided with a single argument. That argument will be the parsed JSON document. This is useful when parsing a string that includes multiple JSON documents. The block can take up to 3 arguments, the parsed object, the position in the string or stream of the start of the JSON for that object, and the length of the JSON for that object plus trailing whitespace.

- json [String|IO] JSON String or an Object that responds to read().

- options [Hash] load options (same as ::default_options).

  - -

- obj [Hash|Array|String|Fixnum|Float|Boolean|nil] parsed object.

- start [_optional, Integer] start position of parsed JSON for obj.

- len [_optional, Integer] length of parsed JSON for obj.

Returns [Hash|Array|String|Fixnum|Float|Boolean|nil]

register_odd(clas, create_object, create_method, *members) click to toggle source

Registers a class as special. This is useful for working around subclasses of primitive types as is done with ActiveSupport classes. The use of this function should be limited to just classes that can not be handled in the normal way. It is not intended as a hook for changing the output of all classes as it is not optimized for large numbers of classes.

- clas [Class_|Module] Class or Module to be made special

- create_object [Object] object to call the create method on

- create_method [Symbol] method on the clas that will create a new instance of the clas when given all the member values in the order specified.

- members [Symbol_|String] methods used to get the member values from instances of the clas.

    static VALUE
    register_odd(int argc, VALUE *argv, VALUE self) {
        if (3 > argc) {
            rb_raise(rb_eArgError, "incorrect number of arguments.");
        }
        switch (rb_type(*argv)) {
        case T_CLASS:
        case T_MODULE:
            break;
        default:
            rb_raise(rb_eTypeError, "expected a class or module.");
            break;
        }
        Check_Type(argv[2], T_SYMBOL);
        if (MAX_ODD_ARGS < argc - 2) {
            rb_raise(rb_eArgError, "too many members.");
        }
        oj_reg_odd(argv[0], argv[1], argv[2], argc - 3, argv + 3, false);

        return Qnil;
    }

register_odd_raw(clas, create_object, create_method, dump_method) click to toggle source

Registers a class as special and expect the output to be a string that can be included in the dumped JSON directly. This is useful for working around subclasses of primitive types as is done with ActiveSupport classes. The use of this function should be limited to just classes that can not be handled in the normal way. It is not intended as a hook for changing the output of all classes as it is not optimized for large numbers of classes. Be careful with this option as the JSON may be incorrect if invalid JSON is returned.

- clas [Class|Module] Class or Module to be made special

- create_object [Object] object to call the create method on

- create_method [Symbol] method on the clas that will create a new instance of the clas when given all the member values in the order specified.

- dump_method [Symbol|String] method to call on the object being serialized to generate the raw JSON.

    static VALUE
    register_odd_raw(int argc, VALUE *argv, VALUE self) {
        if (3 > argc) {
            rb_raise(rb_eArgError, "incorrect number of arguments.");
        }
        switch (rb_type(*argv)) {
        case T_CLASS:
        case T_MODULE:
            break;
        default:
            rb_raise(rb_eTypeError, "expected a class or module.");
            break;
        }
        Check_Type(argv[2], T_SYMBOL);
        if (MAX_ODD_ARGS < argc - 2) {
            rb_raise(rb_eArgError, "too many members.");
        }
        oj_reg_odd(argv[0], argv[1], argv[2], 1, argv + 3, true);

        return Qnil;
    }

safe_load(doc) click to toggle source

Loads a JSON document in strict mode with :auto_define and :symbol_keys turned off. This function should be safe to use with JSON received on an unprotected public interface.

- doc [String_|IO] JSON String or IO to load.

Returns [Hash|Array|String|Fixnum|Bignum|BigDecimal|nil|True|False]

    static VALUE
    safe_load(VALUE self, VALUE doc) {
        struct _ParseInfo   pi;
        VALUE               args[1];

        parse_info_init(&pi);
        pi.err_class = Qnil;
        pi.max_depth = 0;
        pi.options = oj_default_options;
        pi.options.auto_define = No;
        pi.options.sym_key = No;
        pi.options.mode = StrictMode;
        oj_set_strict_callbacks(&pi);
        *args = doc;

        return oj_pi_parse(1, args, &pi, 0, 0, 1);
    }

saj_parse(handler, io)

Parses an IO stream or file containing a JSON document. Raises an exception if the JSON is malformed. This is a callback parser that calls the methods in the handler if they exist. A sample is the Oj::Saj class which can be used as a base class for the handler.

- handler [Oj::Saj] responds to Oj::Saj methods

- io [IO|String] IO Object to read from

sc_parse(handler, io)

Parses an IO stream or file containing a JSON document. Raises an exception if the JSON is malformed. This is a callback parser (Simple Callback Parser) that calls the methods in the handler if they exist. A sample is the Oj::ScHandler class which can be used as a base class for the handler. This callback parser is slightly more efficient than the Saj callback parser and requires less argument checking.

- handler [Oj::ScHandler_] responds to Oj::ScHandler methods

- io [IO_|String] IO Object to read from

strict_load(json, options) { _|_obj, start, len_|_ }

Parses a JSON document String into an Hash, Array, String, Fixnum, Float, true, false, or nil. It parses using a mode that is strict in that it maps each primitive JSON type to a similar Ruby type. The :create_id is not honored in this mode. Note that a Ruby Hash is used to represent the JSON Object type. These two are not the same since the JSON Object type can have repeating entries with the same key and Ruby Hash can not.

When used with a document that has multiple JSON elements the block, if any, will be yielded to. If no block then the last element read will be returned.

Raises an exception if the JSON is malformed or the classes specified are not valid. If the input is not a valid JSON document (an empty string is not a valid JSON document) an exception is raised.

A block can be provided with a single argument. That argument will be the parsed JSON document. This is useful when parsing a string that includes multiple JSON documents. The block can take up to 3 arguments, the parsed object, the position in the string or stream of the start of the JSON for that object, and the length of the JSON for that object plus trailing whitespace.

- json [String|IO] JSON String or an Object that responds to read().

- options [Hash] load options (same as ::default_options).

  - -

- obj [Hash|Array|String|Fixnum|Float|Boolean|nil] parsed object.

- start [_optional, Integer] start position of parsed JSON for obj.

- len [_optional, Integer] length of parsed JSON for obj.

Returns [Hash|Array|String|Fixnum|Float|Boolean|nil]

to_file(file_path, obj, options) click to toggle source

Dumps an Object to the specified file.

- file [String] _path file path to write the JSON document to

- obj [Object] Object to serialize as an JSON document String

- options [Hash] formating options

  - :indent [Fixnum] format expected

  - :circular [Boolean] allow circular references, default: false

    static VALUE
    to_file(int argc, VALUE *argv, VALUE self) {
        struct _Options     copts = oj_default_options;

        if (3 == argc) {
            oj_parse_options(argv[2], &copts);
        }
        Check_Type(*argv, T_STRING);
        oj_write_obj_to_file(argv[1], StringValuePtr(*argv), &copts);

        return Qnil;
    }

to_json(obj, options) click to toggle source

Dumps an Object (obj) to a string. If the object has a ::to_json method that will be called. The mode is set to :compat.

- obj [Object] Object to serialize as an JSON document String

- options [Hash]

  - :max_nesting [boolean] It true nesting is limited to 100. The option to detect circular references is available but is not compatible with the json gem., default is false

  - :allow_nan [boolean] If true non JSON compliant words such as Nan and Infinity will be used as appropriate, default is true.

  - :quirks_mode [boolean] Allow single JSON values instead of documents, default is true (allow).

  - :indent [String|nil] String to use for indentation, overriding the indent option if not nil.

  - :space [String|nil] String to use for the space after the colon in JSON object fields.

  - :space_before [String|nil] String to use before the colon separator in JSON object fields.

  - :object_nl [String|nil] String to use after a JSON object field value.

  - :array_nl [String|nil] String to use after a JSON array value.

Returns [String] the encoded JSON.

    static VALUE
    to_json(int argc, VALUE *argv, VALUE self) {
        char                buf[4096];
        struct _Out         out;
        struct _Options     copts = oj_default_options;
        VALUE               rstr;

        if (1 > argc) {
            rb_raise(rb_eArgError, "wrong number of arguments (0 for 1).");
        }
        copts.escape_mode = JXEsc;
        copts.dump_opts.nan_dump = RaiseNan;
        if (2 == argc) {
            oj_parse_mimic_dump_options(argv[1], &copts);
        }
        copts.mode = CompatMode;
        copts.to_json = Yes;
        out.buf = buf;
        out.end = buf + sizeof(buf) - 10;
        out.allocated = false;
        out.omit_nil = copts.dump_opts.omit_nil;
        // For obj.to_json or generate nan is not allowed but if called from dump
        // it is.
        oj_dump_obj_to_json_using_params(*argv, &copts, &out, argc - 1, argv + 1);

        if (0 == out.buf) {
            rb_raise(rb_eNoMemError, "Not enough memory.");
        }
        rstr = rb_str_new2(out.buf);
        rstr = oj_encode(rstr);
        if (out.allocated) {
            xfree(out.buf);
        }
        return rstr;
    }

to_stream(io, obj, options) click to toggle source

Dumps an Object to the specified IO stream.

- io [IO] IO stream to write the JSON document to

- obj [Object] Object to serialize as an JSON document String

- options [Hash] formating options

  - :indent [Fixnum] format expected

  - :circular [Boolean] allow circular references, default: false

    static VALUE
    to_stream(int argc, VALUE *argv, VALUE self) {
        struct _Options     copts = oj_default_options;

        if (3 == argc) {
            oj_parse_options(argv[2], &copts);
        }
        oj_write_obj_to_stream(argv[1], *argv, &copts);

        return Qnil;
    }

wab_load(json, options) { _|_obj, start, len_|_ }

Parses a JSON document String into an Hash, Array, String, Fixnum, Float, true, false, or nil. It parses using a mode that is :wab in that it maps each primitive JSON type to a similar Ruby type. The :create_id is not honored in this mode. Note that a Ruby Hash is used to represent the JSON Object type. These two are not the same since the JSON Object type can have repeating entries with the same key and Ruby Hash can not.

When used with a document that has multiple JSON elements the block, if any, will be yielded to. If no block then the last element read will be returned.

Raises an exception if the JSON is malformed or the classes specified are not valid. If the input is not a valid JSON document (an empty string is not a valid JSON document) an exception is raised.

A block can be provided with a single argument. That argument will be the parsed JSON document. This is useful when parsing a string that includes multiple JSON documents. The block can take up to 3 arguments, the parsed object, the position in the string or stream of the start of the JSON for that object, and the length of the JSON for that object plus trailing whitespace.

- json [String|IO] JSON String or an Object that responds to read().

- options [Hash] load options (same as ::default_options).

  - -

- obj [Hash|Array|String|Fixnum|Float|Boolean|nil] parsed object.

- start [_optional, Integer] start position of parsed JSON for obj.

- len [_optional, Integer] length of parsed JSON for obj.

Returns [Hash|Array|String|Fixnum|Float|Boolean|nil]

### Public Instance Methods

as_json(*) click to toggle source

    # File lib/oj/mimic.rb, line 56
    def as_json(*)
      name = self.class.name.to_s
      raise JSON::JSONError, "Only named structs are supported!" if 0 == name.length
      { JSON.create_id => name, 't' => table }
    end