jsonify 0.1.2 → 0.1.3

data/.travis.yml

@@ -1,3 +1,8 @@
 rvm:
+  - 1.9.3
   - 1.9.2
   - 1.8.7
+  - ree
+  - rbx-2.0
+  - jruby
+

data/README.md

@@ -1,8 +1,8 @@
-# Jsonify — a builder for JSON [![Build Status](http://travis-ci.org/bsiggelkow/jsonify.png)](http://travis-ci.org/bsiggelkow/jsonify)
+# Jsonify — a builder for JSON [![Build Status](https://secure.travis-ci.org/bsiggelkow/jsonify.png)](http://travis-ci.org/bsiggelkow/jsonify)
 
 [Jsonify](https://github.com/bsiggelkow/jsonify) is to JSON as [Builder](https://github.com/jimweirich/builder) is to XML. 
 
-If you want to use Jsonify for Rails templates, install [Jsonify-Rails](https://github.com/bsiggelkow/jsonify-rails).
+To use Jsonify for Rails templates, install [Jsonify-Rails](https://github.com/bsiggelkow/jsonify-rails).
 
 ## Goal
 
@@ -82,9 +82,27 @@ Results in ...
       ]
     }
 
-### View Templates
+#### Convenience methods
+Jsonify provides class-level convenience methods that
+save you the trouble of instantiating the `Jsonify::Builder`. Each of these methods accepts a block, yields a new `Builder` object to the block, and then compiles the result.
 
-Jsonify includes a Rails 3 template handler. Any template with a `.jsonify` will be handled by Rails.
+- `compile`
+  - Compiles the given block; any options are passed the instantiated `Builder`
+- `pretty`
+  - Compiles the given block; results are output in `pretty` format. 
+- `plain`
+  - Compiles the given block; results are output in `plain` (default) format. 
+
+For example ...
+
+    Jsonify::Builder.plain do |j|
+      j.song 'Fearless'
+      j.album 'Meddle'
+    end
+
+### Rails View Templates
+
+Jsonify can be used for Rails 3 view templates via the [jsonify-rails](https://github.com/bsiggelkow/jsonify-rails) which includes a Rails 3 template handler. Any template with a `.jsonify` extension will be handled by Rails.
 
 The Jsonify template handler exposes the `Jsonify::Builder` instance to your template with the `json` variable as in the following example:
 
@@ -93,7 +111,7 @@ The Jsonify template handler exposes the `Jsonify::Builder` instance to your tem
     end
     
 Just like with any other template, your Jsonify template will have access to
-any instance variables that are exposed through the controller.
+any instance variables that are exposed through the controller. See [Jsonify-Rails](https://github.com/bsiggelkow/jsonify-rails) for additional details.
 
 #### Partials
 
@@ -151,6 +169,28 @@ You can then incorporate this partial into your Jsonify template just as you wou
   
     [1,{"date":"2011-07-30"}]
 
+### Tilt Integration
+
+Jsonify includes support for [Tilt](http://github.com/rtomayko/tilt). This allow you to create views that use Jsonify with any framework that supports Tilt. Here's an example of a simple [Sinatra](http://sinatrarb.com) application that leverages Jsonify's Tilt integration.
+
+    require 'bundler/setup'
+    require 'sinatra'
+
+    require 'jsonify'
+    require 'jsonify/tilt'
+
+    helpers do
+      def jsonify(*args) render(:jsonify, *args) end
+    end
+
+    get '/' do
+      jsonify :index
+    end
+
+And the corresponding template in `views\index.jsonify`
+
+    json.hello :frank
+
 ### Usage Patterns
 
 Jsonify is designed to support construction of an valid JSON representation and
@@ -363,10 +403,6 @@ In this case, Jsonify decides from the first line that you are creating a JSON o
 - [Representative](https://github.com/mdub/representative)
 - [Tokamak](https://github.com/abril/tokamak)
 
-## TODOs
-1. Benchmark performance
-1. Tilt Integration (jsonify-tilt)
-
 ## License
 
 This project is released under the MIT license.

data/jsonify.gemspec

@@ -22,11 +22,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'json' unless RUBY_VERSION =~ /^1.9/
 
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'tilt'
+  s.add_development_dependency 'tilt', '~>1.3.2'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'autotest'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'rdiscount'
-  s.add_development_dependency 'ruby-prof'
 end

data/lib/jsonify/builder.rb

@@ -3,16 +3,25 @@ module Jsonify
     
     class << self
 
+      # Compiles the given block into a JSON string without having to instantiate a Builder.
+      #
+      # @option options [boolean] :verify Builder will verify that the compiled JSON string is parseable;  this option does incur a performance penalty and generally should only be used in development
+      # @option options [symbol] :format Format for the resultant JSON string; 
+      #                          `:pretty`, the JSON string will be output in a prettier format with new lines and indentation; this option does incur a performance penalty and generally should only be used in development
+      #                          `:plain`,  no formatting (compact one-line JSON -- best for production)
+      # 
       def compile( options={} )
         builder = self.new options
         yield builder
         builder.compile!
       end
 
+      # Compiles the given block into a pretty JSON string without having to instantiate a Builder.
       def pretty(&block)
         compile( :format => :pretty, &block )
       end
 
+      # Compiles the given block into a plain (e.g. no newlines and whitespace) JSON string without having to instantiate a Builder.
       def plain(&block)
         compile( :format => :plain, &block )
       end
@@ -43,7 +52,7 @@ module Jsonify
     # @param sym [String] the key for the pair
     # @param *args [arguments] If a block is passed, the first argument will be iterated over and the subsequent result will be added to a JSON array; otherwise, the arguments set value for the `JsonPair`
     # @param &block a code block the result of which will be used to populate the value for the JSON pair
-    def tag!(sym, *args, &block)
+    def tag!(sym, args=nil, &block)
       method_missing(sym, *args, &block)
     end
     
@@ -73,14 +82,16 @@ module Jsonify
     
     # Append -- pushes the given object on the end of a JsonArray.
     def <<(val)
-      __append(val)
+      __array
+      @stack[@level].add val
       self
     end
 
     # Append -- pushes the given variable list objects on to the end of the JsonArray 
     def append!(*args)
+      __array
       args.each do |arg| 
-        __append( arg )
+        @stack[@level].add arg
       end
       self
     end
@@ -125,10 +136,10 @@ module Jsonify
     #     ]
     #
     # @param *args [Array] iterates over the given array yielding each array item to the block; the result of which is added to a JsonArray
-    def method_missing(sym, *args, &block)
+    def method_missing(sym, args=nil, &block)
       
       # When no block given, simply add the symbol and arg as key - value for a JsonPair to current
-      return __store( sym, args.length > 1 ? args : args.first ) unless block
+      return __store( sym, args ) unless block
 
       # In a block; create a JSON pair (with no value) and add it to the current object
       pair = Generate.pair_value(sym)
@@ -137,11 +148,12 @@ module Jsonify
       # Now process the block
       @level += 1
 
-      if args.empty?
+      if args.nil?
         block.call
       else
-        args.first.each do |arg|
-          __append block.call(arg)
+        __array
+        args.each do |arg|
+          @stack[@level].add block.call(arg)
         end
       end
 
@@ -179,14 +191,14 @@ module Jsonify
     private
     
     # BlankSlate requires the __<method> names
-
+    
     def __store(key,value=nil)
       pair = (JsonPair === key ? key : JsonPair.new(key, value))
       (@stack[@level] ||= JsonObject.new).add(pair)
     end  
 
-    def __append(value)
-      (@stack[@level] ||= JsonArray.new).add value
+    def __array
+      @stack[@level] ||= JsonArray.new
     end
 
   end

data/lib/jsonify/version.rb

@@ -1,3 +1,3 @@
 module Jsonify
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/builder_spec.rb

@@ -142,7 +142,7 @@ PRETTY_JSON
     it 'should handle arrays' do
       json[1] = [2, 3]
       json[4] = 5
-      json.compile!.should ==  '{"1":[2,3],"4":5}'
+      JSON.parse(json.compile!).should ==  JSON.parse('{"1":[2,3],"4":5}')
     end
   end
   
@@ -189,6 +189,15 @@ PRETTY_JSON
       end 
       json.compile!.should ==  '{"foo":[2,4,6]}'
     end
+
+    it 'hash with empty array by iteration' do
+      ary = []
+      json.foo(ary) do |n|
+        n * 2
+      end
+      expected = '{"foo":[]}'
+      JSON.parse(json.compile!).should ==  JSON.parse(expected)
+    end
     
     it 'simple array with object' do
       json << 1
@@ -223,7 +232,8 @@ PRETTY_JSON
     describe 'complex array' do
       it 'should work' do
         json.bar [1,2,{:foo => 'goo'}]
-        json.compile!.should == "{\"bar\":[1,2,{\"foo\":\"goo\"}]}"
+        expected = "{\"bar\":[1,2,{\"foo\":\"goo\"}]}"
+        JSON.parse(json.compile!).should == JSON.parse(expected)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonify
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-09 00:00:00.000000000Z
+date: 2011-09-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70122619875620 !ruby/object:Gem::Requirement
+  requirement: &70241180309060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122619875620
+  version_requirements: *70241180309060
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70122619874940 !ruby/object:Gem::Requirement
+  requirement: &70241180306880 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *70122619874940
+  version_requirements: *70241180306880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70122619874400 !ruby/object:Gem::Requirement
+  requirement: &70241180306020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,21 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122619874400
+  version_requirements: *70241180306020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70122619873760 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70122619873760
-- !ruby/object:Gem::Dependency
-  name: autotest
-  requirement: &70122619872980 !ruby/object:Gem::Requirement
+  requirement: &70241180303540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122619872980
+  version_requirements: *70241180303540
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70122619872260 !ruby/object:Gem::Requirement
+  requirement: &70241180302600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,21 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122619872260
+  version_requirements: *70241180302600
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70122619871560 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70122619871560
-- !ruby/object:Gem::Dependency
-  name: ruby-prof
-  requirement: &70122619871100 !ruby/object:Gem::Requirement
+  requirement: &70241180301860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122619871100
+  version_requirements: *70241180301860
 description: Turn Ruby objects into JSON -- correctly!
 email:
 - bsiggelkow@me.com
@@ -144,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3850211948781890722
+      hash: 415595821988882792
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -153,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3850211948781890722
+      hash: 415595821988882792
 requirements: []
 rubyforge_project: jsonify
 rubygems_version: 1.8.6