watirsplash 0.2.14 → 1.0.0

data/lib/watirsplash/html_formatter.rb

@@ -1,4 +1,4 @@
-require 'spec/runner/formatter/html_formatter'
+require 'rspec/core/formatters/html_formatter'
 require 'win32/screenshot'
 require 'pathname'
 require 'fileutils'
@@ -9,14 +9,13 @@ module WatirSplash
   # * 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
+  class HtmlFormatter < ::RSpec::Core::Formatters::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)
+    def initialize(output) # :nodoc:
       @output_dir = File.expand_path(File.dirname(output))
       archive_results
 
@@ -24,25 +23,25 @@ module WatirSplash
       @files_dir = File.join(@output_dir, "files")
       FileUtils.mkdir_p(@files_dir)
       @files_saved_during_example = []
-      super
+      super(File.open(output, "w"))
     end
 
     def example_group_started(example_group) # :nodoc:
       @files_saved_during_example.clear
-      append_extra_information_to_desc(example_group)
+      append_extra_information_to_description(example_group)
       super
     end
 
     def example_started(example) # :nodoc:
       @files_saved_during_example.clear
-      example.description += "#{example.location.scan(/:\d+$/)} (#{Time.now.strftime("%H:%M:%S")})"
+      example.metadata[:description] += "#{example.metadata[:location].scan(/:\d+$/)} (#{Time.now.strftime("%H:%M:%S")})"
       super
     end
 
-    def extra_failure_content(failure) # :nodoc:
+    def extra_failure_content(exception) # :nodoc:
       if @browser.exists?
-        save_html
         save_screenshot
+        save_html
       end
 
       content = []
@@ -105,14 +104,13 @@ module WatirSplash
       end
     end
 
-    def append_extra_information_to_desc(example_group)
+    def append_extra_information_to_description(example_group)
       date = Time.now.strftime("%d.%m.%Y")
-      spec_dir = Pathname.new(example_group.location)
-      relative_spec_path = spec_dir.relative_path_from(Pathname.new(Dir.pwd + "/spec")).to_s
-      appended_description = " @ #{relative_spec_path}#{example_group.location.scan(/:\d+$/)} (#{date})"
-      example_group.description += appended_description
-      # needed for NestedTextFormatter
-      example_group.nested_descriptions.map! {|nested_description| nested_description + appended_description}
+      spec_location, line_no = example_group.metadata[:example_group][:block].to_s.scan(/@(.*)(:\d+)>$/).flatten
+      spec_location = Pathname.new(spec_location)
+      relative_spec_path = spec_location.relative_path_from(Pathname.new(Dir.pwd + "/spec")).to_s
+      appended_description = " @ #{relative_spec_path}#{line_no} (#{date})"
+      example_group.metadata[:example_group][:description] += appended_description
     end
 
   end

data/lib/watirsplash/rspec_patches.rb

@@ -0,0 +1,74 @@
+require 'rspec/core/formatters/html_formatter'
+require 'rspec/core/formatters/snippet_extractor'
+
+# patch for https://github.com/rspec/rspec-core/issues/#issue/214
+module RSpec
+  module Core
+    module Formatters
+      class HtmlFormatter < BaseTextFormatter
+        def extra_failure_content(exception)
+          require 'rspec/core/formatters/snippet_extractor'
+          backtrace = exception.backtrace.map {|line| backtrace_line(line)}
+          backtrace.compact!
+          @snippet_extractor ||= SnippetExtractor.new
+          "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"
+        end
+      end
+
+      class SnippetExtractor
+        def snippet(backtrace)
+          raw_code, line = snippet_for(backtrace[0])
+          highlighted = @@converter.convert(raw_code, false)
+          highlighted << "\n<span class=\"comment\"># gem install syntax to get syntax highlighting</span>" if @@converter.is_a?(NullConverter)
+          post_process(highlighted, line)
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config| #:nodoc:
+  config.include(WatirSplash::SpecHelper)
+
+  config.before(:all) do
+    open_browser_at "about:blank"
+  end
+
+  config.after(:all) do
+    close
+  end
+end
+
+module RSpec #:nodoc:all
+  module Core
+    class ExampleGroup
+      subject {self}
+    end
+  end
+end
+
+# match_array is useful for matching arrays where some elements are regular expressions.
+#    expected_array = ["1", "2", /\d+/, "3"]
+#
+#    ["1", "2", "66", "3"].should match_array(expected_array)
+#    table(:id => "table_id").to_a.should match_array(expected_array)
+RSpec::Matchers.define :match_array do |array2|
+  match do |array1|
+    raise "match_array works only with Array objects!" unless array1.is_a?(Array) && array2.is_a?(Array)
+    match?(array1, array2)
+  end
+
+  def match?(array1, array2)
+    array2.each_with_index do |element, i|
+      if element.is_a?(Array)
+        return false unless match?(array1[i], element)
+      elsif element.is_a?(Regexp)
+        return false unless array1[i] =~ element
+      else
+        return false unless array1[i] == element
+      end
+    end
+
+    true
+  end
+end

data/lib/watirsplash/spec_helper.rb

@@ -3,25 +3,17 @@ module WatirSplash
   #
   # these methods can be used in specs directly
   module SpecHelper
-    include Watir::WaitHelper
 
     # 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
-      formatter.browser = @browser rescue nil 
+      Util.formatter.browser = @browser 
       goto url
       maximize
     end
-
-    # returns WatirSplash::HtmlFormatter object, nil if not in use
-    def formatter
-      @formatter ||= Spec::Runner.options.formatters.find {|f| f.kind_of?(WatirSplash::HtmlFormatter) rescue false}
-    end
-
-    module_function :formatter
-
+    
     def method_missing name, *args #:nodoc:
       @browser.respond_to?(name) ? @browser.send(name, *args) {yield} : super
     end

data/lib/watirsplash/util.rb

@@ -21,6 +21,20 @@ module WatirSplash
         end
       end
 
+      # configure RSpec to use documentation and WatirSplash::HtmlFormatter formatters
+      def configure_rspec_formatters
+        config = RSpec.configuration
+        config.color_enabled = true
+        documentation_formatter = config.send(:built_in_formatter, :documentation).new(config.output)
+        results_path = ENV["WATIRSPLASH_RESULTS_PATH"] || "results/index.html"
+        @@html_formatter = WatirSplash::HtmlFormatter.new(results_path)
+        config.instance_variable_set(:@reporter, RSpec::Core::Reporter.new(@@html_formatter, documentation_formatter))
+      end
+
+      def formatter
+        @@html_formatter
+      end
+
       private
 
       def common_dir
@@ -35,7 +49,7 @@ module WatirSplash
       end
 
       def has_environment? dir
-        return File.exists?(File.join(dir, "environment.rb"))
+        File.exists?(File.join(dir, "environment.rb"))
       end
 
     end

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

@@ -8,12 +8,10 @@ end
 # patches for Watir
 module Watir
   class IE #:nodoc:all
-    include WaitHelper
+    # trigger autoloading
   end
 
   class Element #:nodoc:all
-    include ElementExtensions
-
     # saves a file with the browser
     #
     # clicking the button opens a browser's save as dialog and saves the file document.pdf
@@ -25,15 +23,13 @@ module Watir
       path = Pathname.new(file_path)
       raise "path to #{file_path} has to be absolute!" unless path.absolute?
       self.click_no_wait
-      download_window = RAutomation::Window.new(:title => "File Download")
-      WaitHelper.wait_until {download_window.present?}
-      download_window.button(:value => "&Save").click
+      RAutomation::Window.new(:title => "File Download").button(:value => "&Save").click
 
       save_as_window = RAutomation::Window.new(:title => "Save As")
       save_as_window.text_field(:class => "Edit", :index => 0).set(File.native_path(file_path))
       save_as_window.button(:value => "&Save").click
 
-      WaitHelper.wait_until {File.exists?(file_path)}
+      Wait.until {File.exists?(file_path)}
       file_path
     end
   end

data/spec/file_helper_spec.rb

@@ -0,0 +1,19 @@
+describe File do
+
+  before :all do
+    @file_name = "blah.temp"
+    @ext = File.extname(@file_name)
+    @base = File.basename(@file_name, @ext)
+  end
+
+  it ".path returns unique file path" do
+    expected_path = File.join(Dir.pwd, "results/files/#{@base}_.*#{@ext}")
+    File.path(@file_name).should =~ Regexp.new(expected_path)
+  end
+
+  it ".native_path returns unique file path with native path separator" do
+    expected_path = File.join(Dir.pwd, "results/files/#{@base}_.*#{@ext}").gsub("/", "\\")
+    File.native_path(File.path(@file_name)).should =~ Regexp.new(Regexp.escape(expected_path).gsub("\\.\\*", ".*"))
+  end
+
+end

data/spec/spec_helper_spec.rb

@@ -1,5 +1,3 @@
-require "spec"
-
 describe WatirSplash::SpecHelper do
 
   it "opens browser automatically" do
@@ -18,17 +16,6 @@ describe WatirSplash::SpecHelper do
     text_field.value == "empty value"
   end
 
-  it "has File.path and File.native_path methods" do
-    file_name = "blah.temp"
-    ext = File.extname(file_name)
-    base = File.basename(file_name, ext)
-    expected_path = File.join(Dir.pwd, "results/files/#{base}_.*#{ext}")
-
-    File.path(file_name).should =~ Regexp.new(expected_path)
-    expected_path = expected_path.gsub("/", "\\")
-    File.native_path(File.path(file_name)).should =~ Regexp.new(Regexp.escape(expected_path).gsub("\\.\\*", ".*"))
-  end
-
   it "redirects usages of method 'p' to Watir::IE#p instead of Kernel.p" do
     goto "http://dl.dropbox.com/u/2731643/WatirSplash/test.html"
     paragraph = p(:class => "my_pg")

data/spec/spec_match_array_spec.rb

@@ -1,5 +1,3 @@
-require "spec"
-
 describe "Array match_array matcher" do
 
   it "matches other arrays with regexps" do

data/spec/util_spec.rb

@@ -1,5 +1,3 @@
-require "spec"
-
 describe WatirSplash::Util do
 
   it "loads ui-test-common" do

data/spec/watir_ie_spec.rb

@@ -1,28 +1,23 @@
-require "spec"
-
 describe Watir::IE do
 
   before :each do
     goto "http://dl.dropbox.com/u/2731643/WatirSplash/test.html"
   end
 
-  it "uses currentStyle method to show computed style" do
-    t = table(:id => "normal")
-    normal_cell = t[1][1]
-    normal_cell.text.should == "1"
-    normal_cell.style.color.should == "#000000"
-
-    red_cell = t.cell(:class => "reddish")
-    red_cell.text.should == "9"
-    red_cell.style.color.should == "red"
-  end
+  context Watir::Element do
+    context "#save_as" do
+      it "saves file with the browser" do
+        begin
+          file_path = link(:text => "Download").save_as(File.path("download.zip"))
+          File.read(file_path).should == "this is a 'zip' file!"
+        ensure
+          FileUtils.rm file_path rescue nil
+        end
+      end
 
-  it "has #save_as method for Watir::Element" do
-    begin
-      file_path = link(:text => "Download").save_as(File.path("download.zip"))
-      File.read(file_path).should == "this is a 'zip' file!"
-    ensure
-      FileUtils.rm file_path rescue nil
+      it "allows only absolute paths" do
+        lambda {link(:text => "Download").save_as("download.zip")}.should raise_exception
+      end
     end
   end
 
@@ -35,23 +30,11 @@ describe Watir::IE do
         wait_until(5) {field.value =~ /#{File.basename(__FILE__)}/}
       end
 
-      it "doesn't allow to use FileField#set with non existing file" do
+      it "doesn't allow to use with non existing files" do
         field = file_field(:id => "upload")
         lambda {field.set "upload.zip"}.should raise_exception
       end
     end
   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::WaitHelper::TimeoutError)
-  end
-
-  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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: watirsplash
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 23
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 2
-  - 14
-  version: 0.2.14
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Jarmo Pertman
@@ -26,12 +26,12 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 9
         segments: 
         - 1
-        - 6
-        - 6
-        version: 1.6.6
+        - 7
+        - 1
+        version: 1.7.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -40,18 +40,17 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 11
         segments: 
-        - 1
-        - 3
-        - 0
-        version: 1.3.0
+        - 2
+        - 4
+        version: "2.4"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: diff-lcs
+  name: require_all
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -65,27 +64,26 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rautomation
+  name: syntax
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
         - 0
-        - 4
-        version: "0.4"
+        version: "0"
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: require_all
+  name: thor
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
@@ -94,21 +92,22 @@ dependencies:
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: syntax
+  name: rautomation
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 3
         segments: 
         - 0
-        version: "0"
+        - 4
+        version: "0.4"
   type: :runtime
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: win32console
+  name: require_all
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
@@ -122,9 +121,23 @@ dependencies:
   type: :runtime
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: win32screenshot
+  name: syntax
   prerelease: false
   requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 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: 
     - - ~>
@@ -136,7 +149,7 @@ dependencies:
         - 2
         version: 1.0.2
   type: :runtime
-  version_requirements: *id008
+  version_requirements: *id009
 description: WatirSplash makes testing of web applications splashin' easy by combining best features of Watir, RSpec and Ruby!
 email: jarmo.p@gmail.com
 executables: 
@@ -155,31 +168,29 @@ files:
 - VERSION
 - bin/watirsplash
 - lib/watirsplash.rb
-- lib/watirsplash/element_extensions.rb
+- lib/watirsplash/cli.rb
 - lib/watirsplash/file_helper.rb
-- lib/watirsplash/generator.rb
+- lib/watirsplash/generators/migrate_project.rb
+- lib/watirsplash/generators/new_common_project.rb
+- lib/watirsplash/generators/new_project.rb
+- lib/watirsplash/generators/templates/new_common_project/config.rb.tt
+- lib/watirsplash/generators/templates/new_common_project/environment.rb
+- lib/watirsplash/generators/templates/new_common_project/lib/common_application_helper.rb
+- lib/watirsplash/generators/templates/new_project/.rspec
+- lib/watirsplash/generators/templates/new_project/config.rb.tt
+- lib/watirsplash/generators/templates/new_project/environment.rb.tt
+- lib/watirsplash/generators/templates/new_project/spec/%formatted_name%_helper.rb.tt
+- lib/watirsplash/generators/templates/new_project/spec/dummy_spec.rb.tt
 - lib/watirsplash/html_formatter.rb
-- lib/watirsplash/spec.rb
+- lib/watirsplash/rspec_patches.rb
 - lib/watirsplash/spec_helper.rb
 - lib/watirsplash/util.rb
-- lib/watirsplash/wait_helper.rb
-- lib/watirsplash/watir.rb
-- spec/spec.opts
+- lib/watirsplash/watir_patches.rb
+- spec/file_helper_spec.rb
 - spec/spec_helper_spec.rb
 - spec/spec_match_array_spec.rb
 - spec/util_spec.rb
-- spec/watir_element_spec.rb
 - spec/watir_ie_spec.rb
-- spec/watir_table_row_spec.rb
-- spec/watir_table_spec.rb
-- templates/common/config.rb
-- templates/common/environment.rb
-- templates/common/lib/common_application_helper.rb
-- templates/project/config.rb
-- templates/project/environment.rb
-- templates/project/spec/application_helper.rb
-- templates/project/spec/dummy_spec.rb
-- templates/project/spec/spec.opts
 has_rdoc: true
 homepage: http://github.com/jarmo/WatirSplash
 licenses: []
@@ -187,9 +198,11 @@ licenses: []
 post_install_message: |-
   *************************
   
-  Thank you for installing WatirSplash 0.2.14! Don't forget to take a look at README and History files!
+  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.
   
-  Execute "watirsplash generate" 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!
   
   *************************
 rdoc_options: 
@@ -226,12 +239,10 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: watirsplash 0.2.14
+summary: watirsplash 1.0.0
 test_files: 
+- spec/file_helper_spec.rb
 - spec/spec_helper_spec.rb
 - spec/spec_match_array_spec.rb
 - spec/util_spec.rb
-- spec/watir_element_spec.rb
 - spec/watir_ie_spec.rb
-- spec/watir_table_row_spec.rb
-- spec/watir_table_spec.rb