pbbuilder 0.3.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1699e497c5f64a42a5d2233993352dc40669dee7e95b7cff0fae33dfb531d51b
-  data.tar.gz: 91f2062978f63623af38e58e84b69a54d14d126f0921e2a467fbc5d14ca7a60e
+  metadata.gz: e22f13cb28a04d0b767c619b7c63c91e86a246d524abc200e5062d92cadb977e
+  data.tar.gz: b323e88b227263bfbd4ebc8b0e50f05208afe24527a2069e1110a6a605e453cb
 SHA512:
-  metadata.gz: 925dc28280852d7844ef1404e13e10b016b0f4121ca790011d7b4241ed3a8c843a1045fd8a11e3e489cf50c1cbe3b4176f17f5e29f00f688d189420626a081f6
-  data.tar.gz: 15b1f3fba2ad2e0404c9dd1df9fdeb0947c0f1c8f4f46e4f6e9a4a0d1ec1368a5891303e0a5cf3088eff60856cd465f8ef0de413999d5e7719b0e9dab09d7991
+  metadata.gz: c245be23b0283a134b1dc28b1ab29d96bd9ca0023456f9e984ff3406b164f057147ab9e366bdcf150236fe494417ef182480cc1d89a53880c684403efb60bb95
+  data.tar.gz: e4c4bbd500f921b0b2a71a7fc0e23ec99ea005a872f7f0d66a72f04cca712de54ef3e4898023bf22880eedb9afe990d9fac54dfce62ae164fd4c0b267bfc03bb

data/.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: ruby
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.7", "3.0.1"]
+    name: tests for ruby-${{ matrix.ruby }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Run tests
+        run: bin/test

data/.gitignore

@@ -11,3 +11,4 @@
 .byebug_history
 Gemfile.lock
 *.gem
+/.idea

data/README.md

@@ -22,7 +22,8 @@ $ gem install pbbuilder
 ```
 
 ## Contributing
-Contribution directions go here.
+
+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.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/pbbuilder.rb

@@ -28,8 +28,8 @@ class Pbbuilder < BasicObject
     yield self if ::Kernel.block_given?
   end
 
-  def method_missing(field, *args, &block)
-    set!(field, *args, &block)
+  def method_missing(...)
+    set!(...)
   end
 
   def respond_to_missing?(field)
@@ -39,24 +39,43 @@ class Pbbuilder < BasicObject
   def set!(field, *args, &block)
     name = field.to_s
     descriptor = @message.class.descriptor.lookup(name)
+    ::Kernel.raise ::ArgumentError, "Unknown field #{name}" if descriptor.nil?
 
     if block
-      raise ::ArgumentError, "can't pass block to non-message field" unless descriptor.type == :message
+      ::Kernel.raise ::ArgumentError, "can't pass block to non-message field" unless descriptor.type == :message
 
       if descriptor.label == :repeated
-        # pb.field @array { |element| pb.name = element.name }
-        raise ::ArgumentError, "wrong number of arguments (expected 1)" unless args.length == 1
+        # pb.field @array { |element| pb.name element.name }
+        ::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
       end
 
-      raise ::ArgumentError, "wrong number of arguments (expected 0)" unless args.empty?
-      # pb.field { pb.name = "hello" }
+      ::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
-      @message[name] = args.first
+      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)
+          # pb.fields ["one", "two"]
+          # Using concat so it behaves the same as _append_repeated
+          @message[name].concat arg.to_ary
+        else
+          # pb.fields "one"
+          @message[name].push arg
+        end
+      else
+        # pb.field "value"
+        @message[name] = arg
+      end
     else
       # pb.field @value, :id, :name, :url
       element = args.shift
@@ -89,7 +108,7 @@ class Pbbuilder < BasicObject
   private
 
   def _append_repeated(name, descriptor, collection, &block)
-    raise ::ArgumentError, "expected Enumerable" unless collection.respond_to?(:map)
+    ::Kernel.raise ::ArgumentError, "expected Enumerable" unless collection.respond_to?(:map)
     elements = collection.map do |element|
       message = _new_message_from_descriptor(descriptor)
       _scope(message) { block.call(element) }
@@ -108,7 +127,7 @@ class Pbbuilder < BasicObject
   end
 
   def _new_message_from_descriptor(descriptor)
-    raise ::ArgumentError, "can't pass block to non-message field" unless descriptor.type == :message
+    ::Kernel.raise ::ArgumentError, "can't pass block to non-message field" unless descriptor.type == :message
 
     # Here we're using Protobuf reflection to create an instance of the message class
     message_descriptor = descriptor.subtype
@@ -117,4 +136,5 @@ class Pbbuilder < BasicObject
   end
 end
 
+require "pbbuilder/protobuf_extension"
 require "pbbuilder/railtie" if defined?(Rails)

data/lib/pbbuilder/handler.rb

@@ -1,3 +1,5 @@
+require "pbbuilder/template"
+
 # Basically copied and pasted from JbuilderHandler, except it uses Pbbuilder
 
 class PbbuilderHandler
@@ -6,7 +8,7 @@ class PbbuilderHandler
   def self.call(template, source = nil)
     source ||= template.source
     # We need to keep `source` on the first line, so line numbers are correct if there's an error
-    %{pb=Pbbuilder.new(@_response_class.new); #{source}
-      pb.target!}
+    %{__already_defined = defined?(pb); pb ||= PbbuilderTemplate.new(self, @_response_class.new); #{source}
+      pb.target! unless (__already_defined && __already_defined != "method")}
   end
 end

data/lib/pbbuilder/protobuf_extension.rb

@@ -0,0 +1,7 @@
+require "google/protobuf/message_exts"
+
+module Google::Protobuf::MessageExts::ClassMethods
+  def build(*args, &block)
+    Pbbuilder.new(new(*args), &block).target!
+  end
+end

data/lib/pbbuilder/template.rb

@@ -0,0 +1,97 @@
+# PbbuilderTemplate is an extension of Pbbuilder to be used as a Rails template
+# It adds support for partials.
+class PbbuilderTemplate < Pbbuilder
+  class << self
+    attr_accessor :template_lookup_options
+  end
+
+  self.template_lookup_options = {handlers: [:pbbuilder]}
+
+  def initialize(context, message)
+    @context = context
+    super(message)
+  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
+  # pb.partial! partial: "name/of_partial", locals: {argument: 123}
+  # pb.partial! @model # @model is an ActiveModel value, it will use the name to look up a partial
+  def partial!(*args)
+    if args.one? && _is_active_model?(args.first)
+      _render_active_model_partial args.first
+    else
+      _render_explicit_partial(*args)
+    end
+  end
+
+  def set!(field, *args, **kwargs, &block)
+    # If partial options are being passed, we render a submessage with a partial
+    if kwargs.has_key?(:partial)
+      if args.one? && kwargs.has_key?(:as)
+        # 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
+      else
+        # pb.best_friend partial: "person", person: @best_friend
+        # Call set! as a submessage, passing in the kwargs as partial options
+        super(field, *args) do
+          _render_partial_with_options(kwargs)
+        end
+      end
+    else
+      super
+    end
+  end
+
+  private
+
+  def _is_active_model?(object)
+    object.class.respond_to?(:model_name) && object.respond_to?(:to_partial_path)
+  end
+
+  def _render_explicit_partial(name_or_options, locals = {})
+    case name_or_options
+    when ::Hash
+      # partial! partial: 'name', foo: 'bar'
+      options = name_or_options
+    else
+      # partial! 'name', locals: {foo: 'bar'}
+      options = if locals.one? && (locals.keys.first == :locals)
+        locals.merge(partial: name_or_options)
+      else
+        {partial: name_or_options, locals: locals}
+      end
+      # partial! 'name', foo: 'bar'
+      as = locals.delete(:as)
+      options[:as] = as if as.present?
+      options[:collection] = locals[:collection] if locals.key?(:collection)
+    end
+
+    _render_partial_with_options options
+  end
+
+  def _render_active_model_partial(object)
+    @context.render object, pb: self
+  end
+
+  def _set_inline_partial(object, options)
+    locals = ::Hash[options[:as], object]
+    _render_partial_with_options options.merge(locals: locals)
+  end
+
+  def _render_partial_with_options(options)
+    options.reverse_merge! locals: options.except(:partial, :as, :collection)
+    options.reverse_merge! ::PbbuilderTemplate.template_lookup_options
+
+    _render_partial options
+  end
+
+  def _render_partial(options)
+    options[:locals][:pb] = self
+    @context.render options
+  end
+end

data/pbbuilder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "pbbuilder"
-  spec.version = "0.3.0"
+  spec.version = "0.8.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

@@ -0,0 +1,107 @@
+require "test_helper"
+require "action_view/testing/resolvers"
+
+class PbbuilderTemplateTest < ActiveSupport::TestCase
+  PERSON_PARTIAL = <<-PBBUILDER
+    pb.extract! person, :name
+  PBBUILDER
+
+  RACER_PARTIAL = <<-PBBUILDER
+    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?
+  PBBUILDER
+
+  PARTIALS = {
+    "_partial.pb.pbbuilder" => "pb.name name",
+    "_person.pb.pbbuilder" => PERSON_PARTIAL,
+    "racers/_racer.pb.pbbuilder" => RACER_PARTIAL,
+
+    # Ensure we find only Pbbuilder partials from within Pbbuilder templates.
+    "_person.html.erb" => "Hello world!"
+  }
+
+  test "basic template" do
+    result = render('pb.name "hello"')
+    assert_equal "hello", result.name
+  end
+
+  test "partial by name with top-level locals" do
+    result = render('pb.partial! "partial", name: "hello"')
+    assert_equal "hello", result.name
+  end
+
+  test "submessage partial" do
+    other_racer = Racer.new(2, "Max Verstappen", [])
+    racer = Racer.new(123, "Chris Harris", [], other_racer)
+    result = render('pb.best_friend partial: "person", person: @racer.best_friend', racer: racer)
+    assert_equal "Max Verstappen", result.best_friend.name
+  end
+
+  test "hash" do
+    result = render('pb.favourite_foods "pizza" => "yes"')
+    assert_equal({"pizza" => "yes"}, result.favourite_foods.to_h)
+  end
+
+  test "partial by name with nested locals" do
+    result = render('pb.partial! "partial", locals: { name: "hello" }')
+    assert_equal "hello", result.name
+  end
+
+  test "partial by options containing nested locals" do
+    result = render('pb.partial! partial: "partial", locals: { name: "hello" }')
+    assert_equal "hello", result.name
+  end
+
+  test "partial by options containing top-level locals" do
+    result = render('pb.partial! partial: "partial", name: "hello"')
+    assert_equal "hello", result.name
+  end
+
+  test "partial for Active Model" do
+    result = render("pb.partial! @racer", racer: Racer.new(123, "Chris Harris", []))
+    assert_equal "Chris Harris", result.name
+  end
+
+  test "collection partial" do
+    friends = [Racer.new(1, "Johnny Test", []), Racer.new(2, "Max Verstappen", [])]
+    result = render("pb.partial! @racer", racer: Racer.new(123, "Chris Harris", friends))
+    assert_equal 2, result.friends.size
+    assert_equal "Johnny Test", result.friends[0].name
+    assert_equal "Max Verstappen", result.friends[1].name
+  end
+
+  test "nested message partial" do
+    other_racer = Racer.new(2, "Max Verstappen", [])
+    result = render("pb.partial! @racer", racer: Racer.new(123, "Chris Harris", [], other_racer))
+    assert_equal "Max Verstappen", result.best_friend.name
+  end
+
+  private
+
+  def render(*args)
+    render_without_parsing(*args)
+  end
+
+  def render_without_parsing(source, assigns = {})
+    view = build_view(fixtures: PARTIALS.merge("source.pb.pbbuilder" => source), assigns: assigns)
+    view.render(template: "source", handlers: [:pbbuilder], formats: [:pb])
+  end
+
+  def build_view(options = {})
+    resolver = ActionView::FixtureResolver.new(options.fetch(:fixtures))
+    lookup_context = ActionView::LookupContext.new([resolver], {}, [""])
+    controller = ActionView::TestCase::TestController.new
+
+    assigns = options.fetch(:assigns, {})
+    assigns.reverse_merge! _response_class: API::Person
+
+    view = ActionView::Base.with_empty_template_cache.new(lookup_context, assigns, controller)
+
+    def view.view_cache_dependencies
+      []
+    end
+
+    view
+  end
+end

data/test/pbbuilder_test.rb

@@ -1,5 +1,4 @@
 require "test_helper"
-require "pbbuilder"
 
 class PbbuilderTest < ActiveSupport::TestCase
   test "it makes it possible to create a person" do
@@ -8,9 +7,25 @@ class PbbuilderTest < ActiveSupport::TestCase
       pb.friends 1..3 do |number|
         pb.name "Friend ##{number}"
       end
+      pb.best_friend do
+        pb.name "Manuelo"
+      end
+      pb.field_mask do
+        pb.paths ["ok", "that's"]
+        pb.paths "cool"
+      end
+      pb.favourite_foods({
+        "Breakfast" => "Eggs",
+        "Lunch" => "Shawarma",
+        "Dinner" => "Pizza"
+      })
     end.target!
-    assert_equal person.name, "Hello world"
-    assert_equal person.friends.first.name, "Friend #1"
+
+    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 "Manuelo", person.best_friend.name
+    assert_equal "Eggs", person.favourite_foods["Breakfast"]
   end
 
   test "it can extract fields in a nice way" do

data/test/protobuf_extension_test.rb

@@ -0,0 +1,18 @@
+require "test_helper"
+
+class ProtobufExtensionTest < ActiveSupport::TestCase
+  test ".build" do
+    person = API::Person.build(name: "Hello world!") do |pb|
+      pb.best_friend do
+        pb.name "Johnny"
+      end
+    end
+    assert_equal "Hello world!", person.name
+    assert_equal "Johnny", person.best_friend.name
+  end
+
+  test ".build without block" do
+    person = API::Person.build
+    assert_equal "", person.name
+  end
+end

data/test/test_helper.rb

@@ -5,9 +5,20 @@ require "rails"
 require "rails/test_help"
 require "rails/test_unit/reporter"
 
+require "active_support"
+require "active_support/core_ext/array/access"
+require "active_support/cache/memory_store"
+require "active_support/json"
+require "active_model"
+require "action_view"
+require "rails/version"
+
+require "pbbuilder"
+
 Rails::TestUnitReporter.executable = "bin/test"
 
 require "google/protobuf"
+require "google/protobuf/field_mask_pb"
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("pbbuilder.proto", syntax: :proto3) do
@@ -15,6 +26,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build 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
     end
   end
 end
@@ -22,3 +36,10 @@ end
 module API
   Person = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pbbuildertest.Person").msgclass
 end
+
+class Racer < Struct.new(:id, :name, :friends, :best_friend)
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+end
+
+ActionView::Template.register_template_handler :pbbuilder, PbbuilderHandler

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pbbuilder
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Bouke van der Bijl
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2021-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - Gemfile
 - MIT-LICENSE
@@ -39,10 +40,14 @@ files:
 - bin/test
 - lib/pbbuilder.rb
 - lib/pbbuilder/handler.rb
+- lib/pbbuilder/protobuf_extension.rb
 - lib/pbbuilder/railtie.rb
+- lib/pbbuilder/template.rb
 - lib/tasks/pbbuilder_tasks.rake
 - pbbuilder.gemspec
+- test/pbbuilder_template_test.rb
 - test/pbbuilder_test.rb
+- test/protobuf_extension_test.rb
 - test/test_helper.rb
 homepage: https://github.com/cheddar-me/pbbuilder
 licenses:
@@ -68,5 +73,7 @@ signing_key:
 specification_version: 4
 summary: Generate Protobuf messages via a Builder-style DSL
 test_files:
+- test/pbbuilder_template_test.rb
 - test/pbbuilder_test.rb
+- test/protobuf_extension_test.rb
 - test/test_helper.rb