watir-webdriver 0.0.1.dev

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec/watirspec"]
+	path = spec/watirspec
+	url = git://github.com/jarib/watirspec.git

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jari Bakken
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,32 @@
+= watir-webdriver
+
+Watir implementation built on WebDriver's Ruby bindings.
+See http://rubyforge.org/pipermail/wtr-development/2009-October/001313.html.
+
+= 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).
+
+= See also
+
+* http://github.com/jarib/webidl
+* http://webdriver.googlecode.com
+* http://selenium.googlecode.com
+
+= Dependencies
+
+* selenium-webdriver
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Jari Bakken. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,107 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = "watir-webdriver"
+    gem.summary     = %Q{Watir on WebDriver}
+    gem.description = %Q{WebDriver-backed Watir}
+    gem.email       = "jari.bakken@gmail.com"
+    gem.homepage    = "http://github.com/jarib/watir-webdriver"
+    gem.authors     = ["Jari Bakken"]
+
+    gem.add_dependency "selenium-webdriver", ">= 0.0.10"
+
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "webidl"
+    gem.add_development_dependency "sinatra"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+namespace :html5 do
+  IDL_PATH    = "support/html5/html5.idl"
+  EXTRAS_PATH = "support/html5/html5_extras.idl"
+  SPEC_URI    = "http://dev.w3.org/html5/spec/Overview.html" # TODO: use http://www.whatwg.org/specs/web-apps/current-work/source
+
+  task :extract do
+    require 'support/html5/idl_extractor'
+
+    idl = IdlExtractor.new(SPEC_URI)
+    idl.write_idl_to IDL_PATH
+    idl.write_extras_to "#{EXTRAS_PATH}.txt"
+
+    puts "\n\n"
+    puts "Some HTML elements does not have an interface declaration defined in the spec."
+    puts "You will need to create the IDL by hand and remove the .txt extension from #{EXTRAS_PATH}.txt before running the html5:generate task."
+    puts "We're also adding an extended attribute to specify TagName - you may need to look through #{IDL_PATH} to make sure the syntax is correct."
+  end
+
+  desc 'Re-enerate the base Watir element classes from the spec '
+  task :generate do
+    require "support/html5/watir_visitor"
+    raise Errno::ENOENT, EXTRAS_PATH unless File.exist?(EXTRAS_PATH)
+
+    code = WatirVisitor.generate_from(IDL_PATH)
+    code << "# from extras: \n\n"
+    code << WatirVisitor.generate_from(EXTRAS_PATH)
+
+    old_file = "lib/watir/elements/generated.rb"
+
+    File.open("#{old_file}.new", "w") { |file| file << code }
+    if File.exist?(old_file)
+      system "diff -Naut #{old_file} #{old_file}.new | less"
+    end
+  end
+
+  desc 'Check the syntax of support/html5/*.idl'
+  task :syntax do
+    require 'webidl'
+    parser = WebIDL::Parser::IDLParser.new
+    failures = []
+    Dir['support/html5/*.idl'].each do |path|
+      unless parser.parse(File.read(path))
+        failures << [path, parser.failure_reason]
+      end
+    end
+
+    if failures.any?
+      puts "Parse errors!"
+      failures.each { |path, reason| puts "#{path.ljust(40)}: #{reason}"  }
+    else
+      puts "Syntax OK."
+    end
+  end
+
+end # html5
+
+task :default => :spec
+
+begin
+  require 'yard'
+  require 'support/yard/handlers/attributes_handler'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+load "spec/watirspec/watirspec.rake" if File.exist?("spec/watirspec/watirspec.rake")

data/TODO

@@ -0,0 +1,15 @@
+TODO:
+
+- frames
+- tables
+
+MAYBE:
+
+- support selector arg to collection methods? i.e. browser.buttons(class: "foo")
+
+DONE:
+
+- check if selector attributes are valid (BaseElement.attribute_list ?) to get MissingWayOfFindingObjectException
+- fix watirspec to not be so picky about exception messages
+- text_field should cover both <input type="whatever"> and <textarea>
+- buttons should cover both <input type="button"> and <button>

data/VERSION

@@ -0,0 +1 @@
+0.0.1.dev

data/lib/watir-webdriver.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+require "selenium-webdriver"
+require "json"
+
+require "watir-webdriver/core_ext/string"
+require "watir-webdriver/exception"
+require "watir-webdriver/xpath_support"
+require "watir-webdriver/container"
+require "watir-webdriver/locators/element_locator"
+require "watir-webdriver/locators/button_locator"
+require "watir-webdriver/locators/text_field_locator"
+require "watir-webdriver/locators/table_row_locator"
+require "watir-webdriver/browser"
+
+module Watir
+  include Selenium
+
+  class << self
+    def tag_to_class
+      @tag_to_class ||= {}
+    end
+
+    def element_class_for(tag_name)
+      tag_to_class[tag_name] || raise(Exception::Error, "no class found for #{tag_name.inspect}")
+    end
+  end
+
+end
+
+require "watir-webdriver/base_element"
+require "watir-webdriver/collections/element_collection"
+require "watir-webdriver/elements/generated"
+require "watir-webdriver/elements/shared_radio_checkbox"
+require "watir-webdriver/elements/input"
+require "watir-webdriver/elements/button"
+require "watir-webdriver/collections/buttons_collection"
+require "watir-webdriver/elements/checkbox"
+require "watir-webdriver/elements/file_field"
+require "watir-webdriver/elements/headings"
+require "watir-webdriver/elements/image"
+require "watir-webdriver/elements/link"
+require "watir-webdriver/elements/radio"
+require "watir-webdriver/elements/text_field"
+require "watir-webdriver/collections/text_fields_collection"
+require "watir-webdriver/elements/hidden"
+require "watir-webdriver/elements/select_list"
+require "watir-webdriver/elements/form"
+require "watir-webdriver/elements/option"
+require "watir-webdriver/elements/table"
+require "watir-webdriver/elements/table_row"
+require "watir-webdriver/collections/table_rows_collection"
+
+Watir.tag_to_class.freeze
+
+module Watir
+  module Container
+
+    # TODO: proper frame support
+    alias_method :frame, :iframe
+    alias_method :frames, :iframes
+
+    # TODO: deprecate cell/row in favor of td/tr?
+    alias_method :cell,  :td
+    alias_method :cells, :tds
+    alias_method :row,   :tr
+    alias_method :rows,  :trs
+
+  end # Container
+end # Watir
+
+
+# undefine deprecated methods to use them for Element attributes
+Object.send :undef_method, :id   if Object.method_defined? "id"
+Object.send :undef_method, :type if Object.method_defined? "type"

data/lib/watir-webdriver/base_element.rb

@@ -0,0 +1,347 @@
+# encoding: utf-8
+
+module Watir
+  class BaseElement
+    include Exception
+    include Container
+    include Selenium
+
+    class << self
+      attr_writer :default_selector
+
+      def inherited(klass)
+        klass.default_selector = default_selector.dup
+      end
+
+      def attributes(attribute_map = nil)
+        if attribute_map.nil?
+          return attribute_list
+        end
+
+        add_attributes attribute_map
+
+        attribute_map.each do |type, attribs|
+          attribs.each { |name| define_attribute(type, name) }
+        end
+      end
+
+      def define_attribute(type, name)
+        method_name    = method_name_for(type, name)
+        attribute_name = attribute_for_method(name)
+
+        (@attributes ||= []) << attribute_name
+
+        case type
+        when :string
+          define_string_attribute(method_name, attribute_name)
+        when :bool
+          define_boolean_attribute(method_name, attribute_name)
+        when :int
+          define_int_attribute(method_name, attribute_name)
+        else
+          # $stderr.puts "treating #{type.inspect} as string for now"
+        end
+      end
+
+      def define_string_attribute(mname, aname)
+        define_method mname do
+          assert_exists
+          rescue_no_match { @element.attribute(aname).to_s }
+        end
+      end
+
+      def define_boolean_attribute(mname, aname)
+        define_method mname do
+          assert_exists
+          rescue_no_match(false) { !!@element.attribute(aname) }
+        end
+      end
+
+      def define_int_attribute(mname, aname)
+        define_method mname do
+          assert_exists
+          rescue_no_match(-1) { @element.attribute(aname).to_i }
+        end
+      end
+
+      def container_method(name)
+        klass = self
+        Container.add name do |*args|
+          klass.new(self, *args)
+        end
+      end
+
+      def collection_method(name)
+        element_class = self
+        klass = Watir.const_set(
+          "#{name.to_s.camel_case}Collection",
+          Class.new(ElementCollection)
+        )
+
+        Container.add name do
+          klass.new(self, element_class)
+        end
+      end
+
+      def add_attributes(attributes)
+        attributes.each do |type, attr_list|
+          typed_attributes[type] += attr_list
+        end
+      end
+
+      def typed_attributes
+        @typed_attributes ||= Hash.new { |hash, type| hash[type] = []  }
+      end
+
+      def identifier(selector)
+        Watir.tag_to_class[selector[:tag_name]] = self
+        default_selector.merge! selector
+      end
+
+      def default_selector
+        @default_selector ||= {}
+      end
+
+      def attribute_list
+        @attribute_list ||= begin
+          list = typed_attributes.values.flatten
+          list += ancestors[1..-1].map do |e|
+            e.attribute_list if e.respond_to?(:attribute_list)
+          end.compact.flatten
+        end
+      end
+
+      def method_name_for(type, attribute)
+        # TODO: rethink this - this list could get pretty long...
+        name = case attribute
+               when :hash
+                 'hash_attribute'
+               when :html_for
+                 'for'
+               when :col_span
+                 'colspan'
+               when :row_span
+                 'rowspan'
+               else
+                 attribute.to_s
+               end
+
+        name << "?" if type == :bool
+
+        name
+      end
+
+      def attribute_for_method(method)
+        case method.to_sym
+        when :class_name
+          'class'
+        when :hash_attribute
+          'hash'
+        when :html_for
+          'for'
+        when :read_only
+          'readonly'
+        else
+          method.to_s
+        end
+      end
+    end # class << self
+
+    def initialize(parent, *selectors)
+      @parent   = parent
+      @selector = extract_selector(selectors).merge(self.class.default_selector)
+
+      if @selector.has_key?(:element)
+        @element = @selector[:element]
+      end
+    end
+
+    def exists?
+      assert_exists
+      true
+    rescue UnknownObjectException
+      false
+    end
+    alias_method :exist?, :exists?
+
+    def inspect
+      if @selector.has_key?(:element)
+        '#<%s:0x%x located=%s selector=%s>' % [self.class, hash*2, !!@element, '{:element=>(webdriver element)}']
+      else
+        '#<%s:0x%x located=%s selector=%s>' % [self.class, hash*2, !!@element, @selector.inspect]
+      end
+    end
+
+    def text
+      assert_exists
+      @element.text
+    end
+
+    def tag_name
+      assert_exists
+      @element.tag_name
+    end
+
+    def click
+      assert_exists
+      assert_enabled
+      @element.click
+      run_checkers
+    end
+
+    def double_click
+      assert_exists
+      raise NotImplementedError, "need support in WebDriver"
+
+      @element.double_click
+      run_checkers
+    end
+
+    def right_click
+      assert_exists
+      raise NotImplementedError, "need support in WebDriver"
+
+      @element.right_click
+      run_checkers
+    end
+
+    def flash
+      assert_exists
+      original_color = driver.execute_script("arguments[0].style.backgroundColor", @element)
+      10.times do |n|
+        color = (n % 2 == 0) ? "red" : original_color
+        driver.execute_script("arguments[0].style.backgroundColor = '#{color}'", @element)
+      end
+    end
+
+    def value
+      assert_exists
+      rescue_no_match { @element.value }
+    end
+
+    def attribute_value(attribute_name)
+      assert_exists
+      # should rescue?
+      @element.attribute attribute_name
+    end
+
+    def html
+      assert_exists
+
+      driver.execute_script(<<-JAVASCRIPT, @element)
+        var e = arguments[0];
+        if(e.outerHTML) {
+          return e.outerHTML;
+        } else {
+          return e.parentNode.innerHTML;
+        }
+      JAVASCRIPT
+    end
+
+    def focus
+      fire_event :focus
+    end
+
+    def fire_event(event_name)
+      assert_exists
+      event_name = event_name.to_s.sub!(/^on/, '')
+      browserbot('triggerEvent', @element, event_name, false)
+    end
+
+    def parent
+      assert_exists
+
+      e = driver.execute_script "return arguments[0].parentNode", @element
+
+      if e.kind_of?(WebDriver::Element)
+        Watir.element_class_for(e.tag_name).new(@parent, :element, e)
+      end
+    end
+
+    def driver
+      @parent.driver
+    end
+
+    def element
+      assert_exists
+      @element
+    end
+    alias_method :wd, :element # ensures duck typing with Browser
+
+    def visible?
+      assert_exists
+      @element.displayed?
+    end
+
+    def style(property = nil)
+      if property
+        assert_exists
+        @element.style property
+      else
+        rescue_no_match { attribute_value "style" } || ''
+      end
+    end
+
+    def run_checkers
+      @parent.run_checkers
+    end
+
+  protected
+
+    def assert_exists
+      @element ||= locate
+
+      unless @element
+        raise UnknownObjectException, "unable to locate element, using #{selector_string}"
+      end
+    end
+
+  private
+
+    def selector_string
+      @selector.inspect
+    end
+
+    def attribute?(a)
+      assert_exists
+      rescue_no_match(false) { !!@element.attribute(a)  }
+    end
+
+    def locate
+      @parent.assert_exists
+      ElementLocator.new(@parent.wd, @selector, self.class.attribute_list).locate
+    end
+
+    def assert_enabled
+      raise ObjectDisabledException, "object is disabled #{selector_string}" unless @element.enabled?
+    end
+
+    def assert_writable
+      assert_enabled
+      raise ObjectReadOnlyException if respond_to?(:readonly?) && readonly?
+    end
+
+    def rescue_no_match(returned = "", &blk)
+      yield
+    rescue WebDriver::Error::WebDriverError => e # webdriver needs a MissingAttributeError or similar
+      raise unless e.message == "No match"
+      returned
+    end
+
+    def extract_selector(selectors)
+      case selectors.size
+      when 2
+        { selectors[0] => selectors[1] }
+      when 1
+        unless selectors.first.is_a? Hash
+          raise ArgumentError, "expected Hash or (:how, 'what')"
+        end
+
+        selectors.first
+      else
+        raise ArgumentError, "wrong number of arguments (#{selectors.size} for 2)"
+      end
+    end
+
+  end # BaseElement
+end # Watir