rubocop-petal 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19be17cd451b07bcec9a8d40b5b2f5b6ba1b8b6b1c41b72a6de2d09e2418a5aa
-  data.tar.gz: fae5baf51f4cc13bcb846cf7821c8747aeaf35ed171bed13c167e3697845f0a2
+  metadata.gz: c9c488168be9965605cec779d3496901a44c339bfab481d46b6bfd5a766584aa
+  data.tar.gz: 4aa0a079fc001b2f42f8b7920a43353ae217dbc5c0dc6154c020604c3e9928ee
 SHA512:
-  metadata.gz: e263be802e2969189d10679f9287ecc6d7653644040574e5ad3ffa3221be90cc5aee59c75689ae4ef6a8287b2d95040b4430413995cd0c4b5d4a8ecdcde4ecd3
-  data.tar.gz: 5f19e9ead08ad127feb9e9efb16bcd0eda62e3f5a79e859d77f5eec2e227ae98cb3bcfea43e5ad5db6d046fda3d7b4ade723f4d68a1f8222243f55c8f9c2aba6
+  metadata.gz: bcbdc1f68ee6438939a848094d048e44da32aec786622dfcee20579e961c85eaf0aea1d88782eee2d85f8c1cc2304977e497e7be0a67e59e5e62d9d12ad0707b
+  data.tar.gz: c512bcd9560851dfaa04dab391b6fb2e760247af631ab6cc73d5cb411c166c4cfb2bda90f83bb93c32c485357ba3f132ffbaba76806621accea024ae8b845cbb

data/.github/workflows/build.yml

@@ -1,7 +1,9 @@
 name: Build
-
-on: [push,pull_request]
-
+on:
+  pull_request:
+  push:
+    branches:
+      - main
 jobs:
   build:
     runs-on: ubuntu-latest

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.idea/
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -15,4 +15,4 @@ Metrics/BlockLength:
     - spec/**/*_spec.rb
 
 RSpec/ExampleLength:
-  Max: 10
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+# main
+
+# v0.3.0
+
+* Added cop `Added Migration/ForeignKeyOption` ([#11](https://github.com/petalmd/rubocop-petal/pull/11))
+* Added cop `Added Grape/PreferNamespace` ([#6](https://github.com/petalmd/rubocop-petal/pull/6))
+* Added cop `Added Migration/SchemaStatementsMethods` ([#14](https://github.com/petalmd/rubocop-petal/pull/14))
+* Remove cop `Added Migration/UseChangeTableBulk` ([#15](https://github.com/petalmd/rubocop-petal/pull/15))
+* Update cop `Grape/PreferNamespace` ([#16](https://github.com/petalmd/rubocop-petal/pull/16))
+
+# v0.2.1
+
+* Update lock dependencies `rubocop-rails` ([#9](https://github.com/petalmd/rubocop-petal/pull/9))
+
+# v0.2.0
+
+* Added cop `RSpec/AuthenticatedAs` ([#3](https://github.com/petalmd/rubocop-petal/pull/3))
+* Added cop `Grape/UnnecessaryNamespace` ([#2](https://github.com/petalmd/rubocop-petal/pull/2))
+* Added cop `RSpec/CreateListMax` ([#4](https://github.com/petalmd/rubocop-petal/pull/4))
+* Added Cop `Migration/UseChangeTableBulk` ([#7](https://github.com/petalmd/rubocop-petal/pull/7))
+* Added cop `Grape/HelpersIncludeModule` ([#1](https://github.com/petalmd/rubocop-petal/pull/1))
+
+# v0.1.0
+
+* First version

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    rubocop-petal (0.1.0)
-      rubocop
-      rubocop-rails
+    rubocop-petal (0.3.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-rails (~> 2.10)
 
 GEM
   remote: https://rubygems.org/
@@ -51,10 +51,10 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.15.0)
       parser (>= 3.0.1.1)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.13.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
+      rubocop (>= 1.7.0, < 2.0)
     rubocop-rspec (2.6.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)

data/README.md

@@ -1,6 +1,7 @@
 # RuboCop::Petal
 
 [![Build](https://github.com/petalmd/rubocop-petal/actions/workflows/build.yml/badge.svg)](https://github.com/petalmd/rubocop-petal/actions/workflows/build.yml)
+[![Gem Version](https://badge.fury.io/rb/rubocop-petal.svg)](https://badge.fury.io/rb/rubocop-petal)
 
 Petal custom cops. List of cops can be find [here](https://github.com/petalmd/rubocop-petal/tree/main/lib/rubocop/cop).
 
@@ -26,21 +27,27 @@ In your `.rubocop.yml` file, add `rubocop-petal`
 
 ```yaml
 require:
-  - rubocop-rails
+  - rubocop-petal
 ```
 
 ## Development
 
-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.
+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.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+To run all checks like the CI simply run `bundle exec rake`.
+
 ## Create new cop
 
 ```shell
 bundle exec rake 'new_cop[Rails/MyNewCop]'
 ```
 
+Have a look to [RuboCop documentation](https://docs.rubocop.org/rubocop/1.23/development.html) to get started with
+_node pattern_.
+
 ## Release
 
 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).

data/config/default.yml

@@ -1,3 +1,47 @@
+Grape/PreferNamespace:
+  Description: 'Prevent usage of namespace aliases.'
+  Enabled: true
+  StyleGuide: https://github.com/ruby-grape/grape#namespace-validation-and-coercion
+  Include:
+    - app/api/**/*
+
+Migration/ForeignKeyOption:
+  Description: 'Specify the foreign key option to create the constraint.'
+  Enabled: true
+  Include:
+    - db/migrate/**
+
+Migration/SchemaStatementsConnection:
+  Description: 'Suggest to use SchemaStatements methods already defined in a migration class.'
+  Enabled: true
+  Include:
+    - db/migrate/**
+
+RSpec/AuthenticatedAs:
+  Description: 'Suggest to use authenticated_as instead of legacy api_key.'
+  Enabled: true
+  Include:
+    - spec/api/**/*_spec.rb
+
+RSpec/CreateListMax:
+  Description: 'Prevent creating to most records with `FactoryBot.create_list`.'
+  Enabled: true
+  Max: 5
+  Include:
+    - spec/**/*
+
+Grape/HelpersIncludeModule:
+  Description: 'Prevent using helpers with block to include module'
+  Enabled: true
+  Include:
+    - app/api/**/*
+
+Grape/UnnecessaryNamespace:
+  Description: 'Detect unnecessary usage of Grape namespace.'
+  Enabled: true
+  Include:
+    - app/api/**/*
+
 Rails/EnumPrefix:
   Description: 'Set prefix options when using enums.'
   Enabled: true

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      # Prevent usage of Grape `helpers` with a block to include module.
+      # Using a bloc will create a new unnecessary module.
+      #
+      #   # bad
+      #   helpers do
+      #     include MyModule
+      #   end
+      #
+      #   # bad
+      #   helpers do
+      #     include MyModule
+      #     include MyOtherModule
+      #   end
+      #
+      #   # good
+      #   helpers MyModule
+      #
+      #   # good
+      #   helpers MyModule, MyOtherModule
+      class HelpersIncludeModule < Base
+        MSG = 'Use `helpers %<module_name>s` instead of `helpers` with a block.'
+
+        def_node_matcher :helpers?, <<~PATTERN
+          (send nil? :helpers)
+        PATTERN
+
+        def_node_matcher :called_include?, <<~PATTERN
+          (send nil? :include (const _ $_))
+        PATTERN
+
+        def on_send(node)
+          return unless helpers?(node)
+
+          helpers_block_node = node.block_node.children.last
+          block_nodes = block_nodes_in_helpers(helpers_block_node)
+
+          block_nodes.each do |block_node|
+            if (module_name = called_include?(block_node))
+              add_offense(block_node, message: format(MSG, module_name: module_name))
+            end
+          end
+        end
+
+        private
+
+        def block_nodes_in_helpers(node)
+          if node.begin_type?
+            node.children
+          else
+            [node]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      # Prevent usage of `namespace` aliases
+      #
+      #   # bad:
+      #
+      #   group :my_group do ... end
+      #   resource :my_resource do ... end
+      #   resources :my_resources do ... end
+      #   segment :my_segment do ... end
+      #
+      #   # good:
+      #
+      #   namespace :my_namespace do ... end
+      #
+      class PreferNamespace < Base
+        extend AutoCorrector
+
+        MSG = 'Prefer using `namespace` over its aliases.'
+
+        NAMESPACE_ALIASES = %i[resource resources group segment].freeze
+        RESTRICT_ON_SEND = NAMESPACE_ALIASES
+
+        def_node_matcher :using_alias_on_api?, <<~PATTERN
+          (send nil? ...)
+        PATTERN
+
+        def_node_matcher :namespace_alias, <<~PATTERN
+          (send nil? $_ ...)
+        PATTERN
+
+        def on_send(node)
+          return unless using_alias_on_api? node
+          # Check if use block
+          return unless node.block_node&.children&.last
+
+          add_offense(node) do |corrector|
+            corrector.replace(node, node.source.gsub(/^#{namespace_alias(node)}/, 'namespace'))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Grape
+      # Detect unnecessary usage of Grape namespace.
+      #
+      #   # bad
+      #   namespace :my_namespace
+      #     get {}
+      #   end
+      #
+      #   # good
+      #   get :my_namespace {}
+      #
+      class UnnecessaryNamespace < Base
+        MSG = 'Unnecessary usage of Grape namespace. '\
+              'Specify endpoint name with a argument: `get :my_namespace`.'
+        HTTP_ACTIONS = Set.new(%i[get put post patch delete])
+        GRAPE_NAMESPACE_ALIAS = Set.new(%i[namespace resource resources])
+        METHOD_JUSTIFY_NAMESPACE = Set.new(%i[route_param namespaces resource resources version])
+
+        def_node_matcher :namespace?, <<~PATTERN
+          (send nil? GRAPE_NAMESPACE_ALIAS ({sym | str} _))
+        PATTERN
+
+        def_node_matcher :justify_namespace?, <<~PATTERN
+          (block (send nil? METHOD_JUSTIFY_NAMESPACE ...) ...)
+        PATTERN
+
+        def_node_matcher :http_action?, <<~PATTERN
+          (block (send nil? HTTP_ACTIONS) ...)
+        PATTERN
+
+        def on_send(node)
+          return unless namespace?(node)
+
+          node_to_select_http_action = namespace_node(node)
+
+          return if node_to_select_http_action.any? do |namespace_node|
+            justify_namespace?(namespace_node)
+          end
+
+          http_action_node = select_http_action_block_node(node_to_select_http_action)
+          add_offense(node) if http_action_node.size == 1
+        end
+
+        private
+
+        def select_http_action_block_node(nodes)
+          nodes.select { |node| http_action?(node) }
+        end
+
+        def namespace_node(node)
+          if node.block_node.children.last.block_type?
+            [node.block_node.children.last]
+          else
+            node.block_node.children.last.children
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/migration/foreign_key_option.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Migration
+      # Specify the foreign key option to create the constraint.
+      #
+      #   # bad
+      #   add_reference(:products, :user)
+      #   add_reference(:products, :user, foreign_key: false)
+      #   add_belongs_to(:products, :user)
+      #   t.references(:user)
+      #
+      #   # good
+      #   add_reference(:products, :user, foreign_key: true)
+      #   add_reference(:products, :user, foreign_key: { to_table: users })
+      #   add_belongs_to(:products, :user, foreign_key: true)
+      #   t.references(:user, foreign_key: true)
+      #
+      class ForeignKeyOption < Base
+        MSG = 'Add `foreign_key: true` or `foreign_key: { to_table: :some_table }`'
+
+        ADDING_REFERENCES_METHODS = Set.new(%i[add_reference add_belongs_to references belongs_to]).freeze
+
+        def_node_matcher :adding_reference?, <<~PATTERN
+          (send _ ADDING_REFERENCES_METHODS ...)
+        PATTERN
+
+        def_node_matcher :foreign_key_option?, <<~PATTERN
+          (send _ ADDING_REFERENCES_METHODS ... (hash <(pair (sym :foreign_key) {true hash}) ...>))
+        PATTERN
+
+        def_node_matcher :polymorphic_reference?, <<~PATTERN
+          (... (hash <(pair (sym :polymorphic) true) ... >))
+        PATTERN
+
+        def on_send(node)
+          return unless adding_reference?(node)
+          return if polymorphic_reference?(node)
+
+          add_offense(node) unless foreign_key_option?(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/migration/schema_statements_methods.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Migration
+      # Use SchemaStatements methods already defined in a migration class.
+      # Using already defined method is sorter and will be log during migration.
+      #
+      #   # bad
+      #   ActiveRecord::Base.connection.table_exists? 'users'
+      #
+      #   # bad
+      #   ActiveRecord::Base.connection.column_exists? 'users', 'first_name'
+      #
+      #   # bad
+      #   ApplicationRecord.connection.execute('SELECT COUNT(*) FROM `users`')
+      #
+      #   # good
+      #   table_exists? 'users'
+      #
+      #   # good
+      #   column_exists? 'users', 'first_name'
+      #
+      #   # good
+      #   execute('SELECT COUNT(*) FROM `users`')
+      #
+      class SchemaStatementsMethods < Base
+        extend AutoCorrector
+
+        MSG = 'Use already defined methods. Remove `ActiveRecord::Base.connection`.'
+
+        def_node_matcher :use_connection, <<~PATTERN
+          (:send (... (:const ...) :connection) ...)
+        PATTERN
+
+        def on_send(node)
+          return unless use_connection(node)
+
+          add_offense(node.children[0]) do |corrector|
+            corrector.replace(node, node.source.gsub("#{node.children[0].source}.", ''))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec/authenticated_as.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Suggest to use authenticated_as instead of legacy api_key.
+      # It is faster, can be setup for multiple test.
+      #
+      #   # bad
+      #   get 'api/my_endpoint', headers: { HTTP_API_KEY: user.api_key }
+      #
+      #   # good
+      #   authenticated_as user
+      #   get 'api/my_endpoint'
+      #
+      class AuthenticatedAs < Base
+        MSG = 'Use `authenticated_as` instead of legacy api_key.'
+
+        def_node_search :use_header_api_key, <<~PATTERN
+          (sym :HTTP_API_KEY)
+        PATTERN
+
+        def on_send(node)
+          api_key_usage = use_header_api_key(node).to_a.first
+          return unless api_key_usage
+
+          add_offense(api_key_usage)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec/create_list_max.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Prevent creating to most records with `FactoryBot.create_list`.
+      # Creating to much records can significantly increase spec time.
+      #
+      # @example Max: 5 (default)
+      #   # Maximum amount params allowed for `create_list`.
+      #
+      #   # bad
+      #   create_list :my_model, 10
+      #
+      #   # good
+      #   create_list :my_model, 5
+      #
+      #   # good
+      #   build_stubbed_list :my_model, 10
+      #
+      class CreateListMax < Base
+        MSG = 'Creating more than `%<max_config>s` records is discouraged.'
+        DEFAULT_MAX = 5
+        RESTRICT_ON_SEND = [:create_list].freeze
+
+        def_node_search :create_list, <<~PATTERN
+          (send _ :create_list (sym _) (:int $_) ...)
+        PATTERN
+
+        def on_send(node)
+          amount = create_list(node).to_a.first
+
+          return unless amount
+
+          max_config = cop_config['Max'] || DEFAULT_MAX
+
+          add_offense(node, message: format(MSG, max_config: max_config)) if amount > max_config
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/petal/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Petal
-    VERSION = '0.1.0'
+    VERSION = '0.3.0'
   end
 end

data/rubocop-petal.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
 
-  spec.add_runtime_dependency 'rubocop'
-  spec.add_dependency 'rubocop-rails'
+  spec.add_runtime_dependency 'rubocop', '>= 1.7.0', '< 2.0'
+  spec.add_dependency 'rubocop-rails', '~> 2.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-petal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,28 +16,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.10'
 description:
 email:
 - jfbastien@petalmd.com
@@ -49,6 +55,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -59,10 +66,17 @@ files:
 - config/default.yml
 - lib/rubocop-petal.rb
 - lib/rubocop/cop/chewy/reset_on_type.rb
+- lib/rubocop/cop/grape/helpers_include_module.rb
+- lib/rubocop/cop/grape/prefer_namespace.rb
+- lib/rubocop/cop/grape/unnecessary_namespace.rb
+- lib/rubocop/cop/migration/foreign_key_option.rb
+- lib/rubocop/cop/migration/schema_statements_methods.rb
 - lib/rubocop/cop/petal_cops.rb
 - lib/rubocop/cop/rails/enum_prefix.rb
 - lib/rubocop/cop/rails/risky_activerecord_invocation.rb
 - lib/rubocop/cop/rails/table_name.rb
+- lib/rubocop/cop/rspec/authenticated_as.rb
+- lib/rubocop/cop/rspec/create_list_max.rb
 - lib/rubocop/petal.rb
 - lib/rubocop/petal/inject.rb
 - lib/rubocop/petal/version.rb