watir-rails 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8edc0290a0d14704fb728ea56c21794d20ac317
-  data.tar.gz: 4f863b275e8f3c46c4876d25126dce28bdb460b0
+  metadata.gz: 31008115d6a0ed1cd3554b257f0d28237ca3449d
+  data.tar.gz: a44a67b33ffef400006f8a3a36770e58af34ae72
 SHA512:
-  metadata.gz: 9b31e10fc8944ad4ab387d8e10e10d5f0d1b1c8d8389e1614228d0fc1690d5ac23147a2e0ca3fec7cafcda7597bd0d25b05de64af49dfab88a9fe1b6aa0b06df
-  data.tar.gz: 835e47a998c9d9d4e0d3fe956d6d3ec9e2062719dcbd90a3662dcc977eca43e2147d9d0e8468b69d7580bc3bfd0c70b923c4a1ca3f234182cb18b8c762023743
+  metadata.gz: 29ddc148bfe23b5bb9adb807a18fafb15a696de78b9cb462e90348580ac076ca157709f6ee6ed900aad58139e60a26d1fc7414b20e64eec78ef4dbcf404039db
+  data.tar.gz: 1a2a9bcc5d9c6546e4735f895057021de0b21b20bd1aa628d35d0f73bee5cda907ea33946a1a437e077b32fe8d0102a727d0d2879ddbc4ef24803feee7bb9576

data/.travis.yml

@@ -0,0 +1,11 @@
+rvm:
+ - 1.9.3
+ - 2.0.0
+ - ruby-head
+notifications:
+  recipients:
+    - jarmo.p@gmail.com
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+

data/CHANGES.md

@@ -0,0 +1,5 @@
+### 1.0.0 - 2013/10/05
+
+* Add watir as a dependency to make it possible to use watir-classic too.
+* Add specs to keep the quality high.
+* Documentation fixes.

data/Gemfile

@@ -1,3 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
+
+gem "coveralls", require: false

data/README.md

@@ -1,6 +1,9 @@
 # Watir::Rails
+[![Gem Version](https://badge.fury.io/rb/watir-rails.png)](http://badge.fury.io/rb/watir-rails)
+[![Build Status](https://api.travis-ci.org/watir/watir-rails.png)](http://travis-ci.org/watir/watir-rails)
+[![Coverage](https://coveralls.io/repos/watir/watir-rails/badge.png?branch=master)](https://coveralls.io/r/watir/watir-rails)
 
-This gem adds the [Watir](http://github.com/watir/watir) usage support when writing integration tests in Rails.
+This gem makes the [Watir](https://github.com/watir/watir) work with Rails.
 
 
 ## Installation
@@ -9,7 +12,7 @@ Add this code to your Gemfile:
 
 ```ruby
 group :test do
-  gem 'watir-rails'
+  gem "watir-rails"
 end
 ```
 
@@ -34,7 +37,7 @@ This feature is only enabled when `config.action_dispatch.show_exceptions` is se
 You can disable it in watir-rails by ignoring exceptions:
 
 ```ruby
-Watir::Rails.ignore_exceptions = false
+Watir::Rails.ignore_exceptions = true
 ```
 
 ## Limitations
@@ -56,11 +59,3 @@ The problem is probably caused by the fact that [WIN32OLE overwrites Thread#init
 ## License
 
 See [LICENSE](https://github.com/watir/watir-rails/blob/master/LICENSE).
-
-## 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

@@ -1,3 +1,9 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :release => :spec
+
 require "yard"
 YARD::Rake::YardocTask.new

data/lib/watir/browser.rb

@@ -7,32 +7,60 @@ module Watir
     # Will start Rails instance for Watir automatically and then invoke the
     # original Watir::Browser#initialize method.
     def initialize(*args)
-      Rails.boot
-      original_initialize *args
-      add_checker do
-        if error = Rails.error
-          Rails.error = nil
-          raise error
-        end
-      end unless Rails.ignore_exceptions?
+      initialize_rails_with_watir *args
     end
 
-    # @private
-    alias_method :original_goto, :goto
-
     # Opens the url with the browser instance.
     # Will add {Rails.host} and {Rails.port} to the url when path is specified.
     #
-    # @example Open the regular url:
+    # @example Go to the regular url:
     #   browser.goto "http://google.com"
     #
-    # @example Open the controller path:
+    # @example Go to the controller path:
     #   browser.goto home_path
     #
     # @param [String] url URL to be navigated to.
     def goto(url)
       url = "http://#{Rails.host}:#{Rails.port}#{url}" unless url =~ %r{^(about|data|https?):}i
-      original_goto url
+      _new_goto url
+    end
+
+    private
+
+    def override_and_preserve_original_methods(*method_names, &block)
+      method_names.each do |method_name|
+        next if respond_to? "_original_#{method_name}", true
+        self.class.send :alias_method, "_original_#{method_name}", method_name
+      end
+
+      result = block.call
+
+      method_names.each do |method_name|
+        next if respond_to? "_new_#{method_name}", true
+        self.class.send :alias_method, "_new_#{method_name}", method_name
+
+        self.class.send :define_method, method_name do |*args|
+          send("_original_#{method_name}", *args)
+          #send("_new_#{method_name}", *args)
+        end
+      end
+
+      result
+    end
+
+    def initialize_rails_with_watir(*args)
+      Rails.boot
+      override_and_preserve_original_methods(:goto) { original_initialize *args }
+      add_exception_checker unless Rails.ignore_exceptions?
+    end
+
+    def add_exception_checker
+      add_checker do
+        if error = Rails.error
+          Rails.error = nil
+          raise error
+        end
+      end
     end
   end
 end

data/lib/watir/rails.rb

@@ -1,7 +1,8 @@
-require 'uri'
-require 'net/http'
-require 'rack'
-require 'watir-webdriver'
+require "uri"
+require "net/http"
+require "rack"
+require "watir"
+require "rails"
 require File.expand_path("browser.rb", File.dirname(__FILE__))
 require File.expand_path("rails/middleware.rb", File.dirname(__FILE__))
 
@@ -23,14 +24,13 @@ module Watir
             run_default_server @middleware, @port
           end
 
-          Timeout.timeout(60) { @server_thread.join(0.1) until running? }
+          Timeout.timeout(boot_timeout) { @server_thread.join(0.1) until running? }
         end
       rescue TimeoutError
-        raise "Rails Rack application timed out during boot"
+        raise TimeoutError, "Rails Rack application timed out during boot"
       end
 
-      # Host for Rails app under test. When not set via {.host=} then
-      # {.local_host} is used.
+      # Host for Rails app under test. Default is {.local_host}.
       #
       # @return [String] Host for Rails app under test.
       def host
@@ -119,6 +119,10 @@ module Watir
 
       private
 
+      def boot_timeout
+        60
+      end
+
       def find_available_port
         server = TCPServer.new(local_host, 0)
         server.addr[1]

data/lib/watir/version.rb

@@ -1,5 +1,5 @@
 module Watir
   class Rails
-    VERSION = "0.1.2"
+    VERSION = "1.0.0"
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "simplecov"
+require 'coveralls'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start
+
+# Make sure that fake watir gems are loaded for specs.
+$LOAD_PATH.unshift File.expand_path("support", File.dirname(__FILE__))
+
+require "watir/rails"
+
+RSpec.configure do |c|
+  c.color = true
+  c.order = :random
+end

data/spec/support/fake_browser_with_goto.rb

@@ -0,0 +1,8 @@
+# Needed to simulate watir driver's gem (watir-webdriver or watir-classic).
+
+module Watir
+  class Browser
+    def goto(*args)
+    end
+  end
+end

data/spec/support/watir.rb

@@ -0,0 +1,9 @@
+# Needed to simulate watir gem.
+
+module Watir
+  class Browser
+    def initialize(*args)
+      require File.expand_path("fake_browser_with_goto", File.dirname(__FILE__))
+    end
+  end
+end

data/spec/watir/browser_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+
+describe Watir::Browser do
+  before { Watir::Rails.stub(ignore_exceptions?: true) }
+
+  context "#initialize" do
+    it "starts Rails before opening the browser" do
+      Watir::Rails.should_receive(:boot)
+      Watir::Browser.any_instance.should_receive(:original_initialize).and_call_original
+
+      Watir::Browser.new
+    end
+
+    it "does not add Exception checker when exceptions are ignored" do
+      Watir::Rails.stub(ignore_exceptions?: true, boot: nil)
+
+      Watir::Browser.any_instance.should_not_receive(:add_exception_checker)
+      Watir::Browser.new
+    end
+
+    it "adds Exception checker when exceptions are not ignored" do
+      Watir::Rails.stub(ignore_exceptions?: false, boot: nil)
+
+      Watir::Browser.any_instance.should_receive(:add_exception_checker)
+      Watir::Browser.new
+    end
+  end
+
+  context "#goto" do
+    before do
+      Watir::Rails.stub(host: "foo.com", port: 42, boot: nil)
+    end
+
+    let(:browser) { Watir::Browser.new }
+
+    it "uses Rails for paths specified as an url" do
+      browser.should_receive(:_new_goto).with("http://foo.com:42/foo/bar")
+      browser.goto("/foo/bar")
+    end
+
+    it "does not alter url with http:// scheme" do
+      browser.should_receive(:_new_goto).with("http://baz.org/lol")
+      browser.goto("http://baz.org/lol")
+    end
+
+    it "does not alter url with https:// scheme" do
+      browser.should_receive(:_new_goto).with("https://baz.org/lol")
+      browser.goto("https://baz.org/lol")
+    end
+
+    it "does not alter about:urls" do
+      browser.should_receive(:_new_goto).with("about:url")
+      browser.goto("about:url")
+    end
+
+    it "does not alter data:urls" do
+      browser.should_receive(:_new_goto).with("data:url")
+      browser.goto("data:url")
+    end
+
+    it "alters the unknown urls" do
+      browser.should_receive(:_new_goto).with("http://foo.com:42/xxx:yyy")
+      browser.goto("http://foo.com:42/xxx:yyy")
+    end
+  end
+end

data/spec/watir/rails/middleware_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe Watir::Rails::Middleware do
+  let(:app) { double("app") }
+  let(:middleware) { described_class.new app }
+
+  context "#call" do
+    it "/__identify__ returns app id" do
+      app.should_not_receive(:call)
+      middleware.call("PATH_INFO" => "/__identify__").should == [200, {}, [app.object_id.to_s]]
+    end
+
+    it "other requests are forwarded to the app" do
+      env = {}
+      app.should_receive(:call).with(env)
+      middleware.call(env)
+    end
+
+    it "errors are stored and re-raised" do
+      error = RuntimeError.new
+      app.stub(:call).and_raise error
+
+      expect {
+        middleware.call({})
+      }.to raise_error(error)
+
+      middleware.error.should == error
+    end
+  end
+end

data/spec/watir/rails_spec.rb

@@ -0,0 +1,127 @@
+require "spec_helper"
+
+describe Watir::Rails do
+  before do
+    described_class.stub(:warn)
+    described_class.ignore_exceptions = false
+    described_class.instance_eval { @middleware = @port = @server_thread = @host = @app = nil }
+  end
+
+  context ".boot" do
+    it "starts the server unless already running" do
+      described_class.stub(app: double("app"), find_available_port: 42)
+      described_class.should_receive(:running?).twice.and_return(false, true)
+      described_class.should_receive(:run_default_server).once
+
+      described_class.boot
+    end
+
+    it "does nothing if server is already running" do
+      described_class.stub(app: double("app"), find_available_port: 42)
+      described_class.should_receive(:running?).once.and_return(true)
+      described_class.should_not_receive(:run_default_server)
+
+      described_class.boot
+    end
+
+    it "raises an error if Rails won't boot with timeout" do
+      described_class.stub(app: double("app"), find_available_port: 42, boot_timeout: 0.01)
+      described_class.should_receive(:running?).at_least(:twice).and_return(false)
+      described_class.should_receive(:run_default_server)
+
+      expect {
+        described_class.boot
+      }.to raise_error(Timeout::Error)
+    end
+  end
+
+  context ".host" do
+    it "@host if specified" do
+      described_class.host = "my_host"
+      described_class.host.should == "my_host"
+    end
+
+    it "local_host if @host is not specified" do
+      described_class.host = nil
+      described_class.host.should == "127.0.0.1"
+    end
+  end
+
+  context ".ignore_exceptions?" do
+    it "true if @ignore_exceptions is set to true" do
+      described_class.ignore_exceptions = true
+      described_class.should be_ignore_exceptions
+    end
+
+    it "true if Rails.action_dispatch.show_exceptions is set to true for older Rails" do
+      described_class.stub(legacy_rails?: true)
+      described_class.ignore_exceptions = false
+      ::Rails.stub_chain(:configuration, :action_dispatch, :show_exceptions).and_return(true)
+
+      described_class.should be_ignore_exceptions
+    end
+
+    it "true if Rails.action_dispatch.show_exceptions is set to true for Rails 3" do
+      described_class.stub(legacy_rails?: false)
+      described_class.ignore_exceptions = false
+      ::Rails.stub_chain(:application, :config, :action_dispatch, :show_exceptions).and_return(true)
+
+      described_class.should be_ignore_exceptions
+    end
+
+    it "false if Rails.action_dispatch.show_exceptions is set to false for older Rails" do
+      described_class.stub(legacy_rails?: true)
+      described_class.ignore_exceptions = false
+      ::Rails.stub_chain(:application, :config, :action_dispatch, :show_exceptions).and_return(false)
+
+      described_class.should_not be_ignore_exceptions
+    end
+
+    it "true if Rails.action_dispatch.show_exceptions is set to false for Rails 3" do
+      described_class.stub(legacy_rails?: false)
+      described_class.ignore_exceptions = false
+      ::Rails.stub_chain(:application, :config, :action_dispatch, :show_exceptions).and_return(false)
+
+      described_class.should_not be_ignore_exceptions
+    end
+  end
+
+  context ".running?" do
+    it "false if server thread is running" do
+      fake_thread = double("thread", join: :still_running)
+      described_class.instance_variable_set(:@server_thread, fake_thread)
+
+      described_class.should_not be_running
+    end
+
+    it "false if server cannot be accessed" do
+      fake_thread = double("thread", join: nil)
+      described_class.instance_variable_set(:@server_thread, fake_thread)
+
+      Net::HTTP.should_receive(:start).and_raise Errno::ECONNREFUSED
+      described_class.should_not be_running
+    end
+
+    it "false if server response is not success" do
+      fake_thread = double("thread", join: nil)
+      described_class.instance_variable_set(:@server_thread, fake_thread)
+      app = double("app")
+      described_class.instance_variable_set(:@app, app)
+
+      response = double(Net::HTTPSuccess, is_a?: false)
+      Net::HTTP.should_receive(:start).and_return response
+      described_class.should_not be_running
+    end    
+
+    it "true if server response is success" do
+      fake_thread = double("thread", join: nil)
+      described_class.instance_variable_set(:@server_thread, fake_thread)
+      app = double("app")
+      described_class.instance_variable_set(:@app, app)
+
+      response = double(Net::HTTPSuccess, is_a?: true, body: app.object_id.to_s)
+      Net::HTTP.should_receive(:start).and_return response
+      described_class.should be_running
+    end
+  end
+end

data/watir-rails.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/watir/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Jarmo Pertman"]
   gem.email         = ["jarmo.p@gmail.com"]
-  gem.description   = %q{Add support for Watir (http://github.com/watir/watir) in Rails.}
-  gem.summary       = %q{Add support for Watir (http://github.com/watir/watir) in Rails.}
+  gem.description   = %q{Use Watir (http://github.com/watir/watir) in Rails.}
+  gem.summary       = %q{Use Watir (http://github.com/watir/watir) in Rails.}
   gem.homepage      = "http://github.com/watir/watir-rails"
 
   gem.files         = `git ls-files`.split($\)
@@ -17,8 +17,9 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "rack"
   gem.add_dependency "rails"
-  gem.add_dependency "watir-webdriver"
+  gem.add_dependency "watir", "~> 5.0"
 
   gem.add_development_dependency "yard"
   gem.add_development_dependency "redcarpet"
+  gem.add_development_dependency "rspec", "~>2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watir-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Jarmo Pertman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-13 00:00:00.000000000 Z
+date: 2013-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: watir-webdriver
+  name: watir
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,21 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Add support for Watir (http://github.com/watir/watir) in Rails.
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Use Watir (http://github.com/watir/watir) in Rails.
 email:
 - jarmo.p@gmail.com
 executables: []
@@ -88,7 +102,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - .yardopts
+- CHANGES.md
 - Gemfile
 - LICENSE
 - README.md
@@ -97,6 +113,12 @@ files:
 - lib/watir/rails.rb
 - lib/watir/rails/middleware.rb
 - lib/watir/version.rb
+- spec/spec_helper.rb
+- spec/support/fake_browser_with_goto.rb
+- spec/support/watir.rb
+- spec/watir/browser_spec.rb
+- spec/watir/rails/middleware_spec.rb
+- spec/watir/rails_spec.rb
 - watir-rails.gemspec
 homepage: http://github.com/watir/watir-rails
 licenses: []
@@ -117,9 +139,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
-summary: Add support for Watir (http://github.com/watir/watir) in Rails.
-test_files: []
+summary: Use Watir (http://github.com/watir/watir) in Rails.
+test_files:
+- spec/spec_helper.rb
+- spec/support/fake_browser_with_goto.rb
+- spec/support/watir.rb
+- spec/watir/browser_spec.rb
+- spec/watir/rails/middleware_spec.rb
+- spec/watir/rails_spec.rb
 has_rdoc: