jbuilder 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ac35e89f1be991b27877ffd514d8491719d0f01
-  data.tar.gz: 317b4e79d56b2ec63b0a0248a5b26d2505581ca8
+  metadata.gz: c6836a60ee9c7dd9709201026f7a6b472cc2019e
+  data.tar.gz: 4a8069c61889a929e3ffa10b3d46b799399202a0
 SHA512:
-  metadata.gz: 7207a0e288405e46fe0ff0469dde77087d07037f5a2a24541a046b947d1499ccff4ea3ab2e942794a4c1dd80995452531f77078c9b8a51305f819949a6d40a63
-  data.tar.gz: 5607ad86e9171df3e826ec12f1dbc63b10fff2215cf34ea9f55ff4c50a99a5376a61648b306aa0daf7bf5040fd2db7938a63c2f35ed0d471b918b99983f307a9
+  metadata.gz: 774ae98b86547a5fd8261a3452e5ceb188924b9e84cf52d7c1f9c6e5f7ebfe6fb93816ef04b9f5f2aeb1f65d2136ed4d13b466957bd0cf65b3ead3a80515856f
+  data.tar.gz: 4aeb49c248572ceedfac7fab0bfc3d763607ead19be5dda7362d93e1bd87ddb0a1ea8b47f846747c61afb13b358c7ddc772e8d22542863ddbb948a0781fc61dd

data/.gitignore

@@ -1,3 +1,4 @@
 tmp
+gemfiles/*.lock
 Gemfile.lock
 .ruby-version

data/.travis.yml

@@ -18,6 +18,7 @@ matrix:
   allow_failures:
     - rvm: jruby-19mode
     - rvm: rbx
+  fast_finish: true
 
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+2.0.8
+-----
+* [Eliminate circular dependencies](https://github.com/rails/jbuilder/commit/0879484dc74e7be93b695f66e3708ba48cdb1be3)
+* [Support cache key generation for complex objects](https://github.com/rails/jbuilder/commit/ca9622cca30c1112dd4408fcb2e658849abe1dd5)
+* [Remove JbuilderProxy class](https://github.com/rails/jbuilder/commit/5877482fc7da3224e42d4f72a1386f7a3a08173b)
+* [Move KeyFormatter into a separate file](https://github.com/rails/jbuilder/commit/13fee8464ff53ce853030114283c03c135c052b6)
+* [Move NullError into a separate file](https://github.com/rails/jbuilder/commit/13fee8464ff53ce853030114283c03c135c052b6)
+
 2.0.7
 -----
 * [Add destroy notice to scaffold generator](https://github.com/rails/jbuilder/commit/8448e86f8cdfa0f517bd59576947875775a1d43c)

data/README.md

@@ -1,6 +1,6 @@
 # Jbuilder
 
-[![Build Status](http://img.shields.io/travis/rails/jbuilder.svg)][travis]
+[![Build Status](https://api.travis-ci.org/rails/jbuilder.svg)][travis]
 [![Gem Version](http://img.shields.io/gem/v/jbuilder.svg)][gem]
 [![Code Climate](http://img.shields.io/codeclimate/github/rails/jbuilder.svg)][codeclimate]
 [![Dependencies Status](http://img.shields.io/gemnasium/rails/jbuilder.svg)][gemnasium]
@@ -205,6 +205,10 @@ json.cache_if! !admin?, ['v1', @person], expires_in: 10.minutes do
 end
 ```
 
+If you are rendering fragments for a collection of objects, have a look at
+`jbuilder_cache_multi` gem. It uses fetch_multi (>= Rails 4.1) to fetch
+multiple keys at once.
+
 Keys can be auto formatted using `key_format!`, this can be used to convert
 keynames from the standard ruby_format to camelCase:
 

data/jbuilder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = 'jbuilder'
-  s.version  = '2.0.7'
+  s.version  = '2.0.8'
   s.authors  = ['David Heinemeier Hansson', 'Pavel Pravosud']
   s.email    = ['david@37signals.com', 'pavel@pravosud.com']
   s.summary  = 'Create JSON structures via a Builder-style DSL'

data/lib/jbuilder.rb

@@ -1,58 +1,9 @@
-require 'active_support/core_ext/array/access'
-require 'active_support/core_ext/enumerable'
-require 'active_support/core_ext/hash'
+require 'jbuilder/jbuilder'
+require 'jbuilder/key_formatter'
+require 'jbuilder/errors'
 require 'multi_json'
 
-begin
-  require 'active_support/proxy_object'
-  JbuilderProxy = ActiveSupport::ProxyObject
-rescue LoadError
-  require 'active_support/basic_object'
-  JbuilderProxy = ActiveSupport::BasicObject
-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 = {}
-      @cache = {}
-
-      options = args.extract_options!
-      args.each do |name|
-        @format[name] = []
-      end
-      options.each do |name, paramaters|
-        @format[name] = paramaters
-      end
-    end
-
-    def initialize_copy(original)
-      @cache = {}
-    end
-
-    def format(key)
-      @cache[key] ||= @format.inject(key.to_s) do |result, args|
-        func, args = args
-        if ::Proc === func
-          func.call result, *args
-        else
-          result.send func, *args
-        end
-      end
-    end
-  end
-
-  # Yields a builder and automatically turns the result into a JSON string
-  def self.encode(*args, &block)
-    new(*args, &block).target!
-  end
-
+class Jbuilder
   @@key_formatter = KeyFormatter.new
   @@ignore_nil    = false
 
@@ -61,13 +12,18 @@ class Jbuilder < JbuilderProxy
 
     @key_formatter = options.fetch(:key_formatter){ @@key_formatter.clone }
     @ignore_nil = options.fetch(:ignore_nil, @@ignore_nil)
+
     yield self if block
   end
 
+  # Yields a builder and automatically turns the result into a JSON string
+  def self.encode(*args, &block)
+    new(*args, &block).target!
+  end
+
   BLANK = ::Object.new
 
   def set!(key, value = BLANK, *args, &block)
-
     result = if block
       if BLANK != value
         # json.comments @post.comments { |comment| ... }
@@ -76,7 +32,7 @@ class Jbuilder < JbuilderProxy
       else
         # json.comments { ... }
         # { "comments": ... }
-        _scope { yield self }
+        _scope{ yield self }
       end
     elsif args.empty?
       if ::Jbuilder === value
@@ -96,7 +52,7 @@ class Jbuilder < JbuilderProxy
     else
       # json.author @post.creator, :name, :email_address
       # { "author": { "name": "David", "email_address": "david@loudthinking.com" } }
-      _scope { extract! value, *args }
+      _scope{ extract! value, *args }
     end
 
     _set_value key, result
@@ -105,7 +61,6 @@ class Jbuilder < JbuilderProxy
   alias_method :method_missing, :set!
   private :method_missing
 
-
   # Specifies formatting to be applied to the key. Passing in a name of a function
   # will cause that function to be called on the key.  So :upcase will upper case
   # the key.  You can also pass in lambdas for more complex transformations.
@@ -185,7 +140,7 @@ class Jbuilder < JbuilderProxy
   #   end
   def child!
     @attributes = [] unless ::Array === @attributes
-    @attributes << _scope { yield self }
+    @attributes << _scope{ yield self }
   end
 
   # Turns the current element into an array and iterates over the passed collection, adding each iteration as
@@ -290,41 +245,42 @@ class Jbuilder < JbuilderProxy
 
   private
 
-    def _extract_hash_values(object, *attributes)
-      attributes.each{ |key| _set_value key, object.fetch(key) }
-    end
+  def _extract_hash_values(object, *attributes)
+    attributes.each{ |key| _set_value key, object.fetch(key) }
+  end
 
-    def _extract_method_values(object, *attributes)
-      attributes.each{ |key| _set_value key, object.public_send(key) }
-    end
+  def _extract_method_values(object, *attributes)
+    attributes.each{ |key| _set_value key, object.public_send(key) }
+  end
 
-    def _set_value(key, value)
-      raise NullError, key if @attributes.nil?
-      unless @ignore_nil && value.nil?
-        @attributes[@key_formatter.format(key)] = value
-      end
-    end
+  def _set_value(key, value)
+    raise NullError.build(key) if @attributes.nil?
+    return if @ignore_nil && value.nil?
 
-    def _map_collection(collection)
-      return [] if collection.nil?
+    key = @key_formatter.format(key)
+    @attributes[key] = value
+  end
 
-      collection.map do |element|
-        _scope { yield element }
-      end
-    end
+  def _map_collection(collection)
+    return [] if collection.nil?
 
-    def _scope
-      parent_attributes, parent_formatter = @attributes, @key_formatter
-      @attributes = {}
-      yield
-      @attributes
-    ensure
-      @attributes, @key_formatter = parent_attributes, parent_formatter
+    collection.map do |element|
+      _scope{ yield element }
     end
+  end
 
-    def _mapable_arguments?(value, *args)
-      value.respond_to?(:map)
-    end
+  def _scope
+    parent_attributes, parent_formatter = @attributes, @key_formatter
+    @attributes = {}
+    yield
+    @attributes
+  ensure
+    @attributes, @key_formatter = parent_attributes, parent_formatter
+  end
+
+  def _mapable_arguments?(value, *args)
+    value.respond_to?(:map)
+  end
 end
 
 require 'jbuilder/jbuilder_template' if defined?(ActionView::Template)

data/lib/jbuilder/dependency_tracker.rb

@@ -1,4 +1,4 @@
-require 'jbuilder'
+require 'jbuilder/jbuilder'
 
 dependency_tracker = false
 

data/lib/jbuilder/errors.rb

@@ -0,0 +1,10 @@
+require 'jbuilder/jbuilder'
+
+class Jbuilder
+  class NullError < ::NoMethodError
+    def self.build(key)
+      message = "Failed to add #{key.to_s.inspect} property to null object"
+      new(message)
+    end
+  end
+end

data/lib/jbuilder/jbuilder.rb

@@ -0,0 +1,7 @@
+Jbuilder = Class.new(begin
+  require 'active_support/proxy_object'
+  ActiveSupport::ProxyObject
+rescue LoadError
+  require 'active_support/basic_object'
+  ActiveSupport::BasicObject
+end)

data/lib/jbuilder/jbuilder_template.rb

@@ -1,4 +1,4 @@
-require 'jbuilder'
+require 'jbuilder/jbuilder'
 require 'action_dispatch/http/mime_type'
 require 'active_support/cache'
 
@@ -74,48 +74,55 @@ class JbuilderTemplate < Jbuilder
   end
 
   protected
-    def _handle_partial_options(options)
-      options.reverse_merge! locals: {}
-      options.reverse_merge! ::JbuilderTemplate.template_lookup_options
-      as = options[:as]
-
-      if as && options.key?(:collection)
-        collection = options.delete(:collection) || []
-        array!(collection) do |member|
-          options[:locals].merge! as => member
-          options[:locals].merge! collection: collection
-          _render_partial options
-        end
-      else
+
+  def _handle_partial_options(options)
+    options.reverse_merge! locals: {}
+    options.reverse_merge! ::JbuilderTemplate.template_lookup_options
+    as = options[:as]
+
+    if as && options.key?(:collection)
+      collection = options.delete(:collection) || []
+      array!(collection) do |member|
+        options[:locals].merge! as => member
+        options[:locals].merge! 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 _render_partial(options)
+    options[:locals].merge! json: self
+    @context.render options
+  end
 
-    def _cache_key(key, options)
-      if @context.respond_to?(:cache_fragment_name)
-        # Current compatibility, fragment_name_with_digest is private again and cache_fragment_name
-        # should be used instead.
-        @context.cache_fragment_name(key, options)
-      elsif @context.respond_to?(:fragment_name_with_digest)
-        # Backwards compatibility for period of time when fragment_name_with_digest was made public.
-        @context.fragment_name_with_digest(key)
-      else
-        ::ActiveSupport::Cache.expand_cache_key(key.is_a?(::Hash) ? url_for(key).split('://').last : key, :jbuilder)
-      end
-    end
+  def _cache_key(key, options)
+    key = _fragment_name_with_digest(key, options)
+    key = url_for(key).split('://', 2).last if ::Hash === key
+    ::ActiveSupport::Cache.expand_cache_key(key, :jbuilder)
+  end
 
   private
 
-    def _mapable_arguments?(value, *args)
-      return true if super
-      options = args.last
-      ::Hash === options && options.key?(:as)
+  def _fragment_name_with_digest(key, options)
+    if @context.respond_to?(:cache_fragment_name)
+      # Current compatibility, fragment_name_with_digest is private again and cache_fragment_name
+      # should be used instead.
+      @context.cache_fragment_name(key, options)
+    elsif @context.respond_to?(:fragment_name_with_digest)
+      # Backwards compatibility for period of time when fragment_name_with_digest was made public.
+      @context.fragment_name_with_digest(key)
+    else
+      key
     end
+  end
+
+  def _mapable_arguments?(value, *args)
+    return true if super
+    options = args.last
+    ::Hash === options && options.key?(:as)
+  end
 end
 
 class JbuilderHandler

data/lib/jbuilder/key_formatter.rb

@@ -0,0 +1,34 @@
+require 'jbuilder/jbuilder'
+require 'active_support/core_ext/array'
+
+class Jbuilder
+  class KeyFormatter
+    def initialize(*args)
+      @format = {}
+      @cache = {}
+
+      options = args.extract_options!
+      args.each do |name|
+        @format[name] = []
+      end
+      options.each do |name, paramaters|
+        @format[name] = paramaters
+      end
+    end
+
+    def initialize_copy(original)
+      @cache = {}
+    end
+
+    def format(key)
+      @cache[key] ||= @format.inject(key.to_s) do |result, args|
+        func, args = args
+        if ::Proc === func
+          func.call result, *args
+        else
+          result.send func, *args
+        end
+      end
+    end
+  end
+end

data/lib/jbuilder/proxy.rb

@@ -0,0 +1,7 @@
+Jbuilder = Class.new(begin
+  require 'active_support/proxy_object'
+  ActiveSupport::ProxyObject)
+rescue LoadError
+  require 'active_support/basic_object'
+  ActiveSupport::BasicObject)
+end)

data/test/jbuilder_template_test.rb

@@ -216,18 +216,18 @@ class JbuilderTemplateTest < ActionView::TestCase
 
     render_jbuilder <<-JBUILDER
       json.cache! 'cachekey' do
-        json.array! %w(a b c)
+        json.array! %w[a b c]
       end
     JBUILDER
 
     json = render_jbuilder <<-JBUILDER
       json.cache! 'cachekey' do
-        json.array! %w(1 2 3)
+        json.array! %w[1 2 3]
       end
     JBUILDER
 
     parsed = MultiJson.load(json)
-    assert_equal %w(a b c), parsed
+    assert_equal %w[a b c], parsed
   end
 
   test 'fragment caching works with previous version of cache digests' do
@@ -246,6 +246,7 @@ class JbuilderTemplateTest < ActionView::TestCase
     undef_context_methods :fragment_name_with_digest
 
     @context.expects :cache_fragment_name
+    ActiveSupport::Cache.expects :expand_cache_key
 
     render_jbuilder <<-JBUILDER
       json.cache! 'cachekey' do
@@ -258,6 +259,7 @@ class JbuilderTemplateTest < ActionView::TestCase
     undef_context_methods :fragment_name_with_digest
 
     @context.expects(:cache_fragment_name).with('cachekey', skip_digest: true)
+    ActiveSupport::Cache.expects :expand_cache_key
 
     render_jbuilder <<-JBUILDER
       json.cache! 'cachekey', skip_digest: true do
@@ -277,16 +279,4 @@ class JbuilderTemplateTest < ActionView::TestCase
     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
-
-    ActiveSupport::Cache.expects :expand_cache_key
-
-    render_jbuilder <<-JBUILDER
-      json.cache! 'cachekey' do
-        json.name 'Cache'
-      end
-    JBUILDER
-  end
-
 end