Module: MultiJson
- Extended by:
- MultiJson
- Includes:
- Options
- Included in:
- MultiJson
- Defined in:
- lib/multi_json/vendor/okjson.rb,
lib/multi_json.rb,
lib/multi_json/adapter.rb,
lib/multi_json/options.rb,
lib/multi_json/version.rb,
lib/multi_json/adapters/oj.rb,
lib/multi_json/adapters/gson.rb,
lib/multi_json/adapters/yajl.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
Overview
Some parts adapted from http://golang.org/src/pkg/json/decode.go and http://golang.org/src/pkg/utf8/utf8.go
Defined Under Namespace
Modules: Adapters, ConvertibleHashKeys, OkJson, Options Classes: Adapter, LoadError
Constant Summary collapse
- DecodeError =
Legacy support
LoadError
- ALIASES =
{ 'jrjackson' => :jr_jackson }
- REQUIREMENT_MAP =
[ ['oj', :oj], ['yajl', :yajl], ['json/ext', :json_gem], ['gson', :gson], ['jrjackson', :jr_jackson], ['json/pure', :json_pure] ]
- VERSION =
'1.7.3'
Instance Attribute Summary
Attributes included from Options
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
Instance Method Details
#adapter ⇒ Object Also known as: engine
Get the current adapter class.
69 70 71 72 73 74 75 |
# File 'lib/multi_json.rb', line 69 def adapter return @adapter if defined?(@adapter) && @adapter self.use nil # load default adapter @adapter end |
#current_adapter(options = {}) ⇒ Object
131 132 133 134 135 136 137 |
# File 'lib/multi_json.rb', line 131 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 |
# File 'lib/multi_json.rb', line 47 def default_adapter return :oj if defined?(::Oj) return :yajl if defined?(::Yajl) return :json_gem if defined?(::JSON) return :gson if defined?(::Gson) return :jr_jackson if defined?(::JrJackson) 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
23 24 25 26 27 28 |
# File 'lib/multi_json.rb', line 23 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.
140 141 142 |
# File 'lib/multi_json.rb', line 140 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.
121 122 123 124 125 126 127 128 |
# File 'lib/multi_json.rb', line 121 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
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/multi_json.rb', line 97 def load_adapter(new_adapter) case new_adapter when String, Symbol new_adapter = ALIASES.fetch(new_adapter.to_s, new_adapter) require "multi_json/adapters/#{new_adapter}" klass_name = new_adapter.to_s.split('_').map(&:capitalize) * '' MultiJson::Adapters.const_get(klass_name) when NilClass, FalseClass load_adapter default_adapter when Class, Module new_adapter else raise NameError end rescue NameError, ::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)
89 90 91 92 93 |
# File 'lib/multi_json.rb', line 89 def use(new_adapter) adapter = load_adapter(new_adapter) adapter.activate! if adapter.respond_to?(:activate!) @adapter = adapter end |
#with_adapter(new_adapter) ⇒ Object Also known as: with_engine
Executes passed block using specified adapter.
146 147 148 149 150 151 |
# File 'lib/multi_json.rb', line 146 def with_adapter(new_adapter) old_adapter, self.adapter = adapter, new_adapter yield ensure self.adapter = old_adapter end |