twirp_rails 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afb781b860d752d9ccf6eff558d3e07a7f93923ecf5b70dbbb3a7df373ff60c8
-  data.tar.gz: ee22bba018427cb6d0c29be51a89bec3a40c464a7a67856b1169d72afecb73b1
+  metadata.gz: ebf7858e259ac7b44fe27db5912c15093db8e4c056278293c7a505f0ce3ba0d9
+  data.tar.gz: f52465a773645cb16aa65dbf7b32db9de95f804f1903230d265fd31fcd55ec68
 SHA512:
-  metadata.gz: d14ef916943fec1782354d2349ae4c38fd918a98331d0f4827c3b7a24847720c01a2d8e414c09b4d39d99ae31bfeffb27fbe5f2d9e13b2444065cf83e0399dab
-  data.tar.gz: 7f9ad8ccca240630862a59c107987cf1c3e371392c3e373f5cdb268f04ea24a6db091fe7d5a174bfc58430f1cde21e95e3c74466fd199b647a7bc145c18b9572
+  metadata.gz: a6c7dc0ab5860f6c203429536276f51ea8bbc31bc1e243f030c7fa78d6c5a547381fafd66fa4d00b1c2f6681e99f8e5f5cdbf8cf61e4ec22c38c0735f3c64abe
+  data.tar.gz: dd9967d8189ad815a01e8aa82dcc612e245fa9041a5e5ca2711b2cf28298bdd39d192f5bf8c23ce49d1a6aa8cddfbeab85e88552668e5aeb324d033d9116118c

data/CHANGELOG.md

@@ -4,6 +4,12 @@ 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.1.6 - 2020-02-11
+
+### Added
+- ```rails g twirp service``` generates swagger file at public/swagger, options to skip it or set output path 
+- ```rails g twirp service``` generates handler rspec test
+
 ## 0.1.5 - 2020-02-04
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twirp_rails (0.1.5)
+    twirp_rails (0.1.6)
       railties (~> 6.0)
       twirp (~> 1)
 
@@ -38,7 +38,7 @@ GEM
     generator_spec (0.9.4)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
-    google-protobuf (3.11.2-universal-darwin)
+    google-protobuf (3.11.3-universal-darwin)
     i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     loofah (2.4.0)

data/README.md

@@ -41,7 +41,8 @@ and run
 rails g twirp people
 ```
 
-This command will generate ```lib/twirp/people_pb.rb```, ```lib/twirp/people_twirp.rb``` and ```app/rpc/people_handler.rb``` and add the route.
+This command will add the route and generate ```lib/twirp/people_pb.rb```, ```lib/twirp/people_twirp.rb```,  
+```public/swagger/people.swagger.json```,  ```app/rpc/people_handler.rb``` and ```spec/rpc/people_handler_sprc.rb```.
 ```ruby
 # app/rpc/people_handler.rb
 

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

@@ -3,25 +3,38 @@ require 'rails/generators'
 class TwirpGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
-  PLUGIN_PATH = ENV.fetch('TWIRP_PLUGIN_PATH') { File.expand_path('~/go/bin/protoc-gen-twirp_ruby') }
+  class_option :skip_swagger, type: :boolean, default: false
+  class_option :swagger_out, type: :string, default: 'public/swagger'
+
+  GO_BIN_PATH = ENV.fetch('GOPATH') { File.expand_path('~/go/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 check_requirements
     in_root do
-      unless File.exists?(proto_file_name)
+      unless File.exist?(proto_file_name)
         raise "#{proto_file_name} not found #{`pwd`} #{`ls`}"
       end
     end
 
-    raise 'protoc not found - install protobuf (brew/apt/yum install protobuf)' unless File.exists?(PROTOC_PATH)
+    raise 'protoc not found - install protobuf (brew/apt/yum install protobuf)' unless File.exist?(PROTOC_PATH)
 
-    unless File.exists?(PLUGIN_PATH)
+    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
     end
+
+    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
+    end
   end
 
   def generate_twirp_files
@@ -29,7 +42,9 @@ class TwirpGenerator < Rails::Generators::NamedBase
       proto_files = Dir.glob 'app/protos/**/*.proto'
 
       proto_files.each do |file|
-        cmd = protoc_cmd(file)
+        gen_swagger = gen_swagger? && file =~ %r{/#{file_name}\.proto$}
+        pp [gen_swagger, file]
+        cmd = protoc_cmd(file, gen_swagger: gen_swagger)
 
         `#{cmd}`
 
@@ -43,10 +58,10 @@ class TwirpGenerator < Rails::Generators::NamedBase
   def generate_handler
     methods = proto_content.scan(PROTO_RPC_REGEXP).map do |method, arg_type, result_type|
       result_type = proto_type_to_ruby(result_type)
-      <<-RUBY
-  def #{method.underscore}(req, _env)
-    #{result_type}.new
-  end
+      optimize_indentation <<~RUBY, 2
+        def #{method.underscore}(req, _env)
+          #{result_type}.new
+        end
       RUBY
     end.join("\n")
 
@@ -63,7 +78,47 @@ class TwirpGenerator < Rails::Generators::NamedBase
   end
 
   def generate_rspec_files
-    # TODO
+    in_root do
+      return unless File.exist?('spec')
+
+      methods = proto_content.scan(PROTO_RPC_REGEXP).map do |method, arg_type, result_type|
+        result_type = proto_type_to_ruby(result_type)
+        optimize_indentation <<~RUBY, 2
+          context '##{method.underscore}' do
+            rpc { [:#{method.underscore}, 'arg'] }
+
+            it do
+              expect { #{result_type}.new(subject) }.to_not raise_exception
+              should match({})
+            end
+          end
+        RUBY
+      end.join("\n")
+
+      create_file "spec/rpc/#{file_name}_handler_spec.rb", <<~RUBY
+        require 'rails_helper'
+
+        describe #{class_name}Handler do
+
+        #{methods}end
+      RUBY
+    end
+  end
+
+  def inject_rspec_helper
+    in_root do
+      return unless File.exist?('spec/rails_helper.rb')
+
+      require_sentinel = %r{require 'rspec/rails'\s*\n}m
+      include_sentinel = /RSpec\.configure do |config|\s*\n/m
+
+      inject_into_file 'spec/rails_helper.rb',
+                       "require 'twirp/rails/rspec/helper'",
+                       after: require_sentinel, verbose: true, force: false
+      inject_into_file 'spec/rails_helper.rb',
+                       '  config.include TwirpRails::RSpec::Helper, type: :rpc, file_path: %r{spec/rpc}',
+                       after: include_sentinel, verbose: true, force: false
+    end
   end
 
   private
@@ -72,9 +127,19 @@ class TwirpGenerator < Rails::Generators::NamedBase
     result_type.split('.').map(&:camelize).join('::')
   end
 
-  def protoc_cmd(files)
+  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 --plugin=#{PLUGIN_PATH}"
+
+    flags = '--proto_path=app/protos ' \
+            '--ruby_out=lib/twirp --twirp_ruby_out=lib/twirp ' \
+            "--plugin=#{TWIRP_PLUGIN_PATH}"
+
+    if gen_swagger
+      FileUtils.mkdir_p options[:swagger_out]
+
+      flags += " --plugin=#{SWAGGER_PLUGIN_PATH}" \
+               " --twirp_swagger_out=#{options[:swagger_out]}"
+    end
 
     "#{PROTOC_PATH} #{flags} #{files}"
   end
@@ -91,4 +156,8 @@ class TwirpGenerator < Rails::Generators::NamedBase
   def proto_file_name
     "app/protos/#{file_name}.proto"
   end
+
+  def gen_swagger?
+    !options[:skip_swagger]
+  end
 end

data/lib/twirp_rails/rspec/helper.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
 module TwirpRails
   module RSpec
     module Helper

data/lib/twirp_rails/version.rb

@@ -1,3 +1,3 @@
 module TwirpRails
-  VERSION = '0.1.5'.freeze
+  VERSION = '0.1.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twirp_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Alexandr Zimin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-04 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twirp