twirp_rails 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebf7858e259ac7b44fe27db5912c15093db8e4c056278293c7a505f0ce3ba0d9
-  data.tar.gz: f52465a773645cb16aa65dbf7b32db9de95f804f1903230d265fd31fcd55ec68
+  metadata.gz: 2a92255521f3ac2df3ae47a597caa01c1815a03c60a5ab0b7e8d459162a32dd9
+  data.tar.gz: 7c6bc605775f5bbf1fafa1292bd116be996ab536a602335bc83c0b43cdedf529
 SHA512:
-  metadata.gz: a6c7dc0ab5860f6c203429536276f51ea8bbc31bc1e243f030c7fa78d6c5a547381fafd66fa4d00b1c2f6681e99f8e5f5cdbf8cf61e4ec22c38c0735f3c64abe
-  data.tar.gz: dd9967d8189ad815a01e8aa82dcc612e245fa9041a5e5ca2711b2cf28298bdd39d192f5bf8c23ce49d1a6aa8cddfbeab85e88552668e5aeb324d033d9116118c
+  metadata.gz: b515cb51dd041ded6089f55fde625cc8b52c23b3526179a102ef4145e6c12f38953c052cdf5fbc987fe0c177acc938fc959128d8f1cab5dc87ef8ac6800118fb
+  data.tar.gz: 12b4c238b0ce754a205b84d49f00fb3edef603fe0152a49bc08d6b565886f59cc46932c6808824bbd9e678aeb00e22b45197ef1757b394de22827c2c36104ee2

data/CHANGELOG.md

@@ -4,6 +4,11 @@ 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.7 - 2020-02-11
+
+### Changed
+- initial inject required rspec helper required code moved to the ```twirp:rspec``` generator.
+
 ## 0.1.6 - 2020-02-11
 
 ### Added
@@ -27,7 +32,7 @@ config.include TwirpRails::RSpec::Helper, type: :rpc, file_path: %r{spec/rpc}
 describe TeamsHandler do
   let!(:team) { create :team }
 
-  context '.get' do
+  context '#get' do
     rpc { [:get, id: team.id] }
 
     it { should match(team: team.to_twirp.symbolize_keys) }

data/Gemfile.lock

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

data/README.md

@@ -39,6 +39,7 @@ and run
 
 ```sh
 rails g twirp people
+rails g twirp:rspec # run only once, if you want to use rspec rpc helper
 ```
 
 This command will add the route and generate ```lib/twirp/people_pb.rb```, ```lib/twirp/people_twirp.rb```,  
@@ -59,7 +60,7 @@ end
 Modify ```app/rpc/people_handler.rb```:
 ```ruby
   def get_name(req, _env)
-    GetNameResponse.new name: "Name of #{req.uid}"
+    { name: "Name of #{req.uid}" }
   end
 ```
 
@@ -74,6 +75,32 @@ PeopleClient.new('http://localhost:3000').get_name(GetNameRequest.new uid: '1').
 => "Name of 1"
 ```
 
+### Test your service with rspec
+
+If you use RSpec, twirp generator creates handler spec file with all service methods test templates. 
+
+```ruby
+describe TeamsHandler do
+
+  context '#get' do
+    rpc { [:get, id: team.id] }
+
+    it { should match(team: team.to_twirp) }
+  end
+end
+```
+
+To include required spec helpers add this code to ```rails_helper.rb```
+```ruby
+require 'twirp_rails/rspec/helper'
+
+RSpec.configure do |config|
+  config.include RSpec::Rails::RequestExampleGroup, type: :request, file_path: %r{spec/api}
+end 
+```
+
+or run ```rails g twirp:rspec``` to do it automatically.
+
 ## 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/generators/twirp/twirp_generator.rb

@@ -43,7 +43,7 @@ class TwirpGenerator < Rails::Generators::NamedBase
 
       proto_files.each do |file|
         gen_swagger = gen_swagger? && file =~ %r{/#{file_name}\.proto$}
-        pp [gen_swagger, file]
+
         cmd = protoc_cmd(file, gen_swagger: gen_swagger)
 
         `#{cmd}`

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

@@ -0,0 +1,25 @@
+require 'rails/generators'
+
+module Twirp
+  class RspecGenerator < Rails::Generators::Base
+    desc 'Install twirp rspec helpers into rails_helper.rb'
+    def inject_rspec_helper
+      in_root do
+        unless File.exist?('spec/rails_helper.rb')
+          log :inject_rspec, 'spec/rails_helper.rb is not found'
+          return
+        end
+
+        require_sentinel = %r{require 'rspec/rails'\s*\n}m
+        include_sentinel = /RSpec\.configure\s*do\s*\|config\|\s*\n/m
+
+        inject_into_file 'spec/rails_helper.rb',
+                         "require 'twirp_rails/rspec/helper'\n",
+                         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}\n",
+                         after: include_sentinel, verbose: true, force: false
+      end
+    end
+  end
+end

data/lib/twirp_rails/version.rb

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

data/lib/twirp_rails.rb

@@ -3,6 +3,7 @@
 require 'twirp_rails/version'
 require 'twirp_rails/engine'
 require 'twirp_rails/generators/twirp/twirp_generator'
+require 'twirp_rails/generators/twirp/twirp_rspec_generator'
 require 'twirp_rails/active_record_extension'
 
 module TwirpRails

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twirp_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Alexandr Zimin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twirp
@@ -144,6 +144,7 @@ files:
 - lib/twirp_rails/engine.rb
 - lib/twirp_rails/generators/twirp/USAGE
 - lib/twirp_rails/generators/twirp/twirp_generator.rb
+- lib/twirp_rails/generators/twirp/twirp_rspec_generator.rb
 - lib/twirp_rails/routes.rb
 - lib/twirp_rails/rspec/helper.rb
 - lib/twirp_rails/twirp.rb