~ubuntu-branches/ubuntu/wily/ruby-xpath/wily-proposed

module XPath

  module HTML

    include XPath

    extend self

 

    # Match an `a` link element.

    #

    # @param [String] locator

    #   Text, id, title, or image alt attribute of the link

    #

    def link(locator)

      locator = locator.to_s

      link = descendant(:a)[attr(:href)]

      link[attr(:id).equals(locator) | string.n.contains(locator) | attr(:title).contains(locator) | descendant(:img)[attr(:alt).contains(locator)]]

    end

 

    # Match a `submit`, `image`, or `button` element.

    #

    # @param [String] locator

    #   Value, title, id, or image alt attribute of the button

    #

    def button(locator)

      locator = locator.to_s

      button = descendant(:input)[~attr(:disabled)][attr(:type).one_of('submit', 'reset', 'image', 'button')][attr(:id).equals(locator) | attr(:value).contains(locator) | attr(:title).contains(locator)]

      button += descendant(:button)[~attr(:disabled)][attr(:id).equals(locator) | attr(:value).contains(locator) | string.n.contains(locator) | attr(:title).contains(locator)]

      button += descendant(:input)[~attr(:disabled)][attr(:type).equals('image')][attr(:alt).contains(locator)]

    end

 

 

    # Match anything returned by either {#link} or {#button}.

    #

    # @param [String] locator

    #   Text, id, title, or image alt attribute of the link or button

    #

    def link_or_button(locator)

      link(locator) + button(locator)

    end

 

 

    # Match any `fieldset` element.

    #

    # @param [String] locator

    #   Legend or id of the fieldset

    #

    def fieldset(locator)

      locator = locator.to_s

      descendant(:fieldset)[attr(:id).equals(locator) | child(:legend)[string.n.contains(locator)]]

    end

 

 

    # Match any `input`, `textarea`, or `select` element that doesn't have a

    # type of `submit`, `image`, or `hidden`.

    #

    # @param [String] locator

    #   Label, id, or name of field to match

    #

    def field(locator)

      locator = locator.to_s

      xpath = descendant(:input, :textarea, :select)[~attr(:type).one_of('submit', 'image', 'hidden')]

      xpath = locate_field(xpath, locator)

      xpath

    end

 

 

    # Match any `input` or `textarea` element that can be filled with text.

    # This excludes any inputs with a type of `submit`, `image`, `radio`,

    # `checkbox`, `hidden`, or `file`.

    #

    # @param [String] locator

    #   Label, id, or name of field to match

    #

    def fillable_field(locator)

      locator = locator.to_s

      xpath = descendant(:input, :textarea)[~attr(:type).one_of('submit', 'image', 'radio', 'checkbox', 'hidden', 'file')]

      xpath = locate_field(xpath, locator)

      xpath

    end

 

 

    # Match any `select` element.

    #

    # @param [String] locator

    #   Label, id, or name of the field to match

    #

    def select(locator)

      locator = locator.to_s

      locate_field(descendant(:select), locator)

    end

 

 

    # Match any `input` element of type `checkbox`.

    #

    # @param [String] locator

    #   Label, id, or name of the checkbox to match

    #

    def checkbox(locator)

      locator = locator.to_s

      locate_field(descendant(:input)[attr(:type).equals('checkbox')], locator)

    end

 

 

    # Match any `input` element of type `radio`.

    #

    # @param [String] locator

    #   Label, id, or name of the radio button to match

    #

    def radio_button(locator)

      locator = locator.to_s

      locate_field(descendant(:input)[attr(:type).equals('radio')], locator)

    end

 

 

    # Match any `input` element of type `file`.

    #

    # @param [String] locator

    #   Label, id, or name of the file field to match

    #

    def file_field(locator)

      locator = locator.to_s

      locate_field(descendant(:input)[attr(:type).equals('file')], locator)

    end

 

 

    # Match an `optgroup` element.

    #

    # @param [String] name

    #   Label for the option group

    #

    def optgroup(locator)

      locator = locator.to_s

      descendant(:optgroup)[attr(:label).contains(locator)]

    end

 

 

    # Match an `option` element.

    #

    # @param [String] name

    #   Visible text of the option

    #

    def option(locator)

      locator = locator.to_s

      descendant(:option)[string.n.equals(locator)]

    end

 

 

    # Match any `table` element.

    #

    # @param [String] locator

    #   Caption or id of the table to match

    # @option options [Array] :rows

    #   Content of each cell in each row to match

    #

    def table(locator)

      locator = locator.to_s

      descendant(:table)[attr(:id).equals(locator) | descendant(:caption).contains(locator)]

    end

 

    # Match any 'dd' element.

    #

    # @param [String] locator

    #   Id of the 'dd' element or text from preciding 'dt' element content

    def definition_description(locator)

      locator = locator.to_s

      descendant(:dd)[attr(:id).equals(locator) | previous_sibling(:dt)[string.n.equals(locator)] ]

    end

 

  protected

 

    def locate_field(xpath, locator)

      locate_field = xpath[attr(:id).equals(locator) | attr(:name).equals(locator) | attr(:placeholder).equals(locator) | attr(:id).equals(anywhere(:label)[string.n.contains(locator)].attr(:for))]

      locate_field += descendant(:label)[string.n.contains(locator)].descendant(xpath)

      locate_field[~attr(:disabled)]

    end

  end

end