watirsplash 1.4.3 → 2.0.0.rc1

data/.gitignore

@@ -0,0 +1,7 @@
+coverage/
+pkg/
+archive/
+results/
+.idea
+todo.txt
+rdoc/

data/.rspec

@@ -0,0 +1,2 @@
+--require
+spec/environment.rb

data/Gemfile

@@ -0,0 +1,16 @@
+source :rubygems
+
+# load WatirSplash and it's dependencies
+gemspec
+
+platforms :mingw, :mswin do
+    gem "watir", WatirSplash::Version::WATIR
+    gem "win32screenshot", WatirSplash::Version::WIN32SCREENSHOT, :require => "win32/screenshot"
+end
+
+gem "watir-webdriver", WatirSplash::Version::WATIR_WEBDRIVER
+gem "firewatir", WatirSplash::Version::WATIR
+gem "rspec", "~>2.6.0"
+
+# add your project specific dependencies here:
+# gem "ruby-debug", "0.10.3"

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    watirsplash (1.5.0)
+      bundler (~> 1.0)
+      rake (= 0.8.7)
+      require_all
+      rspec (~> 2.6)
+      syntax
+      thor (~> 0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    childprocess (0.1.9)
+      ffi (~> 1.0.6)
+    commonwatir (1.9.0)
+      user-choices
+    diff-lcs (1.1.2)
+    ffi (1.0.9-x86-mingw32)
+    firewatir (1.9.0)
+      commonwatir (= 1.9.0)
+    hoe (2.9.4)
+      rake (>= 0.8.7)
+    json_pure (1.5.3)
+    mini_magick (3.2.1)
+      subexec (~> 0.0.4)
+    nokogiri (1.4.5-x86-mingw32)
+    rake (0.8.7)
+    rautomation (0.5.1)
+    require_all (1.2.0)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rubyzip (0.9.4)
+    s4t-utils (1.0.4)
+      hoe (>= 1.3.0)
+    selenium-webdriver (0.2.2)
+      childprocess (>= 0.1.9)
+      ffi (>= 1.0.7)
+      json_pure
+      rubyzip
+    subexec (0.0.4)
+    syntax (1.0.0)
+    thor (0.14.6)
+    user-choices (1.1.6.1)
+      builder (>= 2.1.2)
+      s4t-utils (>= 1.0.3)
+      xml-simple (>= 1.0.11)
+    watir (1.9.0)
+      commonwatir (= 1.9.0)
+      ffi (~> 1.0)
+      firewatir (= 1.9.0)
+      nokogiri
+      rautomation (~> 0.5)
+      win32-process (>= 0.5.5)
+      windows-pr (>= 0.6.6)
+    watir-webdriver (0.2.5)
+      selenium-webdriver (>= 0.2.2)
+    win32-api (1.4.8-x86-mingw32)
+    win32-process (0.6.5)
+      windows-pr (>= 1.1.2)
+    win32screenshot (1.0.4)
+      ffi (~> 1.0)
+      mini_magick (~> 3.2.0)
+      rautomation (~> 0.5)
+    windows-api (0.4.0)
+      win32-api (>= 1.4.5)
+    windows-pr (1.2.0)
+      win32-api (>= 1.4.5)
+      windows-api (>= 0.3.0)
+    xml-simple (1.0.16)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  firewatir (= 1.9.0)
+  watir (= 1.9.0)
+  watir-webdriver (~> 0.2.5)
+  watirsplash!
+  win32screenshot (~> 1.0.4)

data/README.rdoc

@@ -6,8 +6,8 @@
 == DESCRIPTION
 
 WatirSplash makes browser-based web page testing in Ruby splashin' easy.
-It combines Watir (http://www.watir.com) for controlling the browser and
-RSpec (http://relishapp.com/rspec) for testing framework. This powerful combination gives you
+It combines Watir, FireWatir or Watir-WebDriver for controlling the browser and
+RSpec 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.
 
@@ -15,78 +15,100 @@ WatirSplash makes it easier to use best features of both of these tools together
 you won't have to spend time on thinking how to do that yourself - you can start
 testing right away!
 
-== SYNOPSIS
-
-=== With vanilla Watir and RSpec
-    require 'watir'
-    require 'rspec'
-
-    describe "Google" do
-        before :all do
-            @browser = Watir::Browser.new
-            @browser.maximize
-            @browser.goto "http://google.com"
-            @browser.url.should =~ /google/
+== GETTING STARTED
+
+1) Install Ruby (version 1.8.7 is recommended)
+
+2) Install WatirSplash
+    C:\my_project>gem install watirsplash
+
+3) Create a new project
+    C:\my_project>watirsplash new
+          create  ui-test
+          ...
+
+    C:\my_project>cd ui-test
+
+4) Install all possible runtime dependencies
+    C:\my_project\ui-test>bundle install
+    Fetching source index for http://rubygems.org/
+    ...
+    Using watirsplash
+    ...
+
+5) Create a "search" page class and a spec skeleton for it
+    C:\my_project\ui-test>watirsplash page search --url http://bing.com
+          create  lib
+          create  lib/app/page/search.rb
+          create  spec
+          create  spec/app/page/search_spec.rb
+
+6) Create a "results" page class without spec
+    C:\Users\jarmo\Desktop\minu\projects\Ruby\my_project\ui-test>watirsplash page results --no-spec
+           exist  lib
+          create  lib/app/page/results.rb
+
+7) Modify the created files
+    # lib\app\page\search.rb
+    module App
+      module Page
+        class Search < WatirSplash::Page::Base
+          url "http://bing.com"
+
+          def search_field
+            text_field(:name => "q")
+          end
+
+          def search_button
+            return_for button(:name => "go"),
+              # clicking the search button results a page transition to "results" page
+              :click => lambda {Results.new @browser}
+          end
         end
+      end
+    end
 
-        it "has search field" do
-            text_field = @browser.text_field(:name => "q")
-            text_field.should exist
-            text_field.should be_visible
-        end
 
-        it "performs search" do
-            @browser.text_field(:name => "q").set "Bing"
-            @browser.button(:name => "btnG").click
-            @browser.text.should include("Bing")
-        end
+    # lib\app\page\results.rb
+    module App
+      module Page
+        class Results < WatirSplash::Page::Base
+
+          def result index
+            div(:id => "results").
+              ul(:class => "sb_results").
+              li(:class => /sa_wr/, :index => index).
+              text
+          end
 
-        after :all do
-            @browser.close
         end
+      end
     end
 
 
-
-=== With WatirSplash
-    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
+    # spec\app\page\search_spec.rb
+    describe App::Page::Search do
+      it "has something on the search page" do
+        search_page = App::Page::Search.new
+        search_page.search_field.set "watirsplash"
+        results_page = search_page.search_button.click
+        results_page.result(1).should =~ /watirsplash/i
+      end
     end
-    
-    C:\project\ui-test>rspec 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
+8) Execute all specs
+    C:\my_project\ui-test>rspec spec
+    Results will be saved into the directory C:/my_project/ui-test/results
 
-    2 examples, 0 failures
+    App::Page::Search @ app/page/search_spec.rb:1 (30.06.2011)
+      has something on the search page:2 (09:34:30)
 
-== INSTALL
+    Finished in 4.48 seconds
+    1 example, 0 failures
 
-1) install Ruby
-    
-2) install WatirSplash:
-    gem install watirsplash
+9) Check out the html report at results/index.html
 
-3) execute in your project's directory:
-    watirsplash new
+10) Repeat & profit! 
 
 == SUPPORTED PLATFORMS & BROWSERS
 
@@ -99,15 +121,17 @@ Each framework drives a specific browser:
 * 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:
+It is possible to specify what framework to use in config.rb file:
     WatirSplash::Util.framework = "watir-webdriver/firefox"
 
-If framework is not specified manually then a default framework will be used for the current platform.
+It is also possible to specify used framework by using environment variable WATIRSPLASH_FRAMEWORK.
+
+If framework is not specified manually then the 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?
+== MORE INFORMATION?
 
 You can read more information about the usage and features from the wiki at http://github.com/jarmo/WatirSplash/wiki
 

data/Rakefile

@@ -1,42 +1,6 @@
 require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    version = File.read("VERSION").strip
-    gem.name = "watirsplash"
-    gem.summary = %Q{watirsplash #{version}}
-    gem.description = %q{WatirSplash makes testing of web applications splashin' easy by combining best features of Watir, RSpec and Ruby!}
-    gem.email = "jarmo.p@gmail.com"
-    gem.homepage = "http://github.com/jarmo/WatirSplash"
-    gem.authors = ["Jarmo Pertman"]
-    gem.executables = ["watirsplash"]
-    gem.extra_rdoc_files = ["README.rdoc", "History.rdoc", "License.txt"]
-    gem.rdoc_options << "--main" << "README.rdoc" <<
-    "--template" << "hanna" <<
-    "--inline-source" << "--format=html"
-    ignored_files = File.readlines(".gitignore").map {|l| l.strip.gsub("*", "")}
-    ignored_files << ".gitignore" << ".gemspec"
-    gem.files = Dir.glob("**/*").delete_if {|f| f =~ Regexp.union(*ignored_files)}
-    gem.files << "lib/watirsplash/generators/templates/new_project/.rspec"
-    gem.post_install_message = %Q{#{"*"*25}
-
-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 a default project structure.
-
-#{"*"*25}}
-
-    gem.add_dependency("rspec", "~>2.6")
-    gem.add_dependency("thor", "~>0")
-    gem.add_dependency("require_all")
-    gem.add_dependency("syntax")
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
@@ -49,10 +13,8 @@ task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "WatirSplash #{version}"
+  rdoc.title = "WatirSplash #{WatirSplash::Version::WATIRSPLASH}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/watirsplash.rb

@@ -2,6 +2,7 @@ require "rubygems"
 require "require_all"
 require "rspec"
 require "pathname"
+require_rel "watirsplash/version" unless defined? WatirSplash::Version
 require_rel "watirsplash/browser"
 require_rel "watirsplash/file_helper"
 require_rel "watirsplash/spec_helper"
@@ -9,7 +10,6 @@ require_rel "watirsplash/rspec_patches"
 require_rel "watirsplash/util"
 require_rel "watirsplash/html_formatter"
 require_rel "watirsplash/frameworks/helper"
+require_rel "watirsplash/page/base"
 WatirSplash::Util.configure_rspec_formatters
-WatirSplash::Util.load_environment
-WatirSplash::Util.load_framework
 

data/lib/watirsplash/browser.rb

@@ -1,7 +1,9 @@
 module WatirSplash
   class Browser
     def self.new
-      Watir::Browser.new
+      browser = Watir::Browser.new
+      Util.formatter.browser = browser
+      browser
     end    
   end
 end

data/lib/watirsplash/cli.rb

@@ -1,39 +1,35 @@
 require "thor"
 require "thor/group"
+require "watirsplash/generators/helper"
 require "watirsplash/generators/new_project"
-require "watirsplash/generators/new_common_project"
-require "watirsplash/generators/migrate_project"
+require "watirsplash/generators/page"
 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]", "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[:framework], options.load_common?])
-    end
+    extend Generators::Helper
 
-    desc "new_common", "Create a new WatirSplash common project."
-    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], options[:framework]])
+    unless Dir.entries(Dir.pwd).include? ".rspec"
+      desc "new [DIRECTORY_NAME]", "Create a new WatirSplash project."
+      method_option :url, :default => "about:blank", :aliases => "-u",
+        :desc => "URL for the application under test."
+      method_option :framework, :default => "default", :aliases => "-f",
+        :desc => "Framework to use. Possible values are #{supported_frameworks.join(", ")}."
+      def new(name = "ui-test")
+        WatirSplash::Generators::NewProject.start([name, options[:url], options[:framework]])
+      end
     end
 
-    if File.basename(Dir.pwd) =~ /^ui-test(-common)?$/
-      desc "migrate", "Migrates old WatirSplash generated project to new."
-      def migrate
-        WatirSplash::Generators::MigrateProject.start
+    if Dir.entries(Dir.pwd).include? ".rspec"
+      desc "page PAGE_NAME [element_name:element_type:locator_name:locator_value]", "Create a new WatirSplash page."
+      method_option :spec, :default => true, :aliases => "-s", :type => :boolean,
+        :desc => "Create spec file for page."
+      method_option :url, :default => nil, :aliases => "-u",
+        :desc => "URL for the page if directly accessible."
+      method_option :module, :default => "App", :aliases => "-m",
+        :desc => "Namespace module for the page."
+      def page(page_name = "Main", *elements)
+        WatirSplash::Generators::Page.start([page_name.gsub("-", "_"), elements, options[:module].gsub("-", "_"), options[:spec], options[:url]])
       end
     end