class Capybara::Query

Constants

VALID_KEYS
VALID_MATCH

Attributes

expression[RW]
find[RW]
locator[RW]
negative[RW]
options[RW]
selector[RW]

Public Class Methods

new(*args) click to toggle source
# File lib/capybara/query.rb, line 8
def initialize(*args)
  @options = if args.last.is_a?(Hash) then args.pop.dup else {} end

  if args[0].is_a?(Symbol)
    @selector = Selector.all[args[0]]
    @locator = args[1]
  else
    @selector = Selector.all.values.find { |s| s.match?(args[0]) }
    @locator = args[0]
  end
  @selector ||= Selector.all[Capybara.default_selector]

  # for compatibility with Capybara 2.0
  if Capybara.exact_options and @selector == Selector.all[:option]
    @options[:exact] = true
  end

  @expression = @selector.call(@locator)
  assert_valid_keys!
end

Public Instance Methods

css() click to toggle source
# File lib/capybara/query.rb, line 105
def css
  @expression
end
description() click to toggle source
# File lib/capybara/query.rb, line 32
def description
  @description = "#{label} #{locator.inspect}"
  @description << " with text #{options[:text].inspect}" if options[:text]
  @description
end
exact?() click to toggle source
# File lib/capybara/query.rb, line 80
def exact?
  if options.has_key?(:exact)
    @options[:exact]
  else
    Capybara.exact
  end
end
label() click to toggle source
# File lib/capybara/query.rb, line 30
def label; selector.label or selector.name; end
match() click to toggle source
# File lib/capybara/query.rb, line 88
def match
  if options.has_key?(:match)
    @options[:match]
  else
    Capybara.match
  end
end
matches_filters?(node) click to toggle source
# File lib/capybara/query.rb, line 38
def matches_filters?(node)
  if options[:text]
    regexp = options[:text].is_a?(Regexp) ? options[:text] : Regexp.escape(options[:text].to_s)
    return false if not node.text(visible).match(regexp)
  end
  case visible
    when :visible then return false unless node.visible?
    when :hidden then return false if node.visible?
  end
  selector.custom_filters.each do |name, filter|
    if options.has_key?(name)
      return false unless filter.matches?(node, options[name])
    elsif filter.default?
      return false unless filter.matches?(node, filter.default)
    end
  end
end
name() click to toggle source
# File lib/capybara/query.rb, line 29
def name; selector.name; end
visible() click to toggle source
# File lib/capybara/query.rb, line 56
def visible
  if options.has_key?(:visible)
    case @options[:visible]
      when true then :visible
      when false then :all
      else @options[:visible]
    end
  else
    if Capybara.ignore_hidden_elements
      :visible
    else
      :all
    end
  end
end
wait() click to toggle source
# File lib/capybara/query.rb, line 72
def wait
  if options.has_key?(:wait)
    @options[:wait] or 0
  else
    Capybara.default_wait_time
  end
end
xpath(exact=nil) click to toggle source
# File lib/capybara/query.rb, line 96
def xpath(exact=nil)
  exact = self.exact? if exact == nil
  if @expression.respond_to?(:to_xpath) and exact
    @expression.to_xpath(:exact)
  else
    @expression.to_s
  end
end

Private Instance Methods

assert_valid_keys!() click to toggle source
# File lib/capybara/query.rb, line 111
def assert_valid_keys!
  valid_keys = VALID_KEYS + @selector.custom_filters.keys
  invalid_keys = @options.keys - valid_keys
  unless invalid_keys.empty?
    invalid_names = invalid_keys.map(&:inspect).join(", ")
    valid_names = valid_keys.map(&:inspect).join(", ")
    raise ArgumentError, "invalid keys #{invalid_names}, should be one of #{valid_names}"
  end
  unless VALID_MATCH.include?(match)
    raise ArgumentError, "invalid option #{match.inspect} for :match, should be one of #{VALID_MATCH.map(&:inspect).join(", ")}"
  end
end