nimboids-capybara 1.1.2

data/lib/capybara/node/actions.rb

@@ -0,0 +1,162 @@
+module Capybara
+  module 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
+      alias_method :click_on, :click_link_or_button
+
+      ##
+      #
+      # 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.select 'March', :from => 'Month'
+      #
+      # @param [String] value             Which option to select
+      # @param [Hash{:from => String}]    The id, name or label of the select box
+      #
+      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 unselect a particular option from it. If the select
+      # box is a multiple select, +unselect+ can be called multiple times to unselect more than
+      # one option. The select box can be found via its name, id or label text.
+      #
+      #     page.unselect 'March', :from => 'Month'
+      #
+      # @param [String] value             Which option to unselect
+      # @param [Hash{:from => String}]    The id, name or label of the select box
+      #
+      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)
+        raise Capybara::FileNotFound, "cannot attach file, #{path} does not exist" unless File.exist?(path.to_s)
+        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
+    end
+  end
+end

data/lib/capybara/node/base.rb

@@ -0,0 +1,63 @@
+module Capybara
+  module Node
+
+    ##
+    #
+    # A {Capybara::Node::Base} represents either an element on a page through the subclass
+    # {Capybara::Node::Element} or a document through {Capybara::Node::Document}.
+    #
+    # Both types of Node share the same methods, used for interacting with the
+    # elements on the page. These methods are divided into three categories,
+    # finders, actions and matchers. These are found in the modules
+    # {Capybara::Node::Finders}, {Capybara::Node::Actions} and {Capybara::Node::Matchers}
+    # respectively.
+    #
+    # A {Capybara::Session} exposes all methods from {Capybara::Node::Document} directly:
+    #
+    #     session = Capybara::Session.new(:rack_test, my_app)
+    #     session.visit('/')
+    #     session.fill_in('Foo', :with => 'Bar')    # from Capybara::Node::Actions
+    #     bar = session.find('#bar')                # from Capybara::Node::Finders
+    #     bar.select('Baz', :from => 'Quox')        # from Capybara::Node::Actions
+    #     session.has_css?('#foobar')               # from Capybara::Node::Matchers
+    #
+    class Base
+      attr_reader :session, :base, :parent
+
+      include Capybara::Node::Finders
+      include Capybara::Node::Actions
+      include Capybara::Node::Matchers
+
+      def initialize(session, base)
+        @session = session
+        @base = base
+      end
+
+      def reload
+        self
+      end
+
+    protected
+
+      def wait_until(seconds=Capybara.default_wait_time)
+        start_time = Time.now
+
+        begin
+          yield
+        rescue => e
+          raise e unless driver.wait?
+          raise e unless (driver.respond_to?(:invalid_element_errors) and driver.invalid_element_errors.include?(e.class)) or e.is_a?(Capybara::ElementNotFound)
+          raise e if (Time.now - start_time) >= seconds
+          sleep(0.05)
+          raise Capybara::FrozenInTime, "time appears to be frozen, Capybara does not work with libraries which freeze time, consider using time travelling instead" if Time.now == start_time
+          reload if Capybara.automatic_reload
+          retry
+        end
+      end
+
+      def driver
+        session.driver
+      end
+    end
+  end
+end

data/lib/capybara/node/document.rb

@@ -0,0 +1,25 @@
+module Capybara
+  module Node
+
+    ##
+    #
+    # A {Capybara::Document} represents an HTML document. Any operation
+    # performed on it will be performed on the entire document.
+    #
+    # @see Capybara::Node
+    #
+    class Document < Base
+      def inspect
+        %(#<Capybara::Document>)
+      end
+
+      ##
+      #
+      # @return [String]    The text of the document
+      #
+      def text
+        find(:xpath, '/html').text
+      end
+    end
+  end
+end

data/lib/capybara/node/element.rb

@@ -0,0 +1,201 @@
+module Capybara
+  module Node
+
+    ##
+    #
+    # A {Capybara::Element} represents a single element on the page. It is possible
+    # to interact with the contents of this element the same as with a document:
+    #
+    #     session = Capybara::Session.new(:rack_test, my_app)
+    #
+    #     bar = session.find('#bar')              # from Capybara::Node::Finders
+    #     bar.select('Baz', :from => 'Quox')      # from Capybara::Node::Actions
+    #
+    # {Capybara::Element} also has access to HTML attributes and other properties of the
+    # element:
+    #
+    #      bar.value
+    #      bar.text
+    #      bar[:title]
+    #
+    # @see Capybara::Node
+    #
+    class Element < Base
+
+      def initialize(session, base, parent, selector)
+        super(session, base)
+        @parent = parent
+        @selector = selector
+      end
+
+      ##
+      #
+      # @return [Object]    The native element from the driver, this allows access to driver specific methods
+      #
+      def native
+        wait_until { base.native }
+      end
+
+      ##
+      #
+      # @return [String]    The text of the element
+      #
+      def text
+        wait_until { base.text }
+      end
+
+      ##
+      #
+      # Retrieve the given attribute
+      #
+      #     element[:title] # => HTML title attribute
+      #
+      # @param  [Symbol] attribute     The attribute to retrieve
+      # @return [String]               The value of the attribute
+      #
+      def [](attribute)
+        wait_until { base[attribute] }
+      end
+
+      ##
+      #
+      # @return [String]    The value of the form element
+      #
+      def value
+        wait_until { base.value }
+      end
+
+      ##
+      #
+      # Set the value of the form element to the given value.
+      #
+      # @param [String] value    The new value
+      #
+      def set(value)
+        wait_until { base.set(value) }
+      end
+
+      ##
+      #
+      # Select this node if is an option element inside a select tag
+      #
+      def select_option
+        wait_until { base.select_option }
+      end
+
+      ##
+      #
+      # Unselect this node if is an option element inside a multiple select tag
+      #
+      def unselect_option
+        wait_until { base.unselect_option }
+      end
+
+      ##
+      #
+      # Click the Element
+      #
+      def click
+        wait_until { base.click }
+      end
+
+      ##
+      #
+      # @return [String]      The tag name of the element
+      #
+      def tag_name
+        wait_until { base.tag_name }
+      end
+
+      ##
+      #
+      # Whether or not the element is visible. Not all drivers support CSS, so
+      # the result may be inaccurate.
+      #
+      # @return [Boolean]     Whether the element is visible
+      #
+      def visible?
+        wait_until { base.visible? }
+      end
+
+      ##
+      #
+      # Whether or not the element is checked.
+      #
+      # @return [Boolean]     Whether the element is checked
+      #
+      def checked?
+        wait_until { base.checked? }
+      end
+
+      ##
+      #
+      # Whether or not the element is selected.
+      #
+      # @return [Boolean]     Whether the element is selected
+      #
+      def selected?
+        wait_until { base.selected? }
+      end
+
+      ##
+      #
+      # An XPath expression describing where on the page the element can be found
+      #
+      # @return [String]      An XPath expression
+      #
+      def path
+        wait_until { base.path }
+      end
+
+      ##
+      #
+      # Trigger any event on the current element, for example mouseover or focus
+      # events. Does not work in Selenium.
+      #
+      # @param [String] event       The name of the event to trigger
+      #
+      def trigger(event)
+        wait_until { base.trigger(event) }
+      end
+
+      ##
+      #
+      # Drag the element to the given other element.
+      #
+      #     source = page.find('#foo')
+      #     target = page.find('#bar')
+      #     source.drag_to(target)
+      #
+      # @param [Capybara::Element] node     The element to drag to
+      #
+      def drag_to(node)
+        wait_until { base.drag_to(node.base) }
+      end
+
+      def find(*args)
+        wait_until { super }
+      end
+
+      def first(*args)
+        wait_until { super }
+      end
+
+      def all(*args)
+        wait_until { super }
+      end
+
+      def reload
+        reloaded = parent.reload.first(@selector.name, @selector.locator, @selector.options)
+        @base = reloaded.base if reloaded
+        self
+      end
+
+      def inspect
+        %(#<Capybara::Element tag="#{tag_name}" path="#{path}">)
+      rescue NotSupportedByDriverError
+        %(#<Capybara::Element tag="#{tag_name}">)
+      end
+    end
+  end
+end