watir-webdriver 0.0.1.dev3 → 0.0.1.dev4

data/README.rdoc

@@ -3,6 +3,10 @@
 Watir implementation built on WebDriver's Ruby bindings.
 See http://rubyforge.org/pipermail/wtr-development/2009-October/001313.html.
 
+= API docs
+
+http://jarib.github.com/watir-webdriver/doc/
+
 = Description
 
 The file in lib/watir/elements/generated.rb is autogenerated from the HTML5 spec. This is done by extracting the IDL parts from the spec and processing them with the WebIDL gem (link below).
@@ -29,4 +33,4 @@ The file in lib/watir/elements/generated.rb is autogenerated from the HTML5 spec
 
 == Copyright
 
-Copyright (c) 2009 Jari Bakken. See LICENSE for details.
+Copyright (c) 2009-2010 Jari Bakken. See LICENSE for details.

data/Rakefile

@@ -97,10 +97,10 @@ task :default => :spec
 
 begin
   require 'yard'
-  require 'support/yard/handlers/attributes_handler'
+  require 'support/yard_handlers'
   YARD::Rake::YardocTask.new
 rescue LoadError
-  task :yardoc do
+  task :yard do
     abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
   end
 end

data/VERSION

@@ -1 +1 @@
-0.0.1.dev3
+0.0.1.dev4

data/lib/watir-webdriver/base_element.rb

@@ -295,6 +295,10 @@ module Watir
       end
     end
 
+    def browser
+      @parent.browser
+    end
+
   private
 
     def selector_string

data/lib/watir-webdriver/browser.rb

@@ -15,6 +15,13 @@ module Watir
       end
     end
 
+    #
+    # Create a Watir::Browser instance
+    #
+    # @param [:firefox, :ie, :chrome, :remote] browser
+    # @param args Passed to the underlying driver
+    #
+
     def initialize(browser, *args)
       case browser
       when Symbol, String
@@ -32,8 +39,15 @@ module Watir
       '#<%s:0x%x url=%s title=%s>' % [self.class, hash*2, url.inspect, title.inspect]
     end
 
+    #
+    # Goto the given URL
+    #
+    # @param [String] uri The url.
+    # @return [String] The url you end up at.
+    #
+
     def goto(uri)
-      uri = "http://#{uri}" unless uri.include?("://")
+      uri = "http://#{uri}" unless uri.include?("://") || uri =~ /^\w+:/
 
       @driver.navigate.to uri
       run_checkers
@@ -82,10 +96,6 @@ module Watir
       @driver.navigate.refresh
     end
 
-    def exist?
-      true
-    end
-
     def status
       execute_script "return window.status;"
     end
@@ -119,6 +129,8 @@ module Watir
       @error_checkers.each { |e| e[self] }
     end
 
+    #
+    # Protocol shared with BaseElement
     #
     # @api private
     #
@@ -127,5 +139,13 @@ module Watir
       true # TODO: assert browser is open
     end
 
+    def exist?
+      true
+    end
+
+    def browser
+      self
+    end
+
   end # Browser
 end # Watir

data/lib/watir-webdriver/browserbot.js

@@ -1,10 +1,10 @@
 // stolen from injectableSelenium.js in WebDriver
-
 var browserbot = {
 
-    triggerEvent : function(element, eventType, canBubble, controlKeyDown, altKeyDown, shiftKeyDown, metaKeyDown) {
-        canBubble = (typeof(canBubble) == undefined) ? true : canBubble;
-        if (element.fireEvent && element.ownerDocument && element.ownerDocument.createEventObject) { // IE
+    triggerEvent: function(element, eventType, canBubble, controlKeyDown, altKeyDown, shiftKeyDown, metaKeyDown) {
+        canBubble = (typeof(canBubble) == undefined) ? true: canBubble;
+        if (element.fireEvent && element.ownerDocument && element.ownerDocument.createEventObject) {
+            // IE
             var evt = this.createEventObject(element, controlKeyDown, altKeyDown, shiftKeyDown, metaKeyDown);
             element.fireEvent('on' + eventType, evt);
         } else {
@@ -15,16 +15,16 @@ var browserbot = {
                 evt.metaKey = metaKeyDown;
                 evt.altKey = altKeyDown;
                 evt.ctrlKey = controlKeyDown;
-            } catch (e) {
+            } catch(e) {
                 // Nothing sane to do
-            }
+                }
 
             evt.initEvent(eventType, canBubble, true);
             element.dispatchEvent(evt);
         }
     },
 
-    getVisibleText : function() {
+    getVisibleText: function() {
         var selection = getSelection();
         var range = document.createRange();
         range.selectNodeContents(document.documentElement);
@@ -32,14 +32,14 @@ var browserbot = {
         return selection.toString();
     },
 
-    getOuterHTML : function(element) {
-          if(element.outerHTML) {
+    getOuterHTML: function(element) {
+        if (element.outerHTML) {
             return element.outerHTML;
-          } else if (typeof(XMLSerializer) != undefined) {
-              return new XMLSerializer().serializeToString(element);
-          } else {
-              throw "can't get outerHTML in this browser";
-          }
+        } else if (typeof(XMLSerializer) != undefined) {
+            return new XMLSerializer().serializeToString(element);
+        } else {
+            throw "can't get outerHTML in this browser";
+        }
     }
 
 

data/lib/watir-webdriver/collections/buttons_collection.rb

@@ -1,6 +1,8 @@
 module Watir
   class ButtonsCollection < ElementCollection
 
+    private
+
     def elements
       @elements ||= ButtonLocator.new(
         @parent.wd,

data/lib/watir-webdriver/collections/element_collection.rb

@@ -12,7 +12,7 @@ module Watir
     end
 
     def length
-      to_a.length
+      elements.length
     end
     alias_method :size, :length
 
@@ -20,19 +20,39 @@ module Watir
       to_a[idx] || @element_class.new(@parent, :index, idx)
     end
 
+    #
+    # First element of this collection
+    #
+    # @return Watir::BaseElement
+    #
+
     def first
       to_a[0] || @element_class.new(@parent, :index, 0)
     end
 
+    #
+    # Last element of the collection
+    #
+    # @return Watir::BaseElement
+    #
+
     def last
       to_a[-1] || @element_class.new(@parent, :index, -1)
     end
 
+    #
+    # This collection as an Array
+    #
+    # @return [Array<Watir::BaseElement>]
+    #
+
     def to_a
       # TODO: optimize - lazily @element_class instance
       @to_a ||= elements.map { |e| @element_class.new(@parent, :element, e) }
     end
 
+    private
+
     def elements
       @elements ||= ElementLocator.new(
         @parent.wd,

data/lib/watir-webdriver/collections/table_rows_collection.rb

@@ -1,6 +1,8 @@
 module Watir
   class TrsCollection < ElementCollection
 
+    private
+
     def elements
       return super unless @parent.kind_of?(Watir::Table)
       @elements ||= TableRowLocator.new(

data/lib/watir-webdriver/collections/text_fields_collection.rb

@@ -1,6 +1,8 @@
 module Watir
   class TextFieldsCollection < ElementCollection
 
+    private
+
     def elements
       @elements ||= TextFieldLocator.new(
         @parent.wd,

data/lib/watir-webdriver/container.rb

@@ -2,6 +2,11 @@
 module Watir
   module Container
     class << self
+
+      #
+      # @api private
+      #
+
       def add(method, &blk)
         define_method(method, &blk)
       end

data/lib/watir-webdriver/elements/generated.rb

@@ -52,15 +52,15 @@ module Watir
     attributes(:html_collection => ([:options]))
   end
 
-  class Object < HTMLElement
-    identifier(:tag_name => "object")
-
-    container_method(:object)
-
-    collection_method(:objects)
-
-    attributes(:string => ([:data, :type, :name, :use_map, :width, :height, :content_window, :validity, :validation_message]), :document => ([:content_document]), :html_element => ([:form]), :bool => ([:will_validate]))
-  end
+  # class Object < HTMLElement
+  #   identifier(:tag_name => "object")
+  #
+  #   container_method(:object)
+  #
+  #   collection_method(:objects)
+  #
+  #   attributes(:string => ([:data, :type, :name, :use_map, :width, :height, :content_window, :validity, :validation_message]), :document => ([:content_document]), :html_element => ([:form]), :bool => ([:will_validate]))
+  # end
 
   class DList < HTMLElement
     identifier(:tag_name => "dl")

data/lib/watir-webdriver/elements/select_list.rb

@@ -12,7 +12,9 @@ module Watir
 
     def clear
       assert_exists
-      raise "you can only clear multi-selects" unless multiple?
+
+      raise Error, "you can only clear multi-selects" unless multiple?
+
       options.each do |o|
         o.toggle if o.selected?
       end
@@ -24,17 +26,16 @@ module Watir
     end
 
     def select(str_or_rx)
-      select_by :text, str_or_rx
+        select_by :text, str_or_rx, multiple?
     end
 
-    # TODO: deprecate?
     def select_value(str_or_rx)
-      select_by :value, str_or_rx
+      select_by :value, str_or_rx, multiple?
     end
 
     def selected?(str_or_rx)
       assert_exists
-      matches = options.select { |e| str_or_rx === e.text }
+      matches = @element.find_elements(:tag_name, 'option').select { |e| str_or_rx === e.text || str_or_rx === e.attribute(:label) }
 
       if matches.empty?
         raise UnknownObjectException, "Unable to locate option matching #{str_or_rx.inspect}"
@@ -57,17 +58,90 @@ module Watir
 
     private
 
-    def select_by(how, str_or_rx)
-      assert_exists
-      os = options.select { |e| str_or_rx === e.send(how) }
+    def select_by(how, str_or_rx, multiple)
+      case str_or_rx
+      when String
+        select_by_string(how, str_or_rx, multiple)
+      when Regexp
+        select_by_regexp(how, str_or_rx, multiple)
+      else
+        raise ArgumentError, "expected String or Regexp, got #{str_or_rx.inspect}:#{str_or_rx.class}"
+      end
+    end
+
+    def select_by_string(how, string, multiple)
+      xpath = option_xpath_for(how, string)
+      if multiple
+        elements = @element.find_elements(:xpath, xpath)
+
+        if elements.empty?
+          raise NoValueFoundException, "#{string.inspect} not found in select list"
+        end
+
+        elements.each { |e| e.select unless e.selected? }
+        elements.first.text
+      else
+        begin
+          e = @element.find_element(:xpath, xpath)
+        rescue WebDriver::Error::WebDriverError # should be more specific
+          raise NoValueFoundException, "#{string.inspect} not found in select list"
+        end
+
+        e.select unless e.selected?
+        e.text
+      end
+    end
 
-      if os.empty?
-        raise NoValueFoundException, "#{str_or_rx.inspect} not found in select list"
+    def select_by_regexp(how, exp, multiple)
+      elements = @element.find_elements(:tag_name, 'option')
+      if elements.empty?
+        raise NoValueFoundException, "no options in select list"
       end
 
-      os.each { |e| e.select unless e.selected? }
-      os.first.text
+      if multiple
+        found = elements.select do |e|
+          next unless matches_regexp?(how, e, exp)
+          e.select unless e.selected?
+          true
+        end
+
+        if found.empty?
+          raise NoValueFoundException, "#{exp.inspect} not found in select list"
+        end
+
+        found.first.text
+      else
+        element = elements.find { |e| matches_regexp?(how, e, exp) }
+        unless element
+          raise NoValueFoundException, "#{exp.inspect} not found in select list"
+        end
+
+        element.select unless element.selected?
+        element.text
+      end
+    end
+
+    def option_xpath_for(how, string)
+      case how
+      when :text
+        "//option[normalize-space()=#{string.inspect} or @label=#{string.inspect}]"
+      when :value
+        "//option[@value=#{string.inspect}]"
+      else
+        raise Error, "unknown how: #{how.inspect}"
+      end
+    end
+
+    def matches_regexp?(how, element, exp)
+      case how
+      when :text
+        element.text =~ exp || element.attribute(:label) =~ exp
+      when :value
+        element.attribute(:value) =~ exp
+      else
+        raise Error, "unknown how: #{how.inspect}"
+      end
     end
 
-  end
-end
+  end # SelectList
+end # Watir

data/lib/watir-webdriver/elements/text_field.rb

@@ -2,7 +2,6 @@
 module Watir
   class TextField < Input
 
-    # perhaps we'll need a custom locate(), since this should also cover textareas
     attributes Watir::TextArea.typed_attributes
     def type; super; end # hacky, but we want Input#type here, which was overriden by TextArea's attributes
 

data/support/yard_handlers.rb

@@ -0,0 +1,87 @@
+# require "ruby-debug"
+require "#{File.dirname(__FILE__)}/../lib/watir-webdriver/core_ext/string"
+
+module YARD
+  module Watir
+    class AttributesHandler < YARD::Handlers::Ruby::Base
+      handles method_call(:attributes)
+
+      TYPES = {
+        :string => "String",
+        :bool => "Boolean",
+        :int => "Integer"
+      }
+
+      def process
+        attributes = try_eval
+
+        if attributes.nil?
+          p :ignoring => statement.source, :in => namespace.to_s
+          return
+        end
+
+        TYPES.each do |type, return_type|
+          if attributes.member? type
+            create_attributes attributes[type], return_type
+          end
+        end
+      end
+
+      private
+
+      def create_attributes(names, return_type)
+        names.each do |attribute_name|
+          p :adding => "#{namespace}##{attribute_name}"
+          attribute_name = "#{attribute_name}?".to_sym if return_type == "Boolean"
+          register MethodObject.new(namespace, attribute_name, scope) do |o|
+            o.visibility = :public
+            o.explicit   = false
+            o.docstring.add_tag YARD::Tags::Tag.new(:return, "", return_type)
+          end
+        end
+      end
+
+      def try_eval
+        eval "{#{statement.parameters.source}}"
+      rescue SyntaxError, StandardError
+        nil
+      end
+
+    end # AttributesHandler
+
+    class ContainerMethodHandler < YARD::Handlers::Ruby::Base
+      handles method_call(:container_method)
+
+      def process
+        name = statement.parameters.flatten.first
+        return_type = namespace.to_s
+        p :adding => "Watir::Container##{name}"
+
+        register MethodObject.new(P("Watir::Container"), name, :instance) do |o|
+          o.docstring.add_tag(YARD::Tags::Tag.new(:return, "", return_type))
+        end
+      end
+    end # ContainerMethodHandler
+
+    class CollectionMethodHandler < YARD::Handlers::Ruby::Base
+      handles method_call(:collection_method)
+
+      def process
+        name = statement.parameters.flatten.first
+        p :adding => "Watir::Container##{name}"
+
+        class_name  = "#{name.to_s.camel_case}Collection"
+        return_type = "Watir::#{class_name}"
+
+        register MethodObject.new(P("Watir::Container"), name, :instance) do |o|
+          o.docstring.add_tag(YARD::Tags::Tag.new(:return, "", return_type))
+        end
+
+        register ClassObject.new(P("Watir"), class_name) do |o|
+          o.superclass = "Watir::ElementCollection"
+        end
+      end
+    end # CollectionMethodHandler
+
+  end # Watir
+end # YARD

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: watir-webdriver
 version: !ruby/object:Gem::Version 
-  version: 0.0.1.dev3
+  version: 0.0.1.dev4
 platform: ruby
 authors: 
 - Jari Bakken
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-21 00:00:00 +01:00
+date: 2010-01-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -102,13 +102,12 @@ files:
 - lib/watir-webdriver/locators/table_row_locator.rb
 - lib/watir-webdriver/locators/text_field_locator.rb
 - lib/watir-webdriver/xpath_support.rb
-- spec/element_locator_spec.rb
 - spec/spec_helper.rb
-- spec/xpath_builder_spec.rb
 - support/html5/html5.idl
 - support/html5/html5_extras.idl
 - support/html5/idl_extractor.rb
 - support/html5/watir_visitor.rb
+- support/yard_handlers.rb
 has_rdoc: true
 homepage: http://github.com/jarib/watir-webdriver
 licenses: []
@@ -138,7 +137,6 @@ signing_key:
 specification_version: 3
 summary: Watir on WebDriver
 test_files: 
-- spec/element_locator_spec.rb
 - spec/spec_helper.rb
 - spec/watirspec/area_spec.rb
 - spec/watirspec/areas_spec.rb
@@ -216,4 +214,3 @@ test_files:
 - spec/watirspec/text_fields_spec.rb
 - spec/watirspec/ul_spec.rb
 - spec/watirspec/uls_spec.rb
-- spec/xpath_builder_spec.rb

data/spec/element_locator_spec.rb

@@ -1,11 +0,0 @@
-# encoding: utf-8
-require "#{File.dirname(__FILE__)}/spec_helper"
-
-describe Watir::ElementLocator do
-  def setup(selector)
-    driver  = mock("Driver")
-    locator = Watir::ElementLocator.new(driver, selector)
-
-    [driver, locator]
-  end
-end

data/spec/xpath_builder_spec.rb

@@ -1,49 +0,0 @@
-# encoding: utf-8
-require "#{File.dirname(__FILE__)}/spec_helper"
-
-# describe Watir::XPathBuilder do
-  # def build(selector)
-  #   XPathBuilder.build_from(selector)
-  # end
-  #
-  # it "builds an xpath from a tag name and a single attribute" do
-  #   build(
-  #     :tag_name => "div",
-  #     :id       => "foo"
-  #   ).should == '//div[@id="foo"]'
-  # end
-  #
-  # it "builds an xpath from a tag name and multiple attributes" do
-  #   build(
-  #     :tag_name => "input",
-  #     :type     => "radio",
-  #     :value    => '1'
-  #   ).should == '//input[@type="radio" and @value="1"]'
-  # end
-  #
-  # it "builds an xpath from a tag name, an attribute and an index" do
-  #   build(
-  #     :tag_name => "input",
-  #     :type => "text",
-  #     :index => 2
-  #   ).should == '//input[@type="text"][3]'
-  # end
-  #
-  # it "builds an xpath from a single attribute" do
-  #   build(
-  #     :class => 'foo'
-  #   ).should == '//*[@class="foo"]'
-  # end
-  #
-  # it "builds an xpath from a tag name and index" do
-  #   build(
-  #     :tag_name => 'span',
-  #     :index => 3
-  #   ).should == '//span[4]'
-  # end
-  #
-  # it "returns nil if any the selector contains a regexp" do
-  #   build(:tag_name => /span|div/).should be_nil
-  # end
-
-# end