pbbuilder 0.16.0 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24755dfd52ac20a000c27ed88c368ef1b09977cacffc1d185f59733474247043
-  data.tar.gz: 0dcac7ff05a509dad422976926176b921fcddcc443de24617c4218d9e5be1ada
+  metadata.gz: 0f61e783abb61817e05f29772b6614314646c0fda6f24a5f73f556ebc19d0f97
+  data.tar.gz: 34cf6626e2f60aa50a7ee2e7278a0149557263d023dee6a758e4adf2d8e0d263
 SHA512:
-  metadata.gz: f6aa9b3c55c5b89a85fc081a62125b7c675c22ec638fe7e29f073dcf291b87d6f0c50af69eb87371fe9c4718131b2243a230f54913f9b325e524fdbd2203107d
-  data.tar.gz: ecb4b6a1de74be30dc041e44f0859b8b6fab5a9e3b932503de02d53dc61b10c5e990ca0e8a631b25be2f7e92b80d6fbaa376f45dfe09e963d561a9c63a5e7a09
+  metadata.gz: 15f60555cb89a70e0b28490db9bc00e4b9ca7ed34f179a5df0576d6a70ef737c9d7acc66e686b0b0216a003e043c967162d377087a443f3057470e4396889e4e
+  data.tar.gz: fd6e5587bd3d8bafc4988f089901afe2848c577243b5d9b105e629b92c3f7cbc522fbe218f9be59ca29605af27c034c423f244c8df0208dd72d9b67bf4831143

data/CHANGELOG.md

@@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file.
 
 This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.16.2
+### Added
+- Add support for partial as a first argument , e.g.`pb.friends "racers/racer", as: :racer, collection: @racers`
+- Add tests to verify that fragment caching is operational
+
+## 0.16.1
+### Changed
+- Deal properly with recursive protobuf messages while using ActiveView::CollectionRenderer
+
 ## 0.16.0
 ### Added
 - Added support for new collection rendering, that is backed by ActiveView::CollectionRenderer.

data/README.md

@@ -13,7 +13,7 @@ We don't aim to have 100% compitability and coverage with jbuilder gem, but we c
 |  cache! | ✅ | ✅ |
 |  cache_if! | ✅ | ✅ |
 | cache_root! | ✅|  |
-| collection cache | ✅|  |
+| fragment cache | ✅| ✅ |
 | extract! | ✅ | ✅ |
 | merge! | ✅ | ✅ |
 | child! | ✅ |  |
@@ -116,7 +116,15 @@ pb.cache_if! !admin?, "cache-key", expires_in: 10.minutes do
 end
 ```
 
-Fragment caching support is currently in the works.
+Fragment caching currently works through ActionView::CollectionRenderer and can be used only with the following syntax:
+
+```ruby
+pb.friends partial: "racers/racer", as: :racer, collection: @racers, cached: true
+```
+
+```ruby
+pb.friends "racers/racer", as: :racer, collection: @racers, cached: true
+```
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/pbbuilder/collection_renderer.rb

@@ -16,13 +16,17 @@ class Pbbuilder
     end
 
     def build_rendered_collection(templates, _spacer)
-      pb.set!(field, templates.map(&:body))
+      pb_parent.set!(field, templates.map(&:body))
     end
 
     def pb
       @options[:locals].fetch(:pb)
     end
 
+    def pb_parent
+      @options[:locals].fetch(:pb_parent)
+    end
+
     def field
       @options[:locals].fetch(:field).to_s
     end

data/lib/pbbuilder/template.rb

@@ -30,48 +30,45 @@ class PbbuilderTemplate < Pbbuilder
     end
   end
 
+  # Set the value in the message field.
+  #
+  # @example
+  #  pb.friends @friends, partial: "friend", as: :friend
+  #  pb.friends partial: "racers/racer", as: :racer, collection: [Racer.new(1, "Johnny Test", []), Racer.new(2, "Max Verstappen", [])]
+  #  pb.best_friend partial: "person", person: @best_friend
+  #  pb.friends "racers/racer", as: :racer, collection: [Racer.new(1, "Johnny Test", []), Racer.new(2, "Max Verstappen", [])]
+
   def set!(field, *args, **kwargs, &block)
     # If partial options are being passed, we render a submessage with a partial
     if kwargs.has_key?(:partial)
       if args.one? && kwargs.has_key?(:as)
-        # pb.friends @friends, partial: "friend", as: :friend
+        # example syntax that should end up here:
+        #   pb.friends @friends, partial: "friend", as: :friend
         # Call set! on the super class, passing in a block that renders a partial for every element
         super(field, *args) do |element|
           _set_inline_partial(element, kwargs)
         end
       elsif kwargs.has_key?(:collection) && kwargs.has_key?(:as)
-        # pb.friends partial: "racers/racer", as: :racer, collection: [Racer.new(1, "Johnny Test", []), Racer.new(2, "Max Verstappen", [])]
-        # collection renderer
-        options = kwargs.deep_dup
-
-        options.reverse_merge! locals: options.except(:partial, :as, :collection, :cached)
-        options.reverse_merge! ::PbbuilderTemplate.template_lookup_options
-
-        collection = options[:collection] || []
-        partial = options[:partial]
-        options[:locals].merge!(pb: self)
-        options[:locals].merge!(field: field)
-
-        if options.has_key?(:layout)
-          raise ::NotImplementedError, "The `:layout' option is not supported in collection rendering."
-        end
-  
-        if options.has_key?(:spacer_template)
-          raise ::NotImplementedError, "The `:spacer_template' option is not supported in collection rendering."
-        end
+        # example syntax that should end up here:
+        #   pb.friends partial: "racers/racer", as: :racer, collection: [Racer.new(1, "Johnny Test", []), Racer.new(2, "Max Verstappen", [])]
 
-        CollectionRenderer
-          .new(@context.lookup_context, options) { |&block| _scope(message[field.to_s],&block) }
-          .render_collection_with_partial(collection, partial, @context, nil)
+        _render_collection_with_options(field, kwargs[:collection], kwargs)
       else
+        # # example syntax that should end up here:
         # pb.best_friend partial: "person", person: @best_friend
-        # Call set! as a submessage, passing in the kwargs as partial options
+
         super(field, *args) do
           _render_partial_with_options(kwargs)
         end
       end
     else
-      super
+      if args.one? && kwargs.has_key?(:collection) && kwargs.has_key?(:as)
+        # example syntax that should end up here:
+        #   pb.friends "racers/racer", as: :racer, collection: [Racer.new(1, "Johnny Test", []), Racer.new(2, "Max Verstappen", [])]
+        _render_collection_with_options(field, kwargs[:collection], kwargs.merge(partial: args.first))
+      else
+        super
+      end
     end
   end
 
@@ -110,10 +107,42 @@ class PbbuilderTemplate < Pbbuilder
 
   private
 
+  # Uses ActionView::CollectionRenderer to render collection effectively and to use rails built in fragment caching support.
+  #
+  # The way recursive rendering works is that the CollectionRenderer needs to be aware of the node its currently rendering and parent node.
+  # There is no need to know the entire "stack" of nodes. ActionView::CollectionRenderer would traverse to bottom node render it first and then go one leve up in stack,
+  # rince and repeat until entire stack is rendered.
+
+  # CollectionRenderer uses locals[:pb] to render the partial as a protobuf message,
+  # but also needs locals[:pb_parent] to apply the rendered partial to the top level protobuf message.
+
+  # This logic can be found in CollectionRenderer#build_rendered_collection method that we overwrote.
+  def _render_collection_with_options(field, collection, options)
+    partial = options[:partial]
+
+    options.reverse_merge! locals: options.except(:partial, :as, :collection, :cached)
+    options.reverse_merge! ::PbbuilderTemplate.template_lookup_options
+
+    options[:locals].merge!(pb: ::PbbuilderTemplate.new(@context, new_message_for(field)))
+    options[:locals].merge!(pb_parent: self)
+    options[:locals].merge!(field: field)
+
+    if options.has_key?(:layout)
+      raise ::NotImplementedError, "The `:layout' option is not supported in collection rendering."
+    end
+
+    if options.has_key?(:spacer_template)
+      raise ::NotImplementedError, "The `:spacer_template' option is not supported in collection rendering."
+    end
+
+    CollectionRenderer
+      .new(@context.lookup_context, options) { |&block| _scope(message[field.to_s],&block) }
+      .render_collection_with_partial(collection, partial, @context, nil)
+  end
+
   # Writes to cache, if cache with keys is missing.
   #
   # @return fragment value
-
   def _cache_fragment_for(key, options, &block)
     key = _cache_key(key, options)
     _read_fragment_cache(key, options) || _write_fragment_cache(key, options, &block)

data/lib/pbbuilder.rb

@@ -57,12 +57,14 @@ class Pbbuilder
       ::Kernel.raise ::ArgumentError, "can't pass block to non-message field" unless descriptor.type == :message
 
       if descriptor.label == :repeated
-        # pb.field @array { |element| pb.name element.name }
+        # example syntax that should end up here:
+        #    pb.field @array { |element| pb.name element.name }
         ::Kernel.raise ::ArgumentError, "wrong number of arguments #{args.length} (expected 1)" unless args.length == 1
         collection = args.first
         _append_repeated(name, descriptor, collection, &block)
       else
-        # pb.field { pb.name "hello" }
+        # example syntax that should end up here:
+        #   pb.field { pb.name "hello" }
         ::Kernel.raise ::ArgumentError, "wrong number of arguments (expected 0)" unless args.empty?
         message = (@message[name] ||= _new_message_from_descriptor(descriptor))
         _scope(message, &block)
@@ -71,7 +73,8 @@ class Pbbuilder
       arg = args.first
       if descriptor.label == :repeated
         if arg.respond_to?(:to_hash)
-          # pb.fields {"one" => "two"}
+          # example syntax that should end up here:
+          #   pb.fields {"one" => "two"}
           arg.to_hash.each { |k, v| @message[name][k] = v }
         elsif arg.respond_to?(:to_ary) && !descriptor.type.eql?(:message)
           # pb.fields ["one", "two"]
@@ -79,20 +82,23 @@ class Pbbuilder
 
           @message[name].concat arg.to_ary
         elsif arg.respond_to?(:to_ary) && descriptor.type.eql?(:message)
-          # pb.friends [Person.new(name: "Johnny Test"), Person.new(name: "Max Verstappen")]
-          # Concat another Protobuf message into parent Protobuf message (not ary of strings)
+          # example syntax that should end up here:
+          #   pb.friends [Person.new(name: "Johnny Test"), Person.new(name: "Max Verstappen")]
 
           args.flatten.each {|obj| @message[name].push descriptor.subtype.msgclass.new(obj)}
         else
-          # pb.fields "one"
+          # example syntax that should end up here:
+          #   pb.fields "one"
           @message[name].push arg
         end
       else
-        # pb.field "value"
+        # example syntax that should end up here:
+        #   pb.field "value"
         @message[name] = arg
       end
     else
-      # pb.field @value, :id, :name, :url
+      # example syntax that should end up here:
+      #   pb.field @value, :id, :name, :url
       element = args.shift
       if descriptor.label == :repeated
         # If the message field that's being assigned is a repeated field, then we assume that `element` is enumerable.
@@ -162,6 +168,13 @@ class Pbbuilder
     @message
   end
 
+  def new_message_for(field)
+    descriptor = _descriptor_for_field(field)
+    ::Kernel.raise ::ArgumentError, "Unknown field #{field}" if descriptor.nil?
+
+    _new_message_from_descriptor(descriptor)
+  end
+
   private
 
   def _descriptor_for_field(field)

data/pbbuilder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "pbbuilder"
-  spec.version = "0.16.0"
+  spec.version = "0.16.2"
   spec.authors = ["Bouke van der Bijl"]
   spec.email = ["bouke@cheddar.me"]
   spec.homepage = "https://github.com/cheddar-me/pbbuilder"

data/test/pbbuilder_template_test.rb

@@ -12,12 +12,20 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
     pb.extract! racer, :name
     pb.friends racer.friends, partial: "racers/racer", as: :racer
     pb.best_friend partial: "racers/racer", racer: racer.best_friend if racer.best_friend.present?
+    pb.logo partial: "asset", asset: racer.logo if racer.logo.present?
+  PBBUILDER
+
+  ASSET_PARTIAL = <<-PBBUILDER
+    pb.url asset.url
+    pb.url_2x asset.url
+    pb.url_3x asset.url
   PBBUILDER
 
   PARTIALS = {
     "_partial.pb.pbbuilder" => "pb.name name",
     "_person.pb.pbbuilder" => PERSON_PARTIAL,
     "racers/_racer.pb.pbbuilder" => RACER_PARTIAL,
+    "_asset.pb.pbbuilder" => ASSET_PARTIAL,
 
     # Ensure we find only Pbbuilder partials from within Pbbuilder templates.
     "_person.html.erb" => "Hello world!"
@@ -31,9 +39,31 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
   end
 
   test "render collections with partial as kwarg" do
-    result = render('pb.friends partial: "racers/racer", as: :racer, collection: [Racer.new(1, "Johnny Test", []), Racer.new(2, "Max Verstappen", [])]')
+    template = <<-PBBUILDER
+      more_friends = [Racer.new(4, "Johnny Brave", [], nil, API::Asset.new(url: "https://google.com/test3.svg"))]
+      friends_of_racer = [Racer.new(3, "Chris Harris", more_friends, nil, API::Asset.new(url: "https://google.com/test2.svg"))]
+      racers = [Racer.new(1, "Johnny Test", friends_of_racer, nil, API::Asset.new(url: "https://google.com/test1.svg")), Racer.new(2, "Max Verstappen", [])]
+      pb.friends partial: "racers/racer", as: :racer, collection: racers
+    PBBUILDER
+    result = render(template)
+
+    assert_equal 2, result.friends.count
+    assert_nil result.logo
+    assert_equal "https://google.com/test1.svg", result.friends.first.logo.url
+    assert_equal "https://google.com/test2.svg", result.friends.first.friends.first.logo.url
+    assert_equal "https://google.com/test3.svg", result.friends.first.friends.first.friends.first.logo.url
+  end
+
+  test "collection partial with fragment caching enabled" do
+    template = <<-PBBUILDER
+      racers = [Racer.new(1, "Johnny Test", [], nil, API::Asset.new(url: "https://google.com/test1.svg")), Racer.new(2, "Max Verstappen", [])]
+      pb.friends partial: "racers/racer", as: :racer, collection: racers, cached: true
+    PBBUILDER
+    result = render(template)
 
     assert_equal 2, result.friends.count
+    assert_nil result.logo
+    assert_equal "https://google.com/test1.svg", result.friends.first.logo.url
   end
 
   test "CollectionRenderer: raises an error on a render with :layout option" do
@@ -52,14 +82,13 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal "The `:spacer_template' option is not supported in collection rendering.", error.message
   end
 
-  test " render collections with partial as arg" do
+  test "render collections with partial as arg" do
     skip("This will be addressed in future version of a gem")
     result = render('pb.friends "racers/racer", as: :racer, collection: [Racer.new(1, "Johnny Test", []), Racer.new(2, "Max Verstappen", [])]')
 
     assert_equal 2, result.friends.count
   end
 
-
   test "partial by name with top-level locals" do
     result = render('pb.partial! "partial", name: "hello"')
     assert_equal "hello", result.name
@@ -339,9 +368,10 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
 
     view = ActionView::Base.with_empty_template_cache.new(lookup_context, assigns, controller)
 
-    def view.view_cache_dependencies
-      []
-    end
+    def view.view_cache_dependencies; [] end
+    def view.combined_fragment_cache_key(key) [ key ] end
+    def view.cache_fragment_name(key, *) key end
+    def view.fragment_name_with_digest(key) key end
 
     view
   end

data/test/test_helper.rb

@@ -46,6 +46,7 @@ end
 
 module API
   Person = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pbbuildertest.Person").msgclass
+  Asset = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pbbuildertest.Asset").msgclass
 end
 
 class << Rails
@@ -54,9 +55,14 @@ class << Rails
   end
 end
 
-class Racer < Struct.new(:id, :name, :friends, :best_friend)
+class Racer < Struct.new(:id, :name, :friends, :best_friend, :logo)
   extend ActiveModel::Naming
   include ActiveModel::Conversion
+
+  # Fragment caching needs to know, if record could be persisted. We set it to false, this is a default in ActiveModel::API.
+  def persisted?
+    false
+  end
 end
 
 Mime::Type.register "application/vnd.google.protobuf", :pb, [], %w(pb)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pbbuilder
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.16.2
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
+date: 2024-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Generate Protobuf Messages with a simple DSL similar to JBuilder