jbuilder 2.6.0 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d949cb2167336c8e5b026626493bb07843dab242
-  data.tar.gz: 1c0a6e23cb4441794732665e5fa2ef73a63eae0d
+  metadata.gz: c4b4939ae1d814cadb9d44ab80a4489d59b4c8a5
+  data.tar.gz: ae232631e1f37a815ae5e46cb45c88706c803da8
 SHA512:
-  metadata.gz: bd78d3b8d0fa94ead3c7a77c7769593f2202ec46d18f3a2d3ba875f35a72040bd0e519bfd6e67b60fea465fbef8ffaf8966d964e02538eb8479c52011a5c24a1
-  data.tar.gz: dc257849862f9619da61c740ab9596026b1e2d9cdf0b3b8aa7eee7ab23eef1912fc00ec49eb6c6a3cd888161104929ff851ddbabb1358d655dc947003f6222cc
+  metadata.gz: b0e4fb3d778a25514a6b82f6bdca2519690fe85719a902ec95c72ae5f7016f796e7567ca847cc369752077525d47f38344edff9f97d03a3a9dbe47b195c88d39
+  data.tar.gz: 24e1713528b9d0bfaa2d90c32f1432440c58acb7e6619c75d1956d23c041ef66672162dc97888af8f7558cd17024f33234102a285001a3188ba97bf39e6fd5ef

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+2.6.1
+-----
+
+* [Optimize root caches with cache_root!][https://github.com/rails/jbuilder/pull/370]
+
 2.6.0
 -----
 

data/CONTRIBUTING.md

@@ -39,7 +39,8 @@ Ensure that you can build the project and run tests.
 
 ```
 bundle install
-bundle exec rake test
+appraisal install
+appraisal rake test
 ```
 
 #### Write Tests
@@ -52,7 +53,7 @@ We definitely appreciate pull requests that highlight or reproduce a problem, ev
 
 Implement your feature or bug fix.
 
-Make sure that `bundle exec rake test` completes without errors.
+Make sure that `appraisal rake test` completes without errors.
 
 #### Write Documentation
 
@@ -82,7 +83,7 @@ git push origin my-feature-branch
 
 #### Make a Pull Request
 
-Go to https://github.com/contributor/jbuilder and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+Visit your forked repo and click the 'New pull request' button. Select your feature branch, fill out the form, and click the 'Create pull request' button. Pull requests are usually reviewed within a few days.
 
 #### Rebase
 
@@ -100,7 +101,7 @@ Go back to your pull request after a few minutes and see whether it passed muste
 
 #### Be Patient
 
-It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang in there!
 
 #### Thank You
 

data/README.md

@@ -1,7 +1,7 @@
 # Jbuilder
 
 Jbuilder gives you a simple DSL for declaring JSON structures that beats
-massaging giant hash structures. This is particularly helpful when the
+manipulating giant hash structures. This is particularly helpful when the
 generation process is fraught with conditionals and loops. Here's a simple
 example:
 

data/gemfiles/rails_5_0.gemfile

@@ -6,8 +6,8 @@ gem "rake"
 gem "mocha", :require => false
 gem "appraisal"
 gem "pry"
-gem "railties", ">= 5.0.0.beta2", "< 5.1"
-gem "actionpack", ">= 5.0.0.beta2", "< 5.1"
-gem "activemodel", ">= 5.0.0.beta2", "< 5.1"
+gem "railties", "~> 5.0.0"
+gem "actionpack", "~> 5.0.0"
+gem "activemodel", "~> 5.0.0"
 
 gemspec :path => "../"

data/jbuilder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = 'jbuilder'
-  s.version  = '2.6.0'
+  s.version  = '2.6.1'
   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/jbuilder_template.rb

@@ -42,6 +42,27 @@ class JbuilderTemplate < Jbuilder
     end
   end
 
+  # Caches the json structure at the root using a string rather than the hash structure. This is considerably
+  # faster, but the drawback is that it only works, as the name hints, at the root. So you cannot
+  # use this approach to cache deeper inside the hierarchy, like in partials or such. Continue to use #cache! there.
+  #
+  # Example:
+  #
+  #   json.cache_root! @person do
+  #     json.extract! @person, :name, :age
+  #   end
+  #
+  #   # json.extra 'This will not work either, the root must be exclusive'
+  def cache_root!(key=nil, options={})
+    if @context.controller.perform_caching
+      raise "cache_root! can't be used after JSON structures have been defined" if @attributes.present?
+
+      @cached_root = _cache_fragment_for([ :root, key ], options) { yield; target! }
+    else
+      yield
+    end
+  end
+
   # Conditionally caches the json depending in the condition given as first parameter. Has the same
   # signature as the `cache` helper method in `ActionView::Helpers::CacheHelper` and so can be used in
   # the same way.
@@ -55,6 +76,10 @@ class JbuilderTemplate < Jbuilder
     condition ? cache!(*args, &::Proc.new) : yield
   end
 
+  def target!
+    @cached_root || super
+  end
+
   def array!(collection = [], *args)
     options = args.first
 

data/lib/jbuilder/key_formatter.rb

@@ -11,8 +11,8 @@ class Jbuilder
       args.each do |name|
         @format[name] = []
       end
-      options.each do |name, paramaters|
-        @format[name] = paramaters
+      options.each do |name, parameters|
+        @format[name] = parameters
       end
     end
 

data/test/jbuilder_generator_test.rb

@@ -21,16 +21,16 @@ class JbuilderGeneratorTest < Rails::Generators::TestCase
     run_generator
 
     assert_file 'app/views/posts/index.json.jbuilder' do |content|
-      assert_match /json.array! @posts, partial: 'posts\/post', as: :post/, content
+      assert_match %r{json.array! @posts, partial: 'posts/post', as: :post}, content
     end
 
     assert_file 'app/views/posts/show.json.jbuilder' do |content|
-      assert_match /json.partial! \"posts\/post\", post: @post/, content
+      assert_match %r{json.partial! \"posts/post\", post: @post}, content
     end
     
     assert_file 'app/views/posts/_post.json.jbuilder' do |content|            
-      assert_match /json\.extract! post, :id, :title, :body/, content
-      assert_match /json\.url post_url\(post, format: :json\)/, content
+      assert_match %r{json\.extract! post, :id, :title, :body}, content
+      assert_match %r{json\.url post_url\(post, format: :json\)}, content
     end
     
 

data/test/jbuilder_template_test.rb

@@ -386,6 +386,35 @@ class JbuilderTemplateTest < ActionView::TestCase
     JBUILDER
   end
 
+  test "caching root structure" do
+    undef_context_methods :fragment_name_with_digest, :cache_fragment_name
+
+    cache_miss_result = jbuild <<-JBUILDER
+      json.cache_root! "cachekey" do
+        json.name "Miss"
+      end
+    JBUILDER
+
+    cache_hit_result = jbuild <<-JBUILDER
+      json.cache_root! "cachekey" do
+        json.name "Hit"
+      end
+    JBUILDER
+
+    assert_equal cache_miss_result, cache_hit_result
+  end
+
+  test "failing to cache root after attributes have been defined" do
+    assert_raises ActionView::Template::Error, "cache_root! can't be used after JSON structures have been defined" do
+      jbuild <<-JBUILDER
+        json.name "Kaboom"
+        json.cache_root! "cachekey" do
+          json.name "Miss"
+        end
+      JBUILDER
+    end
+  end
+
   test "does not perform caching when controller.perform_caching is false" do
     controller.perform_caching = false
 

data/test/scaffold_api_controller_generator_test.rb

@@ -15,7 +15,7 @@ if Rails::VERSION::MAJOR > 4
 
       assert_file 'app/controllers/posts_controller.rb' do |content|
         assert_instance_method :index, content do |m|
-          assert_match /@posts = Post\.all/, m
+          assert_match %r{@posts = Post\.all}, m
         end
 
         assert_instance_method :show, content do |m|
@@ -23,23 +23,23 @@ if Rails::VERSION::MAJOR > 4
         end
 
         assert_instance_method :create, content do |m|
-          assert_match /@post = Post\.new\(post_params\)/, m
-          assert_match /@post\.save/, m
-          assert_match /render :show, status: :created, location: @post/, m
-          assert_match /render json: @post\.errors, status: :unprocessable_entity/, m
+          assert_match %r{@post = Post\.new\(post_params\)}, m
+          assert_match %r{@post\.save}, m
+          assert_match %r{render :show, status: :created, location: @post}, m
+          assert_match %r{render json: @post\.errors, status: :unprocessable_entity}, m
         end
 
         assert_instance_method :update, content do |m|
-          assert_match /render :show, status: :ok, location: @post/, m
-          assert_match /render json: @post.errors, status: :unprocessable_entity/, m
+          assert_match %r{render :show, status: :ok, location: @post}, m
+          assert_match %r{render json: @post.errors, status: :unprocessable_entity}, m
         end
 
         assert_instance_method :destroy, content do |m|
-          assert_match /@post\.destroy/, m
+          assert_match %r{@post\.destroy}, m
         end
 
-        assert_match(/def post_params/, content)
-        assert_match(/params\.require\(:post\)\.permit\(:title, :body\)/, content)
+        assert_match %r{def post_params}, content
+        assert_match %r{params\.require\(:post\)\.permit\(:title, :body\)}, content
       end
     end
 
@@ -47,8 +47,8 @@ if Rails::VERSION::MAJOR > 4
       run_generator %w(Post --api)
 
       assert_file 'app/controllers/posts_controller.rb' do |content|
-        assert_match(/def post_params/, content)
-        assert_match(/params\.fetch\(:post, {}\)/, content)
+        assert_match %r{def post_params}, content
+        assert_match %r{params\.fetch\(:post, \{\}\)}, content
       end
     end
   end

data/test/scaffold_controller_generator_test.rb

@@ -13,7 +13,7 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
 
     assert_file 'app/controllers/posts_controller.rb' do |content|
       assert_instance_method :index, content do |m|
-        assert_match /@posts = Post\.all/, m
+        assert_match %r{@posts = Post\.all}, m
       end
 
       assert_instance_method :show, content do |m|
@@ -21,7 +21,7 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
       end
 
       assert_instance_method :new, content do |m|
-        assert_match /@post = Post\.new/, m
+        assert_match %r{@post = Post\.new}, m
       end
 
       assert_instance_method :edit, content do |m|
@@ -29,29 +29,29 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
       end
 
       assert_instance_method :create, content do |m|
-        assert_match /@post = Post\.new\(post_params\)/, m
-        assert_match /@post\.save/, m
-        assert_match /format\.html \{ redirect_to @post, notice: 'Post was successfully created\.' \}/, m
-        assert_match /format\.json \{ render :show, status: :created, location: @post \}/, m
-        assert_match /format\.html \{ render :new \}/, m
-        assert_match /format\.json \{ render json: @post\.errors, status: :unprocessable_entity \}/, m
+        assert_match %r{@post = Post\.new\(post_params\)}, m
+        assert_match %r{@post\.save}, m
+        assert_match %r{format\.html \{ redirect_to @post, notice: 'Post was successfully created\.' \}}, m
+        assert_match %r{format\.json \{ render :show, status: :created, location: @post \}}, m
+        assert_match %r{format\.html \{ render :new \}}, m
+        assert_match %r{format\.json \{ render json: @post\.errors, status: :unprocessable_entity \}}, m
       end
 
       assert_instance_method :update, content do |m|
-        assert_match /format\.html \{ redirect_to @post, notice: 'Post was successfully updated\.' \}/, m
-        assert_match /format\.json \{ render :show, status: :ok, location: @post \}/, m
-        assert_match /format\.html \{ render :edit \}/, m
-        assert_match /format\.json \{ render json: @post.errors, status: :unprocessable_entity \}/, m
+        assert_match %r{format\.html \{ redirect_to @post, notice: 'Post was successfully updated\.' \}}, m
+        assert_match %r{format\.json \{ render :show, status: :ok, location: @post \}}, m
+        assert_match %r{format\.html \{ render :edit \}}, m
+        assert_match %r{format\.json \{ render json: @post.errors, status: :unprocessable_entity \}}, m
       end
 
       assert_instance_method :destroy, content do |m|
-        assert_match /@post\.destroy/, m
-        assert_match /format\.html \{ redirect_to posts_url, notice: 'Post was successfully destroyed\.' \}/, m
-        assert_match /format\.json \{ head :no_content \}/, m
+        assert_match %r{@post\.destroy}, m
+        assert_match %r{format\.html \{ redirect_to posts_url, notice: 'Post was successfully destroyed\.' \}}, m
+        assert_match %r{format\.json \{ head :no_content \}}, m
       end
 
-      assert_match(/def post_params/, content)
-      assert_match(/params\.require\(:post\)\.permit\(:title, :body\)/, content)
+      assert_match %r{def post_params}, content
+      assert_match %r{params\.require\(:post\)\.permit\(:title, :body\)}, content
     end
   end
 
@@ -59,8 +59,8 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
     run_generator %w(Post)
 
     assert_file 'app/controllers/posts_controller.rb' do |content|
-      assert_match(/def post_params/, content)
-      assert_match(/params\.fetch\(:post, {}\)/, content)
+      assert_match %r{def post_params}, content
+      assert_match %r{params\.fetch\(:post, \{\}\)}, content
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.1
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Create JSON structures via a Builder-style DSL