Fix Cops, Fix problems with v2 (#49)

* require suggested sigil to be strict Co-Authored-By: Matjaž Kavčič <[email protected]> * ensure the sigil is strict Co-Authored-By: Matjaž Kavčič <[email protected]> * ensure private is inlined (same as private_class_method) * add a cop for line length * fix version 2 * CI * Update CHANGELOG.md * fix merge conflict * safe doesn't exist for layout cop * rubocop fixes for the gem's code --------- Co-authored-by: Matjaž Kavčič <[email protected]>
dbl-works · Mar 19, 2024 · 00b08f9 · 00b08f9
1 parent 6a33360
commit 00b08f9
Show file tree

Hide file tree

Showing 11 changed files with 156 additions and 113 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -3,10 +3,9 @@ on: [push]
 jobs:
   test:
     name: ${{ matrix.ruby }} / ${{ matrix.gemfile }}
+    runs-on: ubuntu-latest
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
-    runs-on: ubuntu-latest
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
 
     strategy:
       fail-fast: false
@@ -22,7 +21,6 @@ jobs:
           - gemfiles/rails_6.1.gemfile
           - gemfiles/rails_7.0.gemfile
         exclude:
-          # fatal error with: 1.8.0 (using Parser 3.1.0.0, rubocop-ast 1.15.1, running on ruby 3.1.0 x86_64-linux)
           - ruby: 3.1
             gemfile: gemfiles/rubocop_1.8.gemfile
           - ruby: 3.2

diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1 +1,4 @@
 inherit_from: ./config/dbl.yml
+
+Sorbet/StrictSigil:
+  Enabled: false
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.1.0] - 2024-03-19
+### Changed
+- Removed Rails cops, but auto-add Rails config when generating the config file if Rails is defined
+
 ## [2.0.0] - 2023-12-30
 ### Changed
 - Rails Cops are only enabled, if `Rails` is a defined constant

diff --git a/config/cops/layout.yml b/config/cops/layout.yml
@@ -24,3 +24,10 @@ Layout/ParameterAlignment:
   SupportedStyles:
     - with_first_parameter
     - with_fixed_indentation
+
+Layout/LineLength:
+  Max: 120
+  IgnoreCopDirectives: true
+  AllowedPatterns: ['\s#\s'] # allows comments to overflow the line length. E.g. for URLs
+  Exclude:
+    - 'spec/**/*'
diff --git a/config/cops/rails.yml b/config/cops/rails.yml
diff --git a/config/cops/style.yml b/config/cops/style.yml
@@ -76,3 +76,7 @@ Style/RedundantArgument:
 
 Style/SwapValues:
   Enabled: true
+
+# "private_class_method" must always be inlined, no need for a cop
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
diff --git a/config/cops/types.yml b/config/cops/types.yml
@@ -11,8 +11,14 @@
 #
 
 Sorbet/HasSigil:
-  MinimumStrictness: true
+  MinimumStrictness: strict
   SuggestedStrictness: strict
   Exclude:
-    - spec/**/*
-    - test/**/*
+    - "spec/**/*"
+    - "test/**/*"
+
+Sorbet/StrictSigil:
+  Enabled: true
+  Exclude:
+    - "spec/**/*"
+    - "lib/tasks/**/*"
diff --git a/config/dbl.yml b/config/dbl.yml
@@ -20,7 +20,7 @@ inherit_from:
 # see: https://docs.rubocop.org/rubocop/usage/caching.html
 AllCops:
   UseCache: true
-  TargetRubyVersion: 3.1.4
+  TargetRubyVersion: 3.0.0
   NewCops: enable
   Exclude:
     - '**/tmp/**/*'
@@ -30,7 +30,6 @@ AllCops:
     - 'actionmailbox/test/dummy/**/*'
     - 'actiontext/test/dummy/**/*'
     - '**/node_modules/**/*'
-    # Additional exclude files by rubocop-rails
     - 'bin/**/*'
     - 'config/**/*'
     - 'db/**/*'
diff --git a/lib/generators/rubocop_dbl/install_generator.rb b/lib/generators/rubocop_dbl/install_generator.rb
@@ -10,38 +10,143 @@ class InstallGenerator < Rails::Generators::Base
 
       def create_config_file
         file_method = config_file_exists? ? :prepend : :create
-        send :"#{file_method}_file", config_file_path, config_file_content
-      end
+        content = defined?(Rails) ? config_file_content_rails : config_file_content
 
-      private
+        send(
+          :"#{file_method}_file",
+          config_file_path,
+          content,
+        )
+      end
 
-      def config_file_exists?
+      private def config_file_exists?
         File.exist?(config_file_path)
       end
 
-      def config_file_path
+      private def config_file_path
         '.rubocop.yml'
       end
 
-      def config_file_content
-        if defined?(Rails)
-          <<~HEREDOC
-            require:
-              - rubocop-rails
-
+      private def config_file_content
+        <<~HEREDOC
             inherit_gem:
               rubocop-dbl:
-                - config/dbl.yml
-                - config/cops/rails.yml
-          HEREDOC
-        else
-          <<~HEREDOC
+              - config/dbl.yml
 
-            inherit_gem:
-              rubocop-dbl:
+          # we do not want to overwrite the base-array (from rubocop-dbl), but extend it
+          inherit_mode:
+            merge:
+              - Exclude
+
+          AllCops:
+            TargetRubyVersion: 3.3.0
+            Exclude:
+              - 'sorbet/rbi/shims/**/*'
+        HEREDOC
+      end
+
+      private def config_file_content_rails
+        <<~HEREDOC
+          require:
+            - rubocop-rails
+
+          inherit_gem:
+            rubocop-dbl:
               - config/dbl.yml
-          HEREDOC
-        end
+
+          inherit_mode:
+            merge:
+              - Exclude
+
+          AllCops:
+            TargetRubyVersion: 3.3.0
+            Exclude:
+              - 'sorbet/rbi/shims/**/*'
+
+          # Defaults for this cop are found here:
+          # https://github.com/rubocop/rubocop-rails/blob/master/config/default.yml
+          #
+          # Add customizations below.
+          #
+          # Ensure to document why we change a default by linking the corresponding PR.
+          # For example:
+          #
+          #     Rails/ActionFilter:
+          #       Enabled: false
+          #
+
+          # @NOTE: added: "staging"
+          Rails/UnknownEnv:
+            Environments:
+              - production
+              - development
+              - test
+              - staging
+
+          # @NOTE: disabled
+          Rails/HttpStatus:
+            Enabled: false
+
+          # @NOTE: disabled
+          Rails/ApplicationController:
+            Enabled: false
+
+
+          #
+          # @NOTE: all the cops ahead are "pending" in the current default config
+          #
+          Rails/ActiveRecordCallbacksOrder:
+            Enabled: true
+
+          Rails/AfterCommitOverride:
+            Enabled: true
+
+          Rails/AttributeDefaultBlockValue:
+            Enabled: true
+
+          Rails/FindById:
+            Enabled: true
+
+          Rails/Inquiry:
+            Enabled: true
+
+          Rails/MailerName:
+            Enabled: true
+
+          Rails/MatchRoute:
+            Enabled: true
+
+          Rails/NegateInclude:
+            Enabled: true
+
+          Rails/Pluck:
+            Enabled: true
+
+          Rails/PluckInWhere:
+            Enabled: true
+
+          Rails/RenderInline:
+            Enabled: true
+
+          Rails/RenderPlainText:
+            Enabled: true
+
+          Rails/ShortI18n:
+            Enabled: true
+            EnforcedStyle: aggressive
+
+          Rails/SquishedSQLHeredocs:
+            Enabled: true
+
+          Rails/WhereEquals:
+            Enabled: true
+
+          Rails/WhereExists:
+            Enabled: true
+
+          Rails/WhereNot:
+            Enabled: true
+        HEREDOC
       end
     end
   end

diff --git a/lib/rubocop_dbl/version.rb b/lib/rubocop_dbl/version.rb
@@ -1,5 +1,5 @@
 # typed: false
 
 module RubocopDbl
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.0'.freeze
 end
diff --git a/rubocop-dbl.gemspec b/rubocop-dbl.gemspec
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   ]
   spec.homepage              = 'https://github.com/dbl-works/rubocop-dbl'
   spec.license               = 'MIT'
-  spec.required_ruby_version = '>= 3.1'
+  spec.required_ruby_version = '>= 3.0'
 
   spec.add_dependency 'rubocop', '~> 1'
   spec.add_dependency 'rubocop-ast', '~> 1'