watir-rails 1.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae7a57e6b5536cac083dfa83bffa44461bd34d0f
-  data.tar.gz: 62d7d8fcf2a10ed6ca3ea85df33cb102bcea39c3
+SHA256:
+  metadata.gz: 51d6a45bcdb312a379e427c3a560c2a70aafe25b3aa2622721444d2903e50309
+  data.tar.gz: 4c80f41a3b0da65f8ec48b860badd3e71f651a83f50fababc325ac633ed7d5a9
 SHA512:
-  metadata.gz: 48e9fac9f32993daf3fa757908413deb595e66362934a91b93aa571313ceac211d4f3ff6be886e72629f6622fc3ff033a2af73be7b1afe3a00c18f76c9393f08
-  data.tar.gz: eaf0dea201e969a9fc4079fb8584abe730c9f94222902dadf02b5210557150643ad44719eab9ed998bfdcda66f392152e24f64a8087e9c3f1512536212bc26d5
+  metadata.gz: 3d5bbc1fc15eab822f650c956ce12dd252ac0a2071f11fe0fcdafbdc3f6d411255d5d190359e1099865a4bb7c25462e9d0317750350b2e993b36cf89904497ec
+  data.tar.gz: b245693600d488f7d89881243af9b3d1f87bb8e7ce603b19ead3739780512bd6c16cb0c066cd8ae32cc5a9476522050fd99c38f0a8a364e7d3d97b2e7eeb75dc

data/.travis.yml

@@ -1,15 +1,14 @@
 rvm:
- - 2.3.1
- - 2.2.5
- - 2.1.9
- - ruby-head
+  - 2.6.3
+  - ruby-head
 gemfile:
   - gemfiles/Gemfile.rails-2.x
   - gemfiles/Gemfile.rails-3.x
+  - gemfiles/Gemfile.rails-4.x
   - Gemfile
 notifications:
   recipients:
-    - jarmo.p@gmail.com
+    - jarmo@jarmopertman.com
 matrix:
   allow_failures:
     - rvm: ruby-head

data/CHANGES.md

@@ -1,33 +1,54 @@
-### 1.2.1 - 2016/06/15
-
-* Fix Browser#add_checker deprecation warning. PR #18 by Christophe Bliard.
-
-### 1.2.0 - 2016/01/16
-
-* Add support for running Rails on Puma server. PR #15 by Andrey Koleshko.
-
-### 1.1.0 - 2015/07/22
-
-* Remove strict `mime-types` dependency. See #13
-
-### 1.0.4 - 2015/02/28
-
-* Allow to set Watir::Rails.ignore_exceptions to false. PR #8 by Andrey Koleshko.
-
-### 1.0.3 - 2013/11/02
-
-* Make watir-rails working with Rails 2.3.x too.
-
-### 1.0.2 - 2013/11/02
-
-* Make sure that newest Rails is going to be installed on an empty system.
-
-### 1.0.1 - 2013/11/01
-
-* Add license to gemspec.
-
-### 1.0.0 - 2013/10/05
-
-* Add watir as a dependency to make it possible to use with watir-classic too.
-* Add specs to keep the quality high.
-* Documentation fixes.
+### 2.2.2 - 2020/06/04
+
+* Fix a situation where checking if server is running without using specified port. PR #27 by Stefan Rotariu.
+
+### 2.2.1 - 2019/05/12
+
+* Fix EOFError on some environments. PR #25 by Slava Kardakov.
+
+### 2.2.0 - 2019/05/08
+
+* Add support for specifying custom server for test Rails instance. PR #23 by Alex Rodionov.
+* Add support for cleaning up when test Rails server instance has served all requests. PR #23 by Alex Rodionov.
+
+### 2.1.0 - 2019/03/19
+
+* Add support for specifying Rails test-server port. PR #22 by Bartek Wilczek.
+
+### 2.0.0 - 2016/09/24
+
+* Add support for Watir 6.0.
+
+### 1.2.1 - 2016/06/15
+
+* Fix Browser#add_checker deprecation warning. PR #18 by Christophe Bliard.
+
+### 1.2.0 - 2016/01/16
+
+* Add support for running Rails on Puma server. PR #15 by Andrey Koleshko.
+
+### 1.1.0 - 2015/07/22
+
+* Remove strict `mime-types` dependency. See #13
+
+### 1.0.4 - 2015/02/28
+
+* Allow to set Watir::Rails.ignore_exceptions to false. PR #8 by Andrey Koleshko.
+
+### 1.0.3 - 2013/11/02
+
+* Make watir-rails working with Rails 2.3.x too.
+
+### 1.0.2 - 2013/11/02
+
+* Make sure that newest Rails is going to be installed on an empty system.
+
+### 1.0.1 - 2013/11/01
+
+* Add license to gemspec.
+
+### 1.0.0 - 2013/10/05
+
+* Add watir as a dependency to make it possible to use with watir-classic too.
+* Add specs to keep the quality high.
+* Documentation fixes.

data/README.md

@@ -3,7 +3,7 @@
 [![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 makes the [Watir](https://github.com/watir/watir) work with Rails.
+This gem makes [Watir](https://github.com/watir/watir) work with Rails.
 
 
 ## Installation

data/Rakefile

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

data/gemfiles/Gemfile.rails-4.x

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "coveralls", require: false
+gem "rails", "~> 4.0"

data/lib/watir/rails.rb

@@ -10,7 +10,7 @@ rescue LoadError
   require "initializer"
 end
 
-require File.expand_path("browser.rb", File.dirname(__FILE__))
+require File.expand_path("rails/browser.rb", File.dirname(__FILE__))
 require File.expand_path("rails/middleware.rb", File.dirname(__FILE__))
 
 module Watir
@@ -18,23 +18,26 @@ module Watir
     class << self
       private :new
       attr_reader :port, :middleware
-      attr_writer :ignore_exceptions
+      attr_writer :ignore_exceptions, :server
 
       # Start the Rails server for tests.
       # Will be called automatically by {Watir::Browser#initialize}.
-      def boot
+      #
+      # @param [Integer] port port for the Rails up to run on. If omitted random port will be picked.
+      def boot(port: nil)
+        @port = port || find_available_port
+
         unless running?
           @middleware = Middleware.new(app)
-          @port = find_available_port
 
           @server_thread = Thread.new do
-            run_default_server @middleware, @port
+            server.call @middleware, @port
           end
 
           Timeout.timeout(boot_timeout) { @server_thread.join(0.1) until running? }
         end
-      rescue TimeoutError
-        raise TimeoutError, "Rails Rack application timed out during boot"
+      rescue Timeout::Error
+        raise Timeout::Error, "Rails Rack application timed out during boot"
       end
 
       # Host for Rails app under test. Default is {.local_host}.
@@ -65,6 +68,13 @@ module Watir
         @middleware.error
       end
 
+      # Returns true if there are pending requests to server.
+      #
+      # @return [Boolean]
+      def pending_requests?
+        @middleware.pending_requests?
+      end
+
       # Set error rescued by the middleware.
       #
       # @param value
@@ -103,7 +113,7 @@ module Watir
         if res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
           return res.body == @app.object_id.to_s
         end
-      rescue Errno::ECONNREFUSED, Errno::EBADF
+      rescue Errno::ECONNREFUSED, Errno::EBADF, EOFError
         return false
       end
 
@@ -137,22 +147,24 @@ module Watir
         server.close if server
       end
 
-      def run_default_server(app, port)
-        begin
-          require 'rack/handler/thin'
-          Thin::Logging.silent = true
-          return Rack::Handler::Thin.run(app, :Port => port)
-        rescue LoadError
-        end
+      def server
+        @server ||= lambda do |app, port|
+          begin
+            require 'rack/handler/thin'
+            Thin::Logging.silent = true
+            return Rack::Handler::Thin.run(app, :Port => port)
+          rescue LoadError
+          end
 
-        begin
-          require 'rack/handler/puma'
-          return Rack::Handler::Puma.run(app, :Port => port, :Silent => true)
-        rescue LoadError
-        end
+          begin
+            require 'rack/handler/puma'
+            return Rack::Handler::Puma.run(app, :Port => port, :Silent => true)
+          rescue LoadError
+          end
 
-        require 'rack/handler/webrick'
-        Rack::Handler::WEBrick.run(app, :Port => port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0))
+          require 'rack/handler/webrick'
+          Rack::Handler::WEBrick.run(app, :Port => port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0))
+        end
       end
 
       def legacy_rails?

data/lib/watir/rails/browser.rb

@@ -0,0 +1,45 @@
+module Watir
+  # Reopened Watir::Browser class for working with Rails
+  class Browser
+    # @private
+    alias_method :_original_initialize, :initialize
+
+    # 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_exception_hook unless Rails.ignore_exceptions?
+    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 Go to the regular url:
+    #   browser.goto "http://google.com"
+    #
+    # @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
+    end
+
+    private
+
+    def add_exception_hook
+      after_hooks.add do
+        if error = Rails.error
+          Rails.error = nil
+          raise error
+        end
+      end
+    end
+  end
+end
+

data/lib/watir/rails/middleware.rb

@@ -1,26 +1,50 @@
-module Watir
-  class Rails
-    # @private
-    class Middleware
-      attr_accessor :error
-
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        if env["PATH_INFO"] == "/__identify__"
-          [200, {}, [@app.object_id.to_s]]
-        else
-          begin
-            @app.call(env)
-          rescue => e
-            @error = e
-            raise e
-          end
-        end
-      end
-    end
-
-  end
-end
+module Watir
+  class Rails
+    # @private
+    class Middleware
+      class PendingRequestsCounter
+        attr_reader :value
+
+        def initialize
+          @value = 0
+          @mutex = Mutex.new
+        end
+
+        def increment
+          @mutex.synchronize { @value += 1 }
+        end
+
+        def decrement
+          @mutex.synchronize { @value -= 1 }
+        end
+      end
+
+      attr_accessor :error
+
+      def initialize(app)
+        @app = app
+        @counter = PendingRequestsCounter.new
+      end
+
+      def pending_requests?
+        @counter.value > 0
+      end
+
+      def call(env)
+        if env["PATH_INFO"] == "/__identify__"
+          [200, {}, [@app.object_id.to_s]]
+        else
+          @counter.increment
+          begin
+            @app.call(env)
+          rescue => e
+            @error = e
+            raise e
+          ensure
+            @counter.decrement
+          end
+        end
+      end
+    end
+  end
+end

data/lib/watir/version.rb

@@ -1,5 +1,5 @@
-module Watir
-  class Rails
-    VERSION = "1.2.1"
-  end
-end
+module Watir
+  class Rails
+    VERSION = "2.2.2"
+  end
+end

data/spec/support/watir.rb

@@ -3,7 +3,9 @@
 module Watir
   class Browser
     def initialize(*args)
-      require File.expand_path("fake_browser_with_goto", File.dirname(__FILE__))
+    end
+
+    def goto(url)
     end
   end
 end

data/spec/watir/{browser_spec.rb → rails/browser_spec.rb}

@@ -6,22 +6,22 @@ describe Watir::Browser do
   context "#initialize" do
     it "starts Rails before opening the browser" do
       expect(Watir::Rails).to receive(:boot)
-      expect_any_instance_of(Watir::Browser).to receive(:original_initialize).and_call_original
+      expect_any_instance_of(Watir::Browser).to receive(:_original_initialize).and_call_original
 
       Watir::Browser.new
     end
 
-    it "does not add Exception checker when exceptions are ignored" do
+    it "does not add Exception hook when exceptions are ignored" do
       allow(Watir::Rails).to receive_messages(ignore_exceptions?: true, boot: nil)
 
-      expect_any_instance_of(Watir::Browser).not_to receive(:add_exception_checker)
+      expect_any_instance_of(Watir::Browser).not_to receive(:add_exception_hook)
       Watir::Browser.new
     end
 
-    it "adds Exception checker when exceptions are not ignored" do
+    it "adds Exception hook when exceptions are not ignored" do
       allow(Watir::Rails).to receive_messages(ignore_exceptions?: false, boot: nil)
 
-      expect_any_instance_of(Watir::Browser).to receive(:add_exception_checker)
+      expect_any_instance_of(Watir::Browser).to receive(:add_exception_hook)
       Watir::Browser.new
     end
   end
@@ -34,32 +34,32 @@ describe Watir::Browser do
     let(:browser) { Watir::Browser.new }
 
     it "uses Rails for paths specified as an url" do
-      expect(browser).to receive(:_new_goto).with("http://foo.com:42/foo/bar")
+      expect(browser).to receive(:_original_goto).with("http://foo.com:42/foo/bar")
       browser.goto("/foo/bar")
     end
 
     it "does not alter url with http:// scheme" do
-      expect(browser).to receive(:_new_goto).with("http://baz.org/lol")
+      expect(browser).to receive(:_original_goto).with("http://baz.org/lol")
       browser.goto("http://baz.org/lol")
     end
 
     it "does not alter url with https:// scheme" do
-      expect(browser).to receive(:_new_goto).with("https://baz.org/lol")
+      expect(browser).to receive(:_original_goto).with("https://baz.org/lol")
       browser.goto("https://baz.org/lol")
     end
 
     it "does not alter about:urls" do
-      expect(browser).to receive(:_new_goto).with("about:url")
+      expect(browser).to receive(:_original_goto).with("about:url")
       browser.goto("about:url")
     end
 
     it "does not alter data:urls" do
-      expect(browser).to receive(:_new_goto).with("data:url")
+      expect(browser).to receive(:_original_goto).with("data:url")
       browser.goto("data:url")
     end
 
     it "alters the unknown urls" do
-      expect(browser).to receive(:_new_goto).with("http://foo.com:42/xxx:yyy")
+      expect(browser).to receive(:_original_goto).with("http://foo.com:42/xxx:yyy")
       browser.goto("http://foo.com:42/xxx:yyy")
     end
   end

data/spec/watir/rails_spec.rb

@@ -9,9 +9,11 @@ describe Watir::Rails do
 
   context ".boot" do
     it "starts the server unless already running" do
+      server = ->(app, port) {}
       allow(described_class).to receive_messages(app: double("app"), find_available_port: 42)
       expect(described_class).to receive(:running?).twice.and_return(false, true)
-      expect(described_class).to receive(:run_default_server).once
+      expect(described_class).to receive(:server).and_return(server)
+      expect(server).to receive(:call).once
 
       described_class.boot
       wait_until_server_started
@@ -20,16 +22,18 @@ describe Watir::Rails do
     it "does nothing if server is already running" do
       allow(described_class).to receive_messages(app: double("app"), find_available_port: 42)
       expect(described_class).to receive(:running?).once.and_return(true)
-      expect(described_class).not_to receive(:run_default_server)
+      expect(described_class).not_to receive(:server)
 
       described_class.boot
     end
 
     it "raises an error if Rails won't boot with timeout" do
+      server = ->(app, port) {}
       allow(described_class).to receive_messages(app: double("app"),
         find_available_port: 42, boot_timeout: 0.01)
       expect(described_class).to receive(:running?).at_least(:twice).and_return(false)
-      expect(described_class).to receive(:run_default_server)
+      expect(described_class).to receive(:server).and_return(server)
+      expect(server).to receive(:call)
 
       expect {
         described_class.boot
@@ -41,6 +45,19 @@ describe Watir::Rails do
     end
   end
 
+  context ".server" do
+    it "allows to customize server" do
+      allow(described_class).to receive_messages(app: double("app"), find_available_port: 42)
+      allow(described_class).to receive(:running?).twice.and_return(false, true)
+
+      server = ->(app, port) {}
+      described_class.server = server
+      expect(server).to receive(:call)
+
+      described_class.boot
+    end
+  end
+
   context ".host" do
     it "@host if specified" do
       described_class.host = "my_host"

data/watir-rails.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "rack"
   gem.add_dependency "rails"
-  gem.add_dependency "watir", "~> 5.0"
+  gem.add_dependency "watir", ">= 6.0.0.beta4"
 
   gem.add_development_dependency "yard"
   gem.add_development_dependency "redcarpet"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watir-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Jarmo Pertman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-15 00:00:00.000000000 Z
+date: 2020-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -42,16 +42,16 @@ dependencies:
   name: watir
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 6.0.0.beta4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 6.0.0.beta4
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -111,14 +111,14 @@ files:
 - Rakefile
 - gemfiles/Gemfile.rails-2.x
 - gemfiles/Gemfile.rails-3.x
-- lib/watir/browser.rb
+- gemfiles/Gemfile.rails-4.x
 - lib/watir/rails.rb
+- lib/watir/rails/browser.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/browser_spec.rb
 - spec/watir/rails/middleware_spec.rb
 - spec/watir/rails_spec.rb
 - watir-rails.gemspec
@@ -126,7 +126,7 @@ homepage: http://github.com/watir/watir-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,16 +141,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.4
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 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/browser_spec.rb
 - spec/watir/rails/middleware_spec.rb
 - spec/watir/rails_spec.rb
-has_rdoc: 

data/lib/watir/browser.rb

@@ -1,67 +0,0 @@
-module Watir
-  # Reopened Watir::Browser class for working with Rails
-  class Browser
-    # @private
-    alias_method :original_initialize, :initialize
-
-    # Will start Rails instance for Watir automatically and then invoke the
-    # original Watir::Browser#initialize method.
-    def initialize(*args)
-      initialize_rails_with_watir *args
-    end
-
-    # Opens the url with the browser instance.
-    # Will add {Rails.host} and {Rails.port} to the url when path is specified.
-    #
-    # @example Go to the regular url:
-    #   browser.goto "http://google.com"
-    #
-    # @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
-      _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
-      after_hooks.add do
-        if error = Rails.error
-          Rails.error = nil
-          raise error
-        end
-      end
-    end
-  end
-end
-

data/spec/support/fake_browser_with_goto.rb

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