pbbuilder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95c1a8225cbe27f9523fe58f6e0a706108ae12839d1b091b6a2a70d02d5363cc
+  data.tar.gz: b133c221d7f27e76626632c488309c4c1d8c929e1725d34298847c42ad5f7350
+SHA512:
+  metadata.gz: 033030a337a7b3a7e334719d564dfe098c7e1f7b54e8cea18ace761d51adb091c7fbe0b6b42d527ebc1e3b622e8d3332f4400a1444e263b55c2a95cf9a8e92fd
+  data.tar.gz: 76f971940ae26fcd1360552cec8e5e9bb3160f21a39e36184d2bc700524f480c1b5261781dd760be5d33d702c4e2a95739e5f32d890d348f6f698dc0ee1a315f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/doc/
+/log/*.log
+/pkg/
+/tmp/
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-*
+/test/dummy/log/*.log
+/test/dummy/storage/
+/test/dummy/tmp/
+.byebug_history
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pbbuilder.gemspec.
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Bouke van der Bijl
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Pbbuilder
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pbbuilder'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install pbbuilder
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/bin/test

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("../test", __dir__)
+
+require "bundler/setup"
+require "rails/plugin/test"

data/lib/pbbuilder.rb

@@ -0,0 +1,118 @@
+# Pbbuilder makes it easy to create a protobuf message using the builder pattern
+# It is heavily inspired by jbuilder
+#
+# Given this example message definition:
+# message Person {
+#   string name = 1;
+#   repeated Person friends = 2;
+# }
+#
+# You could use Pbbuilder as follows:
+# 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
+#
+# message.name => "Hello"
+#
+# 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
+  def initialize(message)
+    @message = message
+
+    yield self if ::Kernel.block_given?
+  end
+
+  def method_missing(field, *args, &block)
+    set!(field, *args, &block)
+  end
+
+  def respond_to_missing?(field)
+    !!@message.class.descriptor.lookup(field.to_s)
+  end
+
+  def set!(field, *args, &block)
+    name = field.to_s
+    descriptor = @message.class.descriptor.lookup(name)
+
+    if block
+      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
+        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" }
+      message = (@message[name] ||= _new_message_from_descriptor(descriptor))
+      _scope(message, &block)
+    elsif args.length == 1
+      @message[name] = args.first
+    else
+      # pb.field @value, :id, :name, :url
+      element = args.shift
+      if descriptor.label == :repeated
+        # If the message field that's being assigned is a repeated field, then we assume that `element` is enumerable.
+        # This way you can do something like pb.repeated_field @array, :id, :name
+        # This will create a message out of every object in @array, copying over the :id and :name values.
+        set!(name, element) do |item|
+          extract!(item, *args)
+        end
+      else
+        extract!(element, *args)
+      end
+    end
+  end
+
+  def extract!(element, *args)
+    args.each do |arg|
+      value = element.send(arg)
+      @message[arg.to_s] = value
+    end
+  end
+
+  def target!
+    @message
+  end
+
+  private
+
+  def _append_repeated(name, descriptor, collection, &block)
+    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) }
+    end
+
+    @message[name].push(*elements)
+  end
+
+  def _scope(message)
+    old_message = @message
+    @message = message
+    yield
+    message
+  ensure
+    @message = old_message
+  end
+
+  def _new_message_from_descriptor(descriptor)
+    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
+    message_class = message_descriptor.msgclass
+    message_class.new
+  end
+end
+
+require "pbbuilder/railtie" if defined?(Rails)

data/lib/pbbuilder/handler.rb

@@ -0,0 +1,12 @@
+# Basically copied and pasted from JbuilderHandler, except it uses Pbbuilder
+
+class PbbuilderHandler
+  # This builds up a Ruby string, that Rails' templating system `eval`s to create the view result.
+  # In our case the view result is a Protobuf message.
+  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!}
+  end
+end

data/lib/pbbuilder/railtie.rb

@@ -0,0 +1,11 @@
+require "pbbuilder/handler"
+
+class Pbbuilder
+  class Railtie < ::Rails::Railtie
+    initializer :register_handler do
+      ActiveSupport.on_load :action_view do
+        ActionView::Template.register_template_handler :pbbuilder, PbbuilderHandler
+      end
+    end
+  end
+end

data/lib/tasks/pbbuilder_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :pbbuilder do
+#   # Task goes here
+# end

data/pbbuilder.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |spec|
+  spec.name = "pbbuilder"
+  spec.version = "0.1.0"
+  spec.authors = ["Bouke van der Bijl"]
+  spec.email = ["bouke@cheddar.me"]
+  spec.homepage = "https://github.com/cheddar-me/pbbuilder"
+  spec.summary = "Generate Protobuf messages via a Builder-style DSL"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files = `git ls-files -- test/*`.split("\n")
+
+  spec.add_dependency "rails", "~> 6.1.3"
+  spec.add_dependency "google-protobuf", "~> 3.15.5"
+end

data/test/pbbuilder_test.rb

@@ -0,0 +1,29 @@
+require "test_helper"
+require "pbbuilder"
+
+class PbbuilderTest < ActiveSupport::TestCase
+  test "it makes it possible to create a person" do
+    person = Pbbuilder.new(API::Person.new) do |pb|
+      pb.name "Hello world"
+      pb.friends 1..3 do |number|
+        pb.name "Friend ##{number}"
+      end
+    end.target!
+    assert_equal person.name, "Hello world"
+    assert_equal person.friends.first.name, "Friend #1"
+  end
+
+  test "it can extract fields in a nice way" do
+    klass = Struct.new(:name)
+    friends = [klass.new("Friend 1"), klass.new("Friend 2")]
+    person = Pbbuilder.new(API::Person.new) do |pb|
+      pb.name "Hello world"
+      pb.friends friends, :name
+    end.target!
+
+    assert_equal person.name, "Hello world"
+    assert_equal person.friends.size, 2
+    assert_equal person.friends.first.name, "Friend 1"
+    assert_equal person.friends.last.name, "Friend 2"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require "rails"
+require "rails/test_help"
+require "rails/test_unit/reporter"
+
+Rails::TestUnitReporter.executable = "bin/test"
+
+require "google/protobuf"
+
+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"
+    end
+  end
+end
+
+module API
+  Person = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pbbuildertest.Person").msgclass
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: pbbuilder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bouke van der Bijl
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.15.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.15.5
+description:
+email:
+- bouke@cheddar.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/test
+- lib/pbbuilder.rb
+- lib/pbbuilder/handler.rb
+- lib/pbbuilder/railtie.rb
+- lib/tasks/pbbuilder_tasks.rake
+- pbbuilder.gemspec
+- test/pbbuilder_test.rb
+- test/test_helper.rb
+homepage: https://github.com/cheddar-me/pbbuilder
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Generate Protobuf messages via a Builder-style DSL
+test_files:
+- test/pbbuilder_test.rb
+- test/test_helper.rb