proto_plugin 0.1.0.pre.alpha.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a1f639a6d10b3b1453fe175009232fc1e1b548c4b93b7075e336b548c9a71bf
-  data.tar.gz: '008f968744cc7f74d42df472d1b191a71752973ad9ebba255673d4db4c594f28'
+  metadata.gz: 96f4f3743b30d3c4f264e7756c603da53e14566c2e414b45cf2da7918635a103
+  data.tar.gz: 66cc63cd84cc91c179f0b25e9401d9f23e5d1d7cb678387dd604275abe09e240
 SHA512:
-  metadata.gz: 97fc2b8b9e3d1687d987696a95b479c816937ab0ff92d20e929974dc9884e9d60ff869392fa29eec69285531965a73da35146a88f62e07bcf320efbda85000be
-  data.tar.gz: 82546a40d21f5c5f893fcd89df670667743f0b15cc133134cfbe68ee997cf157a9544ee46bb97ea3f180115f89d5e98ae7671c38cdd44fd6f1b7905fa6021d1f
+  metadata.gz: d6830929a04b8e7464797a2d5c4129d6840246f09b4ace2e77c7cebc5ce63d49b1a4d016e66c85f8dd0d9acf86c5ae675ed99f22a882d85f8c4feb697ea5124d
+  data.tar.gz: c2c9786adcf0530eec151fd445877788d2786b22fb0c9a3c23b8a9080a7ca27277f2b756a6deaead8a1c700e86ce66ccfb87672a1d7d4431798c9ad48880f5aa

data/README.md

@@ -1,5 +1,7 @@
-# Proto::Plugin
+# ProtoPlugin
 
+[![Lint](https://github.com/cocoahero/proto_plugin/actions/workflows/lint.yml/badge.svg)](https://github.com/cocoahero/proto_plugin/actions/workflows/lint.yml)
+[![Test](https://github.com/cocoahero/proto_plugin/actions/workflows/test.yml/badge.svg)](https://github.com/cocoahero/proto_plugin/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/proto_plugin.svg)](https://badge.fury.io/rb/proto_plugin)
 
 ## Installation
@@ -8,6 +10,50 @@
 gem install proto_plugin
 ```
 
+## Usage
+
+Creating a `protoc` plugin is as simple as creating a new executable script.
+
+The name of the file must follow the format `protoc-gen-[plugin-name]`. As an example, the below file could be named `protoc-gen-mycoolplugin`.
+
+```ruby
+#! /usr/bin/env ruby
+
+require "proto_plugin"
+
+class MyCoolPlugin < ProtoPlugin::Base
+  def run
+    request.file_to_generate.each do |f|
+      name = File.basename(f, ".proto")
+
+      add_file(name: "#{name}.txt", content: <<~TXT)
+        This file was generated from #{name}.proto!
+      TXT
+    end
+  end
+end
+
+MyCoolPlugin.run!
+```
+
+To invoke the plugin, first make sure you have `protoc` [installed](https://github.com/protocolbuffers/protobuf#protobuf-compiler-installation). Then in a terminal, run:
+
+```bash
+protoc --plugin=path/to/protoc-gen-mycoolplugin --mycoolplugin_out=. input.proto
+```
+
+If the executable script is in your `$PATH`, for example installed via a gem, you can omit the `--plugin` argument.
+
+```bash
+protoc --mycoolplugin_out=. input.proto
+```
+
+See [`exe/protoc-gen-proto-plugin-demo`](./exe/protoc-gen-proto-plugin-demo) in this repo as another example of a plugin. Since it should be in your `$PATH` (you did install this gem right?) you can invoke it with:
+
+```bash
+protoc --proto-plugin-demo_out=. input.proto
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/protoc-gen-proto-plugin-demo

@@ -0,0 +1,17 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+require "proto_plugin"
+
+class Demo < ProtoPlugin::Base
+  def run
+    request.file_to_generate.each do |f|
+      name = File.basename(f, ".proto")
+      add_file(name: "#{name}.txt", content: <<~TXT)
+        This file was generated from #{name}.proto!
+      TXT
+    end
+  end
+end
+
+Demo.run!

data/lib/proto_plugin/base.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "google/protobuf"
+require "google/protobuf/plugin_pb"
+
+module ProtoPlugin
+  class Base
+    class << self
+      def run!(input: $stdin, output: $stdout)
+        plugin = new(
+          request: Google::Protobuf::Compiler::CodeGeneratorRequest.decode(
+            input.read,
+          ),
+        )
+
+        plugin.run
+
+        result = plugin.response
+        output.write(result.to_proto)
+        result
+      end
+    end
+
+    attr_reader :request
+
+    attr_reader :response
+
+    def initialize(request:)
+      @request = request
+      @response = Google::Protobuf::Compiler::CodeGeneratorResponse.new(
+        supported_features: supported_features.reduce(&:|),
+      )
+    end
+
+    def supported_features
+      [Google::Protobuf::Compiler::CodeGeneratorResponse::Feature::FEATURE_NONE]
+    end
+
+    def add_file(name:, content:)
+      @response.file << Google::Protobuf::Compiler::CodeGeneratorResponse::File.new(
+        name: name, content: content,
+      )
+    end
+
+    def run
+    end
+  end
+end

data/lib/proto_plugin/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ProtoPlugin
-  VERSION = "0.1.0.pre.alpha.2"
+  VERSION = "0.1.0"
 end

data/lib/proto_plugin.rb

@@ -4,3 +4,4 @@ module ProtoPlugin
 end
 
 require_relative "proto_plugin/version"
+require_relative "proto_plugin/base"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: proto_plugin
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Jonathan Baker
@@ -27,13 +27,16 @@ dependencies:
 description: 
 email:
 - jonathan@jmb.dev
-executables: []
+executables:
+- protoc-gen-proto-plugin-demo
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- exe/protoc-gen-proto-plugin-demo
 - lib/proto_plugin.rb
+- lib/proto_plugin/base.rb
 - lib/proto_plugin/version.rb
 homepage: https://github.com/cocoahero/proto_plugin
 licenses:
@@ -48,9 +51,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="