carwow_rubocop 4.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1593ae97f23dd4375b5bea2eee710c9767e912d50e3afa4a6bbf270f2f72bcb9
-  data.tar.gz: d29273a7037782e92b8e88aa8922e1993195b5a47616d1a40d15dce5560caae9
+  metadata.gz: e23461bfdf3292ee603d6094aaa3b6b5d6e0e9d5475e3db9bf7345674b57076d
+  data.tar.gz: ced30bc35295b82176b390599e33f9bb6b54a150be76c3c5e04bd2329a775855
 SHA512:
-  metadata.gz: af53a7e90bb870699a174da4b1ca943755e93be8bd867d38ee967a1f1b68a8538aec28fcee0e522397f6fc0c43bee7c415b1a43187ea211a5c0c3fefa35bb9ad
-  data.tar.gz: '0490e795a93c139d24694994778ee63875698cf694b2bba8d63d3697b21b2b65dd729bdc7fa6acdb92a9d6d2d34e74435a1e8b3e126bff281ad9d322a12d1a2a'
+  metadata.gz: 9faf779b59d6ba0bf8cd5c5076869eb29b90874f0d845e3a95ba058d55bca36811476962c94b76ece7bd4f89a4b45517414d05a9021fe84f3297e2e9ad8f0892
+  data.tar.gz: b7dc05cf6539f33a19f17aa572f29985963c757288592782ffeb0298d4b400b4831af5ccbaec183856dec7cc9ac105802cd0e86b23ec46695a823bdf7bc1b67c

data/.circleci/config.yml

@@ -32,7 +32,7 @@ jobs:
           steps:
             - checkout
             - run: bundle install --jobs=4 --retry=3
-            - run: bundle exec rubocop -p
+            - run: bundle exec rubocop --parallel
 
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    carwow_rubocop (4.1.1)
+    carwow_rubocop (5.0.0)
       rubocop (>= 1.44)
       rubocop-performance
       rubocop-rspec
@@ -15,14 +15,14 @@ GEM
     json (2.6.3)
     method_source (1.0.0)
     parallel (1.22.1)
-    parser (3.2.0.0)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.2)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -37,27 +37,27 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.44.1)
+    rubocop (1.50.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
-    rubocop-capybara (2.17.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
       rubocop (~> 1.41)
-    rubocop-performance (1.15.2)
+    rubocop-performance (1.17.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.18.1)
+    rubocop-rspec (2.19.0)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     unicode-display_width (2.4.2)
 
 PLATFORMS

data/config/default.yml

@@ -7,7 +7,7 @@ require:
 # Global rules
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
   NewCops: enable
   Exclude:
     - '.git/**/*'

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.1.1'.freeze
+    VERSION = '5.0.0'.freeze
   end
 end

data/lib/rubocop/carwow.rb

@@ -1,7 +1,7 @@
 require 'pathname'
 require 'psych'
 
-Dir.glob(File.expand_path('cop/**/*.rb', File.dirname(__FILE__))).sort.each do |file|
+Dir.glob(File.expand_path('cop/**/*.rb', File.dirname(__FILE__))).each do |file|
   require file
 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.1.1
+  version: 5.0.0
 platform: ruby
 authors:
 - carwow Developers
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-25 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: []