watirsplash 2.0.0.rc2 → 2.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    watirsplash (2.0.0.rc1)
+    watirsplash (2.0.0)
       bundler (~> 1.0)
       rake (= 0.8.7)
       require_all
@@ -14,18 +14,18 @@ GEM
     builder (3.0.0)
     childprocess (0.1.9)
       ffi (~> 1.0.6)
-    commonwatir (1.9.0)
+    commonwatir (1.9.1)
       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)
+    firewatir (1.9.1)
+      commonwatir (= 1.9.1)
+    hoe (2.10.0)
+      rake (~> 0.8)
     json_pure (1.5.3)
     mini_magick (3.2.1)
       subexec (~> 0.0.4)
-    nokogiri (1.4.5-x86-mingw32)
+    nokogiri (1.5.0-x86-mingw32)
     rake (0.8.7)
     rautomation (0.5.1)
     require_all (1.2.0)
@@ -52,10 +52,10 @@ GEM
       builder (>= 2.1.2)
       s4t-utils (>= 1.0.3)
       xml-simple (>= 1.0.11)
-    watir (1.9.0)
-      commonwatir (= 1.9.0)
+    watir (1.9.1)
+      commonwatir (= 1.9.1)
       ffi (~> 1.0)
-      firewatir (= 1.9.0)
+      firewatir (= 1.9.1)
       nokogiri
       rautomation (~> 0.5)
       win32-process (>= 0.5.5)
@@ -74,15 +74,15 @@ GEM
     windows-pr (1.2.0)
       win32-api (>= 1.4.5)
       windows-api (>= 0.3.0)
-    xml-simple (1.0.16)
+    xml-simple (1.1.0)
 
 PLATFORMS
   x86-mingw32
 
 DEPENDENCIES
-  firewatir (= 1.9.0)
+  firewatir (= 1.9.1)
   rspec (~> 2.6.0)
-  watir (= 1.9.0)
+  watir (= 1.9.1)
   watir-webdriver (~> 0.2.5)
   watirsplash!
   win32screenshot (~> 1.0.4)

data/History.rdoc

@@ -1,15 +1,20 @@
-=== Version 2.0.0 / 2011-07-xx
-
- * introducing Page Objects - generate them with `watirsplash page` generator
- * use WatirSplash::Browser.new to open up a browser and set it to RSpec-s formatter too
+=== Version 2.0.0 / 2011-07-06
+
+ * added Page Objects support - generate them with `watirsplash page` generator 
+ * added #during RSpec matcher
+ * added :default option for frameworks 
+ * using Bundler for specifying runtime dependencies 
+ * loading environment.rb directly from .rspec file
+ * use WatirSplash::Browser.new to open up a browser and set it up with RSpec's formatter
+ * use WatirSplash::Browser.current method to access current browser object globally
+ * use @browser variable in WatirSplash::Page objects to access browser object 
+ * moved File.path and File.native_path methods to WatirSplash::Util.file_path and .file_native_path since File.path method conflicts with Ruby 1.9
  * removed ui-test-common functionality - just load it's environment.rb if you really need to use it
+ * removed deprecated #in RSpec matcher
  * do not load framework automatically anymore when requiring watirsplash - use WatirSplash::Util.load_framework method in environment.rb or config.rb instead
- * do not maximize browser window anymore automatically
- * load environment.rb directly in .rspec file
- * added :default option for frameworks
+ * do not open browser window automatically anymore - use RSpec.configure block in config.rb if needed
+ * do not maximize browser window anymore automatically - use RSpec configure block in config.rb if needed
  * bumped dependencies for win32screenshot, watir, firewatir and watir-webdriver
- * use Bundler for specifying dependencies from now on
- * moved File.path and File.native_path methods to WatirSplash::Util.file_path and .file_native_path since File.path method conflicts with Ruby 1.9
   
   PS! This version is not fully backwards compatible due to some core changes, but it is possible to make your old project working with it.
 

data/README.rdoc

@@ -60,7 +60,7 @@ testing right away!
           end
 
           def search_button
-            return_for button(:name => "go"),
+            modify button(:name => "go"),
               # clicking the search button results a page transition to "results" page
               :click => lambda {Results.new @browser}
           end

data/lib/watirsplash/browser.rb

@@ -1,10 +1,28 @@
 module WatirSplash
   class Browser
-    def self.new
-      browser = Watir::Browser.new
-      Util.formatter.browser = browser
-      browser
-    end    
+    class << self
+      def new
+        prepare Watir::Browser.new
+      end    
+
+      @@current = nil
+
+      def current
+        @@current
+      end
+
+      def current= browser
+        @@current = browser
+      end
+
+      private
+
+      def prepare browser
+        self.current = browser
+        browser
+      end
+
+    end
   end
 end
 

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

@@ -3,9 +3,7 @@ require_rel "../watir-webdriver.rb"
 module WatirSplash
   class Browser
     def self.new
-      browser = Watir::Browser.new :chrome
-      Util.formatter.browser = browser
-      browser
+      prepare Watir::Browser.new(:chrome)
     end
   end
 end

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

@@ -3,9 +3,7 @@ require_rel "../watir-webdriver.rb"
 module WatirSplash
   class Browser
     def self.new
-      browser = Watir::Browser.new :firefox
-      Util.formatter.browser = browser
-      browser
+      prepare Watir::Browser.new(:firefox)
     end
   end
 end

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

@@ -3,9 +3,7 @@ require_rel "../watir-webdriver.rb"
 module WatirSplash
   class Browser
     def self.new
-      browser = Watir::Browser.new :ie
-      Util.formatter.browser = browser
-      browser      
+      prepare Watir::Browser.new(:ie)
     end
   end
 end

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

@@ -5,3 +5,13 @@ module <%= formatted_name %>
     URL = <%= formatted_url %>
   end
 end
+
+RSpec.configure do |config|
+  config.before :all do
+    # WatirSplash::Browser.new 
+  end
+
+  config.after(:all) do
+    WatirSplash::Browser.current.close if WatirSplash::Browser.current
+  end  
+end

data/lib/watirsplash/html_formatter.rb

@@ -10,10 +10,6 @@ module WatirSplash
   # * saves all files generated/downloaded during the test and shows them in the report
   class HtmlFormatter < ::RSpec::Core::Formatters::HtmlFormatter
 
-    # currently used browser object
-    # needed for saving of screenshots and html
-    attr_accessor :browser
-
     def initialize(output) # :nodoc:
       @output_dir = File.expand_path(File.dirname(output))
       archive_results
@@ -38,7 +34,7 @@ module WatirSplash
     end
 
     def extra_failure_content(exception) # :nodoc:
-      if @browser && @browser.exists?
+      if WatirSplash::Browser.current && WatirSplash::Browser.current.exists?
         save_screenshot
         save_html
       end
@@ -61,7 +57,7 @@ module WatirSplash
     def save_html # :nodoc:
       file_name = file_path("browser.html")
       begin
-        html = @browser.html
+        html = WatirSplash::Browser.current.html
         File.open(file_name, 'w') {|f| f.puts html}
       rescue => e
         $stderr.puts "saving of html failed: #{e.message}"
@@ -71,7 +67,7 @@ module WatirSplash
 
     def save_screenshot(description="Screenshot", hwnd=nil) # :nodoc:
       file_name = file_path("screenshot.png", description)
-      @browser.save_screenshot(:file_name => file_name, :hwnd => hwnd)
+      WatirSplash::Browser.current.save_screenshot(:file_name => file_name, :hwnd => hwnd)
       file_name
     end
 

data/lib/watirsplash/page/base.rb

@@ -13,23 +13,23 @@ module WatirSplash
 
       def initialize(browser=nil)
         if browser
-          @browser = WatirSplash::Util.formatter.browser = browser 
+          @browser = WatirSplash::Browser.current = browser 
         else
           @browser = WatirSplash::Browser.new
           @browser.goto @@url
         end
       end
 
-      def return_for element, methodz
+      def modify element, methodz
         methodz.each_pair do |meth, return_value|
           element.instance_eval do 
-            instance_variable_set("@#{meth}_return_value", return_value)
+            instance_variable_set("@_#{meth}_return_value_proc", return_value)
             instance_eval %Q[
               self.class.send(:alias_method, :__#{meth}, :#{meth}) if respond_to? :#{meth}
 
               def #{meth}(*args)
                 self.send(:__#{meth}, *args) if respond_to? :__#{meth}
-                instance_variable_get("@#{meth}_return_value").call(*args)
+                instance_variable_get("@_#{meth}_return_value_proc").call(*args)
               end
             ]
           end

data/lib/watirsplash/rspec_patches.rb

@@ -29,10 +29,6 @@ end
 
 RSpec.configure do |config| #:nodoc:
   config.include(WatirSplash::SpecHelper)
-
-  config.after(:all) do
-    WatirSplash::Util.formatter.browser.close if WatirSplash::Util.formatter.browser
-  end
 end
 
 module RSpec #:nodoc:all
@@ -74,14 +70,14 @@ module RSpec::Matchers
   class Change
     def matches?(event_proc)
       raise_block_syntax_error if block_given?
-      
+
       # to make #change work with #in(timeout) method
       unless defined? @actual_before
         @actual_before = evaluate_value_proc
         event_proc.call
       end
       @actual_after = evaluate_value_proc
-    
+
       (!change_expected? || changed?) && matches_before? && matches_after? && matches_expected_delta? && matches_min? && matches_max?
     end
   end
@@ -114,15 +110,15 @@ RSpec::Matchers.constants.each do |const|
     inst_methods = instance_methods.map {|m| m.to_sym}
 
     if !(inst_methods.include?(:__matches?) || inst_methods.include?(:__does_not_match?)) && 
-        (inst_methods.include?(:matches?) || inst_methods.include?(:does_not_match?))
+      (inst_methods.include?(:matches?) || inst_methods.include?(:does_not_match?))
 
-      def in(timeout)
-        Kernel.warn "DEPRECATION NOTICE: #in(timeout) is DEPRECATED, please use #within(timeout) method instead!"
-        within(timeout)
+      def within(timeout)
+        @within_timeout = timeout
+        self
       end
 
-      def within(timeout)
-        @timeout = timeout
+      def during(timeout)
+        @during_timeout = timeout
         self
       end
 
@@ -138,8 +134,8 @@ RSpec::Matchers.constants.each do |const|
       alias_method :second, :seconds
 
       def minutes
-        return unless @timeout
-        @timeout *= 60
+        @within_timeout *= 60 if @within_timeout
+        @during_timeout *= 60 if @during_timeout
         self
       end
 
@@ -150,7 +146,13 @@ RSpec::Matchers.constants.each do |const|
       alias_method :__matches?, :matches? 
 
       def matches?(actual)
-        @timeout ? (Watir::Wait.until(@timeout) {__matches?(actual)} rescue false) : __matches?(actual)
+        if @within_timeout
+          Watir::Wait.until(@within_timeout) {__matches?(actual)} rescue false
+        elsif @during_timeout
+          Watir::Wait.while(@during_timeout) {__matches?(actual)} rescue true
+        else
+          __matches?(actual)
+        end
       end
     end
 
@@ -158,11 +160,23 @@ RSpec::Matchers.constants.each do |const|
       alias_method :__does_not_match?, :does_not_match?
 
       def does_not_match?(actual)
-        @timeout ? (Watir::Wait.until(@timeout) {__does_not_match?(actual)} rescue false) : __does_not_match?(actual)
+        if @within_timeout
+          Watir::Wait.until(@within_timeout) {__does_not_match?(actual)} rescue false
+        elsif @during_timeout
+          Watir::Wait.while(@during_timeout) {__does_not_match?(actual)} rescue true
+        else
+          __does_not_match?(actual)
+        end
       end
     elsif inst_methods.include? :matches?
       def does_not_match?(actual)
-        @timeout ? !(Watir::Wait.while(@timeout) {__matches?(actual)} rescue true) : !__matches?(actual)
+        if @within_timeout
+          Watir::Wait.until(@within_timeout) {!__matches?(actual)} rescue false
+        elsif @during_timeout
+          Watir::Wait.while(@during_timeout) {!__matches?(actual)} rescue true
+        else
+          !__matches?(actual)
+        end
       end
     end
   end

data/lib/watirsplash/spec_helper.rb

@@ -5,13 +5,13 @@ module WatirSplash
   module SpecHelper
 
     def method_missing name, *args #:nodoc:
-      if WatirSplash::Util.formatter.browser.respond_to?(name)
+      if WatirSplash::Browser.current.respond_to?(name)
         SpecHelper.module_eval %Q[
           def #{name}(*args)
-            WatirSplash::Util.formatter.browser.send(:#{name}, *args) {yield}
+            WatirSplash::Browser.current.send(:#{name}, *args) {yield}
           end
         ]
-        WatirSplash::Util.formatter.browser.send(name, *args) {yield}
+        self.send(name, *args) {yield}
       else
         super
       end
@@ -21,7 +21,7 @@ module WatirSplash
     # and not Kernel
     # use Kernel.p if you need to dump some variable 
     def p *args #:nodoc:
-      WatirSplash::Util.formatter.browser.p *args
+      WatirSplash::Browser.current.p *args
     end
 
   end

data/lib/watirsplash/version.rb

@@ -1,9 +1,9 @@
 module WatirSplash
   module Version
-    WATIRSPLASH = "2.0.0.rc2"
+    WATIRSPLASH = "2.0.0"
 
     # possible runtime dependencies
-    WATIR = "1.9.0"
+    WATIR = "1.9.1"
     WIN32SCREENSHOT = "~>1.0.4"
     WATIR_WEBDRIVER = "~>0.2.5"
   end

data/spec/browser_spec.rb

@@ -0,0 +1,23 @@
+describe WatirSplash::Browser do
+
+  before :all do
+    # close the browser opened in environment.rb
+    WatirSplash::Browser.current.close
+  end
+
+  it "opens up the browser" do
+    browser = WatirSplash::Browser.new
+    browser.should exist
+    browser.should respond_to(:title)
+  end
+
+  it "stores the current browser" do
+    browser = WatirSplash::Browser.new
+    browser.should == WatirSplash::Browser.current
+  end
+
+  after :each do
+    WatirSplash::Browser.current.close
+  end
+
+end

data/spec/environment.rb

@@ -10,5 +10,9 @@ RSpec.configure do |config|
   config.before(:all) do
     WatirSplash::Browser.new
   end
+
+  config.after(:all) do
+    WatirSplash::Browser.current.close
+  end
 end
 

data/spec/page_spec.rb

@@ -0,0 +1,81 @@
+class DummyPage < WatirSplash::Page::Base
+  url "http://bing.com"
+
+  def something
+    modify Hash.new,
+      :store => lambda {|a,b| a + b},
+      :new_method => lambda {[]}
+  end
+end
+
+describe WatirSplash::Page::Base do
+  before :all do
+    # close the browser opened in environment.rb    
+    WatirSplash::Browser.current.close
+  end
+
+  context ".new" do
+    it "opens up a new browser if no browser specified" do
+      page = DummyPage.new
+      browser = page.instance_variable_get(:@browser)
+      browser.should respond_to(:title)
+      browser.url.should =~ /bing\.com/
+    end
+
+    it "allows to reuse existing browser" do
+      browser = WatirSplash::Browser.new
+      browser.goto "http://google.com/ncr"
+
+      page = DummyPage.new(browser)
+      page_browser = page.instance_variable_get(:@browser)
+      page_browser.should == browser
+      page_browser.url.should =~ /google\.com/
+    end
+  end
+
+  context "#modify" do
+    it "returns the instance of the object" do
+      page = DummyPage.new
+      page.something.should == {}
+    end
+
+    it "allows to modify default behavior of the instance's methods" do
+      page = DummyPage.new
+      page.something.store(1, 2).should == 3
+    end
+
+    it "executes the original method too" do
+      page = DummyPage.new
+      res = page.something
+      res.store(1, 2)
+      res.should == {1 => 2}
+    end
+
+    it "doesn't modify instance methods of the class itself" do
+      h = Hash.new
+      h.store(1, 2).should == 2
+      h.should == {1 => 2}
+    end
+
+    it "allows to add new methods too" do
+      page = DummyPage.new
+      page.something.new_method.should == []
+    end
+  end
+
+  context "#method_missing" do
+    it "gets SpecHelper module included into class" do
+      DummyPage.included_modules.should include(WatirSplash::SpecHelper)
+    end
+
+    it "redirects all missing methods to browser object" do
+      page = DummyPage.new
+      page.should_not respond_to(:text_field)
+      page.text_field(:id => /somethin/).should be_kind_of(Watir::TextField)
+    end
+  end
+
+  after :each do
+    WatirSplash::Browser.current.close
+  end
+end

data/spec/rspec_patches_spec.rb

@@ -79,6 +79,61 @@ describe "RSpec patches" do
       end
     end
 
+    context "#during" do
+      it "will pass upon timeout" do
+        require "ruby-debug"; debugger;
+        t = Time.now
+        true.should be_true.during(0.5)
+        (Time.now - t).should be >= 0.5
+      end
+
+      it "handles #should_not via matcher's #matches?" do
+        t = Time.now
+        h = {}
+        h.should_not have_key(:special).during(1)
+        (Time.now - t).should be >= 1
+      end
+
+      it "fails when #should_not is not satisfied during timeout via matcher's #matches?" do
+        t = Time.now
+        h = {}
+        Thread.new {sleep 0.5; h[:special] = true}
+        expect {
+          h.should_not have_key(:special).during(1)
+        }.to raise_error
+        (Time.now - t).should be_between(0.5, 1)
+      end
+
+      it "handles #should_not via matcher's #does_not_match?" do
+        RSpec::Matchers.define :have_my_key do |expected|
+          match_for_should_not do |actual|
+            !actual.has_key?(expected)
+          end
+        end
+
+        t = Time.now
+        h = {}
+        h.should_not have_my_key(:special).during(1)
+        (Time.now - t).should be >= 1
+      end
+
+      it "fails when #should_not is not satisfied within timeout via matcher's #does_not_match?" do
+        RSpec::Matchers.define :have_my_key do |expected|
+          match_for_should_not do |actual|
+            !actual.has_key?(expected)
+          end
+        end
+
+        t = Time.now
+        h = {}
+        Thread.new {sleep 0.5; h[:special] = true}
+        expect {
+          h.should_not have_my_key(:special).during(1)
+        }.to raise_error
+        (Time.now - t).should be_between(0.5, 1)
+      end
+    end
+
     context "#soon" do
       it "is an alias for #in(30)" do
         t = Time.now
@@ -99,21 +154,25 @@ describe "RSpec patches" do
 
     context "#seconds" do
       it "is for syntactic sugar" do
-        RSpec::Matchers::Matcher.new(nil) {}.within(2).seconds.instance_variable_get(:@timeout).should == 2
+        RSpec::Matchers::Matcher.new(nil) {}.within(2).seconds.instance_variable_get(:@within_timeout).should == 2
+        RSpec::Matchers::Matcher.new(nil) {}.during(3).seconds.instance_variable_get(:@during_timeout).should == 3
       end
 
       it "has #second as an alias" do
-        RSpec::Matchers::Matcher.new(nil) {}.within(1).second.instance_variable_get(:@timeout).should == 1
+        RSpec::Matchers::Matcher.new(nil) {}.within(1).second.instance_variable_get(:@within_timeout).should == 1
+        RSpec::Matchers::Matcher.new(nil) {}.during(2).second.instance_variable_get(:@during_timeout).should == 2
       end
     end
 
     context "#minutes" do
       it "converts timeout into minutes" do
-        RSpec::Matchers::Matcher.new(nil) {}.within(2).minutes.instance_variable_get(:@timeout).should == 2*60
+        RSpec::Matchers::Matcher.new(nil) {}.within(2).minutes.instance_variable_get(:@within_timeout).should == 2*60
+        RSpec::Matchers::Matcher.new(nil) {}.during(3).minutes.instance_variable_get(:@during_timeout).should == 3*60
       end
 
       it "has #minute as an alias" do
-        RSpec::Matchers::Matcher.new(nil) {}.within(1).minute.instance_variable_get(:@timeout).should == 1*60
+        RSpec::Matchers::Matcher.new(nil) {}.within(1).minute.instance_variable_get(:@within_timeout).should == 1*60
+        RSpec::Matchers::Matcher.new(nil) {}.during(2).minute.instance_variable_get(:@during_timeout).should == 2*60
       end
     end
 

data/spec/spec_helper_spec.rb

@@ -1,10 +1,5 @@
 describe WatirSplash::SpecHelper do
 
-  it "opens browser automatically" do
-    WatirSplash::Util.formatter.browser.should exist
-    WatirSplash::Util.formatter.browser.url.should == "about:blank"
-  end
-
   it "redirects method calls to Watir::Browser" do
     goto "http://dl.dropbox.com/u/2731643/WatirSplash/test.html"
     url.should =~ /test/

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: watirsplash
 version: !ruby/object:Gem::Version 
-  hash: 15424081
-  prerelease: 6
+  hash: 15
+  prerelease: 
   segments: 
   - 2
   - 0
   - 0
-  - rc
-  - 2
-  version: 2.0.0.rc2
+  version: 2.0.0
 platform: ruby
 authors: 
 - Jarmo Pertman
@@ -17,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-03 00:00:00 Z
+date: 2011-07-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -135,7 +133,9 @@ files:
 - lib/watirsplash/spec_helper.rb
 - lib/watirsplash/util.rb
 - lib/watirsplash/version.rb
+- spec/browser_spec.rb
 - spec/environment.rb
+- spec/page_spec.rb
 - spec/rspec_patches_spec.rb
 - spec/spec_helper_spec.rb
 - spec/spec_match_array_spec.rb
@@ -162,23 +162,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      hash: 25
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
 rubygems_version: 1.8.4
 signing_key: 
 specification_version: 3
-summary: watirsplash 2.0.0.rc2
+summary: watirsplash 2.0.0
 test_files: 
+- spec/browser_spec.rb
 - spec/environment.rb
+- spec/page_spec.rb
 - spec/rspec_patches_spec.rb
 - spec/spec_helper_spec.rb
 - spec/spec_match_array_spec.rb