capybara 0.3.9 → 0.4.0.rc

data/lib/capybara/node/actions.rb

@@ -0,0 +1,170 @@
+module Capybara
+  class Node
+    module Actions
+
+      ##
+      #
+      # Finds a button or link by id, text or value and clicks it. Also looks at image
+      # alt text inside the link.
+      #
+      # @param [String] locator      Text, id or value of link or button
+      #
+      def click_link_or_button(locator)
+        msg = "no link or button '#{locator}' found"
+        find(:xpath, XPath::HTML.link_or_button(locator), :message => msg).click
+      end
+
+      ##
+      #
+      # Finds a link by id or text and clicks it. Also looks at image
+      # alt text inside the link.
+      #
+      # @param [String] locator      Text, id or text of link
+      #
+      def click_link(locator)
+        msg = "no link with title, id or text '#{locator}' found"
+        find(:xpath, XPath::HTML.link(locator), :message => msg).click
+      end
+
+      ##
+      #
+      # Finds a button by id, text or value and clicks it.
+      #
+      # @param [String] locator      Text, id or value of button
+      #
+      def click_button(locator)
+        msg = "no button with value or id or text '#{locator}' found"
+        find(:xpath, XPath::HTML.button(locator), :message => msg).click
+      end
+
+      ##
+      #
+      # Locate a text field or text area and fill it in with the given text
+      # The field can be found via its name, id or label text.
+      #
+      #     page.fill_in 'Name', :with => 'Bob'
+      #
+      # @param [String] locator           Which field to fill in
+      # @param [Hash{:with => String}]    The value to fill in
+      #
+      def fill_in(locator, options={})
+        msg = "cannot fill in, no text field, text area or password field with id, name, or label '#{locator}' found"
+        raise "Must pass a hash containing 'with'" if not options.is_a?(Hash) or not options.has_key?(:with)
+        find(:xpath, XPath::HTML.fillable_field(locator), :message => msg).set(options[:with])
+      end
+
+      ##
+      #
+      # Find a radio button and mark it as checked. The radio button can be found
+      # via name, id or label text.
+      #
+      #     page.choose('Male')
+      #
+      # @param [String] locator           Which radio button to choose
+      #
+      def choose(locator)
+        msg = "cannot choose field, no radio button with id, name, or label '#{locator}' found"
+        find(:xpath, XPath::HTML.radio_button(locator), :message => msg).set(true)
+      end
+
+      ##
+      #
+      # Find a check box and mark it as checked. The check box can be found
+      # via name, id or label text.
+      #
+      #     page.check('German')
+      #
+      # @param [String] locator           Which check box to check
+      #
+      def check(locator)
+        msg = "cannot check field, no checkbox with id, name, or label '#{locator}' found"
+        find(:xpath, XPath::HTML.checkbox(locator), :message => msg).set(true)
+      end
+
+      ##
+      #
+      # Find a check box and mark uncheck it. The check box can be found
+      # via name, id or label text.
+      #
+      #     page.uncheck('German')
+      #
+      # @param [String] locator           Which check box to uncheck
+      #
+      def uncheck(locator)
+        msg = "cannot uncheck field, no checkbox with id, name, or label '#{locator}' found"
+        find(:xpath, XPath::HTML.checkbox(locator), :message => msg).set(false)
+      end
+
+      ##
+      #
+      # Find a select box on the page and select a particular option from it. If the select
+      # box is a multiple select, +select+ can be called multiple times to select more than
+      # one option. The select box can be found via its name, id or label text.
+      #
+      #     page.uncheck('German')
+      #
+      # @param [String] locator           Which check box to uncheck
+      #
+      def select(value, options={})
+        if options.has_key?(:from)
+          no_select_msg = "cannot select option, no select box with id, name, or label '#{options[:from]}' found"
+          no_option_msg = "cannot select option, no option with text '#{value}' in select box '#{options[:from]}'"
+          select = find(:xpath, XPath::HTML.select(options[:from]), :message => no_select_msg)
+          select.find(:xpath, XPath::HTML.option(value), :message => no_option_msg).select_option
+        else
+          no_option_msg = "cannot select option, no option with text '#{value}'"
+          find(:xpath, XPath::HTML.option(value), :message => no_option_msg).select_option
+        end
+      end
+
+      ##
+      #
+      # Find a select box on the page and select a particular option from it. If the select
+      # box is a multiple select, +select+ can be called multiple times to select more than
+      # one option. The select box can be found via its name, id or label text.
+      #
+      #     page.uncheck('German')
+      #
+      # @param [String] locator           Which check box to uncheck
+      #
+      def unselect(value, options={})
+        if options.has_key?(:from)
+          no_select_msg = "cannot unselect option, no select box with id, name, or label '#{options[:from]}' found"
+          no_option_msg = "cannot unselect option, no option with text '#{value}' in select box '#{options[:from]}'"
+          select = find(:xpath, XPath::HTML.select(options[:from]), :message => no_select_msg)
+          select.find(:xpath, XPath::HTML.option(value), :message => no_option_msg).unselect_option
+        else
+          no_option_msg = "cannot unselect option, no option with text '#{value}'"
+          find(:xpath, XPath::HTML.option(value), :message => no_option_msg).unselect_option
+        end
+      end
+
+      ##
+      #
+      # Find a file field on the page and attach a file given its path. The file field can
+      # be found via its name, id or label text.
+      #
+      #     page.attach_file(locator, '/path/to/file.png')
+      #
+      # @param [String] locator       Which field to attach the file to
+      # @param [String] path          The path of the file that will be attached
+      #
+      def attach_file(locator, path)
+        msg = "cannot attach file, no file field with id, name, or label '#{locator}' found"
+        find(:xpath, XPath::HTML.file_field(locator), :message => msg).set(path)
+      end
+
+      ##
+      #
+      # Drag one element to another
+      #
+      # @deprecated    Use Capybara::Element#drag_to instead.
+      #
+      def drag(source_locator, target_locator)
+        source = find(:xpath, source_locator, :message => "drag source '#{source_locator}' not found on page")
+        target = find(:xpath, target_locator, :message => "drag target '#{target_locator}' not found on page")
+        source.drag_to(target)
+      end
+    end
+  end
+end

data/lib/capybara/node/finders.rb

@@ -0,0 +1,150 @@
+module Capybara
+  class Node
+    module Finders
+
+      ##
+      #
+      # Find an {Capybara::Element} based on the given arguments. +find+ will raise an error if the element
+      # is not found. The error message can be customized through the +:message+ option.
+      #
+      # If the driver is capable of executing JavaScript, +find+ will wait for a set amount of time
+      # and continuously retry finding the element until either the element is found or the time
+      # expires. The length of time +find+ will wait is controlled through {Capybara.default_wait_time}
+      # and defaults to 2 seconds.
+      #
+      # +find+ takes the same options as +all+.
+      #
+      #     page.find('#foo').find('.bar')
+      #     page.find(:xpath, '//div[contains("bar")]')
+      #     page.find('li', :text => 'Quox').click_link('Delete')
+      #
+      # @param (see Capybara::Node::Finders#all)
+      # @option options [String] :message     An error message in case the element can't be found
+      # @return [Capybara::Element]           The found element
+      # @raise  [Capybara::ElementNotFound]   If the element can't be found before time expires
+      #
+      def find(*args)
+        node = wait_conditionally_until { all(*args).first }
+      ensure
+        options = if args.last.is_a?(Hash) then args.last else {} end
+        raise Capybara::ElementNotFound, options[:message] || "Unable to find '#{args[1] || args[0]}'" unless node
+        return node
+      end
+
+      ##
+      #
+      # @deprecated {#find} now behaves like locate used to. Use {#find} instead.
+      #
+      def locate(*args)
+        Capybara.deprecate("locate", "find")
+        find(*args)
+      end
+
+      ##
+      #
+      # Find a form field on the page. The field can be found by its name, id or label text.
+      #
+      # @param [String] locator       Which field to find
+      # @return [Capybara::Element]   The found element
+      #
+      def find_field(locator)
+        find(:xpath, XPath::HTML.field(locator))
+      end
+      alias_method :field_labeled, :find_field
+
+      ##
+      #
+      # Find a link on the page. The link can be found by its id or text.
+      #
+      # @param [String] locator       Which link to find
+      # @return [Capybara::Element]   The found element
+      #
+      def find_link(locator)
+        find(:xpath, XPath::HTML.link(locator))
+      end
+
+      ##
+      #
+      # Find a button on the page. The link can be found by its id, name or value.
+      #
+      # @param [String] locator       Which button to find
+      # @return [Capybara::Element]   The found element
+      #
+      def find_button(locator)
+        find(:xpath, XPath::HTML.button(locator))
+      end
+
+      ##
+      #
+      # Find a element on the page, given its id.
+      #
+      # @param [String] locator       Which element to find
+      # @return [Capybara::Element]   The found element
+      #
+      def find_by_id(id)
+        find(:css, "##{id}")
+      end
+
+      ##
+      #
+      # Find all elements on the page matching the given selector
+      # and options.
+      #
+      # Both XPath and CSS expressions are supported, but Capybara
+      # does not try to automatically distinguish between them. The
+      # following statements are equivalent:
+      #
+      #     page.all(:css, 'a#person_123')
+      #     page.all(:xpath, '//a[@id="person_123"]')
+      #
+      #
+      # If the type of selector is left out, Capybara uses
+      # {Capybara.default_selector}. It's set to :css by default.
+      #
+      #     page.all("a#person_123")
+      #
+      #     Capybara.default_selector = :xpath
+      #     page.all('//a[@id="person_123"]')
+      #
+      # The set of found elements can further be restricted by specifying
+      # options. It's possible to select elements by their text or visibility:
+      #
+      #     page.all('a', :text => 'Home')
+      #     page.all('#menu li', :visible => true)
+      #
+      # @param [:css, :xpath, String] kind_or_locator     Either the kind of selector or the selector itself
+      # @param [String] locator                           The selector
+      # @param [Hash{Symbol => Object}] options           Additional options
+      # @option options [String, Regexp] text             Only find elements which contain this text or match this regexp
+      # @option options [Boolean] visible                 Only find elements that are visible on the page
+      # @return [Capybara::Element]                       The found elements
+      #
+      def all(*args)
+        options = if args.last.is_a?(Hash) then args.pop else {} end
+
+        results = Capybara::Selector.normalize(*args).map do |path|
+          base.find(path)
+        end.flatten
+
+        if text = options[:text]
+          text = Regexp.escape(text) unless text.kind_of?(Regexp)
+
+          results = results.select { |node| node.text.match(text) }
+        end
+
+        if options[:visible] or Capybara.ignore_hidden_elements
+          results = results.select { |node| node.visible? }
+        end
+
+        results.map { |n| Capybara::Element.new(session, n) }
+      end
+
+    protected
+
+      def wait_conditionally_until
+        if driver.wait? then session.wait_until { yield } else yield end
+      end
+
+    end
+  end
+end

data/lib/capybara/node/matchers.rb

@@ -0,0 +1,360 @@
+module Capybara
+  class Node
+    module Matchers
+
+      ##
+      #
+      # Checks if a given selector is on the page or current node.
+      #
+      #     page.has_selector?('p#foo')
+      #     page.has_selector?(:xpath, './/p[@id="foo"]')
+      #     page.has_selector?(:foo)
+      #
+      # By default it will check if the expression occurs at least once,
+      # but a different number can be specified.
+      #
+      #     page.has_selector?('p#foo', :count => 4)
+      #
+      # This will check if the expression occurs exactly 4 times.
+      #
+      # It also accepts all options that {Capybara::Node::Finders#all} accepts,
+      # such as :text and :visible.
+      #
+      #     page.has_selector?('li', :text => 'Horse', :visible => true)
+      #
+      # has_selector? can also accept XPath expressions generated by the
+      # XPath gem:
+      #
+      #     xpath = XPath.generate { |x| x.descendant(:p) }
+      #     page.has_selector?(:xpath, xpath)
+      #
+      # @param (see Capybara::Node::Finders#all)
+      # @option options [Integer] :count (nil)    Number of times the expression should occur
+      # @return [Boolean]                         If the expression exists
+      #
+      def has_selector?(*args)
+        options = if args.last.is_a?(Hash) then args.last else {} end
+        wait_conditionally_until do
+          results = all(*args)
+
+          if options[:count]
+            results.size == options[:count]
+          else
+            results.size > 0
+          end
+        end
+      rescue Capybara::TimeoutError
+        return false
+      end
+
+      ##
+      #
+      # Checks if a given selector is not on the page or current node.
+      # Usage is identical to Capybara::Node::Matchers#has_selector?
+      #
+      # @param (see Capybara::Node::Finders#has_selector?)
+      # @return [Boolean]
+      #
+      def has_no_selector?(*args)
+        options = if args.last.is_a?(Hash) then args.last else {} end
+        wait_conditionally_until do
+          results = all(*args)
+
+          if options[:count]
+            results.size != options[:count]
+          else
+            results.empty?
+          end
+        end
+      rescue Capybara::TimeoutError
+        return false
+      end
+
+      ##
+      #
+      # Checks if a given XPath expression is on the page or current node.
+      #
+      #     page.has_xpath?('.//p[@id="foo"]')
+      #
+      # By default it will check if the expression occurs at least once,
+      # but a different number can be specified.
+      #
+      #     page.has_xpath?('.//p[@id="foo"]', :count => 4)
+      #
+      # This will check if the expression occurs exactly 4 times.
+      #
+      # It also accepts all options that {Capybara::Node::Finders#all} accepts,
+      # such as :text and :visible.
+      #
+      #     page.has_xpath?('.//li', :text => 'Horse', :visible => true)
+      #
+      # has_xpath? can also accept XPath expressions generate by the
+      # XPath gem:
+      #
+      #     xpath = XPath.generate { |x| x.descendant(:p) }
+      #     page.has_xpath?(xpath)
+      #
+      # @param [String] path                      An XPath expression
+      # @param options                            (see Capybara::Node::Finders#all)
+      # @option options [Integer] :count (nil)    Number of times the expression should occur
+      # @return [Boolean]                         If the expression exists
+      #
+      def has_xpath?(path, options={})
+        has_selector?(:xpath, path, options)
+      end
+
+      ##
+      #
+      # Checks if a given XPath expression is not on the page or current node.
+      # Usage is identical to Capybara::Node::Matchers#has_xpath?
+      #
+      # @param (see Capybara::Node::Finders#has_xpath?)
+      # @return [Boolean]
+      #
+      def has_no_xpath?(path, options={})
+        has_no_selector?(:xpath, path, options)
+      end
+
+      ##
+      #
+      # Checks if a given CSS selector is on the page or current node.
+      #
+      #     page.has_css?('p#foo')
+      #
+      # By default it will check if the selector occurs at least once,
+      # but a different number can be specified.
+      #
+      #     page.has_css?('p#foo', :count => 4)
+      #
+      # This will check if the selector occurs exactly 4 times.
+      #
+      # It also accepts all options that {Capybara::Node::Finders#all} accepts,
+      # such as :text and :visible.
+      #
+      #     page.has_css?('li', :text => 'Horse', :visible => true)
+      #
+      # @param [String] path                      A CSS selector
+      # @param options                            (see Capybara::Node::Finders#all)
+      # @option options [Integer] :count (nil)    Number of times the selector should occur
+      # @return [Boolean]                         If the selector exists
+      #
+      def has_css?(path, options={})
+        has_xpath?(XPath.css(path), options)
+      end
+
+      ##
+      #
+      # Checks if a given CSS selector is not on the page or current node.
+      # Usage is identical to Capybara::Node::Matchers#has_css?
+      #
+      # @param (see Capybara::Node::Finders#has_css?)
+      # @return [Boolean]
+      #
+      def has_no_css?(path, options={})
+        has_no_xpath?(XPath.css(path), options)
+      end
+
+      ##
+      #
+      # Checks if the page or current node has the given text content,
+      # ignoring any HTML tags and normalizing whitespace.
+      #
+      # @param [String] content       The text to check for
+      # @return [Boolean]             Whether it exists
+      #
+      def has_content?(content)
+        has_xpath?(XPath::HTML.content(content))
+      end
+
+      ##
+      #
+      # Checks if the page or current node does not have the given text
+      # content, ignoring any HTML tags and normalizing whitespace.
+      #
+      # @param [String] content       The text to check for
+      # @return [Boolean]             Whether it exists
+      #
+      def has_no_content?(content)
+        has_no_xpath?(XPath::HTML.content(content))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has a link with the given
+      # text or id.
+      #
+      # @param [String] locator      The text or id of a link to check for
+      # @return [Boolean]            Whether it exists
+      #
+      def has_link?(locator)
+        has_xpath?(XPath::HTML.link(locator))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has no link with the given
+      # text or id.
+      #
+      # @param [String] locator      The text or id of a link to check for
+      # @return [Boolean]            Whether it doesn't exist
+      #
+      def has_no_link?(locator)
+        has_no_xpath?(XPath::HTML.link(locator))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has a button with the given
+      # text, value or id.
+      #
+      # @param [String] locator      The text, value or id of a button to check for
+      # @return [Boolean]            Whether it exists
+      #
+      def has_button?(locator)
+        has_xpath?(XPath::HTML.button(locator))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has no button with the given
+      # text, value or id.
+      #
+      # @param [String] locator      The text, value or id of a button to check for
+      # @return [Boolean]            Whether it doesn't exist
+      #
+      def has_no_button?(locator)
+        has_no_xpath?(XPath::HTML.button(locator))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has a form field with the given
+      # label, name or id.
+      #
+      # For text fields and other textual fields, such as textareas and
+      # HTML5 email/url/etc. fields, it's possible to specify a :with
+      # option to specify the text the field should contain:
+      #
+      #     page.has_field?('Name', :with => 'Jonas')
+      #
+      # @param [String] locator           The label, name or id of a field to check for
+      # @option options [String] :with    The text content of the field
+      # @return [Boolean]                 Whether it exists
+      #
+      def has_field?(locator, options={})
+        has_xpath?(XPath::HTML.field(locator, options))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has no form field with the given
+      # label, name or id. See {Capybara::Node::Matchers#has_field?}.
+      #
+      # @param [String] locator           The label, name or id of a field to check for
+      # @option options [String] :with    The text content of the field
+      # @return [Boolean]                 Whether it doesn't exist
+      #
+      def has_no_field?(locator, options={})
+        has_no_xpath?(XPath::HTML.field(locator, options))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has a radio button or
+      # checkbox with the given label, value or id, that is currently
+      # checked.
+      #
+      # @param [String] locator           The label, name or id of a checked field
+      # @return [Boolean]                 Whether it exists
+      #
+      def has_checked_field?(locator)
+        has_xpath?(XPath::HTML.field(locator, :checked => true))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has a radio button or
+      # checkbox with the given label, value or id, that is currently
+      # unchecked.
+      #
+      # @param [String] locator           The label, name or id of an unchecked field
+      # @return [Boolean]                 Whether it exists
+      #
+      def has_unchecked_field?(locator)
+        has_xpath?(XPath::HTML.field(locator, :unchecked => true))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has a select field with the
+      # given label, name or id.
+      #
+      # It can be specified which option should currently be selected:
+      #
+      #     page.has_select?('Language', :selected => 'German')
+      #
+      # For multiple select boxes, several options may be specified:
+      #
+      #     page.has_select?('Language', :selected => ['English', 'German'])
+      #
+      # It's also possible to check if a given set of options exists for
+      # this select box:
+      #
+      #     page.has_select?('Language', :options => ['English', 'German'])
+      #
+      # @param [String] locator                      The label, name or id of a select box
+      # @option options [Array] :options             Options which should be contained in this select box
+      # @option options [String, Array] :selected    Options which should be selected
+      # @return [Boolean]                            Whether it exists
+      #
+      def has_select?(locator, options={})
+        has_xpath?(XPath::HTML.select(locator, options))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has no select field with the
+      # given label, name or id. See {Capybara::Node::Matchers#has_select?}.
+      #
+      # @param (see Capybara::Node::Matchers#has_select?)
+      # @return [Boolean]     Whether it doesn't exist
+      #
+      def has_no_select?(locator, options={})
+        has_no_xpath?(XPath::HTML.select(locator, options))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has a table with the given id
+      # or caption.
+      #
+      # If the options :rows is given, it will check that the table contains
+      # the rows and columns given:
+      #
+      #    page.has_table?('People', :rows => [['Jonas', '24'], ['Peter', '32']])
+      #
+      # Note that this option is quite strict, the order needs to be correct
+      # and the text needs to match exactly.
+      #
+      # @param [String] locator                        The id or caption of a table
+      # @option options [Array[Array[String]]] :rows   A set of rows the table should contain
+      # @return [Boolean]                              Whether it exist
+      #
+      def has_table?(locator, options={})
+        has_xpath?(XPath::HTML.table(locator, options))
+      end
+
+      ##
+      #
+      # Checks if the page or current node has no table with the given id
+      # or caption. See {Capybara::Node::Matchers#has_table?}.
+      #
+      # @param (see Capybara::Node::Matchers#has_table?)
+      # @return [Boolean]       Whether it doesn't exist
+      #
+      def has_no_table?(locator, options={})
+        has_no_xpath?(XPath::HTML.table(locator, options))
+      end
+    end
+  end
+end