multi_json 1.5.0 → 1.15.0

data/lib/multi_json.rb

@@ -1,130 +1,161 @@
+require 'multi_json/options'
+require 'multi_json/version'
+require 'multi_json/adapter_error'
+require 'multi_json/parse_error'
+require 'multi_json/options_cache'
+
 module MultiJson
-  class DecodeError < StandardError
-    attr_reader :data
-    def initialize(message="", backtrace=[], data="")
-      super(message)
-      self.set_backtrace(backtrace)
-      @data = data
+  include Options
+  extend self
+
+  def default_options=(value)
+    Kernel.warn "MultiJson.default_options setter is deprecated\n" \
+      'Use MultiJson.load_options and MultiJson.dump_options instead'
+
+    self.load_options = self.dump_options = value
+  end
+
+  def default_options
+    Kernel.warn "MultiJson.default_options is deprecated\n" \
+      'Use MultiJson.load_options or MultiJson.dump_options instead'
+
+    load_options
+  end
+
+  %w(cached_options reset_cached_options!).each do |method_name|
+    define_method method_name do |*|
+      Kernel.warn "MultiJson.#{method_name} method is deprecated and no longer used."
     end
   end
 
-  @adapter = nil
+  ALIASES = {'jrjackson' => 'jr_jackson'}
 
   REQUIREMENT_MAP = [
-    ["oj", :oj],
-    ["yajl", :yajl],
-    ["json", :json_gem],
-    ["json/pure", :json_pure]
+    [:oj,         'oj'],
+    [:yajl,       'yajl'],
+    [:jr_jackson, 'jrjackson'],
+    [:json_gem,   'json/ext'],
+    [:gson,       'gson'],
+    [:json_pure,  'json/pure'],
   ]
 
-  class << self
-
-    # 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.
-    def default_adapter
-      return :oj if defined?(::Oj)
-      return :yajl if defined?(::Yajl)
-      return :json_gem if defined?(::JSON)
-
-      REQUIREMENT_MAP.each do |(library, adapter)|
-        begin
-          require library
-          return adapter
-        rescue LoadError
-          next
-        end
-      end
+  # 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.
+  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::Ext::Parser)
+    return :gson if defined?(::Gson)
 
-      Kernel.warn "[WARNING] MultiJson is using the default adapter (ok_json). We recommend loading a different JSON library to improve performance."
-      :ok_json
-    end
-    # :nodoc:
-    alias :default_engine :default_adapter
-
-    # Get the current adapter class.
-    def adapter
-      return @adapter if @adapter
-      self.use self.default_adapter
-      @adapter
-    end
-    # :nodoc:
-    alias :engine :adapter
-
-    # Set the JSON parser utilizing a symbol, string, or class.
-    # Supported by default are:
-    #
-    # * <tt>:oj</tt>
-    # * <tt>:json_gem</tt>
-    # * <tt>:json_pure</tt>
-    # * <tt>:ok_json</tt>
-    # * <tt>:yajl</tt>
-    # * <tt>:nsjsonserialization</tt> (MacRuby only)
-    def use(new_adapter)
-      @adapter = load_adapter(new_adapter)
-    end
-    alias :adapter= :use
-    # :nodoc:
-    alias :engine= :use
-
-    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
-        default_adapter = self.default_adapter
-        require "multi_json/adapters/#{default_adapter}"
-        MultiJson::Adapters.const_get(:"#{default_adapter.to_s.split('_').map{|s| s.capitalize}.join('')}")
-      when Class
-        new_adapter
-      else
-        raise "Did not recognize your adapter specification. Please specify either a symbol or a class."
-      end
-    end
-
-    # Decode a JSON string into Ruby.
-    #
-    # <b>Options</b>
-    #
-    # <tt>:symbolize_keys</tt> :: If true, will use symbols instead of strings for the keys.
-    # <tt>:adapter</tt> :: If set, the selected engine will be used just for the call.
-    def load(string, options={})
-      adapter = current_adapter(options)
+    REQUIREMENT_MAP.each do |adapter, library|
       begin
-        adapter.load(string, options)
-      rescue adapter::ParseError => exception
-        raise DecodeError.new(exception.message, exception.backtrace, string)
+        require library
+        return adapter
+      rescue ::LoadError
+        next
       end
     end
-    # :nodoc:
-    alias :decode :load
-
-    def current_adapter(options)
-      if new_adapter = (options || {}).delete(:adapter)
-        load_adapter(new_adapter)
-      else
-        adapter
-      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
+  alias_method :default_engine, :default_adapter
+
+  # Get the current adapter class.
+  def adapter
+    return @adapter if defined?(@adapter) && @adapter
+
+    use nil # load default adapter
+
+    @adapter
+  end
+  alias_method :engine, :adapter
+
+  # Set the JSON parser utilizing a symbol, string, or class.
+  # Supported by default are:
+  #
+  # * <tt>:oj</tt>
+  # * <tt>:json_gem</tt>
+  # * <tt>:json_pure</tt>
+  # * <tt>:ok_json</tt>
+  # * <tt>:yajl</tt>
+  # * <tt>:nsjsonserialization</tt> (MacRuby only)
+  # * <tt>:gson</tt> (JRuby only)
+  # * <tt>:jr_jackson</tt> (JRuby only)
+  def use(new_adapter)
+    @adapter = load_adapter(new_adapter)
+  ensure
+    OptionsCache.reset
+  end
+  alias_method :adapter=, :use
+  alias_method :engine=, :use
+
+  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
+      fail ::LoadError, new_adapter
     end
+  rescue ::LoadError => exception
+    raise AdapterError.build(exception)
+  end
 
-    # Encodes a Ruby object as JSON.
-    def dump(object, options={})
-      adapter = current_adapter(options)
-      adapter.dump(object, options)
+  # Decode a JSON string into Ruby.
+  #
+  # <b>Options</b>
+  #
+  # <tt>:symbolize_keys</tt> :: If true, will use symbols instead of strings for the keys.
+  # <tt>:adapter</tt> :: If set, the selected adapter will be used for this call.
+  def load(string, options = {})
+    adapter = current_adapter(options)
+    begin
+      adapter.load(string, options)
+    rescue adapter::ParseError => exception
+      raise ParseError.build(exception, string)
     end
-    # :nodoc:
-    alias :encode :dump
-
-    def with_adapter(new_adapter)
-      old_adapter, self.adapter = adapter, new_adapter
-      yield
-    ensure
-      self.adapter = old_adapter
+  end
+  alias_method :decode, :load
+
+  def current_adapter(options = {})
+    if (new_adapter = options[:adapter])
+      load_adapter(new_adapter)
+    else
+      adapter
     end
-    alias :with_engine :with_adapter
+  end
 
+  # Encodes a Ruby object as JSON.
+  def dump(object, options = {})
+    current_adapter(options).dump(object, options)
   end
+  alias_method :encode, :dump
 
+  #  Executes passed block using specified adapter.
+  def with_adapter(new_adapter)
+    old_adapter = adapter
+    self.adapter = new_adapter
+    yield
+  ensure
+    self.adapter = old_adapter
+  end
+  alias_method :with_engine, :with_adapter
+
+private
+
+  def load_adapter_from_string_name(name)
+    name = ALIASES.fetch(name, name)
+    require "multi_json/adapters/#{name.downcase}"
+    klass_name = name.to_s.split('_').map(&:capitalize) * ''
+    MultiJson::Adapters.const_get(klass_name)
+  end
 end

metadata

@@ -1,105 +1,67 @@
 --- !ruby/object:Gem::Specification
 name: multi_json
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 1.5.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Michael Bleigh
 - Josh Kalderimis
 - Erik Michaels-Ober
+- Pavel Pravosud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0.9'
-    none: false
   name: rake
-  type: :development
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-    none: false
-- !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.9'
-    none: false
-  name: rdoc
+        version: '10.5'
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.9'
-    none: false
-- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
-    none: false
+        version: '10.5'
+- !ruby/object:Gem::Dependency
   name: rspec
-  type: :development
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '2.6'
-    none: false
-- !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-    none: false
-  name: simplecov
+        version: '3.9'
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-    none: false
-description: A gem to provide easy switching between different JSON backends, including
-  Oj, Yajl, the JSON gem (with C-extensions), the pure-Ruby JSON gem, and OkJson.
+        version: '3.9'
+description: A common interface to multiple JSON libraries, including Oj, Yajl, the
+  JSON gem (with C-extensions), the pure-Ruby JSON gem, NSJSONSerialization, gson.rb,
+  JrJackson, and OkJson.
 email:
 - michael@intridea.com
 - josh.kalderimis@gmail.com
 - sferik@gmail.com
+- pavel@pravosud.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.md
-- README.md
+extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CONTRIBUTING.md
 - LICENSE.md
 - README.md
-- Rakefile
-- multi_json.gemspec
-- Gemfile
-- .document
-- .rspec
-- .travis.yml
-- spec/adapter_shared_example.rb
-- spec/helper.rb
-- spec/multi_json_spec.rb
+- lib/multi_json.rb
+- lib/multi_json/adapter.rb
+- lib/multi_json/adapter_error.rb
+- lib/multi_json/adapters/gson.rb
+- lib/multi_json/adapters/jr_jackson.rb
 - lib/multi_json/adapters/json_common.rb
 - lib/multi_json/adapters/json_gem.rb
 - lib/multi_json/adapters/json_pure.rb
@@ -107,37 +69,38 @@ files:
 - lib/multi_json/adapters/oj.rb
 - lib/multi_json/adapters/ok_json.rb
 - lib/multi_json/adapters/yajl.rb
+- lib/multi_json/convertible_hash_keys.rb
+- lib/multi_json/options.rb
+- lib/multi_json/options_cache.rb
+- lib/multi_json/parse_error.rb
 - lib/multi_json/vendor/okjson.rb
 - lib/multi_json/version.rb
-- lib/multi_json.rb
-homepage: http://github.com/intridea/multi_json
+homepage: https://github.com/intridea/multi_json
 licenses:
 - MIT
+metadata:
+  bug_tracker_uri: https://github.com/intridea/multi_json/issues
+  changelog_uri: https://github.com/intridea/multi_json/blob/v1.15.0/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/multi_json/1.15.0
+  source_code_uri: https://github.com/intridea/multi_json/tree/v1.15.0
+  wiki_uri: https://github.com/intridea/multi_json/wiki
 post_install_message: 
-rdoc_options:
-- --charset=UTF-8
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
-  none: false
+      version: 1.3.5
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
-summary: A gem to provide swappable JSON backends.
-test_files:
-- spec/adapter_shared_example.rb
-- spec/helper.rb
-- spec/multi_json_spec.rb
-has_rdoc: 
+specification_version: 4
+summary: A common interface to multiple JSON libraries.
+test_files: []

data/.document

@@ -1,5 +0,0 @@
-LICENSE.md
-README.md
-bin/*
-features/**/*.feature
-lib/**/*.rb

data/.rspec

@@ -1,3 +0,0 @@
---color
---fail-fast
---order random

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-rvm:
-  - rbx-18mode
-  - rbx-19mode
-  - jruby-18mode
-  - jruby-19mode
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - ruby-head

data/Gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'json',      '~> 1.4', :require => nil
-gem 'oj',        '~> 1.0', :require => nil, :platforms => [:ruby, :mswin, :mingw]
-gem 'yajl-ruby', '~> 1.0', :require => nil, :platforms => [:ruby, :mswin, :mingw]
-
-gemspec

data/Rakefile

@@ -1,20 +0,0 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-desc "Run all examples"
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-task :test => :spec
-
-namespace :doc do
-  require 'rdoc/task'
-  require File.expand_path('../lib/multi_json/version', __FILE__)
-  RDoc::Task.new do |rdoc|
-    rdoc.rdoc_dir = 'rdoc'
-    rdoc.title = "multi_json #{MultiJson::VERSION}"
-    rdoc.main = 'README.md'
-    rdoc.rdoc_files.include('README.md', 'LICENSE.md', 'lib/**/*.rb')
-  end
-end

data/multi_json.gemspec

@@ -1,23 +0,0 @@
-# encoding: utf-8
-require File.expand_path("../lib/multi_json/version", __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.add_development_dependency 'rake', '>= 0.9'
-  gem.add_development_dependency 'rdoc', '>= 3.9'
-  gem.add_development_dependency 'rspec', '>= 2.6'
-  gem.add_development_dependency 'simplecov', '>= 0.4'
-  gem.authors = ["Michael Bleigh", "Josh Kalderimis", "Erik Michaels-Ober"]
-  gem.description = %q{A gem to provide easy switching between different JSON backends, including Oj, Yajl, the JSON gem (with C-extensions), the pure-Ruby JSON gem, and OkJson.}
-  gem.email = ['michael@intridea.com', 'josh.kalderimis@gmail.com', 'sferik@gmail.com']
-  gem.extra_rdoc_files = ['LICENSE.md', 'README.md']
-  gem.files = Dir['LICENSE.md', 'README.md', 'Rakefile', 'multi_json.gemspec', 'Gemfile', '.document', '.rspec', '.travis.yml' ,'spec/**/*', 'lib/**/*']
-  gem.homepage = 'http://github.com/intridea/multi_json'
-  gem.licenses = ['MIT']
-  gem.name = 'multi_json'
-  gem.rdoc_options = ["--charset=UTF-8"]
-  gem.require_paths = ['lib']
-  gem.required_rubygems_version = Gem::Requirement.new(">= 1.3.6")
-  gem.summary = %q{A gem to provide swappable JSON backends.}
-  gem.test_files = Dir['spec/**/*']
-  gem.version = MultiJson::VERSION
-end

data/spec/adapter_shared_example.rb

@@ -1,127 +0,0 @@
-shared_examples_for "an adapter" do |adapter|
-
-  before do
-    begin
-      MultiJson.use adapter
-    rescue LoadError
-      pending "Adapter #{adapter} couldn't be loaded (not installed?)"
-    end
-  end
-
-  describe '.dump' do
-    it 'writes decodable JSON' do
-      [
-        {'abc' => 'def'},
-        [1, 2, 3, "4"],
-      ].each do |example|
-        expect(MultiJson.load(MultiJson.dump(example))).to eq example
-      end
-    end
-
-    it 'dumps symbol and fixnum keys as strings' do
-      [
-        [
-          {:foo => {:bar => 'baz'}},
-          {'foo' => {'bar' => 'baz'}},
-        ],
-        [
-          [{:foo => {:bar => 'baz'}}],
-          [{'foo' => {'bar' => 'baz'}}],
-        ],
-        [
-          {:foo => [{:bar => 'baz'}]},
-          {'foo' => [{'bar' => 'baz'}]},
-        ],
-        [
-          {1 => {2 => {3 => 'bar'}}},
-          {'1' => {'2' => {'3' => 'bar'}}}
-        ]
-      ].each do |example, expected|
-        dumped_json = MultiJson.dump(example)
-        expect(MultiJson.load(dumped_json)).to eq expected
-      end
-    end
-
-    it 'dumps rootless JSON' do
-      expect(MultiJson.dump("random rootless string")).to eq "\"random rootless string\""
-      expect(MultiJson.dump(123)).to eq "123"
-    end
-
-    it 'passes options to the adapter' do
-      MultiJson.adapter.should_receive(:dump).with('foo', {:bar => :baz})
-      MultiJson.dump('foo', :bar => :baz)
-    end
-
-    if adapter == 'json_gem' || adapter == 'json_pure'
-      describe 'with :pretty option set to true' do
-        it 'passes default pretty options' do
-          object = 'foo'
-          object.should_receive(:to_json).with(JSON::PRETTY_STATE_PROTOTYPE.to_h)
-          MultiJson.dump(object,:pretty => true)
-        end
-      end
-    end
-
-    it 'dumps custom objects which implement as_json' do
-      expect(MultiJson.dump(TimeWithZone.new)).to eq "\"2005-02-01T15:15:10Z\""
-    end
-
-    it 'allow to dump JSON values' do
-      expect(MultiJson.dump(42)).to eq '42'
-    end
-
-  end
-
-  describe '.load' do
-    it 'properly loads valid JSON' do
-      expect(MultiJson.load('{"abc":"def"}')).to eq({'abc' => 'def'})
-    end
-
-    it 'raises MultiJson::DecodeError on invalid JSON' do
-      expect{MultiJson.load('{"abc"}')}.to raise_error(MultiJson::DecodeError)
-    end
-
-    it 'raises MultiJson::DecodeError with data on invalid JSON' do
-      data = '{invalid}'
-      begin
-        MultiJson.load(data)
-      rescue MultiJson::DecodeError => de
-        expect(de.data).to eq data
-      end
-    end
-
-    it 'stringifys symbol keys when encoding' do
-      dumped_json = MultiJson.dump(:a => 1, :b => {:c => 2})
-      expect(MultiJson.load(dumped_json)).to eq({"a" => 1, "b" => {"c" => 2}})
-    end
-
-    it 'properly loads valid JSON in StringIOs' do
-      json = StringIO.new('{"abc":"def"}')
-      expect(MultiJson.load(json)).to eq({'abc' => 'def'})
-    end
-
-    it 'allows for symbolization of keys' do
-      [
-        [
-          '{"abc":{"def":"hgi"}}',
-          {:abc => {:def => 'hgi'}},
-        ],
-        [
-          '[{"abc":{"def":"hgi"}}]',
-          [{:abc => {:def => 'hgi'}}],
-        ],
-        [
-          '{"abc":[{"def":"hgi"}]}',
-          {:abc => [{:def => 'hgi'}]},
-        ],
-      ].each do |example, expected|
-        expect(MultiJson.load(example, :symbolize_keys => true)).to eq expected
-      end
-    end
-
-    it 'allow to load JSON values' do
-      expect(MultiJson.load('42')).to eq 42
-    end
-
-  end
-end