twirp_rails 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dd3357733d9ed117fd486b9ef3dd7c4ca5bd9ffcb73a891e2959fb93aed2ec9
-  data.tar.gz: 1c5eee503666ad7810a9e02b0d3815d1716b8e9103799c9b1397a02bb95d78bb
+  metadata.gz: f7fbba3b1fe02ffed0c06b8a421f52577aab8634e0c3628c079721415c22df56
+  data.tar.gz: 25ab97b4b24fd79ea5c338bbef35f124e082c3ce34a9588b0d66658858936f77
 SHA512:
-  metadata.gz: ffc1c1b275fc2a92aab71d3c09371168abe9396123f31442e6f1352668523a8b8d4ca3cae3f224df0ac67942286ecc5ac0072524454f776f12a70704d1204a75
-  data.tar.gz: b54953adfc17d1b2d8fdce6af8e2e1d3f9be524b0f3917ddb80ed6e86f09cb4dc2235518aa03907c9a93fde188e35cf0bad7d7b47fab111d828ff63361069469
+  metadata.gz: 11e6b0f20cfc055c2b0d89b06e7a79011b3ca28b5d0f4456d8872b62c67e6c22e8ca50728f6d1c3700fbf8c6bc04b5bcef0245c37392eb3f687b1329603446d2
+  data.tar.gz: 2ee3fb02db058cea267475e4e872cc5049f732a3877a4454677ff9b4cbf9445f2c83b00fc654fae274f8994d822cdefdabb2656c178c886070ccd9ef02fd29fb

data/CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 The 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.4.1 - 2020-03-30
+
+### Added
+
+- smart service detection - you can use `rails g twirp svc` if you `Svc` or 
+`SvcAPI` service described at `company/service/subservice/version/etc/svc_api.proto`
+- Add `# :nocov:` comment to generated modules to avoid decrease coverage
+- Improve generator console output and error handling
+- `add_api_acronym` configuration option
+
+### Fixed
+
+- `protoc` path was cached on start and didn't reload with spring
+
 ## 0.4.0 - 2020-03-24
 
 ### Breaking changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twirp_rails (0.4.0)
+    twirp_rails (0.4.1)
       railties (~> 6.0)
       twirp (~> 1)
 

data/README.md

@@ -25,7 +25,7 @@ to install required protoc and twirp-ruby plugin.
 
 ### Generator
 
-Create a proto file ```app/protos/people.proto```:
+Create a proto file ```rpc/people.proto```:
 ```proto
 syntax = "proto3";
 
@@ -110,18 +110,14 @@ or run ```rails g twirp:rspec``` to do it automatically.
 
 ## Log twirp calls
 
-By default, Rails logs only start of POST request. To get a more detailed log of twirp calls, add this code to the initializer.
+By default, Rails logs only start of POST request. To get a more detailed log of twirp calls
+ use `config.log_twirp_calls` configuration option (default `true`).
 
-```ruby
-# config/initializers/twirp_rails.rb
-TwirpRails.log_twirp_calls!
-```
-
-You can customize log output by pass a block argument
+You can customize log output by pass a proc.
 
 ```ruby
 # config/initializers/twirp_rails.rb
-TwirpRails.log_twirp_calls! do |event|
+config.log_twirp_calls = -> (event) do
   twirp_call_info = {
     duration: event.duration,
     method: event.payload[:env][:rpc_method],
@@ -136,6 +132,42 @@ TwirpRails.log_twirp_calls! do |event|
 end
 ```
 
+## Generate clients
+
+Clients generator calls `protoc` to generate code from all proto files from 
+`rpc_clients` directory to `lib/twirp_clients` (all files auto required on application startup).
+
+Generator runs without options by executing 
+
+```
+$ rails g twirp:clients
+```
+
+## Configuration
+
+All configuration options (e.g. paths) can be customized via initializer file
+generated by 
+```
+$ rails g twirp:init
+```
+
+## API acronym
+
+Gem adds inflector acronym `API` to correct using services with suffix `API`. 
+`API` suffix required by `prototool` linter with `uber2` rules. You can disable this
+inflection by set to false `add_api_acronym` configuration option. 
+
+## Swagger generation
+
+Service generator `rails g twirp service` generates swagger file in `public/swagger` 
+by default. You can turn it off or customize path in configuration.
+
+## Smart service detection 
+
+You can use `rails g twirp svc` if your `Svc` or 
+`SvcAPI` service described at `company/service/subservice/version/etc/svc_api.proto`
+and you have no other files `svc_api.proto`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/twirp_rails/engine.rb

@@ -29,8 +29,10 @@ module TwirpRails
       end
 
       initializer 'twirp_rails.add_api_acronym' do
-        ActiveSupport::Inflector.inflections(:en) do |inflect|
-          inflect.acronym 'API'
+        if TwirpRails.configuration.add_api_acronym
+          ActiveSupport::Inflector.inflections(:en) do |inflect|
+            inflect.acronym 'API'
+          end
         end
       end
     end

data/lib/twirp_rails/generators/generators.rb

@@ -0,0 +1,5 @@
+require 'twirp_rails/generators/twirp/protoc_adapter'
+require 'twirp_rails/generators/twirp/init/init_generator'
+require 'twirp_rails/generators/twirp/clients/clients_generator'
+require 'twirp_rails/generators/twirp/twirp_generator'
+require 'twirp_rails/generators/twirp/twirp_rspec_generator'

data/lib/twirp_rails/generators/twirp/clients/clients_generator.rb

@@ -5,30 +5,37 @@ module Twirp
     desc 'This generator run protoc generation on each file in the twirp_clients dir'
 
     def check_requirements
-      raise 'protoc not found - install protobuf (brew/apt/yum install protobuf)' unless File.exist?(TwirpGenerator::PROTOC_PATH)
-
-      unless File.exist?(TwirpGenerator::TWIRP_PLUGIN_PATH)
-        raise <<~TEXT
-          protoc-gen-twirp_ruby not found - install go (brew install go)
-          and run "go get github.com/twitchtv/twirp-ruby/protoc-gen-twirp_ruby
-          or set TWIRP_PLUGIN_PATH environment variable to right location.
-        TEXT
+      protoc.check_requirements do |msg|
+        abort msg
+      end
+    end
+
+    def rm_old_twirp_files
+      return unless cfg.purge_old_twirp_code
+
+      in_root do
+        removed_files = protoc.rm_old_twirp_files
+
+        if removed_files
+          msg = "#{removed_files.size} twirp and pb files purged from #{dst_path}"
+          say_status :protoc, msg, :green
+        end
       end
     end
 
     def generate_twirp_files
       in_root do
-        FileUtils.mkdir_p cfg.clients_twirp_code_path
+        FileUtils.mkdir_p dst_path
 
-        protos_mask = File.join cfg.clients_proto_path, '**/*.proto'
+        protos_mask = File.join src_path, '**/*.proto'
         proto_files = Dir.glob protos_mask
 
         proto_files.each do |file|
-          cmd = protoc_cmd(file)
+          cmd = protoc.cmd(file)
 
           `#{cmd}`
 
-          raise "protoc failure: #{cmd}" unless $?.success?
+          abort "protoc failure: #{cmd}" unless $?.success?
         end
       end
     end
@@ -39,13 +46,20 @@ module Twirp
       TwirpRails.configuration
     end
 
-    def protoc_cmd(files)
-      flags = "--proto_path=#{cfg.clients_proto_path} " \
-            "--ruby_out=#{cfg.clients_twirp_code_path} --twirp_ruby_out=#{cfg.clients_twirp_code_path} " \
-            "--plugin=#{TwirpGenerator::TWIRP_PLUGIN_PATH}"
+    def abort(msg)
+      raise Thor::InvocationError, msg
+    end
 
-      "#{TwirpGenerator::PROTOC_PATH} #{flags} #{files}"
+    def protoc
+      @protoc ||= ProtocAdapter.new(src_path, dst_path)
     end
 
+    def src_path
+      cfg.clients_proto_path
+    end
+
+    def dst_path
+      cfg.clients_twirp_code_path
+    end
   end
 end

data/lib/twirp_rails/generators/twirp/init/templates/twirp_rails.rb

@@ -18,4 +18,11 @@ TwirpRails.configure do |config|
   # set to proc to customize log output
   # set to false to disable feature
   # config.log_twirp_calls = true
+  #
+  # Delete all files from x_twirp_code_path
+  # before run protoc on proto files
+  # config.purge_old_twirp_code = true
+  #
+  # Add API acronym to inflector
+  # config.add_api_acronym = true
 end

data/lib/twirp_rails/generators/twirp/protoc_adapter.rb

@@ -0,0 +1,65 @@
+class ProtocAdapter
+  attr_reader :src_path, :dst_path, :swagger_out_path
+
+  attr_reader :twirp_plugin_path, :swagger_plugin_path, :protoc_path
+
+  def initialize(src_path, dst_path, swagger_out_path: nil)
+    @src_path = src_path
+    @dst_path = dst_path
+    @swagger_out_path = swagger_out_path
+
+    go_path = ENV.fetch('GOPATH') { File.expand_path('~/go') }
+    go_bin_path = File.join(go_path, 'bin')
+    @twirp_plugin_path = ENV.fetch('TWIRP_PLUGIN_PATH') { File.join(go_bin_path, 'protoc-gen-twirp_ruby') }
+    @swagger_plugin_path = ENV.fetch('SWAGGER_PLUGIN_PATH') { File.join(go_bin_path, 'protoc-gen-twirp_swagger') }
+    @protoc_path = `which protoc`.chomp
+  end
+
+  def rm_old_twirp_files
+    return unless File.exists? dst_path
+
+    remove_mask = File.join dst_path, '**/*_{twirp,pb}.rb'
+    files_to_remove = Dir.glob remove_mask
+
+    return if files_to_remove.empty?
+
+    files_to_remove.each do |file|
+      File.unlink file
+    end
+  end
+
+  def cmd(files, gen_swagger: false)
+    flags = "--proto_path=#{src_path} " \
+            "--ruby_out=#{dst_path} --twirp_ruby_out=#{dst_path} " \
+            "--plugin=#{twirp_plugin_path}"
+
+    if gen_swagger
+      flags += " --plugin=#{swagger_plugin_path}" \
+               " --twirp_swagger_out=#{swagger_out_path}"
+    end
+
+    "#{protoc_path} #{flags} #{files}"
+  end
+
+  def check_requirements(check_swagger: false)
+    unless File.exist?(protoc_path)
+      yield 'protoc not found - install protobuf (brew/apt/yum install protobuf)'
+    end
+
+    unless File.exist?(twirp_plugin_path)
+      yield <<~TEXT
+        protoc-gen-twirp_ruby not found - install go (brew install go)
+        and run "go get github.com/twitchtv/twirp-ruby/protoc-gen-twirp_ruby
+        or set TWIRP_PLUGIN_PATH environment variable to right location.
+      TEXT
+    end
+
+    if check_swagger && !File.exist?(swagger_plugin_path)
+      yield <<~TEXT
+        protoc-gen-twirp_swagger not found - install go (brew install go)
+        and run "go get github.com/elliots/protoc-gen-twirp_swagger
+        or set SWAGGER_PLUGIN_PATH environment variable to right location.
+      TEXT
+    end
+  end
+end

data/lib/twirp_rails/generators/twirp/twirp_generator.rb

@@ -6,71 +6,99 @@ class TwirpGenerator < Rails::Generators::NamedBase
   class_option :skip_swagger, type: :boolean, default: false
   class_option :swagger_out, type: :string, default: nil
 
-  GOPATH = ENV.fetch('GOPATH') { File.expand_path('~/go') }
-  GO_BIN_PATH = File.join(GOPATH, 'bin')
-  TWIRP_PLUGIN_PATH = ENV.fetch('TWIRP_PLUGIN_PATH') { File.join(GO_BIN_PATH, 'protoc-gen-twirp_ruby') }
-  SWAGGER_PLUGIN_PATH = ENV.fetch('SWAGGER_PLUGIN_PATH') { File.join(GO_BIN_PATH, 'protoc-gen-twirp_swagger') }
-  PROTOC_PATH = `which protoc`.chomp
+  def smart_detect_proto_file_name
+    return if File.exist?(proto_file_name) # dont detect when file exists
+    return if class_path.any? # dont detect when file with path
 
-  def check_requirements
     in_root do
-      raise "#{proto_file_name} not found" unless File.exist?(proto_file_name)
+      [file_name, "#{file_name}_api"].each do |file|
+        mask = File.join src_path, "**/#{file}.proto"
+        matched_files = Dir.glob(mask)
+
+        next if matched_files.empty?
+
+        abort "many proto files matched the #{file_name}: #{matched_files.join(' ')}" if matched_files.size > 1
+
+        matched_file = Pathname.new(matched_files.first).relative_path_from Pathname.new(src_path)
+        matched_file = matched_file.to_s[0..-(matched_file.extname.length + 1)] # remove extension
+
+        @file_path = nil # reset cache
+
+        say_status :detect, "Smart detect #{file_name} as #{matched_file}", :yellow
+        assign_names!(matched_file)
+        break
+      end
     end
+  end
 
-    unless File.exist?(PROTOC_PATH)
-      raise 'protoc not found - install protobuf (brew/apt/yum install protobuf)'
+  def check_requirements
+    in_root do
+      abort "#{proto_file_name} not found" unless File.exist?(proto_file_name)
     end
 
-    unless File.exist?(TWIRP_PLUGIN_PATH)
-      raise <<~TEXT
-        protoc-gen-twirp_ruby not found - install go (brew install go)
-        and run "go get github.com/twitchtv/twirp-ruby/protoc-gen-twirp_ruby
-        or set TWIRP_PLUGIN_PATH environment variable to right location.
-      TEXT
+    protoc.check_requirements(check_swagger: gen_swagger?) do |msg|
+      abort msg
     end
+  end
+
+  def rm_old_twirp_files
+    return unless cfg.purge_old_twirp_code
 
-    if gen_swagger? && !File.exist?(SWAGGER_PLUGIN_PATH)
-      raise <<~TEXT
-        protoc-gen-twirp_swagger not found - install go (brew install go)
-        and run "go get github.com/elliots/protoc-gen-twirp_swagger
-        or set SWAGGER_PLUGIN_PATH environment variable to right location.
-      TEXT
+    in_root do
+      removed_files = protoc.rm_old_twirp_files
+
+      if removed_files
+        msg = "#{removed_files.size} twirp and pb files purged from #{dst_path}"
+        say_status :protoc, msg, :green
+      end
     end
   end
 
   def generate_twirp_files
     in_root do
-      FileUtils.mkdir_p cfg.services_twirp_code_path
+      FileUtils.mkdir_p dst_path
 
-      protos_mask = File.join cfg.services_proto_path, '**/*.proto'
+      protos_mask = File.join src_path, '**/*.proto'
       proto_files = Dir.glob protos_mask
 
+      protoc_files_count = 0
+      swagger_files_count = 0
+
       proto_files.each do |file|
         gen_swagger = gen_swagger? && file =~ %r{/#{file_name}\.proto$}
 
         FileUtils.mkdir_p swagger_out_path if gen_swagger
 
-        cmd = protoc_cmd(file, gen_swagger: gen_swagger)
+        cmd = protoc.cmd(file, gen_swagger: gen_swagger)
+
+        protoc_files_count += 1
+        swagger_files_count += gen_swagger ? 1 : 0
 
         `#{cmd}`
 
-        raise "protoc failure: #{cmd}" unless $?.success?
+        abort "protoc failure: #{cmd}" unless $?.success?
       end
+
+      msg = "#{protoc_files_count} proto files processed, #{swagger_files_count} with swagger"
+      say_status :protoc, msg, :green
     end
   end
 
-  PROTO_RPC_REGEXP = /\brpc\s+(\S+)\s*\(\s*(\S+)\s*\)\s*returns\s*\(\s*(\S+)\s*\)/m.freeze
-
   def create_module_files
     return if regular_class_path.empty?
 
     class_path.length.times do |i|
       current_path = class_path[0..i]
-      create_file File.join('app/rpc', "#{current_path.join('/')}.rb"),
-                  module_hier(current_path.map(&:camelize))
+
+      create_file File.join('app/rpc', "#{current_path.join('/')}.rb"), <<~RUBY
+        # :nocov:
+        #{module_hier(current_path.map(&:camelize))}# :nocov:
+      RUBY
     end
   end
 
+  PROTO_RPC_REGEXP = /\brpc\s+(\S+)\s*\(\s*(\S+)\s*\)\s*returns\s*\(\s*(\S+)\s*\)/m.freeze
+
   def generate_handler
     methods = proto_content.scan(PROTO_RPC_REGEXP).map do |method, _arg_type, _result_type|
       optimize_indentation <<~RUBY, 2
@@ -134,17 +162,12 @@ class TwirpGenerator < Rails::Generators::NamedBase
     result_type.split('.').map(&:camelize).join('::')
   end
 
-  def protoc_cmd(files, gen_swagger: gen_swagger?)
-    flags = "--proto_path=#{cfg.services_proto_path} " \
-            "--ruby_out=#{cfg.services_twirp_code_path} --twirp_ruby_out=#{cfg.services_twirp_code_path} " \
-            "--plugin=#{TWIRP_PLUGIN_PATH}"
-
-    if gen_swagger
-      flags += " --plugin=#{SWAGGER_PLUGIN_PATH}" \
-               " --twirp_swagger_out=#{swagger_out_path}"
-    end
+  def src_path
+    cfg.services_proto_path
+  end
 
-    "#{PROTOC_PATH} #{flags} #{files}"
+  def dst_path
+    cfg.services_twirp_code_path
   end
 
   def proto_content
@@ -157,7 +180,7 @@ class TwirpGenerator < Rails::Generators::NamedBase
   end
 
   def proto_file_name
-    File.join cfg.services_proto_path, "#{file_path}.proto"
+    File.join src_path, "#{file_path}.proto"
   end
 
   def cfg
@@ -171,4 +194,12 @@ class TwirpGenerator < Rails::Generators::NamedBase
   def swagger_out_path
     options[:swagger_out] || cfg.swagger_output_path
   end
+
+  def abort(msg)
+    raise Thor::InvocationError, msg
+  end
+
+  def protoc
+    @protoc ||= ProtocAdapter.new(src_path, dst_path, swagger_out_path: swagger_out_path)
+  end
 end

data/lib/twirp_rails/version.rb

@@ -1,3 +1,3 @@
 module TwirpRails
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.1'.freeze
 end

data/lib/twirp_rails.rb

@@ -2,10 +2,7 @@
 
 require 'twirp_rails/version'
 require 'twirp_rails/engine'
-require 'twirp_rails/generators/twirp/init/init_generator'
-require 'twirp_rails/generators/twirp/clients/clients_generator'
-require 'twirp_rails/generators/twirp/twirp_generator'
-require 'twirp_rails/generators/twirp/twirp_rspec_generator'
+require 'twirp_rails/generators/generators'
 require 'twirp_rails/active_record_extension'
 require 'twirp_rails/log_subscriber'
 
@@ -60,6 +57,10 @@ module TwirpRails
     config_param :swagger_output_path, 'public/swagger'
 
     config_param :log_twirp_calls, true
+
+    config_param :purge_old_twirp_code, true
+
+    config_param :add_api_acronym, true
   end
 
   def self.configuration
@@ -100,4 +101,22 @@ module TwirpRails
       yield
     end
   end
+
+  # Convert google.protobuf.Timestamp or Google::Protobuf::Timestampp hash
+  # to [Time]
+  # @param [Hash|Google::Protobuf::Timestamp] proto_timestamp
+  def self.timestamp_to_time(proto_timestamp)
+    return nil unless proto_timestamp
+
+    proto_timestamp = proto_timestamp.to_h unless proto_timestamp.is_a?(Hash)
+
+    seconds = proto_timestamp[:seconds]
+    raise "invalid timestamp #{proto_timestamp.inspect}" unless seconds
+
+    nanos = proto_timestamp[:nanos]
+
+    seconds += nanos * 1e-9 unless nanos.nil? || nanos.zero?
+
+    Time.zone.at seconds
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twirp_rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Alexandr Zimin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2020-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twirp
@@ -142,12 +142,14 @@ files:
 - lib/twirp_rails.rb
 - lib/twirp_rails/active_record_extension.rb
 - lib/twirp_rails/engine.rb
+- lib/twirp_rails/generators/generators.rb
 - lib/twirp_rails/generators/twirp/USAGE
 - lib/twirp_rails/generators/twirp/clients/USAGE
 - lib/twirp_rails/generators/twirp/clients/clients_generator.rb
 - lib/twirp_rails/generators/twirp/init/USAGE
 - lib/twirp_rails/generators/twirp/init/init_generator.rb
 - lib/twirp_rails/generators/twirp/init/templates/twirp_rails.rb
+- lib/twirp_rails/generators/twirp/protoc_adapter.rb
 - lib/twirp_rails/generators/twirp/twirp_generator.rb
 - lib/twirp_rails/generators/twirp/twirp_rspec_generator.rb
 - lib/twirp_rails/log_subscriber.rb