jbuilder 1.3.0 → 1.4.0

data/README.md

@@ -59,7 +59,7 @@ To define attribute and structure names dynamically, use the `set!` method:
 
 ``` ruby
 json.set! :author do
-  json.set! :name, "David"
+  json.set! :name, 'David'
 end
 
 # => "author": { "name": "David" }
@@ -77,6 +77,16 @@ end
 # => [ { "name": "David", "age": 32 }, { "name": "Jamie", "age": 31 } ]
 ```
 
+You can also extract attributes from array directly.
+
+``` ruby
+# @people = People.all
+json.array! @people, :id, :name
+
+# => [ { "id": 1, "name": "David" }, { "id": 2, "name": "Jamie" } ]
+```
+
+
 Jbuilder objects can be directly nested inside each other.  Useful for composing objects.
 
 ``` ruby
@@ -99,7 +109,7 @@ class Company
   end
 end
 
-company = Company.new("Doodle Corp", Person.new("John Stobs", 58))
+company = Company.new('Doodle Corp', Person.new('John Stobs', 58))
 company.to_builder.target!
 
 # => {"name":"Doodle Corp","president":{"name":"John Stobs","age":58}}
@@ -126,14 +136,28 @@ end
 # RAILS_ROOT/app/views/api/comments/_comments, and set a local variable
 # 'comments' with all this message's comments, which you can use inside
 # the partial.
-json.partial! "api/comments/comments", comments: @message.comments
+json.partial! 'api/comments/comments', comments: @message.comments
+```
+
+You can explicitly make Jbuilder object return null if you want:
+
+``` ruby
+json.extract! @post, :id, :title, :content, :published_at
+json.author do
+  if @post.anonymous?
+    json.null! # or json.nil!
+  else
+    json.first_name @post.author_first_name
+    json.last_name @post.author_last_name
+  end
+end
 ```
 
 Keys can be auto formatted using `key_format!`, this can be used to convert keynames from the standard ruby_format to CamelCase:
 
 ``` ruby
 json.key_format! :camelize => :lower
-json.first_name "David"
+json.first_name 'David'
 
 # => { "firstName": "David" }
 ```

data/jbuilder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name    = 'jbuilder'
-  s.version = '1.3.0'
+  s.version = '1.4.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

@@ -14,6 +14,12 @@ rescue LoadError
 end
 
 class Jbuilder < JbuilderProxy
+  class NullError < ::NoMethodError
+    def initialize(key)
+      super "Failed to add #{key.to_s.inspect} property to null object"
+    end
+  end
+
   class KeyFormatter
     def initialize(*args)
       @format = ::ActiveSupport::OrderedHash.new
@@ -52,7 +58,7 @@ class Jbuilder < JbuilderProxy
   @@key_formatter = KeyFormatter.new
   @@ignore_nil    = false
 
-  def initialize(*args)
+  def initialize(*args, &block)
     @attributes = ::ActiveSupport::OrderedHash.new
 
     options = args.extract_options!
@@ -67,14 +73,14 @@ class Jbuilder < JbuilderProxy
         'arguments is deprecated. Use hash syntax instead.'
     end
 
-    yield self if ::Kernel.block_given?
+    yield self if block
   end
 
   BLANK = ::Object.new
 
   def set!(key, value = BLANK, *args, &block)
 
-    result = if ::Kernel.block_given?
+    result = if block
       if BLANK != value
         # json.comments @post.comments { |comment| ... }
         # { "comments": [ { ... }, { ... } ] }
@@ -224,9 +230,11 @@ class Jbuilder < JbuilderProxy
   #   json.array! [1, 2, 3]
   #
   #   [1,2,3]
-  def array!(collection, &block)
-    @attributes = if ::Kernel::block_given?
+  def array!(collection, *attributes, &block)
+    @attributes = if block
       _map_collection(collection) { |element| block.arity == 2 ? block[self, element] : block[element] }
+    elsif attributes.any?
+      _map_collection(collection) { |element| extract! element, *attributes }
     else
       collection
     end
@@ -286,6 +294,7 @@ class Jbuilder < JbuilderProxy
   private
 
     def _set_value(key, value)
+      raise NullError, key if @attributes.nil?
       unless @ignore_nil && value.nil?
         @attributes[@key_formatter.format(key)] = value
       end

data/lib/jbuilder/jbuilder_template.rb

@@ -9,9 +9,9 @@ class JbuilderTemplate < Jbuilder
     when ::Hash
       options[:locals] ||= {}
       options[:locals].merge!(:json => self)
-      @context.render(options.reverse_merge(:formats => [:json]))
+      @context.render(options.reverse_merge(:handlers => [:jbuilder]))
     else # String
-      @context.render(:partial => options, :locals => locals.merge(:json => self), :formats => [:json])
+      @context.render(:partial => options, :locals => locals.merge(:json => self), :handlers => [:jbuilder])
     end
   end
 

data/test/jbuilder_test.rb

@@ -325,8 +325,9 @@ class JbuilderTest < ActiveSupport::TestCase
       end
     end
 
-    assert_equal 'David', MultiJson.load(json)[0]['names'].last
-    assert_not_equal 'hello', MultiJson.load(json)[0]['not_in_json']
+    parsed = MultiJson.load(json)
+    assert_equal 'David', parsed.first['names'].last
+    assert_not_equal 'hello', parsed.first['not_in_json']
   end
 
   test 'nested jbuilder objects' do
@@ -367,6 +368,20 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal 'world', parsed.second['content']
   end
 
+  test 'extract attributes directly from array' do
+    comments = [ Comment.new('hello', 1), Comment.new('world', 2) ]
+
+    json = Jbuilder.encode do |json|
+      json.array! comments, :content, :id
+    end
+
+    parsed = MultiJson.load(json)
+    assert_equal 'hello', parsed.first['content']
+    assert_equal       1, parsed.first['id']
+    assert_equal 'world', parsed.second['content']
+    assert_equal       2, parsed.second['id']
+  end
+
   test 'empty top-level array' do
     comments = []
 
@@ -585,4 +600,10 @@ class JbuilderTest < ActiveSupport::TestCase
     json.null!
     assert_nil json.attributes!
   end
+
+  test 'throws meaningfull error when on trying to add properties to null' do
+    json = Jbuilder.new
+    json.null!
+    assert_raise(Jbuilder::NullError) { json.foo 'bar' }
+  end
 end

metadata

@@ -1,57 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  prerelease: 
+  version: 1.4.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-11 00:00:00.000000000 Z
+date: 2013-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  prerelease: false
   name: activesupport
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-  type: :runtime
 - !ruby/object:Gem::Dependency
-  prerelease: false
   name: multi_json
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
-  type: :runtime
 - !ruby/object:Gem::Dependency
-  prerelease: false
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 10.0.3
-  requirement: !ruby/object:Gem::Requirement
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 10.0.3
-  type: :development
 description: 
 email: david@37signals.com
 executables: []
@@ -81,30 +88,30 @@ files:
 homepage: 
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Create JSON structures via a Builder-style DSL
 test_files:
 - test/jbuilder_generator_test.rb
 - test/jbuilder_template_test.rb
 - test/jbuilder_test.rb
 - test/scaffold_controller_generator_test.rb
-has_rdoc: 

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MmU0OWNkNDE0NGQzMWFiNmU2N2ZiOTY2NjA1MTk5ZDg3YTYyMmJiYQ==
-  data.tar.gz: !binary |-
-    N2Q5YjE3Mjk4ZThjZTU1NGQxY2QwZGQzZjJhOTliZTU3MDA2M2VmMQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MmYxNDMwNTAzZjI5ZDIzY2U1M2RjYjAxOTUwZDBiNzlmNjMyYTNkN2JhZWY3
-    OTE4NmQzMmVjZWE2YmJkYjg1NzEyNWYyYjcyMGQ1MDYxMDc1YzkxYmRlZjEw
-    ZDQwZDdhZjViYWQ2YmZkNDhiNTI1YzYwYjc3YjQ0NWE5ZTIyOTQ=
-  data.tar.gz: !binary |-
-    NDg5NmI2ZjhiN2UyYjU4MjhhZGRiNGYzZDU4ZjBkOWQ5NTVmYzhjYjQwZmIy
-    MzYxZmMzMWJmMTdkMjM2YzdhNjk0ZGJjMGNmMTBhYWQ5MDI3M2VlODczNWQ3
-    ODE2MWQzOWU5NTZkYjI0MmRhNTk2MDk5YTUyOWZkYzgwYzRjYWQ=