Module: MultiJson
- Extended by:
- MultiJson
- Includes:
- Options
- Included in:
- MultiJson
- Defined in:
- lib/multi_json.rb,
lib/multi_json/adapter.rb,
lib/multi_json/options.rb,
lib/multi_json/version.rb,
lib/multi_json/load_error.rb,
lib/multi_json/adapters/oj.rb,
lib/multi_json/parse_error.rb,
lib/multi_json/adapter_error.rb,
lib/multi_json/adapters/gson.rb,
lib/multi_json/adapters/yajl.rb,
lib/multi_json/vendor/okjson.rb,
lib/multi_json/adapters/ok_json.rb,
lib/multi_json/adapters/json_gem.rb,
lib/multi_json/adapters/json_pure.rb,
lib/multi_json/adapters/jr_jackson.rb,
lib/multi_json/adapters/json_common.rb,
lib/multi_json/convertible_hash_keys.rb,
lib/multi_json/adapters/nsjsonserialization.rb
Defined Under Namespace
Modules: Adapters, ConvertibleHashKeys, OkJson, Options Classes: Adapter, AdapterError, LoadError, ParseError, Version
Constant Summary collapse
- ALIASES =
{ 'jrjackson' => 'jr_jackson' }
- REQUIREMENT_MAP =
[ ['oj', :oj], ['yajl', :yajl], ['jrjackson', :jr_jackson], ['json/ext', :json_gem], ['gson', :gson], ['json/pure', :json_pure] ]
- VERSION =
Version.to_s.freeze
- DecodeError =
Legacy support
LoadError = ParseError
Class Method Summary collapse
Instance Method Summary collapse
-
#adapter ⇒ Object
(also: #engine)
Get the current adapter class.
- #current_adapter(options = {}) ⇒ Object
-
#default_adapter ⇒ Object
(also: #default_engine)
The default adapter based on what you currently have loaded and installed.
- #default_options=(value) ⇒ Object
-
#dump(object, options = {}) ⇒ Object
(also: #encode)
Encodes a Ruby object as JSON.
-
#load(string, options = {}) ⇒ Object
(also: #decode)
Decode a JSON string into Ruby.
- #load_adapter(new_adapter) ⇒ Object
-
#use(new_adapter) ⇒ Object
(also: #adapter=, #engine=)
Set the JSON parser utilizing a symbol, string, or class.
-
#with_adapter(new_adapter) ⇒ Object
(also: #with_engine)
Executes passed block using specified adapter.
Methods included from Options
#default_dump_options, #default_load_options, #dump_options, #dump_options=, #load_options, #load_options=
Class Method Details
.cached_options ⇒ Object
11 12 13 |
# File 'lib/multi_json.rb', line 11 def @cached_options ||= {} end |
.reset_cached_options! ⇒ Object
15 16 17 |
# File 'lib/multi_json.rb', line 15 def @cached_options = {} end |
Instance Method Details
#adapter ⇒ Object Also known as: engine
Get the current adapter class.
71 72 73 74 75 76 77 |
# File 'lib/multi_json.rb', line 71 def adapter return @adapter if defined?(@adapter) && @adapter self.use nil # load default adapter @adapter end |
#current_adapter(options = {}) ⇒ Object
128 129 130 131 132 133 134 |
# File 'lib/multi_json.rb', line 128 def current_adapter(={}) if new_adapter = [:adapter] load_adapter(new_adapter) else adapter end end |
#default_adapter ⇒ Object Also known as: default_engine
The default adapter based on what you currently have loaded and installed. First checks to see if any adapters are already loaded, then checks to see which are installed if none are loaded.
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/multi_json.rb', line 47 def default_adapter return :oj if defined?(::Oj) return :yajl if defined?(::Yajl) return :jr_jackson if defined?(::JrJackson) return :json_gem if defined?(::JSON::JSON_LOADED) return :gson if defined?(::Gson) REQUIREMENT_MAP.each do |library, adapter| begin require library return adapter rescue ::LoadError next end end Kernel.warn '[WARNING] MultiJson is using the default adapter (ok_json).' + 'We recommend loading a different JSON library to improve performance.' :ok_json end |
#default_options=(value) ⇒ Object
25 26 27 28 29 30 |
# File 'lib/multi_json.rb', line 25 def (value) Kernel.warn "MultiJson.default_options setter is deprecated\n" + "Use MultiJson.load_options and MultiJson.dump_options instead" self. = self. = value end |
#dump(object, options = {}) ⇒ Object Also known as: encode
Encodes a Ruby object as JSON.
137 138 139 |
# File 'lib/multi_json.rb', line 137 def dump(object, ={}) current_adapter().dump(object, ) end |
#load(string, options = {}) ⇒ Object Also known as: decode
Decode a JSON string into Ruby.
Options
:symbolize_keys :: If true, will use symbols instead of strings for the keys. :adapter :: If set, the selected adapter will be used for this call.
118 119 120 121 122 123 124 125 |
# File 'lib/multi_json.rb', line 118 def load(string, ={}) adapter = current_adapter() begin adapter.load(string, ) rescue adapter::ParseError => exception raise ParseError.build(exception, string) end end |
#load_adapter(new_adapter) ⇒ Object
97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/multi_json.rb', line 97 def load_adapter(new_adapter) case new_adapter when String, Symbol load_adapter_from_string_name new_adapter.to_s when NilClass, FalseClass load_adapter default_adapter when Class, Module new_adapter else raise ::LoadError, new_adapter end rescue ::LoadError => exception raise AdapterError.build(exception) end |
#use(new_adapter) ⇒ Object Also known as: adapter=, engine=
Set the JSON parser utilizing a symbol, string, or class. Supported by default are:
- :oj
- :json_gem
- :json_pure
- :ok_json
- :yajl
- :nsjsonserialization (MacRuby only)
- :gson (JRuby only)
- :jr_jackson (JRuby only)
91 92 93 |
# File 'lib/multi_json.rb', line 91 def use(new_adapter) @adapter = load_adapter(new_adapter) end |
#with_adapter(new_adapter) ⇒ Object Also known as: with_engine
Executes passed block using specified adapter.
143 144 145 146 147 148 |
# File 'lib/multi_json.rb', line 143 def with_adapter(new_adapter) old_adapter, self.adapter = adapter, new_adapter yield ensure self.adapter = old_adapter end |