jbuilder_reopen 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5446874dfdda2493ac6fb23c20412fde4268761754ffec2e6a95fabb4bc7862
+  data.tar.gz: 5297ce54a75bbcfacfc1b0d237bf164e397045b573a6bc5708358cfeabb7b561
+SHA512:
+  metadata.gz: cbf407e0c17497c433e3ebc80083eeb7481c545f41d7dbd1f10df81ce98a54467061c1cf357305fdd73841034d15fe61a482dee3646bbdad356cdf1558a2e4f0
+  data.tar.gz: ac94bb0e47acace36e8c1aac753cbd370b34aadb5034b60da9e10204e6f4dab31c8c6708e7c160f9ffc828b75d833f314564168c14be6b68950c2f35de984aca

data/.gitignore

@@ -0,0 +1,6 @@
+tmp
+gemfiles/*.lock
+Gemfile.lock
+.ruby-version
+pkg
+*.gem

data/.travis.yml

@@ -0,0 +1,47 @@
+language: ruby
+
+cache: bundler
+
+before_install:
+  - "gem update --system 2.7.9"
+  - "gem install bundler -v '<2'"
+
+rvm:
+  - 2.2.10
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.2
+  - ruby-head
+  - rbx-3.107
+
+gemfile:
+  - gemfiles/rails_5_0.gemfile
+  - gemfiles/rails_5_1.gemfile
+  - gemfiles/rails_5_2.gemfile
+  - gemfiles/rails_6_0.gemfile
+  - gemfiles/rails_head.gemfile
+
+matrix:
+  exclude:
+    - rvm: 2.2.10
+      gemfile: gemfiles/rails_6_0.gemfile
+    - rvm: 2.3.8
+      gemfile: gemfiles/rails_6_0.gemfile
+    - rvm: 2.4.6
+      gemfile: gemfiles/rails_6_0.gemfile
+    - rvm: 2.2.10
+      gemfile: gemfiles/rails_head.gemfile
+    - rvm: 2.3.8
+      gemfile: gemfiles/rails_head.gemfile
+    - rvm: 2.4.6
+      gemfile: gemfiles/rails_head.gemfile
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-3.107
+    - rvm: ruby-head
+    - gemfile: gemfiles/rails_head.gemfile
+  fast_finish: true
+
+notifications:
+  email: false

data/Appraisals

@@ -0,0 +1,21 @@
+appraise "rails-5-0" do
+  gem "rails", "~> 5.0.0"
+end
+
+appraise "rails-5-1" do
+  gem "rails", "~> 5.1.0"
+end
+
+appraise "rails-5-2" do
+  gem "rails", "~> 5.2.0"
+end
+
+if RUBY_VERSION >= "2.5.0"
+  appraise "rails-6-0" do
+    gem "rails", "~> 6.0.0"
+  end
+
+  appraise "rails-head" do
+    gem "rails", github: "rails/rails"
+  end
+end

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+gem "mocha", require: false
+gem "appraisal"

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Jason Tian
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# JbuilderReopen
+
+## Installation
+
+    gem 'jbuilder_reopen'
+
+## Usage
+
+To opmtimise cache, now you can reopen blocks and add additional fields
+
+Examples:
+
+	json.cache! "cache-key" do
+    json.posts @posts, partial: "post", as: :post
+  end
+  json.reopen! ["posts"] do |post|
+    json.title post["body"]
+    json.reopen! ["author"] do |author|
+      json.middle_name author["first_name"]
+    end
+  end
+
+## Testing
+    bundle install
+    appraisal install
+    appraisal rake test
+
+## Credit
+Thank you! https://github.com/rails/jbuilder

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  require "appraisal/task"
+  Appraisal::Task.new
+  task default: :appraisal
+else
+  Rake::TestTask.new do |test|
+    require "rails/version"
+
+    test.libs << "test"
+
+    test.test_files = FileList["test/*_test.rb"]
+  end
+
+  task default: :test
+end

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "mocha", require: false
+gem "appraisal"
+gem "rails", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "mocha", require: false
+gem "appraisal"
+gem "rails", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "mocha", require: false
+gem "appraisal"
+gem "rails", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_6_0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "mocha", require: false
+gem "appraisal"
+gem "rails", "~> 6.0.0"
+
+gemspec path: "../"

data/gemfiles/rails_head.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rake"
+gem "mocha", require: false
+gem "appraisal"
+gem "rails", github: "rails/rails"
+
+gemspec path: "../"

data/jbuilder_reopen.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jbuilder_reopen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jbuilder_reopen"
+  spec.version       = JbuilderReopen::VERSION
+  spec.authors       = ["Ben Zhang", "Jason Tian"]
+  spec.email         = ["jason.tian@pixelforcesystems.com.au"]
+  spec.summary       = "Now you can reopen blocks and add additional fields"
+  spec.homepage      = "https://www.github.com/jialitian/jbuilder-reopen"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- test/*`.split("\n")
+
+  spec.required_ruby_version = '>= 2.2.2'
+
+  spec.add_dependency 'jbuilder', '~> 2.10'
+end

data/lib/jbuilder_reopen.rb

@@ -0,0 +1,6 @@
+require "jbuilder_reopen/version"
+require "jbuilder_reopen/jbuilder_scope"
+require "jbuilder_reopen/jbuilder_template"
+
+module JbuilderReopen
+end

data/lib/jbuilder_reopen/jbuilder_scope.rb

@@ -0,0 +1,12 @@
+module JbuilderScope
+  def _scope(_attributes=Jbuilder::Blank.new)
+    parent_attributes, parent_formatter = @attributes, @key_formatter
+    @attributes = _attributes
+    yield
+    @attributes
+  ensure
+    @attributes, @key_formatter = parent_attributes, parent_formatter
+  end
+end
+
+Jbuilder.prepend(JbuilderScope)

data/lib/jbuilder_reopen/jbuilder_template.rb

@@ -0,0 +1,20 @@
+class JbuilderTemplate
+  def reopen!(keys=[], &block)
+    keys = keys.dup
+    if keys.empty?
+      _scope(@attributes) { yield @attributes }
+    else
+      return if _blank?
+      key = keys.shift
+      result = if ::Array === @attributes[key]
+        @attributes[key].map do |element|
+          _scope(element) { reopen!(keys, &block) }
+        end
+      elsif ::Hash === @attributes[key]
+        _scope(@attributes[key]) { reopen!(keys, &block) }
+      end
+      @attributes[key] = result if result.present?
+      @attributes
+    end
+  end
+end

data/lib/jbuilder_reopen/version.rb

@@ -0,0 +1,3 @@
+module JbuilderReopen
+  VERSION = "0.1.3"
+end

data/test/jbuilder_template_test.rb

@@ -0,0 +1,193 @@
+require "test_helper"
+require "action_view/testing/resolvers"
+
+class JbuilderTemplateTest < ActiveSupport::TestCase
+  POST_PARTIAL = <<-JBUILDER
+    json.extract! post, :id, :body
+    json.author do
+      first_name, last_name = post.author_name.split(nil, 2)
+      json.first_name first_name
+      json.last_name last_name
+    end
+  JBUILDER
+
+  COLLECTION_PARTIAL = <<-JBUILDER
+    json.extract! collection, :id, :name
+  JBUILDER
+
+  RACER_PARTIAL = <<-JBUILDER
+    json.extract! racer, :id, :name
+  JBUILDER
+
+  PARTIALS = {
+    "_partial.json.jbuilder"      => "json.content content",
+    "_post.json.jbuilder"         => POST_PARTIAL,
+    "racers/_racer.json.jbuilder" => RACER_PARTIAL,
+    "_collection.json.jbuilder"   => COLLECTION_PARTIAL,
+
+    # Ensure we find only Jbuilder partials from within Jbuilder templates.
+    "_post.html.erb" => "Hello world!"
+  }
+
+  AUTHORS = [ "David Heinemeier Hansson", "Pavel Pravosud" ].cycle
+  POSTS   = (1..10).collect { |i| Post.new(i, "Post ##{i}", AUTHORS.next) }
+
+  setup { Rails.cache.clear }
+
+  test "reopen array" do
+    code = <<-JBUILDER
+      json.cache! "cache-key" do
+        json.posts @posts, partial: "post", as: :post
+      end
+      json.reopen! ["posts"] do |post|
+        json.title ("title " + post["id"].to_s)
+      end
+    JBUILDER
+    result = render(code, posts: POSTS)
+    assert_equal "title 1", result["posts"][0]["title"]
+  end
+
+  test "reopen nested hash" do
+    code = <<-JBUILDER
+      json.cache! "cache-key" do
+        json.posts @posts, partial: "post", as: :post
+      end
+      json.reopen! ["posts"] do |post|
+        json.title post["body"]
+      end
+      json.reopen! ["posts", "author"] do |author|
+        json.middle_name author["first_name"]
+      end
+    JBUILDER
+    result = render(code, posts: POSTS)
+    assert_equal "Post #1", result["posts"][0]["title"]
+    assert_equal 1, result["posts"][0]["id"]
+    assert_equal "Post #1", result["posts"][0]["body"]
+    assert_equal "David", result["posts"][2]["author"]["first_name"]
+    assert_equal "Heinemeier Hansson", result["posts"][2]["author"]["last_name"]
+    assert_equal "David", result["posts"][2]["author"]["middle_name"]
+    assert_equal "Pavel", result["posts"][5]["author"]["middle_name"]
+  end
+
+  test "reopen nested reopen" do
+    code = <<-JBUILDER
+      json.cache! "cache-key" do
+        json.posts @posts, partial: "post", as: :post
+      end
+      json.reopen! ["posts"] do |post|
+        json.title post["body"]
+        json.reopen! ["author"] do |author|
+          json.middle_name author["first_name"]
+        end
+      end
+    JBUILDER
+    result = render(code, posts: POSTS)
+    assert_equal "Post #1", result["posts"][0]["title"]
+    assert_equal 1, result["posts"][0]["id"]
+    assert_equal "Post #1", result["posts"][0]["body"]
+    assert_equal "David", result["posts"][2]["author"]["first_name"]
+    assert_equal "Heinemeier Hansson", result["posts"][2]["author"]["last_name"]
+    assert_equal "David", result["posts"][2]["author"]["middle_name"]
+    assert_equal "Pavel", result["posts"][5]["author"]["middle_name"]
+  end
+
+  test "reopen nested array" do
+    code = <<-JBUILDER
+      json.cache! "cache-key" do
+        json.authors ["David Heinemeier Hansson", "Pavel Pravosud"] do |author|
+          json.name author
+          json.posts @posts, partial: "post", as: :post
+        end
+      end
+      json.reopen! ["authors", "posts"] do |_post|
+        json.title "test"
+        json.body nil
+      end
+    JBUILDER
+    result = render(code, posts: POSTS)
+    assert_equal "test", result["authors"][0]["posts"][2]["title"]
+    assert_nil result["authors"][0]["posts"][2]["body"]
+  end
+
+  test "raise error if change data type has been overrided" do
+    code = <<-JBUILDER
+      json.cache! "cache-key" do
+        json.posts @posts, partial: "post", as: :post
+      end
+      json.reopen! ["posts", "body"] do |_body|
+        json.title "test"
+      end
+    JBUILDER
+    result = render(code, posts: POSTS)
+    assert_nil result["posts"][0]["title"]
+    assert_equal "Post #1", result["posts"][0]["body"]
+  end
+
+  test "do nothing if anchor target is not found" do
+    code = <<-JBUILDER
+      json.cache! "cache-key" do
+        json.posts @posts, partial: "post", as: :post
+      end
+      json.reopen! ["posts", "title"] do |_body|
+        json.title "test"
+      end
+    JBUILDER
+    result = render(code, posts: POSTS)
+    assert_equal false, result["posts"][0].key?("title")
+    assert_equal "Post #1", result["posts"][0]["body"]
+  end
+
+  test "do nothing if anchor target is missing" do
+    discussions = [
+      {
+        title: "Discussion 1",
+        posts: POSTS 
+      },
+      {
+        title: "Discussion 2",
+        posts: [] 
+      }
+    ]
+    code = <<-JBUILDER
+      json.cache! "cache-key" do
+        json.discussions @discussions do |discussion|
+          json.name discussion[:name]
+          json.posts discussion[:posts], partial: "post", as: :post
+        end
+      end
+      json.reopen! ["discussions", "posts", "author"] do |author|
+        json.middle_name "test"
+      end
+    JBUILDER
+    result = render(code, discussions: discussions)
+    assert_equal "test", result["discussions"][0]["posts"][0]["author"]["middle_name"]
+    assert_equal [], result["discussions"][1]["posts"]
+  end
+
+  private
+    def render(*args)
+      JSON.load render_without_parsing(*args)
+    end
+
+    def render_without_parsing(source, assigns = {})
+      view = build_view(fixtures: PARTIALS.merge("source.json.jbuilder" => source), assigns: assigns)
+      view.render(template: "source.json.jbuilder")
+    end
+
+    def build_view(options = {})
+      resolver = ActionView::FixtureResolver.new(options.fetch(:fixtures))
+      lookup_context = ActionView::LookupContext.new([ resolver ], {}, [""])
+      controller = ActionView::TestCase::TestController.new
+
+      # TODO: Use with_empty_template_cache unconditionally after dropping support for Rails <6.0.
+      view = if ActionView::Base.respond_to?(:with_empty_template_cache)
+        ActionView::Base.with_empty_template_cache.new(lookup_context, options.fetch(:assigns, {}), controller)
+      else
+        ActionView::Base.new(lookup_context, options.fetch(:assigns, {}), controller)
+      end
+
+      def view.view_cache_dependencies; []; end
+
+      view
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+require "bundler/setup"
+
+require "active_support"
+require "active_support/core_ext/array/access"
+require "active_support/cache/memory_store"
+require "active_support/json"
+require "active_model"
+require "action_view"
+require "rails/version"
+
+require "jbuilder"
+require "jbuilder_reopen"
+
+require "active_support/testing/autorun"
+require "mocha/setup"
+
+ActiveSupport.test_order = :random
+
+class << Rails
+  def cache
+    @cache ||= ActiveSupport::Cache::MemoryStore.new
+  end
+end
+
+class Post < Struct.new(:id, :body, :author_name); end
+
+class Racer < Struct.new(:id, :name)
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+end
+
+ActionView::Template.register_template_handler :jbuilder, JbuilderHandler
+
+ActionView::Base.remove_possible_method :fragment_name_with_digest
+ActionView::Base.remove_possible_method :cache_fragment_name

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: jbuilder_reopen
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Ben Zhang
+- Jason Tian
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+description: 
+email:
+- jason.tian@pixelforcesystems.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- gemfiles/.bundle/config
+- gemfiles/rails_5_0.gemfile
+- gemfiles/rails_5_1.gemfile
+- gemfiles/rails_5_2.gemfile
+- gemfiles/rails_6_0.gemfile
+- gemfiles/rails_head.gemfile
+- jbuilder_reopen.gemspec
+- lib/jbuilder_reopen.rb
+- lib/jbuilder_reopen/jbuilder_scope.rb
+- lib/jbuilder_reopen/jbuilder_template.rb
+- lib/jbuilder_reopen/version.rb
+- test/jbuilder_template_test.rb
+- test/test_helper.rb
+homepage: https://www.github.com/jialitian/jbuilder-reopen
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Now you can reopen blocks and add additional fields
+test_files:
+- test/jbuilder_template_test.rb
+- test/test_helper.rb