gl_rubocop 0.2.13 → 0.2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b577c0d013512c5d8ba1aceb36e2fd627b253c81712043fc34fc0ceead445fe2
-  data.tar.gz: 58eb42711279ba3c0f36f9809e57fcd1ed9d178cf764c8f1367d4f74c486f80b
+  metadata.gz: b30fd98a7f750b5929387d4b241f9c3105cfce56b9e6f9de1f51668c3c8a094c
+  data.tar.gz: ca04a1801385c3967576191fd524a39a45155028c0cc54bac6221f6b607fe691
 SHA512:
-  metadata.gz: 400902b6f175f59a4fb56a18edf45a6d216787221d6355d3d054cb1b96694607be98d8b5a522964b4e816358b819532e6735bf76c47d2aeeb517ec251f7d0dfc
-  data.tar.gz: 593697de8795b407b31c5789db03ceee26b8bf7de461f3e9db6e09b6101f4880bd0f9ea882cf9fb861aa34c61e19e67b643fcfccdd4971e84e94febd3ccd8bc7
+  metadata.gz: b5a4b2c4768adf655531073ad7dd87477f3c1b005c8728cf9690526fd9d8b3fae766a6ce0166a2343dfe1e80026bc3316bd32e9fa39ce738d8ba91780f533b23
+  data.tar.gz: 92b84460fed08c5a9337b6b551f37068b1fdd411a0e9281ed99c362f96e80a5305a5187038eaef5af5b713ce3894d027219381654bf2b44522bcf3ed9a42c211

data/default.yml

@@ -8,6 +8,7 @@ require:
   - rubocop-sorbet
   - ./lib/gl_rubocop/gl_cops/callback_method_names.rb
   - ./lib/gl_rubocop/gl_cops/interactor_inherits_from_interactor_base.rb
+  - ./lib/gl_rubocop/gl_cops/limit_flash_options.rb
   - ./lib/gl_rubocop/gl_cops/no_stubbing_perform_async.rb
   - ./lib/gl_rubocop/gl_cops/prevent_erb_files.rb
   - ./lib/gl_rubocop/gl_cops/rails_cache.rb
@@ -43,6 +44,9 @@ GLCops/InteractorInheritsFromInteractorBase:
   Include:
     - "app/interactors/**/*"
 
+GLCops/LimitFlashOptions:
+  Enabled: true
+
 GLCops/NoStubbingPerformAsync:
   Enabled: true
 
@@ -68,6 +72,7 @@ Layout/ClassStructure:
 Layout/LineLength:
   AllowedPatterns:
     - "^ *#" # Ignores full lines starting with any indentation and a comment (#)
+    - "^\\s*['\"].*['\"]\\s*$" # ignores lines that are string literals
   Max: 100
 
 Lint/MissingSuper:

data/lib/gl_rubocop/gl_cops/limit_flash_options.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module GLRubocop
+  module GLCops
+    class LimitFlashOptions < RuboCop::Cop::Base
+      # This cop ensures that the use of any of our notification methods only accept the allowed keys for type
+      # and variant.
+      # Good:
+      #   flash[:success] = "Operation successful"
+      #   flash.now[:info] = "This is an info message"
+      #   Alert::Component.new(type: :success, message: "Success")
+      #   Notifications::Dismissible::Component.new(variant: :info, message: "Info")
+
+      # Bad:
+      #   flash[:error] = "Not allowed"
+      #   flash.now[:anything_else] = "Not allowed"
+      #   Alert::Component.new(type: :notice, message: "Error")
+      #   Notifications::Dismissible::Component.new(variant: :blue_box, message: "Error")
+
+      MSG = 'This cop checks for the use of flash options not in the allowlist. ' \
+            'Please limit flash options to those defined in the application configuration.'
+
+      ALLOWED_FLASH_KEYS = %i[success info warning danger].freeze
+
+      # Matches the Rails flash hash assignment
+      def_node_matcher :rails_flash?, <<~PATTERN
+        {
+          (send
+            (send nil? :flash) :[]=
+            (sym $_)
+            _*
+          )
+          (send
+            (send
+              (send nil? :flash) :now) :[]=
+              (sym $_)
+              _*
+            )
+        }
+      PATTERN
+
+      def_node_matcher :alert_component_new?, <<~PATTERN
+        (send
+          (const
+            (const nil? :Alert) :Component) :new
+          (hash
+            (pair (sym :type) (sym $_)) _*
+          )
+        )
+      PATTERN
+
+      def_node_matcher :notifications_dismissible_component_new?, <<~PATTERN
+        (send
+          (const
+            (const
+              (const nil? :Notifications) :Dismissible
+            ) :Component
+          ) :new
+          (hash
+            (pair (sym :variant) (sym $_))
+            (...)
+          )
+        )
+      PATTERN
+
+      # Checks for usage of flash or flash.now with keys not in the allowlist
+      def on_send(node)
+        check_key(node, rails_flash?(node))
+        check_key(node, alert_component_new?(node))
+        check_key(node, notifications_dismissible_component_new?(node))
+      end
+
+      def check_key(node, key)
+        return false unless key
+        return false if ALLOWED_FLASH_KEYS.include?(key)
+
+        add_offense(node, message: MSG)
+      end
+    end
+  end
+end

data/lib/gl_rubocop/version.rb

@@ -1,3 +1,3 @@
 module GLRubocop
-  VERSION = '0.2.13'.freeze
+  VERSION = '0.2.15'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.2.13
+  version: 0.2.15
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-24 00:00:00.000000000 Z
+date: 2025-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -136,6 +136,7 @@ files:
 - lib/gl_rubocop.rb
 - lib/gl_rubocop/gl_cops/callback_method_names.rb
 - lib/gl_rubocop/gl_cops/interactor_inherits_from_interactor_base.rb
+- lib/gl_rubocop/gl_cops/limit_flash_options.rb
 - lib/gl_rubocop/gl_cops/no_stubbing_perform_async.rb
 - lib/gl_rubocop/gl_cops/prevent_erb_files.rb
 - lib/gl_rubocop/gl_cops/rails_cache.rb