rubocop-config-captive 1.9.7 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec5056c440c47a77d6ebdfd69d963c4772814f674abf69787c86e341924db80e
-  data.tar.gz: 5e9e205eb6474d30048e1bb1b22ff9c9e1a958d3dbeece107c68ff3066eaa4e1
+  metadata.gz: 3d97b68d10ca94ef35962dc273c1157d64839ac6b2fced7c99aed0f07f5eb4a7
+  data.tar.gz: c98e237061db822fc35993bc780260340eb59bcae41b3cd252d04025effa8216
 SHA512:
-  metadata.gz: 3a5092b21d89eb654468c1008dd185ccbba615e9237f1112f6d2689531f6a046ff9791b4845268e67b9ca306d60eac679ca3521cca73c9955cf58ae7a582f525
-  data.tar.gz: c88be3fa86c62a12b903b3d238c69cb1280e17115ed693ef602fac6aa2c79bb1c205fbbab959ef560223cb7b05b89a69dbc0a4de8282c086e9204867d23f5e61
+  metadata.gz: 87ded8aca4ebc42f5eff1ff4bc5aa57c7f3289d02ba1f95c7b08b46f8ecd75927ffe49aa127d3f0066f004f6c5b81969a30f2137960e607c70c7b43230e74b83
+  data.tar.gz: aa6036eeabf88151a60b912c0d805e1bbcedcfb36bf5e80d07c0ad5b4b6e55c98c3fc6fe7427e7ede5939657f5050d0227d5d6ac0698b4c6630118edd9ea38fa

data/README.md

@@ -110,3 +110,18 @@ To contribute, here are some inspirations for good configurations :
 [license-image]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
 <!-- AUTO-GENERATED-CONTENT:END -->
 [license-url]: ./LICENSE
+
+About Captive
+-------------
+
+![captive](https://raw.githubusercontent.com/Captive-Studio/assets/main/logo_captive_blue_avec_fond.webp)
+
+rubocop-config-captive is maintained and funded by Captive.
+The names and logos for captive are trademarks of captive-studio.
+
+We love open source software!
+See [our other projects][community] or
+[hire us][hire] to design, develop, and grow your product.
+
+[community]: https://github.com/Captive-Studio
+[hire]: https://www.captive.fr/contact?utm_source=github

data/config/rubocop-captive.yml

@@ -4,8 +4,9 @@ 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/no_email_from_controller.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_email_from_controller.rb
   - ../lib/rubocop/cop/captive/string_where_in_scope.rb
   - ../lib/rubocop/cop/captive/no_app_env.rb
 
@@ -37,18 +38,24 @@ Captive/RSpec/SpecifyBeforeParameter:
   Include:
     - 'spec/**/*'
 
-# Rails
-Captive/Rails/NoEmailFromController:
-  Description: "Do not send emails from controllers. Because it doesn't follow the MVC standard"
-  Include:
-    - 'app/controllers/**/*'
-
 # Rails
 Captive/Rails/ForceSslEnabledInProduction:
   Description: "Ensures SSL is forced in production, so that secure cookies are used."
   Include:
     - 'config/environments/production.rb'
 
+# Rails
+Captive/Rails/MigrationMethods:
+  Description: "Avoid using ActiveRecord::Migration methods in `up` and `down` methods. Use `change` instead."
+  Include:
+    - 'db/migrate/**/*'
+
+# Rails
+Captive/Rails/NoEmailFromController:
+  Description: "Do not send emails from controllers. Because it doesn't follow the MVC standard"
+  Include:
+    - 'app/controllers/**/*'
+
 # other
 Captive/StringWhereInScope:
   Description: 'The `where` method should be used in a scope in a model.'

data/config/rubocop-magic_numbers.yml

@@ -27,13 +27,7 @@ MagicNumbers/NoAssignment:
     - '**/config/**/*'
 
 MagicNumbers/NoDefault:
-  Enabled: true
-  Exclude:
-    - '**/spec/**/*.rb'
-    - '**/test/**/*.rb'
-    - '**/*_spec.rb'
-    - '**/*_test.rb'
-    - '**/config/**/*'
+  Enabled: false
 
 MagicNumbers/NoReturn:
   Enabled: true

data/config/rubocop-rspec.yml

@@ -13,3 +13,19 @@ RSpec/ScatteredSetup:
 RSpec/RepeatedExample:
   Exclude:
     - 'spec/requests/**/*'
+
+RSpec/ContextWording:
+  Enabled: true
+  Prefixes:
+    - when
+    - with
+    - without
+    - if
+    - unless
+    - for
+    - quand
+    - avec
+    - sans
+    - si
+    - sauf si
+    - pour

data/lib/rubocop/captive/version.rb

@@ -3,6 +3,6 @@
 module RuboCop
   module Captive
     # Version information for the the Airbnb RuboCop plugin.
-    VERSION = "1.9.7"
+    VERSION = "1.11.0"
   end
 end

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

@@ -16,17 +16,15 @@ module RuboCop
           extend AutoCorrector
 
           MSG = "force_ssl should be enabled in production."
+          GOOD_PRACTICE = "ENV[\"SKIP_FORCE_SSL\"].blank?"
 
           def on_send(node)
             if setting_force_ssl_not_true?(node)
               add_offense(node, message: MSG) do |corrector|
-                # Replace with 'true' only if the argument is not already 'true'
-                unless node.arguments.first.true_type?
-                  corrector.replace(
-                    node.arguments.first.source_range,
-                    "true"
-                  )
-                end
+                corrector.replace(
+                  node.arguments.first.source_range,
+                  GOOD_PRACTICE
+                )
               end
             end
           end
@@ -40,14 +38,25 @@ module RuboCop
           private
 
           def setting_force_ssl_not_true?(node)
-            node.method_name == :force_ssl= && !node.arguments.first.true_type?
+            node.method_name == :force_ssl= && node.arguments != [
+              s(
+                :send,
+                s(
+                  :send,
+                  s(:const, nil, :ENV),
+                  :[],
+                  s(:str, "SKIP_FORCE_SSL")
+                ),
+                :blank?
+              ),
+            ]
           end
 
           def check_comment(comment)
             return unless force_ssl_commented?(comment.text)
 
             add_offense(comment.loc.expression, message: MSG) do |corrector|
-              corrector.replace(comment.loc.expression, "config.force_ssl = true")
+              corrector.replace(comment.loc.expression, "config.force_ssl = #{GOOD_PRACTICE}")
             end
           end
 

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Captive
+      module Rails
+        ##
+        # This cop ensures the use `change` method when is possible.
+        #
+        # Il est possible d'utiliser la méthode `change` lors de l'utilisation de méthode de ActiveRecord::Migration tel que : `remove_column`, `add_column`, `add_index`, ...
+        # La méthode gère automatiquement le UP et le DOWN.
+        # Il n'est donc pas nécéssaire définir le `def up` et `def down` seulement lors d'une migration de donnée
+        #
+        # @example
+        #   # bad
+        #   def up
+        #     remove_column :table, :column, :type
+        #   end
+        #
+        #   def down
+        #     add_column :table, :column, :type
+        #   end
+        #
+        #   # good
+        #   def change
+        #     remove_column :table, :column, :type
+        #   end
+        #
+        # @see https://git.captive.fr/captive/iris-galerie/iris-platform/-/merge_requests/676#note_186669
+        class MigrationMethods < Base
+          MSG = "Avoid using ActiveRecord::Migration methods in `up` and `down` methods. \
+            Use `change` instead."
+
+          BLACKLISTED_METHODS = %i(
+            add_column
+            add_foreign_key
+            add_index
+            add_reference
+            add_timestamps
+            change_column
+            change_table
+            create_table
+            create_join_table
+            drop_table
+            remove_column
+            remove_foreign_key
+            remove_index
+            remove_reference
+            remove_timestamps
+            rename_column
+            rename_index
+            rename_table
+          ).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 migration_method?(node)
+
+            add_offense(node, message: MSG)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-config-captive
 version: !ruby/object:Gem::Version
-  version: 1.9.7
+  version: 1.11.0
 platform: ruby
 authors:
 - Captive
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-16 00:00:00.000000000 Z
+date: 2024-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -185,6 +185,7 @@ files:
 - lib/rubocop/cop/captive/active_admin/active_admin_addons_presence.rb
 - lib/rubocop/cop/captive/no_app_env.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_email_from_controller.rb
 - lib/rubocop/cop/captive/rspec/specify_before_parameter.rb
 - lib/rubocop/cop/captive/string_where_in_scope.rb