multi_json 1.5.1 → 1.6.0

data/.travis.yml

@@ -1,3 +1,4 @@
+bundler_args: --without development
 language: ruby
 rvm:
   - rbx-18mode
@@ -7,4 +8,4 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ruby-head
+  - 2.0.0

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+-
+CHANGELOG.md
+CONTRIBUTING.md
+LICENSE.md
+README.md

data/CHANGELOG.md

@@ -0,0 +1,116 @@
+1.6.0
+-----
+* [Add gson.rb support](https://github.com/intridea/multi_json/pull/71)
+* [Add MultiJson.default_options](https://github.com/intridea/multi_json/pull/70)
+* [Add MultiJson.with_adapter](https://github.com/intridea/multi_json/pull/67)
+* [Stringify all possible keys for ok_json](https://github.com/intridea/multi_json/pull/66)
+* [Alias `MultiJson::DecodeError` to `MultiJson::LoadError`](https://github.com/intridea/multi_json/pull/79)
+
+1.5.1
+-----
+* [Do not allow Oj or JSON to create symbols by searching for classes](https://github.com/intridea/multi_json/commit/193e28cf4dc61b6e7b7b7d80f06f74c76df65c41)
+
+1.5.0
+-----
+* [Add `MultiJson.with_adapter` method](https://github.com/intridea/multi_json/commit/d14c5d28cae96557a0421298621b9499e1f28104)
+* [Stringify all possible keys for `ok_json`](https://github.com/intridea/multi_json/commit/73998074058e1e58c557ffa7b9541d486d6041fa)
+
+1.4.0
+-----
+* [Allow `load`/`dump` of JSON fragments](https://github.com/intridea/multi_json/commit/707aae7d48d39c85b38febbd2c210ba87f6e4a36)
+
+1.3.7
+-----
+* [Fix rescue clause for MagLev](https://github.com/intridea/multi_json/commit/39abdf50199828c50e85b2ce8f8ba31fcbbc9332)
+* [Remove unnecessary check for string version of options key](https://github.com/intridea/multi_json/commit/660101b70e962b3c007d0b90d45944fa47d13ec4)
+* [Explicitly set default adapter when adapter is set to `nil` or `false`](https://github.com/intridea/multi_json/commit/a9e587d5a63eafb4baee9fb211265e4dd96a26bc)
+* [Fix Oj `ParseError` mapping for Oj 1.4.0](https://github.com/intridea/multi_json/commit/7d9045338cc9029401c16f3c409d54ce97f275e2)
+
+1.3.6
+-----
+* [Allow adapter-specific options to be passed through to Oj](https://github.com/intridea/multi_json/commit/d0e5feeebcba0bc69400dd203a295f5c30971223)
+
+1.3.5
+-----
+* [Add pretty support to Oj adapter](https://github.com/intridea/multi_json/commit/0c8f75f03020c53bcf4c6be258faf433d24b2c2b)
+
+1.3.4
+-----
+* [Use `class << self` instead of `module_function` to create aliases](https://github.com/intridea/multi_json/commit/ba1451c4c48baa297e049889be241a424cb05980)
+
+1.3.3
+-----
+* [Remove deprecation warnings](https://github.com/intridea/multi_json/commit/36b524e71544eb0186826a891bcc03b2820a008f)
+
+1.3.2
+-----
+* [Add ability to use adapter per call](https://github.com/intridea/multi_json/commit/106bbec469d5d0a832bfa31fffcb8c0f0cdc9bd3)
+* [Add and deprecate `default_engine` method](https://github.com/intridea/multi_json/commit/fc3df0c7a3e2ab9ce0c2c7e7617a4da97dd13f6e)
+
+1.3.1
+-----
+* [Only warn once for each instance a deprecated method is called](https://github.com/intridea/multi_json/commit/e21d6eb7da74b3f283995c1d27d5880e75f0ae84)
+
+1.3.0
+-----
+* [Implement `load`/`dump`; deprecate `decode`/`encode`](https://github.com/intridea/multi_json/commit/e90fd6cb1b0293eb0c73c2f4eb0f7a1764370216)
+* [Rename engines to adapters](https://github.com/intridea/multi_json/commit/ae7fd144a7949a9c221dcaa446196ec23db908df)
+
+1.2.0
+-----
+* [Add support for Oj](https://github.com/intridea/multi_json/commit/acd06b233edabe6c44f226873db7b49dab560c60)
+
+1.1.0
+-----
+* [`NSJSONSerialization` support for MacRuby](https://github.com/intridea/multi_json/commit/f862e2fc966cac8867fe7da3997fc76e8a6cf5d4)
+
+1.0.4
+-----
+* [Set data context to `DecodeError` exception](https://github.com/intridea/multi_json/commit/19ddafd44029c6681f66fae2a0f6eabfd0f85176)
+* [Allow `ok_json` to fallback to `to_json`](https://github.com/intridea/multi_json/commit/c157240b1193b283d06d1bd4d4b5b06bcf3761f8)
+* [Add warning when using `ok_json`](https://github.com/intridea/multi_json/commit/dd4b68810c84f826fb98f9713bfb29ab96888d57)
+* [Options can be passed to an engine on encode](https://github.com/intridea/multi_json/commit/e0a7ff5d5ff621ffccc61617ed8aeec5816e81f7)
+
+1.0.3
+-----
+* [`Array` support for `stringify_keys`](https://github.com/intridea/multi_json/commit/644d1c5c7c7f6a27663b11668527b346094e38b9)
+* [`Array` support for `symbolize_keys`](https://github.com/intridea/multi_json/commit/c885377d47a2aa39cb0d971fea78db2d2fa479a7)
+
+1.0.2
+-----
+* [Allow encoding of rootless JSON when `ok_json` is used](https://github.com/intridea/multi_json/commit/d1cde7de97cb0f6152aef8daf14037521cdce8c6)
+
+1.0.1
+-----
+* [Correct an issue with `ok_json` not being returned as the default engine](https://github.com/intridea/multi_json/commit/d33c141619c54cccd770199694da8fd1bd8f449d)
+
+1.0.0
+-----
+* [Remove `ActiveSupport::JSON` support](https://github.com/intridea/multi_json/commit/c2f4140141d785a24b3f56e58811b0e561b37f6a)
+* [Fix `@engine` ivar warning](https://github.com/intridea/multi_json/commit/3b978a8995721a8dffedc3b75a7f49e5494ec553)
+* [Only `rescue` from parsing errors during decoding, not any `StandardError`](https://github.com/intridea/multi_json/commit/391d00b5e85294d42d41347605d8d46b4a7f66cc)
+* [Rename `okjson` engine and vendored lib to `ok_json`](https://github.com/intridea/multi_json/commit/5bd1afc977a8208ddb0443e1d57cb79665c019f1)
+* [Add `StringIO` support to `json` gem and `ok_json`](https://github.com/intridea/multi_json/commit/1706b11568db7f50af451fce5f4d679aeb3bbe8f)
+
+0.0.5
+-----
+* [Trap all JSON decoding errors; raise `MultiJson::DecodeError`](https://github.com/intridea/multi_json/commit/dea9a1aef6dd1212aa1e5a37ab1669f9b045b732)
+
+0.0.4
+-----
+* [Fix default_engine check for `json` gem](https://github.com/intridea/multi_json/commit/caced0c4e8c795922a109ebc00c3c4fa8635bed8)
+* [Make requirement mapper an `Array` to preserve order in Ruby versions < 1.9](https://github.com/intridea/multi_json/commit/526f5f29a42131574a088ad9bbb43d7f48439b2c)
+
+0.0.3
+-----
+* [Improved defaulting and documentation](https://github.com/sferik/twitter/commit/3a0e41b9e4b0909201045fa47704b78c9d949b73)
+
+0.0.2
+-----
+
+* [Rename to `multi_json`](https://github.com/sferik/twitter/commit/461ab89ce071c8c9fabfc183581e0ec523788b62)
+
+0.0.1
+-----
+
+* [Initial commit](https://github.com/sferik/twitter/commit/518c21ab299c500527491e6c049ab2229e22a805)

data/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace)
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/intridea/multi_json/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
+7. Run `open coverage/index.html`. If your changes are not completely covered
+   by your tests, return to step 3.
+8. Add, commit, and push your changes.
+9. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -1,7 +1,31 @@
-source 'https://rubygems.org'
+source :rubygems
 
-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]
+gem 'rake', '>= 0.9'
+gem 'yard', '>= 0.8'
+
+platforms :ruby_18 do
+  gem 'json', '~> 1.4', :require => nil
+end
+
+gem 'json_pure', '~> 1.4', :require => nil
+
+platforms :ruby, :mswin, :mingw do
+  gem 'oj', '~> 2.0', :require => nil
+  gem 'yajl-ruby', '~> 1.0', :require => nil
+end
+platforms :jruby do
+  gem 'gson', '>= 0.6', :require => nil
+end
+
+group :development do
+  gem 'kramdown', '>= 0.14'
+  gem 'pry'
+  gem 'pry-debugger', :platforms => :mri_19
+end
+
+group :test do
+  gem 'rspec', '>= 2.11'
+  gem 'simplecov', :require => false
+end
 
 gemspec

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Michael Bleigh, Josh Kalderimis, Erik Michaels-Ober, and Intridea, Inc.
+Copyright (c) 2010-2013 Michael Bleigh, Josh Kalderimis, Erik Michaels-Ober, Pavel Pravosud
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,19 +1,33 @@
-# MultiJSON [![Build Status](https://secure.travis-ci.org/intridea/multi_json.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/intridea/multi_json.png?travis)][gemnasium]
+# MultiJSON
+[![Gem Version](https://badge.fury.io/rb/multi_json.png)][gem]
+[![Build Status](https://secure.travis-ci.org/intridea/multi_json.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/intridea/multi_json.png?travis)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/intridea/multi_json.png)][codeclimate]
 
+[gem]: https://rubygems.org/gems/multi_json
 [travis]: http://travis-ci.org/intridea/multi_json
 [gemnasium]: https://gemnasium.com/intridea/multi_json
+[codeclimate]: https://codeclimate.com/github/intridea/multi_json
 
 Lots of Ruby libraries parse JSON and everyone has their favorite JSON coder.
 Instead of choosing a single JSON coder and forcing users of your library to be
 stuck with it, you can use MultiJSON instead, which will simply choose the
 fastest available JSON coder. Here's how to use it:
 
-    require 'multi_json'
+```ruby
+require 'multi_json'
 
-    MultiJson.load('{"abc":"def"}') #=> {"abc" => "def"}
-    MultiJson.load('{"abc":"def"}', :symbolize_keys => true) #=> {:abc => "def"}
-    MultiJson.dump({:abc => 'def'}) # convert Ruby back to JSON
-    MultiJson.dump({:abc => 'def'}, :pretty => true) # encoded in a pretty form (if supported by the coder)
+MultiJson.load('{"abc":"def"}') #=> {"abc" => "def"}
+MultiJson.load('{"abc":"def"}', :symbolize_keys => true) #=> {:abc => "def"}
+MultiJson.dump({:abc => 'def'}) # convert Ruby back to JSON
+MultiJson.dump({:abc => 'def'}, :pretty => true) # encoded in a pretty form (if supported by the coder)
+```
+
+When loading invalid JSON, multiJSON will throw a `MultiJson::LoadError`. `MultiJson::DecodeError` is an alias for backwards compatibility.
+
+```ruby
+MultiJson.load('invalid json') #=> MultiJson::LoadError
+```
 
 The `use` method, which sets the MultiJson adapter, takes either a symbol or a
 class (to allow for custom JSON parsers) that responds to both `.load` and `.dump`
@@ -43,6 +57,7 @@ implementations:
 * Ruby 1.8.7
 * Ruby 1.9.2
 * Ruby 1.9.3
+* Ruby 2.0.0
 * [JRuby][]
 * [Rubinius][]
 * [MacRuby][] (not tested on Travis CI)
@@ -51,8 +66,7 @@ implementations:
 [rubinius]: http://rubini.us/
 [macruby]: http://www.macruby.org/
 
-If something doesn't work on one of these interpreters, it should be considered
-a bug.
+If something doesn't work on one of these interpreters, it's a bug.
 
 This library may inadvertently work (or seem to work) on other Ruby
 implementations, however support will only be provided for the versions listed
@@ -61,9 +75,9 @@ above.
 If you would like this library to support another Ruby version, you may
 volunteer to be a maintainer. Being a maintainer entails making sure all tests
 run and pass on that implementation. When something breaks on your
-implementation, you will be personally responsible for providing patches in a
-timely fashion. If critical issues for a particular implementation exist at the
-time of a major release, support for that Ruby version may be dropped.
+implementation, you will be responsible for providing patches in a timely
+fashion. If critical issues for a particular implementation exist at the time
+of a major release, support for that Ruby version may be dropped.
 
 ## Versioning
 
@@ -76,13 +90,15 @@ introduced with new major versions. As a result of this policy, you can (and
 should) specify a dependency on this gem using the [Pessimistic Version
 Constraint][pvc] with two digits of precision. For example:
 
-    spec.add_dependency 'multi_json', '~> 1.0'
+```ruby
+spec.add_dependency 'multi_json', '~> 1.0'
+```
 
 [semver]: http://semver.org/
 [pvc]: http://docs.rubygems.org/read/chapter/16#page74
 
 ## Copyright
-Copyright (c) 2010 Michael Bleigh, Josh Kalderimis, Erik Michaels-Ober, and Intridea, Inc.
-See [LICENSE][] for details.
+Copyright (c) 2010-2013 Michael Bleigh, Josh Kalderimis, Erik Michaels-Ober,
+and Pavel Pravosud. See [LICENSE][] for details.
 
-[license]: https://github.com/intridea/multi_json/blob/master/LICENSE.md
+[license]: LICENSE.md

data/Rakefile

@@ -8,13 +8,5 @@ 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
+require 'yard'
+YARD::Rake::YardocTask.new

data/lib/multi_json.rb

@@ -1,130 +1,137 @@
 module MultiJson
-  class DecodeError < StandardError
+  extend self
+
+  class LoadError < StandardError
     attr_reader :data
-    def initialize(message="", backtrace=[], data="")
+    def initialize(message='', backtrace=[], data='')
       super(message)
       self.set_backtrace(backtrace)
       @data = data
     end
   end
+  DecodeError = LoadError # Legacy support
+
 
-  @adapter = nil
+  @default_options = {}
+  attr_accessor :default_options
 
   REQUIREMENT_MAP = [
-    ["oj", :oj],
-    ["yajl", :yajl],
-    ["json", :json_gem],
-    ["json/pure", :json_pure]
+    ['oj',        :oj],
+    ['yajl',      :yajl],
+    ['json',      :json_gem],
+    ['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 :json_gem if defined?(::JSON)
+    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 |(library, adapter)|
       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
+  # :nodoc:
+  alias :default_engine :default_adapter
+
+  # Get the current adapter class.
+  def adapter
+    return @adapter if defined?(@adapter) && @adapter
+
+    self.use nil # load 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)
+  # * <tt>:gson</tt> (JRuby 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
+      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
 
-    # 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 engine will be used just for the call.
+  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
-    # :nodoc:
-    alias :encode :dump
-
-    def with_adapter(new_adapter)
-      old_adapter, self.adapter = adapter, new_adapter
-      yield
-    ensure
-      self.adapter = old_adapter
+  end
+  # :nodoc:
+  alias :decode :load
+
+  def current_adapter(options)
+    if new_adapter = (options || {}).delete(:adapter)
+      load_adapter(new_adapter)
+    else
+      adapter
     end
-    alias :with_engine :with_adapter
+  end
+
+  # Encodes a Ruby object as JSON.
+  def dump(object, options={})
+    options = default_options.merge(options)
+    adapter = current_adapter(options)
+    adapter.dump(object, options)
+  end
+  # :nodoc:
+  alias :encode :dump
 
+  #  Executes passed block using specified adapter.
+  def with_adapter(new_adapter)
+    old_adapter, self.adapter = adapter, new_adapter
+    yield
+  ensure
+    self.adapter = old_adapter
   end
+  # :nodoc:
+  alias :with_engine :with_adapter
 
 end