pbbuilder 0.18.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75cb2682f8933e0e8acb2b3bb6a525df5447dab8a65b2d8509f54a3c2b430c35
-  data.tar.gz: '0282cfeb404460224fd8cb2d32d134335b9d307d2edefc4af854368b9c8788e1'
+  metadata.gz: 9f241a460f2ab7e8383c37db199821f8cb5e8d2f69c262f38c7c462a4d7827e0
+  data.tar.gz: 3e8c43a8d0c0362049a9cb8a709c86eac64d86e12366812f2b996b1e81d73c23
 SHA512:
-  metadata.gz: d429891ca19333b9e626ccd9bf63462fbe61eea672c8ac14f427aafdc392a2f12e36370e63f1a4522c384b4375e81433d63d804f447d508346744aedca448fbf
-  data.tar.gz: 1af6634160780c84f93a99d9b6b282e90500da24d654bfa36f1220b48260bec074412da69f83267a2df8f935e33218b332a27cf102765e6eff7b3db853ec686e
+  metadata.gz: '03691d015507cb98d862c4f1c352a08c20e0968f0fae3a23795bec6e6ffdbef6b3e54dca9057364c32e353bfc561e8f117cf02219ad2c73725ae004b7fd1590b'
+  data.tar.gz: b52b5324090887effbaba0ae6ff79ebe9cc7c08ffae945037883d42375bca4ec53bd5a37dc4a9d144c488a6ba5e7ffce88d05f3e9f7ba1a260af5f0ed55107ed

data/.github/workflows/test.yml

@@ -13,24 +13,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.0", "3.1", "3.2", "3.3"]
-
-        gemfile: [ "rails_6_1", "rails_7_0"]
+        ruby: ["3.2.2"]
+        gemfile: ["rails_7_2", "rails_8_0"]
         experimental: [false]
 
-        #include:
-        #  - ruby: '2.7'
-        #    gemfile: rails_head
-        #    experimental: true
-        #  - ruby: '3.0'
-        #    gemfile: rails_head
-        #    experimental: true
-        #  - ruby: '3.1'
-        #    gemfile: rails_head
-        #    experimental: true
-
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: ruby/setup-ruby@v1
         with:

data/.gitignore

@@ -18,5 +18,5 @@ gemfiles/*.lock
 Gemfile.lock
 .ruby-version
 pkg
-
+.vscode/
 

data/Appraisals

@@ -1,11 +1,9 @@
-appraise "rails-6-1" do
-  gem "rails", "~> 6.1.0"
+appraise "rails-7-2" do
+  gem "rails", "~> 7.2.0"
+  gem "google-protobuf", "~> 3.25", "< 4.0"
 end
 
-appraise "rails-7-0" do
-  gem "rails", "~> 7.0.0"
-end
-
-appraise "rails-7-1" do
-  gem "rails", "~> 7.1.0"
+appraise "rails-8-0" do
+  gem "rails", "~> 8.0.2"
+  gem "google-protobuf", "~> 4.0", "< 5.0"
 end

data/CHANGELOG.md

@@ -1,60 +1,55 @@
-# Pbbuilder Changelog
-All notable changes to this project will be documented in this file.
+## Unreleased
 
-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).
+- Remove official support for Rails 7.0 and Rails 6.x, add Appraisal config for Rails 8.x
+- Bump actions/checkout from 3 to 4 (#40)
+- Drop support for rails v6.* versions (#60)
+- Regenerate Appraisals, drop Rails 7.0
+- Allow usage of google-protobuf 4.x
+- Use an actual .proto for testing
+- Test with both google-protobuf 3.25 and 4.x
+- Remove --verbose when running rake test
+
+## 0.19.0
+- Add support for rails 7.2, but leave out rails 7.1 support. This is because ActionView has a breaking bug in 7.1 that renders the template back as a string instead of an object, like we need for Pbbuilder https://github.com/rails/rails/pull/51023 This also removes the uses of the Rails variant of BasicObject in favor of the Ruby built-in.
+
+## 0.18.0
+- Allow literal assignment of protos to fields
 
 ## 0.17.0
-### Changed
 - Instead of appending to repeated enum message, we're replacing it to avoid issues in case output will be rendered twice
 - If one field was defined twice, only last definition will end up in output
-
-## Fixed
 - Fixed CI by locking 3 version or lower of google-protobuf dependency.
 
 ## 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.
-
-### 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)
 
 ## 0.14.0
-### Added
 - Adding `frozen_string_literal: true` to all files.
 
-## 0.13.2 2023.02.3
-### Fixed
+## 0.13.2
 - In case ActiveSupport::Cache::FileStore in Rails is used as a cache, File.atomic_write can have a race condition and fail to rename temporary file. We're attempting to recover from that, by catching this specific error and returning a value.
 
-## 0.13.1 2023.01.24
-### Added
+## 0.13.1
 - #merge! to support boolean values
 
-## 0.13.0 2023.01.18
-### Added
+## 0.13.0
 - #merge! method added for PbbuilderTemplate class
 - ActiveSupport added as a dependency for gem
 - Fragment Caching support added, with #cache! and #cache_if! methods in PbbuilderTemplate class.
-
-
-### Changed
 - Appraisal is properly configured to run against all rubies and rails combinations.
 - Supported ruby version's are 2.7, 3.0, 3.1
 - Superclass for pbbuilder is now active_support/proxy_object, with a fallback to active_support/basic_object.
@@ -62,10 +57,7 @@ This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
   - `rails` from version 6.1.4.4 to 6.1.7, and from version 7.0.1 to 7.0.4
   - `google-protobuf` is let loose
   - `bundler` from version 2.3.4 to 2.3.22
-
-### Removed
-- TestUnit dependency
-
+- TestUnit dependency removed
 
 ## 0.12.0 Prior to 2022-10-14
 

data/Gemfile

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

data/README.md

@@ -1,22 +1,22 @@
 # Pbbuilder
-PBBuilder generates [Protobuf](https://developers.google.com/protocol-buffers) Messages with a simple DSL similar to [JBuilder](https://rubygems.org/gems/jbuilder) gem.
+PBBuilder generates [Protobuf](https://developers.google.com/protocol-buffers) Messages with a simple DSL similar to the [JBuilder](https://rubygems.org/gems/jbuilder) gem.
 
+## Requirements
+This gem only supports Rails 7.0 and Rails 7.2, **7.1 is not supported**.
 
-At least Rails 6.1 is required.
+There currently is a regression in ActionView (the part of Rails which renders) that forces rendered objects into strings, but for Pbbuilder we need the raw objects.
+This is only present in Rails 7.1, and a fix is released in Rails 7.2. https://github.com/rails/rails/pull/51023
 
-> [!WARNING]  
-> There currently is a regression in ActionView (the part of Rails which renders) that forces rendered objects into strings. This is only present
-> in Rails 7.1, and is fixed in Rails. However, a 7.1 gem containing the fix hasn't been released yet. For the moment you should refrain
-> from using pbbuilder and rails-twirp with Rails 7.1 and wait for the next version to be released.
+It might work on rails v6 (it worked previously), but we don't guarantee that and don't test against these versions anymore.
 
 ## 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 |
 |---|---|---|
-|  set! | ✅ | ✅ |
-|  cache! | ✅ | ✅ |
-|  cache_if! | ✅ | ✅ |
+| set! | ✅ | ✅ |
+| cache! | ✅ | ✅ |
+| cache_if! | ✅ | ✅ |
 | cache_root! | ✅|  |
 | fragment cache | ✅| ✅ |
 | extract! | ✅ | ✅ |
@@ -25,7 +25,7 @@ We don't aim to have 100% compitability and coverage with jbuilder gem, but we c
 | array! | ✅ |  |
 | .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.
+Due to the 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.
@@ -61,7 +61,7 @@ pb.phone_number account.phone_number
 pb.tag account.tag
 ```
 
-could be rewritten to a shorter version with a use of `extract!`.
+can be rewritten to a shorter version with the use of `extract!`.
 ```
 pb.extract! account, :id, :phone_number, :tag
 ```
@@ -80,7 +80,7 @@ Using partial while passing a variable to it
 pb.account partial: "account", account: @account
 ```
 
-Here is way to use partials with collection while passing a variable to it
+Here is a way to use partials with a collection while passing a variable to it
 
 ```
 pb.accounts @accounts, partial: "account", as: account
@@ -96,7 +96,7 @@ pb.friends partial: "racers/racer", as: :racer, collection: @racers
 pb.friends "racers/racer", as: :racer, collection: @racers
 ```
 
-And there are other ways, that don't use Collection Renderer (not very effective probably)
+And there are other ways, that don't use CollectionRenderer
 ```ruby
 pb.partial! @racer, racer: Racer.new(123, "Chris Harris", friends)
 ```
@@ -105,7 +105,7 @@ pb.friends @friends, partial: "racers/racer", as: :racer
 ```
 
 ### Caching
-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
@@ -121,7 +121,7 @@ pb.cache_if! !admin?, "cache-key", expires_in: 10.minutes do
 end
 ```
 
-Fragment caching currently works through ActionView::CollectionRenderer and can be used only with the following syntax:
+Fragment caching currently works through ActionView::CollectionRenderer and can only be used with the following syntax:
 
 ```ruby
 pb.friends partial: "racers/racer", as: :racer, collection: @racers, cached: true
@@ -151,16 +151,32 @@ $ gem install pbbuilder
 
 When debugging, make sure to prepend `::Kernel` to any calls such as `puts` as otherwise the code will think you're trying to add another attribute into protobuf object.
 
-In case, you're looking to use breakpoints for debugging purposes - it's better to use `pry`. Just make sure to [change pbbuilder superclass from `ProxyObject/BasicObject` to `Object`](lib/pbbuilder/pbbuilder.rb).
+In case you're looking to use breakpoints (for debugging purposes via `binding.pry` for instance), let Pbbuilder inherit from `Object` instead of `BasicObject`]
+Seen in:
+[Pbbuilder](lib/pbbuilder/pbbuilder.rb)
+[Errors](lib/pbbuilder/errors.rb)
 
 ## Testing
-Running `bundle exec appraisal rake test` locally will run entire testsuit with all version of rails. To run tests only for certain rails version do the following `bundle exec appraisal rails-7-0 rake test`
 
-To run only one tests from file - use `m` utility. Like this:
-`bundle exec appraisal rails-7-0 m test/pbbuilder_template_test.rb:182`
+`pbbuilder` is set up with Appraisal so that we can test a couple Rails and google-protobuf versions against our changes. To run the tests for all setups:
+
+```bash
+$ bundle exec appraisal install
+$ bundle exec appraisal rake test
+
+To run tests only for a certain pre-set Gemfile (check the `Appraisals` file to see what's defined):
+
+```bash
+$ bundle exec appraisal rails-7-2 rake test`
+```
+
+To run only one test use `m` utility. Like this:
+`bundle exec appraisal rails-7-2 m test/pbbuilder_template_test.rb:182`
 
 ## Contributing
+
 Everyone is welcome to contribute.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "bundler/setup"
 require "bundler/gem_tasks"
 require "rake/testtask"
 
@@ -11,10 +10,28 @@ if !ENV["APPRAISAL_INITIALIZED"] && !ENV["CI"]
 else
   Rake::TestTask.new(:test) do |t|
     t.libs << "test"
-    t.pattern = "test/**/*_test.rb"
-    t.verbose = false
-    t.warning = false
+    t.libs << "lib"
+
+    # Running specific tests with line numbers, like with rails test, is not supported by default in rake.
+    # By setting the TESTOPS env var we can however specify the name of a single test with underscores instead of spaces.
+    # So run your single test by calling for ex:
+    #
+    # rake test /Users/sebastian/projects/cheddar/rails-twirp/test/ping_controller_test.rb "uncaught errors should bubble up to the test"
+
+    file_name = ARGV[1]
+    test_name = ARGV[2]&.tr(" ", "_")
+
+    ENV["TESTOPTS"] = ""
+
+    t.test_files = if file_name
+      if test_name
+        ENV["TESTOPTS"] += " --name=test_#{test_name}"
+      end
+      [file_name]
+    else
+      FileList["test/**/*_test.rb"]
+    end
   end
 
   task default: :test
-end
+end

data/gemfiles/{rails_6_1.gemfile → rails_7_2.gemfile}

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "appraisal"
-gem "ruby-lsp"
-gem "rails", "~> 6.1.0"
+gem "rails", "~> 7.2.0"
+gem "google-protobuf", "~> 3.25", "< 4.0"
 
 gemspec path: "../"

data/gemfiles/{rails_6.gemfile → rails_8_0.gemfile}

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 
 gem "rake"
 gem "appraisal"
-gem "rails", "~> 6.0"
+gem "rails", "~> 8.0.2"
+gem "google-protobuf", "~> 4.0", "< 5.0"
 
 gemspec path: "../"

data/lib/pbbuilder/errors.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require 'pbbuilder'
-
-class Pbbuilder
+class Pbbuilder < BasicObject
   class MergeError < ::StandardError
     def self.build(current_value, updates)
       message = "Can't merge #{updates.inspect} into #{current_value.inspect}"
       self.new(message)
     end
   end
-end
+end

data/lib/pbbuilder/template.rb

@@ -17,6 +17,7 @@ class PbbuilderTemplate < Pbbuilder
   end
 
   # Render a partial. Can be called as:
+  #
   # pb.partial! "name/of_partial", argument: 123
   # pb.partial! "name/of_partial", locals: {argument: 123}
   # pb.partial! partial: "name/of_partial", argument: 123
@@ -30,7 +31,7 @@ class PbbuilderTemplate < Pbbuilder
     end
   end
 
-  # Set the value in the message field.
+  # Sets the value in the message field.
   #
   # @example
   #  pb.friends @friends, partial: "friend", as: :friend
@@ -39,31 +40,30 @@ class PbbuilderTemplate < Pbbuilder
   #  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 any partial options are being passed, we render a submessage with a partial
     if kwargs.has_key?(:partial)
       if args.one? && kwargs.has_key?(:as)
-        # example syntax that should end up here:
+        # 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)
-        # example syntax that should end up here:
+        # 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", [])]
 
         _render_collection_with_options(field, kwargs[:collection], kwargs)
       else
-        # # example syntax that should end up here:
+        # Example syntax that should end up here:
         # pb.best_friend partial: "person", person: @best_friend
-
         super(field, *args) do
           _render_partial_with_options(kwargs)
         end
       end
     else
       if args.one? && kwargs.has_key?(:collection) && kwargs.has_key?(:as)
-        # example syntax that should end up here:
+        # 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
@@ -72,7 +72,7 @@ class PbbuilderTemplate < Pbbuilder
     end
   end
 
-  # Caches fragment of message. Can be called like the following:
+  # Caches a fragment of a message with a given cache key. Can be called like the following:
   # 'pb.cache! "cache-key" do; end'
   # 'pb.cache! "cache-key", expire_in: 1.min do; end'
   #
@@ -107,16 +107,16 @@ class PbbuilderTemplate < Pbbuilder
 
   private
 
-  # Uses ActionView::CollectionRenderer to render collection effectively and to use rails built in fragment caching support.
+  # Uses ActionView::CollectionRenderer to render the 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.
+  # The way recursive rendering works is that the CollectionRenderer needs to be aware of the node it's currently rendering and it's parent node.
+  # There is no need to know the entire "stack" of nodes. ActionView::CollectionRenderer will traverse to the bottom node, render it first and then go one level up in the stack.
+  # Rinse and repeat until the 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.
+  # This logic can be found in the CollectionRenderer#build_rendered_collection method that we overwrote.
   def _render_collection_with_options(field, collection, options)
     partial = options[:partial]
 
@@ -128,15 +128,15 @@ class PbbuilderTemplate < Pbbuilder
     options[:locals].merge!(field: field)
 
     if options.has_key?(:layout)
-      raise ::NotImplementedError, "The `:layout' option is not supported in collection rendering."
+      ::Kernel.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."
+      ::Kernel.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) }
+      .new(@context.lookup_context, options) { |&block| _scope(message[field.to_s], &block) }
       .render_collection_with_partial(collection, partial, @context, nil)
   end
 
@@ -172,10 +172,9 @@ class PbbuilderTemplate < Pbbuilder
         begin
           ::Rails.cache.write(key, value, options)
         rescue ::SystemCallError
-          # In case ActiveSupport::Cache::FileStore in Rails is used as a cache,
-          # File.atomic_write can have a race condition and fail to rename temporary
-          # file. We're attempting to recover from that, by catching this specific
-          # error and returning a value.
+          # In case `ActiveSupport::Cache::FileStore` in Rails is used as a cache,
+          # `File.atomic_write` can have a race condition and fails to rename temporary file.
+          # We're attempting to recover from that by catching this specific error and returning a value.
           #
           # @see https://github.com/rails/rails/pull/44151
           # @see https://github.com/rails/rails/blob/main/activesupport/lib/active_support/core_ext/file/atomic.rb#L50

data/lib/pbbuilder.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require "pbbuilder/pbbuilder"
-require 'pbbuilder/errors'
+require "pbbuilder/errors"
 require "pbbuilder/protobuf_extension"
 require "pbbuilder/railtie" if defined?(Rails)
 
-
-# Pbbuilder makes it easy to create a protobuf message using the builder pattern
+# Pbbuilder makes it easy to create a protobuf message using the builder pattern.
 # It is heavily inspired by jbuilder
 #
 # Given this example message definition:
@@ -15,8 +13,10 @@ require "pbbuilder/railtie" if defined?(Rails)
 #   repeated Person friends = 2;
 # }
 #
-# You could use Pbbuilder as follows:
+# You can use Pbbuilder as follows:
+#
 # person = RPC::Person.new
+#
 # Pbbuilder.new(person) do |pb|
 #   pb.name "Hello"
 #   pb.friends [1, 2, 3] do |number|
@@ -29,7 +29,7 @@ require "pbbuilder/railtie" if defined?(Rails)
 # It basically works exactly like jbuilder. The main difference is that it can use introspection to figure out what kind
 # of protobuf message it needs to create.
 
-class Pbbuilder
+class Pbbuilder < BasicObject
   def initialize(message)
     @message = message
 
@@ -48,11 +48,15 @@ class Pbbuilder
     !!_descriptor_for_field(field)
   end
 
+  # When calling for ex: response.drivers, where response is a Google::Protobuf object, 'drivers' is not a method on that. These
+  # methods (or messages in our case) get added here. This is of course based on what kind of message it is. Singular, an array
+  # (repeated) etc. with their arguments.
   def set!(field, *args, &block)
     name = field.to_s
     descriptor = _descriptor_for_field(name)
-    ::Kernel.raise ::ArgumentError, "Unknown field #{name}" if descriptor.nil?
+    ::Kernel.raise ::ArgumentError, "Unknown field: #{name}" if descriptor.nil?
 
+    # An block is used to pass on it's children
     if ::Kernel.block_given?
       ::Kernel.raise ::ArgumentError, "can't pass block to non-message field" unless descriptor.type == :message
 
@@ -66,9 +70,11 @@ class Pbbuilder
         # 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)
       end
+    # No block given, but with 1 argument
     elsif args.length == 1
       arg = args.first
       if descriptor.label == :repeated
@@ -106,7 +112,7 @@ class Pbbuilder
       else
         # example syntax that should end up here:
         #   pb.field "value"
-        
+
         @message[name] = arg
       end
     else
@@ -128,6 +134,8 @@ class Pbbuilder
     end
   end
 
+  # Shorthand command for getting a few attributes from an object.
+  #     pb.extract! racer, :name, :id, :age
   def extract!(element, *args)
     args.each { |arg| @message[arg.to_s] = element.send(arg) }
   end
@@ -181,6 +189,7 @@ class Pbbuilder
     @message
   end
 
+  # @param field string
   def new_message_for(field)
     descriptor = _descriptor_for_field(field)
     ::Kernel.raise ::ArgumentError, "Unknown field #{field}" if descriptor.nil?
@@ -190,11 +199,14 @@ class Pbbuilder
 
   private
 
+  # Lookup the field name (or 'attribute' name, for ex "best_friend") on the Google descriptor (Google::Protobuf::Descriptor) of our
+  # message object.
+  # @param field string
   def _descriptor_for_field(field)
     @message.class.descriptor.lookup(field.to_s)
   end
 
-  # Appends protobuf message with existing @message object
+  # Appends protobuf objects to our 'repeated' attribute. This can create a list of items to a repeated field.
   #
   # @param name string
   # @param descriptor Google::Protobuf::FieldDescriptor
@@ -210,7 +222,8 @@ class Pbbuilder
     @message[name].push(*elements)
   end
 
-  # Yields an Protobuf object in a scope of message and provided values.
+  # Yields a Protobuf object in the scope of message and provided values.
+  # This will 'assign' the field values as it were to the message attributes.
   #
   # @param message Google::Protobuf::(field_type)
   def _scope(message)
@@ -222,7 +235,7 @@ class Pbbuilder
     @message = old_message
   end
 
-  # Build up empty protobuf message based on descriptor
+  # Builds up an empty protobuf message based on the given descriptor.
   #
   # @param descriptor Google::Protobuf::FieldDescriptor
   def _new_message_from_descriptor(descriptor)

data/pbbuilder.gemspec

@@ -2,20 +2,21 @@
 
 Gem::Specification.new do |spec|
   spec.name = "pbbuilder"
-  spec.version = "0.18.0"
-  spec.authors = ["Bouke van der Bijl"]
-  spec.email = ["bouke@cheddar.me"]
+  spec.version = "0.20.0"
+  spec.authors = ["Bouke van der Bijl", "Julik Tarkhanov", "Stas Katkov", "Sebastian van Hesteren"]
+  spec.email = ["julik@cheddar.me"]
   spec.homepage = "https://github.com/cheddar-me/pbbuilder"
-  spec.summary = "Generate Protobuf Messages with a simple DSL similar to JBuilder"
+  spec.summary = "Generate Protobuf messages with a simple DSL similar to JBuilder"
   spec.license = "MIT"
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.2'
 
   spec.files = `git ls-files`.split("\n")
   spec.test_files = `git ls-files -- test/*`.split("\n")
 
-  spec.add_dependency "google-protobuf", "~> 3.25"
+  spec.add_dependency "google-protobuf", ">= 3.25", "< 5.0"
   spec.add_dependency "activesupport"
-  spec.add_development_dependency 'm'
+  spec.add_development_dependency "m"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
 end

data/test/pbbuilder_template_test.rb

@@ -57,7 +57,7 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
   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
+      pb.friends partial: "racers/racer", collection: racers, cached: true, as: :racer
     PBBUILDER
     result = render(template)
 
@@ -83,7 +83,7 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
   end
 
   test "render collections with partial as arg" do
-    skip("This will be addressed in future version of a gem")
+    skip("This will be addressed in a future version of this 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

data/test/pbbuilder_test.rb

@@ -62,7 +62,7 @@ class PbbuilderTest < ActiveSupport::TestCase
 
     assert_equal(["ok", "that's"], p.field_mask.paths)
   end
-  
+
   test "sets the last value of the repeated field to be the only value" do
     person = Pbbuilder.new(API::Person.new) do |pb|
       pb.field_mask do

data/test/test_helper.rb

@@ -21,28 +21,14 @@ require "pry"
 
 ActiveSupport.test_order = :random
 
-Google::Protobuf::DescriptorPool.generated_pool.build do
-  add_file("pbbuilder.proto", syntax: :proto3) do
-    add_message "pbbuildertest.Person" do
-      optional :name, :string, 1
-      repeated :friends, :message, 2, "pbbuildertest.Person"
-      optional :best_friend, :message, 3, "pbbuildertest.Person"
-      repeated :nicknames, :string, 4
-      optional :field_mask, :message, 5, "google.protobuf.FieldMask"
-      map :favourite_foods, :string, :string, 6
-      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
+# Regenerate Ruby descriptors from proto if needed, and require them.
+# This does require protoc to be installed
+proto_file = File.expand_path("test_proto.proto", __dir__)
+ruby_out = File.expand_path("test_proto_pb.rb", __dir__)
+if !File.exist?(ruby_out) || File.mtime(ruby_out) < File.mtime(proto_file)
+  system("protoc --proto_path=#{File.dirname(proto_file)} --ruby_out=#{File.dirname(ruby_out)} #{proto_file}")
 end
+require_relative "test_proto_pb"
 
 module API
   Person = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pbbuildertest.Person").msgclass
@@ -55,10 +41,16 @@ class << Rails
   end
 end
 
+Pbbuilder::CollectionRenderer.collection_cache = Rails.cache
+
 class Racer < Struct.new(:id, :name, :friends, :best_friend, :logo)
   extend ActiveModel::Naming
   include ActiveModel::Conversion
 
+  def cache_key
+    "racer-#{id}"
+  end
+
   # 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

data/test/test_proto.proto

@@ -0,0 +1,27 @@
+// This is the source proto file from which Ruby proto descriptors are generated.
+// See test/test_helper.rb for the generation process.
+
+syntax = "proto3";
+
+package pbbuildertest;
+
+import "google/protobuf/field_mask.proto";
+
+message Person {
+  string name = 1;
+  repeated Person friends = 2;
+  Person best_friend = 3;
+  repeated string nicknames = 4;
+  google.protobuf.FieldMask field_mask = 5;
+  map<string, string> favourite_foods = 6;
+  repeated string tags = 7;
+  string last_name = 8;
+  bool boolean_me = 9;
+  Asset logo = 10;
+}
+
+message Asset {
+  string url = 1;
+  string url_2x = 2;
+  string url_3x = 3;
+} 

data/test/test_proto_pb.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: test_proto.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/field_mask_pb'
+
+
+descriptor_data = "\n\x10test_proto.proto\x12\rpbbuildertest\x1a google/protobuf/field_mask.proto\"\x81\x03\n\x06Person\x12\x0c\n\x04name\x18\x01 \x01(\t\x12&\n\x07\x66riends\x18\x02 \x03(\x0b\x32\x15.pbbuildertest.Person\x12*\n\x0b\x62\x65st_friend\x18\x03 \x01(\x0b\x32\x15.pbbuildertest.Person\x12\x11\n\tnicknames\x18\x04 \x03(\t\x12.\n\nfield_mask\x18\x05 \x01(\x0b\x32\x1a.google.protobuf.FieldMask\x12\x42\n\x0f\x66\x61vourite_foods\x18\x06 \x03(\x0b\x32).pbbuildertest.Person.FavouriteFoodsEntry\x12\x0c\n\x04tags\x18\x07 \x03(\t\x12\x11\n\tlast_name\x18\x08 \x01(\t\x12\x12\n\nboolean_me\x18\t \x01(\x08\x12\"\n\x04logo\x18\n \x01(\x0b\x32\x14.pbbuildertest.Asset\x1a\x35\n\x13\x46\x61vouriteFoodsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"4\n\x05\x41sset\x12\x0b\n\x03url\x18\x01 \x01(\t\x12\x0e\n\x06url_2x\x18\x02 \x01(\t\x12\x0e\n\x06url_3x\x18\x03 \x01(\tb\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Pbbuildertest
+  Person = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pbbuildertest.Person").msgclass
+  Asset = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pbbuildertest.Asset").msgclass
+end

metadata

@@ -1,29 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: pbbuilder
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Bouke van der Bijl
+- Julik Tarkhanov
+- Stas Katkov
+- Sebastian van Hesteren
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2025-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.25'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.25'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -66,9 +75,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
-- bouke@cheddar.me
+- julik@cheddar.me
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -85,17 +108,12 @@ 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
+- gemfiles/rails_7_2.gemfile
+- gemfiles/rails_8_0.gemfile
 - lib/pbbuilder.rb
 - lib/pbbuilder/collection_renderer.rb
 - lib/pbbuilder/errors.rb
 - lib/pbbuilder/handler.rb
-- lib/pbbuilder/pbbuilder.rb
 - lib/pbbuilder/protobuf_extension.rb
 - lib/pbbuilder/railtie.rb
 - lib/pbbuilder/template.rb
@@ -104,6 +122,8 @@ files:
 - test/pbbuilder_test.rb
 - test/protobuf_extension_test.rb
 - test/test_helper.rb
+- test/test_proto.proto
+- test/test_proto_pb.rb
 homepage: https://github.com/cheddar-me/pbbuilder
 licenses:
 - MIT
@@ -116,19 +136,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: Generate Protobuf Messages with a simple DSL similar to JBuilder
+summary: Generate Protobuf messages with a simple DSL similar to JBuilder
 test_files:
 - test/pbbuilder_template_test.rb
 - test/pbbuilder_test.rb
 - test/protobuf_extension_test.rb
 - test/test_helper.rb
+- test/test_proto.proto
+- test/test_proto_pb.rb

data/gemfiles/rails_7.gemfile

@@ -1,9 +0,0 @@
-# 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

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

data/gemfiles/rails_7_1.gemfile

@@ -1,10 +0,0 @@
-# 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/gemfiles/rails_head.gemfile

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

data/lib/pbbuilder/pbbuilder.rb

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