jsonify 0.1.3 → 0.2.0

data/README.md

@@ -31,18 +31,38 @@ But an even greater motivation for me was emulating the simplicity of [Builder](
 
 ## Usage
 
-In the examples that follow, the JSON output is usually shown "prettified". Is this only
+In the examples that follow, the JSON output is usually shown "prettified". This is only
 for illustration purposes, as the default behavior for Jsonify is not to prettify the output.
 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). The default format, `plain`, dictates no special formatting: the result will be rendered as a compact string without any newlines.
 
+### Compatibility Warning
+
+Starting with version 0.2.0, the handling of arrays has changed to provide a more natural feel. As a consequence, however, code written using earlier versions of Jsonify may not work correctly. The example that follows demonstrates the changes you will need to be make.
+
+Previously, when arrays were processed, you had to put away the builder-style, and use more conventional Rubyisms.
+
+    json.links(@links) do |link|
+      {:rel => link.type, :href => link.url}
+    end
+
+This difference was a frequent stumbling block with users and I wanted to remedy it. The interface for handling arrays is now consistent with the builder-style and should be less surprising to developers. The above snippet is now implemented as:
+
+    json.links(@links) do |link|
+      json.rel link.type
+      json.href link.url
+    end
+
+As always, all feedback is greatly appreciated. I want to know how this new style works out.
+
 ### Standalone
     # Create some objects that represent a person and associated hyperlinks
     @person = Struct.new(:first_name,:last_name).new('George','Burdell')
+    Link = Struct.new(:type, :url)
     @links = [
-      ['self',   'http://example.com/people/123'],
-      ['school', 'http://gatech.edu'],
+      Link.new('self', 'http://example.com/people/123'),
+      Link.new('school', 'http://gatech.edu')
     ]
 
     # Build this information as JSON
@@ -57,7 +77,8 @@ want to show this format). The default format, `plain`, dictates no special form
 
     # Relevant links
     json.links(@links) do |link|
-      {:rel => link.first, :href => link.last}
+      json.rel link.type
+      json.href link.url
     end
 
     # Evaluate the result to a string
@@ -303,20 +324,20 @@ Jsonify supports JSON array construction through two approaches: `method_missing
 
 ##### method_missing
 
-Pass an array and a block to `method_missing` (or `tag!`), and Jsonify will iterate
-over that array, and create a JSON array where each array item is the result of the block.
-If you pass an array that has a length of 5, you will end up with a JSON array that has 5 items.
+Pass an array and a block to `method_missing` (or `tag!`), and Jsonify will create a JSON array. It will then iterate over your array and call the block for each item in the array. Within the block, you use the `json` object to add items to the JSON array.
+
 That JSON array is then set as the value of the name-value pair, where the name comes from the method name (for `method_missing`)
 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(:format => :pretty)
-    json.letters('a'..'c') do |letter|
-      letter.upcase
+    Jsonify::Builder.pretty do |json|
+      json.letters('a'..'c') do |letter|
+        json << letter.upcase
+      end
     end
     
-compiles to ...
+results in ...
 
     {
       "letters": [

data/lib/jsonify/builder.rb

@@ -116,11 +116,12 @@ module Jsonify
     # If a block is given and an argument is passed, the argument it is assumed to be an 
     # Array (more specifically, an object that responds to `each`). 
     # The argument is iterated over and each item is yielded to the block.
-    # The result of the block becomes an array item of a JsonArray.
+    # The result of the block becomes an array item of the JsonArray.
     #
     # @example Map an of array of links to an array of JSON objects
     #     json.links(@links) do |link|
-    #       {:rel => link.first, :href => link.last}
+    #       json.rel link.first
+    #       json.href link.last
     #     end
     # 
     # @example compiles to something like ...
@@ -153,7 +154,19 @@ module Jsonify
       else
         __array
         args.each do |arg|
-          @stack[@level].add block.call(arg)
+          @level += 1
+          block.call(arg)
+          @level -= 1
+          
+          value = @stack.pop
+
+          # If the object created was an array with a single value
+          # assume that just the value should be added
+          if (JsonArray === value && value.values.length <= 1)
+            value = value.values.first
+          end
+
+          @stack[@level].add value
         end
       end
 
@@ -202,4 +215,4 @@ module Jsonify
     end
 
   end
-end
+end

data/lib/jsonify/version.rb

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

data/spec/builder_spec.rb

@@ -184,21 +184,14 @@ PRETTY_JSON
     
     it 'hash with array by iteration' do
       ary = [1,2,3]
-      json.foo(ary) do |n|
-        n * 2
+      json.foo do
+        ary.each do |n|
+          json << (n * 2)
+        end
       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
       json << {:foo => :bar}
@@ -261,7 +254,8 @@ PRETTY_JSON
           json.lname 'Burdell'
         end
         json.links(links) do |link|
-          { :href => link.url, :rel => link.type}
+          json.href link.url
+          json.rel link.type
         end
       end
       expected = "{\"result\":{\"person\":{\"fname\":\"George\",\"lname\":\"Burdell\"},\"links\":[{\"href\":\"example.com\",\"rel\":\"self\"},{\"href\":\"foo.com\",\"rel\":\"parent\"}]}}"
@@ -313,4 +307,31 @@ PRETTY_JSON
       end
     end
   end
-end
+
+  describe 'with new array style' do
+    it 'should work' do
+      results =[
+        {:id => 1, :kids => [{:id => 'a'},{:id => 'b'}]},
+        {:id => 2, :kids => [{:id => 'c'},{:id => 'd'}]},
+      ]
+
+      json.results(results) do |result|
+        json.id result[:id]
+        json.children(result[:kids]) do |kid|
+          json.id kid[:id]
+        end
+      end
+      
+      expected = '{"results":[{"id":1,"children":[{"id":"a"},{"id":"b"}]},{"id":2,"children":[{"id":"c"},{"id":"d"}]}]}'
+      JSON.parse(json.compile!).should == JSON.parse(expected)
+    end
+    it 'simple append' do
+      json.letters('a'..'c') do |letter|
+        json << letter.upcase
+      end
+      expected = '{"letters":["A","B","C"]}'
+      JSON.parse(json.compile!).should == JSON.parse(expected)
+    end
+    
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonify
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-01 00:00:00.000000000Z
+date: 2011-09-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70241180309060 !ruby/object:Gem::Requirement
+  requirement: &70165351228400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70241180309060
+  version_requirements: *70165351228400
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70241180306880 !ruby/object:Gem::Requirement
+  requirement: &70165351226320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *70241180306880
+  version_requirements: *70165351226320
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70241180306020 !ruby/object:Gem::Requirement
+  requirement: &70165351224580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70241180306020
+  version_requirements: *70165351224580
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70241180303540 !ruby/object:Gem::Requirement
+  requirement: &70165351223680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70241180303540
+  version_requirements: *70165351223680
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70241180302600 !ruby/object:Gem::Requirement
+  requirement: &70165351220980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70241180302600
+  version_requirements: *70165351220980
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &70241180301860 !ruby/object:Gem::Requirement
+  requirement: &70165351220280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70241180301860
+  version_requirements: *70165351220280
 description: Turn Ruby objects into JSON -- correctly!
 email:
 - bsiggelkow@me.com
@@ -122,7 +122,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 415595821988882792
+      hash: 50285731348355282
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 415595821988882792
+      hash: 50285731348355282
 requirements: []
 rubyforge_project: jsonify
 rubygems_version: 1.8.6