Class: ERBLint::Linters::GitHub::Accessibility::AvoidGenericLinkTextCounter

Inherits:
Linter
  • Object
show all
Includes:
CustomHelpers, LinterRegistry
Defined in:
lib/erblint-github/linters/github/accessibility/avoid_generic_link_text_counter.rb

Constant Summary collapse

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."

Instance Method Summary collapse

Methods included from CustomHelpers

#basic_conditional_code_check, #counter_correct?, #generate_offense, #generate_offense_from_source_range, #possible_attribute_values, #rule_disabled?, #simple_class_name, #tags

Instance Method Details

#autocorrect(processed_source, offense) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/erblint-github/linters/github/accessibility/avoid_generic_link_text_counter.rb', line 67

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

#run(processed_source) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/erblint-github/linters/github/accessibility/avoid_generic_link_text_counter.rb', line 23

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