watir-webdriver 0.7.0 → 0.8.0

data/lib/watir-webdriver/generator/html/spec_extractor.rb

@@ -0,0 +1,50 @@
+module Watir
+  module Generator
+    class HTML::SpecExtractor < Base::SpecExtractor
+
+      private
+
+      def extract_interface_map
+        # http://www.whatwg.org/specs/web-apps/current-work/#elements-1
+        table = @doc.search("//h3[@id='elements-3']/following-sibling::table[1]").first
+        table or raise "could not find elements-3 table"
+
+        @interface_map = {}
+
+        parse_table(table).each do |row|
+          row['Element'].split(", ").each { |tag| @interface_map[tag] = row['Interface'] }
+        end
+      end
+
+      def build_result
+        {}.tap do |result|
+          @interface_map.each do |tag, interface|
+            result[tag] = fetch_interface(interface)
+          end
+
+          # missing from the elements-1 table
+          result['frameset'] = fetch_interface('HTMLFrameSetElement')
+        end
+      end
+
+      def parse_table(table)
+        headers = table.css("thead th").map { |e| e.inner_text.strip }
+
+        table.css("tbody tr").map do |row|
+          result = {}
+
+          row.css("th, td").each_with_index do |node, idx|
+            result[headers[idx]] = node.inner_text.strip
+          end
+
+          result
+        end
+      end
+
+      def issued_interfaces
+        []
+      end
+
+    end # HTML:;SpecExtractor
+  end # Generator
+end # Watir

data/lib/watir-webdriver/generator/html/visitor.rb

@@ -0,0 +1,21 @@
+module Watir
+  module Generator
+    class HTML::Visitor < Base::Visitor
+
+      def classify_regexp
+        /^HTML(.+)Element$/
+      end
+
+      private
+
+      def interface_regexp
+        /^HTML/
+      end
+
+      def force_inheritance
+        { 'HTMLElement' => 'Element' }
+      end
+
+    end # HTML::Visitor
+  end # Generator
+end # Watir

data/lib/watir-webdriver/generator/svg.rb

@@ -0,0 +1,7 @@
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.plural 'defs', 'defss'
+end
+
+require "watir-webdriver/generator/svg/generator"
+require "watir-webdriver/generator/svg/spec_extractor"
+require "watir-webdriver/generator/svg/visitor"

data/lib/watir-webdriver/generator/svg/generator.rb

@@ -0,0 +1,38 @@
+module Watir
+  module Generator
+    class SVG < Base
+
+      private
+
+      # fix collisions with HTML
+      #
+      # TODO: change generator so instead these classes
+      # are inherited from HTML ones
+
+      def ignored_tags
+        %w(a audio canvas iframe image script source style text title track video)
+      end
+
+      def ignored_interfaces
+        ignored_tags.map { |tag| "SVG#{tag.capitalize}Element" }
+      end
+
+      def ignored_attributes
+        []
+      end
+
+      def generator_implementation
+        'SVG'
+      end
+
+      def visitor_class
+        SVG::Visitor
+      end
+
+      def extractor_class
+        SVG::SpecExtractor
+      end
+
+    end # SVG
+  end # Generator
+end # Watir

data/lib/watir-webdriver/generator/svg/spec_extractor.rb

@@ -0,0 +1,46 @@
+module Watir
+  module Generator
+    class SVG::SpecExtractor < Base::SpecExtractor
+
+      private
+
+      def extract_interface_map
+        list = @doc.search("//div[@id='chapter-eltindex']//ul/li")
+        list.any? or raise 'could not find elements list'
+
+        @interface_map = parse_list(list)
+      end
+
+      def build_result
+        {}.tap do |result|
+          @interface_map.each do |tag, interface|
+            result[tag] = fetch_interface(interface)
+          end
+        end
+      end
+
+      def parse_list(list)
+        {}.tap do |result|
+          list.each do |node|
+            tag_name = node.css('a span').inner_text.strip
+            id = node.css('a').attr('href').to_s
+
+            # Some interfaces are actually defined in different specs
+            # (for example, clipPath), so we ignore them for now
+            if id =~ /^#.+/
+              interface_css = 'div.element-summary a.idlinterface'
+              interface_name = @doc.css("#{id} #{interface_css}, #{id} ~ #{interface_css}").first.inner_text.strip
+
+              result[tag_name] = interface_name
+            end
+          end
+        end
+      end
+
+      def issued_interfaces
+        %w(SVGHatchElement SVGHatchPathElement SVGSolidColorElement)
+      end
+
+    end # SVG::SpecExtractor
+  end # Generator
+end # Watir

data/lib/watir-webdriver/generator/svg/visitor.rb

@@ -0,0 +1,21 @@
+module Watir
+  module Generator
+    class SVG::Visitor < Base::Visitor
+
+      def classify_regexp
+        /^SVG(.+)Element$/
+      end
+
+      private
+
+      def interface_regexp
+        /^SVG.*Element$/
+      end
+
+      def force_inheritance
+        { 'SVGElement' => 'HTMLElement' }
+      end
+
+    end # SVG::Visitor
+  end # Generator
+end # Watir

data/lib/watir-webdriver/has_window.rb

@@ -5,13 +5,13 @@ module Watir
     # Returns browser windows array.
     #
     # @example
-    #   browser.windows(:title => 'closeable window')
+    #   browser.windows(title: 'closeable window')
     #
     # @return [Array<Window>]
     #
 
     def windows(*args)
-      all = @driver.window_handles.map { |handle| Window.new(@driver, :handle => handle) }
+      all = @driver.window_handles.map { |handle| Window.new(@driver, handle: handle) }
 
       if args.empty?
         all
@@ -24,7 +24,7 @@ module Watir
     # Returns browser window.
     #
     # @example
-    #   browser.window(:title => 'closeable window')
+    #   browser.window(title: 'closeable window')
     #
     # @return [Window]
     #

data/lib/watir-webdriver/locators/button_locator.rb

@@ -10,7 +10,7 @@ module Watir
     def wd_find_first_by(how, what)
       if how == :tag_name
         how  = :xpath
-        what = ".//button | .//input[#{attribute_expression :type => Button::VALID_TYPES}]"
+        what = ".//button | .//input[#{attribute_expression type: Button::VALID_TYPES}]"
       end
 
       super
@@ -33,7 +33,7 @@ module Watir
       xpath << " | .//input"
       xpath << "[#{input_attr_exp}]"
 
-      p :build_wd_selector => xpath if $DEBUG
+      p build_wd_selector: xpath if $DEBUG
 
       [:xpath, xpath]
     end
@@ -67,6 +67,11 @@ module Watir
       end
     end
 
+    def can_convert_regexp_to_contains?
+      # regexp conversion won't work with the complex xpath selector
+      false
+    end
+
     def tag_name_matches?(tag_name, _)
       !!(/^(input|button)$/ === tag_name)
     end

data/lib/watir-webdriver/locators/child_cell_locator.rb

@@ -23,7 +23,7 @@ module Watir
 
       xpath = expressions.join(" | ")
 
-      p :build_wd_selector => xpath if $DEBUG
+      p build_wd_selector: xpath if $DEBUG
 
       [:xpath, xpath]
     end

data/lib/watir-webdriver/locators/child_row_locator.rb

@@ -28,7 +28,7 @@ module Watir
 
       xpath = expressions.join(" | ")
 
-      p :build_wd_selector => xpath if $DEBUG
+      p build_wd_selector: xpath if $DEBUG
 
       [:xpath, xpath]
     end

data/lib/watir-webdriver/locators/element_locator.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Watir
   class ElementLocator
     include Watir::Exception
@@ -18,6 +17,17 @@ module Watir
 
     WILDCARD_ATTRIBUTE = /^(aria|data)_(.+)$/
 
+    # Regular expressions that can be reliably converted to xpath `contains`
+    # expressions in order to optimize the locator.
+    #
+    CONVERTABLE_REGEXP = %r{
+      \A
+      ([^\[\]\\^$.|?*+()]*) # leading literal characters
+      [^|]*?                # do not try to convert expressions with alternates
+      ([^\[\]\\^$.|?*+()]*) # trailing literal characters
+      \z
+    }x
+
     def initialize(wd, selector, valid_attributes)
       @wd               = wd
       @selector         = selector.dup
@@ -100,7 +110,7 @@ module Watir
     def find_all_by_multiple
       selector = normalized_selector
 
-      if selector.has_key? :index
+      if selector.key? :index
         raise ArgumentError, "can't locate all elements by :index"
       end
 
@@ -132,7 +142,7 @@ module Watir
       parent = @wd
       rx_selector = delete_regexps_from(selector)
 
-      if rx_selector.has_key?(:label) && should_use_label_element?
+      if rx_selector.key?(:label) && should_use_label_element?
         label = label_from_text(rx_selector.delete(:label)) || return
         if (id = label.attribute(:for))
           selector[:id] = id
@@ -147,6 +157,15 @@ module Watir
         raise Error, "internal error: unable to build WebDriver selector from #{selector.inspect}"
       end
 
+      if how == :xpath && can_convert_regexp_to_contains?
+        rx_selector.each do |key, value|
+          next if key == :tag_name || key == :text
+
+          predicates = regexp_selector_to_predicates(key, value)
+          what = "(#{what})[#{predicates.join(' and ')}]" unless predicates.empty?
+        end
+      end
+
       elements = parent.find_elements(how, what)
       elements.__send__(method) { |el| matches_selector?(el, rx_selector) }
     end
@@ -169,7 +188,7 @@ module Watir
     def label_from_text(label_exp)
       # TODO: this won't work correctly if @wd is a sub-element
       @wd.find_elements(:tag_name, 'label').find do |el|
-        matches_selector?(el, :text => label_exp)
+        matches_selector?(el, text: label_exp)
       end
     end
 
@@ -233,6 +252,22 @@ module Watir
       rx_selector
     end
 
+    def regexp_selector_to_predicates(key, re)
+      return [] if re.casefold?
+
+      match = re.source.match(CONVERTABLE_REGEXP)
+      return [] unless match
+
+      lhs = lhs_for(key)
+      match.captures.reject(&:empty?).map do |literals|
+        "contains(#{lhs}, #{XpathSupport.escape(literals)})"
+      end
+    end
+
+    def can_convert_regexp_to_contains?
+      true
+    end
+
     def assert_valid_as_attribute(attribute)
       unless valid_attribute? attribute or attribute.to_s =~ WILDCARD_ATTRIBUTE
         raise MissingWayOfFindingObjectException, "invalid attribute: #{attribute.inspect}"
@@ -255,7 +290,7 @@ module Watir
     end
 
     def all_elements
-      @wd.find_elements(:xpath => ".//*")
+      @wd.find_elements(xpath: ".//*")
     end
 
     def tag_name_matches?(element_tag_name, tag_name)
@@ -287,7 +322,7 @@ module Watir
         xpath << "[" << attribute_expression(selectors) << "]"
       end
 
-      p :xpath => xpath, :selectors => selectors if $DEBUG
+      p xpath: xpath, selectors: selectors if $DEBUG
 
       [:xpath, xpath]
     end
@@ -327,15 +362,15 @@ module Watir
     def use_css?(selectors)
       return false unless Watir.prefer_css?
 
-      if selectors.has_key?(:text) || selectors.has_key?(:label) || selectors.has_key?(:index)
+      if selectors.key?(:text) || selectors.key?(:label) || selectors.key?(:index)
         return false
       end
 
-      if selectors[:tag_name] == 'input' && selectors.has_key?(:type)
+      if selectors[:tag_name] == 'input' && selectors.key?(:type)
         return false
       end
 
-      if selectors.has_key?(:class) && selectors[:class] !~ /^[\w-]+$/ui
+      if selectors.key?(:class) && selectors[:class] !~ /^[\w-]+$/ui
         return false
       end
 

data/lib/watir-webdriver/locators/text_area_locator.rb

@@ -3,6 +3,10 @@ module Watir
 
     private
 
+    def can_convert_regexp_to_contains?
+      false
+    end
+
     def normalize_selector(how, what)
       # We need to iterate through located elements and fetch
       # attribute value using WebDriver because XPath doesn't understand

data/lib/watir-webdriver/locators/text_field_locator.rb

@@ -5,6 +5,11 @@ module Watir
     # TODO: better way of finding input text fields?
     NEGATIVE_TYPE_EXPR = NON_TEXT_TYPES.map { |type| "%s!=%s" % [XpathSupport.downcase('@type'), type.inspect] }.join(' and ')
 
+    def wd_find_first_by(how, what)
+      how, what = build_wd_selector(how => what) if how == :tag_name
+      super
+    end
+
     def locate_all
       find_all_by_multiple
     end
@@ -28,7 +33,7 @@ module Watir
       xpath << "| .//textarea"
       xpath << "[#{textarea_attr_exp}]" unless textarea_attr_exp.empty?
 
-      p :build_wd_selector => xpath if $DEBUG
+      p build_wd_selector: xpath if $DEBUG
 
       [:xpath, xpath]
     end
@@ -49,7 +54,7 @@ module Watir
       tag_name = element.tag_name.downcase
 
       [:text, :value, :label].each do |key|
-        if rx_selector.has_key?(key)
+        if rx_selector.key?(key)
           correct_key = tag_name == 'input' ? :value : :text
           rx_selector[correct_key] = rx_selector.delete(key)
         end

data/lib/watir-webdriver/screenshot.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Watir
   class Screenshot
 

data/lib/watir-webdriver/version.rb

@@ -1,3 +1,3 @@
 module Watir
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/lib/watir-webdriver/wait.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 require 'forwardable'
 require 'watir-webdriver/wait/timer'
 
@@ -29,7 +28,7 @@ module Watir
       # Waits until the block evaluates to true or times out.
       #
       # @example
-      #   Watir::Wait.until { browser.text_field(:name => "new_user_first_name").visible? }
+      #   Watir::Wait.until { browser.text_field(name: "new_user_first_name").visible? }
       #
       # @param [Fixnum] timeout How long to wait in seconds
       # @param [String] message Message to raise if timeout is exceeded
@@ -37,6 +36,7 @@ module Watir
       #
 
       def until(timeout = nil, message = nil)
+        timeout ||= Watir.default_timeout
         run_with_timer(timeout) { return true if yield(self) }
         raise TimeoutError, message_for(timeout, message)
       end
@@ -45,7 +45,7 @@ module Watir
       # Wait while the block evaluates to true or times out.
       #
       # @example
-      #   Watir::Wait.while { browser.text_field(:name => "abrakadbra").present? }
+      #   Watir::Wait.while { browser.text_field(name: "abrakadbra").present? }
       #
       # @param [Fixnum] timeout How long to wait in seconds
       # @param [String] message Message to raise if timeout is exceeded
@@ -53,6 +53,7 @@ module Watir
       #
 
       def while(timeout = nil, message = nil)
+        timeout ||= Watir.default_timeout
         run_with_timer(timeout) { return unless yield(self) }
         raise TimeoutError, message_for(timeout, message)
       end
@@ -66,9 +67,7 @@ module Watir
         err
       end
 
-      def run_with_timer(timeout = nil, &block)
-        timeout ||= Watir.default_timeout
-
+      def run_with_timer(timeout, &block)
         if timeout == 0
           block.call
         else
@@ -134,9 +133,9 @@ module Watir
     # Waits until the element is present.
     #
     # @example
-    #   browser.text_field(:name => "new_user_first_name").when_present.click
-    #   browser.text_field(:name => "new_user_first_name").when_present { |field| field.set "Watir" }
-    #   browser.text_field(:name => "new_user_first_name").when_present(60).text
+    #   browser.text_field(name: "new_user_first_name").when_present.click
+    #   browser.text_field(name: "new_user_first_name").when_present { |field| field.set "Watir" }
+    #   browser.text_field(name: "new_user_first_name").when_present(60).text
     #
     # @param [Fixnum] timeout seconds to wait before timing out
     #
@@ -160,7 +159,7 @@ module Watir
     # Waits until the element is present.
     #
     # @example
-    #   browser.text_field(:name => "new_user_first_name").wait_until_present
+    #   browser.text_field(name: "new_user_first_name").wait_until_present
     #
     # @param [Fixnum] timeout seconds to wait before timing out
     #
@@ -178,7 +177,7 @@ module Watir
     # Waits while the element is present.
     #
     # @example
-    #   browser.text_field(:name => "abrakadbra").wait_while_present
+    #   browser.text_field(name: "abrakadbra").wait_while_present
     #
     # @param [Fixnum] timeout seconds to wait before timing out
     #