xpath 0.1.4 → 1.0.0.beta1

data/lib/xpath/html.rb

@@ -3,112 +3,151 @@ module XPath
     include XPath
     extend self
 
-    def link(locator, options={})
-      href = options[:href]
-      link = descendant(:a)[href ? attr(:href).equals(href) : attr(:href)]
-      link[attr(:id).equals(locator) | string.n.is(locator) | attr(:title).is(locator) | descendant(:img)[attr(:alt).is(locator)]]
-    end
-
-    def content(locator)
-      child(:"descendant-or-self::*")[current.n.contains(locator)]
-    end
-
+    # Match an `a` link element.
+    #
+    # @param [String] locator
+    #   Text, id, title, or image alt attribute of the link
+    #
+    def link(locator)
+      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)
-      button = descendant(:input)[attr(:type).one_of('submit', 'image', 'button')][attr(:id).equals(locator) | attr(:value).is(locator) | attr(:title).is(locator)]
-      button += descendant(:button)[attr(:id).equals(locator) | attr(:value).is(locator) | string.n.is(locator) | attr(:title).is(locator)]
-      button += descendant(:input)[attr(:type).equals('image')][attr(:alt).is(locator)]
+      button = descendant(:input)[attr(:type).one_of('submit', 'reset', 'image', 'button')][attr(:id).equals(locator) | attr(:value).contains(locator) | attr(:title).contains(locator)]
+      button += descendant(:button)[attr(:id).equals(locator) | attr(:value).contains(locator) | string.n.contains(locator) | attr(:title).contains(locator)]
+      button += descendant(:input)[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)
-      descendant(:fieldset)[attr(:id).equals(locator) | descendant(:legend)[string.n.is(locator)]]
+      descendant(:fieldset)[attr(:id).equals(locator) | child(:legend)[string.n.contains(locator)]]
     end
 
-    def field(locator, options={})
+
+    # 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)
       xpath = descendant(:input, :textarea, :select)[~attr(:type).one_of('submit', 'image', 'hidden')]
       xpath = locate_field(xpath, locator)
-      xpath = xpath[attr(:checked)] if options[:checked]
-      xpath = xpath[~attr(:checked)] if options[:unchecked]
-      xpath = xpath[field_value(options[:with])] if options.has_key?(:with)
       xpath
     end
 
-    def fillable_field(locator, options={})
+
+    # 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)
       xpath = descendant(:input, :textarea)[~attr(:type).one_of('submit', 'image', 'radio', 'checkbox', 'hidden', 'file')]
       xpath = locate_field(xpath, locator)
-      xpath = xpath[field_value(options[:with])] if options.has_key?(:with)
       xpath
     end
 
-    def select(locator, options={})
-      xpath = locate_field(descendant(:select), locator)
 
-      options[:options].each do |option|
-        xpath = xpath[descendant(:option).equals(option)]
-      end if options[:options]
+    # Match any `select` element.
+    #
+    # @param [String] locator
+    #   Label, id, or name of the field to match
+    #
+    def select(locator)
+      locate_field(descendant(:select), locator)
+    end
 
-      [options[:selected]].flatten.each do |option|
-        xpath = xpath[descendant(:option)[attr(:selected)].equals(option)]
-      end if options[:selected]
 
-      xpath
+    # Match any `input` element of type `checkbox`.
+    #
+    # @param [String] locator
+    #   Label, id, or name of the checkbox to match
+    #
+    def checkbox(locator)
+      locate_field(descendant(:input)[attr(:type).equals('checkbox')], locator)
     end
 
-    def checkbox(locator, options={})
-      xpath = locate_field(descendant(:input)[attr(:type).equals('checkbox')], locator)
-    end
 
-    def radio_button(locator, options={})
+    # Match any `input` element of type `radio`.
+    #
+    # @param [String] locator
+    #   Label, id, or name of the radio button to match
+    #
+    def radio_button(locator)
       locate_field(descendant(:input)[attr(:type).equals('radio')], locator)
     end
 
-    def file_field(locator, options={})
+
+    # Match any `input` element of type `file`.
+    #
+    # @param [String] locator
+    #   Label, id, or name of the file field to match
+    #
+    def file_field(locator)
       locate_field(descendant(:input)[attr(:type).equals('file')], locator)
     end
 
+
+    # Match an `optgroup` element.
+    #
+    # @param [String] name
+    #   Label for the option group
+    #
     def optgroup(name)
-      descendant(:optgroup)[attr(:label).is(name)]
+      descendant(:optgroup)[attr(:label).contains(name)]
     end
 
-    def option(name)
-      descendant(:option)[string.n.is(name)]
-    end
 
-    def table(locator, options={})
-      xpath = descendant(:table)[attr(:id).equals(locator) | descendant(:caption).contains(locator)]
-      xpath = xpath[table_rows(options[:rows])] if options[:rows]
-      xpath
+    # Match an `option` element.
+    #
+    # @param [String] name
+    #   Visible text of the option
+    #
+    def option(name)
+      descendant(:option)[string.n.equals(name)]
     end
 
-    def table_rows(rows)
-      row_conditions = descendant(:tr)[table_row(rows.first)]
-      rows.drop(1).each do |row|
-        row_conditions = row_conditions.next_sibling(:tr)[table_row(row)]
-      end
-      row_conditions
-    end
 
-    def table_row(cells)
-      cell_conditions = child(:td, :th)[string.n.equals(cells.first)]
-      cells.drop(1).each do |cell|
-        cell_conditions = cell_conditions.next_sibling(:td, :th)[string.n.equals(cell)]
-      end
-      cell_conditions
+    # 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)
+      descendant(:table)[attr(:id).equals(locator) | descendant(:caption).contains(locator)]
     end
 
   protected
 
     def locate_field(xpath, locator)
-      locate_field = xpath[attr(:id).equals(locator) | attr(:name).equals(locator) | attr(:id).equals(anywhere(:label)[string.n.is(locator)].attr(:for))]
-      locate_field += descendant(:label)[string.n.is(locator)].descendant(xpath)
+      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)
     end
-
-    def field_value(value)
-      (string.n.is(value) & tag(:textarea)) | (attr(:value).equals(value) & ~tag(:textarea))
-    end
-
   end
 end

data/lib/xpath/literal.rb

@@ -0,0 +1,8 @@
+module XPath
+  class Literal
+    attr_reader :value
+    def initialize(value)
+      @value = value
+    end
+  end
+end

data/lib/xpath/renderer.rb

@@ -0,0 +1,146 @@
+module XPath
+  class Renderer
+    def self.render(node)
+      new.render(node)
+    end
+
+    def render(node)
+      arguments = node.arguments.map { |argument| convert_argument(argument) }
+      send(node.expression, *arguments)
+    end
+
+    def convert_argument(argument)
+      case argument
+        when Expression, Union then render(argument)
+        when Array then argument.map { |element| convert_argument(element) }
+        when String then string_literal(argument)
+        when Literal then argument.value
+        else argument.to_s
+      end
+    end
+
+    def string_literal(string)
+      if string.include?("'")
+        string = string.split("'", -1).map do |substr|
+          "'#{substr}'"
+        end.join(%q{,"'",})
+        "concat(#{string})"
+      else
+        "'#{string}'"
+      end
+    end
+
+    def this_node
+      '.'
+    end
+
+    def descendant(parent, element_names)
+      if element_names.length == 1
+        "#{parent}//#{element_names.first}"
+      elsif element_names.length > 1
+        "#{parent}//*[#{element_names.map { |e| "self::#{e}" }.join(" | ")}]"
+      else
+        "#{parent}//*"
+      end
+    end
+
+    def child(parent, element_names)
+      if element_names.length == 1
+        "#{parent}/#{element_names.first}"
+      elsif element_names.length > 1
+        "#{parent}/*[#{element_names.map { |e| "self::#{e}" }.join(" | ")}]"
+      else
+        "#{parent}/*"
+      end
+    end
+
+    def axis(parent, name, tag_name)
+      "#{parent}/#{name}::#{tag_name}"
+    end
+
+    def node_name(current)
+      "name(#{current})"
+    end
+
+    def where(on, condition)
+      "#{on}[#{condition}]"
+    end
+
+    def attribute(current, name)
+      "#{current}/@#{name}"
+    end
+
+    def equality(one, two)
+      "#{one} = #{two}"
+    end
+
+    def variable(name)
+      "%{#{name}}"
+    end
+
+    def text(current)
+      "#{current}/text()"
+    end
+
+    def normalized_space(current)
+      "normalize-space(#{current})"
+    end
+
+    def literal(node)
+      node
+    end
+
+    def css(current, selector)
+      paths = Nokogiri::CSS.xpath_for(selector).map do |xpath_selector|
+        "#{current}#{xpath_selector}"
+      end
+      union(paths)
+    end
+
+    def union(*expressions)
+      expressions.join(' | ')
+    end
+
+    def anywhere(tag_name)
+      "//#{tag_name}"
+    end
+
+    def contains(current, value)
+      "contains(#{current}, #{value})"
+    end
+
+    def starts_with(current, value)
+      "starts-with(#{current}, #{value})"
+    end
+
+    def and(one, two)
+      "(#{one} and #{two})"
+    end
+
+    def or(one, two)
+      "(#{one} or #{two})"
+    end
+
+    def one_of(current, values)
+      values.map { |value| "#{current} = #{value}" }.join(' or ')
+    end
+
+    def next_sibling(current, element_names)
+      if element_names.length == 1
+        "#{current}/following-sibling::*[1]/self::#{element_names.first}"
+      elsif element_names.length > 1
+        "#{current}/following-sibling::*[1]/self::*[#{element_names.map { |e| "self::#{e}" }.join(" | ")}]"
+      else
+        "#{current}/following-sibling::*[1]/self::*"
+      end
+    end
+
+    def inverse(current)
+      "not(#{current})"
+    end
+
+    def string_function(current)
+      "string(#{current})"
+    end
+  end
+end

data/lib/xpath/union.rb

@@ -3,29 +3,27 @@ module XPath
     include Enumerable
 
     attr_reader :expressions
+    alias_method :arguments, :expressions
 
     def initialize(*expressions)
       @expressions = expressions
     end
 
-    def each(&block)
-      expressions.each(&block)
-    end
-
-    def to_s
-      to_xpaths.join(' | ')
+    def expression
+      :union
     end
 
-    def to_xpath(predicate=nil)
-      expressions.map { |e| e.to_xpath(predicate) }.join(' | ')
+    def each(&block)
+      arguments.each(&block)
     end
 
-    def to_xpaths
-      [to_xpath(:exact), to_xpath(:fuzzy)].uniq
+    def method_missing(*args)
+      XPath::Union.new(*arguments.map { |e| e.send(*args) })
     end
 
-    def method_missing(*args)
-      XPath::Union.new(*expressions.map { |e| e.send(*args) })
+    def to_xpath
+      Renderer.render(self)
     end
+    alias_method :to_s, :to_xpath
   end
 end

data/lib/xpath/version.rb

@@ -1,3 +1,3 @@
 module XPath
-  VERSION = '0.1.4'
+  VERSION = '1.0.0.beta1'
 end

data/spec/fixtures/form.html

@@ -28,7 +28,15 @@
   <input type="submit" title="My submit title" value="submit-with-title" data="title-submit">
   <input type="submit" title="Exact submit title" value="exact title submit" data="exact-title-submit">
   <input type="submit" title="Not Exact submit title" value="exact title submit" data="not-exact-title-submit">
-
+  
+  <input type="reset" id="reset-with-id" data="id-reset" value="Has ID"/>
+  <input type="reset" value="reset-with-value" data="value-reset"/>
+  <input type="reset" value="not exact value reset" data="not-exact-value-reset"/>
+  <input type="reset" value="exact value reset" data="exact-value-reset"/>
+  <input type="reset" title="My reset title" value="reset-with-title" data="title-reset">
+  <input type="reset" title="Exact reset title" value="exact title reset" data="exact-title-reset">
+  <input type="reset" title="Not Exact reset title" value="exact title reset" data="not-exact-title-reset">
+  
   <input type="button" id="button-with-id" data="id-button" value="Has ID"/>
   <input type="button" value="button-with-value" data="value-button"/>
   <input type="button" value="not exact value button" data="not-exact-value-button"/>
@@ -46,10 +54,10 @@
   <input type="image" title="Not Exact imgbut title" value="not exact title imgbut" data="not-exact-title-imgbut">
   <input type="image" title="Exact imgbut title" value="exact title imgbut" data="exact-title-imgbut">
 
-  <button id="btag-with-id" data="id-btag" value="Has ID"/>
-  <button value="btag-with-value" data="value-btag"/>
-  <button value="not exact value btag" data="not-exact-value-btag"/>
-  <button value="exact value btag" data="exact-value-btag"/>
+  <button id="btag-with-id" data="id-btag" value="Has ID"></button>
+  <button value="btag-with-value" data="value-btag"></button>
+  <button value="not exact value btag" data="not-exact-value-btag"></button>
+  <button value="exact value btag" data="exact-value-btag"></button>
 
   <button data="text-btag">btag-with-text</button>
   <button data="not-exact-text-btag">not exact text btag</button>
@@ -77,16 +85,30 @@
   <fieldset data="fieldset-legend-span"><legend><span>Span Legend</span></legend></fieldset>
   <fieldset data="fieldset-fuzzy"><legend>Long legend yo</legend></fieldset>
   <fieldset data="fieldset-exact"><legend>Long legend</legend></fieldset>
+  <fieldset data="fieldset-outer"><legend>Outer legend</legend>
+    <fieldset data="fieldset-inner"><legend>Inner legend</legend></fieldset>
+  </fieldset>
 </p>
 
 <p>
   <select>
     <optgroup label="Group A" data="optgroup-a"></optgroup>
     <optgroup label="Group B" data="optgroup-b"></optgroup>
+    <option data="option-with-text-data">Option with text</option>
   </select>
 </p>
 
-<p>
+<h2>Tables</h2>
+
+  <table id="table-with-id" data="table-with-id-data">
+    <tr><td>First</td><td>Second</td></tr>
+  </table>
+
+  <table data="table-with-caption-data">
+    <caption>Table with caption</caption>
+    <tr><td>First</td><td>Second</td></tr>
+  </table>
+
   <table id="whitespaced-table" data="table-with-whitespace">
     <tr>
       <td data="cell-whitespaced">I have
@@ -95,7 +117,7 @@
       <td>I don't</td>
     </tr>
   </table>
-</p>
+
 
 <p>
   <h2>Fields</h2>
@@ -103,6 +125,7 @@
   <h4>With id</h4>
   <input id="input-with-id" value="correct-value" data="input-with-id-data"/>
   <input type="text" id="input-text-with-id" data="input-text-with-id-data"/>
+  <input type="file" id="input-file-with-id" data="input-file-with-id-data"/>
   <input type="password" id="input-password-with-id" data="input-password-with-id-data"/>
   <input type="custom" id="input-custom-with-id" data="input-custom-with-id-data"/>
   <textarea id="textarea-with-id" data="textarea-with-id-data">Correct value</textarea>
@@ -110,10 +133,13 @@
   <input type="submit" id="input-submit-with-id" data="input-submit-with-id-data"/>
   <input type="image" id="input-image-with-id" data="input-image-with-id-data"/>
   <input type="hidden" id="input-hidden-with-id" data="input-hidden-with-id-data"/>
+  <input type="checkbox" id="input-checkbox-with-id" data="input-checkbox-with-id-data"/>
+  <input type="radio" id="input-radio-with-id" data="input-radio-with-id-data"/>
 
   <h4>With name</h4>
   <input name="input-with-name" data="input-with-name-data"/>
   <input type="text" name="input-text-with-name" data="input-text-with-name-data"/>
+  <input type="file" name="input-file-with-name" data="input-file-with-name-data"/>
   <input type="password" name="input-password-with-name" data="input-password-with-name-data"/>
   <input type="custom" name="input-custom-with-name" data="input-custom-with-name-data"/>
   <textarea name="textarea-with-name" data="textarea-with-name-data"></textarea>
@@ -121,10 +147,21 @@
   <input type="submit" name="input-submit-with-name" data="input-submit-with-name-data"/>
   <input type="image" name="input-image-with-name" data="input-image-with-name-data"/>
   <input type="hidden" name="input-hidden-with-name" data="input-hidden-with-name-data"/>
+  <input type="checkbox" name="input-checkbox-with-name" data="input-checkbox-with-name-data"/>
+  <input type="radio" name="input-radio-with-name" data="input-radio-with-name-data"/>
+
+  <h4>With placeholder</h4>
+  <input name="input-with-placeholder" data="input-with-placeholder-data"/>
+  <input type="text" placeholder="input-text-with-placeholder" data="input-text-with-placeholder-data"/>
+  <input type="password" placeholder="input-password-with-placeholder" data="input-password-with-placeholder-data"/>
+  <input type="custom" placeholder="input-custom-with-placeholder" data="input-custom-with-placeholder-data"/>
+  <textarea placeholder="textarea-with-placeholder" data="textarea-with-placeholder-data"></textarea>
+  <input type="hidden" placeholder="input-hidden-with-placeholder" data="input-hidden-with-placeholder-data"/>
 
   <h4>With referenced label</h4>
   <label for="input-with-label">Input with label</label><input id="input-with-label" data="input-with-label-data"/>
   <label for="input-text-with-label">Input text with label</label><input type="text" id="input-text-with-label" data="input-text-with-label-data"/>
+  <label for="input-file-with-label">Input file with label</label><input type="file" id="input-file-with-label" data="input-file-with-label-data"/>
   <label for="input-password-with-label">Input password with label</label><input type="password" id="input-password-with-label" data="input-password-with-label-data"/>
   <label for="input-custom-with-label">Input custom with label</label><input type="custom" id="input-custom-with-label" data="input-custom-with-label-data"/>
   <label for="textarea-with-label">Textarea with label</label><textarea id="textarea-with-label" data="textarea-with-label-data"></textarea>
@@ -132,10 +169,13 @@
   <label for="input-submit-with-label">Input submit with label</label><input type="submit" id="input-submit-with-label" data="input-submit-with-label-data"/>
   <label for="input-image-with-label">Input image with label</label><input type="image" id="input-image-with-label" data="input-image-with-label-data"/>
   <label for="input-hidden-with-label">Input hidden with label</label><input type="hidden" id="input-hidden-with-label" data="input-hidden-with-label-data"/>
+  <label for="input-checkbox-with-label">Input checkbox with label</label><input type="checkbox" id="input-checkbox-with-label" data="input-checkbox-with-label-data"/>
+  <label for="input-radio-with-label">Input radio with label</label><input type="radio" id="input-radio-with-label" data="input-radio-with-label-data"/>
 
   <h4>With parent label</h4>
   <label>Input with parent label<input data="input-with-parent-label-data"/></label>
   <label>Input text with parent label<input type="text" data="input-text-with-parent-label-data"/></label>
+  <label>Input file with parent label<input type="file" data="input-file-with-parent-label-data"/></label>
   <label>Input password with parent label<input type="password" data="input-password-with-parent-label-data"/></label>
   <label>Input custom with parent label<input type="custom" data="input-custom-with-parent-label-data"/></label>
   <label>Textarea with parent label<textarea data="textarea-with-parent-label-data"></textarea></label>
@@ -143,4 +183,6 @@
   <label>Input submit with parent label<input type="submit" data="input-submit-with-parent-label-data"/></label>
   <label>Input image with parent label<input type="image" data="input-image-with-parent-label-data"/></label>
   <label>Input hidden with parent label<input type="hidden" data="input-hidden-with-parent-label-data"/></label>
+  <label>Input checkbox with parent label<input type="checkbox" data="input-checkbox-with-parent-label-data"/></label>
+  <label>Input radio with parent label<input type="radio" data="input-radio-with-parent-label-data"/></label>
 </p>