spec_ui 0.2.3 → 0.2.4

data/Manifest.txt

@@ -14,9 +14,10 @@ lib/spec/ui/version.rb
 lib/spec/ui/watir.rb
 lib/spec/ui/watir/browser.rb
 lib/spec/ui/watir/matchers.rb
+lib/spec/ui/watir/watir_behaviour.rb
 examples/selenium/Rakefile
 examples/selenium/README.txt
-examples/selenium/spec/google/find_rspecs_homepage_spec.rb
+examples/selenium/spec/selenium/find_rspecs_homepage_spec.rb
 examples/selenium/spec/spec_helper.rb
 examples/watir/Rakefile
 examples/watir/README.txt

data/examples/selenium/Rakefile

@@ -1,17 +1,57 @@
-# You don't need to tweak the $LOAD_PATH if you have RSpec and Spec::Ui installed as gems
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../../rspec/lib')
+# You don't need to tweak the $LOAD_PATH if you have RSpec installed as a gem
+$LOAD_PATH.unshift('../../../rspec/lib')
 
 require 'rubygems'
 require 'spec/rake/spectask'
 
 desc "Run Selenium Specs"
 Spec::Rake::SpecTask.new('spec:selenium') do |t|
-  t.spec_files = FileList['spec/google/**/*.rb']
-  # This line is not necessary if you have RSpec and Spec::Ui installed as gems
-  t.ruby_opts = ["-I#{File.dirname(__FILE__) + '/../../lib'}"]
+  t.spec_files = FileList['spec/selenium/**/*.rb']
+  # This line is not necessary if you have Spec::Ui installed as a gem
+  t.libs = ["../../lib"]
   t.spec_opts = [
+    '--color', '--diff',
     '--require', 'rubygems,spec/ui', 
     '--format', 'Spec::Ui::ScreenshotFormatter:spec_report.html',
     '--format', 'progress'
   ]
 end
+
+# IMPORTANT: If you use the master/slave mode you really ought to
+# run everything on different machines.
+
+desc "Run Selenium Specs as Spec::Distributed slave"
+Spec::Rake::SpecTask.new('spec:selenium:slave') do |t|
+  t.spec_files = FileList['spec/selenium/**/*.rb']
+  # This line is not necessary if you have Spec::Ui and Spec::Distributed installed as gems
+  t.libs = ["../../lib", "../../../spec_distributed/lib"]
+  t.spec_opts = lambda do
+    url = ENV['DRB_URL']
+    raise "You must pass DRB_URL=druby://localhost:8991 (for example) on the command line" if url.nil?
+    [
+    '--color', '--diff',
+    '--require', 'rubygems,spec/ui,spec/distributed', 
+    '--format', 'Spec::Ui::SlaveScreenshotFormatter:spec_report.html',
+    '--format', 'progress',
+    '--runner', "Spec::Distributed::SlaveRunner:#{url}"
+    ]
+  end
+end
+
+desc "Run Selenium Specs as Spec::Distributed master"
+Spec::Rake::SpecTask.new('spec:selenium:master') do |t|
+  t.spec_files = FileList['spec/selenium/**/*.rb']
+  # This line is not necessary if you have Spec::Ui and Spec::Distributed installed as gems
+  t.libs = ["../../lib", "../../../spec_distributed/lib"]
+  t.spec_opts = lambda do
+    urls = ENV['DRB_URLS']
+    raise "You must pass DRB_URLS=druby://localhost:8991,druby://localhost:8991 (for example) on the command line" if urls.nil?
+    [
+    '--color', '--diff',
+    '--require', 'rubygems,spec/ui,spec/distributed', 
+    '--format', 'Spec::Ui::MasterScreenshotFormatter:spec_report.html',
+    '--format', 'progress',
+    '--runner', "Spec::Distributed::MasterRunner:#{urls}"
+    ]
+  end
+end

data/examples/selenium/spec/{google → selenium}/find_rspecs_homepage_spec.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
-describe "Google's search page" do
+describe "Google's search page I" do
 
   before(:each) do
     # The @browser is initialised in spec_helper.rb
@@ -13,6 +13,15 @@ describe "Google's search page" do
     @browser.is_text_present("rspec.rubyforge.org").should be_true
   end
 
+end
+
+describe "Google's search page II" do
+
+  before(:each) do
+    # The @browser is initialised in spec_helper.rb
+    @browser.open('http://www.google.no')
+  end
+
   it "should find rspec's home page when I search for 'better than fudge' (will probably fail)" do
     @browser.type "name=q", "better than fudge"
     @browser.click_and_wait "name=btnG"
@@ -25,4 +34,4 @@ describe "Google's search page" do
     @browser.is_text_present("Ali G").should be_false
   end
 
-end
+end

data/examples/selenium/spec/spec_helper.rb

@@ -16,7 +16,7 @@ Spec::Runner.configure do |config|
   end
   
   config.after(:each) do
-    Spec::Ui::ScreenshotFormatter.take_screenshot_of(@browser)
+    Spec::Ui::ScreenshotFormatter.instance.take_screenshot_of(@browser)
   end
 
   config.after(:all) do

data/examples/watir/Rakefile

@@ -1,5 +1,5 @@
-# You don't need to tweak the $LOAD_PATH if you have RSpec and Spec::Ui installed as gems
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../../rspec/lib')
+# You don't need to tweak the $LOAD_PATH if you have RSpec installed as a gem
+$LOAD_PATH.unshift('../../../rspec/lib')
 
 require 'rubygems'
 require 'spec/rake/spectask'
@@ -7,11 +7,51 @@ require 'spec/rake/spectask'
 desc "Run Watir Specs"
 Spec::Rake::SpecTask.new('spec:watir') do |t|
   t.spec_files = FileList['spec/watir/**/*.rb']
-  # This line is not necessary if you have RSpec and Spec::Ui installed as gems
-  t.ruby_opts = ["-I#{File.dirname(__FILE__) + '/../../lib'}"]
+  # This line is not necessary if you have Spec::Ui installed as a gem
+  t.libs = ["../../lib"]
   t.spec_opts = [
+    '--color', '--diff',
     '--require', 'rubygems,spec/ui', 
     '--format', 'Spec::Ui::ScreenshotFormatter:spec_report.html',
     '--format', 'progress'
   ]
 end
+
+# IMPORTANT: If you use the master/slave mode you really ought to
+# run everything on different machines.
+
+desc "Run Watir Specs as Spec::Distributed slave"
+Spec::Rake::SpecTask.new('spec:watir:slave') do |t|
+  t.spec_files = FileList['spec/watir/**/*.rb']
+  # This line is not necessary if you have Spec::Ui and Spec::Distributed installed as gems
+  t.libs = ["../../lib", "../../../spec_distributed/lib"]
+  t.spec_opts = lambda do
+    url = ENV['DRB_URL']
+    raise "You must pass DRB_URL=druby://localhost:8991 (for example) on the command line" if url.nil?
+    [
+    '--color', '--diff',
+    '--require', 'rubygems,spec/ui,spec/distributed', 
+    '--format', 'Spec::Ui::SlaveScreenshotFormatter:spec_report.html',
+    '--format', 'progress',
+    '--runner', "Spec::Distributed::SlaveRunner:#{url}"
+    ]
+  end
+end
+
+desc "Run Watir Specs as Spec::Distributed master"
+Spec::Rake::SpecTask.new('spec:watir:master') do |t|
+  t.spec_files = FileList['spec/watir/**/*.rb']
+  # This line is not necessary if you have Spec::Ui and Spec::Distributed installed as gems
+  t.libs = ["../../lib", "../../../spec_distributed/lib"]
+  t.spec_opts = lambda do
+    urls = ENV['DRB_URLS']
+    raise "You must pass DRB_URLS=druby://localhost:8991,druby://localhost:8991 (for example) on the command line" if urls.nil?
+    [
+    '--color', '--diff',
+    '--require', 'rubygems,spec/ui,spec/distributed', 
+    '--format', 'Spec::Ui::MasterScreenshotFormatter:spec_report.html',
+    '--format', 'progress',
+    '--runner', "Spec::Distributed::MasterRunner:#{urls}"
+    ]
+  end
+end

data/examples/watir/spec/spec_helper.rb

@@ -11,12 +11,12 @@ Spec::Runner.configure do |config|
   config.before(:all) do
     @browser = Watir::Browser.new
   end
-  
+
   config.after(:each) do
-    Spec::Ui::ScreenshotFormatter.take_screenshot_of(@browser)
+    Spec::Ui::ScreenshotFormatter.instance.take_screenshot_of(@browser)
   end
 
   config.after(:all) do
-    @browser.kill! rescue nil
+    @browser.kill!
   end
-end
+end

data/examples/watir/spec/watir/find_rspecs_homepage_spec.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 
-describe "Google's search page" do
+describe "Google's search page I" do
   before(:each) do
     # The @browser is initialised in spec_helper.rb
     @browser.goto('http://www.google.com')
@@ -9,7 +9,14 @@ describe "Google's search page" do
   it "should find rspec's home page when I search for rspec" do
     @browser.text_field(:name, "q").set("rspec")
     @browser.button(:name, "btnG").click
-    @browser.should have_link(:url, "http://rspec.rubyforge.org/")
+    @browser.should have_link(:url, "http://rspec.rubyforge.org/index.html")
+  end
+end
+
+describe "Google's search page II" do
+  before(:each) do
+    # The @browser is initialised in spec_helper.rb
+    @browser.goto('http://www.google.com')
   end
 
   it "should find rspec's home page when I search for 'better than fudge' (this is supposed to fail)" do
@@ -25,4 +32,4 @@ describe "Google's search page" do
   end
   
   it "should do something we haven't done yet"
-end
+end

data/lib/spec/ui/formatter.rb

@@ -1,113 +1,162 @@
-require 'tempfile'
-require 'base64'
-require 'cgi'
-require 'spec/ui/screenshot_saver'
-
-module Spec
-  module Ui
-    class ScreenshotFormatter < Spec::Runner::Formatter::HtmlFormatter
-      class << self
-        include ScreenshotSaver
-        attr_reader :html
-
-        # Takes screenshot and snapshot of the +browser+'s html.
-        # This method calls #screenshot! so that method should not be called
-        # when this method is used.
-        # This method *must* be called in an after(:each) block.
-        def take_screenshot_of(browser)
-          screenshot
-          @html = browser.html
-        end
-
-        # Takes a screenshot of the current window. Use this method when
-        # you don't have a browser object.
-        def screenshot
-          @png_path = Tempfile.new("spec:ui").path
-          save_screenshot(png_path)
-        end
-        
-        def png_path
-          raise "Screenshot not taken. You must call #{self.name}.screenshot or #{self.name}.take_screenshot_of(@browser) from after(:each)" if @png_path.nil?
-          @png_path
-        end
-        
-        # Resets the screenshot and html. Do not call this method from your specs.
-        def reset!
-          @png_path = nil
-          @html = nil
-        end
-      end
-
-      def global_scripts
-        super + <<-EOF
-function showImage(e) {
-  w = window.open();
-  w.location = e.childNodes[0].src
-}
-
-// Lifted from Ruby RDoc
-function toggleSource( id ) {
-  var elem
-  var link
-
-  if( document.getElementById )
-  {
-    elem = document.getElementById( id )
-    link = document.getElementById( "l_" + id )
-  }
-  else if ( document.all )
-  {
-    elem = eval( "document.all." + id )
-    link = eval( "document.all.l_" + id )
-  }
-  else
-    return false;
-
-  if( elem.style.display == "block" )
-  {
-    elem.style.display = "none"
-    link.innerHTML = "show source"
-  }
-  else
-  {
-    elem.style.display = "block"
-    link.innerHTML = "hide source"
-  }
-}
-EOF
-      end
-
-      def global_styles
-        super + <<-EOF
-div.rspec-report textarea {
-  width: 100%;
-}
-
-div.rspec-report div.dyn-source {
-  background:#FFFFEE none repeat scroll 0%;
-  border:1px dotted black;
-  color:#000000;
-  display:none;
-  margin:0.5em 2em;
-  padding:0.5em;
-}
-EOF
-      end
-
-      def extra_failure_content(failure)
-        result = super(failure)
-        # Add embedded image to the report.
-        img_data = Base64.encode64(File.open(self.class.png_path, "rb").read)
-        result += "        <div><a href=\"#\" onclick=\"showImage(this)\"><img width=\"25%\" height=\"25%\" src=\"data:image/png;base64,#{img_data}\" /></a></div>\n"
-        if self.class.html
-          escaped_html = CGI::escapeHTML(self.class.html)
-          source_id = "#{current_example_number}_source"
-          result += "        <div>[<a id=\"l_#{source_id}\" href=\"javascript:toggleSource('#{source_id}')\">show source</a>]</div>\n"
-          result += "        <div id=\"#{source_id}\" class=\"dyn-source\"><textarea rows=\"20\">#{escaped_html}</textarea></div>\n"
-        end
-        self.class.reset!
-        result
-      end
-    end
-  end
-end
+require 'spec/ui/screenshot_saver'
+require 'stringio'
+
+module Spec
+  module Ui
+    class ScreenshotFormatter < Spec::Runner::Formatter::HtmlFormatter
+      class << self
+        attr_accessor :instance
+      end
+
+      include ScreenshotSaver
+
+      def initialize(where, out=where)
+        super(out)
+        if where.is_a?(String)
+          @root = File.dirname(where)
+        else
+          raise "#{self.class} must write to a file, so that we know where to store screenshots"
+        end
+        raise "Only one instance of #{self.class} is allowed" unless self.class.instance.nil?
+        ScreenshotFormatter.instance = self
+      end
+      
+      # Takes screenshot and snapshot of the +browser+'s html.
+      # This method calls #screenshot! so that method should not be called
+      # when this method is used.
+      # This method *must* be called in an after(:each) block.
+      def take_screenshot_of(browser)
+        screenshot
+        save_html(browser)
+      end
+      
+      # Takes a screenshot of the current window and saves it to disk. 
+      # Use this method when you don't have a browser object.
+      def screenshot
+        png_path = File.join(@root, relative_png_path)
+        ensure_dir(png_path)
+        save_screenshot(png_path)
+      end
+      
+      # Writes the HTML from +browser+ to disk
+      def save_html(browser)
+        ensure_dir(absolute_html_path)
+        File.open(absolute_html_path, "w") {|io| io.write(browser.html)}
+      end
+      
+      def ensure_dir(file)
+        dir = File.dirname(file)
+        FileUtils.mkdir_p(dir) unless File.directory?(dir)
+      end
+
+      def absolute_png_path
+        File.join(@root, relative_png_path)
+      end
+
+      def relative_png_path
+        "images/#{current_example_number}.png"
+      end
+
+      def absolute_html_path
+        File.join(@root, relative_html_path)
+      end
+
+      def relative_html_path
+        "html/#{current_example_number}.html"
+      end
+
+      def global_scripts
+        super + <<-EOF
+function showImage(e) {
+  w = window.open();
+  w.location = e.childNodes[0].src
+}
+
+// Lifted from Ruby RDoc
+function toggleSource( id ) {
+  var elem
+  var link
+
+  if( document.getElementById )
+  {
+    elem = document.getElementById( id )
+    link = document.getElementById( "l_" + id )
+  }
+  else if ( document.all )
+  {
+    elem = eval( "document.all." + id )
+    link = eval( "document.all.l_" + id )
+  }
+  else
+    return false;
+
+  if( elem.style.display == "block" )
+  {
+    elem.style.display = "none"
+    link.innerHTML = "show snapshot"
+  }
+  else
+  {
+    elem.style.display = "block"
+    link.innerHTML = "hide snapshot"
+  }
+}
+EOF
+      end
+
+      def global_styles
+        super + <<-EOF
+div.rspec-report textarea {
+  width: 100%;
+}
+
+div.rspec-report div.dyn-source {
+  background:#FFFFEE none repeat scroll 0%;
+  border:1px dotted black;
+  color:#000000;
+  display:none;
+  margin:0.5em 2em;
+  padding:0.5em;
+}
+EOF
+      end
+
+      def extra_failure_content(failure)
+        result = super(failure)
+        if File.exist?(absolute_png_path)
+          result += img_div 
+        end
+        if File.exist?(absolute_html_path)
+          source_id = "#{current_example_number}_source"
+          result += "        <div>[<a id=\"l_#{source_id}\" href=\"javascript:toggleSource('#{source_id}')\">show snapshot</a>]</div>\n"
+          result += "        <div id=\"#{source_id}\" class=\"dyn-source\"><iframe src=\"#{relative_html_path}\" width=\"100%\" height=\"300px\"></iframe></div>\n"
+        end
+        result
+      end
+ 
+      def img_div
+        "        <div><a href=\"#{relative_png_path}\"><img width=\"25%\" height=\"25%\" src=\"#{relative_png_path}\" /></a></div>\n"
+      end
+    end
+    
+    # This formatter produces the same HTML as ScreenshotFormatter, except that
+    # it doesn't save screenshot PNGs and browser snapshot HTML source to disk. 
+    # It is meant to be used from a Spec::Distributed master
+    class MasterScreenshotFormatter < ScreenshotFormatter
+      def screenshot
+      end
+      
+      def save_html(browser)
+      end
+    end
+    
+    # This formatter writes PNG and browser snapshot HTML to disk, just like its superclass,
+    # but it doesn't write the HTML report itself.
+    # It is meant to be used from Spec::Distributed slaves
+    class SlaveScreenshotFormatter < ScreenshotFormatter
+      def initialize(where)
+        super(where, StringIO.new)
+      end
+    end
+  end
+end

data/lib/spec/ui/screenshot_saver.rb

@@ -23,8 +23,16 @@ module Spec
               nil
             rescue Magick::ImageMagickError => e
               if e.message =~ /Insufficient image data in file/
-                e.message << "\nTry this:\n1) Open your app (e.g. Internet Explorer)\n2) Resize the app to be bigger (without maximizing).\n3) close it so Windows remembers its size.\n" +
-                "This *may* make this error go away."
+                e.message << <<-EOM
+This is a bug in win32screenshot - it fails to take screenshots of "small" windows. Try this workaround:
+
+1) Close all instances of the app you're trying to take a screenshot of (e.g. Internet Explorer)
+2) Open the app
+3) Resize the window so it occupies the entire screen (without maximizing it!)
+4) Exit the app. Windows will now remember its size the next time it starts.
+
+This *may* make this error go away
+EOM
               end
               raise e
             end
@@ -47,4 +55,4 @@ module Spec
       end
     end
   end
-end
+end

data/lib/spec/ui/selenium.rb

@@ -1 +1 @@
-require 'spec/ui/selenium/driver_ext'
+require 'spec/ui/selenium/driver_ext'

data/lib/spec/ui/version.rb

@@ -3,7 +3,7 @@ module Spec
     module VERSION #:nodoc:
       MAJOR = 0
       MINOR = 2
-      TINY  = 3
+      TINY  = 4
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

data/lib/spec/ui/watir/browser.rb

@@ -34,4 +34,4 @@ class Watir::Browser
       raise e
     end
   end
-end
+end

data/lib/spec/ui/watir/watir_behaviour.rb

@@ -0,0 +1,24 @@
+require 'spec/ui/watir/matchers'
+
+module Spec
+  module Ui
+    module Watir
+      class WatirBehaviour < Spec::DSL::Behaviour
+        def before_eval # :nodoc:
+          include Spec::Matchers::Watir
+          begin
+            # We'll try to hook up to the Rails stuff. This gives us access
+            # to transactional fixtures etc.
+            inherit Spec::Rails::DSL::EvalContext
+            prepend_before {setup}
+            append_after {teardown}
+            configure
+          rescue
+          end
+        end
+
+        Spec::DSL::BehaviourFactory.add_behaviour_class(:watir, self)
+      end
+    end
+  end
+end

data/spec/spec/ui/watir/matchers_spec.rb

@@ -37,4 +37,4 @@ describe "Browser" do
     end.should raise_error(Spec::Expectations::ExpectationNotMetError, 
       'Expected BrowserStub to not have label(:foo, true), but it was found')
   end
-end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: spec_ui
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
-date: 2007-05-24 00:00:00 +02:00
+  version: 0.2.4
+date: 2007-08-12 00:00:00 -04:00
 summary: Run UI RSpec examples with screenshot reports
 require_paths: 
 - lib
@@ -45,9 +45,10 @@ files:
 - lib/spec/ui/watir.rb
 - lib/spec/ui/watir/browser.rb
 - lib/spec/ui/watir/matchers.rb
+- lib/spec/ui/watir/watir_behaviour.rb
 - examples/selenium/Rakefile
 - examples/selenium/README.txt
-- examples/selenium/spec/google/find_rspecs_homepage_spec.rb
+- examples/selenium/spec/selenium/find_rspecs_homepage_spec.rb
 - examples/selenium/spec/spec_helper.rb
 - examples/watir/Rakefile
 - examples/watir/README.txt
@@ -57,10 +58,15 @@ files:
 - spec/spec/ui/watir/matchers_spec.rb
 test_files: []
 
-rdoc_options: []
-
-extra_rdoc_files: []
-
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- examples/selenium/README.txt
+- examples/watir/README.txt
 executables: []
 
 extensions: []
@@ -75,5 +81,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.0
+        version: 1.2.2
     version: