Module: MultiJson

Extended by:
MultiJson
Included in:
MultiJson
Defined in:
lib/vendor/multi_json/lib/multi_json/vendor/okjson.rb,
lib/vendor/multi_json/lib/multi_json.rb,
lib/vendor/multi_json/lib/multi_json/version.rb,
lib/vendor/multi_json/lib/multi_json/adapters/oj.rb,
lib/vendor/multi_json/lib/multi_json/adapters/gson.rb,
lib/vendor/multi_json/lib/multi_json/adapters/yajl.rb,
lib/vendor/multi_json/lib/multi_json/adapters/ok_json.rb,
lib/vendor/multi_json/lib/multi_json/adapters/json_gem.rb,
lib/vendor/multi_json/lib/multi_json/adapters/json_pure.rb,
lib/vendor/multi_json/lib/multi_json/adapters/json_common.rb,
lib/vendor/multi_json/lib/multi_json/adapters/nsjsonserialization.rb

Overview

Defined Under Namespace

Modules: Adapters, OkJson Classes: LoadError

Constant Summary collapse

DecodeError =

Legacy support

LoadError
REQUIREMENT_MAP =
[
  ['oj',        :oj],
  ['yajl',      :yajl],
  ['json',      :json_gem],
  ['gson',      :gson],
  ['json/pure', :json_pure]
]
VERSION =
"1.6.1"

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#default_optionsObject

Returns the value of attribute default_options


16
17
18
# File 'lib/vendor/multi_json/lib/multi_json.rb', line 16

def default_options
  @default_options
end

Instance Method Details

#adapterObject Also known as: engine

Get the current adapter class.


52
53
54
55
56
57
58
# File 'lib/vendor/multi_json/lib/multi_json.rb', line 52

def adapter
  return @adapter if defined?(@adapter) && @adapter

  self.use nil # load default adapter

  @adapter
end

#current_adapter(options) ⇒ Object


110
111
112
113
114
115
116
# File 'lib/vendor/multi_json/lib/multi_json.rb', line 110

def current_adapter(options)
  if new_adapter = (options || {}).delete(:adapter)
    load_adapter(new_adapter)
  else
    adapter
  end
end

#default_adapterObject 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.


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# File 'lib/vendor/multi_json/lib/multi_json.rb', line 30

def default_adapter
  return :oj if defined?(::Oj)
  return :yajl if defined?(::Yajl)
  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

#dump(object, options = {}) ⇒ Object Also known as: encode

Encodes a Ruby object as JSON.


119
120
121
122
123
# File 'lib/vendor/multi_json/lib/multi_json.rb', line 119

def dump(object, options={})
  options = default_options.merge(options)
  adapter = current_adapter(options)
  adapter.dump(object, options)
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 engine will be used just for the call.


99
100
101
102
103
104
105
106
# File 'lib/vendor/multi_json/lib/multi_json.rb', line 99

def load(string, options={})
  adapter = current_adapter(options)
  begin
    adapter.load(string, options)
  rescue adapter::ParseError => exception
    raise LoadError.new(exception.message, exception.backtrace, string)
  end
end

#load_adapter(new_adapter) ⇒ Object


79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/vendor/multi_json/lib/multi_json.rb', line 79

def load_adapter(new_adapter)
  case new_adapter
  when String, Symbol
    require "multi_json/adapters/#{new_adapter}"
    MultiJson::Adapters.const_get(:"#{new_adapter.to_s.split('_').map{|s| s.capitalize}.join('')}")
  when NilClass, FalseClass
    load_adapter default_adapter
  when Class, Module
    new_adapter
  else
    raise "Did not recognize your adapter specification. Please specify either a symbol or a class."
  end
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)


72
73
74
# File 'lib/vendor/multi_json/lib/multi_json.rb', line 72

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.


128
129
130
131
132
133
# File 'lib/vendor/multi_json/lib/multi_json.rb', line 128

def with_adapter(new_adapter)
  old_adapter, self.adapter = adapter, new_adapter
  yield
ensure
  self.adapter = old_adapter
end