gl_rubocop 0.2.14 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4ff64d4fe8319c6a27df33579794a878e3abcfd76af266befae6a7df22aea31
-  data.tar.gz: 6817379d374994edd63c8df2dc5410b923ca67b30dc29e95a36f52ef5be9883e
+  metadata.gz: 506bb7fe1d711020cc9b6875c92fa3171f8efb90e035eb5955039eb51d7a0937
+  data.tar.gz: 7a88ba78b296bca4bd143f18c91bc6ba73c34f5a9a32f8b16c92067db5716d71
 SHA512:
-  metadata.gz: de6a83b5ffb2b2e2e5a36855b239211b8f3d78d5e1357772273767fab853eff71743466157d64422d139e161915379986d079caec6db2c26b321bed90c32a9ab
-  data.tar.gz: 8905a71df576ee38712fed81329d91ccfd0f4e0071f20840ce1f33bc74f09919745fb57bcc6a27213fa8796a9d08f99bae4ad5270fc98c934efbd5570460d2a4
+  metadata.gz: 335abd0579fdf6a7db7f34e3c26c8ec550b86d18cf6dfc9a417fa5cfb7072f6bf10eacc941f406225eaa34cdd2a4685e2a6defe24abb3b8cbc85aa30a3504028
+  data.tar.gz: 7f8ea4867d5e773eb4c38517a21379e63862fc2e394791f1a2c9c083fac77a678e56416d302aae20dc2ce3087592f2658e1d22fec0fbc748876ffc6f09905953

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
 

data/lib/gl_rubocop/gl_cops/limit_flash_options.rb

@@ -0,0 +1,80 @@
+# 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")
+      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: "'#{key}' is not one of the permitted flash keys: #{ALLOWED_FLASH_KEYS}"
+        )
+      end
+    end
+  end
+end

data/lib/gl_rubocop/version.rb

@@ -1,3 +1,3 @@
 module GLRubocop
-  VERSION = '0.2.14'.freeze
+  VERSION = '0.2.16'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.2.14
+  version: 0.2.16
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-04 00:00:00.000000000 Z
+date: 2025-08-18 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