jsonify 0.1.1 → 0.1.2

data/README.md

@@ -33,9 +33,9 @@ But an even greater motivation for me was emulating the simplicity of [Builder](
 
 In the examples that follow, the JSON output is usually shown "prettified". Is this only
 for illustration purposes, as the default behavior for Jsonify is not to prettify the output.
-You can enable prettification by passing `:pretty => true` to the Jsonify::Builder constructor; however,
+You can enable prettification by passing `:format => :pretty` to the Jsonify::Builder constructor; however,
 pretty printing is a relatively costly operation and should not be used in production (unless, of course, you explicitly
-want to show this format).
+want to show this format). The default format, `plain`, dictates no special formatting: the result will be rendered as a compact string without any newlines.
 
 ### Standalone
     # Create some objects that represent a person and associated hyperlinks
@@ -47,16 +47,17 @@ want to show this format).
 
     # Build this information as JSON
     require 'jsonify'
-    json = Jsonify::Builder.new(:pretty => true)
-
-    json.result do
-      json.alumnus do
-        json.fname @person.first_name
-        json.lname @person.last_name
-      end
-      json.links(@links) do |link|
-        {:rel => link.first, :href => link.last}
-      end
+    json = Jsonify::Builder.new(:format => :pretty)
+
+    # Representation of the person
+    json.alumnus do
+      json.fname @person.first_name
+      json.lname @person.last_name
+    end
+
+    # Relevant links
+    json.links(@links) do |link|
+      {:rel => link.first, :href => link.last}
     end
 
     # Evaluate the result to a string
@@ -65,22 +66,20 @@ want to show this format).
 Results in ...
 
     {
-      "result": {
-        "alumnus": {
-          "fname": "George",
-          "lname": "Burdell"
+      "alumnus": {
+        "fname": "George",
+        "lname": "Burdell"
+      },
+      "links": [
+        {
+          "rel": "self",
+          "href": "http://example.com/people/123"
         },
-        "links": [
-          {
-            "rel": "self",
-            "href": "http://example.com/people/123"
-          },
-          {
-            "rel": "school",
-            "href": "http://gatech.edu"
-          }
-        ]
-      }
+        {
+          "rel": "school",
+          "href": "http://gatech.edu"
+        }
+      ]
     }
 
 ### View Templates
@@ -272,7 +271,7 @@ or symbol (for `tag!`).
 
 So this construct is really doing two things -- creating a JSON pair, and creating a JSON array as the value of the pair.
 
-    json = Jsonify::Builder.new(:pretty => true)
+    json = Jsonify::Builder.new(:format => :pretty)
     json.letters('a'..'c') do |letter|
       letter.upcase
     end

data/lib/jsonify/builder.rb

@@ -1,14 +1,34 @@
 module Jsonify
   class Builder < BlankSlate
+    
+    class << self
+
+      def compile( options={} )
+        builder = self.new options
+        yield builder
+        builder.compile!
+      end
+
+      def pretty(&block)
+        compile( :format => :pretty, &block )
+      end
+
+      def plain(&block)
+        compile( :format => :plain, &block )
+      end
+
+    end
 
     # Initializes a new builder. The Jsonify::Builder works by keeping a stack of +JsonValue+s.
     #
     # @param [Hash] options the options to create with
     # @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 [pretty] :pretty Builder will output the JSON string in a prettier format with new lines and indentation; 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 initialize(options={})
       @verify = options[:verify].nil? ? false : options[:verify] 
-      @pretty = options[:pretty].nil? ? false : options[:pretty] 
+      @pretty = options[:format].to_s == 'pretty' ? true : false 
       reset!
     end
     
@@ -29,7 +49,7 @@ module Jsonify
     
     # Compiles the JSON objects into a string representation. 
     # If initialized with +:verify => true+, the compiled result will be verified by attempting to re-parse it using +JSON.parse+.
-    # If initialized with +:pretty => true+, the compiled result will be parsed and regenerated via +JSON.pretty_generate+.
+    # If initialized with +:format => :pretty+, the compiled result will be parsed and regenerated via +JSON.pretty_generate+.
     # This method can be called without any side effects. You can call +compile!+ at any time, and multiple times if desired.
     #
     # @raise [TypeError] only if +:verify+ is set to true

data/lib/jsonify/version.rb

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

data/spec/builder_spec.rb

@@ -3,6 +3,33 @@ require 'spec_helper'
 describe Jsonify::Builder do
 
   let(:json) { Jsonify::Builder.new }
+  
+  describe 'class methods' do
+    it '#compile should compile' do
+      Jsonify::Builder.compile do |j|
+        j.foo 'bar'
+      end.should == '{"foo":"bar"}'
+    end
+    it '#pretty should be pretty' do
+      pretty_results = <<PRETTY_JSON
+{
+  "foo": {
+    "bar": "baz"
+  }
+}
+PRETTY_JSON
+      Jsonify::Builder.pretty do |j|
+        j.foo do
+          j.bar 'baz'
+        end
+      end.should == pretty_results.chomp
+    end
+    it '#plain should be plain' do
+      Jsonify::Builder.plain do |j|
+        j.foo 'bar'
+      end.should == '{"foo":"bar"}'
+    end
+  end
 
   describe 'base behavior' do
     describe 'should render empty object on literal' do
@@ -49,7 +76,7 @@ describe Jsonify::Builder do
         json.compile!.should == non_pretty_results
       end
       it "should be pretty when asked for" do
-        json = Jsonify::Builder.new(:pretty => true)
+        json = Jsonify::Builder.new(:format => :pretty)
         json.foo do
           json.bar 'baz'
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-08 00:00:00.000000000Z
+date: 2011-08-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70349313881080 !ruby/object:Gem::Requirement
+  requirement: &70122619875620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349313881080
+  version_requirements: *70122619875620
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70349313880380 !ruby/object:Gem::Requirement
+  requirement: &70122619874940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349313880380
+  version_requirements: *70122619874940
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70349313879820 !ruby/object:Gem::Requirement
+  requirement: &70122619874400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349313879820
+  version_requirements: *70122619874400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70349313879120 !ruby/object:Gem::Requirement
+  requirement: &70122619873760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349313879120
+  version_requirements: *70122619873760
 - !ruby/object:Gem::Dependency
   name: autotest
-  requirement: &70349313878380 !ruby/object:Gem::Requirement
+  requirement: &70122619872980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349313878380
+  version_requirements: *70122619872980
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70349313877680 !ruby/object:Gem::Requirement
+  requirement: &70122619872260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349313877680
+  version_requirements: *70122619872260
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70349313876960 !ruby/object:Gem::Requirement
+  requirement: &70122619871560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349313876960
+  version_requirements: *70122619871560
 - !ruby/object:Gem::Dependency
   name: ruby-prof
-  requirement: &70349313876420 !ruby/object:Gem::Requirement
+  requirement: &70122619871100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70349313876420
+  version_requirements: *70122619871100
 description: Turn Ruby objects into JSON -- correctly!
 email:
 - bsiggelkow@me.com
@@ -144,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2506856459072491085
+      hash: -3850211948781890722
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2506856459072491085
+      hash: -3850211948781890722
 requirements: []
 rubyforge_project: jsonify
 rubygems_version: 1.8.6