watirsplash 1.4.3 → 2.0.0.rc1

data/lib/watirsplash/frameworks/firewatir.rb

@@ -1,4 +1,4 @@
-WatirSplash::Frameworks::Helper.load_gem :gem => "firewatir", :version => "1.8.1"
+WatirSplash::Frameworks::Helper.load_gem "firewatir"
 
 module FireWatir #:nodoc:all
   class Firefox

data/lib/watirsplash/frameworks/helper.rb

@@ -3,22 +3,8 @@ module WatirSplash
     class Helper
       class << self
         def load_gems *gems
-          failed_gems = []
-          gems.each do |gem_params|
-            begin
-              gem gem_params[:gem], gem_params[:version]
-              require gem_params[:require] || gem_params[:gem]
-            rescue Gem::LoadError
-              failed_gems << gem_params
-            end
-          end
-          unless failed_gems.empty?
-            puts "\nSome dependencies are missing. Install them with:"
-            failed_gems.each do |failed_gem|
-              puts "  gem install #{failed_gem[:gem]}#{failed_gem[:version] ? " -v #{failed_gem[:version].gsub(/^[~>=]*\s*/, "")}" : ""}"
-            end
-            puts
-            exit 1 unless failed_gems.empty?          
+          gems.each do |gem|
+            require gem
           end
         end
 

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

@@ -1,4 +1,4 @@
-WatirSplash::Frameworks::Helper.load_gem :gem => "watir-webdriver", :version => ">=0.2.3"
+WatirSplash::Frameworks::Helper.load_gem "watir-webdriver"
 
 module Watir
   class Browser

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

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

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

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

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

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

data/lib/watirsplash/frameworks/watir.rb

@@ -1,5 +1,4 @@
-WatirSplash::Frameworks::Helper.load_gems({:gem => "watir", :version => "1.8.1"}, 
-  {:gem => "win32screenshot", :require => "win32/screenshot", :version => ">=1.0.3"})
+WatirSplash::Frameworks::Helper.load_gems "watir", "win32/screenshot"
 require "watirsplash/mini_magick_patch"
 require "watir/ie"
 
@@ -20,7 +19,6 @@ module Watir
       self.speed = :fast
       @error_checkers ||= []
       add_checker Watir::PageCheckers::JAVASCRIPT_ERRORS_CHECKER
-      maximize if @ie # @ie is not set here when attaching...
     end
 
     def save_screenshot(params)

data/lib/watirsplash/generators/helper.rb

@@ -0,0 +1,15 @@
+module WatirSplash
+  module Generators
+    module Helper
+      def supported_frameworks
+        %w[default watir firewatir watir-webdriver/ie watir-webdriver/firefox watir-webdriver/chrome]
+      end
+
+      def frameworks_banner
+        "# What framework to use? Possible values are:\r\n" +
+          "#   * #{supported_frameworks.join("\r\n#   * ")}\r\n" +
+          "WatirSplash::Util.framework = \"#{framework}\""
+      end
+    end
+  end
+end

data/lib/watirsplash/generators/new_project.rb

@@ -1,42 +1,43 @@
 require "uri"
+require "watirsplash/version"
 
 module WatirSplash
   module Generators
     class NewProject < Thor::Group
       include Thor::Actions
+      include Helper
 
       argument :name 
       argument :url
       argument :framework
-      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
+        directory("new_project", name)
+        template("../../../../Gemfile", "#{name}/Gemfile")
 
-      def formatted_name
-        Thor::Util.snake_case(name)
+        gsub_file("#{name}/Gemfile", "gemspec", %Q{gem "watirsplash", "#{WatirSplash::Version::WATIRSPLASH}"})
+        gsub_file("#{name}/Gemfile", /WatirSplash::Version::WATIR_WEBDRIVER/, "\"#{WatirSplash::Version::WATIR_WEBDRIVER}\"")
+        gsub_file("#{name}/Gemfile", /WatirSplash::Version::WATIR/, "\"#{WatirSplash::Version::WATIR}\"")
+        gsub_file("#{name}/Gemfile", /WatirSplash::Version::WIN32SCREENSHOT/, "\"#{WatirSplash::Version::WIN32SCREENSHOT}\"")
       end
 
       def formatted_url
         uri = URI.parse(url)
-        if load_common && !default_url? && uri.relative?
-          %Q[Config.full_url("#{uri}")] 
+        if !default_url? && uri.relative?
+          %Q[URI.join(#{formatted_name}::Config::URL, "#{uri}").to_s] 
         else
           %Q["#{uri}"]
         end
       end
 
+      def formatted_name
+        Thor::Util.camel_case name.gsub("-", "_")
+      end
+
       def default_url?
         url.to_s == "about:blank"
       end

data/lib/watirsplash/generators/page.rb

@@ -0,0 +1,64 @@
+require "uri"
+
+module WatirSplash
+  module Generators
+    class Page < Thor::Group
+      include Thor::Actions
+
+      argument :page_name
+      argument :elements
+      argument :namespace
+      argument :create_spec, :optional => true
+      argument :url, :optional => true
+
+      def self.source_root
+        File.dirname(__FILE__) + "/templates"
+      end
+
+      def generate
+        directory("page/lib", "lib")
+        directory("page/spec", "spec") if create_spec
+      end
+
+      def formatted_page_name
+        Thor::Util.snake_case(page_name)
+      end
+
+      def formatted_namespace
+        Thor::Util.snake_case(namespace)
+      end
+
+      def page_body
+        str = ""
+        str += %Q[url "#{url}"
+] if url
+
+        elements.each do |element|
+          name, type, locator_name, locator_value = element.split(":")
+          str += %Q[
+      def #{name}
+        #{type}(:#{locator_name} => "#{locator_value}")
+      end
+]
+        end
+        str
+      end
+
+      def spec_body
+        str = "#{formatted_page_name}_page = #{page_path}.new#{$/}"
+
+        elements.each do |element|
+          name, type, locator_name, locator_value = element.split(":")
+          str += %Q[    # #{formatted_page_name}_page.#{name} # => #{type}(:#{locator_name} => "#{locator_value}")
+]
+        end
+        str
+      end
+
+      def page_path
+        "#{Thor::Util.camel_case(namespace)}::Page::#{Thor::Util.camel_case(page_name)}"
+      end
+
+    end
+  end
+end

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

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

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

@@ -1,34 +1,7 @@
-# What framework to use? Possible values are:
-#   * watir
-#   * firewatir
-#   * watir-webdriver/ie
-#   * watir-webdriver/firefox
-#   * watir-webdriver/chrome
-<%=
-  load_cmd = ""
-  load_cmd += "# " if load_common
-  load_cmd += "WatirSplash::Util.framework = \"#{framework}\""
-%> 
-
 # 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")
+module <%= formatted_name %>
+  module Config
+    # Main URL of your application under test
     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/lib/watirsplash/generators/templates/new_project/environment.rb.tt

@@ -1,13 +1,15 @@
-# Add all your require statements into this file to avoid unnecessary
-# code in your spec files
+require "rubygems"
+require "bundler"
+Bundler.setup
+require "watirsplash"
+
+<%= frameworks_banner %>
 
-<%= load_common_cmd %>
+# Load the framework specified by the environment variable WATIRSPLASH_FRAMEWORK or WatirSplash::Util.framework
+WatirSplash::Util.load_framework
 
-# 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$/i
-end
-require_all filtered_ruby_files
+require_all File.join(File.dirname(__FILE__), "lib/**/*.rb")
 require_rel "config.rb"
+
+# Add all your require statements into this file to avoid unnecessary
+# code in your spec files

data/lib/watirsplash/generators/templates/page/lib/%formatted_namespace%/page/%formatted_page_name%.rb.tt

@@ -0,0 +1,8 @@
+module <%= Thor::Util.camel_case namespace %>
+  module Page
+    class <%= Thor::Util.camel_case page_name %> < WatirSplash::Page::Base
+      <%= page_body %>
+    end
+  end
+end
+

data/lib/watirsplash/generators/templates/page/spec/%formatted_namespace%/page/%formatted_page_name%_spec.rb.tt

@@ -0,0 +1,5 @@
+describe <%= page_path %> do
+  it "has something on the <%= formatted_page_name %> page" do
+    <%= spec_body %>
+  end
+end

data/lib/watirsplash/html_formatter.rb

@@ -12,7 +12,7 @@ module WatirSplash
 
     # currently used browser object
     # needed for saving of screenshots and html
-    attr_writer :browser
+    attr_accessor :browser
 
     def initialize(output) # :nodoc:
       @output_dir = File.expand_path(File.dirname(output))

data/lib/watirsplash/page/base.rb

@@ -0,0 +1,41 @@
+module WatirSplash
+  module Page
+    class Base
+      include SpecHelper
+
+      class << self
+        @@url = "about:blank"
+
+        def url url
+          @@url = url
+        end
+      end
+
+      def initialize(browser=nil)
+        if browser
+          @browser = WatirSplash::Util.formatter.browser = browser 
+        else
+          @browser = WatirSplash::Browser.new
+          @browser.goto @@url
+        end
+      end
+
+      def return_for element, methodz
+        methodz.each_pair do |meth, return_value|
+          element.instance_eval do 
+            instance_variable_set("@#{meth}_return_value", 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)
+              end
+            ]
+          end
+        end
+        element
+      end
+    end
+  end
+end

data/lib/watirsplash/rspec_patches.rb

@@ -30,12 +30,8 @@ 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 if @browser
+    WatirSplash::Util.formatter.browser.close if WatirSplash::Util.formatter.browser
   end
 end
 
@@ -117,7 +113,9 @@ 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?)
+    if !(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)
@@ -162,7 +160,7 @@ RSpec::Matchers.constants.each do |const|
       def does_not_match?(actual)
         @timeout ? (Watir::Wait.until(@timeout) {__does_not_match?(actual)} rescue false) : __does_not_match?(actual)
       end
-    else
+    elsif inst_methods.include? :matches?
       def does_not_match?(actual)
         @timeout ? !(Watir::Wait.while(@timeout) {__matches?(actual)} rescue true) : !__matches?(actual)
       end

data/lib/watirsplash/spec_helper.rb

@@ -4,31 +4,24 @@ module WatirSplash
   # these methods can be used in specs directly
   module SpecHelper
 
-    # opens the browser at specified url
-    def open_browser_at url
-      @browser = WatirSplash::Browser.new
-      Util.formatter.browser = @browser 
-      goto url
-    end
-
     def method_missing name, *args #:nodoc:
-      if @browser.respond_to?(name)
+      if WatirSplash::Util.formatter.browser.respond_to?(name)
         SpecHelper.module_eval %Q[
           def #{name}(*args)
-            @browser.send(:#{name}, *args) {yield}
+            WatirSplash::Util.formatter.browser.send(:#{name}, *args) {yield}
           end
         ]
-        @browser.send(name, *args) {yield}
+        WatirSplash::Util.formatter.browser.send(name, *args) {yield}
       else
         super
       end
     end
 
-    # make sure that using method 'p' will be invoked on @browser
+    # make sure that using method 'p' will be invoked on browser
     # and not Kernel
     # use Kernel.p if you need to dump some variable 
     def p *args #:nodoc:
-      @browser.p *args
+      WatirSplash::Util.formatter.browser.p *args
     end
 
   end

data/lib/watirsplash/util.rb

@@ -3,24 +3,6 @@ module WatirSplash
   class Util
     class << self
 
-      # loads ui-test-common/environment.rb
-      #
-      # ui-test-common has to be located at some higher level within directory
-      # structure compared to project/ui-test directory
-      def load_common
-        dir = common_dir
-        puts "Loading ui-test-common from #{dir}..."
-        require File.join(dir, "environment.rb")
-      end
-
-      # loads environment.rb for the project if it exists in the ui-test
-      # or in some higher level directory 
-      def load_environment
-        Pathname(Dir.pwd).ascend do |path|
-          require File.join(path, "environment.rb") if has_environment?(path)
-        end
-      end
-
       # configure RSpec to use documentation and WatirSplash::HtmlFormatter formatters
       def configure_rspec_formatters
         config = RSpec.configuration
@@ -38,7 +20,8 @@ module WatirSplash
       @@framework = nil
 
       def framework= framework
-        @@framework = framework.to_sym
+        framework = framework.to_sym
+        @@framework = framework == :default ? default_framework : framework.to_sym
       end
 
       def framework
@@ -47,7 +30,7 @@ module WatirSplash
 
       def load_framework
         self.framework = ENV["WATIRSPLASH_FRAMEWORK"] || framework || default_framework
-        require "watirsplash/frameworks/#{framework}"        
+        require "watirsplash/frameworks/#{framework}"
       end
 
       private
@@ -63,21 +46,6 @@ module WatirSplash
         end
       end
 
-      def common_dir
-        ui_test_common_dir = "ui-test-common"
-        Pathname(Dir.pwd).ascend do |path|
-          if File.exists?(dir = File.join(path, ui_test_common_dir)) &&
-                  has_environment?(dir)
-            return dir
-          end
-        end
-        raise "#{ui_test_common_dir} directory was not found! It has to exist somewhere higher in directory tree than your project's directory and it has to have environment.rb file in it!"
-      end
-
-      def has_environment? dir
-        File.exists?(File.join(dir, "environment.rb"))
-      end
-
     end
   end
 end