# frozen_string_literal: true module Watir module Locators class Element class SelectorBuilder include Exception attr_reader :custom_attributes, :built WILDCARD_ATTRIBUTE = /^(aria|data)_(.+)$/ VALID_WHATS = Hash.new([String, Regexp, TrueClass, FalseClass]).merge(adjacent: [::Symbol], xpath: [String], css: [String], index: [Integer], visible: [TrueClass, FalseClass], tag_name: [String, Regexp, ::Symbol], visible_text: [String, Regexp], scope: [Hash], text: [String, Regexp]).freeze def initialize(valid_attributes, query_scope) @valid_attributes = valid_attributes @custom_attributes = [] @query_scope = query_scope end # rubocop:disable Metrics/PerceivedComplexity: def build(selector) @selector = selector normalize_selector inspected = selector.inspect scope = @query_scope unless @selector.key?(:scope) || @query_scope.is_a?(Watir::Browser) @built = if scope.is_a? Watir::ShadowRoot raise ArgumentError, ':xpath not supported when locating elements from shadow root' if @selector[:xpath] @selector[:css] ||= '*' @selector else wd_locators.empty? ? build_wd_selector(@selector) : @selector end @built.delete(:index) if @built[:index]&.zero? @built[:scope] = scope if scope Watir.logger.info "Converted #{inspected} to #{@built.inspect}" @built end # rubocop:enable Metrics/PerceivedComplexity: def wd_locators Watir::Locators::W3C_FINDERS & @selector.keys end private def normalize_selector # TODO: This can be more specific now that only 2 raise LocatorException, "Can not locate element with #{wd_locators}" if wd_locators.size > 1 @selector[:scope] = @query_scope.selector_builder.built if merge_scope? if @selector.key?(:class) || @selector.key?(:class_name) @selector[:class] = ([@selector[:class]].flatten + [@selector.delete(:class_name)].flatten).compact end if @selector[:adjacent] == :ancestor && @selector.key?(:text) raise LocatorException, 'Can not find parent element with text locator' end @selector.keys.each do |key| check_type(key, @selector[key]) how, what = normalize_locator(key, @selector.delete(key)) @selector[how] = what end end def merge_scope? return false unless ((Watir::Locators::W3C_FINDERS + [:adjacent]) & @selector.keys).empty? return false if [Watir::Browser, Watir::IFrame, Watir::ShadowRoot].any? { |k| @query_scope.is_a?(k) } scope_invalid_locators = @query_scope.selector_builder.built.keys.reject { |key| key == wd_locator } scope_invalid_locators.empty? end def check_type(how, what) if %i[class class_name].include? how [what].flatten.each { |value| raise_unless(value, VALID_WHATS[how]) } else raise_unless(what, VALID_WHATS[how]) end end def should_use_label_element? !valid_attribute?(:label) end def normalize_locator(how, what) case how when :tag_name what = what.to_s if what.is_a?(::Symbol) [how, what] when :text, :xpath, :index, :css, :visible, :visible_text, :adjacent [how, what] when :class what = false if what.tap { |arr| arr.delete('') }.empty? [how, what] when :label, :visible_label if should_use_label_element? ["#{how}_element".to_sym, what] else [how, what] end else check_custom_attribute how [how, what] end end def check_custom_attribute(attribute) return if valid_attribute?(attribute) || attribute.to_s =~ WILDCARD_ATTRIBUTE @custom_attributes << attribute.to_s end # Extensions implement this method when creating a different selector builder def implementation_class Watir.const_get("#{self.class.name}::XPath") end def build_wd_selector(selector) implementation_class.new.build(selector) end def wd_locator implementation_class::LOCATOR end def valid_attribute?(attribute) @valid_attributes&.include?(attribute) end def combine_with_xpath_or_css?(selector) keys = selector.keys keys.reject! { |key| %i[visible visible_text index].include? key } if (keys - [:tag_name]).empty? true else selector[:tag_name] == 'input' && keys == %i[tag_name type] end end def raise_unless(what, types) return if types.include?(what.class) raise TypeError, "expected one of #{types}, got #{what.inspect}:#{what.class}" end end end end end