pbbuilder 0.16.1 → 0.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4c9ff9f8ec71c8e3fee410430e9c29da1907e6e110ec6869531b52b8ec54ce5
-  data.tar.gz: 0f75e4c2fbdde5b6c33acc05dd62173b2b399d03c1030c7fd132c460d229b12b
+  metadata.gz: 0f61e783abb61817e05f29772b6614314646c0fda6f24a5f73f556ebc19d0f97
+  data.tar.gz: 34cf6626e2f60aa50a7ee2e7278a0149557263d023dee6a758e4adf2d8e0d263
 SHA512:
-  metadata.gz: '0191dcf320aa97316c483230dda497cc1d83c20f1aac6caa5e4ce4a8883188a949a8217344f04445ab4375b1a4bf952c49eef115af357c87c8127f1c85db3ac7'
-  data.tar.gz: 287458b4fc6db49f90a0d76e4da273861b58bfd84d49edd86f966198a16cb694319cd47fca69200d5cad5767307fbbe83b2fa8c866519056313b3d435c5e917e
+  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/template.rb

@@ -30,57 +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]
-
-        # The way recursive rendering works is that CollectionRenderer needs to be aware of node its currently rendering and parent node,
-        # these is no need to know entire "stack" of nodes. CollectionRenderer would traverse to bottom node render that first and then go up in stack.
-
-        # CollectionRenderer uses locals[:pb] to render the partial as a protobuf message,
-        # but also needs locals[:pb_parent] to apply rendered partial to top level protobuf message.
-
-        # This logic could be found in CollectionRenderer#build_rendered_collection method that we over wrote.
-        options[:locals].merge!(pb: ::PbbuilderTemplate.new(@context, new_message_for(field)))
-        options[:locals].merge!(pb_parent: self)
-        options[:locals].merge!(field: field)
+        # 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", [])]
 
-        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)
+        _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
 
@@ -119,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.

data/pbbuilder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "pbbuilder"
-  spec.version = "0.16.1"
+  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

@@ -54,6 +54,18 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
     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
     error = assert_raises NotImplementedError do
       render('pb.friends partial: "racers/racer", as: :racer, layout: "layout", collection: [Racer.new(1, "Johnny Test", []), Racer.new(2, "Max Verstappen", [])]')
@@ -356,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

@@ -58,6 +58,11 @@ end
 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.1
+  version: 0.16.2
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-02 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