erblint-github 0.0.3 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46d00ab6d8c5bc82e5ea9e42c316037af0509e6f16a107cfd7762c21bac5c762
-  data.tar.gz: 87f2785cf56cd632f122eb9ddb2e369298902737e281ca75de514fffa45de514
+  metadata.gz: 310138254b0989437e8cf803d52cba66ad005d7cae43b8b6233e638a20e40868
+  data.tar.gz: 654d731eb0c99317883327dd401726582d7df70995350d0006b365fe1b9670b6
 SHA512:
-  metadata.gz: efd49409b7c581f29c45bcc884279bfcff48baefa63ec7e53e028980589b33a87fa655e20a39bb919167cb078e27a6e07ab3c7f4323eec7b02f6d258e1a7f489
-  data.tar.gz: 24a5f6882e6795950545a47fb87c6e8950fc588976ffaa2c7135f9b363a642743f45ebc2e37ff9748360292249b5e36003c89dc8ec3adc6c77499ea12bc9336e
+  metadata.gz: ce1a90a1c2482b29b406787a1c530614718242de1b9fac828617c2f476db00578872bcddf52037bf8195c71beb8750916e853b5127f4de036aea5771a8edbe2b
+  data.tar.gz: 2a1e8844fdae5d352a6798937629e4ae70bea7d3a16c00e1a6de363dcc805044164b55e5166d9ffaf6f288bbdb135c373c2f1b1b40d27ecb0705c2cb616a833c

data/README.md

@@ -25,20 +25,30 @@ require "erblint-github/linters"
 linters:
   GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled:
     enabled: true
+  GitHub::Accessibility::IframeHasTitle:
+    enabled: true
   GitHub::Accessibility::ImageHasAlt:
     enabled: true
-  GitHub::Accessibility::NoAriaLabelMisuse:
+  GitHub::Accessibility::NoAriaLabelMisuseCounter:
+    enabled: true
+  GitHub::Accessibility::NoPositiveTabIndex:
     enabled: true
   GitHub::Accessibility::NoRedundantImageAlt:
     enabled: true
+  GitHub::Accessibility::NoTitleAttributeCounter:
+    enabled: true
 ```
 
 ## Rules
 
 - [GitHub::Accessibility::AvoidBothDisabledAndAriaDisabled](./docs/rules/accessibility/avoid-both-disabled-and-aria-disabled.md)
+- [GitHub::Accessibility::AvoidGenericLinkTextCounter](./docs/rules/accessibility/avoid-generic-link-text-counter.md)
+- [GitHub::Accessibility::IframeHasTitle](./docs/rules/accessibility/iframe-has-title.md)
 - [GitHub::Accessibility::ImageHasAlt](./docs/rules/accessibility/image-has-alt.md)
-- [GitHub::Accessibility::NoAriaLabelMisuse](./docs/rules/accessibility/no-aria-label-misuse.md)
+- [GitHub::Accessibility::NoAriaLabelMisuseCounter](./docs/rules/accessibility/no-aria-label-misuse-counter.md)
+- [GitHub::Accessibility::NoPositiveTabIndex](./docs/rules/accessibility/no-positive-tab-index.md)
 - [GitHub::Accessibility::NoRedundantImageAlt](./docs/rules/accessibility/no-redundant-image-alt.md)
+- [GitHub::Accessibility::NoTitleAttributeCounter](./docs/rules/accessibility/no-title-attribute-counter.md)
 
 ## Testing
 

data/lib/erblint-github/linters/custom_helpers.rb

@@ -24,6 +24,39 @@ module ERBLint
         end
       end
 
+      def counter_correct?(processed_source)
+        comment_node = nil
+        expected_count = 0
+        rule_name = simple_class_name
+        offenses_count = @offenses.length
+
+        processed_source.parser.ast.descendants(:erb).each do |node|
+          indicator_node, _, code_node, = *node
+          indicator = indicator_node&.loc&.source
+          comment = code_node&.loc&.source&.strip
+
+          if indicator == "#" && comment.start_with?("erblint:counter") && comment.match(rule_name)
+            comment_node = node
+            expected_count = comment.match(/\s(\d+)\s?$/)[1].to_i
+          end
+        end
+
+        if offenses_count.zero?
+          # have to adjust to get `\n` so we delete the whole line
+          add_offense(processed_source.to_source_range(comment_node.loc.adjust(end_pos: 1)), "Unused erblint:counter comment for #{rule_name}", "") if comment_node
+          return
+        end
+
+        first_offense = @offenses[0]
+
+        if comment_node.nil?
+          add_offense(processed_source.to_source_range(first_offense.source_range), "#{rule_name}: If you must, add <%# erblint:counter #{rule_name} #{offenses_count} %> to bypass this check.", "<%# erblint:counter #{rule_name} #{offenses_count} %>")
+        else
+          clear_offenses
+          add_offense(processed_source.to_source_range(comment_node.loc), "Incorrect erblint:counter number for #{rule_name}. Expected: #{expected_count}, actual: #{offenses_count}.", "<%# erblint:counter #{rule_name} #{offenses_count} %>") if expected_count != offenses_count
+        end
+      end
+
       def generate_offense(klass, processed_source, tag, message = nil, replacement = nil)
         message ||= klass::MESSAGE
         message += "\nLearn more at https://github.com/github/erblint-github#rules.\n"
@@ -31,6 +64,13 @@ module ERBLint
         add_offense(processed_source.to_source_range(tag.loc), offense, replacement)
       end
 
+      def generate_offense_from_source_range(klass, source_range, message = nil, replacement = nil)
+        message ||= klass::MESSAGE
+        message += "\nLearn more at https://github.com/github/erblint-github#rules.\n"
+        offense = ["#{simple_class_name}:#{message}", source_range.source].join("\n")
+        add_offense(source_range, offense, replacement)
+      end
+
       def possible_attribute_values(tag, attr_name)
         value = tag.attributes[attr_name]&.value || nil
         basic_conditional_code_check(value || "") || [value].compact

data/lib/erblint-github/linters/github/accessibility/avoid_generic_link_text_counter.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class AvoidGenericLinkTextCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          BANNED_GENERIC_TEXT = [
+            "Read more",
+            "Learn more",
+            "Click here",
+            "More",
+            "Link",
+            "Here"
+          ].freeze
+          MESSAGE = "Avoid using generic link text such as #{BANNED_GENERIC_TEXT.join(', ')} which do not make sense in isolation."
+
+          def run(processed_source)
+            processed_source.ast.children.each_with_index do |node, index|
+              next unless node.methods.include?(:type) && node.type == :text
+
+              text = node.children.join.strip
+              # Checks HTML tags
+              if banned_text?(text)
+                prev_node = processed_source.ast.children[index - 1]
+                next_node = processed_source.ast.children[index + 1]
+
+                next unless tag_type?(prev_node) && tag_type?(next_node)
+
+                text_node_tag = BetterHtml::Tree::Tag.from_node(node)
+                prev_node_tag = BetterHtml::Tree::Tag.from_node(prev_node)
+                next_node_tag = BetterHtml::Tree::Tag.from_node(next_node)
+
+                # We only report if the text is nested between two link tags.
+                if link_tag?(prev_node_tag) && link_tag?(next_node_tag) && next_node_tag.closing?
+                  range = prev_node_tag.loc.begin_pos...text_node_tag.loc.end_pos
+                  source_range = processed_source.to_source_range(range)
+                  generate_offense_from_source_range(self.class, source_range)
+                end
+              end
+
+              # Checks Rails link helpers like `link_to`
+              erb_node = node.type == :erb ? node : node.descendants(:erb).first
+              next unless erb_node
+
+              _, _, code_node = *erb_node
+              source = code_node.loc.source
+              ruby_node = extract_ruby_node(source)
+              send_node = ruby_node&.descendants(:send)&.first
+              next unless send_node.methods.include?(:method_name) && send_node.method_name == :link_to
+
+              send_node.child_nodes.each do |child_node|
+                if child_node.methods.include?(:type) && child_node.type == :str && banned_text?(child_node.children.join)
+                  tag = BetterHtml::Tree::Tag.from_node(code_node)
+                  generate_offense(self.class, processed_source, tag)
+                  end
+              end
+            end
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
+          end
+
+          private
+
+          def banned_text?(text)
+            BANNED_GENERIC_TEXT.map(&:downcase).include?(text.downcase)
+          end
+
+          def extract_ruby_node(source)
+            BetterHtml::TestHelper::RubyNode.parse(source)
+          rescue ::Parser::SyntaxError
+            nil
+          end
+
+          def link_tag?(tag_node)
+            tag_node.name == "a"
+          end
+
+          def tag_type?(node)
+            node.methods.include?(:type) && node.type == :tag
+          end
+        end
+      end
+    end
+  end
+end

data/lib/erblint-github/linters/github/accessibility/iframe_has_title.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class IframeHasTitle < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          MESSAGE = "`<iframe>` with meaningful content should have a title attribute that identifies the content."\
+                    " If `<iframe>` has no meaningful content, hide it from assistive technology with `aria-hidden='true'`."\
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.name != "iframe"
+              next if tag.closing?
+
+              title = possible_attribute_values(tag, "title")
+
+              generate_offense(self.class, processed_source, tag) if title.empty? && !aria_hidden?(tag)
+            end
+
+            rule_disabled?(processed_source)
+          end
+
+          private
+
+          def aria_hidden?(tag)
+            tag.attributes["aria-hidden"]&.value&.present?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/erblint-github/linters/github/accessibility/{no_aria_label_misuse.rb → no_aria_label_misuse_counter.rb}

@@ -6,7 +6,7 @@ module ERBLint
   module Linters
     module GitHub
       module Accessibility
-        class NoAriaLabelMisuse < Linter
+        class NoAriaLabelMisuseCounter < Linter
           include ERBLint::Linters::CustomHelpers
           include LinterRegistry
 
@@ -34,7 +34,21 @@ module ERBLint
                 end
               end
             end
-            rule_disabled?(processed_source)
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
           end
         end
       end

data/lib/erblint-github/linters/github/accessibility/no_positive_tab_index.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class NoPositiveTabIndex < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          MESSAGE = "Do not use positive tabindex as it is error prone and can severely disrupt navigation experience for keyboard users"
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.closing?
+              next unless tag.attributes["tabindex"]&.value.to_i.positive?
+
+              generate_offense(self.class, processed_source, tag)
+            end
+
+            rule_disabled?(processed_source)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/erblint-github/linters/github/accessibility/no_title_attribute_counter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "../../custom_helpers"
+
+module ERBLint
+  module Linters
+    module GitHub
+      module Accessibility
+        class NoTitleAttributeCounter < Linter
+          include ERBLint::Linters::CustomHelpers
+          include LinterRegistry
+
+          MESSAGE = "The title attribute should never be used unless for an `<iframe>` as it is inaccessible for several groups of users."
+
+          def run(processed_source)
+            tags(processed_source).each do |tag|
+              next if tag.name == "iframe"
+              next if tag.closing?
+
+              title = possible_attribute_values(tag, "title")
+              generate_offense(self.class, processed_source, tag) if title.present?
+            end
+
+            counter_correct?(processed_source)
+          end
+
+          def autocorrect(processed_source, offense)
+            return unless offense.context
+
+            lambda do |corrector|
+              if processed_source.file_content.include?("erblint:counter #{simple_class_name}")
+                # update the counter if exists
+                corrector.replace(offense.source_range, offense.context)
+              else
+                # add comment with counter if none
+                corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tasks/docs.rake

@@ -4,10 +4,9 @@ namespace :docs do
   task :coverage do
     require "erb_lint/all"
     require "erblint-github/linters"
-
-    Dir[File.join(__dir__, "linters", "github/**/*.rb")].sort.each do |file|
+    Dir[File.join("lib", "erblint-github", "linters", "github/**/*.rb")].sort.each do |file|
       rule_documentation_path = file
-                                .gsub("#{__dir__}linters/github/", "docs/rules/")
+                                .gsub("lib/erblint-github/linters/github/", "docs/rules/")
                                 .gsub(".rb", ".md")
                                 .tr("_", "-")
       raise "Missing rule documentation. Please document rule in #{rule_documentation_path}" unless File.file?(rule_documentation_path.to_s)

data/lib/tasks/tests.rake

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+namespace :tests do
+  task :coverage do
+    require "erb_lint/all"
+    require "erblint-github/linters"
+
+    Dir[File.join("lib", "erblint-github", "linters", "github/**/*.rb")].sort.each do |file|
+      test_path = file.gsub("lib/erblint-github/linters/github/", "test/linters/").gsub(".rb", "_test.rb")
+      raise "Missing test. Please add test in #{test_path}" unless File.file?(test_path.to_s)
+    end
+    puts "All rules have test coverage."
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erblint-github
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2022-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erb_lint
@@ -16,84 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.15'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.30.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.13.0
+        version: 1.30.0
 - !ruby/object:Gem::Dependency
   name: rubocop-github
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.17.0
 description: Template style checking for GitHub Ruby repositories
 email:
 - opensource+erblint-github@github.com
@@ -106,14 +106,20 @@ files:
 - lib/erblint-github/linters.rb
 - lib/erblint-github/linters/custom_helpers.rb
 - lib/erblint-github/linters/github/accessibility/avoid_both_disabled_and_aria_disabled.rb
+- lib/erblint-github/linters/github/accessibility/avoid_generic_link_text_counter.rb
+- lib/erblint-github/linters/github/accessibility/iframe_has_title.rb
 - lib/erblint-github/linters/github/accessibility/image_has_alt.rb
-- lib/erblint-github/linters/github/accessibility/no_aria_label_misuse.rb
+- lib/erblint-github/linters/github/accessibility/no_aria_label_misuse_counter.rb
+- lib/erblint-github/linters/github/accessibility/no_positive_tab_index.rb
 - lib/erblint-github/linters/github/accessibility/no_redundant_image_alt.rb
+- lib/erblint-github/linters/github/accessibility/no_title_attribute_counter.rb
 - lib/tasks/docs.rake
+- lib/tasks/tests.rake
 homepage: https://github.com/github/erblint-github
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -122,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="