rubocop-config-captive 2.0.0.pre.alpha → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89d7f60a4c0f6bf82d38c7edb07550329610e4582994eab5fb226f24f89c8151
-  data.tar.gz: 05efb5230791a782bf022fba4b8b8846b2afda8d9a4ffb59e6762e182ff54ef7
+  metadata.gz: 025aa502d3ae6f6bf653e87ae00bdc61386dc3497706c87c2f6a30f3fb46e0e1
+  data.tar.gz: 498f927eb7dd914eb6416401cb06cd7ecc53d5fc839479e152a6bc978e9eb332
 SHA512:
-  metadata.gz: '08acab7ddee1ce4de738918def23ef8dd9604f6983f2cda849ee3fe61f8e880a2d10d29a2eeff871f5679fabdacc175b3cd31757af81d5093bc0b42a5e866fc6'
-  data.tar.gz: 337bd6708b8a78899344d7d768b691b3b3d8748ceb48933a611cf7df0f5179091acacd97db5d66a7b5b6304f1bffb3f5ff88e310bc7b6c3d16bf38271dc4e03d
+  metadata.gz: de0db8c0afe4f0fdab648baba4a25fda50df28fabc4773eaa2bf28a12a3947add08da9d9d1bb6f0a375e9efa4729ac4487ecdc15ad252f3a267e7813e3e69b7b
+  data.tar.gz: 234503342ef955c2caf0929e3144d1db474361b8f5f56ea5589c4077f00e90852ce1146ac8aadfdd6aacf1373156f74d30e028e10b46c0057a4361ea5006c505

data/README.md

@@ -11,7 +11,7 @@ add the follow line into your `Gemfile`
 
 ```ruby
 group :test, :development do
-  gem 'rubocop-config-captive'
+  gem 'rubocop-config-captive', '~> 2.0'
 end
 ```
 

data/config/__private__/rubocop-capybara.yml

@@ -1,6 +1,5 @@
 ### ⚠️ GENERATED WITH `script/pull`. DO NOT EDIT MANUALLY. ###
-require:
-  - rubocop-capybara
+plugins: rubocop-capybara
 
 Capybara/CurrentPathExpectation:
   Description: Checks that no expectations are set on Capybara's `current_path`.

data/config/__private__/rubocop-naming.yml

@@ -48,7 +48,7 @@ Naming/MethodName:
   - snake_case
   - camelCase
 
-Naming/PredicateName:
+Naming/PredicatePrefix:
   Description: Check the names of predicate methods.
   StyleGuide: https://github.com/rubocop-hq/ruby-style-guide#bool-methods-qmark
   Enabled: false

data/config/rubocop-captive.yml

@@ -4,8 +4,10 @@ require:
   - ../lib/rubocop/cop/captive/translation/rails_i18n_presence.rb
   - ../lib/rubocop/cop/captive/translation/kaminari_i18n_presence.rb
   - ../lib/rubocop/cop/captive/rspec/specify_before_parameter.rb
+  - ../lib/rubocop/cop/captive/rails/after_commit_not_allowed.rb
   - ../lib/rubocop/cop/captive/rails/force_ssl_enabled_in_production.rb
   - ../lib/rubocop/cop/captive/rails/migration_methods.rb
+  - ../lib/rubocop/cop/captive/rails/no_disable_ddl_transaction.rb
   - ../lib/rubocop/cop/captive/rails/no_email_from_controller.rb
   - ../lib/rubocop/cop/captive/rails/no_float_price_columns.rb
   - ../lib/rubocop/cop/captive/rails/no_find_by_in_scope.rb
@@ -40,6 +42,16 @@ Captive/RSpec/SpecifyBeforeParameter:
   Include:
     - 'spec/**/*'
 
+# Rails
+Captive/Rails/AfterCommitNotAllowed:
+  Description: "Interdit l'utilisation de `after_commit` dans les modèles Rails."
+  Severity: error
+  Enabled: true
+  Include:
+    - 'app/models/**/*.rb'
+  Exclude: []
+  Match: 'after_commit'
+
 Captive/Rails/ForceSslEnabledInProduction:
   Description: "Ensures SSL is forced in production, so that secure cookies are used."
   Include:
@@ -50,6 +62,11 @@ Captive/Rails/MigrationMethods:
   Include:
     - 'db/migrate/**/*'
 
+Captive/Rails/NoDisableDdlTransaction:
+  Description: "Avoid using 'disable_ddl_transaction!' in migrations."
+  Include:
+    - 'db/migrate/**/*'
+
 Captive/Rails/NoEmailFromController:
   Description: "Do not send emails from controllers. Because it doesn't follow the MVC standard"
   Include:

data/config/rubocop-capybara.yml

@@ -1,2 +1 @@
-require:
-  - rubocop-capybara
+plugins: rubocop-capybara

data/config/rubocop-factory_bot.yml

@@ -1,2 +1 @@
-require:
-  - rubocop-factory_bot
+plugins: rubocop-factory_bot

data/config/rubocop-rails-omakase.yml

@@ -1,2 +1,2 @@
-require:
-  - rubocop-rails-omakase
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml

data/config/rubocop-rake.yml

@@ -1,2 +1 @@
-require:
-  - rubocop-rake
+plugins: rubocop-rake

data/lib/rubocop/captive/inject.rb

@@ -11,7 +11,7 @@ module RuboCop
         path = CONFIG_DEFAULT.to_s
         hash = ConfigLoader.load_file(path).to_hash
         config = Config.new(hash, path)
-        puts "configuration from #{path}" if ConfigLoader.debug?
+        Rails.logger.debug "configuration from #{path}" if ConfigLoader.debug?
         config = ConfigLoader.merge_with_default(config, path)
         ConfigLoader.instance_variable_set(:@default_configuration, config)
       end

data/lib/rubocop/captive/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Captive
-    VERSION = "2.0.0-alpha"
+    VERSION = "2.0.1"
   end
 end

data/lib/rubocop/cop/captive/rails/after_commit_not_allowed.rb

@@ -0,0 +1,52 @@
+module RuboCop
+  module Cop
+    module Captive
+      module Rails
+        # This cop checks for the use of `after_commit` in Rails models.
+        # Using `after_commit` can lead to unexpected behaviors and is discouraged.
+        # Instead, consider using a service object to handle the logic that would
+        # otherwise be placed inside an `after_commit` callback.
+        #
+        # For more information, see the documentation:
+        # https://captive.notion.site/Quota-expir-PDF-Monkey-25e707bff8eb8094ba48ecc564fe5bd7?source=copy_link
+        #
+        # @example
+        #   # bad
+        #   class MyModel < ApplicationRecord
+        #     after_commit :some_method
+        #   end
+        #
+        #   # good
+        #   class MyModel < ApplicationRecord
+        #     def save_something
+        #       MyService.new(self).call
+        #     end
+        #   end
+        #
+        #   # better
+        #   # Use a service object for handling post-persistence logic
+        #   class MyService
+        #     def initialize(model)
+        #       @model = model
+        #     end
+        #
+        #     def call
+        #       # Perform the operations needed after commit
+        #     end
+        #   end
+        class AfterCommitNotAllowed < Base
+          MSG = "Interdit l'utilisation de `after_commit` dans les modèles Rails. \
+            Utilisez un service plutôt."
+
+          def_node_matcher :after_commit?, <<~PATTERN
+            (send nil? :after_commit ...)
+          PATTERN
+
+          def on_send(node)
+            add_offense(node, message: MSG) if after_commit?(node)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/captive/rails/migration_methods.rb

@@ -31,7 +31,7 @@ module RuboCop
           MSG = "Avoid using ActiveRecord::Migration methods in `up` and `down` methods. \
             Use `change` instead."
 
-          BLACKLISTED_METHODS = %i(
+          BLACKLISTED_METHODS = %i[
             add_column
             add_foreign_key
             add_index
@@ -50,14 +50,14 @@ module RuboCop
             rename_column
             rename_index
             rename_table
-          ).freeze
+          ].freeze
 
           def_node_search :migration_method?, <<~PATTERN
             (send nil? {#{BLACKLISTED_METHODS.map(&:inspect).join(" ")}} ...)
           PATTERN
 
           def on_def(node)
-            return unless %i(up down).include?(node.method_name)
+            return unless %i[up down].include?(node.method_name)
             return unless migration_method?(node)
 
             add_offense(node, message: MSG)

data/lib/rubocop/cop/captive/rails/no_disable_ddl_transaction.rb

@@ -0,0 +1,44 @@
+# lib/rubocop/no_disable_ddl_transaction.rb
+module RuboCop
+  module Cop
+    module Captive
+      module Rails
+        ##
+        # Cette migration utilise `disable_ddl_transaction!`, ce qui peut rendre le comportement de la migration
+        # difficile à prévoir et potentiellement dangereux. Voici pourquoi il est important de l'éviter :
+        #
+        # 1. **Transactions atomiques :** Les migrations sont généralement exécutées dans une transaction afin de garantir
+        #    que toutes les modifications d'une migration réussissent ou échouent ensemble. Cela permet de maintenir la
+        #    cohérence de la base de données.
+        #
+        # 2. **Erreurs de schéma :** En désactivant la transaction, une erreur survenant lors de l'application des modifications
+        #    peut laisser la base de données dans un état intermédiaire, ce qui complique le débogage et le retour en arrière.
+        #
+        # 3. **Verrouillage des tables :** Les opérations DDL sans transaction peuvent provoquer un verrouillage prolongé de
+        #    la base de données, impactant la performance et l'accessibilité des tables pour d'autres requêtes pendant
+        #    l'exécution de la migration.
+        #
+        # 4. **Difficulté de maintenance :** L'absence de transactions peut rendre plus difficile la maintenance de l'application,
+        #    car il devient plus compliqué de conserver un historique clair des modifications apportées au schéma.
+        #
+        # Pour toutes ces raisons, nous devons éviter d'utiliser `disable_ddl_transaction!` afin de garantir une gestion
+        # sécurisée et fiable des migrations.
+        #
+        # @see https://captive-team.atlassian.net/browse/CAE-290?focusedCommentId=24501
+        class NoDisableDdlTransaction < Base
+          MSG = "Avoid using 'disable_ddl_transaction!' in migrations.".freeze
+
+          def_node_matcher :disable_ddl_transaction?, <<~PATTERN
+            (send nil? :disable_ddl_transaction!)
+          PATTERN
+
+          def on_send(node)
+            return unless disable_ddl_transaction?(node)
+
+            add_offense(node)
+          end
+        end
+      end
+    end
+  end
+end

data/rubocop-config-captive.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version = RuboCop::Captive::VERSION
   gem.summary = "Shared rubocop configurations"
   gem.description = "Shared rubocop configuration for Captive projects"
-  gem.authors = ["Captive", "Julien Polo", "Clément Prod'homme"]
-  gem.email = ["julien.polo@captive.fr"]
+  gem.authors = [ "Captive", "Julien Polo", "Clément Prod'homme" ]
+  gem.email = [ "julien.polo@captive.fr" ]
   gem.homepage = "https://github.com/Captive-Studio/rubocop-config"
   gem.license = "MIT"
   gem.required_ruby_version = ">= 2.6"
@@ -21,6 +21,8 @@ Gem::Specification.new do |gem|
     "Gemfile",
   ]
 
+  # Pour mettre à jour les dépendances, vous pouvez utiliser le script :
+  # ruby script/update_dependencies.rb
   gem.add_dependency("rubocop", "~> 1.77.0")
   gem.add_dependency("rubocop-performance", "~> 1.25.0")
   gem.add_dependency("rubocop-rake", "~> 0.7.1")

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-config-captive
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha
+  version: 2.0.1
 platform: ruby
 authors:
 - Captive
 - Julien Polo
 - Clément Prod'homme
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -195,8 +194,10 @@ files:
 - lib/rubocop/captive/version.rb
 - lib/rubocop/cop/captive/active_admin/active_admin_addons_presence.rb
 - lib/rubocop/cop/captive/no_app_env.rb
+- lib/rubocop/cop/captive/rails/after_commit_not_allowed.rb
 - lib/rubocop/cop/captive/rails/force_ssl_enabled_in_production.rb
 - lib/rubocop/cop/captive/rails/migration_methods.rb
+- lib/rubocop/cop/captive/rails/no_disable_ddl_transaction.rb
 - lib/rubocop/cop/captive/rails/no_email_from_controller.rb
 - lib/rubocop/cop/captive/rails/no_find_by_in_scope.rb
 - lib/rubocop/cop/captive/rails/no_float_price_columns.rb
@@ -210,7 +211,6 @@ homepage: https://github.com/Captive-Studio/rubocop-config
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -221,12 +221,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Shared rubocop configurations
 test_files: []