watirspec 0.1.0

data/History.rdoc

@@ -0,0 +1,3 @@
+=== Version 0.1.0 / 2010-04-03
+
+First release of WatiRspec, a small library for combining Watir and RSpec for browser-based functional testing in Ruby.

data/License.txt

@@ -0,0 +1,24 @@
+(The MIT License)
+
+Copyright (c) 2010 Jarmo Pertman
+
+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,161 @@
+= WatiRspec
+
+* Web: http://github.com/jarmo/WatiRspec
+* Author: Jarmo Pertman (mailto:jarmo.p[at]gmail.com)
+
+== DESCRIPTION:
+
+WatiRspec is a small library for easier browser-based functional testing in Ruby.
+It combines Watir (http://www.watir.com) for controlling the browser (currently mainly IE) and
+RSpec (http://rspec.info) for testing framework. This powerful combination gives you
+the ability to write easily well-maintained and easy-to-read specs (specifications in RSpec) so
+you don't need to have any extra documentation for your applications.
+
+WatiRspec makes it easier to use best features of both of these tools together so
+you won't have to spend time on thinking how to do that yourself - you can start
+testing right away!
+
+== FEATURES:
+
+* generate command for generating default project structure
+* generate_common command for generating common ui-tests directory
+* Browser will be opened and closed for each example group automatically
+* You can use Watir method names directly without having to specify a browser object:
+    text_field(:name => "locator") # instead of @browser.text_field(:name => "locator")
+* All needed libraries will be loaded and helper modules will be included automatically
+* All JavaScript errors will be detected automatically
+* Some additional methods to help using Watir (download_file, wait_until, wait_until! etc.)
+
+* Custom html formatter for RSpec:
+* Saves screenshot of the browser window
+* Saves html of the page
+* Saves all the files created/downloaded during the example and shows them on the report
+* Automatically archives test results for later reviewing
+
+== SYNOPSIS:
+
+    describe "Google" do
+        before :all do
+            goto "http://google.com"
+            url.should =~ /google/
+        end
+        
+        it "has search field" do
+            text_field = text_field(:name => "q")
+            text_field.should exist
+            text_field.should be_visible
+        end
+        
+        it "performs search" do
+            text_field(:name => "q").set "Bing"
+            button(:name => "btnG").click
+            text.should include("Bing")
+        end
+    end
+    
+    C:\project\ui-test>watirspec spec\google_spec.rb
+    Results will be saved into the directory C:/project/ui-test/results
+    Google
+      has search field
+      performs search
+
+    Finished in 6.782388 seconds
+
+    2 examples, 0 failures
+
+== INSTALL:
+
+* install Ruby 1.8.6:
+    http://rubyinstaller.org/
+    
+* install ImageMagick with rmagick-win32 for making the screenshots:
+    http://rubyforge.org/frs/?group_id=12&release_id=42049
+    
+* update RubyGems:
+    gem update --system
+
+* install WatiRspec:
+    gem install watirspec
+    
+== USAGE:
+    
+If you have a web-application project (it may have been written in any programming language) without any browser-based tests,
+then it has probably a directory structure similar to this example:
+    C:\example_project
+    ├───doc
+    ├───lib
+    └───test
+    
+Now from the command line go to this directory and execute generate command:
+    C:\>cd example_project
+
+    C:\example_project>watirspec generate
+    Creating WatiRspec project directory structure to C:/example_project/ui-test...
+    Done
+    
+After that the directory structure will be something like this:
+    C:\example_project
+    ├───doc
+    ├───lib
+    ├───test
+    └───ui-test
+        └───spec
+    
+The contents of that ui-test directory will be:
+    ui-test\application_helper.rb
+    ui-test\config.rb
+    ui-test\environment.rb
+    ui-test\ide_runner.rb
+    
+    ui-test\spec
+    ui-test\spec\dummy_spec.rb
+    
+Just check out all the files to see some example code and comments in it and execute dummy_spec.rb
+to verify that everything works correctly:
+    watirspec spec\dummy_spec.rb
+    
+You can have whatever directory structure for your tests just make sure that all test files have _spec.rb in
+the end of their filename (if using default RSpec options).
+    
+== USAGE FOR MULTIPLE PROJECTS:
+
+Usually you're going to write tests for multiple different projects. It would be shame if you'd
+going to create all those common helper methods again for different projects or just copy-paste
+the code from previous project's helpers. This is the place where ui-test-common comes into play.
+    
+ui-test-common would be a place where you can hold all your common functionality in helper
+modules/methods/classes and then use those things in your tests so you won't have multiple
+copies of similar or even same code in different places. So it helps you
+to keep DRY (http://en.wikipedia.org/wiki/Don't_repeat_yourself).
+    
+After finding yourself in a situation where a new project comes into play, then execute
+generate_common command once somewhere in a higher level of a directory tree than your project's ui-test directory
+to generate ui-test-common directory:
+    C:\example_project>cd ..
+
+    C:\>watirspec generate_common
+    Creating WatiRspec common project directory structure to C:/ui-test-common...
+    Done
+
+It has a structure of:
+    C:\UI-TEST-COMMON
+    └───lib
+    
+    ui-test-common\config.rb
+    ui-test-common\environment.rb
+    ui-test-common\lib
+    ui-test-common\lib\common_application_helper.rb
+    
+In environment.rb under project/ui-test you shall add common functionality to your project.
+Add the following line before any other require statements to do that:
+    WatiRspec::Util.load_common
+    
+This gives you by default the access to every method in ui-test-common/lib/common_application_helper.rb
+    
+Now, in ui-test-common/config.rb change the URL to your hostname and in config.rb under project/ui-test:
+    URL = Config.full_url("/relative_path")
+    
+This gives you the ability to have host and port written only in one place.
+    
+Now move all the common functionality away from your project's files into ui-test-common files and start testing.
+From now on, add all common functionality into ui-test-common/lib

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_dir = 'coverage'
+  t.rcov_opts << '--sort coverage --text-summary --aggregate coverage.data'
+end
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts << "--options" << "lib/spec.opts" <<
+          "--require" << "lib/watirspec/html_formatter" <<
+          "--format" << "WatiRspec::HtmlFormatter:results/index.html"
+end

data/bin/watirspec

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+watirspec_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(watirspec_dir) unless $LOAD_PATH.include?(watirspec_dir)
+require 'watirspec/runner'
+
+if ARGV.size == 1 && ::WatiRspec::Runner.respond_to?(ARGV[0])
+  exit ::WatiRspec::Runner.send(ARGV[0])
+else
+  exit ::WatiRspec::Runner.run
+end

data/lib/spec.opts

@@ -0,0 +1,5 @@
+--color
+--format
+nested
+--diff
+u

data/lib/watirspec/autoit.rb

@@ -0,0 +1,54 @@
+# Helper class for AutoIt
+class AutoItHelper
+  extend WatiRspec::Waiter
+  
+  @@autoit = Watir.autoit
+
+  class << self
+    # clicks save button on window with specified title,
+    # activates window automatically and makes sure that the click
+    # was successful
+    def click_save(window_title="File Download")
+      click_button(window_title, "&Save")
+    end
+
+    # sets edit field value to field_value on window with specified title,
+    # activates window automatically and makes sure that the field's
+    # value got changed
+    def set_edit(field_value, window_title="Save As")
+      set_field(window_title, "Edit1", field_value)
+    end
+
+    # sets specified field's value on window with specified title,
+    # activates window automatically and makes sure that the field's
+    # value got changed
+    def set_field(window_title, field_name, field_value)
+      wait_until! do
+        activate_window(window_title) &&
+                @@autoit.ControlFocus(window_title, "", field_name) == 1 &&
+                @@autoit.ControlSetText(window_title, "", field_name, field_value) == 1 &&
+                @@autoit.ControlGetText(window_title, "", field_name) == field_value
+      end
+    end
+
+    # clicks specified button on window with specified title,
+    # activates window automatically and makes sure that the click
+    # was successful
+    def click_button(window_title, button_name)
+      wait_until! do
+        activate_window(window_title) &&
+                @@autoit.ControlFocus(window_title, "", button_name) == 1 &&
+                @@autoit.ControlClick(window_title, "", button_name) == 1 &&
+                wait_until(3) {@@autoit.WinExists(window_title) == 0}
+      end
+    end
+
+    # makes window active with specified title
+    # * returns true if activation was successful and false otherwise
+    def activate_window(window_title)
+      @@autoit.WinWait(window_title, "", 1) == 1 &&
+              @@autoit.WinActivate(window_title) != 0 &&
+              @@autoit.WinActive(window_title) != 0
+    end
+  end
+end

data/lib/watirspec/html_formatter.rb

@@ -0,0 +1,112 @@
+require 'spec/runner/formatter/html_formatter'
+require 'win32screenshot'
+require 'rmagick'
+require 'pathname'
+require 'fileutils'
+
+module WatiRspec
+  # Custom RSpec formatter for WatiRspec
+  # * saves screenshot of the browser upon test failure
+  # * saves html of the browser upon test failure
+  # * saves javascript error dialog upon test failure
+  # * saves all files generated/downloaded during the test and shows them in the report
+  class HtmlFormatter < ::Spec::Runner::Formatter::HtmlFormatter
+
+    # currently used browser object
+    # needed for saving of screenshots and html
+    attr_writer :browser
+
+    def initialize(options, output) # :nodoc:
+      raise "output has to be a file path!" unless output.is_a?(String)
+      @output_dir = File.expand_path(File.dirname(output))
+      puts "Results will be saved into the directory #{@output_dir}"
+      @files_dir = File.join(@output_dir, "files")
+      if File.exists?(@output_dir)
+        archive_dir = File.join(@output_dir, "../archive")
+        FileUtils.mkdir_p(archive_dir) unless File.exists?(archive_dir)
+        FileUtils.mv @output_dir, File.join(archive_dir, "#{File.basename(@output_dir)}_#{File.mtime(@output_dir).strftime("%y%m%d_%H%M%S")}")
+      end
+      FileUtils.mkdir_p(@files_dir)
+      super
+    end
+
+    def example_started(example) # :nodoc:
+      @files_saved_during_example = []
+      super
+    end
+
+    def extra_failure_content(failure) # :nodoc:
+      save_javascript_error
+      save_html
+      save_screenshot
+
+      content = []
+      content << "<span>"
+      @files_saved_during_example.each {|f| content << link_for(f)}
+      content << "</span>"
+      super + content.join($/)
+    end
+
+    def link_for(file) # :nodoc:
+      return unless File.exists?(file[:path])
+
+      description = file[:desc] ? file[:desc] : File.extname(file[:path]).upcase[1..-1]
+      path = Pathname.new(file[:path])
+      "<a href='#{path.relative_path_from(Pathname.new(@output_dir))}'>#{description}</a>&nbsp;"
+    end
+
+    def save_html # :nodoc:
+      begin
+        html = @browser.html
+        file_name = file_path("browser.html")
+        File.open(file_name, 'w') {|f| f.puts html}
+      rescue => e
+        $stderr.puts "saving of html failed: #{e.message}"
+        $stderr.puts e.backtrace
+      end
+      file_name
+    end
+
+    def save_screenshot(description="Screenshot", hwnd=@browser.hwnd) # :nodoc:
+      begin
+        @browser.bring_to_front
+        width, height, blob = Win32::Screenshot.capture_hwnd(hwnd)
+        file_name = file_path("screenshot.png", description)
+        img = Magick::ImageList.new
+        img.from_blob(blob)
+        img.write(file_name)
+      rescue => e
+        $stderr.puts "saving of screenshot failed: #{e.message}"
+        $stderr.puts e.backtrace
+      end
+      file_name
+    end
+
+    def save_javascript_error # :nodoc:
+      file_name = nil
+      if @browser.is_a?(Watir::IE) && @browser.status =~ /Error on page/
+        autoit = Watir::autoit
+        autoit.AutoItSetOption("MouseCoordMode", 0)
+        autoit.ControlClick("[TITLE:#{@browser.title}]", "", "[CLASS:msctls_statusbar32]", "left", 2)
+        popup_title = "[REGEXPTITLE:^(Windows )?Internet Explorer$]"
+        autoit.WinWait(popup_title, "", 10)
+        file_name = save_screenshot("JS_Error", autoit.WinGetHandle(popup_title).hex)
+        autoit.WinClose(popup_title)
+      end
+      file_name
+    end
+
+    # Generates unique file name and path for each example.
+    #
+    # All file names generated with this method will be shown
+    # on the report.
+    def file_path(file_name, description=nil)
+      extension = File.extname(file_name)
+      basename = File.basename(file_name, extension)
+      file_path = File.join(@files_dir, "#{basename}_#{Time.now.strftime("%H%M%S")}_#{example_group_number}_#{example_number}#{extension}")
+      @files_saved_during_example.unshift(:desc => description, :path => file_path)
+      file_path
+    end
+    
+  end
+end

data/lib/watirspec/rspec.rb

@@ -0,0 +1,17 @@
+Spec::Runner.configure do |config| #:nodoc:
+  config.include(WatiRspec::SpecHelper)
+
+  config.before(:all) do
+    open_browser_at "about:blank"
+  end
+
+  config.after(:all) do
+    close
+  end
+end
+
+module Spec #:nodoc:all
+  class ExampleGroup
+    subject {self}
+  end
+end

data/lib/watirspec/runner.rb

@@ -0,0 +1,97 @@
+module WatiRspec
+
+  # WatiRspec runner class is responsible for:
+  # * generating directory structures for projects
+  # * starting RSpec with specified settings
+  class Runner
+    @@template_directory = File.join(File.dirname(__FILE__), "../../templates/")
+
+    class << self
+
+      # Run RSpec with custom settings
+      # * loads spec.opts from project's directory if exists
+      # * loads environment.rb from project's directory if exists
+      # * loads custom Formatter
+      def run
+        unless ARGV.empty?
+          require "watirspec"
+          load_formatter
+          load_options
+          load_project_env
+        else
+          return help
+        end
+
+        ::Spec::Runner::CommandLine.run
+      end
+
+      # Generates ui-test project structure for project
+      def generate
+        ui_test_dir = File.join(Dir.pwd, "ui-test")
+        puts "Creating WatiRspec project directory structure to #{ui_test_dir}..."
+        require "fileutils"
+        FileUtils.cp_r File.join(@@template_directory, "project/."), ui_test_dir
+        puts "Done"
+        return 0
+      rescue => e
+        puts "Failed:"
+        puts e.message
+        return -1
+      end
+
+      # Generates ui-test-common directory structure
+      def generate_common
+        common_dir = File.join(Dir.pwd, "ui-test-common")
+        puts "Creating WatiRspec common project directory structure to #{common_dir}..."
+        require "fileutils"
+        FileUtils.cp_r File.join(@@template_directory, "common/."), common_dir
+        puts "Done"
+        return 0
+      rescue => e
+        puts "Failed:"
+        puts e.message
+        return -1
+      end
+
+      # Shows help
+      def help
+        puts %Q{WatiRspec:
+Usage: watirspec (COMMAND|FILE(:LINE)?|DIRECTORY|GLOB)+ [options]
+Commands:
+          * generate - generate default directory structure for new project
+          * generate_common - generate common project directory structure
+          * help - show this help
+          * --help - show RSpec's help
+
+All other commands/options will be passed to RSpec directly.}
+
+        return 1
+      end
+
+      private
+
+      def load_formatter
+        ARGV << "--require" << "watirspec/html_formatter.rb"
+        ARGV << "--format" << "WatiRspec::HtmlFormatter:#{File.join(Dir.pwd, "results/index.html")}"
+      end
+
+      def load_options
+        ARGV << "--options"
+        project_spec_opts = File.join(Dir.pwd, "spec.opts")
+        if File.exists?(project_spec_opts)
+          ARGV << project_spec_opts
+        else
+          ARGV << "#{File.join(File.dirname(__FILE__), "../spec.opts")}"
+        end
+      end
+
+      def load_project_env
+        project_env_file = File.join(Dir.pwd, "environment.rb")
+        if File.exists?(project_env_file)
+          ARGV << "--require" << project_env_file
+        end
+      end
+
+    end
+  end
+end

data/lib/watirspec/spec_helper.rb

@@ -0,0 +1,68 @@
+module WatiRspec
+  # main helper module
+  #
+  # these methods can be used in specs directly
+  module SpecHelper
+    include Waiter
+
+    # opens the browser at specified url
+    def open_browser_at url
+      @browser = Watir::Browser.new
+      @browser.speed = :fast
+      add_checker Watir::PageCheckers::JAVASCRIPT_ERRORS_CHECKER
+      begin
+        formatter.browser = @browser
+      rescue
+      end
+      goto url
+      maximize
+    end
+
+    # downloads file with browser
+    #
+    # you need to use click_no_wait to use this method:
+    #   button(:id => "something").click_no_wait # opens a browser save as dialog
+    #   download_file("document.pdf")
+    #
+    # * raises an exception if saving the file is unsuccessful
+    # * returns absolute file_path of the saved file
+    def download_file file_name
+      AutoItHelper.click_save
+      file_path = native_file_path(file_path(file_name))
+      AutoItHelper.set_edit(file_path)
+      AutoItHelper.click_save("Save As")
+      wait_until! {File.exists?(file_path)}
+      file_path
+    end
+
+    # returns WatiRspec::HtmlFormatter object, nil if not in use
+    def formatter
+      @formatter ||= Spec::Runner.options.formatters.find {|f| f.kind_of?(WatiRspec::HtmlFormatter) rescue false}
+    end
+
+    # returns unique file path for use in examples.
+    #
+    # all file names generated with this method will
+    # be shown on the report upon test failure.
+    def file_path(file_name, description=nil)
+      formatter.file_path(file_name, description)
+    rescue
+      extension = File.extname(file_name)
+      basename = File.basename(file_name, extension)
+      file_path = File.join(Dir.pwd, "#{basename}_#{Time.now.strftime("%H%M%S")}#{extension}")
+      file_path
+    end
+
+    # returns native file path
+    # e.g. on Windows:
+    #   native_file_path("c:/blah/blah2/file.txt") => c:\\blah\\blah2\\file.txt 
+    def native_file_path(file_path)
+      File::ALT_SEPARATOR ? file_path.gsub(File::SEPARATOR, File::ALT_SEPARATOR) : file_path
+    end
+
+    def method_missing name, *arg #:nodoc:
+      @browser.respond_to?(name) ? @browser.send(name, *arg) : super
+    end
+
+  end
+end

data/lib/watirspec/util.rb

@@ -0,0 +1,35 @@
+module WatiRspec
+  # 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/watirspec/version.rb

@@ -0,0 +1,3 @@
+module WatiRspec
+  VERSION = "0.1.0" #:nodoc:
+end

data/lib/watirspec/waiter.rb

@@ -0,0 +1,29 @@
+module WatiRspec
+  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/watirspec/watir.rb

@@ -0,0 +1,80 @@
+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 #:nodoc:all
+  class IE
+    # 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
+  end
+
+  module PageContainer
+    # 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
+end

data/lib/watirspec.rb

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

data/spec/spec_helper_spec.rb

@@ -0,0 +1,56 @@
+require "watirspec"
+require "spec/autorun"
+
+describe WatiRspec::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/util_spec.rb

@@ -0,0 +1,38 @@
+require "watirspec"
+require "spec/autorun"
+
+describe WatiRspec::Util do
+
+  it "loads ui-test-common" do
+    class WatiRspec::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 {WatiRspec::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 WatiRspec::Util
+      @@ui_test_common_dir = "nonexisting_ui_test_common_dir"
+    end
+
+    lambda {WatiRspec::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/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 require this file from your projects' environment.rb, which
+  will use common functionality:
+  require_rel "../../../ui-test-common/environment.rb
+
+  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,10 @@
+# you can create under this directory common libraries/helpers/methods which you could
+# use within your specs in different projects
+
+module CommonApplicationHelper
+
+  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,18 @@
+# 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
+    URL = "about:blank"
+  end
+end
+
+# A global configuration for specs, 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,10 @@
+# add all your require statements into this file to avoid unnecessary
+# code in your spec files
+
+# 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 "watirspec/runner"
+exit ::WatiRspec::Runner.run

data/templates/project/spec/dummy_spec.rb

@@ -0,0 +1,44 @@
+# this is just a fully working dummy spec file which you can run to see if
+# your configuration is correct and everything is working
+
+describe "WatiRspec" 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 'watirspec generate_common' command
+and ui-test-common is not loaded by this project" do
+      new_global_method.should == "it just works"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification 
+name: watirspec
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jarmo Pertman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-03 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: watir
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 6
+        - 5
+        version: 1.6.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: diff-lcs
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: require_all
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 12
+        - 0
+        version: 2.12.0
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: syntax
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: win32console
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+description: Combines best features of Watir, RSpec and Ruby for browser-based functional testing.
+email: 
+- jarmo.p@gmail.com
+executables: 
+- watirspec
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- History.rdoc
+- License.txt
+files: 
+- bin/watirspec
+- History.rdoc
+- lib/spec.opts
+- lib/watirspec/autoit.rb
+- lib/watirspec/html_formatter.rb
+- lib/watirspec/rspec.rb
+- lib/watirspec/runner.rb
+- lib/watirspec/spec_helper.rb
+- lib/watirspec/util.rb
+- lib/watirspec/version.rb
+- lib/watirspec/waiter.rb
+- lib/watirspec/watir.rb
+- lib/watirspec.rb
+- License.txt
+- Rakefile
+- README.rdoc
+- spec/spec_helper_spec.rb
+- spec/util_spec.rb
+- templates/common/config.rb
+- templates/common/environment.rb
+- templates/common/lib/common_application_helper.rb
+- templates/project/application_helper.rb
+- templates/project/config.rb
+- templates/project/environment.rb
+- templates/project/ide_runner.rb
+- templates/project/spec/dummy_spec.rb
+- watirspec-0.1.0.gem
+has_rdoc: true
+homepage: http://github.com/jarmo/WatiRspec
+licenses: []
+
+post_install_message: |-
+  *************************
+  
+  Thank you for installing WatiRspec! Don't forget to take a look at README file!
+  
+  Execute "watirspec generate" under your project's directory to generate default project structure.
+  
+  *************************
+rdoc_options: 
+- --main
+- README.rdoc
+- --template
+- hanna
+- --inline-source
+- --format=html
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: watirspec 0.1.0
+test_files: []
+