Class: RuboCop::Cop::Primer::TestSelector

Inherits:
BaseCop
  • Object
show all
Defined in:
lib/rubocop/cop/primer/test_selector.rb

Overview

Prefer the ‘test_selector` argument over manually generating a `data-test-selector` attribute.

Bad:

Primer::BaseComponent.new(data: { “test-selector”: “the-component” })

Good:

Primer::BaseComponent.new(test_selector: “the-component”)

Constant Summary collapse

INVALID_MESSAGE = 
<<~STR
  Prefer the `test_selector` argument over manually generating a `data-test-selector` attribute: https://primer.style/view-components/system-arguments.
STR

Instance Method Summary collapse

Methods inherited from BaseCop

#valid_node?

Instance Method Details

#on_send(node) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/rubocop/cop/primer/test_selector.rb', line 24

def on_send(node)
  return unless valid_node?(node)
  return unless node.arguments?

  kwargs = node.arguments.last
  return unless kwargs.type == :hash

  data_arg = kwargs.pairs.find { |kwarg| kwarg.key.value == :data }
  return if data_arg.nil?
  return unless data_arg.value.type == :hash

  hash = data_arg.child_nodes.find { |arg| arg.type == :hash }
  return unless hash

  test_selector = hash.pairs.find do |pair|
    pair.key.value == :"test-selector" || pair.key.value == "test-selector"
  end
  return unless test_selector

  add_offense(data_arg, message: INVALID_MESSAGE)
end