watirsplash 0.1.9

data/lib/watirsplash/util.rb

@@ -0,0 +1,35 @@
+module WatirSplash
+  # class for common functionality
+  class Util
+    @@ui_test_common_dir = "ui-test-common"
+
+    class << self
+
+      # loads ui-test-common/environment.rb
+      #
+      # ui-test-common has to be located at some higher level within directory
+      # structure compared to project/ui-test directory
+      def load_common
+        dir = common_dir
+        puts "Loading ui-test-common from #{dir}..."
+        require File.join(dir, "environment.rb")
+      end
+
+      private
+
+      def common_dir
+        Dir.chdir("..") do
+          dirs = Dir.entries(Dir.pwd).find_all {|entry| File.directory?(entry)}
+          if dirs.include?(@@ui_test_common_dir) && File.exists?(@@ui_test_common_dir + "/environment.rb")
+            File.join(Dir.pwd, @@ui_test_common_dir)
+          elsif dirs.include?("..")
+            common_dir
+          else
+            raise "#{@@ui_test_common_dir} directory was not found! It has to exist somewhere higher in directory tree than your project's directory and it has to have environment.rb file in it!"
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/watirsplash/version.rb

@@ -0,0 +1,3 @@
+module WatirSplash
+  VERSION = "0.1.9"
+end

data/lib/watirsplash/waiter.rb

@@ -0,0 +1,29 @@
+module WatirSplash
+  module Waiter
+    # waits until some condition is true and
+    # throws Watir::Exception::TimeOutException upon timeout
+    #
+    # examples:
+    #   wait_until! {text_field(:name => 'x').exists?} # waits until text field exists
+    #   wait_until!(5) {...} # waits maximum of 5 seconds condition to be true
+    def wait_until! *arg
+      Watir::Waiter.wait_until(*arg) {yield}
+    end
+
+    # waits until some condition is true and
+    # returns false if timeout occurred, true otherwise
+    #
+    # examples:
+    #   wait_until {text_field(:name => 'x').exists?} # waits until text field exists
+    #   wait_until(5) {...} # waits maximum of 5 seconds condition to be true
+    def wait_until *arg
+      begin
+        wait_until!(*arg) {yield}
+      rescue Watir::Exception::TimeOutException
+        return false
+      end
+
+      return true
+    end
+  end
+end

data/lib/watirsplash/watir.rb

@@ -0,0 +1,151 @@
+module Watir
+  module PageCheckers
+    # raises an error if javascript error was found
+    JAVASCRIPT_ERRORS_CHECKER = lambda {|ie| raise "Got JavaScript error!" if ie.status =~ /Error on page/}
+  end
+end
+
+# patches for Watir
+module Watir
+  class IE #:nodoc:all
+    # This is Watir's overriden wait method, which is used in many places for deciding
+    # if browser is ready or not. We have to patch one line in it to work properly
+    # when file save as dialog has been displayed. For some reason READYSTATE (4)
+    # property value will be READYSTATE_INTERACTIVE (3) after file has been downloaded
+    # and not 4, thus wait will stay blocking.
+    # read more about IE READYSTATE property:
+    # http://msdn.microsoft.com/en-us/library/aa768362(VS.85).aspx
+    def wait(no_sleep=false)
+      @xml_parser_doc = nil
+      @down_load_time = 0.0
+      a_moment = 0.2 # seconds
+      start_load_time = Time.now
+
+      begin
+        while @ie.busy # XXX need to add time out
+          sleep a_moment
+        end
+        # this is the line which has been changed to accept also state 3
+        until @ie.readyState <= READYSTATE_COMPLETE do
+          sleep a_moment
+        end
+        sleep a_moment
+        until @ie.document do
+          sleep a_moment
+        end
+
+        documents_to_wait_for = [@ie.document]
+
+      rescue WIN32OLERuntimeError # IE window must have been closed
+        @down_load_time = Time.now - start_load_time
+        sleep @pause_after_wait unless no_sleep
+        return @down_load_time
+      end
+
+      while doc = documents_to_wait_for.shift
+        begin
+          until doc.readyState == "complete" do
+            sleep a_moment
+          end
+          @url_list << doc.location.href unless @url_list.include?(doc.location.href)
+          doc.frames.length.times do |n|
+            begin
+              documents_to_wait_for << doc.frames[n.to_s].document
+            rescue WIN32OLERuntimeError, NoMethodError
+            end
+          end
+        rescue WIN32OLERuntimeError
+        end
+      end
+
+      @down_load_time = Time.now - start_load_time
+      run_error_checks
+      sleep @pause_after_wait unless no_sleep
+      @down_load_time
+    end
+
+    # Closes the browser even if #wait throws an exception.
+    # It happens mostly when #run_error_checks throws some exception.
+    def close
+      return unless exists?
+      @closing = true
+      @ie.stop
+      begin
+        wait
+      rescue
+      end
+      chwnd = @ie.hwnd.to_i
+      @ie.quit
+      while Win32API.new("user32", "IsWindow", 'L', 'L').Call(chwnd) == 1
+        sleep 0.3
+      end
+    end
+  end
+
+  module PageContainer #:nodoc:all
+    # patch for .click_no_wait
+    def eval_in_spawned_process(command)
+      command.strip!
+      ruby_code = "require 'rubygems';"
+      ruby_code << "require 'watir/ie';"
+      ruby_code << "pc = #{attach_command};"
+      ruby_code << "pc.instance_eval(#{command.inspect});"
+      exec_string = "start rubyw -e #{ruby_code.inspect}".gsub("\\\"", "'")
+      system(exec_string)
+    end
+  end
+
+  class Table < Element
+
+    # This method returns multi-dimensional array of the text's in table.
+    #
+    # It works with tr, th, td elements, colspan, rowspan and nested tables.
+    def to_a
+      assert_exists
+      y = []
+      @o.rows.each do |row|
+        y << TableRow.new(@container, :ole_object, row).to_a
+      end
+      y
+    end
+  end
+
+  class TableRow < Element
+
+    # This method returns (multi-dimensional) array of the text's in table's row.
+    #
+    # It works with th, td elements, colspan, rowspan and nested tables.
+    def to_a
+      assert_exists
+      y = []
+      @o.cells.each do |cell|
+        inner_tables = cell.getElementsByTagName("TABLE")
+        inner_tables.each do |inner_table|
+          # make sure that the inner table is directly child for this cell
+          if inner_table?(cell, inner_table)
+            y << Table.new(@container, :ole_object, inner_table).to_a
+          end
+        end
+
+        if inner_tables.length == 0
+          y << cell.innerText.strip
+        end
+      end
+      y
+    end
+
+    private
+    # returns true if inner_table is direct child
+    # table for cell and there's not any table-s in between
+    def inner_table?(cell, inner_table)
+      parent_element = inner_table.parentElement
+      if parent_element.uniqueID == cell.uniqueID
+        return true
+      elsif parent_element.tagName == "TABLE"
+        return false
+      else
+        return inner_table?(cell, parent_element)
+      end
+    end
+  end
+end

data/lib/watirsplash.rb

@@ -0,0 +1,11 @@
+require "rubygems"
+require "require_all"
+require "spec"
+require "watir"
+require "watirsplash/util"
+require "watirsplash/waiter"
+require "watirsplash/spec_helper"
+require "watirsplash/spec"
+require "watirsplash/watir"
+require "watirsplash/autoit"
+

data/spec/spec_helper_spec.rb

@@ -0,0 +1,56 @@
+require "watirsplash"
+require "spec/autorun"
+
+describe WatirSplash::SpecHelper do
+
+  it "opens browser automatically" do
+    @browser.should exist
+    @browser.url.should == "about:blank"
+    @browser.title.should == ""
+  end
+
+  it "redirects method calls to Watir::Browser" do
+    goto "http://google.com"
+    url.should =~ /google/
+    title.should =~ /google/i
+    text_field = text_field(:name => "q")
+    text_field.should exist
+    text_field.should be_visible
+  end
+
+  it "has wait_until" do
+    result = wait_until {sleep 0.1; true}
+    result.should be_true
+
+    result = wait_until(0.5) {sleep 0.1; false}
+    result.should be_false
+  end
+
+  it "has wait_until!" do
+    lambda {wait_until!(0.5) {sleep 0.1; true}}.should_not raise_exception
+    lambda {wait_until!(0.5) {sleep 0.1; false}}.should raise_exception(Watir::Exception::TimeOutException)
+  end
+
+  it "has file_path methods without using formatter" do
+    file_name = "blah.temp"
+    ext = File.extname(file_name)
+    base = File.basename(file_name, ext)
+    expected_path = File.join(Dir.pwd, "#{base}_\\d{6}#{ext}")
+
+    file_path(file_name).should =~ Regexp.new(expected_path)
+    expected_path = expected_path.gsub("/", "\\")
+    native_file_path(file_path(file_name)).should =~ Regexp.new(Regexp.escape(expected_path).gsub("\\\\d\\{6\\}", "\\d{6}"))
+  end
+
+  it "has download_file method" do
+    begin
+      goto "http://dl.dropbox.com/u/2731643/misc/download.html"
+      link(:text => "Download").click_no_wait
+      file = download_file("download.zip")
+      File.read(file).should == "this is a 'zip' file!"
+    ensure
+      FileUtils.rm file
+    end
+  end
+
+end

data/spec/spec_match_array_spec.rb

@@ -0,0 +1,21 @@
+require "spec/autorun"
+require "watirsplash"
+
+describe "Array match_array matcher" do
+
+  it "matches other arrays with regexps" do
+    expected_ary = ["1", "2", "3", /\d/]
+    ["1", "2", "3", "5"].should match_array(expected_ary)
+
+    expected_ary = ["1", ["2", /\d+/], /3/]
+    ["1", [], "4"].should_not match_array(expected_ary)
+    ["1", ["2", "55"], "3"].should match_array(expected_ary)
+  end
+
+  it "doesn't work with other objects than Array" do
+    lambda {"".should match_array("")}.should raise_exception
+    lambda {[].should match_array("")}.should raise_exception
+    lambda {"".should match_array([])}.should raise_exception
+  end
+
+end

data/spec/util_spec.rb

@@ -0,0 +1,38 @@
+require "watirsplash"
+require "spec/autorun"
+
+describe WatirSplash::Util do
+
+  it "loads ui-test-common" do
+    class WatirSplash::Util
+      @@ui_test_common_dir = "ui-test-common-for-test"
+    end
+
+    begin
+      ui_test_common_dir = "../ui-test-common-for-test"
+      FileUtils.mkdir(ui_test_common_dir)
+      File.open(File.join(ui_test_common_dir, "environment.rb"), "w") do |f|
+        f.puts "
+module GlobalApplication
+  LOADED = true
+end"
+      end
+
+      lambda {WatirSplash::Util.load_common}.should_not raise_exception
+      GlobalApplication::LOADED.should be_true
+    ensure
+      FileUtils.rm_rf(ui_test_common_dir)
+    end
+  end
+
+  it "raises exception if ui-test-common is not found" do
+    class WatirSplash::Util
+      @@ui_test_common_dir = "nonexisting_ui_test_common_dir"
+    end
+
+    lambda {WatirSplash::Util.load_common}.
+            should raise_exception(RuntimeError,
+                                   "nonexisting_ui_test_common_dir directory was not found! It has to exist somewhere higher in directory tree than your project's directory and it has to have environment.rb file in it!")
+  end
+
+end

data/spec/watir_ie_spec.rb

@@ -0,0 +1,13 @@
+require "watirsplash"
+require "spec/autorun"
+
+describe Watir::IE do
+
+  it "closes the browser even when Watir::IE#run_error_checks throws an exception" do
+    @browser.add_checker lambda {raise "let's fail IE#wait in IE#close"}
+    @browser.should exist
+    lambda {@browser.close}.should_not raise_exception
+    @browser.should_not exist
+  end
+
+end

data/spec/watir_table_row_spec.rb

@@ -0,0 +1,46 @@
+require "watirsplash"
+require "spec/autorun"
+
+describe Watir::TableRow do
+  include WatirSplash::SpecHelper
+
+  before :all do
+    goto "http://dl.dropbox.com/u/2731643/misc/tables.html"
+  end
+
+  it "#to_a works with regular row" do
+    first_row = table(:id => "normal")[1]
+    first_row.to_a.should == ["1", "2", "3"]
+  end
+
+  it "#to_a works with headers in row" do
+    first_row = table(:id => "headers")[1]
+    first_row.to_a.should == ["1", "2", "3", "4"]
+  end
+
+  it "#to_a works with nested tables" do
+    second_row = table(:id => "nested")[2]
+    second_row.to_a.should == [[["11", "12"], ["13","14"]], "3"]
+  end
+
+  it "#to_a works with deep-nested tables" do
+    second_row = table(:id => "deepnested")[2]
+    second_row.to_a.should == [[["11", "12"],
+                                [[["404", "405"], ["406", "407"]], "14"]], "3"]
+  end
+
+  it "#to_a works with colspan" do
+    second_row = table(:id => "colspan")[2]
+    second_row.to_a.should == ["3"]
+  end
+
+  it "#to_a works with rowspan" do
+    t = table(:id => "rowspan")
+    second_row = t[2]
+    second_row.to_a.should == ["3", "4"]
+
+    third_row = t[3]
+    third_row.to_a.should == ["5"]
+  end
+
+end

data/spec/watir_table_spec.rb

@@ -0,0 +1,79 @@
+require "watirsplash"
+require "spec/autorun"
+
+describe Watir::Table do
+  include WatirSplash::SpecHelper
+
+  before :all do
+    goto "http://dl.dropbox.com/u/2731643/misc/tables.html"
+  end
+
+  it "#to_a works with regular table" do
+    expected_table = [
+            ["1", "2", "3"],
+            ["4", "5", "6"],
+            ["7", "8", "9"]
+    ]
+    table(:id => "normal").to_a.should == expected_table
+  end
+
+  it "#to_a works with table with headers" do
+    expected_table = [
+            ["1", "2", "3", "4"],
+            ["5", "6", "7", "8"],
+            ["9", "10", "11", "12"]
+    ]
+    table(:id => "headers").to_a.should == expected_table
+  end
+
+  it "#to_a works with nested tables" do
+    expected_table =
+            [
+                    ["1", "2"],
+                    [[["11", "12"],
+                      ["13", "14"]], "3"]
+            ]
+    table(:id => "nested").to_a.should == expected_table
+  end
+
+  it "#to_a works with nested table with non-direct child" do
+    expected_table =
+            [
+                    ["1", "2"],
+                    [[["11", "12"],
+                      ["13", "14"]], "3"]
+            ]
+
+    table(:id => "nestednondirectchild").to_a.should == expected_table
+  end
+
+  it "#to_a works with deep-nested tables" do
+    expected_table =
+            [
+                    ["1", "2"],
+                    [[["11", "12"],
+                      [[["404", "405"],
+                        ["406", "407"]], "14"]], "3"]
+            ]
+    table(:id => "deepnested").to_a.should == expected_table
+  end
+
+  it "#to_a works with colspan" do
+    expected_table =
+            [
+                    ["1", "2"],
+                    ["3"]
+            ]
+    table(:id => "colspan").to_a.should == expected_table
+  end
+
+  it "#to_a works with rowspan" do
+    expected_table =
+            [
+                    ["1", "2"],
+                    ["3", "4"],
+                    ["5"]
+            ]
+    table(:id => "rowspan").to_a.should match_array(expected_table)
+  end
+end

data/templates/common/config.rb

@@ -0,0 +1,28 @@
+=begin
+  Global configuration constants
+  For example, you can use the URL constant below from your projects like this:
+
+  In your projects' config.rb:
+
+  module Config
+    module Application
+      URL = Config.full_url("my_subpage/index.html") # => equals "http://localhost/my_subpage/index.html
+    end
+  end
+=end
+
+require "uri"
+
+module Config
+  module GlobalApplication
+    URL = "http://localhost"
+  end
+
+  def Config.full_url relative_url
+    URI.join(GlobalApplication::URL, relative_url).to_s
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(CommonApplicationHelper)
+end

data/templates/common/environment.rb

@@ -0,0 +1,17 @@
+=begin
+  you have to load this file from your projects' environment.rb, which
+  will use common functionality:
+  WatirSplash::Util.load_common
+
+  add all your require statements into this file to avoid unnecessary
+  code in your other projects' files
+
+  by default everything, which is not a spec file, will be loaded
+=end
+
+local_dir = File.join(File.dirname(__FILE__), "**/*.rb")
+filtered_ruby_files = Dir.glob(local_dir).delete_if do |file|
+  File.directory?(file) || File.basename(file) =~ /(config|_spec)\.rb$/
+end
+require_all filtered_ruby_files
+require_rel "config.rb"

data/templates/common/lib/common_application_helper.rb

@@ -0,0 +1,14 @@
+# you can create under this directory common libraries/helpers/methods which you could
+# use within your specs in different projects
+
+module CommonApplicationHelper
+
+  # you can use these methods automatically inside of your it-blocks
+  # it "does something" do
+  #   new_global_method.should == "it just works"
+  # end
+  def new_global_method
+    "it just works"
+  end
+
+end

data/templates/project/application_helper.rb

@@ -0,0 +1,18 @@
+# ApplicationHelper module has helper methods for easy use in specs
+# see usages in spec/dummy_spec.rb
+
+module ApplicationHelper
+
+  def helper_method_one
+    "one"
+  end
+
+  def has_second_method?
+    true
+  end
+
+  def correct?
+    false
+  end
+
+end

data/templates/project/config.rb

@@ -0,0 +1,20 @@
+# Config for your application
+module Config
+  module Application
+    # URL, which will be opened by every test
+    # replace it with the URL of your application under test
+    # or if ui-test-common is used then
+    # URL = Config.full_url("/relative/url/index.html")
+    URL = "about:blank"
+  end
+end
+
+# A global configuration for specs in this project, which will include by default
+# a ApplicationHelper module and open Config::Application::URL with
+# the browser.
+# You can read more about RSpec-s before and after syntax from:
+# http://rspec.info/documentation/before_and_after.html
+Spec::Runner.configure do |config|
+  config.include(ApplicationHelper)
+  config.before(:all) {goto Config::Application::URL}
+end

data/templates/project/environment.rb

@@ -0,0 +1,13 @@
+# add all your require statements into this file to avoid unnecessary
+# code in your spec files
+
+# uncomment following line to load functionality from ui-test-common
+# WatirSplash::Util.load_common
+
+# by default everything, which is not a spec file, will be loaded
+local_dir = File.join(File.dirname(__FILE__), "**/*.rb")
+filtered_ruby_files = Dir.glob(local_dir).delete_if do |file|
+  File.directory?(file) || File.basename(file) =~ /(ide_runner|config|_spec)\.rb$/
+end
+require_all filtered_ruby_files
+require_rel "config.rb"

data/templates/project/ide_runner.rb

@@ -0,0 +1,3 @@
+# this file is needed for launching specs from IDE
+require "watirsplash/runner"
+exit ::WatirSplash::Runner.run

data/templates/project/spec/dummy_spec.rb

@@ -0,0 +1,44 @@
+# this is a fully working dummy spec file which you can run to see if
+# your configuration is correct and everything is working as expected
+
+describe "WatirSplash" do
+
+  it "has the browser window opened" do
+    url.should == "about:blank"
+  end
+
+  it "has easy access to ApplicationHelper methods" do
+    # ApplicationHelper#helper_method_one will be executed
+    helper_method_one.should == "one"
+    # ApplicationHelper#has_second_method? will be execute
+    should have_second_method
+    # ApplicationHelper#correct? method will be execute
+    should_not be_correct
+  end
+
+  it "fails the example and makes a screenshot of the browser" do
+    false.should be_true
+  end
+
+  it "is in pending status" do
+    goto "http://google.com"
+    title.should == "Google"
+    text_field(:name => "q").set "Bing"
+    search_button = button(:name => "btnG")
+    search_button.should exist
+    search_button.should be_visible
+    search_button.click
+    text.should include("Bing")
+    pending "this is a known 'bug'" do
+      title.should == "Bing"
+    end
+  end
+
+  it "has also access to global methods" do
+    pending "it fails as long as there's not executed 'watirsplash generate_common' command
+and ui-test-common is not loaded by this project" do
+      new_global_method.should == "it just works"
+    end
+  end
+
+end