jsonify 0.0.4 → 0.0.5

data/README.md

@@ -1,12 +1,14 @@
 # Jsonify — a builder for JSON [![Build Status](http://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.
+[Jsonify](https://github.com/bsiggelkow/jsonify) is to JSON as [Builder](https://github.com/jimweirich/builder) is to XML. 
+[Jsonify-Rails](https://github.com/bsiggelkow/jsonify-rails) allows you to 
+create Rails views using Jsonify templates.
 
 ## Goal
 
 Jsonify provides a ___builder___ style engine for creating correct JSON representations of Ruby objects.
 
-Jsonify hooks into Rails ActionView to allow you to create JSON view templates in much the same way that you can use Builder for XML templates.
+[Jsonify-Rails](http://github.com/bsiggelkow/jsonify-rails) hooks into Rails ActionView to allow you to create JSON view templates in much the same way that you can use Builder for XML templates.
 
 ## Motivation
 
@@ -85,70 +87,72 @@ Results in ...
 
 ### View Templates
 
-Jsonify includes Rails 3 template handler. Rails will handle any template with a `.jsonify` extension with Jsonify.
+Jsonify includes a Rails 3 template handler. Any template with a `.jsonify` 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:
 
     json.hello do
       json.world "Jsonify is Working!"
     end
+    
+Just like with any other template, your Jsonify template will have access to
+any instance variables that are exposed through the controller.
 
 #### Partials
 
-You can use partials with Jsonify view templates, but how you use them will 
-depend on how the information they return is structured. An important to keep in
-mind is that a partial, no matter what kind it is, always a returns a string.
+You can use partials from Jsonify views, and you can create Jsonify partials.  How your Jsonify template uses a partial depends on how the information the partial returns is structured. Keep in mind that any paritial, be it a Jsonify template, erb, or anything else, always a returns its result as a string.
 
 ##### Jsonify partials
 
 Any Jsonify partial — that is, the file has a `.jsonify` extension —
-will return, by design, a string that is valid JSON. It will represent either a JSON object,
-and be wrapped in curly braces ({}), or a JSON array, and be wrapped in square brackets ([]).
+will return, by design, a string that is valid JSON. It will represent either a JSON object,wrapped in curly braces ( {} ), or a JSON array, wrapped in square brackets ( [] ).
+
+To incorporate such a value into a Jsonify template, use the `ingest!` method. 
 
-To incorporate such a value into a Jsonify template, Jsonify provides the `ingest!` method. 
+`ingest!` assumes that the value it receives is valid JSON representation. It parses the JSON into a Jsonify object graph, and then adds it to the current Jsonify builder.
 
-You can use this method to add JSON, rendered by a partial, to the builder.
-Let's assume this our main template, `index.jsonify`:
+Let's assume this this is your main template, `index.jsonify`:
 
     json << 1
     json.ingest! (render :partial=>'my_partial')
 
-From the first line, you can tell that an array will be created so this line uses the append operator.
-On the second line, a partial is being added to the builder. Note that you cannot simply place `render :parial ...`
-on a line by itself as you can do with other templates like `erb` and `haml`; you have to explicitly tell Jsonify
-to add it.
+From the first line, you can tell that an array will be created as this line uses the append operator.
+On the second line, a partial is being added to the builder. Note that you cannot simply place `render :parial ...` on a line by itself as you can do with other templates like `erb` and `haml`. You have to explicitly tell Jsonify to add it to the builder.
 
 Let's say that the partial file, `_my_partial.jsonify`, is as follows:
 
     json << 3
     json << 4
 
-This `json` variable is a separate instance of the Jsonify::Builder, distinct from the builder instance,
-in the main template. This partial will end up generating the following string:
+This `json` variable in this partial is a separate distinct `Jsonify::Builder` instance from the `json` variable in the main template.
+
+> Note: Figure out if a the `json` instance can be passed to the Jsonify partial.
+> It would make things easier and we wouldn't have to ingest the result.
+
+This partial results in the following string:
 
     "[3,4]"
 
-The `ingest!` method will actually parse this string back into a Jsonify-based object, and add it
-to the builder's current state. The resulting output will be:
+The `ingest!` method will actually parse this string back into a Jsonify-based object, and adds it to the builder's current state. The resulting output will be:
 
     "[1,[3,4]]"
 
 ##### Other partials
 
-You can also use output from non-Jsonify templates (e.g. erb); just remember that the output from a template
-is always a string and that you have to tell the builder how to include the result of the partial.
-For example, suppose I have the partial `_today.erb` with the following content:
+You can also use output from non-Jsonify templates (e.g. erb); just remember that the output from a template is always a string and that you have to tell the builder how to include the result of the partial.
+
+For example, suppose you have the partial `_today.erb` with the following content:
 
     <%= Date.today %>
 
 You can then incorporate this partial into your Jsonify template just as you would any other string value:
 
     json << 1
-    json.ingest! (render :partial=>'my_partial')
     json << {:date => (render :partial => 'today')}
 
   renders ...
   
-    [1,[3,4],{"date":"2011-07-30"}]
+    [1,{"date":"2011-07-30"}]
 
 ### Usage Patterns
 
@@ -168,10 +172,9 @@ must be one of these structures and Jsonify ensures that this condition is met.
 
 A JSON object, sometimes
 referred to as an ___object literal___, is a common structure familiar
-to most developers. Its analogous to the nested element structured common
+to most developers. It's analogous to the nested element structure common
 in XML. The [JSON RFC](http://www.ietf.org/rfc/rfc4627.txt) states that 
-"the names within an object SHOULD be unique". Jsonify elevates this recommendation
-by backing the JsonObject with a `Hash`; an object must have unique keys and the last one in, wins.
+"the names within an object SHOULD be unique". Jsonify enforces this recommendation by backing the JsonObject with a `Hash`; an object must have unique keys and the last one in, wins.
 
     json = Jsonify::Builder.new
     json.person do # start a new JsonObject where the key is 'foo'
@@ -326,7 +329,30 @@ Of course, standard iteration works here as well ...
 
 #### Mixing JSON Arrays and Objects
 
-___coming soon___
+You can readily mix JSON arrays and objects and the Jsonify builder will do
+its best to keep things straight.
+
+Here's an example where we start off with an array; but then decide to throw in an object.
+
+    json = Jsonify::Builder.new
+    json.append! 1,2,3
+    json.say "go, cat go"
+
+  compiles to ...
+
+    [1,2,3,{"say":"go, cat go"}]
+
+When Jsonify detected that you were trying to add a JSON name-value pair to a JSON array, it converted that pair to a JSON object.
+
+Let's take a look at the inverse approach ... say, we are creating a JSON object; and then decide to add an array item ...
+
+    json.foo 'bar'
+    json.go  'far'
+    json  << 'baz'
+
+In this case, Jsonify decides from the first line that you are creating a JSON object. When it gets to the third line, it simply turns the single item ('baz') into a name-value pair with a `null` value:
+
+    {"foo":"bar","go":"far","baz":null}
 
 ## Documentation
 
@@ -342,7 +368,6 @@ ___coming soon___
 
 ## TODOs
 1. Benchmark performance
-1. Document how partials can be used
 1. Clean up specs
 
 ## Roadmap

data/jsonify.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'json'
-  s.add_dependency "actionpack", "~> 3.0.0"
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'

data/lib/jsonify.rb

@@ -3,5 +3,4 @@ require 'blank_slate'
 require 'jsonify/version'
 require 'jsonify/json_value'
 require 'jsonify/generate'
-require 'jsonify/builder'
-require 'jsonify/rails'
+require 'jsonify/builder'

data/lib/jsonify/version.rb

@@ -1,3 +1,3 @@
 module Jsonify
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,116 +1,100 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jsonify
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.5
   prerelease: 
-  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Bill Siggelkow
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-30 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-08-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70100933802020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: actionpack
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        version: 3.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70100933802020
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &70100933801000 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70100933801000
+- !ruby/object:Gem::Dependency
   name: rake
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &70100933799960 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70100933799960
+- !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &70100933798940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70100933798940
+- !ruby/object:Gem::Dependency
   name: autotest
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &70100933797480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70100933797480
+- !ruby/object:Gem::Dependency
   name: yard
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &70100933796540 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
+  version_requirements: *70100933796540
+- !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &70100933795500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *id008
+  version_requirements: *70100933795500
 description: Turn Ruby objects into JSON -- correctly!
-email: 
+email:
 - bsiggelkow@me.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -123,48 +107,43 @@ files:
 - lib/jsonify/builder.rb
 - lib/jsonify/generate.rb
 - lib/jsonify/json_value.rb
-- lib/jsonify/rails.rb
 - lib/jsonify/version.rb
 - spec/builder_spec.rb
 - spec/generate_spec.rb
 - spec/json_value_spec.rb
 - spec/jsonify_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/bsiggelkow/jsonify
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -1768495453963674133
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 184180262065251326
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: -1768495453963674133
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 184180262065251326
 requirements: []
-
 rubyforge_project: jsonify
-rubygems_version: 1.5.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Turn Ruby objects into JSON
-test_files: 
+test_files:
 - spec/builder_spec.rb
 - spec/generate_spec.rb
 - spec/json_value_spec.rb

data/lib/jsonify/rails.rb

@@ -1,19 +0,0 @@
-require 'action_view'
-
-module ActionView
-  module Template::Handlers
-    class JsonifyBuilder < Template::Handler
-      include Compilable
-
-      self.default_format = Mime::JSON
-
-      def compile(template)
-        "json = ::Jsonify::Builder.new();" +
-          template.source +
-        ";json.compile!;"
-      end
-    end
-  end
-end
-
-ActionView::Template.register_template_handler :jsonify, ActionView::Template::Handlers::JsonifyBuilder