pbbuilder 0.14.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d829e7e9831b4b7190db4aa3d426a68b6073156895479d243321692bd653fea
-  data.tar.gz: 72498247f4a3ee30e403e01ed01be4cd68b17c369e5c10ca83a6be97b0397b6a
+  metadata.gz: dc165db83a23b9c5bf32a6921b3cd959171083d48f7a6887df8c524f9920d574
+  data.tar.gz: 7d3631f19dea340592918300b66e6d024889fe2c18776c729d4bebdb9424ad4b
 SHA512:
-  metadata.gz: fbe8929f56b70421a55902c8b30248740e5bfb68b2f14f1017b384a2a5ce9202ed0bed89ae3c4e8aea011e83e2d7ef36856f1d069f3179cad5e71c5b572b1a1e
-  data.tar.gz: 04dd8c8f46b1f1120e5d3e964cd28efd101dbf44f7f2f08381d7e3e614270b5dc042ff365d944239c9776cdd040ac7add6511c58ab738499f76f9d4e6df2f533
+  metadata.gz: ad453cd1f12f8a71f05b98c5d60e34837848f1c4bdbe403d41a407762b980d5f47c6dc16925b01f2927fef427cb82b5a4b23801102fa7a46d280adf1245afe2f
+  data.tar.gz: 1b0bb8019d473e1a433e3009ece6976d7a42992e00d207290106fef8a7de3fd16de5c49caaf6dc23a39aab5cdd6369caae06f62b34def0f431e6c16361210e03

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.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.

data/README.md

@@ -1,21 +1,26 @@
 # Pbbuilder
 PBBuilder generates [Protobuf](https://developers.google.com/protocol-buffers) Messages with a simple DSL similar to [JBuilder](https://rubygems.org/gems/jbuilder) gem.
 
-## Usage
-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.
+## Compatibility
+We don't aim to have 100% compatibility with jbuilder gem, but we closely follow jbuilder's API design. 
+
+| | Jbuilder | Pbbuilder |
+|---|---|---|
+|  set! | ✅ | ✅ |
+|  cache! | ✅ | ✅ |
+|  cache_if! | ✅ | ✅ |
+| cache_root! | ✅|  |
+| extract! | ✅ | ✅ |
+| merge! | ✅ | ✅ |
+| deep_format_keys! | ✅ |  |
+| child! | ✅ |  |
+| array! | ✅ |  |
+| ignore_nil! | ✅ |  |
 
+## Usage
+The main difference is that it can use introspection to figure out what kind of protobuf message it needs to create.
 
-Following Pbbuilder code
-```
-person = RPC::Person.new
- Pbbuilder.new(person) do |pb|
-   pb.name "Hello"
-   pb.friends [1, 2, 3] do |number|
-     pb.name "Friend ##{number}"
-   end
- end
-```
-Would produce this message:
+This is an example `.proto` message.
 
 ```
 message Person {
@@ -24,6 +29,52 @@ message Person {
 }
 ```
 
+The following `.pb` file would generate a message of valid Person type.
+```
+person = RPC::Person.new
+
+Pbbuilder.new(person) do |pb|
+  pb.name "Hello"
+  pb.friends [1, 2, 3] do |number|
+    pb.name "Friend ##{number}"
+  end
+end
+```
+
+Under the hood, this DSL is using `method_missing` and `set!` methods. But there are other methods and features to use.
+
+### extract!
+The following `_account.pb.pbbuilder` partial:
+```
+pb.id account.id
+pb.phone_number account.phone_number
+pb.tag account.tag
+```
+
+could be rewritten to a shorter version with a use of `extract!`.
+```
+pb.extract! account, :id, :phone_number, :tag
+```
+
+### Partials
+Given partial `_account.pb.pbuilder`:
+
+```
+pb.name account.name
+pb.registration_date account.created_at
+```
+
+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
+
+```
+pb.accounts @accounts, partial: "account", as: account
+```
 
 ### Caching
 Fragment caching is supported, it uses Rails.cache and works like caching in HTML templates:
@@ -42,7 +93,6 @@ pb.cache_if! !admin?, "cache-key", expires_in: 10.minutes do
 end
 ```
 
-
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -59,10 +109,20 @@ Or install it yourself as:
 ```bash
 $ gem install pbbuilder
 ```
+## Development
 
-## Contributing
+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.
 
-When debugging, make sure you're prepending `::Kernel` to any calls such as `puts` as otherwise the code will think you're trying to add another attribute onto the protobuf.
+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).
+
+## 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`
+
+## 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/lib/pbbuilder.rb

@@ -116,33 +116,63 @@ class Pbbuilder
     ::Kernel.raise Pbbuilder::MergeError.build(target!, object) unless object.class == ::Hash
 
     object.each_key do |key|
-      if object[key].respond_to?(:empty?) && object[key].empty?
-        ::Kernel.raise Pbbuilder::MergeError.build(target!, object)
-      end
+      next if object[key].respond_to?(:empty?) && object[key].empty?
 
-      if object[key].class == ::String
-        # pb.fields {"one" => "two"}
-        @message[key.to_s] = object[key]
-      elsif object[key].class == ::Array
-        # pb.tags ['test', 'ok']
-        @message[key.to_s].replace object[key]
-      elsif object[key].class == ::TrueClass || object[key].class == ::FalseClass
-        # pb.boolean true || false
-        @message[key.to_s] = object[key]
-      elsif ( obj = object[key]).class == ::Hash
-        # pb.field_name do
-        #    pb.tags ["ok", "cool"]
-        # end
-        #
+      descriptor = @message.class.descriptor.lookup(key.to_s)
+      ::Kernel.raise ::ArgumentError, "Unknown field #{name}" if descriptor.nil?
 
+      if descriptor.label == :repeated
         # optional empty fields don't show up in @message object,
         # we recreate empty message, so we can fill it with values
         if @message[key.to_s].nil?
-          field_descriptor = @message.class.descriptor.lookup(key.to_s)
-          @message[key.to_s] = _new_message_from_descriptor(field_descriptor)
+          @message[key.to_s] = _new_message_from_descriptor(descriptor)
         end
 
-        @message[key.to_s] = _scope(@message[key.to_s]) { self.merge!(obj) }
+        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|
+            descriptor.subtype ? descriptor.subtype.msgclass.new(obj) : obj
+          end
+
+          @message[key.to_s].replace(elements)
+        end
+      else
+        if object[key].class == ::String
+          # 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
+        end
       end
     end
   end

data/pbbuilder.gemspec

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

@@ -103,19 +103,51 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
   end
 
   test "should raise Error in merge! an empty hash" do
-    assert_raise(ActionView::Template::Error) {
+    assert_nothing_raised {
       render(<<-PBBUILDER)
         pb.merge! "name" => {}
       PBBUILDER
     }
 
-    assert_raise(ActionView::Template::Error) {
+    assert_nothing_raised {
       render(<<-PBBUILDER)
         pb.merge! "" => {}
       PBBUILDER
     }
   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'
 
@@ -131,6 +163,39 @@ class PbbuilderTemplateTest < ActiveSupport::TestCase
     assert_equal "suslik", result["name"]
   end
 
+  test "caching repeated partial" do
+    template = <<-PBBUILDER
+      pb.cache! "some-random-key" do
+        pb.friends @friends, partial: "racers/racer", as: :racer
+      end
+    PBBUILDER
+    friends = [Racer.new(1, "Johnny Test", []), Racer.new(2, "Max Verstappen", [])]
+
+    result = assert_nothing_raised { render(template, friends: friends) }
+    assert_equal("Johnny Test", result.friends[0].name)
+    assert_equal("Max Verstappen", result.friends[1].name)
+
+    result = render('pb.cache! "some-random-key" do; end ')
+    assert_equal("Johnny Test", result.friends[0].name)
+    assert_equal("Max Verstappen", result.friends[1].name)
+  end
+
+  test "caching map values" do
+    template = <<-PBBUILDER
+      pb.cache! "some-random-cache-key" do
+        pb.favourite_foods @foods
+      end
+    PBBUILDER
+
+    r = assert_nothing_raised { render( template, foods: {'pizza' => 'yes', 'borsh' => 'false'})}
+    assert_equal('false', r.favourite_foods['borsh'])
+    assert_equal('yes', r.favourite_foods['pizza'])
+
+    result = render('pb.cache! "some-random-cache-key" do; end ')
+    assert_equal('false', result.favourite_foods['borsh'])
+    assert_equal('yes', result.favourite_foods['pizza'])
+  end
+
   test "object fragment caching" do
     render(<<-PBBUILDER)
       pb.cache! "cache-key" do

data/test/test_helper.rb

@@ -17,6 +17,7 @@ require "google/protobuf"
 require "google/protobuf/field_mask_pb"
 
 require "active_support/testing/autorun"
+require "pry"
 
 ActiveSupport.test_order = :random
 
@@ -32,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.14.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf