Path: | README.md |
Last Update: | Sat Sep 22 15:21:35 +0000 2012 |
# MultiJSON [][travis] [][gemnasium]
[travis]: travis-ci.org/intridea/multi_json [gemnasium]: gemnasium.com/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' 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)
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` 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 Oj, then Yajl, then the JSON gem, then JSON pure. If no other JSON library is available, MultiJSON falls back to [OkJson][], a simple, vendorable JSON parser.
[okjson]: github.com/kr/okjson
## Supported JSON Engines
## Contributing In the spirit of [free software][free-sw], *everyone* is encouraged to help improve this project.
[free-sw]: www.fsf.org/licensing/essays/free-sw.html
Here are some ways you can contribute:
[issues]: 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]: gist.github.com/
## Submitting a Pull Request
[fork]: help.github.com/fork-a-repo/ [branch]: learn.github.com/p/branching.html [pr]: help.github.com/send-pull-requests/
## Supported Ruby Versions This library aims to support and is [tested against][travis] the following Ruby implementations:
[jruby]: www.jruby.org/ [rubinius]: rubini.us/ [macruby]: www.macruby.org/
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.
## Copyright Copyright (c) 2010 Michael Bleigh, Josh Kalderimis, Erik Michaels-Ober, and Intridea, Inc. See [LICENSE][] for details.
[license]: github.com/intridea/multi_json/blob/master/LICENSE.md