rubocop-twirp 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fd2c1e5539fcf54151b1a5a5fd90f83f7b841ada41ed672bc791212bc160c40
-  data.tar.gz: 8d61149045abd2246ddf00e30dabd67620b69b49e3212e37d132af265f24c7b7
+  metadata.gz: 34f94e78595b7dc92e5de467fa5529b39bc3427ddf7e9e8120c794ec2fa44a0e
+  data.tar.gz: 2dd8f977b38beebbee179240e1ab08396258769418c2ecc079b1deeaed097d58
 SHA512:
-  metadata.gz: ce634e64bdc75f3702aff3d39cbd60373d17c90589aa3eb241116b52eed3bbf579e7ca554d375afbb305787681a9996d93f509fdeb0ce398372315b1dd182ffb
-  data.tar.gz: d51f7c50615aa2fa207c117cfeaf7d7234dd59ff3f6c946964e1c028ebd61bafcdbf9a17d67860ad9efa5fde8209fe06df210e1526552044e42470d30f3a50ea
+  metadata.gz: 823f2a6a00ad57d192e85cbd32a08342c7cc50fc09fa577a46dff75604f1ffc8fabc1f0acbdceec3ec813d0c3a838cfe0acd6448dc13c00308bca994aa00a85e
+  data.tar.gz: 5e70efaf01bc212da38adc36ab77f767b3a652bfa0748dc21afb6c01d3ff369f73a613eab89a0f45a51ebbc0f7d89e50456cec62c64667ca559af426c3bdeeb9

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+###  v0.1.0  (2023-02-26)
+- client response cop
+- be_a cop
+
 ###  v0.0.1  (2023-02-25)
 -
 

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    rubocop-twirp (0.0.1)
+    rubocop-twirp (0.1.0)
       rubocop (>= 1)
-      twirp (>= 1)
 
 GEM
   remote: https://rubygems.org/
@@ -12,11 +11,6 @@ GEM
     byebug (11.1.3)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
-    google-protobuf (3.22.0-x86_64-darwin)
     json (2.6.3)
     parallel (1.22.1)
     parser (3.2.1.0)
@@ -51,20 +45,16 @@ GEM
     rubocop-ast (1.26.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    twirp (1.10.0)
-      faraday (< 3)
-      google-protobuf (~> 3.0, >= 3.7.0)
     unicode-display_width (2.4.2)
 
 PLATFORMS
-  x86_64-darwin-21
+  ruby
 
 DEPENDENCIES
   byebug

data/README.md

@@ -3,29 +3,37 @@ rubocop-twirp
 ![Gem](https://img.shields.io/gem/dt/rubocop-twirp?style=plastic)
 [![codecov](https://codecov.io/gh/dpep/rubocop-twirp/branch/main/graph/badge.svg)](https://codecov.io/gh/dpep/rubocop-twirp)
 
-...
+Improve your Twirp code with [RuboCop](https://github.com/bbatsov/rubocop)
 
-[RuboCop](https://github.com/bbatsov/rubocop)
 
-
-
-```ruby
+## Install
+```
 gem install rubocop-twirp
+```
 
-# or add to your Gemfile
+Add to your Gemfile
+```ruby
 gem "rubocop-twirp", require: false
 ```
 
-Add this to your .rubocop.yml:
+Add to .rubocop.yml
 ```
 require: rubocop-twirp
 ```
 
-Scan for issues
+## Use
+Scan and fix issues
 ```
-rubocop -r rubocop-twirp --only Twirp
+rubocop -r rubocop-twirp --only Twirp -A
 ```
 
+
+Fix `Twirp::ClientResp` breaking change introduced in [Twirp v1.10](https://github.com/github/twirp-ruby/commit/4614a5fe004ca408c48ddfc813c80f3ad7bcb586). (Cop disabled by default)
+```
+rubocop -r rubocop-twirp --only Twirp/DeprecatedArguments -A
+```
+
+
 ----
 ## Contributing
 
@@ -37,3 +45,9 @@ Yes please  :)
 1. Commit your changes (`git commit -am 'awesome new feature'`)
 1. Push your branch (`git push origin my-feature`)
 1. Create a Pull Request
+
+
+### Resources
+- https://docs.rubocop.org/rubocop/1.46/development.html
+- https://github.com/rubocop/rubocop-ast/blob/master/docs/modules/ROOT/pages/node_pattern.adoc
+- https://github.com/rubocop/rubocop-performance

data/config/default.yml

@@ -1,7 +1,18 @@
 Twirp:
   Enabled: true
 
+Twirp/ClientResponse:
+  Description: 'Use webmock-twirp to stub client responses'
+  Enabled: true
+  VersionAdded: '0.1'
+
 Twirp/DeprecatedArguments:
   Description: 'Use keyword args for `Twirp::ClientResp.new`'
+  Enabled: false
+  VersionAdded: '0.1'
+  Severity: error
+
+Twirp/RSpecBeA:
+  Description: 'Use rspec-twirp to simplify specs'
   Enabled: true
   VersionAdded: '0.1'

data/lib/rubocop/cop/twirp/client_response.rb

@@ -0,0 +1,30 @@
+module RuboCop
+  module Cop
+    module Twirp
+      # Use webmock-twirp to stub Twirp client responses
+      # https://github.com/dpep/webmock-twirp
+      #
+      # @example
+      #   # bad
+      #   allow(MyTwirpClient).to receive(:my_rpc).and_return(Twirp::ClientResp.new(...))
+      #
+      #   # good
+      #   stub_twirp_request(MyTwirpClient, :my_rpc).to_return(...)
+      #
+      class ClientResponse < Base
+        RESTRICT_ON_SEND = [:new].freeze
+        MSG = "Avoid constructing Twirp client responses manually. Use `stub_twirp_request` from `webmock-twirp` (https://github.com/dpep/webmock-twirp)".freeze
+
+        def_node_matcher :client_response?, <<~PATTERN
+          (send (const (const _ :Twirp) :ClientResp) :new ...)
+        PATTERN
+
+        def on_send(node)
+          client_response?(node) do
+            add_offense(node.loc.expression, message: MSG)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/twirp/deprecated_arguments.rb

@@ -16,7 +16,7 @@ module RuboCop
         POSITIONAL_ARGS = [:data, :error].freeze
 
         def_node_matcher :pos_args?, <<~PATTERN
-          (send (const (const { nil? cbase } :Twirp) :ClientResp) :new $!hash_type?+)
+          (send (const (const _ :Twirp) :ClientResp) :new $!hash_type?+)
         PATTERN
 
 
@@ -27,9 +27,6 @@ module RuboCop
               "`%<class_name>s.%<method_name>s(%<kwargs>s)`"
 
         def on_send(node)
-          # kwargs were introduced in Twirp v1.10
-          return unless Gem::Version.new(::Twirp::VERSION) >= Gem::Version.new("1.10")
-
           return unless pos_args?(node)
 
           kwargs = POSITIONAL_ARGS.map.with_index do |arg, index|

data/lib/rubocop/cop/twirp/rspec_be_a.rb

@@ -0,0 +1,54 @@
+module RuboCop
+  module Cop
+    module Twirp
+      # Use rspec-twirp to simplify specs
+      # https://github.com/dpep/rspec-twirp
+      #
+      # @example
+      #   # bad
+      #   expect(...).to be_a(Twirp::ClientResp)
+      #   expect(...).to be_a(Twirp::Error)
+      #
+      #   # good
+      #   expect(...).to be_a_twirp_response
+      #   expect(...).to be_a_twirp_error
+      #
+      class RSpecBeA < Base
+        RESTRICT_ON_SEND = [:be_a].freeze
+        TWIRP_RESPONSE_MSG = "Use `be_a_twirp_response` from `rspec-twirp` (https://github.com/dpep/rspec-twirp)".freeze
+        TWIRP_ERROR_MSG = "Use `be_a_twirp_error` from `rspec-twirp` (https://github.com/dpep/rspec-twirp)".freeze
+
+        def_node_matcher :twirp_type?, <<~PATTERN
+          (send _ :be_a (const (const _ :Twirp) ${:ClientResp :Error}))
+        PATTERN
+
+        include RangeHelp
+        extend AutoCorrector
+
+        def on_send(node)
+          twirp_type?(node) do |type|
+            case type
+            when :ClientResp
+              msg = TWIRP_RESPONSE_MSG
+              replacement = "be_a_twirp_response"
+            when :Error
+              msg = TWIRP_ERROR_MSG
+              replacement = "be_a_twirp_error"
+            else
+              return
+            end
+
+            range = range_between(
+              node.loc.selector.begin_pos,
+              node.loc.end.end_pos,
+            )
+
+            add_offense(range, message: msg) do |corrector|
+              corrector.replace(range, replacement)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/twirp/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Twirp
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/rubocop/twirp.rb

@@ -1,6 +1,29 @@
 require "rubocop"
 require "rubocop/twirp/version"
-require "twirp"
+
+module RuboCop
+  module Twirp
+    PROJECT_ROOT = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+    CONFIG = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+
+    # RuboCop doesn't support plugins yet, so monkey patch config
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end
+
+RuboCop::Twirp::Inject.defaults!
 
 # load cops
 Dir["./cop/twirp/**/*.rb", base: __dir__].each { |f| require_relative f }

data/rubocop-twirp.gemspec

@@ -13,7 +13,6 @@ Gem::Specification.new do |s|
   s.version     = package.const_get "VERSION"
 
   s.add_dependency "rubocop", ">= 1"
-  s.add_dependency "twirp", ">= 1"
 
   s.add_development_dependency "byebug"
   s.add_development_dependency "rspec"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-twirp
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-26 00:00:00.000000000 Z
+date: 2023-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1'
-- !ruby/object:Gem::Dependency
-  name: twirp
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -93,7 +79,9 @@ files:
 - README.md
 - config/default.yml
 - lib/rubocop-twirp.rb
+- lib/rubocop/cop/twirp/client_response.rb
 - lib/rubocop/cop/twirp/deprecated_arguments.rb
+- lib/rubocop/cop/twirp/rspec_be_a.rb
 - lib/rubocop/twirp.rb
 - lib/rubocop/twirp/version.rb
 - rubocop-twirp.gemspec