carwow_rubocop 4.2.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb0368d67c7728b8bb6ae4427868535d8e1fca18fc91eaf7cf61409a74116827
-  data.tar.gz: e0a7aee5cc8953d93e1aa5e5e85bc538b3c237f3306c4eb0e595df841066fe39
+  metadata.gz: e23461bfdf3292ee603d6094aaa3b6b5d6e0e9d5475e3db9bf7345674b57076d
+  data.tar.gz: ced30bc35295b82176b390599e33f9bb6b54a150be76c3c5e04bd2329a775855
 SHA512:
-  metadata.gz: d681a96c87057770250378b262ca70963d4d20c5987daca64d26c45a8dac9de816775d911d57e0df522d7c08c381f8e9f6ee80e849c976e075b89ad8d737744b
-  data.tar.gz: 4fae7c1ba3b2a704af6248f7a9e7e970cfcc75498ab6f0db637359f95afda913a6d663abbe44f68d658b7d1090a657111a6cd0d976a07673f46094c8ebba771e
+  metadata.gz: 9faf779b59d6ba0bf8cd5c5076869eb29b90874f0d845e3a95ba058d55bca36811476962c94b76ece7bd4f89a4b45517414d05a9021fe84f3297e2e9ad8f0892
+  data.tar.gz: b7dc05cf6539f33a19f17aa572f29985963c757288592782ffeb0298d4b400b4831af5ccbaec183856dec7cc9ac105802cd0e86b23ec46695a823bdf7bc1b67c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carwow_rubocop (4.2.0)
+    carwow_rubocop (5.0.0)
       rubocop (>= 1.44)
       rubocop-performance
       rubocop-rspec

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/lib/rubocop/carwow/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Carwow
-    VERSION = '4.2.0'.freeze
+    VERSION = '5.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: 5.0.0
 platform: ruby
 authors:
 - carwow Developers
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,6 +144,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
@@ -153,7 +154,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: carwow's rubocop configuration
 test_files: []