gl_rubocop 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cf48112bc9eafd596804f516e47f35112f8fe783c89824927baabe203358c36
-  data.tar.gz: 1f5b3d7bbdb11915a6afd5aaeca0bed5ea6432d8670161d7e8ff562aa563d1a4
+  metadata.gz: cc932e911296ebd58c3e59febe32b734287f3ac302762c807c7f2cf58cc1c3ea
+  data.tar.gz: 9e9a20252ffcf744d7c8faf367f53f355e07dfcd9d8cb20f29a7d28401c5fd42
 SHA512:
-  metadata.gz: fccd43ad5c6c29f83384b87c1b0bf2b01872ec0a5d311bb30954a4cfa9724f71cd8a96a9efeee76fb807f37f9e08b4db8f066f2c57fed60f5ce6065a9b96bf9a
-  data.tar.gz: 991618a3e4e97f685a4886ad2f392b813637dc7af86ac8332da4aab6dddd2751ca5648e447c3d96c8434a45fec3126b39a58712f351aad7321e6727d334593c4
+  metadata.gz: c1f6f481ca4275167ba6c630eaf558a83bd29cac26f6a777c8354dd0dff798c792f86eaded520dab8df616294cb6c0941477a2343abc4a13bdfa548bb021e7b7
+  data.tar.gz: 3ef8ba758032a3623ebfe92fbc3cef16b4736b78e0875051ef1f158131f78bbf5b1cb8933ea12c78d4beb103c86d525e3f4ddd607e19d03cc69ea3bc331290d9

data/default.yml

@@ -7,6 +7,7 @@ require:
   - ./lib/gl_rubocop/gl_cops/interactor_inherits_from_interactor_base.rb
   - ./lib/gl_rubocop/gl_cops/callback_method_names.rb
   - ./lib/gl_rubocop/gl_cops/prevent_erb_files.rb
+  - ./lib/gl_rubocop/gl_cops/rails_cache.rb
   - ./lib/gl_rubocop/gl_cops/sidekiq_inherits_from_sidekiq_job.rb
   - ./lib/gl_rubocop/gl_cops/unique_identifier.rb
 
@@ -37,6 +38,9 @@ GLCops/CallbackMethodNames:
 GLCops/PreventErbFiles:
   Enabled: true
 
+GLCops/RailsCache:
+  Enabled: true
+
 GLCops/SidekiqInheritsFromSidekiqJob:
   Include:
     - 'app/**/*_worker.rb'

data/lib/gl_rubocop/gl_cops/rails_cache.rb

@@ -0,0 +1,24 @@
+module GLRubocop
+  module GLCops
+    class RailsCache < RuboCop::Cop::Base
+      #  This cop ensures that Rails.cache is not directly used.
+      #  This is to prevent generation of unique key ids (SIG Code Quality Discussion 2024-12-16):
+      #  https://www.notion.so/givelively/2024-12-16-152eb3d1736e805abe85de1fd96f3599?pvs=4#15eeb3d1736e80ecb82defd5d6b1f0e5
+
+      MSG = 'Rails.cache should not be used directly'.freeze
+
+      def_node_matcher :using_rails_cache?, <<~PATTERN
+        (send#{' '}
+          (send (const nil? :Rails) :cache)
+          {:fetch :read :write :delete :exist? :clear}
+          ...)
+      PATTERN
+
+      def on_send(node)
+        return unless using_rails_cache?(node)
+
+        add_offense(node)
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/unique_identifier.rb

@@ -4,12 +4,10 @@ module GLRubocop
       # This cop ensures that view components include a data-test-id attribute.
       #
       # Good:
-      #   {data-test-id: 'unique-id'}
+      #   {data-test-id: "unique-id"}
       #   {data-test-id: @unique_id }
-      #   {'data-test-id': 'unique-id'}
+      #   {'data-test-id': "unique-id"}
       #   {"data-test-id": "unique-id"}
-      #   {data: {test-id: 'unique-id'}}
-      #   {data: {'test-id': 'unique-id'}}
       #
       # Bad:
       #   {data: {testId: "unique-id"}}
@@ -17,7 +15,7 @@ module GLRubocop
 
       MSG = 'View components must include a data-test-id attribute'.freeze
       EMPTY_MSG = 'data-test-id attribute must not be empty'.freeze
-      UNIQUE_IDENTIFIER = 'test-id'.freeze
+      UNIQUE_IDENTIFIER = 'data-test-id'.freeze
 
       def on_send(node)
         return unless file_exists? && valid_method_name?(node)
@@ -44,7 +42,7 @@ module GLRubocop
 
       def regex_for_indentifier_and_value
         key = Regexp.quote(UNIQUE_IDENTIFIER)
-        /(?:["']?data-#{key}["']?|data:.?\{["']?#{key}["']?):\s*(["']([^"']*)["']|@\w+)/
+        /(?:#{key}|["']#{key}["']):\s*(["']([^"']*)["']|@\w+)/
       end
 
       def test_id_value

data/lib/gl_rubocop/version.rb

@@ -1,3 +1,3 @@
 module GLRubocop
-  VERSION = '0.2.5'.freeze
+  VERSION = '0.2.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -123,6 +123,7 @@ files:
 - 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/prevent_erb_files.rb
+- lib/gl_rubocop/gl_cops/rails_cache.rb
 - lib/gl_rubocop/gl_cops/sidekiq_inherits_from_sidekiq_job.rb
 - lib/gl_rubocop/gl_cops/unique_identifier.rb
 - lib/gl_rubocop/version.rb