Skip to content

bigjason/elster

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Elster

Build Status

Elster is a streaming JSON encoder written in pure ruby. There were 2 main requirements when I set out to write Elster:

  1. The JSON data must be streamed with no caching whatsoever.
  2. No DSL in the core API.

Streaming Status with Rails: I am working on figuring out how to use streaming with Rails. Currently the Rails Streaming API doesn't allow this, but I hope to get together something to make it work.

Installation

Add this line to your application's Gemfile:

gem 'elster'

And then execute:

$ bundle

Or install it yourself as:

$ gem install elster

Usage

output = StringIO.new
json = Elster::Streamer.new(output)
json.key(:name, "George")
json.key(:kids) do
  json.add("Job")
  json.add("Buster")
end
json.close

puts output.string
# {"name":"George","kids":["Job","Buster"]}

With Rails

You can use Elster with rails by naming templates with the .json.elster extension. When used as a rails template simply reference the implicit json object. For example:

json.key(:name, "George")
json.key(:kids) do
  json.add("Job")
  json.add("Buster")
end

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

About

A simple streaming JSON encoder.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages