rubocop-petal 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23c16c29cc61affe8674156a8c36e121d07cbfda0f5db9a9bcc697822d52d263
-  data.tar.gz: e6b2d9dbc87c12675d08fd838d58710a0b47dd1084f39a5c6cff52f1a93517b2
+  metadata.gz: c9c488168be9965605cec779d3496901a44c339bfab481d46b6bfd5a766584aa
+  data.tar.gz: 4aa0a079fc001b2f42f8b7920a43353ae217dbc5c0dc6154c020604c3e9928ee
 SHA512:
-  metadata.gz: 7ac33dda0ec0a66d1819149a05a079ad152f666983eb4c5044f8dec987896d5fabee35e173a16b57cfb0eaa55275343eab672cf05532ccd46120ae14f6acb905
-  data.tar.gz: b06f412a68de52822e646e79fa707b222d57900ca9291350f9dc3b66ad76c75d4c653dddb23102cedea7d8c8022934abdb14576c4fe758715d0e3e3438b038e0
+  metadata.gz: bcbdc1f68ee6438939a848094d048e44da32aec786622dfcee20579e961c85eaf0aea1d88782eee2d85f8c1cc2304977e497e7be0a67e59e5e62d9d12ad0707b
+  data.tar.gz: c512bcd9560851dfaa04dab391b6fb2e760247af631ab6cc73d5cb411c166c4cfb2bda90f83bb93c32c485357ba3f132ffbaba76806621accea024ae8b845cbb

data/CHANGELOG.md

@@ -2,9 +2,17 @@
 
 # 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))
+* Update lock dependencies `rubocop-rails` ([#9](https://github.com/petalmd/rubocop-petal/pull/9))
 
 # v0.2.0
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-petal (0.2.1)
+    rubocop-petal (0.3.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-rails (~> 2.10)
 
@@ -51,7 +51,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.15.0)
       parser (>= 3.0.1.1)
-    rubocop-rails (2.12.4)
+    rubocop-rails (2.13.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.7.0, < 2.0)

data/config/default.yml

@@ -1,3 +1,22 @@
+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
@@ -11,12 +30,6 @@ RSpec/CreateListMax:
   Include:
     - spec/**/*
 
-Migration/UseChangeTableBulk:
-  Description: 'Enforces the use of option `bulk: true` with `change_table`'
-  Enabled: true
-  Include:
-    - db/migrate/**
-
 Grape/HelpersIncludeModule:
   Description: 'Prevent using helpers with block to include module'
   Enabled: true

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/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/petal/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-petal
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -67,8 +67,10 @@ files:
 - 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/use_change_table_bulk.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

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

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Migration
-      # Use `bulk: true` with `change_table`.
-      # # bad
-      #
-      # change_table :my_table
-      #
-      # # good
-      #
-      # change_table :my_table, bulk: true
-      class UseChangeTableBulk < Base
-        MSG = 'Use `change_table` with `bulk: true`.'
-        RESTRICT_ON_SEND = %i[change_table].freeze
-
-        def_node_matcher :use_bulk?, <<~PATTERN
-          (send nil? :change_table _ (hash <(pair (sym :bulk) true) ...>) ...)
-        PATTERN
-
-        def on_send(node)
-          return if use_bulk?(node)
-
-          add_offense(node)
-        end
-      end
-    end
-  end
-end