pbbuilder 0.6.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3f417c956ceb3a2123489021f4cc401b7bf56399355fb6bb0d4ebaa437d1cb2
-  data.tar.gz: '0408c3174481e7aa7e22f129829a973f822a7245d57c3e93bad2ef564d3ee05f'
+  metadata.gz: cc495285bd745ade01ad6dc96698eff9ffdabf2a60154f8714a39d6f69ad1524
+  data.tar.gz: 30083b95fa612fbcb39df4b88bcb8af170e4d78a4b2ca407ab75bf30d767e990
 SHA512:
-  metadata.gz: e7476c24846d78dd0dc011372998bb54301a673510ccc8cffe540714db1a991ba6b36c14ec0eb45572aef1880e9cb638870be38a7a510c4edb501eb0da670278
-  data.tar.gz: 3027ae2509d083bd9da6a02bf9732c43038534992790017a3bdb00ba1bb80179d650d1a12d6f136af036854a5944125cad64d7b17268b084609f3642e8f7dbfc
+  metadata.gz: 649b1beb020c09e1f5167b8882d7fd8e6578f29c45f51fb807a6ff4a749e6dd0be0a76111e7947aaccf967ab8f6364bb1878eb31fcf7bd65e78d871851416461
+  data.tar.gz: ef254cdf2acd93e0dbdbf9d49c20653ec8f12b0700fe9853faf3eaa2ac1495bd3e8ff8a4ea3516e031acb88c0ebb859f4291fe6e82a8161aabd3ae5b6fb90d76

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/railtie.rb

@@ -4,6 +4,7 @@ class Pbbuilder
   class Railtie < ::Rails::Railtie
     initializer :register_handler do
       ActiveSupport.on_load :action_view do
+        ActionView::Template::Types.symbols << :pb
         ActionView::Template.register_template_handler :pbbuilder, PbbuilderHandler
       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/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,19 +39,20 @@ 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
+        ::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?
+      ::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)
@@ -107,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) }
@@ -126,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

data/pbbuilder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "pbbuilder"
-  spec.version = "0.6.0"
+  spec.version = "0.10.0"
   spec.authors = ["Bouke van der Bijl"]
   spec.email = ["bouke@cheddar.me"]
   spec.homepage = "https://github.com/cheddar-me/pbbuilder"
@@ -10,5 +10,5 @@ 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", "~> 3.15.5"
+  spec.add_dependency "google-protobuf", "~> 3.17.3"
 end

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/test_helper.rb

@@ -4,6 +4,15 @@ ENV["RAILS_ENV"] = "test"
 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"
@@ -27,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.6.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Bouke van der Bijl
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -16,15 +16,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.15.5
+        version: 3.17.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.15.5
-description: 
+        version: 3.17.3
+description:
 email:
 - bouke@cheddar.me
 executables: []
@@ -42,8 +42,10 @@ files:
 - 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
@@ -51,7 +53,7 @@ homepage: https://github.com/cheddar-me/pbbuilder
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,11 +68,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.22
+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