pbbuilder 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e89f023f27d95d8d11cdf454148ef955b0234b6d7e59f40e30859e09c02761cb
-  data.tar.gz: 108693d16d963bc46ad96d3f79ed4b8078f8efc9c3a7f798c32b7bdd5cc98e73
+  metadata.gz: 24755dfd52ac20a000c27ed88c368ef1b09977cacffc1d185f59733474247043
+  data.tar.gz: 0dcac7ff05a509dad422976926176b921fcddcc443de24617c4218d9e5be1ada
 SHA512:
-  metadata.gz: aa478fc7fad5954801385b731b7fc77296d732e8f13a6bc5688417dfdeb247a7135f3ecbce14f88abc441a87cbc6ad669d3f5547b917f80bfddfbac7e0b2c9a8
-  data.tar.gz: 2fe79ab3cfde6b908907d55eaf37054cb0b530f4e98dbf44d732bef82c46054f0efd4c6ba3a05827915cc855f9cc70a671adc2316c691edd5147ababec573ec6
+  metadata.gz: f6aa9b3c55c5b89a85fc081a62125b7c675c22ec638fe7e29f073dcf291b87d6f0c50af69eb87371fe9c4718131b2243a230f54913f9b325e524fdbd2203107d
+  data.tar.gz: ecb4b6a1de74be30dc041e44f0859b8b6fab5a9e3b932503de02d53dc61b10c5e990ca0e8a631b25be2f7e92b80d6fbaa376f45dfe09e963d561a9c63a5e7a09

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,17 @@ 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
+
 ## 0.15.0
 ### Changed
 - #merge! method was refactored to accomodate caching for all data types (especially those that are :repeated)

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,30 @@
+# 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.set!(field, templates.map(&:body))
+    end
+
+    def pb
+      @options[:locals].fetch(:pb)
+    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,30 @@ 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]
+        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
+
+        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,45 +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)
-              _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
@@ -179,6 +164,10 @@ class Pbbuilder
 
   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.0"
+  spec.version = "0.16.0"
   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

@@ -30,6 +30,36 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal "hello", result.name
   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", [])]')
+
+    assert_equal 2, result.friends.count
+  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
@@ -116,6 +146,38 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
     }
   end
 
+  test "caching a message object" do
+    template = <<-PBBUILDER
+      pb.cache! "some-random-key-again" do
+        pb.best_friend do
+          pb.name "Max Verstappen"
+          pb.logo do
+            pb.url('https://google.com/image.jpg')
+            pb.url_2x('https://google.com/image.jpg')
+            pb.url_3x('https://google.com/image.jpg')
+          end
+        end
+        pb.logo do
+          pb.url('https://google.com/image.jpg')
+          pb.url_2x('https://google.com/image.jpg')
+          pb.url_3x('https://google.com/image.jpg')
+        end
+      end
+    PBBUILDER
+
+    assert_nothing_raised { render(template) }
+
+    result = render('pb.cache! "some-random-key-again" do; end ')
+
+    assert_equal('https://google.com/image.jpg', result.logo.url)
+    assert_equal('https://google.com/image.jpg', result.logo.url_2x)
+    assert_equal('https://google.com/image.jpg', result.logo.url_3x)
+
+    assert_equal('https://google.com/image.jpg', result.best_friend.logo.url)
+    assert_equal('https://google.com/image.jpg', result.best_friend.logo.url_2x)
+    assert_equal('https://google.com/image.jpg', result.best_friend.logo.url_3x)
+  end
+
   test "empty fragment caching" do
     render 'pb.cache! "nothing" do; end'
 

data/test/test_helper.rb

@@ -33,6 +33,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :tags, :string, 7
       optional :last_name, :string, 8
       optional :boolean_me, :bool, 9
+      optional :logo, :message, 10, "pbbuildertest.Asset"
+    end
+
+    add_message "pbbuildertest.Asset" do
+      optional :url, :string, 1
+      optional :url_2x, :string, 2
+      optional :url_3x, :string, 3
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pbbuilder
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-10-23 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