jbuilder 0.7.0 → 0.8.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jbuilder (0.7.0)
+    jbuilder (0.8.0)
       activesupport (>= 3.0.0)
 
 GEM

data/README.md

@@ -8,7 +8,7 @@ Jbuilder.encode do |json|
   json.content format_content(@message.content)
   json.(@message, :created_at, :updated_at)
 
-  json.author do |json|
+  json.author do
     json.name @message.creator.name.familiar
     json.email_address @message.creator.email_address_with_name
     json.url url_for(@message.creator, format: :json)
@@ -20,7 +20,7 @@ Jbuilder.encode do |json|
 
   json.comments @message.comments, :content, :created_at
   
-  json.attachments @message.attachments do |json, attachment|
+  json.attachments @message.attachments do |attachment|
     json.filename attachment.filename
     json.url url_for(attachment)
   end
@@ -59,7 +59,7 @@ Top level arrays can be handled directly.  Useful for index and other collection
 
 ``` ruby
 # @people = People.all
-json.array!(@people) do |json, person|
+json.array!(@people) do |person|
   json.name person.name
   json.age calculate_age(person.birthday)
 end
@@ -101,7 +101,7 @@ You can either use Jbuilder stand-alone or directly as an ActionView template la
 json.content format_content(@message.content)
 json.(@message, :created_at, :updated_at)
 
-json.author do |json|
+json.author do
   json.name @message.creator.name.familiar
   json.email_address @message.creator.email_address_with_name
   json.url url_for(@message.creator, format: :json)

data/jbuilder.gemspec

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

data/lib/jbuilder.rb

@@ -62,7 +62,7 @@ class Jbuilder < ActiveSupport::BasicObject
   #
   # You can also pass a block for nested attributes
   #
-  #   json.set!(:author) do |json|
+  #   json.set!(:author) do
   #     json.name "David"
   #     json.age 32
   #   end
@@ -70,7 +70,7 @@ class Jbuilder < ActiveSupport::BasicObject
   #   { "author": { "name": "David", "age": 32 } }
   def set!(key, value = nil)
     if ::Kernel::block_given?
-      _set_value(key, _with_attributes { yield self })
+      _set_value(key, _scope { yield self })
     else
       _set_value(key, value)
     end
@@ -83,7 +83,7 @@ class Jbuilder < ActiveSupport::BasicObject
   # Example:
   #
   #   json.key_format! :upcase
-  #   json.author do |json|
+  #   json.author do
   #     json.name "David"
   #     json.age 32
   #   end
@@ -117,21 +117,21 @@ class Jbuilder < ActiveSupport::BasicObject
   #
   # Example:
   #
-  #   json.comments do |json|
-  #     json.child! { |json| json.content "hello" }
-  #     json.child! { |json| json.content "world" }
+  #   json.comments do
+  #     json.child! { json.content "hello" }
+  #     json.child! { json.content "world" }
   #   end
   #
   #   { "comments": [ { "content": "hello" }, { "content": "world" } ]}
   #
   # More commonly, you'd use the combined iterator, though:
   #
-  #   json.comments(@post.comments) do |json, comment|
+  #   json.comments(@post.comments) do |comment|
   #     json.content comment.formatted_content
   #   end
   def child!
     @attributes = [] unless @attributes.is_a? ::Array
-    @attributes << _with_attributes { yield self }
+    @attributes << _scope { yield self }
   end
 
   # Turns the current element into an array and iterates over the passed collection, adding each iteration as
@@ -139,7 +139,7 @@ class Jbuilder < ActiveSupport::BasicObject
   #
   # Example:
   #
-  #   json.array!(@people) do |json, person|
+  #   json.array!(@people) do |person|
   #     json.name person.name
   #     json.age calculate_age(person.birthday)
   #   end
@@ -148,11 +148,11 @@ class Jbuilder < ActiveSupport::BasicObject
   #
   # If you are using Ruby 1.9+, you can use the call syntax instead of an explicit extract! call:
   #
-  #   json.(@people) { |json, person| ... }
+  #   json.(@people) { |person| ... }
   #
   # It's generally only needed to use this method for top-level arrays. If you have named arrays, you can do:
   #
-  #   json.people(@people) do |json, person|
+  #   json.people(@people) do |person|
   #     json.name person.name
   #     json.age calculate_age(person.birthday)
   #   end
@@ -165,8 +165,8 @@ class Jbuilder < ActiveSupport::BasicObject
   #
   #   [1,2,3]
   def array!(collection)
-    @attributes = if block_given?
-      _map_collection(collection) { |element| yield self, element }
+    @attributes = if ::Kernel::block_given?
+      _map_collection(collection) { |element| if ::Proc.new.arity == 2 then yield self, element else yield element end }
     else
       collection
     end
@@ -199,7 +199,7 @@ class Jbuilder < ActiveSupport::BasicObject
 
   def call(object = nil, *attributes)
     if attributes.empty?
-      array!(object) { |_, element| yield self, element }
+      array!(object, &::Proc.new)
     else
       extract!(object, *attributes)
     end
@@ -215,48 +215,22 @@ class Jbuilder < ActiveSupport::BasicObject
     ::MultiJson.encode @attributes
   end
 
-  # Caches the json constructed within the block passed. Has the same signature as the `cache` helper 
-  # method in `ActionView::Helpers::CacheHelper` and so can be used in the same way.
-  #
-  # Example:
-  #
-  #   json.cache! ['v1', @person], :expires_in => 10.minutes do |json|
-  #     json.extract! @person, :name, :age
-  #   end
-  def cache!(key=nil, options={}, &block)
-    cache_key = ::ActiveSupport::Cache.expand_cache_key(key.is_a?(::Hash) ? url_for(key).split("://").last : key, :jbuilder)
-    value = ::Rails.cache.fetch(cache_key, options) do
-      jb = ::Jbuilder.new
-      yield jb
-      jb.attributes!
-    end
-
-    if value.is_a?(::Array)
-      array! value
-    else
-      value.each do |k, v|
-        set! k, v
-      end
-    end
-  end
-
   protected
     def _set_value(key, value)
       @attributes[@key_formatter.format(key)] = value
     end
 
-
   private
     def method_missing(method, value = nil, *args)
       result = if ::Kernel.block_given?
         if value
-          # json.comments @post.comments { |json, comment| ... }
+          # json.comments @post.comments { |comment| ... }
           # { "comments": [ { ... }, { ... } ] }
-          _map_collection(value) { |element| yield self, element }
+          _map_collection(value) { |element| if ::Proc.new.arity == 2 then yield self, element else yield element end }
         else
-          # json.comments { |json| ... }
+          # json.comments { ... }
           # { "comments": ... }
-          _with_attributes { yield self }
+          _scope { yield self }
         end
       else
         if args.empty?
@@ -282,7 +256,7 @@ class Jbuilder < ActiveSupport::BasicObject
           else
             # json.author @post.creator, :name, :email_address
             # { "author": { "name": "David", "email_address": "david@loudthinking.com" } }
-            _with_attributes { extract! value, *args }
+            _scope { extract! value, *args }
           end
         end
       end
@@ -291,11 +265,11 @@ class Jbuilder < ActiveSupport::BasicObject
 
     def _map_collection(collection)
       collection.each.map do |element|
-        _with_attributes { yield element }
+        _scope { yield element }
       end
     end
 
-    def _with_attributes
+    def _scope
       parent_attributes, parent_formatter = @attributes, @key_formatter
       @attributes = ::ActiveSupport::OrderedHash.new
       yield
@@ -303,6 +277,15 @@ class Jbuilder < ActiveSupport::BasicObject
     ensure
       @attributes, @key_formatter = parent_attributes, parent_formatter
     end
+
+    def _merge(hash_or_array)
+      if hash_or_array.is_a?(::Array)
+        @attributes = [] unless @attributes.is_a? ::Array
+        @attributes.concat(hash_or_array)
+      else
+        @attributes.update(hash_or_array)
+      end
+    end
 end
 
 require "jbuilder_template" if defined?(ActionView::Template)

data/lib/jbuilder_template.rb

@@ -14,6 +14,22 @@ class JbuilderTemplate < Jbuilder
       @context.render(options, locals.merge(:json => self))
     end
   end
+
+  # Caches the json constructed within the block passed. Has the same signature as the `cache` helper
+  # method in `ActionView::Helpers::CacheHelper` and so can be used in the same way.
+  #
+  # Example:
+  #
+  #   json.cache! ['v1', @person], :expires_in => 10.minutes do
+  #     json.extract! @person, :name, :age
+  #   end
+  def cache!(key=nil, options={}, &block)
+    cache_key = ::ActiveSupport::Cache.expand_cache_key(key.is_a?(::Hash) ? url_for(key).split("://").last : key, :jbuilder)
+    value = ::Rails.cache.fetch(cache_key, options) do
+      _scope { yield self }
+    end
+    _merge(value)
+  end
 end
 
 class JbuilderHandler

data/test/jbuilder_template_test.rb

@@ -1,9 +1,32 @@
 require 'test/unit'
 require 'action_view'
 require 'action_view/testing/resolvers'
+require 'active_support/cache'
 
 require 'jbuilder'
 
+module Rails
+  class Cache
+    def initialize
+      @cache = {}
+    end
+
+    def write(k, v, opt={})
+      @cache[k] = v
+    end
+
+    def read(k, opt={})
+      @cache[k]
+    end
+
+    def fetch(k, opt={}, &block)
+      @cache[k] || @cache[k] = block.call
+    end
+  end
+
+  def self.cache; @cache ||= Cache.new; end
+end
+
 class JbuilderTemplateTest < ActionView::TestCase
   def partials
     { "_partial.json.jbuilder" => 'json.content "hello"' }
@@ -36,7 +59,7 @@ class JbuilderTemplateTest < ActionView::TestCase
     json = render_jbuilder <<-JBUILDER
       json.key_format! :upcase
       json.level1 "one"
-      json.level2 do |json|
+      json.level2 do
         json.value "two"
       end
     JBUILDER
@@ -53,4 +76,43 @@ class JbuilderTemplateTest < ActionView::TestCase
 
     assert_equal "hello", MultiJson.load(json)["content"]
   end
+
+  test "fragment caching a JSON object" do
+    json = render_jbuilder <<-JBUILDER
+      json.cache!("cachekey") do
+        json.name "Cache"
+      end
+    JBUILDER
+
+    Rails.cache.read("jbuilder/cachekey").tap do |parsed|
+      assert_equal "Cache", parsed['name']
+    end
+  end
+
+  test "fragment caching deserializes a JSON object" do
+    Rails.cache.write("jbuilder/cachekey", {'name' => "Something"})
+    json = render_jbuilder <<-JBUILDER
+      json.cache!("cachekey") do
+        json.name "Cache"
+      end
+    JBUILDER
+
+    MultiJson.load(json).tap do |parsed|
+      assert_equal "Something", parsed['name']
+    end
+  end
+
+  test "fragment caching deserializes an array" do
+    Rails.cache.write("jbuilder/cachekey", ["a", "b", "c"])
+    json = render_jbuilder <<-JBUILDER
+      json.cache!("cachekey") do
+        json.array! ['1', '2', '3']
+      end
+    JBUILDER
+
+    MultiJson.load(json).tap do |parsed|
+      assert_equal ["a", "b", "c"], parsed
+    end
+  end
+
 end

data/test/jbuilder_test.rb

@@ -1,32 +1,9 @@
 require 'test/unit'
 require 'active_support/test_case'
-require 'active_support/cache'
 require 'active_support/inflector'
 
 require 'jbuilder'
 
-module Rails
-  class Cache
-    def initialize
-      @cache = {}
-    end
-
-    def write(k, v, opt={})
-      @cache[k] = v
-    end
-
-    def read(k, opt={})
-      @cache[k]
-    end
-
-    def fetch(k, opt={}, &block)
-      @cache[k] || @cache[k] = block.call
-    end
-  end
-
-  def self.cache; @cache ||= Cache.new; end
-end
-
 class JbuilderTest < ActiveSupport::TestCase
   test "single key" do
     json = Jbuilder.encode do |json|
@@ -110,7 +87,7 @@ class JbuilderTest < ActiveSupport::TestCase
 
   test "nesting single child with block" do
     json = Jbuilder.encode do |json|
-      json.author do |json|
+      json.author do
         json.name "David"
         json.age  32
       end
@@ -124,9 +101,9 @@ class JbuilderTest < ActiveSupport::TestCase
 
   test "nesting multiple children with block" do
     json = Jbuilder.encode do |json|
-      json.comments do |json|
-        json.child! { |json| json.content "hello" }
-        json.child! { |json| json.content "world" }
+      json.comments do
+        json.child! { json.content "hello" }
+        json.child! { json.content "world" }
       end
     end
 
@@ -186,6 +163,22 @@ class JbuilderTest < ActiveSupport::TestCase
   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) ]
 
+    json = Jbuilder.encode do |json|
+      json.comments comments do |comment|
+        json.content comment.content
+      end
+    end
+
+    MultiJson.load(json).tap do |parsed|
+      assert_equal ["content"], parsed["comments"].first.keys
+      assert_equal "hello", parsed["comments"].first["content"]
+      assert_equal "world", parsed["comments"].second["content"]
+    end
+  end
+
+  test "nesting multiple children from array with inline loop with old api" do
+    comments = [ Struct.new(:content, :id).new("hello", 1), Struct.new(:content, :id).new("world", 2) ]
+
     json = Jbuilder.encode do |json|
       json.comments comments do |json, comment|
         json.content comment.content
@@ -202,6 +195,21 @@ class JbuilderTest < ActiveSupport::TestCase
   test "nesting multiple children from array with inline loop on root" do
     comments = [ Struct.new(:content, :id).new("hello", 1), Struct.new(:content, :id).new("world", 2) ]
 
+    json = Jbuilder.encode do |json|
+      json.call(comments) do |comment|
+        json.content comment.content
+      end
+    end
+
+    MultiJson.load(json).tap do |parsed|
+      assert_equal "hello", parsed.first["content"]
+      assert_equal "world", parsed.second["content"]
+    end
+  end
+
+  test "nesting multiple children from array with inline loop on root with old api" do
+    comments = [ Struct.new(:content, :id).new("hello", 1), Struct.new(:content, :id).new("world", 2) ]
+
     json = Jbuilder.encode do |json|
       json.call(comments) do |json, comment|
         json.content comment.content
@@ -216,13 +224,13 @@ class JbuilderTest < ActiveSupport::TestCase
 
   test "array nested inside nested hash" do
     json = Jbuilder.encode do |json|
-      json.author do |json|
+      json.author do
         json.name "David"
         json.age  32
 
-        json.comments do |json|
-          json.child! { |json| json.content "hello" }
-          json.child! { |json| json.content "world" }
+        json.comments do
+          json.child! { json.content "hello" }
+          json.child! { json.content "world" }
         end
       end
     end
@@ -235,10 +243,10 @@ class JbuilderTest < ActiveSupport::TestCase
 
   test "array nested inside array" do
     json = Jbuilder.encode do |json|
-      json.comments do |json|
-        json.child! do |json|
-          json.authors do |json|
-            json.child! do |json|
+      json.comments do
+        json.child! do
+          json.authors do
+            json.child! do
               json.name "david"
             end
           end
@@ -249,6 +257,36 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal "david", MultiJson.load(json)["comments"].first["authors"].first["name"]
   end
 
+  test "directly set an array nested in another array" do
+    data = [ { :department => 'QA', :not_in_json => 'hello', :names => ['John', 'David'] } ]
+    json = Jbuilder.encode do |json|
+      json.array! data do |object|
+        json.department object[:department]
+        json.names do
+          json.array! object[:names]
+        end
+      end
+    end
+
+    assert_equal 'David', MultiJson.load(json)[0]['names'].last
+    assert_not_equal 'hello', MultiJson.load(json)[0]['not_in_json']
+  end
+
+  test "directly set an array nested in another array with old api" do
+    data = [ { :department => 'QA', :not_in_json => 'hello', :names => ['John', 'David'] } ]
+    json = Jbuilder.encode do |json|
+      json.array! data do |json, object|
+        json.department object[:department]
+        json.names do
+          json.array! object[:names]
+        end
+      end
+    end
+
+    assert_equal 'David', MultiJson.load(json)[0]['names'].last
+    assert_not_equal 'hello', MultiJson.load(json)[0]['not_in_json']
+  end
+
   test "nested jbuilder objects" do
     to_nest = Jbuilder.new
     to_nest.nested_value "Nested Test"
@@ -265,7 +303,7 @@ class JbuilderTest < ActiveSupport::TestCase
     comments = [ Struct.new(:content, :id).new("hello", 1), Struct.new(:content, :id).new("world", 2) ]
 
     json = Jbuilder.encode do |json|
-      json.array!(comments) do |json, comment|
+      json.array!(comments) do |comment|
         json.content comment.content
       end
     end
@@ -280,7 +318,7 @@ class JbuilderTest < ActiveSupport::TestCase
     comments = []
 
     json = Jbuilder.encode do |json|
-      json.array!(comments) do |json, comment|
+      json.array!(comments) do |comment|
         json.content comment.content
       end
     end
@@ -298,7 +336,7 @@ class JbuilderTest < ActiveSupport::TestCase
 
   test "dynamically set a key/nested child with block" do
     json = Jbuilder.encode do |json|
-      json.set!(:author) do |json|
+      json.set!(:author) do
         json.name "David"
         json.age 32
       end
@@ -357,7 +395,7 @@ class JbuilderTest < ActiveSupport::TestCase
     json = Jbuilder.new
     json.key_format! :upcase
     json.level1 "one"
-    json.level2 do |json|
+    json.level2 do
       json.value "two"
     end
 
@@ -368,7 +406,7 @@ class JbuilderTest < ActiveSupport::TestCase
 
   test "key_format! resets after child element" do
     json = Jbuilder.new
-    json.level2 do |json|
+    json.level2 do
       json.key_format! :upcase
       json.value "two"
     end
@@ -419,41 +457,4 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal [], Jbuilder.send(:class_variable_get, "@@key_formatter").instance_variable_get("@cache").keys
   end
 
-  test "fragment caching a JSON object" do
-    json = Jbuilder.encode do |json|
-      json.cache!("cachekey") do |json|
-        json.name "Cache"
-      end
-    end
-
-    Rails.cache.read("jbuilder/cachekey").tap do |parsed|
-      assert_equal "Cache", parsed['name']
-    end
-  end
-
-  test "fragment caching deserializes a JSON object" do
-    Rails.cache.write("jbuilder/cachekey", {'name' => "Something"})
-    json = Jbuilder.encode do |json|
-      json.cache!("cachekey") do |json|
-        json.name "Cache"
-      end
-    end
-
-    JSON.parse(json).tap do |parsed|
-      assert_equal "Something", parsed['name']
-    end
-  end
-
-  test "fragment caching deserializes an array" do
-    Rails.cache.write("jbuilder/cachekey", ["a", "b", "c"])
-    json = Jbuilder.encode do |json|
-      json.cache!("cachekey") do |json|
-        json.array! ['1', '2', '3']
-      end
-    end
-
-    JSON.parse(json).tap do |parsed|
-      assert_equal ["a", "b", "c"], parsed
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-24 00:00:00.000000000 Z
+date: 2012-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2152334840 !ruby/object:Gem::Requirement
+  requirement: &2152108040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152334840
+  version_requirements: *2152108040
 description: 
 email: david@37signals.com
 executables: []
@@ -31,6 +31,7 @@ files:
 - ./Gemfile
 - ./Gemfile.lock
 - ./jbuilder-0.6.0.gem
+- ./jbuilder-0.7.0.gem
 - ./jbuilder.gemspec
 - ./lib/jbuilder.rb
 - ./lib/jbuilder_template.rb