twirp_rails 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06560208f92156b0a681508de14468457ca498294e139f6f949f14f037ca03d4'
-  data.tar.gz: '0989d1e84e085f7faaac0514c4140f96d3ffcf11f3bb157f1c775c38f06f83d3'
+  metadata.gz: 5dd3357733d9ed117fd486b9ef3dd7c4ca5bd9ffcb73a891e2959fb93aed2ec9
+  data.tar.gz: 1c5eee503666ad7810a9e02b0d3815d1716b8e9103799c9b1397a02bb95d78bb
 SHA512:
-  metadata.gz: a56fe829dba492ce1df60576e045a254a2e116004065ce4d866d625d3717fefda40b48f5d31f5470c5b685f22ab2c3acf76232c6f91959823cf35c57906240ef
-  data.tar.gz: dec12ac4cb49e5d6dca4f8460fa2029648e747b5ddba3653a44f09754dbcf27040cd02473279a11bb2e9a09bedd7bdaa8509f50a8a0926a4101b804ea97b863d
+  metadata.gz: ffc1c1b275fc2a92aab71d3c09371168abe9396123f31442e6f1352668523a8b8d4ca3cae3f224df0ac67942286ecc5ac0072524454f776f12a70704d1204a75
+  data.tar.gz: b54953adfc17d1b2d8fdce6af8e2e1d3f9be524b0f3917ddb80ed6e86f09cb4dc2235518aa03907c9a93fde188e35cf0bad7d7b47fab111d828ff63361069469

data/CHANGELOG.md

@@ -4,6 +4,24 @@ 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.0 - 2020-03-24
+
+### Breaking changes
+
+- Client and server proto directory splits from `app/protos` to `rpc` and `rpc/clients` (configurable)
+ 
+### Added
+
+- Added gem configuration and generator to create initial configuration file `rails g twirp:init` (comments inside).
+- Proto source dirs and rb destination dirs now configurable.
+- Added separate generator to run protoc on clients proto files `rails g twirp:clients`.
+- Add acronym API to Rails inflector to correct generate `ServiceAPI` handler from `ServiceApi` as protoc twirp plugin.
+- In the development environment gem uses warn instead of raise errors on incorrect generated code or invalid service routes.  
+
+### Fixed
+
+- Fixed incorrect indent in generated modules.
+
 ## 0.3.2 - 2020-03-12
 
 ### Added

data/Gemfile.lock

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

data/lib/twirp_rails/engine.rb

@@ -16,7 +16,22 @@ module TwirpRails
       end
 
       initializer 'twirp_rails.require_generated_files' do
-        TwirpRails::Twirp.auto_require_twirp_files
+        TwirpRails.handle_dev_error 'Require services twirp files' do
+          path = Pathname.new(TwirpRails.configuration.services_twirp_code_path)
+          path = Rails.root.join(path) if path.relative?
+          TwirpRails::Twirp.auto_require_twirp_files(path.to_s)
+        end
+        TwirpRails.handle_dev_error 'Require clients twirp files' do
+          path = Pathname.new(TwirpRails.configuration.clients_twirp_code_path)
+          path = Rails.root.join(path) if path.relative?
+          TwirpRails::Twirp.auto_require_twirp_files(path.to_s)
+        end
+      end
+
+      initializer 'twirp_rails.add_api_acronym' do
+        ActiveSupport::Inflector.inflections(:en) do |inflect|
+          inflect.acronym 'API'
+        end
       end
     end
   end

data/lib/twirp_rails/generators/twirp/clients/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Generate twirp code from protofiles of twirp_clients dir.
+
+Example:
+    rails generate twirp:clients
+
+    This will run protoc generation on each file in the twirp_clients dir.

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

@@ -0,0 +1,51 @@
+require 'rails/generators'
+
+module Twirp
+  class ClientsGenerator < Rails::Generators::Base
+    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
+      end
+    end
+
+    def generate_twirp_files
+      in_root do
+        FileUtils.mkdir_p cfg.clients_twirp_code_path
+
+        protos_mask = File.join cfg.clients_proto_path, '**/*.proto'
+        proto_files = Dir.glob protos_mask
+
+        proto_files.each do |file|
+          cmd = protoc_cmd(file)
+
+          `#{cmd}`
+
+          raise "protoc failure: #{cmd}" unless $?.success?
+        end
+      end
+    end
+
+    private
+
+    def cfg
+      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}"
+
+      "#{TwirpGenerator::PROTOC_PATH} #{flags} #{files}"
+    end
+
+  end
+end

data/lib/twirp_rails/generators/twirp/init/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generate twirp_rails default initializer code.
+
+Example:
+    rails generate twirp:init
+
+    This will create:
+        config/initializers/twirp_rails.rb

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

@@ -0,0 +1,12 @@
+require 'rails/generators'
+
+module Twirp
+  class InitGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    desc 'This generator creates an initializer file at config/initializers'
+    def create_initializer_file
+      copy_file 'twirp_rails.rb', 'config/initializers/twirp_rails.rb'
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+TwirpRails.configure do |config|
+  # Application services proto files path
+  # config.services_proto_path = 'rpc'
+  #
+  # Used clients proto files path
+  # config.clients_proto_path = 'rpc_clients'
+  #
+  # Services code generator destination path (autorequired on application start)
+  # config.services_twirp_code_path = 'lib/twirp'
+  #
+  # Clients code generator destination path (autorequired on application start)
+  # config.clients_twirp_code_path = 'lib/twirp_clients'
+  #
+  # Swagger files generated from services proto files path (set to nil unless you need to generete swagger)
+  # config.swagger_output_path = 'public/swagger'
+  #
+  # Instrument twirp calls and set hooks to log twirp calls
+  # set to proc to customize log output
+  # set to false to disable feature
+  # config.log_twirp_calls = true
+end

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

@@ -4,7 +4,7 @@ class TwirpGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
   class_option :skip_swagger, type: :boolean, default: false
-  class_option :swagger_out, type: :string, default: 'public/swagger'
+  class_option :swagger_out, type: :string, default: nil
 
   GOPATH = ENV.fetch('GOPATH') { File.expand_path('~/go') }
   GO_BIN_PATH = File.join(GOPATH, 'bin')
@@ -14,12 +14,12 @@ class TwirpGenerator < Rails::Generators::NamedBase
 
   def check_requirements
     in_root do
-      unless File.exist?(proto_file_name)
-        raise "#{proto_file_name} not found"
-      end
+      raise "#{proto_file_name} not found" unless File.exist?(proto_file_name)
     end
 
-    raise 'protoc not found - install protobuf (brew/apt/yum install protobuf)' unless File.exist?(PROTOC_PATH)
+    unless File.exist?(PROTOC_PATH)
+      raise 'protoc not found - install protobuf (brew/apt/yum install protobuf)'
+    end
 
     unless File.exist?(TWIRP_PLUGIN_PATH)
       raise <<~TEXT
@@ -40,12 +40,16 @@ class TwirpGenerator < Rails::Generators::NamedBase
 
   def generate_twirp_files
     in_root do
-      protos_mask = File.join *['app/protos', class_path, '**/*.proto'].flatten
+      FileUtils.mkdir_p cfg.services_twirp_code_path
+
+      protos_mask = File.join cfg.services_proto_path, '**/*.proto'
       proto_files = Dir.glob protos_mask
 
       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}`
@@ -63,7 +67,7 @@ class TwirpGenerator < Rails::Generators::NamedBase
     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), 0)
+                  module_hier(current_path.map(&:camelize))
     end
   end
 
@@ -116,13 +120,13 @@ class TwirpGenerator < Rails::Generators::NamedBase
 
   private
 
-  def module_hier(modules, indent)
+  def module_hier(modules, indent = 0)
     return '' if modules.size.zero?
 
     cur, *tail = modules
     optimize_indentation <<~RUBY, indent
       module #{cur}
-      #{module_hier(tail, indent + 2)}end
+      #{module_hier(tail, 2)}end
     RUBY
   end
 
@@ -131,17 +135,13 @@ class TwirpGenerator < Rails::Generators::NamedBase
   end
 
   def protoc_cmd(files, gen_swagger: gen_swagger?)
-    FileUtils.mkdir_p 'lib/twirp'
-
-    flags = '--proto_path=app/protos ' \
-            '--ruby_out=lib/twirp --twirp_ruby_out=lib/twirp ' \
+    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
-      FileUtils.mkdir_p options[:swagger_out]
-
       flags += " --plugin=#{SWAGGER_PLUGIN_PATH}" \
-               " --twirp_swagger_out=#{options[:swagger_out]}"
+               " --twirp_swagger_out=#{swagger_out_path}"
     end
 
     "#{PROTOC_PATH} #{flags} #{files}"
@@ -157,10 +157,18 @@ class TwirpGenerator < Rails::Generators::NamedBase
   end
 
   def proto_file_name
-    "app/protos/#{file_path}.proto"
+    File.join cfg.services_proto_path, "#{file_path}.proto"
+  end
+
+  def cfg
+    TwirpRails.configuration
   end
 
   def gen_swagger?
-    !options[:skip_swagger]
+    !options[:skip_swagger] && cfg.swagger_output_path
+  end
+
+  def swagger_out_path
+    options[:swagger_out] || cfg.swagger_output_path
   end
 end

data/lib/twirp_rails/routes.rb

@@ -4,38 +4,37 @@ module TwirpRails
   module Routes # :nodoc:
     module Helper
       def mount_twirp(name, handler: nil, scope: 'twirp')
-        case name
-        when Class
-          raise 'handler param required when name is a class' unless handler&.is_a?(Class)
+        TwirpRails.handle_dev_error "mount twirp route #{name}" do
+          case name
+          when Class
+            raise 'handler param required when name is a class' unless handler&.is_a?(Class)
 
-          service_class = name
+            service_class = name
 
-        when String, Symbol
-          service_class = Helper.constantize_first "#{name}_service", name
+          when String, Symbol
+            service_class = Helper.constantize_first "#{name}_service", name
 
-          unless service_class
-            msg = "mount_twirp of #{name} error. #{name.camelize}Service or #{name.camelize} class is not found"
+            unless service_class
+              msg = "mount_twirp of #{name} error. #{name.camelize}Service or #{name.camelize} class is not found"
 
-            raise TwirpRails::Error, msg unless Rails.env.development?
+              raise TwirpRails::Error, msg
+            end
 
-            warn msg
-            return
+            handler ||= "#{name}_handler".camelize.constantize
+          else
+            raise 'twirp service name required'
           end
 
-          handler ||= "#{name}_handler".camelize.constantize
-        else
-          raise 'twirp service name required'
-        end
-
-        service = service_class.new(handler.new)
-        Helper.run_create_hooks service
+          service = service_class.new(handler.new)
+          Helper.run_create_hooks service
 
-        if scope
-          scope scope do
+          if scope
+            scope scope do
+              mount service, at: service.full_name
+            end
+          else
             mount service, at: service.full_name
           end
-        else
-          mount service, at: service.full_name
         end
       end
 

data/lib/twirp_rails/twirp.rb

@@ -1,9 +1,8 @@
 module TwirpRails
   module Twirp
-    def self.auto_require_twirp_files
+    def self.auto_require_twirp_files(twirp_path)
       # protoc generates require without path in a _pb files
-      twirp_path = Rails.root.join('lib/twirp').to_s
-      $LOAD_PATH.unshift(twirp_path) if !$LOAD_PATH.include?(twirp_path)
+      $LOAD_PATH.unshift(twirp_path) unless $LOAD_PATH.include?(twirp_path)
 
       Dir.glob(Rails.root.join('lib/twirp/**/*_twirp.rb')).sort.each do |file|
         require file

data/lib/twirp_rails/version.rb

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

data/lib/twirp_rails.rb

@@ -2,6 +2,8 @@
 
 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/active_record_extension'
@@ -10,10 +12,92 @@ require 'twirp_rails/log_subscriber'
 module TwirpRails
   class Error < StandardError; end
 
+  class Configuration
+    def self.config_param(symbol, default_value = nil, &block)
+      raise 'wrong args' if !default_value.nil? && block_given?
+
+      if block_given?
+        class_variable_set("@@#{symbol}_default", block)
+        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+          def #{symbol}_default
+            instance_eval &@@#{symbol}_default
+          end
+        RUBY
+      else
+        class_variable_set("@@#{symbol}_default", default_value)
+        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+          def #{symbol}_default
+            @@#{symbol}_default
+          end
+        RUBY
+      end
+
+      class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+        def #{symbol}
+          @#{symbol} ||= #{symbol}_default
+        end
+      RUBY
+
+      class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+        def #{symbol}?
+          #{symbol}
+        end
+
+        def #{symbol}=(value)
+          @#{symbol} = value
+        end
+      RUBY
+    end
+
+    config_param :services_proto_path, 'rpc'
+
+    config_param :clients_proto_path, 'rpc_clients'
+
+    config_param :services_twirp_code_path, 'lib/twirp'
+
+    config_param :clients_twirp_code_path, 'lib/twirp_clients'
+
+    config_param :swagger_output_path, 'public/swagger'
+
+    config_param :log_twirp_calls, true
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+    setup
+  end
+
+  def self.setup
+    if configuration.log_twirp_calls
+      if configuration.log_twirp_calls.is_a?(Proc)
+        log_twirp_calls!(&configuration.log_twirp_calls)
+      else
+        log_twirp_calls!
+      end
+    end
+  end
+
   def self.log_twirp_calls!(&log_writer)
     TwirpRails::LoggingAdapter.install
 
     TwirpRails::LogSubscriber.log_writer = log_writer if block_given?
     TwirpRails::LogSubscriber.attach_to(:twirp)
   end
+
+  def self.handle_dev_error(msg, &_)
+    if Rails.env.development? && !ENV['TWIRP_RAILS_RAISE']
+      begin
+        yield
+      rescue StandardError => e
+        warn("#{msg} #{e.message}")
+        warn('twirp_rails error raised but control flow will resume for development environment. Define env TWIRP_RAILS_RAISE to raise error.')
+      end
+    else
+      yield
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twirp_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Alexandr Zimin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twirp
@@ -143,6 +143,11 @@ files:
 - lib/twirp_rails/active_record_extension.rb
 - lib/twirp_rails/engine.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/twirp_generator.rb
 - lib/twirp_rails/generators/twirp/twirp_rspec_generator.rb
 - lib/twirp_rails/log_subscriber.rb