rubocop-grape 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f369f405421b61d6ad373deee22453343db7c7d661953a3f9a8b3860b561f93
-  data.tar.gz: db25749738766747e43c629bb9fe392759e5605adbb489a99120c217c4b5eb72
+  metadata.gz: 5e2ad9ec7a76a877cde28f025cccbff00e561a5ce9678892cb36d84583f4cdb7
+  data.tar.gz: 0ddb3542ef0b046ff88328c2813626c19749541b5b760161d6df6d3c985fece3
 SHA512:
-  metadata.gz: 17a713bd89ecad8ed274fbdb64e8564c5661815cd15cb3d3199a0c846912f67a7beb4f041e5830fc70bb481e73a7303c0902abe8f7743a77211184586dcea7ef
-  data.tar.gz: 8ee60612e5c0b86046496110477e5bcdf598a20954bdb912de5c28ec3c8a1f9bb88fed2fb5d86e35391f83b6420bfe0834b4a9adbaa0b3d1b646e1514088a831
+  metadata.gz: 0cc9262ee02e74a134f7e0917ef9ba6fea99fe09c397b65ebb9d8c94c1f138a1cc44aef6d6995aee82689f791faca506c54f53a414618494298adb684b837252
+  data.tar.gz: 3d997bee7403959125be792b5e496d7280fdfad2273aafa5f55c3ce2e0554841aeac5e6de7841a6f88bcddcb44b574ad85e73dc8d507038a4c92ccf37bfd4588

data/README.md

@@ -1,8 +1,8 @@
-# RuboCop::Grape
+# RuboCop Grape
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/grape`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Actions Status](https://github.com/kakubin/rubocop-grape/workflows/Ruby/badge.svg?branch=main)](https://github.com/kakubin/rubocop-grape/actions?query=workflow%3ARuby)
 
-TODO: Delete this and the text above, and describe your gem
+[RuboCop](https://github.com/rubocop/rubocop) extension for [Grape](https://rubygems.org/gems/grape/versions/0.16.2).
 
 ## Installation
 
@@ -16,20 +16,30 @@ And then execute:
 
     $ bundle install
 
-Or install it yourself as:
+## Usage
 
-    $ gem install rubocop-grape
+You need to tell RuboCop to load the Grape extension. There are three
+ways to do this:
 
-## Usage
+### RuboCop configuration file
 
-TODO: Write usage instructions here
+Put this into your `.rubocop.yml`.
 
-## Development
+```yaml
+require: rubocop-grape
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Alternatively, use the following array notation when specifying multiple extensions.
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-grape
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Now you can run `rubocop` and it will automatically load the RuboCop Grape
+cops together with the standard cops.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-grape.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kakubin/rubocop-grape.

data/lib/rubocop/cop/grape/ivar.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      # @example
+      #   # bad
+      #   ActiveRecord.with_readonly do
+      #     @ivar = User.find(params[:user_id])
+      #   end
+      #
+      #   # good
+      #   var = ActiveRecord.with_readonly do
+      #     User.find(params[:user_id]
+      #   end
+      #
+      #   # good
+      #   office = nil
+      #   user = nil
+      #
+      #   ActiveRecord.with_readonly do
+      #     user = User.find(params[:user_id])
+      #     office = user.office
+      #   end
+      #
+      class Ivar < Base
+        MSG = "Don't use instance_variable"
+
+        def on_ivasgn(node)
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/grape/params_position.rb

@@ -27,20 +27,20 @@ module RuboCop
         PATTERN
 
         def_node_matcher :http_method_node?, <<~PATTERN
-          (block (send _ :get) ...)
+          (block (send _ {:get :post :put :patch :delete} ...) ...)
         PATTERN
 
         def on_block(node)
           return unless http_method_node?(node)
 
-          collect_violationg_nodes(node).each(&method(:add_offense))
+          collect_violating_nodes(node).each(&method(:add_offense))
         end
 
-        def collect_violationg_nodes(node, collector = [])
+        def collect_violating_nodes(node, collector = [])
           collector.push(node) if node.type == :block && params_block?(node)
 
           node.children.each do |descendant|
-            collect_violationg_nodes(descendant, collector) if descendant.is_a?(Parser::AST::Node)
+            collect_violating_nodes(descendant, collector) if descendant.is_a?(Parser::AST::Node)
           end
 
           collector

data/lib/rubocop/cop/grape_cops.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
+require_relative 'grape/ivar'
 require_relative 'grape/params_position'
 require_relative 'grape/route_param_type'

data/lib/rubocop/grape/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Grape
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-grape
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Akito Hikasa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-21 00:00:00.000000000 Z
+date: 2022-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -44,6 +44,7 @@ files:
 - bin/console
 - config/default.yml
 - lib/rubocop-grape.rb
+- lib/rubocop/cop/grape/ivar.rb
 - lib/rubocop/cop/grape/params_position.rb
 - lib/rubocop/cop/grape/route_param_type.rb
 - lib/rubocop/cop/grape_cops.rb