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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c99695fc1dc46fea45cd66954df04ddd6e2ea13f28f53a933f961a026bf95df
-  data.tar.gz: da9335228acf9cb78300f709a1b57eb69466cb5ded705e29e8c21be2abee14c3
+  metadata.gz: 025aa502d3ae6f6bf653e87ae00bdc61386dc3497706c87c2f6a30f3fb46e0e1
+  data.tar.gz: 498f927eb7dd914eb6416401cb06cd7ecc53d5fc839479e152a6bc978e9eb332
 SHA512:
-  metadata.gz: cff9f4fa93b83242395217b1ceede3900fe0c6f961a6b4a7ee9b25da58039d5802674517b384d7c52975ab9c3b53b6b72da20d00228ed66e27f2aced86e04213
-  data.tar.gz: 90243990c19ed762be59170645fcc8b32b7714cac8eef762d2c3093faf46439d3df238768d114edc57ab864e92afa39fcb5d5c5e425f2acdc84382c902b9eeb9
+  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/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/lib/rubocop/captive/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Captive
-    VERSION = "2.0.0-alpha.1"
+    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/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

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-config-captive
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha.1
+  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: []