rubocop-grape 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd6f622b828feeb370985d1d3c2bb9fd5d5e366dca5ced9f4232dc00bd69541f
-  data.tar.gz: 175d75a07c48e200de2417e4e951332a44c6bbd3f4cdeaef38cf025f6ab14c90
+  metadata.gz: '02479172353db2e2fea8b532d01cf2dde616c7751e0d81a4a550227789128fc7'
+  data.tar.gz: 83cc6fcfe0f01e021e4bedd257a5e2162f4a20c4f35aad28e5dcf04f2364706d
 SHA512:
-  metadata.gz: 6961acacaa6a7304899b852294f651e6aba4e9528f674756cdd0536d7384739a9bda2d928e7ef4c9b23dda30776ce020fa8f78bf98e5d5c5e9d599502d99a3d1
-  data.tar.gz: eb230658d3993d3c096a1e826096a4b7f6f00243a6b810a57c35d7b7a80d3ea6a3a5bc4f515e9d784e63d930710980d9e0ec2d6a5b7880bfd028d13599297a03
+  metadata.gz: 46c7d251b5e0882e72a76d1aa77271f04386141a172a5b4d054ff079957b4a43f2ffe1cfdba7d993ed83aa868bcaac6366db9cbfb2882c6b01acbe6f9631ba49
+  data.tar.gz: bd9bb8ca47a1c2cca8eaf6b08ec39ea9d80d69e59ecb32225909b1da83ee38a516c1cf8e65e7a14d2c8e322ea5a8b0a356a5bad2a1243623263b40c4381b070a

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/config/default.yml

@@ -1,3 +1,6 @@
+AllCops:
+  GrapeDir: 'app/api'
+
 Grape/RouteParamType:
   Enabled: true
   Safe: false

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,7 +27,7 @@ module RuboCop
         PATTERN
 
         def_node_matcher :http_method_node?, <<~PATTERN
-          (block (send _ {:get :post :put :patch :delete}) ...)
+          (block (send _ {:get :post :put :patch :delete} ...) ...)
         PATTERN
 
         def on_block(node)

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/grape_files.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      # This is a monkey patch for RuboCop
+      # which makes rubocop-grape cops adapted only for grape files.
+      module GrapeFile
+        DEFAULT_GRAPE_DIR = 'app/api'
+
+        def grape_dir
+          @grape_dir ||= load_grape_file_from_config || DEFAULT_GRAPE_DIR
+        end
+
+        def grape_files
+          @grape_files ||= Dir.glob('**/*.rb', base: grape_dir).map do |relative_path|
+            File.absolute_path(relative_path, grape_dir)
+          end
+        end
+
+        Team.prepend self
+
+        private
+
+        def load_grape_file_from_config
+          @config.for_all_cops['GrapeDir']
+        end
+
+        def roundup_relevant_cops(filename)
+          super.select do |cop|
+            next true unless cop.class.name.match?(/RuboCop::Cop::Grape::.+$/)
+
+            grape_files.include?(filename)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/grape/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Grape
-    VERSION = '0.1.2'
+    VERSION = '0.2.1'
   end
 end

data/lib/rubocop-grape.rb

@@ -8,4 +8,6 @@ require_relative 'rubocop/grape/inject'
 
 RuboCop::Grape::Inject.defaults!
 
+require_relative 'rubocop/grape/grape_files'
+
 require_relative 'rubocop/cop/grape_cops'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-grape
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Akito Hikasa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-21 00:00:00.000000000 Z
+date: 2023-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -44,10 +44,12 @@ 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
 - lib/rubocop/grape.rb
+- lib/rubocop/grape/grape_files.rb
 - lib/rubocop/grape/inject.rb
 - lib/rubocop/grape/version.rb
 homepage: https://github.com/kakubin/rubocop-grape