pbbuilder 0.16.2 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f61e783abb61817e05f29772b6614314646c0fda6f24a5f73f556ebc19d0f97
-  data.tar.gz: 34cf6626e2f60aa50a7ee2e7278a0149557263d023dee6a758e4adf2d8e0d263
+  metadata.gz: 75cb2682f8933e0e8acb2b3bb6a525df5447dab8a65b2d8509f54a3c2b430c35
+  data.tar.gz: '0282cfeb404460224fd8cb2d32d134335b9d307d2edefc4af854368b9c8788e1'
 SHA512:
-  metadata.gz: 15f60555cb89a70e0b28490db9bc00e4b9ca7ed34f179a5df0576d6a70ef737c9d7acc66e686b0b0216a003e043c967162d377087a443f3057470e4396889e4e
-  data.tar.gz: fd6e5587bd3d8bafc4988f089901afe2848c577243b5d9b105e629b92c3f7cbc522fbe218f9be59ca29605af27c034c423f244c8df0208dd72d9b67bf4831143
+  metadata.gz: d429891ca19333b9e626ccd9bf63462fbe61eea672c8ac14f427aafdc392a2f12e36370e63f1a4522c384b4375e81433d63d804f447d508346744aedca448fbf
+  data.tar.gz: 1af6634160780c84f93a99d9b6b282e90500da24d654bfa36f1220b48260bec074412da69f83267a2df8f935e33218b332a27cf102765e6eff7b3db853ec686e

data/CHANGELOG.md

@@ -3,6 +3,14 @@ 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.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`

data/README.md

@@ -4,6 +4,11 @@ PBBuilder generates [Protobuf](https://developers.google.com/protocol-buffers) M
 
 At least Rails 6.1 is required.
 
+> [!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.
+
 ## 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.
 

data/lib/pbbuilder.rb

@@ -75,25 +75,38 @@ class Pbbuilder
         if arg.respond_to?(:to_hash)
           # 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"]
-          # Using concat so it behaves the same as _append_repeated
 
-          @message[name].concat arg.to_ary
+          @message[name].replace arg.to_ary
         elsif arg.respond_to?(:to_ary) && descriptor.type.eql?(:message)
-          # 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)}
+          # pb.friends [Person.new(name: "Johnny Test"), Person.new(name: "Max Verstappen")]
+          #
+          # Accepts both objects that can be to_hash-translated into keyword arguments
+          # for creating a nested proto message object and actual proto message objects
+          # which can be assigned "as is". With "as-is" assignment the proto message can be stored
+          # in memory and reused
+          nested_messages = arg.map do |arg_member_message_or_hash|
+            # If the arg passed already is a proto message and is the same as the
+            # field expects - just use it as-is
+            if arg_member_message_or_hash.is_a?(descriptor.subtype.msgclass)
+              arg_member_message_or_hash
+            else
+              descriptor.subtype.msgclass.new(arg_member_message_or_hash)
+            end
+          end
+          @message[name].replace(nested_messages)
         else
           # example syntax that should end up here:
           #   pb.fields "one"
-          @message[name].push arg
+          @message[name].replace [arg]
         end
       else
         # example syntax that should end up here:
         #   pb.field "value"
+        
         @message[name] = arg
       end
     else
@@ -220,4 +233,4 @@ class Pbbuilder
     message_class = message_descriptor.msgclass
     message_class.new
   end
-end
+end

data/pbbuilder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "pbbuilder"
-  spec.version = "0.16.2"
+  spec.version = "0.18.0"
   spec.authors = ["Bouke van der Bijl"]
   spec.email = ["bouke@cheddar.me"]
   spec.homepage = "https://github.com/cheddar-me/pbbuilder"
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files`.split("\n")
   spec.test_files = `git ls-files -- test/*`.split("\n")
 
-  spec.add_dependency "google-protobuf"
+  spec.add_dependency "google-protobuf", "~> 3.25"
   spec.add_dependency "activesupport"
   spec.add_development_dependency 'm'
   spec.add_development_dependency "pry"

data/test/pbbuilder_test.rb

@@ -25,11 +25,55 @@ class PbbuilderTest < ActiveSupport::TestCase
 
     assert_equal "Hello world", person.name
     assert_equal "Friend #1", person.friends.first.name
-    assert_equal ["ok", "that's", "cool"], person.field_mask.paths
+    assert_equal ["cool"], person.field_mask.paths
     assert_equal "Manuelo", person.best_friend.name
     assert_equal "Eggs", person.favourite_foods["Breakfast"]
   end
 
+  test "allows assignment of prefab nested proto messages" do
+    max_proto = API::Person.new(name: "Max Verstappen")
+    james_proto = API::Person.new(name: "James Hunt")
+    friend_protos = [max_proto, james_proto]
+
+    person = Pbbuilder.new(API::Person.new) do |pb|
+      pb.name "Niki Lauda"
+      pb.friends friend_protos
+      pb.best_friend james_proto
+    end.target!
+
+    assert_equal "Niki Lauda", person.name
+    assert_equal "Max Verstappen", person.friends[0].name
+    assert_equal "James Hunt", person.friends[1].name
+    assert_equal "James Hunt", person.best_friend.name
+  end
+
+  test "replaces the repeated field's value with the last one set" do
+    person = Pbbuilder.new(API::Person.new) do |pb|
+      pb.field_mask do
+        pb.paths ["ok", "that's"]
+      end
+    end.target!
+
+    p = Pbbuilder.new(person) do |pb|
+      pb.field_mask do
+        pb.paths ["ok", "that's"]
+      end
+    end.target!
+
+    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
+        pb.paths ["ok", "that's"]
+        pb.paths ["cool"]
+      end
+    end.target!
+
+    assert_equal ["cool"], person.field_mask.paths
+  end
+
   test "it can extract fields in a nice way" do
     klass = Struct.new(:name)
     friends = [klass.new("Friend 1"), klass.new("Friend 2")]

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pbbuilder
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.18.0
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-18 00:00:00.000000000 Z
+date: 2024-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.25'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Generate Protobuf Messages with a simple DSL similar to JBuilder