jbuilder 1.4.2 → 1.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MzM1MDNlYmI1ZTFkYWRiN2ViYmI4MjM5YTY1Yjk5ZGU3YjcyOGRmNw==
+    NGYyYTk2NWM1ZjkxN2Q1YWYxNmM1MWI2YWZhZWFlODY4YWJiNjZjYw==
   data.tar.gz: !binary |-
-    OTVlNmY0ODBmNGZmY2M4NGE2Zjc5NTYyN2M2MzQyYzA2NzY1YzQ3YQ==
+    ZGM3Mjg1NGYxODFjNGU4NGYwZWRkYmNkNTZmMjJjMmFjMzk3NTUxZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YWVkODM4Zjg5YTYxN2Y0NTJkMjA3N2JjMTFhN2U2ZmU0MWQ3NjlhMDFiMTk1
-    ODFkMmNmYmE4NTIzNDc1MGVkNzdkMTQzYjE4YmRhOWM0Y2IzZDQ5MGE2NWM0
-    MzA4OTYxOTYwNWFhNDJlYzkxZDIzNTcyNDQ1MzlkY2UxNjQzYTQ=
+    OGFkMmYzYWM0MjQ5OWM5ZmU4ZjU1ODBhZmVkMzQ3ZjRjNjg0YmE2N2VmY2Rm
+    M2YyNDIwY2FlZTNhMzBmNDk4MDljNGMxNWVkNzMwYTMyOTRiYTEwYzE2Mjc4
+    NjE0ODZlZTU2MjczZjgxMDg5ZTVmZmIxZWQ0OGQ1NTI5M2FhNmQ=
   data.tar.gz: !binary |-
-    MzgwMDcwNGFkMTI5OWI4YzE3NmQzMTUwZDk2Yzg0YmExYjE0NjEyZjE4ZWY0
-    NWIwOTBlN2NkZjk3NzI2ODNmZWY2ZGIwMmMzYWU0M2RmNTZjZTZhMmY4OWJm
-    MzNjYTgzZjUxNWE1NjI1YWE0OWMwMjZkZjdlZjVlOTczN2Q5ZTg=
+    ODc3OGEwYTkxMGFlNTdhODdmOGEzYWM1YzZiYTEyOTk5MjFmZjM4M2I5ZTU1
+    ZTU4Y2ViYTFhMTA1NzFmZGFlMTc5OTljYTk1OTA2MTk0MDVmOTVhZGYyMzZl
+    Y2Y1ZTlmOWU0OTQ2NTY1MmY1ODQ2YmY2YjdiYTEwYTA2NTYwYmE=

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
-before_install:
-  - gem install bundler
+
 rvm:
   - 1.8.7
   - 1.9.2
@@ -12,12 +11,14 @@ rvm:
   - jruby-19mode
   - rbx-18mode
   - rbx-19mode
+
 gemfile:
   - Gemfile
   - Gemfile.edge
+
 matrix:
   exclude:
-    # Edge Rails is only compatible with 1.9.3
+    # Edge Rails is only compatible with 1.9.3+
     - gemfile: Gemfile.edge
       rvm: 1.8.7
     - gemfile: Gemfile.edge
@@ -28,6 +29,10 @@ matrix:
       rvm: jruby-18mode
     - gemfile: Gemfile.edge
       rvm: rbx-18mode
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-18mode
+    - rvm: rbx-19mode
 
 notifications:
   email: false

data/Gemfile.edge

@@ -3,9 +3,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'mocha', require: false
-
-git 'git://github.com/rails/rails.git', branch: '4-0-stable' do
-  gem 'railties', require: 'rails/railtie'
-  gem 'actionpack'
-end
+gem 'railties',   '~> 4.0.0'
+gem 'actionpack', '~> 4.0.0'
+gem 'mocha', require: false

data/README.md

@@ -131,12 +131,30 @@ end
 if current_user.admin?
   json.visitors calculate_visitors(@message)
 end
+```
+
+
+You can use partials as well. The following will render the file
+`views/comments/_comments.json.jbuilder`, and set a local variable
+`comments` with all this message's comments, which you can use inside
+the partial.
+
+```ruby
+json.partial! 'comments/comments', comments: @message.comments
+```
+
+It's also possible to render collections of partials:
+
+```ruby
+json.array! @posts, partial: 'posts/post', as: :post
+
+# or
+
+json.partial! 'posts/post', collection: @posts, as: :post
+
+# or
 
-# You can use partials as well. The following line will render the file
-# RAILS_ROOT/app/views/api/comments/_comments.json.jbuilder, 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! partial: 'posts/post', collection: @posts, as: :post
 ```
 
 You can explicitly make Jbuilder object return null if you want:

data/jbuilder.gemspec

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

@@ -252,9 +252,9 @@ class Jbuilder < JbuilderProxy
   #   json.(@person, :name, :age)
   def extract!(object, *attributes)
     if ::Hash === object
-      attributes.each { |attribute| _set_value attribute, object.fetch(attribute) }
+      _extract_hash_values(object, *attributes)
     else
-      attributes.each { |attribute| _set_value attribute, object.send(attribute) }
+      _extract_method_values(object, *attributes)
     end
   end
 
@@ -285,6 +285,22 @@ class Jbuilder < JbuilderProxy
 
   private
 
+    def  _extract_hash_values(object, *attributes)
+      attributes.each{ |key| _set_value key, object.fetch(key) }
+    end
+
+    def _extract_method_values(object, *attributes)
+      attributes.each do |method_name|
+        unless object.respond_to?(method_name)
+          message = "Private method #{method_name.inspect} was used to " +
+            'extract value. This will be an error in future versions of Jbuilder'
+        end
+
+        _set_value method_name, object.send(method_name)
+        ::ActiveSupport::Deprecation.warn message if message
+      end
+    end
+
     def _set_value(key, value)
       raise NullError, key if @attributes.nil?
       unless @ignore_nil && value.nil?

data/lib/jbuilder/jbuilder_template.rb

@@ -6,14 +6,29 @@ class JbuilderTemplate < Jbuilder
     super(*args, &block)
   end
 
-  def partial!(options, locals = {})
-    case options
+  def partial!(name_or_options, locals = {})
+    case name_or_options
     when ::Hash
-      options[:locals] ||= {}
-      options[:locals].merge!(:json => self)
-      @context.render(options.reverse_merge(:handlers => [:jbuilder]))
-    else # String
-      @context.render(:partial => options, :locals => locals.merge(:json => self), :handlers => [:jbuilder])
+      # partial! partial: 'name', locals: { foo: 'bar' }
+      options = name_or_options
+    else
+      # partial! 'name', foo: 'bar'
+      options = { :partial => name_or_options, :locals => locals }
+      as = locals.delete(:as)
+      options[:as] = as if as.present?
+      options[:collection] = locals[:collection]
+    end
+
+    _handle_partial_options options
+  end
+
+  def array!(collection, *attributes, &block)
+    options = attributes.extract_options!
+
+    if options.key?(:partial)
+      partial! options[:partial], options.merge(:collection => collection)
+    else
+      super
     end
   end
 
@@ -26,15 +41,38 @@ class JbuilderTemplate < Jbuilder
   #     json.extract! @person, :name, :age
   #   end
   def cache!(key=nil, options={}, &block)
-    options[:force] = true unless @context.controller.perform_caching
-    value = ::Rails.cache.fetch(_cache_key(key), options) do
-      _scope { yield self }
-    end
+    if @context.controller.perform_caching
+      value = ::Rails.cache.fetch(_cache_key(key), options) do
+        _scope { yield self }
+      end
 
-    _merge(value)
+      _merge(value)
+    else
+      yield
+    end
   end
 
   protected
+    def _handle_partial_options(options)
+      options.reverse_merge!(:locals => {}, :handlers => [:jbuilder])
+      collection = options.delete(:collection)
+      as = options[:as]
+
+      if collection && as
+        array!(collection) do |member|
+          options[:locals].merge!(as => member, :collection => collection)
+          _render_partial options
+        end
+      else
+        _render_partial options
+      end
+    end
+
+    def _render_partial(options)
+      options[:locals].merge!(:json => self)
+      @context.render options
+    end
+
     def _cache_key(key)
       if @context.respond_to?(:cache_fragment_name)
         # Current compatibility, fragment_name_with_digest is private again and cache_fragment_name

data/test/jbuilder_template_test.rb

@@ -5,6 +5,20 @@ require 'action_view/testing/resolvers'
 require 'active_support/cache'
 require 'jbuilder'
 
+
+BLOG_POST_PARTIAL = <<-JBUILDER
+  json.extract! blog_post, :id, :body
+  json.author do
+    name = blog_post.author_name.split(nil, 2)
+    json.first_name name[0]
+    json.last_name  name[1]
+  end
+JBUILDER
+
+BlogPost = Struct.new(:id, :body, :author_name)
+blog_authors = [ 'David Heinemeier Hansson', 'Pavel Pravosud' ].cycle
+BLOG_POST_COLLECTION = 10.times.map{ |i| BlogPost.new(i+1, "post body #{i+1}", blog_authors.next) }
+
 module Rails
   def self.cache
     @cache ||= ActiveSupport::Cache::MemoryStore.new
@@ -18,7 +32,10 @@ class JbuilderTemplateTest < ActionView::TestCase
   end
 
   def partials
-    { '_partial.json.jbuilder' => 'json.content "hello"' }
+    {
+      '_partial.json.jbuilder'  => 'json.content "hello"',
+      '_blog_post.json.jbuilder' => BLOG_POST_PARTIAL
+    }
   end
 
   def render_jbuilder(source)
@@ -35,6 +52,16 @@ class JbuilderTemplateTest < ActionView::TestCase
     end
   end
 
+  def assert_collection_rendered(json)
+    result = MultiJson.load(json)
+
+    assert_equal 10, result.length
+    assert_equal Array, result.class
+    assert_equal 'post body 5',        result[4]['body']
+    assert_equal 'Heinemeier Hansson', result[2]['author']['last_name']
+    assert_equal 'Pavel',              result[5]['author']['first_name']
+  end
+
   test 'rendering' do
     json = render_jbuilder <<-JBUILDER
       json.content 'hello'
@@ -74,6 +101,30 @@ class JbuilderTemplateTest < ActionView::TestCase
     assert_equal 'hello', MultiJson.load(json)['content']
   end
 
+  test 'partial! renders collections' do
+    json = render_jbuilder <<-JBUILDER
+      json.partial! 'blog_post', :collection => BLOG_POST_COLLECTION, :as => :blog_post
+    JBUILDER
+
+    assert_collection_rendered json
+  end
+
+  test 'partial! renders collection (alt. syntax)' do
+    json = render_jbuilder <<-JBUILDER
+      json.partial! :partial => 'blog_post', :collection => BLOG_POST_COLLECTION, :as => :blog_post
+    JBUILDER
+
+    assert_collection_rendered json
+  end
+
+  test 'render array of partials' do
+    json = render_jbuilder <<-JBUILDER
+      json.array! BLOG_POST_COLLECTION, :partial => 'blog_post', :as => :blog_post
+    JBUILDER
+
+    assert_collection_rendered json
+  end
+
   test 'fragment caching a JSON object' do
     undef_context_methods :fragment_name_with_digest, :cache_fragment_name
 
@@ -136,6 +187,17 @@ class JbuilderTemplateTest < ActionView::TestCase
     JBUILDER
   end
 
+  test 'does not perform caching when controller.perform_caching is false' do
+    controller.perform_caching = false
+    render_jbuilder <<-JBUILDER
+      json.cache! 'cachekey' do
+        json.name 'Cache'
+      end
+    JBUILDER
+
+    assert_equal Rails.cache.inspect[/entries=(\d+)/, 1], '0'
+  end
+
   test 'fragment caching falls back on ActiveSupport::Cache.expand_cache_key' do
     undef_context_methods :fragment_name_with_digest, :cache_fragment_name
 

data/test/jbuilder_test.rb

@@ -5,12 +5,14 @@ require 'jbuilder'
 
 Comment = Struct.new(:content, :id)
 
-class JbuilderProxy
-  # Faking Object#instance_eval for 1.8
-  def instance_eval(code)
-    eval code
+unless JbuilderProxy.method_defined? :instance_eval
+  # Faking Object#instance_eval for 1.8 and some newer JRubies
+  class JbuilderProxy
+    def instance_eval(code)
+      eval code
+    end
   end
-end if ::RUBY_VERSION < '1.9'
+end
 
 class NonEnumerable
   def initialize(collection)
@@ -71,6 +73,23 @@ class JbuilderTest < ActiveSupport::TestCase
     assert_equal 32, parsed['age']
   end
 
+  test 'extracting from object using private method' do
+    person = Struct.new(:name) do
+      private
+      def age
+        32
+      end
+    end.new('David')
+
+    message = 'Private method :age was used to extract value. This will be' +
+      ' an error in future versions of Jbuilder'
+
+    ::ActiveSupport::Deprecation.expects(:warn).with(message)
+    json = Jbuilder.encode do |json|
+      json.extract! person, :name, :age
+    end
+  end
+
   test 'extracting from object using call style for 1.9' do
     person = Struct.new(:name, :age).new('David', 32)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-05 00:00:00.000000000 Z
+date: 2013-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -16,28 +16,28 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
+  type: :runtime
+  prerelease: false
+  name: activesupport
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-  type: :runtime
-  prerelease: false
-  name: activesupport
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
+  type: :runtime
+  prerelease: false
+  name: multi_json
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
-  type: :runtime
-  prerelease: false
-  name: multi_json
 description: 
 email: david@37signals.com
 executables: []
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Create JSON structures via a Builder-style DSL