carwow_rubocop 4.2.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb0368d67c7728b8bb6ae4427868535d8e1fca18fc91eaf7cf61409a74116827
-  data.tar.gz: e0a7aee5cc8953d93e1aa5e5e85bc538b3c237f3306c4eb0e595df841066fe39
+  metadata.gz: 2502f69ed5e5cd4255c0b1bf1c5c693aaf99d59a8b098ab35eef2dcd3d7b7eff
+  data.tar.gz: 2c5e6df20f64962209d92ee0fd8c709cfdc4ea90f09406ca84473bbe53bbb19e
 SHA512:
-  metadata.gz: d681a96c87057770250378b262ca70963d4d20c5987daca64d26c45a8dac9de816775d911d57e0df522d7c08c381f8e9f6ee80e849c976e075b89ad8d737744b
-  data.tar.gz: 4fae7c1ba3b2a704af6248f7a9e7e970cfcc75498ab6f0db637359f95afda913a6d663abbe44f68d658b7d1090a657111a6cd0d976a07673f46094c8ebba771e
+  metadata.gz: 91474e6f5948d8a99c2f82d6835dd680308bbcda86273639b78a54f750af43fc6dd8763a7b10c33467426f3dbece2a3170f610a1a02915d01ca4599b12fff828
+  data.tar.gz: bab97908a5aec300ca75d9ea208e0b99fb70da355958fa50b7f5f69882cc16de63c89c602509577dac7b0337acbc4e9c734e8fd268bc56b83681bd7f87aa6537

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    carwow_rubocop (4.2.0)
+    carwow_rubocop (6.0.0)
       rubocop (>= 1.44)
+      rubocop-factory_bot
       rubocop-performance
       rubocop-rspec
 
@@ -11,54 +12,55 @@ GEM
   specs:
     ast (2.4.2)
     coderay (1.1.3)
-    diff-lcs (1.5.0)
-    json (2.6.3)
+    diff-lcs (1.5.1)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    parallel (1.22.1)
-    parser (3.2.2.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
+      racc
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.50.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.66.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
-      rubocop (~> 1.41)
-    rubocop-performance (1.17.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.19.0)
-      rubocop (~> 1.33)
-      rubocop-capybara (~> 2.17)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
+    rubocop-performance (1.22.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (3.0.5)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.6.0)
 
 PLATFORMS
   ruby

data/carwow_rubocop.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rubocop', '>= 1.44'
   spec.add_dependency 'rubocop-performance'
   spec.add_dependency 'rubocop-rspec'
+  spec.add_dependency 'rubocop-factory_bot'
   spec.metadata = {
-    'rubygems_mfa_required' => 'true'
   }
 end

data/config/default.yml

@@ -32,3 +32,4 @@ inherit_from:
   - './rubocop-rspec.yml'
   - './rubocop-security.yml'
   - './rubocop-style.yml'
+  - './rubocop-factory_bot.yml'

data/config/rubocop-carwow.yml

@@ -31,3 +31,8 @@ Carwow/NoStubbingBusinessEvent:
   Include: &spec_only
     - "**/*_spec.rb"
     - "**/spec/**/*"
+
+Carwow/AddColumnWithComment:
+  Enabled: true
+  Include: &migrations_only
+    - "**/db/migrate/**/*.rb"

data/config/rubocop-factory_bot.yml

@@ -0,0 +1,8 @@
+require:
+  - rubocop-factory_bot
+
+FactoryBot:
+  Include:
+    - spec/factories/**/*.rb
+    - features/support/factories/**/*.rb
+

data/config/rubocop-rspec.yml

@@ -5,10 +5,6 @@ RSpec:
   Include:
     - _spec.rb
     - "(?:^|/)spec/"
-RSpec/FactoryBot:
-  Include:
-    - spec/factories/**/*.rb
-    - features/support/factories/**/*.rb
 
 RSpec/ContextWording:
   Enabled: False

data/lib/rubocop/carwow/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Carwow
-    VERSION = '4.2.0'.freeze
+    VERSION = '6.0.0'.freeze
   end
 end

data/lib/rubocop/cop/carwow/add_column_with_comment.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+module RuboCop
+  module Cop
+    module Carwow
+      # Checks the migration to confirm that new columns have a comment.
+      #
+      # @example
+      #   # bad
+      #   add_column :users, :name, :string
+      #
+      #   # bad
+      #   create_table :users do |t|
+      #     t.string :name
+      #     t.string :email
+      #   end
+      #
+      #   # good
+      #   add_column :users, :name, :string, comment: 'The name of the user'
+      #
+      #   # good
+      #   create_table :users do |t|
+      #     t.string :name, comment: 'The name of the user'
+      #     t.string :email, comment: 'The email of the user'
+      #   end
+      #
+      class AddColumnWithComment < Cop
+        MSG = "Missing 'comment' parameter for new column."
+
+        def_node_matcher :inside_create_table_block?, <<~PATTERN
+          (block (send nil? :create_table ...) (args ...) ...)
+        PATTERN
+
+        def_node_matcher :add_column?, <<~PATTERN
+          (send nil? :add_column ...)
+        PATTERN
+
+        def on_send(node)
+          return unless add_column?(node) || inside_create_table_block?(node.parent.parent)
+
+          # Timestamps and indexes do not need comments
+          return if %i[timestamps index].include?(node.method_name)
+
+          # Extract arguments
+          _receiver, _method_name, *args = *node
+
+          # Check if there is a 'comment' argument
+          comment_arg = find_comment_arg(args)
+
+          return if comment_arg
+
+          add_offense(node, location: :expression, message: MSG)
+        end
+
+        private
+
+        def find_comment_arg(args)
+          args.find { |arg| arg.hash_type? && arg.pairs.any? { |pair| pair.key.value == :comment } }
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carwow_rubocop
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 6.0.0
 platform: ruby
 authors:
 - carwow Developers
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2024-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: All carwow's ruby projects will follow these rules
 email:
 - developers@carwow.co.uk
@@ -130,6 +144,7 @@ files:
 - config/default.yml
 - config/rubocop-bundler.yml
 - config/rubocop-carwow.yml
+- config/rubocop-factory_bot.yml
 - config/rubocop-gemspec.yml
 - config/rubocop-layout.yml
 - config/rubocop-lint.yml
@@ -144,6 +159,7 @@ files:
 - lib/rubocop/carwow.rb
 - lib/rubocop/carwow/inject.rb
 - lib/rubocop/carwow/version.rb
+- lib/rubocop/cop/carwow/add_column_with_comment.rb
 - lib/rubocop/cop/carwow/jobs.rb
 - lib/rubocop/cop/carwow/jobs_must_define_queue.rb
 - lib/rubocop/cop/carwow/jobs_queue_name_style.rb
@@ -151,9 +167,8 @@ files:
 homepage: https://github.com/carwow/carwow_rubocop
 licenses:
 - MIT
-metadata:
-  rubygems_mfa_required: 'true'
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,8 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.20
+signing_key:
 specification_version: 4
 summary: carwow's rubocop configuration
 test_files: []