watirsplash 1.0.0 → 1.1.0

data/History.rdoc

@@ -1,3 +1,8 @@
+=== Version 1.1.0 / 2011-02-17
+
+ * browser methods will be cached by #method_missing for faster lookup
+ * added support for different frameworks - Watir, FireWatir and Watir-WebDriver
+
 === Version 1.0.0 / 2011-01-26
 
  * using RSpec 2

data/README.rdoc

@@ -80,16 +80,34 @@ testing right away!
 
 == INSTALL
 
-1) install Ruby 1.8:
-    http://rubyinstaller.org/
+1) install Ruby
     
 2) install WatirSplash:
     gem install watirsplash
 
-3) in your project's directory:
+3) execute in your project's directory:
     watirsplash new
 
-== WHAT NEXT?
+== SUPPORTED PLATFORMS & BROWSERS
+
+WatirSplash supports different frameworks/browsers on different operating systems:
+* Linux & OS X - firewatir, watir-webdriver/chrome and watir-webdriver/firefox
+* Windows - firewatir, watir, watir-webdriver/chrome, watir-webdriver/ie, watir-webdriver/firefox
+
+Each framework drives a specific browser:
+* FireWatir - Firefox
+* Watir - IE
+* Watir-WebDriver - Chrome, IE and Firefox
+
+It is possible to specify what framework to use in ui-test/config.rb and/or in ui-test-common/config.rb files:
+    WatirSplash::Util.framework = "watir-webdriver/firefox"
+
+If framework is not specified manually then a default framework will be used for the current platform.
+
+PS! Please note that all frameworks are not 100% compatible with each other. If you find any concrete incompatibilities then
+it would be great if you'd contribute fixes or information to the authors of the frameworks.
+
+== WHAT'S NEXT?
 
 You can read more information about the usage and features from the wiki at http://github.com/jarmo/WatirSplash/wiki
 

data/Rakefile

@@ -24,21 +24,15 @@ begin
 
 Thank you for installing WatirSplash #{version}! Don't forget to take a look at the README and History files!
 
-Execute `watirsplash new` under your project's directory to generate default project structure.
-
-PS! If you are using older WatirSplash version <= 0.2.14, then execute `watirsplash migrate` under ui-test and ui-test-common!
+Execute `watirsplash new` under your project's directory to generate a default project structure.
 
 #{"*"*25}}
 
-    gem.add_dependency("watir", "=1.7.1")
-    gem.add_dependency("rspec", "~>2.4")
+    gem.add_dependency("rspec", "~>2.5")
     gem.add_dependency("require_all")
-    gem.add_dependency("syntax")
     gem.add_dependency("thor", "~>0")
-    gem.add_dependency("rautomation", "~>0.4")
     gem.add_dependency("require_all")
     gem.add_dependency("syntax")
-    gem.add_dependency("win32screenshot", "~>1.0.2")
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/environment.rb

@@ -0,0 +1,2 @@
+WatirSplash::Util.framework = "watir"
+

data/lib/watirsplash/browser.rb

@@ -0,0 +1,8 @@
+module WatirSplash
+  class Browser
+    def self.new
+      Watir::Browser.new
+    end    
+  end
+end
+

data/lib/watirsplash/cli.rb

@@ -3,24 +3,31 @@ require "thor/group"
 require "watirsplash/generators/new_project"
 require "watirsplash/generators/new_common_project"
 require "watirsplash/generators/migrate_project"
+require "watirsplash/util"
 
 module WatirSplash
   class CLI < Thor
+    framework_option = proc do
+      method_option :framework, :default => WatirSplash::Util.send(:default_framework).to_s, :aliases => "-f",
+        :desc => "Framework to use. Possible values are watir, firewatir, watir-webdriver/ie, watir-webdriver/firefox, watir-webdriver/chrome."
+    end
 
-    desc "new [APPLICATION_NAME]", "Creates a new WatirSplash project."
+    desc "new [APPLICATION_NAME]", "Create a new WatirSplash project."
     method_option :load_common, :type => :boolean, :default => false, :aliases => "-l",
       :desc => "Load WatirSplash common project automatically."
     method_option :url, :default => "about:blank", :aliases => "-u",
       :desc => "URL to open in the browser before each test. May be relative if WatirSplash common project is loaded."
+    framework_option.call
     def new(name = "Application")
-      WatirSplash::Generators::NewProject.start([Thor::Util.camel_case(name), options[:url], options.load_common?])
+      WatirSplash::Generators::NewProject.start([Thor::Util.camel_case(name), options[:url], options[:framework], options.load_common?])
     end
 
     desc "new_common", "Create a new WatirSplash common project."
-    method_option :url, :default => "http://localhost",
-      :desc => "url for the application main page" 
+    method_option :url, :default => "http://localhost", :aliases => "-u",
+      :desc => "URL for the application main page." 
+    framework_option.call    
     def new_common
-      WatirSplash::Generators::NewCommonProject.start([options[:url]])
+      WatirSplash::Generators::NewCommonProject.start([options[:url], options[:framework]])
     end
 
     if File.basename(Dir.pwd) =~ /^ui-test(-common)?$/

data/lib/watirsplash/frameworks/firewatir.rb

@@ -0,0 +1,15 @@
+WatirSplash::Frameworks::Helper.load_gem :gem => "firewatir", :version => "1.7.1"
+
+module FireWatir #:nodoc:all
+  class Firefox
+    def exists?
+      js_eval("getWindows().length").to_i == 1 || find_window(:url, @window_url) > 0
+    end
+
+    alias_method :exist?, :exists?
+
+    def save_screenshot(params)
+      # currently not yet supported
+    end
+  end
+end

data/lib/watirsplash/frameworks/helper.rb

@@ -0,0 +1,29 @@
+module WatirSplash
+  module Frameworks
+    class Helper
+      class << self
+        def load_gems *gems
+          failed_gems = []
+          gems.each do |gem_params|
+            begin
+              gem gem_params[:gem], gem_params[:version]
+              require gem_params[:require] || gem_params[:gem]
+            rescue Gem::LoadError
+              failed_gems << gem_params
+            end
+          end
+          unless failed_gems.empty?
+            puts "\nSome dependencies are missing. Install them with:"
+            failed_gems.each do |failed_gem|
+              puts "  gem install #{failed_gem[:gem]}#{failed_gem[:version] ? " -v #{failed_gem[:version].gsub(/^[~>=]*\s*/, "")}" : ""}"
+            end
+            puts
+            exit 1 unless failed_gems.empty?          
+          end
+        end
+
+        alias_method :load_gem, :load_gems
+      end
+    end
+  end
+end

data/lib/watirsplash/frameworks/watir-webdriver/chrome.rb

@@ -0,0 +1,9 @@
+require_rel "../watir-webdriver.rb"
+
+module WatirSplash
+  class Browser
+    def self.new
+      Watir::Browser.new :chrome
+    end
+  end
+end

data/lib/watirsplash/frameworks/watir-webdriver/firefox.rb

@@ -0,0 +1,9 @@
+require_rel "../watir-webdriver.rb"
+
+module WatirSplash
+  class Browser
+    def self.new
+      Watir::Browser.new :firefox
+    end
+  end
+end

data/lib/watirsplash/frameworks/watir-webdriver/ie.rb

@@ -0,0 +1,10 @@
+require_rel "../watir-webdriver.rb"
+WatirSplash::Frameworks::Helper.load_gem :gem => "win32screenshot", :require => "win32/screenshot"
+
+module WatirSplash
+  class Browser
+    def self.new
+      Watir::Browser.new :ie
+    end
+  end
+end

data/lib/watirsplash/frameworks/watir-webdriver.rb

@@ -0,0 +1,10 @@
+WatirSplash::Frameworks::Helper.load_gem :gem => "watir-webdriver", :version => ">=0.2.0"
+
+module Watir
+  class Browser
+    def save_screenshot(params)
+      driver.save_screenshot(params[:file_name])
+    end
+  end
+end
+

data/lib/watirsplash/{watir_patches.rb → frameworks/watir.rb}

@@ -1,3 +1,7 @@
+WatirSplash::Frameworks::Helper.load_gems({:gem => "watir", :version => "1.7.1"}, 
+  {:gem => "win32screenshot", :require => "win32/screenshot", :version => ">=1.0.2"})
+require "watir/ie"
+
 module Watir
   module PageCheckers
     # raises an error if javascript error was found
@@ -8,10 +12,24 @@ end
 # patches for Watir
 module Watir
   class IE #:nodoc:all
-    # trigger autoloading
+    alias_method :_initialize, :initialize
+
+    def initialize suppress_new_window=nil
+      _initialize suppress_new_window
+      self.speed = :fast
+      add_checker Watir::PageCheckers::JAVASCRIPT_ERRORS_CHECKER
+      maximize
+    end
+
+    def save_screenshot(params)
+      params[:hwnd] ||= hwnd
+      ::Win32::Screenshot::Take.of(:window, :hwnd => params[:hwnd]).write(params[:file_name])
+    rescue => e
+      $stderr.puts "saving of screenshot failed: #{e.message}"
+    end
   end
 
-  class Element #:nodoc:all
+  class Element 
     # saves a file with the browser
     #
     # clicking the button opens a browser's save as dialog and saves the file document.pdf
@@ -45,4 +63,4 @@ module Watir
     end
   end
 
-end
+end

data/lib/watirsplash/generators/new_common_project.rb

@@ -4,6 +4,7 @@ module WatirSplash
       include Thor::Actions
 
       argument :url 
+      argument :framework
 
       def self.source_root
         File.dirname(__FILE__) + "/templates"

data/lib/watirsplash/generators/new_project.rb

@@ -7,6 +7,7 @@ module WatirSplash
 
       argument :name 
       argument :url
+      argument :framework
       argument :load_common, :optional => true
 
       def self.source_root

data/lib/watirsplash/generators/templates/new_common_project/config.rb.tt

@@ -1,3 +1,11 @@
+# What framework to use? Possible values are:
+#   * watir
+#   * firewatir
+#   * watir-webdriver/ie
+#   * watir-webdriver/firefox
+#   * watir-webdriver/chrome
+<%= "WatirSplash::Util.framework = \"#{framework}\"" %> 
+
 =begin
   Global configuration constants
   For example, you can use the URL constant below from your projects' config.rb like this:

data/lib/watirsplash/generators/templates/new_project/config.rb.tt

@@ -1,3 +1,15 @@
+# What framework to use? Possible values are:
+#   * watir
+#   * firewatir
+#   * watir-webdriver/ie
+#   * watir-webdriver/firefox
+#   * watir-webdriver/chrome
+<%=
+  load_cmd = ""
+  load_cmd += "# " if load_common
+  load_cmd += "WatirSplash::Util.framework = \"#{framework}\""
+%> 
+
 # Config for your application
 module Config
   module <%= name %>

data/lib/watirsplash/html_formatter.rb

@@ -1,5 +1,4 @@
 require 'rspec/core/formatters/html_formatter'
-require 'win32/screenshot'
 require 'pathname'
 require 'fileutils'
 
@@ -39,7 +38,7 @@ module WatirSplash
     end
 
     def extra_failure_content(exception) # :nodoc:
-      if @browser.exists?
+      if @browser && @browser.exists?
         save_screenshot
         save_html
       end
@@ -72,13 +71,7 @@ module WatirSplash
 
     def save_screenshot(description="Screenshot", hwnd=nil) # :nodoc:
       file_name = file_path("screenshot.png", description)
-      hwnd ||= @browser.hwnd
-      @browser.bring_to_front
-      begin
-        Win32::Screenshot::Take.of(:window, :hwnd => hwnd).write(file_name)
-      rescue => e
-        $stderr.puts "saving of screenshot failed: #{e.message}"
-      end
+      @browser.save_screenshot(:file_name => file_name, :hwnd => hwnd)
       file_name
     end
 

data/lib/watirsplash/rspec_patches.rb

@@ -35,7 +35,7 @@ RSpec.configure do |config| #:nodoc:
   end
 
   config.after(:all) do
-    close
+    close if @browser
   end
 end
 

data/lib/watirsplash/spec_helper.rb

@@ -6,16 +6,22 @@ module WatirSplash
 
     # 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
+      @browser = WatirSplash::Browser.new
       Util.formatter.browser = @browser 
       goto url
-      maximize
     end
-    
+
     def method_missing name, *args #:nodoc:
-      @browser.respond_to?(name) ? @browser.send(name, *args) {yield} : super
+      if @browser.respond_to?(name)
+        SpecHelper.module_eval %Q[
+          def #{name}(*args)
+            @browser.send(:#{name}, *args) {yield}
+          end
+        ]
+        @browser.send(name, *args) {yield}
+      else
+        super
+      end
     end
 
     # make sure that using method 'p' will be invoked on @browser
@@ -26,4 +32,4 @@ module WatirSplash
     end
 
   end
-end
+end

data/lib/watirsplash/util.rb

@@ -35,8 +35,34 @@ module WatirSplash
         @@html_formatter
       end
 
+      @@framework = nil
+
+      def framework= framework
+        @@framework = framework.to_sym
+      end
+
+      def framework
+        @@framework
+      end
+
+      def load_framework
+        self.framework = ENV["WATIRSPLASH_FRAMEWORK"] || framework || default_framework
+        require "watirsplash/frameworks/#{framework}"        
+      end
+
       private
 
+      def default_framework
+        case RUBY_PLATFORM
+        when /mswin|msys|mingw32/
+          :watir
+        when /darwin|linux/
+          :firewatir
+        else
+          raise "Unsupported platform: #{RUBY_PLATFORM}"
+        end
+      end
+
       def common_dir
         ui_test_common_dir = "ui-test-common"
         Pathname(Dir.pwd).ascend do |path|
@@ -54,4 +80,4 @@ module WatirSplash
 
     end
   end
-end
+end

data/lib/watirsplash.rb

@@ -1,15 +1,15 @@
 require "rubygems"
 require "require_all"
-require "rautomation"
 require "rspec"
-require "watir"
 require "pathname"
+require_rel "watirsplash/browser"
 require_rel "watirsplash/file_helper"
 require_rel "watirsplash/spec_helper"
 require_rel "watirsplash/rspec_patches"
-require_rel "watirsplash/watir_patches"
 require_rel "watirsplash/util"
 require_rel "watirsplash/html_formatter"
+require_rel "watirsplash/frameworks/helper"
 WatirSplash::Util.configure_rspec_formatters
 WatirSplash::Util.load_environment
+WatirSplash::Util.load_framework
 

data/spec/watir_ie_spec.rb

@@ -1,10 +1,10 @@
-describe Watir::IE do
+describe "Watir::IE", :if => WatirSplash::Util.framework == :watir do
 
   before :each do
     goto "http://dl.dropbox.com/u/2731643/WatirSplash/test.html"
   end
 
-  context Watir::Element do
+  context "Watir::Element" do
     context "#save_as" do
       it "saves file with the browser" do
         begin
@@ -21,7 +21,7 @@ describe Watir::IE do
     end
   end
 
-  context Watir::FileField do
+  context "Watir::FileField" do
     context "#set" do
       it "sets the file to upload with the browser" do
         field = file_field(:id => "upload")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: watirsplash
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Jarmo Pertman
@@ -15,58 +15,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 +02:00
+date: 2011-02-17 00:00:00 +02:00
 default_executable: watirsplash
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: watir
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 7
-        - 1
-        version: 1.7.1
-  type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 9
         segments: 
         - 2
-        - 4
-        version: "2.4"
+        - 5
+        version: "2.5"
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: require_all
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: syntax
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -76,11 +46,11 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: thor
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -90,26 +60,11 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rautomation
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        - 4
-        version: "0.4"
-  type: :runtime
-  version_requirements: *id006
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: require_all
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -119,11 +74,11 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id007
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: syntax
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -133,23 +88,7 @@ dependencies:
         - 0
         version: "0"
   type: :runtime
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: win32screenshot
-  prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 0
-        - 2
-        version: 1.0.2
-  type: :runtime
-  version_requirements: *id009
+  version_requirements: *id005
 description: WatirSplash makes testing of web applications splashin' easy by combining best features of Watir, RSpec and Ruby!
 email: jarmo.p@gmail.com
 executables: 
@@ -167,9 +106,18 @@ files:
 - Rakefile
 - VERSION
 - bin/watirsplash
+- environment.rb
 - lib/watirsplash.rb
+- lib/watirsplash/browser.rb
 - lib/watirsplash/cli.rb
 - lib/watirsplash/file_helper.rb
+- lib/watirsplash/frameworks/firewatir.rb
+- lib/watirsplash/frameworks/helper.rb
+- lib/watirsplash/frameworks/watir-webdriver.rb
+- lib/watirsplash/frameworks/watir-webdriver/chrome.rb
+- lib/watirsplash/frameworks/watir-webdriver/firefox.rb
+- lib/watirsplash/frameworks/watir-webdriver/ie.rb
+- lib/watirsplash/frameworks/watir.rb
 - lib/watirsplash/generators/migrate_project.rb
 - lib/watirsplash/generators/new_common_project.rb
 - lib/watirsplash/generators/new_project.rb
@@ -185,7 +133,6 @@ files:
 - lib/watirsplash/rspec_patches.rb
 - lib/watirsplash/spec_helper.rb
 - lib/watirsplash/util.rb
-- lib/watirsplash/watir_patches.rb
 - spec/file_helper_spec.rb
 - spec/spec_helper_spec.rb
 - spec/spec_match_array_spec.rb
@@ -198,11 +145,9 @@ licenses: []
 post_install_message: |-
   *************************
   
-  Thank you for installing WatirSplash 1.0.0! Don't forget to take a look at the README and History files!
-  
-  Execute `watirsplash new` under your project's directory to generate default project structure.
+  Thank you for installing WatirSplash 1.1.0! Don't forget to take a look at the README and History files!
   
-  PS! If you are using older WatirSplash version <= 0.2.14, then execute `watirsplash migrate` under ui-test and ui-test-common!
+  Execute `watirsplash new` under your project's directory to generate a default project structure.
   
   *************************
 rdoc_options: 
@@ -239,7 +184,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: watirsplash 1.0.0
+summary: watirsplash 1.1.0
 test_files: 
 - spec/file_helper_spec.rb
 - spec/spec_helper_spec.rb