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/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, LoadError, 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
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
10 11 12 |
# File 'lib/multi_json.rb', line 10 def @cached_options ||= {} end |
.reset_cached_options! ⇒ Object
14 15 16 |
# File 'lib/multi_json.rb', line 14 def @cached_options = {} end |
Instance Method Details
#adapter ⇒ Object Also known as: engine
Get the current adapter class.
68 69 70 71 72 73 74 |
# File 'lib/multi_json.rb', line 68 def adapter return @adapter if defined?(@adapter) && @adapter self.use nil # load default adapter @adapter end |
#current_adapter(options = {}) ⇒ Object
125 126 127 128 129 130 131 |
# File 'lib/multi_json.rb', line 125 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.
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/multi_json.rb', line 46 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) 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
24 25 26 27 28 29 |
# File 'lib/multi_json.rb', line 24 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.
134 135 136 |
# File 'lib/multi_json.rb', line 134 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.
115 116 117 118 119 120 121 122 |
# File 'lib/multi_json.rb', line 115 def load(string, ={}) adapter = current_adapter() begin adapter.load(string, ) rescue adapter::ParseError => exception raise LoadError.new(exception., exception.backtrace, string) end end |
#load_adapter(new_adapter) ⇒ Object
94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/multi_json.rb', line 94 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 end rescue ::LoadError raise ArgumentError, 'Did not recognize your adapter specification.' 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)
88 89 90 |
# File 'lib/multi_json.rb', line 88 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.
140 141 142 143 144 145 |
# File 'lib/multi_json.rb', line 140 def with_adapter(new_adapter) old_adapter, self.adapter = adapter, new_adapter yield ensure self.adapter = old_adapter end |