gl_rubocop 0.5.2 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa594b531f0d00238170541e84317172b54acf43dde2e41eede7ad26f7d20d19
-  data.tar.gz: 6f3a07046f7d082f0bcbfe6f98754350ab5966d10c97de0cbac00ad3e189f955
+  metadata.gz: cbecf0a138a66001d115607b6e635bda71eb4a2637c7eaa86b164807313efc8c
+  data.tar.gz: a40a64ea1547488a822ed7f021c688da5187ec57dde140357d05b3f624c9bbfb
 SHA512:
-  metadata.gz: 6726a89cc1d5de58ecb536f729af9ac08a44735ff91e03cba605e50d59193e773644474da29e0068e4b204e169973d921f7a2f3b85b10c666850c5422f61d685
-  data.tar.gz: d9497503468a4d3ce800156293299f857ec5766bbae85887e20699aa62ed71af7d4a5aded239ca56c49c07cad272b778576086dc505013fe30c1c7941ff6cb17
+  metadata.gz: 25d837867c4e28a5e2e7134db085a93b94392ceb783bd533240c04a9f582adbfc60033edd5fadce6b5bfa5ebf569728fd258b2394a8f4dff6c9128df44fca953
+  data.tar.gz: 6af51558e77b72d5f791f51a5cb87f4a4fa51c953d08b69f9a4c1d87b6724cf5f9601a94e9b8f47f0ee6d06618a53e6c8bb50774cdd5796ddaebc59f98aafe4e

data/default.yml

@@ -12,6 +12,7 @@ require:
   - ./lib/gl_rubocop/gl_cops/consolidate_request_system_specs.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_env.rb
   - ./lib/gl_rubocop/gl_cops/no_stubbing_perform_async.rb
   - ./lib/gl_rubocop/gl_cops/prevent_haml_files.rb
   - ./lib/gl_rubocop/gl_cops/rails_cache.rb
@@ -24,6 +25,9 @@ require:
   - ./lib/gl_rubocop/gl_cops/view_component_class_naming.rb
   - ./lib/gl_rubocop/gl_cops/view_component_inheritance.rb
   - ./lib/gl_rubocop/gl_cops/view_component_directory_structure.rb
+  - ./lib/gl_rubocop/gl_cops/no_hardcoded_strings_in_erb_text_elements.rb
+  - ./lib/gl_rubocop/gl_cops/text_and_content_variable_naming.rb
+  - ./lib/gl_rubocop/gl_cops/no_hardcoded_string_assignment_to_text_or_content_variable.rb
 
 AllCops:
   SuggestExtensions: false
@@ -62,6 +66,21 @@ GLCops/InteractorInheritsFromInteractorBase:
 GLCops/LimitFlashOptions:
   Enabled: true
 
+GLCops/NoHardcodedStringAssignmentToTextOrContentVariable:
+  Enabled: true
+  Include:
+    - "app/components/**/*.rb"
+
+GLCops/NoHardcodedStringsInErbTextElements:
+  Enabled: true
+  Include:
+    - "app/components/**/*.erb"
+
+GLCops/NoStubbingEnv:
+  Enabled: true
+  Include:
+    - "**/*spec.rb"
+
 GLCops/NoStubbingPerformAsync:
   Enabled: true
   Include:
@@ -82,6 +101,11 @@ GLCops/TailwindNoContradictingClassName:
   # Disabling the tailwind no contradicting class name for some fixes
   Enabled: false
 
+GLCops/TextAndContentVariableNaming:
+  Enabled: true
+  Include:
+    - "app/components/**/*.erb"
+
 GLCops/UniqueIdentifier:
   Enabled: true
   Include:

data/lib/gl_rubocop/gl_cops/no_hardcoded_string_assignment_to_text_or_content_variable.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module GLRubocop
+  module GLCops
+    # Ensures that variables and parameters named with _text, text, _content,
+    # or content suffixes are never assigned a hardcoded string literal. Create an
+    # i18n entry and use t() or I18n.t() instead.
+    #
+    # Good:
+    #   title_text = t('components.title')
+    #   @label_text = I18n.t('components.label')
+    #   def initialize(button_text: t('components.button.default'))
+    #   title_text = content_tag(:span, t('components.title'))
+    #   @label_content = tag.p(t('components.label'), class: 'label')
+    #
+    # Bad:
+    #   title_text = 'Hello'
+    #   @label_text = 'Click here'
+    #   def initialize(button_text: 'Submit')
+    class NoHardcodedStringAssignmentToTextOrContentVariable < RuboCop::Cop::Cop
+      MSG = '`%<name>s` must not be assigned a hardcoded string. ' \
+            'Create an i18n entry and use t() instead.'
+
+      def on_lvasgn(node)
+        name, value = node.children
+        return unless text_or_content_name?(name)
+        return unless value&.str_type?
+
+        add_offense(value, message: format(MSG, name:))
+      end
+
+      def on_ivasgn(node)
+        name, value = node.children
+        return unless text_or_content_name?(name.to_s.delete_prefix('@'))
+        return unless value&.str_type?
+
+        add_offense(value, message: format(MSG, name:))
+      end
+
+      def on_kwoptarg(node)
+        name, default = node.children
+        return unless text_or_content_name?(name)
+        return unless default&.str_type?
+
+        add_offense(default, message: format(MSG, name:))
+      end
+
+      private
+
+      def text_or_content_name?(name)
+        n = name.to_s
+        n == 'text' || n == 'content' || n.end_with?('_text', '_content')
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/no_hardcoded_strings_in_erb_text_elements.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/erb_content_helper'
+
+module GLRubocop
+  module GLCops
+    # Ensures that text-containing HTML elements in ERB files do not have
+    # literal text outside of ERB expressions. All visible text must be
+    # wrapped in <%= t() %> or a variable expression.
+    #
+    # Good:
+    #   <p><%= t('components.message') %></p>
+    #   <span><%= @label_text %></span>
+    #   <h1><%= @title_text %></h1>
+    #   <%= content_tag(:p, t('components.message')) %>
+    #
+    # Bad:
+    #   <p>Hello World</p>
+    #   <span>Click here</span>
+    #   <h1>Page Title</h1>
+    class NoHardcodedStringsInErbTextElements < RuboCop::Cop::Cop
+      include GLRubocop::ErbContentHelper
+
+      MSG = 'Hardcoded string in <%<tag>s> on line %<line>d. ' \
+            'Use an i18n expression (t()) or a variable.'
+
+      TEXT_TAGS = %w[
+        a span strong em b i p
+        h1 h2 h3 h4 h5 h6
+        blockquote li td th
+        label button dt dd caption
+      ].freeze
+
+      def investigate(processed_source)
+        return unless erb_file?
+
+        content = read_erb_file
+        return unless content
+
+        find_and_report_hardcoded_strings(content, processed_source)
+      end
+
+      private
+
+      def find_and_report_hardcoded_strings(content, processed_source)
+        TEXT_TAGS.each do |tag|
+          pattern = element_pattern(tag)
+          content.scan(pattern) do |groups|
+            inner = groups[0]
+            next unless hardcoded_text?(inner)
+
+            match_start = Regexp.last_match.begin(0)
+            line_number = content[0...match_start].count("\n") + 1
+            range = processed_source.buffer.source_range
+            add_offense(nil, location: range, message: format(MSG, tag:, line: line_number))
+          end
+        end
+      end
+
+      # Matches <tag ...attrs...>body</tag> where attrs may include ERB expressions.
+      def element_pattern(tag)
+        Regexp.new(
+          "<#{Regexp.escape(tag)}\\b(?:[^>]|<%.*?%>)*>(.*?)<\\/#{Regexp.escape(tag)}>",
+          Regexp::MULTILINE | Regexp::IGNORECASE
+        )
+      end
+
+      def hardcoded_text?(inner_content)
+        # Skip elements that contain child HTML tags — only flag leaf-level text
+        # to avoid duplicate offenses on nested elements.
+        return false if inner_content.match?(/<[a-z]/i)
+
+        stripped = inner_content.gsub(/<%.*?%>/m, '')
+        stripped.match?(/[[:alpha:]]/)
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/no_stubbing_env.rb

@@ -0,0 +1,42 @@
+module GLRubocop
+  module GLCops
+    # This cop ensures that you don't stub ENV with `allow`/`expect` + `receive`.
+    #
+    # Stubbing ENV this way (even with `and_call_original`) only stubs the env vars the
+    # spec explicitly knows about. Any var that is read but not stubbed - for example a
+    # var that is present on CI but not locally, or vice versa - behaves inconsistently
+    # and causes flaky failures.
+    #
+    # Instead, replace ENV wholesale with `stub_const`, building the hash from the real
+    # ENV so unrelated vars keep working everywhere:
+    #
+    # Good:
+    #   stub_const('ENV', ENV.to_hash.except('VAR_TO_UNSET').merge('VAR_TO_SET' => 'value'))
+    #
+    # Bad:
+    #   allow(ENV).to receive(:[]).and_call_original
+    #   allow(ENV).to receive(:[]).with('VAR_TO_SET').and_return('value')
+    #   expect(ENV).to receive(:fetch)
+    class NoStubbingEnv < RuboCop::Cop::Base
+      MSG = "Don't stub ENV with allow/expect + receive. Use " \
+            "stub_const('ENV', ENV.to_hash.except('VAR_TO_UNSET')." \
+            "merge('VAR_TO_SET' => 'value')) instead, so unrelated ENV vars " \
+            '(e.g. on CI) keep working.'.freeze
+
+      # Match `allow(ENV).to receive(...)` / `expect(ENV).not_to receive(...)`, including
+      # chained forms like `.and_call_original`, `.and_return(...)`, `.with(...)`.
+      def_node_matcher :stubbing_env?, <<~PATTERN
+        (send
+          (send nil? {:allow :expect} (const {nil? cbase} :ENV))
+          {:to :not_to :to_not}
+          `(send nil? :receive ...))
+      PATTERN
+
+      def on_send(node)
+        return unless stubbing_env?(node)
+
+        add_offense(node)
+      end
+    end
+  end
+end

data/lib/gl_rubocop/gl_cops/text_and_content_variable_naming.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/erb_content_helper'
+
+module GLRubocop
+  module GLCops
+    # Ensures that simple variable references inside text-containing HTML
+    # elements in ERB files are named with a _text or _content suffix (or
+    # are exactly `text` or `content`). This makes the intent explicit:
+    # _text for plain strings, _content for text-or-HTML values.
+    #
+    # Configuration parameters that are not rendered as user-visible text
+    # (e.g. variant, size, href) belong in non-text elements and are exempt.
+    #
+    # Good:
+    #   <p><%= @message_text %></p>
+    #   <span><%= @banner_content %></span>
+    #   <h1><%= text %></h1>
+    #   <p class="<%= @variant %>"><%= @label_text %></p>   (variant is in attribute, not body)
+    #
+    # Bad:
+    #   <p><%= @message %></p>
+    #   <span><%= @title %></span>
+    class TextAndContentVariableNaming < RuboCop::Cop::Cop
+      include GLRubocop::ErbContentHelper
+
+      MSG = '`%<name>s` (line %<line>d) is rendered inside a text element. ' \
+            'Rename it with a `_text` suffix (plain text) or `_content` suffix (HTML content).'
+
+      TEXT_TAGS = %w[
+        a span strong em b i p
+        h1 h2 h3 h4 h5 h6
+        blockquote li td th
+        label button dt dd caption
+      ].freeze
+
+      # Matches only bare variable/ivar references: <%= @name %> or <%= name %>
+      # Does NOT match method calls with arguments (t('key'), helper.method, etc.)
+      BARE_VAR_PATTERN = /<%=\s*@?(\w+)\s*%>/
+
+      def investigate(processed_source)
+        return unless erb_file?
+
+        content = read_erb_file
+        return unless content
+
+        find_and_report_improperly_named_variables(content, processed_source)
+      end
+
+      private
+
+      def find_and_report_improperly_named_variables(content, processed_source)
+        TEXT_TAGS.each do |tag|
+          pattern = element_pattern(tag)
+          content.scan(pattern) do |groups|
+            body_start = Regexp.last_match.begin(1)
+            check_body_variables(groups[0], body_start, content, processed_source)
+          end
+        end
+      end
+
+      def check_body_variables(body, body_start, content, processed_source)
+        body.scan(BARE_VAR_PATTERN) do |var_match|
+          var_name = var_match[0]
+          next if properly_named?(var_name)
+
+          absolute_offset = body_start + Regexp.last_match.begin(0)
+          line_number = content[0...absolute_offset].count("\n") + 1
+          msg = format(MSG, name: var_name, line: line_number)
+          add_offense(nil, location: processed_source.buffer.source_range, message: msg)
+        end
+      end
+
+      # Matches <tag ...attrs...>body</tag> where attrs may contain ERB expressions.
+      def element_pattern(tag)
+        Regexp.new(
+          "<#{Regexp.escape(tag)}\\b(?:[^>]|<%.*?%>)*>(.*?)<\\/#{Regexp.escape(tag)}>",
+          Regexp::MULTILINE | Regexp::IGNORECASE
+        )
+      end
+
+      def properly_named?(name)
+        name == 'text' || name == 'content' ||
+          name.end_with?('_text', '_content')
+      end
+    end
+  end
+end

data/lib/gl_rubocop/version.rb

@@ -1,3 +1,3 @@
 module GLRubocop
-  VERSION = '0.5.2'.freeze
+  VERSION = '0.5.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gl_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Give Lively
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-06 00:00:00.000000000 Z
+date: 2026-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -166,11 +166,15 @@ files:
 - lib/gl_rubocop/gl_cops/consolidate_request_system_specs.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_hardcoded_string_assignment_to_text_or_content_variable.rb
+- lib/gl_rubocop/gl_cops/no_hardcoded_strings_in_erb_text_elements.rb
+- lib/gl_rubocop/gl_cops/no_stubbing_env.rb
 - lib/gl_rubocop/gl_cops/no_stubbing_perform_async.rb
 - lib/gl_rubocop/gl_cops/prevent_haml_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/tailwind_no_contradicting_class_name.rb
+- lib/gl_rubocop/gl_cops/text_and_content_variable_naming.rb
 - lib/gl_rubocop/gl_cops/unique_identifier.rb
 - lib/gl_rubocop/gl_cops/valid_data_test_id.rb
 - lib/gl_rubocop/gl_cops/vcr_cassette_names.rb
@@ -201,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A shareable configuration of Give Lively's rubocop rules.