watirsplash 0.2.14 → 1.0.0

data/History.rdoc

@@ -1,3 +1,11 @@
+=== Version 1.0.0 / 2011-01-26
+
+ * using RSpec 2
+   - if you have projects using WatirSplash <= 0.2.14 then execute `watirsplash migrate` under ui-test and ui-test-common directories!
+ * removed Watir::WaitHelper - use Watir's waiting methods instead
+ * using Watir 1.7.1
+ * use WATIRSPLASH_RESULTS_PATH environment variable for specifying custom spec results location
+
 === Version 0.2.14 / 2011-01-25
 
 * use newer RAutomation

data/License.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2010 Jarmo Pertman
+Copyright (c) 2010-2011 Jarmo Pertman
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -21,4 +21,4 @@ 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
+OTHER DEALINGS IN THE SOFTWARE

data/README.rdoc

@@ -7,7 +7,7 @@
 
 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://rspec.info) for testing framework. This powerful combination gives you
+RSpec (http://relishapp.com/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.
 
@@ -19,7 +19,7 @@ testing right away!
 
 === With vanilla Watir and RSpec
     require 'watir'
-    require 'spec'
+    require 'rspec'
 
     describe "Google" do
         before :all do
@@ -68,7 +68,7 @@ testing right away!
         end
     end
     
-    C:\project\ui-test>spec spec\google_spec.rb
+    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
@@ -87,7 +87,7 @@ testing right away!
     gem install watirsplash
 
 3) in your project's directory:
-    watirsplash generate
+    watirsplash new
 
 == WHAT NEXT?
 
@@ -95,4 +95,4 @@ You can read more information about the usage and features from the wiki at http
 
 == COPYRIGHT
 
-Copyright © 2010 Jarmo Pertman. See LICENSE for details.
+Copyright © 2010-2011 Jarmo Pertman. See LICENSE for details.

data/Rakefile

@@ -14,26 +14,30 @@ begin
     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"
+    "--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 README and History files!
+Thank you for installing WatirSplash #{version}! Don't forget to take a look at the README and History files!
 
-Execute "watirsplash generate" under your project's directory to generate default project structure.
+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!
 
 #{"*"*25}}
 
-    gem.add_dependency("watir", "=1.6.6")
-    gem.add_dependency("rspec", "=1.3.0")
-    gem.add_dependency("diff-lcs")
+    gem.add_dependency("watir", "=1.7.1")
+    gem.add_dependency("rspec", "~>2.4")
+    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("win32console")
     gem.add_dependency("win32screenshot", "~>1.0.2")
   end
   Jeweler::GemcutterTasks.new
@@ -41,16 +45,11 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
 end
 
 task :default => :spec

data/VERSION

@@ -1 +1 @@
-0.2.14
+1.0.0

data/bin/watirsplash

@@ -1,10 +1,3 @@
 #!/usr/bin/env ruby
-watirsplash_dir = File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
-$LOAD_PATH.unshift(watirsplash_dir) unless $LOAD_PATH.include?(watirsplash_dir)
-require 'watirsplash/generator'
-
-if ARGV.size == 1 && ::WatirSplash::Generator.respond_to?(ARGV[0])
-  exit ::WatirSplash::Generator.send(ARGV[0])
-else
-  exit ::WatirSplash::Generator.help
-end
+require "watirsplash/cli"
+WatirSplash::CLI.start

data/lib/watirsplash.rb

@@ -1,17 +1,15 @@
 require "rubygems"
 require "require_all"
 require "rautomation"
-gem "rspec", "=1.3.0"
-require "spec"
-gem "watir", "=1.6.6"
+require "rspec"
 require "watir"
 require "pathname"
-require_rel "watirsplash/wait_helper"
-require_rel "watirsplash/element_extensions"
 require_rel "watirsplash/file_helper"
 require_rel "watirsplash/spec_helper"
-require_rel "watirsplash/spec"
-require_rel "watirsplash/watir"
+require_rel "watirsplash/rspec_patches"
+require_rel "watirsplash/watir_patches"
 require_rel "watirsplash/util"
+require_rel "watirsplash/html_formatter"
+WatirSplash::Util.configure_rspec_formatters
 WatirSplash::Util.load_environment
 

data/lib/watirsplash/cli.rb

@@ -0,0 +1,34 @@
+require "thor"
+require "thor/group"
+require "watirsplash/generators/new_project"
+require "watirsplash/generators/new_common_project"
+require "watirsplash/generators/migrate_project"
+
+module WatirSplash
+  class CLI < Thor
+
+    desc "new [APPLICATION_NAME]", "Creates 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."
+    def new(name = "Application")
+      WatirSplash::Generators::NewProject.start([Thor::Util.camel_case(name), options[:url], 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" 
+    def new_common
+      WatirSplash::Generators::NewCommonProject.start([options[:url]])
+    end
+
+    if File.basename(Dir.pwd) =~ /^ui-test(-common)?$/
+      desc "migrate", "Migrates old WatirSplash generated project to new."
+      def migrate
+        WatirSplash::Generators::MigrateProject.start
+      end
+    end
+
+  end  
+end

data/lib/watirsplash/file_helper.rb

@@ -5,7 +5,7 @@ class File
     # all file names generated with this method will
     # be shown on the report upon test failure.
     def path(file_name, description=nil)
-      WatirSplash::SpecHelper.formatter.file_path(file_name, description)
+      WatirSplash::Util.formatter.file_path(file_name, description)
     end
 
     # returns native file path

data/lib/watirsplash/generators/migrate_project.rb

@@ -0,0 +1,25 @@
+require "pathname"
+
+module WatirSplash
+  module Generators
+    class MigrateProject < Thor::Group
+      include Thor::Actions
+
+      argument :dir
+
+      def self.source_root
+        File.dirname(__FILE__) + "/templates"
+      end
+
+      def migrate
+        gsub_file("config.rb", /^(\s*)Spec::Runner\./, "\\1RSpec.")
+
+        if File.basename(Dir.pwd) == "ui-test"
+          remove_file "spec/spec.opts"
+          template "new_project/.rspec", ".rspec"
+        end
+      end
+
+    end
+  end
+end

data/lib/watirsplash/generators/new_common_project.rb

@@ -0,0 +1,18 @@
+module WatirSplash
+  module Generators
+    class NewCommonProject < Thor::Group
+      include Thor::Actions
+
+      argument :url 
+
+      def self.source_root
+        File.dirname(__FILE__) + "/templates"
+      end
+
+      def generate
+        directory("new_common_project", "ui-test-common")
+      end
+
+    end
+  end
+end

data/lib/watirsplash/generators/new_project.rb

@@ -0,0 +1,45 @@
+require "uri"
+
+module WatirSplash
+  module Generators
+    class NewProject < Thor::Group
+      include Thor::Actions
+
+      argument :name 
+      argument :url
+      argument :load_common, :optional => true
+
+      def self.source_root
+        File.dirname(__FILE__) + "/templates"
+      end
+
+      def generate
+        directory("new_project", "ui-test")
+      end
+
+      def load_common_cmd
+        cmd = "WatirSplash::Util.load_common"
+        cmd = "# Uncomment the following line to load functionality from ui-test-common\n# " + cmd unless load_common
+        cmd
+      end
+
+      def formatted_name
+        Thor::Util.snake_case(name)
+      end
+
+      def formatted_url
+        uri = URI.parse(url)
+        if load_common && !default_url? && uri.relative?
+          %Q[Config.full_url("#{uri}")] 
+        else
+          %Q["#{uri}"]
+        end
+      end
+
+      def default_url?
+        url.to_s == "about:blank"
+      end
+
+    end
+  end
+end

data/{templates/common/config.rb → lib/watirsplash/generators/templates/new_common_project/config.rb.tt}

@@ -3,8 +3,8 @@
   For example, you can use the URL constant below from your projects' config.rb like this:
 
   module Config
-    module Application
-      URL = Config.full_url("my_subpage/index.html") # => equals "http://localhost/my_subpage/index.html
+    module YourApplication
+      URL = Config.full_url("my_subpage/index.html") # => "http://localhost/my_subpage/index.html
     end
   end
 =end
@@ -13,7 +13,7 @@ require "uri"
 
 module Config
   module GlobalApplication
-    URL = "http://localhost"
+    URL = <%= %Q["#{url}"] %>
   end
 
   def Config.full_url relative_url
@@ -21,6 +21,6 @@ module Config
   end
 end
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   config.include(CommonApplicationHelper)
 end

data/{templates/common → lib/watirsplash/generators/templates/new_common_project}/environment.rb

@@ -2,10 +2,10 @@
   You have to load this file from your projects' environment.rb, which
   would like to use common functionality.
 
-  Use the following code to do it automatically:
-  WatirSplash::Util.load_common
+  Use the following line to do it automatically:
+    WatirSplash::Util.load_common
 
-  Add all your require statements into this file to avoid unnecessary
+  Add all your global require statements into this file to avoid unnecessary
   code in your other projects' files
 
   By default everything in lib directory will be loaded

data/{templates/common → lib/watirsplash/generators/templates/new_common_project}/lib/common_application_helper.rb

@@ -1,5 +1,5 @@
-# You can create under this directory common libraries/helpers/methods which you would
-# like to use within your specs in different projects
+# You can create common libraries/helpers/methods under this directory
+# to use within your specs within different projects
 
 module CommonApplicationHelper
 

data/lib/watirsplash/generators/templates/new_project/.rspec

@@ -0,0 +1,2 @@
+--require
+watirsplash

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

@@ -0,0 +1,22 @@
+# Config for your application
+module Config
+  module <%= name %>
+    # URL, which will be opened before 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 = <%= formatted_url %>
+  end
+end
+
+# A global configuration for specs in this project, which will include by default
+# an <%= name %>Helper module and open Config::<%= name %>::URL with
+# the browser.
+#
+# You can read more about RSpec-s before and after syntax from:
+# http://relishapp.com/rspec/rspec-core/dir/hooks/before-and-after-hooks
+RSpec.configure do |config|
+  config.include(<%= name %>Helper)
+  config.before(:all) {goto Config::<%= name %>::URL}
+end

data/{templates/project/environment.rb → lib/watirsplash/generators/templates/new_project/environment.rb.tt}

@@ -1,14 +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
+<%= load_common_cmd %>
 
 # By default everything, which is not a spec file, will be loaded from spec directory
 # and it's subdirectories
 spec_dir = File.join(File.dirname(__FILE__), "spec/**/*.rb")
 filtered_ruby_files = Dir.glob(spec_dir).delete_if do |file|
-  File.basename(file) =~ /.*_spec\.rb$/
+  File.basename(file) =~ /.*_spec\.rb$/i
 end
-require_all filtered_ruby_files unless filtered_ruby_files.empty?
-require_rel "config.rb"
+require_all filtered_ruby_files
+require_rel "config.rb"

data/{templates/project/spec/application_helper.rb → lib/watirsplash/generators/templates/new_project/spec/%formatted_name%_helper.rb.tt}

@@ -1,7 +1,7 @@
-# ApplicationHelper module has helper methods for easy use in specs
+# <%= name %>Helper module has helper methods for easy use in specs
 # see usages in spec/dummy_spec.rb
 
-module ApplicationHelper
+module <%= name %>Helper
 
   def helper_method_one
     "one"
@@ -15,4 +15,4 @@ module ApplicationHelper
     false
   end
 
-end
+end

data/lib/watirsplash/generators/templates/new_project/spec/dummy_spec.rb.tt

@@ -0,0 +1,40 @@
+# This is a fully working 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 == Config::<%= name %>::URL
+  end
+
+  it "has easy access to <%= name %>Helper methods" do
+    # <%= name %>Helper#helper_method_one will be executed
+    helper_method_one.should == "one"
+    # <%= name %>Helper#has_second_method? will be executed
+    should have_second_method
+    # <%= name %>Helper#correct? method will be executed
+    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/ncr"
+    title.should == "Google"
+    text_field(:name => "q").set "Bing"
+    wait_until(15) {text.include? "Bing"}
+    pending "this is a known 'bug'" do
+      title.should == "Bing"
+    end
+  end
+
+  it "has access to global methods after \"new_common\" command has been used" do
+    pending "it fails as long as 'watirsplash new_common' command hasn't been executed
+and ui-test-common is not loaded by this project" do
+      new_global_method.should == "it just works"
+    end
+  end
+
+end