jbuilder 0.3 → 0.3.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    jbuilder (0.3)
+      activesupport (>= 3.0.0)
+      blankslate (>= 2.1.2.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    blankslate (2.1.2.4)
+    multi_json (1.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jbuilder!

data/README.md

@@ -3,71 +3,83 @@ Jbuilder
 
 Jbuilder gives you a simple DSL for declaring JSON structures that beats massaging giant hash structures. This is particularly helpful when the generation process is fraught with conditionals and loops. Here's a simple example:
 
-    Jbuilder.encode do |json|
-      json.content format_content(@message.content)
-      json.(@message, :created_at, :updated_at)
-  
-      json.author do |json|
-        json.name @message.creator.name.familiar
-        json.email_address @message.creator.email_address_with_name
-        json.url url_for(@message.creator, format: :json)
-      end
-  
-      if current_user.admin?
-        json.visitors calculate_visitors(@message)
-      end
+``` ruby
+Jbuilder.encode do |json|
+  json.content format_content(@message.content)
+  json.(@message, :created_at, :updated_at)
+
+  json.author do |json|
+    json.name @message.creator.name.familiar
+    json.email_address @message.creator.email_address_with_name
+    json.url url_for(@message.creator, format: :json)
+  end
+
+  if current_user.admin?
+    json.visitors calculate_visitors(@message)
+  end
+
+  json.comments @message.comments, :content, :created_at
   
-      json.comments @message.comments, :content, :created_at
-      
-      json.attachments @message.attachments do |json, attachment|
-        json.filename attachment.filename
-        json.url url_for(attachment)
-      end
-    end
+  json.attachments @message.attachments do |json, attachment|
+    json.filename attachment.filename
+    json.url url_for(attachment)
+  end
+end
+```
 
 This will build the following structure:
 
-    { 
-      "content": "<p>This is <i>serious</i> monkey business",
-      "created_at": "2011-10-29T20:45:28-05:00",
-      "updated_at": "2011-10-29T20:45:28-05:00",
-    
-      "author": {
-        "name": "David H.",
-        "email_address": "'David Heinemeier Hansson' <david@heinemeierhansson.com>",
-        "url": "http://example.com/users/1-david.json"
-      },
-    
-      "visitors": 15,
-    
-      "comments": [
-        { "content": "Hello everyone!", "created_at": "2011-10-29T20:45:28-05:00" },
-        { "content": "To you my good sir!", "created_at": "2011-10-29T20:47:28-05:00" }
-      ],
-      
-      "attachment": [
-        { "filename": "forecast.xls", "url": "http://example.com/downloads/forecast.xls" },
-        { "filename": "presentation.pdf", "url": "http://example.com/downloads/presentation.pdf" }
-      ]
-    }
+``` javascript
+{ 
+  "content": "<p>This is <i>serious</i> monkey business",
+  "created_at": "2011-10-29T20:45:28-05:00",
+  "updated_at": "2011-10-29T20:45:28-05:00",
+
+  "author": {
+    "name": "David H.",
+    "email_address": "'David Heinemeier Hansson' <david@heinemeierhansson.com>",
+    "url": "http://example.com/users/1-david.json"
+  },
+
+  "visitors": 15,
+
+  "comments": [
+    { "content": "Hello everyone!", "created_at": "2011-10-29T20:45:28-05:00" },
+    { "content": "To you my good sir!", "created_at": "2011-10-29T20:47:28-05:00" }
+  ],
+  
+  "attachment": [
+    { "filename": "forecast.xls", "url": "http://example.com/downloads/forecast.xls" },
+    { "filename": "presentation.pdf", "url": "http://example.com/downloads/presentation.pdf" }
+  ]
+}
+```
 
 You can either use Jbuilder stand-alone or directly as an ActionView template language. When required in Rails, you can create views ala show.json.jbuilder (the json is already yielded):
 
-    # Any helpers available to views are available to the builder
-    json.content format_content(@message.content)
-    json.(@message, :created_at, :updated_at)
+``` ruby
+# Any helpers available to views are available to the builder
+json.content format_content(@message.content)
+json.(@message, :created_at, :updated_at)
+
+json.author do |json|
+  json.name @message.creator.name.familiar
+  json.email_address @message.creator.email_address_with_name
+  json.url url_for(@message.creator, format: :json)
+end
 
-    json.author do |json|
-      json.name @message.creator.name.familiar
-      json.email_address @message.creator.email_address_with_name
-      json.url url_for(@message.creator, format: :json)
-    end
+if current_user.admin?
+  json.visitors calculate_visitors(@message)
+end
 
-    if current_user.admin?
-      json.visitors calculate_visitors(@message)
-    end
+# You can use partials as well, just remember to pass in the json instance
+json.partial! "api/comments/comments", @message.comments
+```
 
-    # You can use partials as well, just remember to pass in the json instance
-    json.partial! "api/comments/comments" @message.comments
+Libraries similar to this in some form or another includes:
 
-Note: Jbuilder is similar to Garrett Bjerkhoel's json_builder, which I discovered after making this, but the DSL has taken a different turn and will retain the explicit yield style (vs json_builder's 3.0's move to instance_eval).
+* RABL: https://github.com/nesquena/rabl
+* JsonBuilder: https://github.com/nov/jsonbuilder
+* JSON Builder: https://github.com/dewski/json_builder
+* Jsonify: https://github.com/bsiggelkow/jsonify
+* RepresentationView: https://github.com/mdub/representative_view

data/jbuilder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name    = 'jbuilder'
-  s.version = '0.3'
+  s.version = '0.3.1'
   s.author  = 'David Heinemeier Hansson'
   s.email   = 'david@37signals.com'
   s.summary = 'Create JSON structures via a Builder-style DSL'

data/lib/jbuilder.rb

@@ -17,6 +17,11 @@ class Jbuilder < BlankSlate
     @attributes = ActiveSupport::OrderedHash.new
   end
 
+  # Dynamically set a key value pair.
+  def set!(key, value)
+    @attributes[key] = value
+  end
+
   # Turns the current element into an array and yields a builder to add a hash.
   #
   # Example:
@@ -38,7 +43,8 @@ class Jbuilder < BlankSlate
     @attributes << _new_instance._tap { |jbuilder| yield jbuilder }.attributes!
   end
 
-  # Iterates over the passed collection and adds each iteration as an element of the resulting array.
+  # Turns the current element into an array and iterates over the passed collection, adding each iteration as 
+  # an element of the resulting array.
   #
   # Example:
   #
@@ -47,7 +53,7 @@ class Jbuilder < BlankSlate
   #     json.age calculate_age(person.birthday)
   #   end
   #
-  #   [ { "David", 32 }, { "Jamie", 31 } ]
+  #   [ { "name": David", "age": 32 }, { "name": Jamie", "age": 31 } ]
   #
   # If you are using Ruby 1.9+, you can use the call syntax instead of an explicit extract! call:
   #
@@ -60,8 +66,10 @@ class Jbuilder < BlankSlate
   #     json.age calculate_age(person.birthday)
   #   end  
   #
-  #   { "people": [ { "David", 32 }, { "Jamie", 31 } ] }
+  #   { "people": [ { "name": David", "age": 32 }, { "name": Jamie", "age": 31 } ] }
   def array!(collection)
+    @attributes = [] and return if collection.empty?
+    
     collection.each do |element|
       child! do |child|
         yield child, element
@@ -75,7 +83,7 @@ class Jbuilder < BlankSlate
   #
   #   json.extract! @person, :name, :age
   #
-  #   { "David", 32 }, { "Jamie", 31 }
+  #   { "name": David", "age": 32 }, { "name": Jamie", "age": 31 }
   #
   # If you are using Ruby 1.9+, you can use the call syntax instead of an explicit extract! call:
   #
@@ -111,34 +119,46 @@ class Jbuilder < BlankSlate
   private
     def method_missing(method, *args)
       case
+      # json.comments @post.comments { |json, comment| ... }
+      # { "comments": [ { ... }, { ... } ] }
       when args.one? && block_given?
         _yield_iteration(method, args.first) { |child, element| yield child, element }
+
+      # json.age 32
+      # { "age": 32 }
       when args.one?
-        _assign method, args.first
+        set! method, args.first
+
+      # json.comments { |json| ... }
+      # { "comments": ... }
       when args.empty? && block_given?
         _yield_nesting(method) { |jbuilder| yield jbuilder }
+      
+      # json.comments(@post.comments, :content, :created_at)
+      # { "comments": [ { "content": "hello", "created_at": "..." }, { "content": "world", "created_at": "..." } ] }
       when args.many? && args.first.is_a?(Enumerable)
         _inline_nesting method, args.first, args.from(1)
+
+      # json.author @post.creator, :name, :email_address
+      # { "author": { "name": "David", "email_address": "david@loudthinking.com" } }
       when args.many?
         _inline_extract method, args.first, args.from(1)
       end
     end
 
-    def _assign(key, value)
-      @attributes[key] = value
-    end
-
     # Overwrite in subclasses if you need to add initialization values
     def _new_instance
       __class__.new
     end
 
     def _yield_nesting(container)
-      @attributes[container] = _new_instance._tap { |jbuilder| yield jbuilder }.attributes!
+      set! container, _new_instance._tap { |jbuilder| yield jbuilder }.attributes!
     end
 
     def _inline_nesting(container, collection, attributes)
       __send__(container) do |parent|
+        parent.array!(collection) and return if collection.empty?
+        
         collection.each do |element|
           parent.child! do |child|
             attributes.each do |attribute|

data/lib/jbuilder_template.rb

@@ -9,7 +9,7 @@ class JbuilderTemplate < Jbuilder
   end
   
   def partial!(partial_name, options = {})
-    @context.render(partial_name, options.merge(json: self))
+    @context.render(partial_name, options.merge(:json => self))
   end
   
   private

data/test/jbuilder_test.rb

@@ -111,6 +111,19 @@ class JbuilderTest < ActiveSupport::TestCase
     end
   end
   
+  test "nesting multiple children from array when child array is empty" do
+    comments = []
+    
+    json = Jbuilder.encode do |json|
+      json.name "Parent"
+      json.comments comments, :content
+    end
+    
+    JSON.parse(json).tap do |parsed|
+      assert_equal "Parent", parsed["name"]
+      assert_equal [], parsed["comments"]
+    end
+  end
   
   test "nesting multiple children from array with inline loop" do
     comments = [ Struct.new(:content, :id).new("hello", 1), Struct.new(:content, :id).new("world", 2) ]
@@ -192,4 +205,24 @@ class JbuilderTest < ActiveSupport::TestCase
       assert_equal "world", parsed.second["content"]
     end
   end 
+  
+  test "empty top-level array" do
+    comments = []
+    
+    json = Jbuilder.encode do |json|
+      json.array!(comments) do |json, comment|
+        json.content comment.content
+      end
+    end
+    
+    assert_equal [], JSON.parse(json)
+  end
+  
+  test "dynamically set a key/value" do
+    json = Jbuilder.encode do |json|
+      json.set!(:each, "stuff")
+    end
+    
+    assert_equal "stuff", JSON.parse(json)["each"]
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000 Z
+date: 2012-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70104549490040 !ruby/object:Gem::Requirement
+  requirement: &70354468053200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70104549490040
+  version_requirements: *70354468053200
 - !ruby/object:Gem::Dependency
   name: blankslate
-  requirement: &70104549489160 !ruby/object:Gem::Requirement
+  requirement: &70354468052720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,13 +32,16 @@ dependencies:
         version: 2.1.2.4
   type: :runtime
   prerelease: false
-  version_requirements: *70104549489160
+  version_requirements: *70354468052720
 description: 
 email: david@37signals.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ./Gemfile
+- ./Gemfile.lock
+- ./jbuilder-0.3.gem
 - ./jbuilder.gemspec
 - ./lib/jbuilder.rb
 - ./lib/jbuilder_template.rb
@@ -65,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Create JSON structures via a Builder-style DSL