watir-rspec 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jarmo Pertman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+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.

data/README.md

@@ -0,0 +1,80 @@
+# Watir::RSpec
+
+Use Watir with RSpec with ease.
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+    group :test do
+      gem 'watir-rspec'
+    end
+
+And add these lines to your spec\_helper.rb file:
+
+    RSpec.configure do |config|
+      # Add Watir::RSpec::HtmlFormatter to get links to the screenshots, html and
+      # all other files created during the failing examples.
+      config.add_formatter('documentation')
+      config.add_formatter(Watir::RSpec::HtmlFormatter)
+
+      # Open up the browser for each example.
+      config.before :all do
+        @browser = Watir::Browser.new
+      end
+
+      # Close that browser after each example.
+      config.after :all do
+        @browser.close if @browser
+      end
+
+      # Include RSpec::Helper into each of your example group for making it possible to
+      # write in your examples instead of:
+      #   @browser.goto "localhost"
+      #   @browser.text_field(:name => "first_name").set "Bob"
+      #
+      # like this:
+      #   goto "localhost"
+      #   text_field(:name => "first_name").set "Bob"
+      #
+      # This needs that you've used @browser as an instance variable name in
+      # before :all block.
+      config.include Watir::RSpec::Helper
+    end
+
+
+When using Rails and writing specs to requests directory, add an additional filter for RSpec:
+
+    config.before :all, :type => :request do
+      @browser = Watir::Browser.new :chrome
+    end
+
+    config.after :all, :type => :request do
+      @browser.close if @browser
+    end
+
+    config.include Watir::RSpec::Helper, :type => :request
+
+## Usage
+
+Just use the browser in your examples. If you haven't included
+Watir::RSpec::Helper, then you need to use the @browser instance variable when
+calling Watir::Browser methods, otherwise you may omit it.
+
+When creating/downloading/uploading files in your examples and using
+Watir::RSpec::HtmlFormatter then you can generate links automatically to these files when example
+fails. To do that you need to use Watir::RSpec.file\_path method for generating
+unique file name:
+
+    uploaded_file_path = Watir::RSpec.file_path("uploaded.txt")
+    File.open(uploaded_file_path, "w") {|file| file.write "Generated File Input"}
+
+If you're using Rails, then you also need to install [watir-rails](https://github.com/watir/watir-rails) gem.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/watir/rspec/active_record_shared_connection.rb

@@ -0,0 +1,16 @@
+RSpec.configuration.before(:suite) do
+  # Allow RSpec specs to use transactional fixtures when using Watir. 
+  #
+  # Tip from http://blog.plataformatec.com.br/2011/12/three-tips-to-improve-the-performance-of-your-test-suite/
+  class ::ActiveRecord::Base
+    mattr_accessor :shared_connection
+    @@shared_connection = nil
+
+    def self.connection
+      @@shared_connection || retrieve_connection
+    end
+  end
+
+  # Forces all threads to share the same connection. 
+  ::ActiveRecord::Base.shared_connection = ::ActiveRecord::Base.connection
+end

data/lib/watir/rspec/helper.rb

@@ -0,0 +1,25 @@
+module Watir
+  class RSpec
+    module Helper
+      extend Forwardable
+
+      def method_missing name, *args #:nodoc:
+        if @browser.respond_to?(name)
+          Helper.module_eval %Q[
+            def #{name}(*args)
+              @browser.send(:#{name}, *args) {yield}
+            end
+          ]
+          self.send(name, *args) {yield}
+        else
+          super
+        end
+      end
+
+      # 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_delegators :@browser, :p
+    end
+  end
+end

data/lib/watir/rspec/html_formatter.rb

@@ -0,0 +1,91 @@
+require 'rspec/core/formatters/html_formatter'
+require 'pathname'
+require 'fileutils'
+
+module Watir
+  class RSpec
+    # Custom RSpec formatter
+    # * saves screenshot of the browser upon test failure
+    # * saves html of the browser upon test failure
+    # * saves all files generated/downloaded during the test and shows them in the report
+    class HtmlFormatter < ::RSpec::Core::Formatters::HtmlFormatter
+      def initialize(output) # :nodoc:
+        @output_path = File.expand_path(ENV["WATIR_RESULTS_PATH"] || (output.respond_to?(:path) ? output.path : "tmp/spec-results/index.html"))
+        FileUtils.rm_rf File.dirname(@output_path), :verbose => true if File.exists?(@output_path)
+
+        @output_relative_path = Pathname.new(@output_path).relative_path_from(Pathname.new(Dir.pwd))
+        puts "Results will be saved to #{@output_relative_path}"
+
+        @files_dir = File.dirname(@output_path)
+        FileUtils.mkdir_p(@files_dir)
+        @files_saved_during_example = []
+
+        super(File.open(@output_path, "w"))
+      end
+
+      def example_group_started(example_group) # :nodoc:
+        @files_saved_during_example.clear
+        super
+      end
+
+      def example_started(example) # :nodoc:
+        @files_saved_during_example.clear
+        super
+      end
+
+      def extra_failure_content(exception) # :nodoc:
+        browser = example_group.before_all_ivars[:@browser]
+        return super unless browser && browser.exists?
+
+        save_screenshot browser
+        save_html browser
+
+        content = []
+        content << "<span>"
+        @files_saved_during_example.each {|f| content << link_for(f)}
+        content << "</span>"
+        super + content.join($/)
+      end
+
+      # Generates unique file name and path for each example.
+      #
+      # All file names generated with this method will be shown
+      # on the report.
+      def file_path(file_name, description=nil)
+        extension = File.extname(file_name)
+        basename = File.basename(file_name, extension)
+        file_path = File.join(@files_dir, "#{basename}_#{::Time.now.strftime("%H%M%S")}_#{example_group_number}_#{example_number}#{extension}")
+        @files_saved_during_example.unshift(:desc => description, :path => file_path)
+        file_path
+      end
+
+      private
+
+      def link_for(file) # :nodoc:
+        return unless File.exists?(file[:path])
+
+        description = file[:desc] ? file[:desc] : File.extname(file[:path]).upcase[1..-1]
+        path = Pathname.new(file[:path])
+        "<a href='#{path.relative_path_from(Pathname.new(@output_path).dirname)}'>#{description}</a>&nbsp;"
+      end
+
+      def save_html(browser) # :nodoc:
+        file_name = file_path("browser.html")
+        begin
+          html = browser.html
+          File.open(file_name, 'w') {|f| f.puts html}
+        rescue => e
+          $stderr.puts "saving of html failed: #{e.message}"
+        end
+        file_name
+      end
+
+      def save_screenshot(browser, description="Screenshot") # :nodoc:
+        file_name = file_path("screenshot.png", description)
+        browser.screenshot.save(file_name)
+        file_name
+      end
+
+    end
+  end
+end

data/lib/watir/rspec/version.rb

@@ -0,0 +1,5 @@
+module Watir
+  class RSpec
+    VERSION = "0.0.1"
+  end
+end

data/lib/watir/rspec.rb

@@ -0,0 +1,158 @@
+require 'rspec'
+require File.expand_path("rspec/helper", File.dirname(__FILE__))
+require File.expand_path("rspec/html_formatter", File.dirname(__FILE__))
+
+if defined? ActiveRecord
+  require File.expand_path("rspec/active_record_shared_connection", File.dirname(__FILE__))
+end
+
+module Watir
+  # add #within(timeout) and #during(timeout) methods for every matcher for allowing to wait until some condition is met.
+  #     div.click
+  #     another_div.should be_present.within(5)
+  #
+  #     expect {
+  #       div.click
+  #     }.to change {another_div.text}.from("before").to("after").within(5)
+  #
+  #     expect {
+  #       div.click
+  #     }.to make {another_div.present?}.within(5)
+  #
+  #     expect {
+  #       div.click
+  #     }.to change {another_div.text}.soon
+  #
+  class RSpec
+    class << self
+      def bootstrap const
+        const.class_eval do
+
+          inst_methods = instance_methods.map &:to_sym
+
+          if !(inst_methods.include?(:__matches?) || inst_methods.include?(:__does_not_match?)) && 
+            (inst_methods.include?(:matches?) || inst_methods.include?(:does_not_match?))
+
+            def within(timeout)
+              @within_timeout = timeout
+              self
+            end
+
+            def during(timeout)
+              @during_timeout = timeout
+              self
+            end
+
+            def soon 
+              within(30)
+            end      
+
+            def seconds
+              # for syntactic sugar
+              self
+            end
+
+            alias_method :second, :seconds
+
+            def minutes
+              @within_timeout *= 60 if @within_timeout
+              @during_timeout *= 60 if @during_timeout
+              self
+            end
+
+            alias_method :minute, :minutes
+          end
+
+          if inst_methods.include? :matches?
+            alias_method :__matches?, :matches? 
+
+            def matches?(actual)
+              match_with_wait {__matches?(actual)}
+            end
+          end
+
+          if inst_methods.include? :does_not_match?
+            alias_method :__does_not_match?, :does_not_match?
+
+            def does_not_match?(actual)
+              match_with_wait {__does_not_match?(actual)}
+            end
+          elsif inst_methods.include? :matches?
+            def does_not_match?(actual)
+              match_with_wait {!__matches?(actual)}
+            end
+          end
+
+          private
+
+          def match_with_wait
+            if @within_timeout
+              timeout = @within_timeout; @within_timeout = nil
+              Watir::Wait.until(timeout) {yield} rescue false
+            elsif @during_timeout
+              timeout = @during_timeout; @during_timeout = nil
+              Watir::Wait.while(timeout) {yield} rescue true        
+            else
+              yield
+            end
+          end
+        end
+      end
+
+      def file_path(file_name, description=nil)
+        formatter.file_path(file_name, description=nil)
+      end
+
+      private
+
+      def formatter
+        @formatter ||= begin
+                         formatter = ::RSpec.configuration.formatters.find {|f| f.kind_of? Watir::RSpec::HtmlFormatter}
+                         unless formatter
+                           raise <<-EOF
+Watir::RSpec::HtmlFormatter is not set as a RSpec formatter.
+
+You need to add it into your spec_helper.rb file like this:
+  RSpec.configure do |config|
+    config.add_formatter('documentation')
+    config.add_formatter(Watir::RSpec::HtmlFormatter)
+  end
+EOF
+                         end
+                         formatter
+                       end
+      end
+
+
+    end
+
+  end
+end
+
+# patch for #within(timeout) method
+module ::RSpec::Matchers
+  class BuiltIn::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
+
+  alias_method :make, :change
+end
+
+matchers = RSpec::Matchers::BuiltIn.constants.map(&:to_sym)
+matchers.delete :BaseMatcher
+matchers.each do |const|
+  Watir::RSpec.bootstrap RSpec::Matchers::BuiltIn.const_get const
+end
+
+Watir::RSpec.bootstrap RSpec::Matchers::DSL::Matcher

data/watir-rspec.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/watir/rspec/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jarmo Pertman"]
+  gem.email         = ["jarmo.p@gmail.com"]
+  gem.description   = %q{Use Watir with RSpec with ease.}
+  gem.summary       = %q{Use Watir with RSpec with ease.}
+  gem.homepage      = "http://github.com/watir/watir-rspec"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "watir-rspec"
+  gem.require_paths = ["lib"]
+  gem.version       = Watir::RSpec::VERSION
+
+  gem.add_dependency "rspec", "~>2.0"
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: watir-rspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jarmo Pertman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Use Watir with RSpec with ease.
+email:
+- jarmo.p@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/watir/rspec.rb
+- lib/watir/rspec/active_record_shared_connection.rb
+- lib/watir/rspec/helper.rb
+- lib/watir/rspec/html_formatter.rb
+- lib/watir/rspec/version.rb
+- watir-rspec.gemspec
+homepage: http://github.com/watir/watir-rspec
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Use Watir with RSpec with ease.
+test_files: []
+has_rdoc: