File: element_with_pattern.rb

package info (click to toggle)
gitlab 17.6.5-19
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 629,368 kB
  • sloc: ruby: 1,915,304; javascript: 557,307; sql: 60,639; xml: 6,509; sh: 4,567; makefile: 1,239; python: 406
file content (45 lines) | stat: -rw-r--r-- 1,095 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# frozen_string_literal: true

require_relative '../../qa_helpers'

module RuboCop
  module Cop
    module QA
      # This cop checks for the usage of patterns in QA elements
      #
      # @example
      #
      #   # bad
      #   element :some_element, "link_to 'something'"
      #   element :some_element, /link_to 'something'/
      #
      #   # good
      #   element :some_element
      #   element :some_element, required: true
      class ElementWithPattern < RuboCop::Cop::Base
        include QAHelpers

        MESSAGE = "Don't use a pattern for element, create a corresponding `%s` instead."

        def on_send(node)
          return unless in_qa_file?(node)
          return unless method_name(node).to_s == 'element'

          element_name, *args = node.arguments

          return if args.first.nil?

          args.first.each_node(:str) do |arg|
            add_offense(arg, message: MESSAGE % "data-testid=#{element_name.value}")
          end
        end

        private

        def method_name(node)
          node.children[1]
        end
      end
    end
  end
end