pbbuilder 0.15.1 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc165db83a23b9c5bf32a6921b3cd959171083d48f7a6887df8c524f9920d574
-  data.tar.gz: 7d3631f19dea340592918300b66e6d024889fe2c18776c729d4bebdb9424ad4b
+  metadata.gz: f4c9ff9f8ec71c8e3fee410430e9c29da1907e6e110ec6869531b52b8ec54ce5
+  data.tar.gz: 0f75e4c2fbdde5b6c33acc05dd62173b2b399d03c1030c7fd132c460d229b12b
 SHA512:
-  metadata.gz: ad453cd1f12f8a71f05b98c5d60e34837848f1c4bdbe403d41a407762b980d5f47c6dc16925b01f2927fef427cb82b5a4b23801102fa7a46d280adf1245afe2f
-  data.tar.gz: 1b0bb8019d473e1a433e3009ece6976d7a42992e00d207290106fef8a7de3fd16de5c49caaf6dc23a39aab5cdd6369caae06f62b34def0f431e6c16361210e03
+  metadata.gz: '0191dcf320aa97316c483230dda497cc1d83c20f1aac6caa5e4ce4a8883188a949a8217344f04445ab4375b1a4bf952c49eef115af357c87c8127f1c85db3ac7'
+  data.tar.gz: 287458b4fc6db49f90a0d76e4da273861b58bfd84d49edd86f966198a16cb694319cd47fca69200d5cad5767307fbbe83b2fa8c866519056313b3d435c5e917e

data/.github/workflows/test.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1", "3.2"]
+        ruby: ["3.0", "3.1", "3.2", "3.3"]
 
         gemfile: [ "rails_6_1", "rails_7_0"]
         experimental: [false]

data/Appraisals

@@ -6,6 +6,6 @@ appraise "rails-7-0" do
   gem "rails", "~> 7.0.0"
 end
 
-appraise "rails-head" do
-  gem "rails", github: "rails/rails", branch: "main"
-end
+appraise "rails-7-1" do
+  gem "rails", "~> 7.1.0"
+end

data/CHANGELOG.md

@@ -3,6 +3,13 @@ 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.0
+### Added
+- Added support for new collection rendering, that is backed by ActiveView::CollectionRenderer.
+
+### Changed
+- Refactoring and simplification of #merge! method without a change in functionality.
+
 ## 0.15.1
 ### Fixed
 - #merge! method to handle repeated unintialized message object

data/Gemfile

@@ -7,3 +7,5 @@ gemspec
 
 gem "rake"
 gem "appraisal"
+
+gem "ruby-lsp"

data/README.md

@@ -1,8 +1,11 @@
 # Pbbuilder
 PBBuilder generates [Protobuf](https://developers.google.com/protocol-buffers) Messages with a simple DSL similar to [JBuilder](https://rubygems.org/gems/jbuilder) gem.
 
-## Compatibility
-We don't aim to have 100% compatibility with jbuilder gem, but we closely follow jbuilder's API design. 
+
+At least Rails 6.1 is required.
+
+## Compatibility with jBuilder
+We don't aim to have 100% compitability and coverage with jbuilder gem, but we closely follow jbuilder's API design to maintain familiarity.
 
 | | Jbuilder | Pbbuilder |
 |---|---|---|
@@ -10,12 +13,14 @@ We don't aim to have 100% compatibility with jbuilder gem, but we closely follow
 |  cache! | ✅ | ✅ |
 |  cache_if! | ✅ | ✅ |
 | cache_root! | ✅|  |
+| collection cache | ✅|  |
 | extract! | ✅ | ✅ |
 | merge! | ✅ | ✅ |
-| deep_format_keys! | ✅ |  |
 | child! | ✅ |  |
 | array! | ✅ |  |
-| ignore_nil! | ✅ |  |
+| .call | ✅ |  |
+
+Due to protobuf message implementation, there is absolutely no need to implement support for `deep_format_keys!`, `key_format!`, `key_format`, `deep_format_keys`, `ignore_nil!`, `ignore_nil!`, `nil`. So those would never be added.
 
 ## Usage
 The main difference is that it can use introspection to figure out what kind of protobuf message it needs to create.
@@ -76,8 +81,26 @@ Here is way to use partials with collection while passing a variable to it
 pb.accounts @accounts, partial: "account", as: account
 ```
 
+## Collections (or Arrays)
+There are two different methods to render a collection. One that uses ActiveView::CollectionRenderer
+```ruby
+pb.friends partial: "racers/racer", as: :racer, collection: @racers
+```
+
+```ruby
+pb.friends "racers/racer", as: :racer, collection: @racers
+```
+
+And there are other ways, that don't use Collection Renderer (not very effective probably)
+```ruby
+pb.partial! @racer, racer: Racer.new(123, "Chris Harris", friends)
+```
+```ruby
+pb.friends @friends, partial: "racers/racer", as: :racer
+```
+
 ### Caching
-Fragment caching is supported, it uses Rails.cache and works like caching in HTML templates:
+it uses Rails.cache and works like caching in HTML templates:
 
 ```
 pb.cache! "cache-key", expires_in: 10.minutes do
@@ -93,6 +116,8 @@ pb.cache_if! !admin?, "cache-key", expires_in: 10.minutes do
 end
 ```
 
+Fragment caching support is currently in the works.
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/gemfiles/rails_6.gemfile

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

data/gemfiles/rails_6_1.gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "appraisal"
+gem "ruby-lsp"
 gem "rails", "~> 6.1.0"
 
 gemspec path: "../"

data/gemfiles/rails_7.gemfile

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

data/gemfiles/rails_7_0.gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "appraisal"
+gem "ruby-lsp"
 gem "rails", "~> 7.0.0"
 
 gemspec path: "../"

data/gemfiles/rails_7_1.gemfile

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

data/lib/pbbuilder/collection_renderer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'action_view/renderer/collection_renderer'
+
+class Pbbuilder
+  class CollectionRenderer < ::ActionView::CollectionRenderer # :nodoc:
+    def initialize(lookup_context, options, &scope)
+      super(lookup_context, options)
+      @scope = scope
+    end
+
+    private
+
+    def build_rendered_template(content, template, layout = nil)
+      super(content || pb.attributes!, template)
+    end
+
+    def build_rendered_collection(templates, _spacer)
+      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
+  end
+end

data/lib/pbbuilder/pbbuilder.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 Pbbuilder = Class.new(begin
-  require 'active_support/proxy_object'
-  ActiveSupport::ProxyObject
+    require 'active_support/proxy_object'
+    ActiveSupport::ProxyObject
 rescue LoadError
-  require 'active_support/basic_object'
-  ActiveSupport::BasicObject
+    require 'active_support/basic_object'
+    ActiveSupport::BasicObject
 end)

data/lib/pbbuilder/template.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'pbbuilder/collection_renderer'
+
 # PbbuilderTemplate is an extension of Pbbuilder to be used as a Rails template
 # It adds support for partials.
 class PbbuilderTemplate < Pbbuilder
@@ -37,6 +39,39 @@ class PbbuilderTemplate < Pbbuilder
         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)
+
+        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)
       else
         # pb.best_friend partial: "person", person: @best_friend
         # Call set! as a submessage, passing in the kwargs as partial options

data/lib/pbbuilder.rb

@@ -40,16 +40,20 @@ class Pbbuilder
     set!(...)
   end
 
+  def attributes!
+    @message.to_h
+  end
+
   def respond_to_missing?(field)
-    !!@message.class.descriptor.lookup(field.to_s)
+    !!_descriptor_for_field(field)
   end
 
   def set!(field, *args, &block)
     name = field.to_s
-    descriptor = @message.class.descriptor.lookup(name)
+    descriptor = _descriptor_for_field(name)
     ::Kernel.raise ::ArgumentError, "Unknown field #{name}" if descriptor.nil?
 
-    if block
+    if ::Kernel.block_given?
       ::Kernel.raise ::ArgumentError, "can't pass block to non-message field" unless descriptor.type == :message
 
       if descriptor.label == :repeated
@@ -57,25 +61,28 @@ class Pbbuilder
         ::Kernel.raise ::ArgumentError, "wrong number of arguments #{args.length} (expected 1)" unless args.length == 1
         collection = args.first
         _append_repeated(name, descriptor, collection, &block)
-        return
+      else
+        # 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)
       end
-
-      ::Kernel.raise ::ArgumentError, "wrong number of arguments (expected 0)" unless args.empty?
-      # pb.field { pb.name "hello" }
-      message = (@message[name] ||= _new_message_from_descriptor(descriptor))
-      _scope(message, &block)
     elsif args.length == 1
       arg = args.first
       if descriptor.label == :repeated
         if arg.respond_to?(:to_hash)
           # pb.fields {"one" => "two"}
-          arg.to_hash.each do |k, v|
-            @message[name][k] = v
-          end
-        elsif arg.respond_to?(:to_ary)
+          arg.to_hash.each { |k, v| @message[name][k] = v }
+        elsif arg.respond_to?(:to_ary) && !descriptor.type.eql?(:message)
           # pb.fields ["one", "two"]
           # Using concat so it behaves the same as _append_repeated
+
           @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)
+
+          args.flatten.each {|obj| @message[name].push descriptor.subtype.msgclass.new(obj)}
         else
           # pb.fields "one"
           @message[name].push arg
@@ -103,10 +110,7 @@ class Pbbuilder
   end
 
   def extract!(element, *args)
-    args.each do |arg|
-      value = element.send(arg)
-      @message[arg.to_s] = value
-    end
+    args.each { |arg| @message[arg.to_s] = element.send(arg) }
   end
 
   # Merges object into a protobuf message, mainly used for caching.
@@ -115,11 +119,11 @@ class Pbbuilder
   def merge!(object)
     ::Kernel.raise Pbbuilder::MergeError.build(target!, object) unless object.class == ::Hash
 
-    object.each_key do |key|
-      next if object[key].respond_to?(:empty?) && object[key].empty?
+    object.each do |key, value|
+      next if value.respond_to?(:empty?) && value.empty?
 
-      descriptor = @message.class.descriptor.lookup(key.to_s)
-      ::Kernel.raise ::ArgumentError, "Unknown field #{name}" if descriptor.nil?
+      descriptor = _descriptor_for_field(key)
+      ::Kernel.raise ::ArgumentError, "Unknown field #{key}" if descriptor.nil?
 
       if descriptor.label == :repeated
         # optional empty fields don't show up in @message object,
@@ -128,50 +132,26 @@ class Pbbuilder
           @message[key.to_s] = _new_message_from_descriptor(descriptor)
         end
 
-        if object[key].respond_to?(:to_hash)
-          object[key].to_hash.each {|k, v| @message[key.to_s][k] = v}
-        elsif object[key].respond_to?(:to_ary)
-          elements = object[key].map do |obj|
+        if value.respond_to?(:to_hash)
+          value.to_hash.each {|k, v| @message[key.to_s][k] = v}
+        elsif value.respond_to?(:to_ary)
+          elements = value.map do |obj|
             descriptor.subtype ? descriptor.subtype.msgclass.new(obj) : obj
           end
 
           @message[key.to_s].replace(elements)
         end
       else
-        if object[key].class == ::String
+        if descriptor.type == :message
+          @message[key.to_s] = descriptor.subtype.msgclass.new(value)
+        else
           # pb.fields {"one" => "two"}
-          @message[key.to_s] = object[key]
-        elsif object[key].class == ::TrueClass || object[key].class == ::FalseClass
           # pb.boolean true || false
-          @message[key.to_s] = object[key]
-        elsif object[key].class == ::Array
           # pb.field_name do
           #    pb.tags ["ok", "cool"]
           # end
 
-          @message[key.to_s] = object[key]
-        elsif object[key].class == ::Hash
-          if @message[key.to_s].nil?
-            @message[key.to_s] = _new_message_from_descriptor(descriptor)
-          end
-
-          object[key].each do |k, v|
-            if object[key][k].respond_to?(:to_hash)
-              if @message[key.to_s][k.to_s].nil?
-                descriptor = @message[key.to_s].class.descriptor.lookup(k.to_s)
-                @message[key.to_s][k.to_s] = _new_message_from_descriptor(descriptor)
-              end
-
-              _scope(@message[key.to_s][k.to_s]) { self.merge!(object[key][k]) }
-            elsif object[key][k].respond_to?(:to_ary)
-              @message[key.to_s][k.to_s].replace object[key][k]
-            else
-              # Throws an error, if we try to merge nil object into empty value.
-              next if object[key][k].nil? && @message[key.to_s][k.to_s].nil?
-
-              @message[key.to_s][k.to_s] = object[key][k]
-            end
-          end
+          @message[key.to_s] = value
         end
       end
     end
@@ -182,8 +162,19 @@ 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)
+    @message.class.descriptor.lookup(field.to_s)
+  end
+
   # Appends protobuf message with existing @message object
   #
   # @param name string

data/pbbuilder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "pbbuilder"
-  spec.version = "0.15.1"
+  spec.version = "0.16.1"
   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!"
@@ -30,6 +38,45 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal "hello", result.name
   end
 
+  test "render collections with partial as kwarg" do
+    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 "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", [])]')
+    end
+
+    assert_equal "The `:layout' option is not supported in collection rendering.", error.message
+  end
+
+  test "CollectionRenderer: raises an error on a render with :spacer_template option" do
+    error = assert_raises NotImplementedError do
+      render('pb.friends partial: "racers/racer", as: :racer, spacer_template: "template", collection: [Racer.new(1, "Johnny Test", []), Racer.new(2, "Max Verstappen", [])]')
+    end
+
+    assert_equal "The `:spacer_template' option is not supported in collection rendering.", error.message
+  end
+
+  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

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,7 +55,7 @@ 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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pbbuilder
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.1
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-07 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -76,7 +76,6 @@ files:
 - ".github/dependabot.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
-- ".ruby-version"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -86,10 +85,14 @@ files:
 - bin/appraisal
 - bin/test
 - gemfiles/.bundle/config
+- gemfiles/rails_6.gemfile
 - gemfiles/rails_6_1.gemfile
+- gemfiles/rails_7.gemfile
 - gemfiles/rails_7_0.gemfile
+- gemfiles/rails_7_1.gemfile
 - gemfiles/rails_head.gemfile
 - lib/pbbuilder.rb
+- lib/pbbuilder/collection_renderer.rb
 - lib/pbbuilder/errors.rb
 - lib/pbbuilder/handler.rb
 - lib/pbbuilder/pbbuilder.rb
@@ -120,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Generate Protobuf Messages with a simple DSL similar to JBuilder

data/.ruby-version

@@ -1 +0,0 @@
-3.1.2