Path: | README.md |
Last Update: | Sat Mar 03 17:13:05 +0000 2012 |
# MultiJSON Lots of Ruby libraries utilize JSON parsing in some form, and everyone has their favorite JSON library. In order to best support multiple JSON parsers and libraries, multi_json is a general-purpose swappable JSON backend library. You use it like so:
require 'multi_json' MultiJson.engine = :yajl MultiJson.decode('{ "abc":"def" }') # decoded using Yajl MultiJson.engine = :json_gem MultiJson.engine = MultiJson::Engines::JsonGem # equivalent to previous line MultiJson.encode({ :abc => 'def' }) # encoded using the JSON gem MultiJson.encode({ :abc => 'def' }, :pretty => true) # encoded in a pretty form (ignored if engine is ok_json)
The engine setter takes either a symbol or a class (to allow for custom JSON parsers) that responds to both .decode and .encode at the class level.
MultiJSON tries to have intelligent defaulting. That is, if you have any of the supported engines already loaded, it will utilize them before attempting to load any. When loading, libraries are ordered by speed. First Yajl-Ruby, then the JSON gem, then JSON pure. If no JSON library is available, MultiJSON falls back to a bundled version of [OkJson](github.com/kr/okjson).
## <a name="ci">Continuous Integration</a> [](http://travis-ci.org/intridea/multi_json)
## <a name="contributing">Contributing</a> In the spirit of [free software](www.fsf.org/licensing/essays/free-sw.html), *everyone* is encouraged to help improve this project.
Here are some ways you can contribute:
## <a name="issues">Submitting an Issue</a> We use the [GitHub issue tracker](github.com/intridea/multi_json/issues) to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn‘t already been submitted. You can indicate support for an existing issuse by voting it up. When submitting a bug report, please include a [Gist](gist.github.com/) 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.
## <a name="pulls">Submitting a Pull Request</a>
## <a name="rubies">Supported Rubies</a> This library aims to support and is [tested against](travis-ci.org/intridea/multi_json) the following Ruby implementations:
If something doesn‘t work on one of these interpreters, it should be considered 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 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.
## <a name="copyright">Copyright</a> Copyright (c) 2010 Michael Bleigh, Josh Kalderimis, Erik Michaels-Ober, and Intridea, Inc. See [LICENSE](github.com/intridea/multi_json/blob/master/LICENSE.md) for details.