gl_rubocop 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a173779cd13f263e06b1335bc3d616fff54ba25d1d36df283bc5e1f1bf0f40ad
-  data.tar.gz: 7404b7c467ea8781b216155568f6f6d7e777428475866cbbf2f581e51918f6d3
+  metadata.gz: 20051ad7be570098d65231ae0699f2a8e0388ac1d46e635c2b967b04d4490278
+  data.tar.gz: 92d0f9a01f967880e8db09a2715adad74144071489e3a39e0b05fd260dd54f33
 SHA512:
-  metadata.gz: 711216513be498b83798ff8fb78f7e3b02ffe52496bb51ecd719ad2e9cb6f4ea0966aae586d28157b4abb7c51f410eccd56c024cd38225612b61e5b807f610e1
-  data.tar.gz: 24f7d44b9036db679ec633999cb686d48519e2ec7e220b3ce559b79e8ea95e1f3cd597ccee85ed87e04f1fd4319c794485e06d9a590dcac51f44cb1e746a6f68
+  metadata.gz: 0ad7a44349b6182c777f3277b84458624ed4010c6e8d5effc08461779262dc021081a83b2dbe1c0a325f86292b621ac2f73181c06ee24cda60b69a5ecd79f0eb
+  data.tar.gz: 17b072554bdbcb5df215abe5dd0c01c7d64324a0db62fdd555c8e931b16fbaa259d97a1a1028581fc3340b27e6e4bfb93963581c7414f5300d322a577d826ccd

data/default.yml

@@ -3,10 +3,13 @@ require:
   - rubocop-rails
   - rubocop-rspec
   - rubocop-magic_numbers
+  - rubocop-haml
   - ./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/sidekiq_inherits_from_sidekiq_job.rb
+  - ./lib/gl_rubocop/gl_cops/unique_identifier.rb
+
 
 AllCops:
   SuggestExtensions: false
@@ -39,6 +42,11 @@ GLCops/SidekiqInheritsFromSidekiqJob:
     - 'app/**/*_worker.rb'
     - 'app/**/*_job.rb'
 
+GLCops/UniqueIdentifier:
+  Enabled: true
+  Include:
+    - 'app/components/**/*.haml'
+
 Layout/LineLength:
   Max: 100
   AllowedPatterns:

data/gl_rubocop.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rubocop', '~> 1.62.0'
+  spec.add_dependency 'rubocop-haml', '~> 0.2.4'
   spec.add_dependency 'rubocop-magic_numbers'
   spec.add_dependency 'rubocop-performance'
   spec.add_dependency 'rubocop-rails'

data/lib/gl_rubocop/gl_cops/unique_identifier.rb

@@ -0,0 +1,62 @@
+module GLRubocop
+  module GLCops
+    class UniqueIdentifier < RuboCop::Cop::Base
+      # 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"}
+      #
+      # Bad:
+      #   {data: {testId: "unique-id"}}
+      #   {data: {test: {id: "unique-id"}}
+
+      MSG = 'View components must include a data-test-id attribute'.freeze
+      EMPTY_MSG = 'data-test-id attribute must not be empty'.freeze
+      UNIQUE_IDENTIFIER = 'data-test-id'.freeze
+
+      def on_send(node)
+        return unless file_exists? && valid_method_name?(node)
+
+        return add_offense(node) unless raw_content.include?(UNIQUE_IDENTIFIER)
+
+        add_offense(node, message: EMPTY_MSG) if test_id_value.strip.empty?
+      end
+
+      private
+
+      def file_exists?
+        File.exist?(processed_source.file_path)
+      end
+
+      def identifiable_line
+        line_number = raw_content.lines.find_index { |line| line.include?(UNIQUE_IDENTIFIER) }
+        raw_content.lines[line_number]
+      end
+
+      def raw_content
+        @raw_content ||= File.read(processed_source.file_path)
+      end
+
+      def regex_for_indentifier_and_value
+        key = Regexp.quote(UNIQUE_IDENTIFIER)
+        /(?:#{key}|["']#{key}["']):\s*(["']([^"']*)["']|@\w+)/
+      end
+
+      def test_id_value
+        match = identifiable_line.match(regex_for_indentifier_and_value)
+
+        return '' unless match
+
+        value = match[1]
+        value.start_with?('"', "'") ? value[1..-2] : value
+      end
+
+      def valid_method_name?(node)
+        node.method_name == :render || node.method_name == :template
+      end
+    end
+  end
+end

data/lib/gl_rubocop/version.rb

@@ -1,3 +1,3 @@
 module GLRubocop
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 2025-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.62.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: rubocop-magic_numbers
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +124,7 @@ files:
 - 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/sidekiq_inherits_from_sidekiq_job.rb
+- lib/gl_rubocop/gl_cops/unique_identifier.rb
 - lib/gl_rubocop/version.rb
 homepage: https://github.com/givelively/gl_rubocop
 licenses: