watir-rails 2.2.3 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0890e02a5cef434105541f81252240ad701f28bb828643f84aaf6b6745eb6cbf'
-  data.tar.gz: b13169b1ea1a2bbfa49b79968eb5568e3137e2319e48a5172e70ab7f0f50572d
+  metadata.gz: 70a4bf116e756c213c309ccd099175324a364a69bdf3e9e7b43889b2430220b3
+  data.tar.gz: 5debf047f4f0fef4474bc81b712dc47f085cc14989e4ae068bab2283f6cfb655
 SHA512:
-  metadata.gz: 9aa0f04dfa0f53060fd48765c040f26158e647254bc9ca049c8ebc2bca4f89ef3bd2c117c7ccc2bc9c05a94b1a4a4c47a04c2f93eda59aeb835d72963d6624d7
-  data.tar.gz: 264a48bb5458b09926950e32709184d909ce4e15123e90bc8ff2ae0f6091c16f4e1aab39b2d421ba1f087f86a7ae9f3f5cf59bfbcb4c352ab9b95b39830b8c16
+  metadata.gz: 28658a949209812b349e100afcf9a7d7850a09080f1bd23b4e784a9250b8a1c21c04f37d9cdccfeb07e60c0a13b095e3a3727ab3c99246ae433509d105ddd5ea
+  data.tar.gz: 7f2f3901a136c79515f2a323e95c302898db125ab478ffcb13b81069eafcddbe4e40d1b5462f2b48508d132415c58267a92dae0210e608e81ed410d1f8b0c14f

data/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: Run watir-rails CI
+
+'on':
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    continue-on-error: ${{ matrix.ruby-version == 'debug' }}
+    strategy:
+      matrix:
+        BUNDLE_GEMFILE: [gemfiles/Gemfile.rails-3.x, gemfiles/Gemfile.rails-4.x, Gemfile]
+        ruby-version: [2.6.3, debug]
+        exclude:
+          # rails-4.2 requires BigDecimal.new (dropped in ruby-2.7)
+          - { BUNDLE_GEMFILE: gemfiles/Gemfile.rails-4.x, ruby-version: debug }
+          # The issue on rails-3.2 + head is json-1.8.6 compat (simplecov
+          # uses it), we could potentially workaround it using, for example, Oj
+          - { BUNDLE_GEMFILE: gemfiles/Gemfile.rails-3.x, ruby-version: debug }
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.BUNDLE_GEMFILE }}
+      LCOV_REPORT_PATH: './coverage/lcov.info'
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          # rails < 5 doesn't support bundler-2
+          bundler: 1
+          bundler-cache: true
+
+      - run: bundle exec rake
+
+      - uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: ${{ env.LCOV_REPORT_PATH }}
+          parallel: true
+          flag-name: ruby-${{ matrix.ruby-version }}_gemfile-${{ matrix.BUNDLE_GEMFILE }}
+
+  coveralls:
+    needs: test
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        parallel-finished: true

data/.travis.yml

@@ -2,7 +2,6 @@ rvm:
   - 2.6.3
   - ruby-head
 gemfile:
-  - gemfiles/Gemfile.rails-2.x
   - gemfiles/Gemfile.rails-3.x
   - gemfiles/Gemfile.rails-4.x
   - Gemfile
@@ -12,4 +11,3 @@ notifications:
 matrix:
   allow_failures:
     - rvm: ruby-head
-

data/CHANGES.md

@@ -1,7 +1,11 @@
+### 2.3.0 - 2023/02/18
+
+* Make `Watir::Rails.boot` use previously selected port in subsequent calls. PR #34 by Bartek Bulat.
+
 ### 2.2.3 - 2021/04/16
 
 * Fix a possible initialization problem with Watir 7.0.0+. See #32.
- 
+
 ### 2.2.2 - 2020/06/04
 
 * Fix a situation where checking if server is running without using specified port. PR #27 by Stefan Rotariu.

data/Gemfile

@@ -2,4 +2,5 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "coveralls", require: false
+gem "simplecov", require: false
+gem "simplecov-lcov", require: false

data/gemfiles/Gemfile.rails-3.x

@@ -2,5 +2,6 @@ source "https://rubygems.org"
 
 gemspec path: ".."
 
-gem "coveralls", require: false
-gem "rails", "~> 3.0"
+gem "simplecov", require: false
+gem "simplecov-lcov", require: false
+gem "rails", "~> 3.0"

data/gemfiles/Gemfile.rails-4.x

@@ -2,5 +2,6 @@ source "https://rubygems.org"
 
 gemspec path: ".."
 
-gem "coveralls", require: false
+gem "simplecov", require: false
+gem "simplecov-lcov", require: false
 gem "rails", "~> 4.0"

data/lib/watir/rails/browser.rb

@@ -1,45 +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
-
+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/version.rb

@@ -1,5 +1,5 @@
 module Watir
   class Rails
-    VERSION = "2.2.3"
+    VERSION = "2.3.0"
   end
 end

data/lib/watir/rails.rb

@@ -3,12 +3,7 @@ require "net/http"
 require "rack"
 require "watir"
 
-begin
-  require "rails"
-rescue LoadError
-  # Load legacy Rails
-  require "initializer"
-end
+require "rails"
 
 require File.expand_path("rails/browser.rb", File.dirname(__FILE__))
 require File.expand_path("rails/middleware.rb", File.dirname(__FILE__))
@@ -23,9 +18,10 @@ module Watir
       # Start the Rails server for tests.
       # Will be called automatically by {Watir::Browser#initialize}.
       #
-      # @param [Integer] port port for the Rails up to run on. If omitted random port will be picked.
+      # @param [Integer] port port for the Rails up to run on. If omitted use
+      #   previously selected port or select random available port.
       def boot(port: nil)
-        @port = port || find_available_port
+        @port = port || @port || find_available_port
 
         unless running?
           @middleware = Middleware.new(app)
@@ -87,13 +83,7 @@ module Watir
       # @return [Boolean] true if exceptions should be ignored, false otherwise.
       def ignore_exceptions?
         if @ignore_exceptions.nil?
-          show_exceptions = if legacy_rails?
-                   ::Rails.configuration.action_dispatch.show_exceptions
-                 else
-                   ::Rails.application.config.action_dispatch.show_exceptions
-                 end
-
-          if show_exceptions
+          if ::Rails.application.config.action_dispatch.show_exceptions
             warn '[WARN] "action_dispatch.show_exceptions" is set to "true", disabling watir-rails exception catcher.'
             @ignore_exceptions = true
           end
@@ -121,15 +111,9 @@ module Watir
       #
       # @return [Object] Rails Rack app.
       def app
-        legacy = legacy_rails?
         @app ||= Rack::Builder.new do
           map "/" do
-            if legacy
-              use ::Rails::Rack::Static
-              run ActionController::Dispatcher.new
-            else
-              run ::Rails.application
-            end
+            run ::Rails.application
           end
         end.to_app
       end
@@ -166,11 +150,6 @@ module Watir
           Rack::Handler::WEBrick.run(app, :Port => port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0))
         end
       end
-
-      def legacy_rails?
-        ::Rails.version.to_f < 3.0
-      end
-
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,17 @@
 require "simplecov"
-require 'coveralls'
 
-SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+if ENV["LCOV_REPORT_PATH"]
+  require "simplecov-lcov"
+
+  SimpleCov::Formatter::LcovFormatter.config do |c|
+    c.report_with_single_file = true
+    root_dir = File.expand_path('..', __dir__)
+    c.single_report_path = File.expand_path(ENV.fetch('LCOV_REPORT_PATH'), root_dir)
+  end
+
+  SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+end
+
 SimpleCov.start
 
 # Make sure that fake watir gems are loaded for specs.
@@ -12,4 +22,11 @@ require "watir/rails"
 RSpec.configure do |c|
   c.color = true
   c.order = :random
+
+  c.after do
+    described_class.instance_variable_set(:@port, nil)
+    described_class.instance_variable_set(:@server_thread, nil)
+    described_class.instance_variable_set(:@server, nil)
+    described_class.instance_variable_set(:@app, nil)
+  end
 end

data/spec/support/watir.rb

@@ -1,11 +1,11 @@
-# Needed to simulate watir gem.
-
-module Watir
-  class Browser
-    def initialize(*args)
-    end
-
-    def goto(url)
-    end
-  end
-end
+# Needed to simulate watir gem.
+
+module Watir
+  class Browser
+    def initialize(*args)
+    end
+
+    def goto(url)
+    end
+  end
+end

data/spec/watir/rails/browser_spec.rb

@@ -24,6 +24,21 @@ describe Watir::Browser do
       expect_any_instance_of(Watir::Browser).to receive(:add_exception_hook)
       Watir::Browser.new
     end
+
+    context 'when boot was already called' do
+      let(:app) { -> (_env) { [200, {}, 'OK'] } }
+      before do
+        Watir::Rails.instance_variable_set(:@app, app)
+        Watir::Rails.boot
+      end
+
+      it 'does not start new server thread' do
+        middleware = Watir::Rails.middleware
+
+        Watir::Browser.new
+        expect(middleware).to eq(Watir::Rails.middleware)
+      end
+    end
   end
 
   context "#goto" do

data/spec/watir/rails_spec.rb

@@ -7,6 +7,8 @@ describe Watir::Rails do
     described_class.instance_eval { @middleware = @port = @server_thread = @host = @app = nil }
   end
 
+  let(:thread) { described_class.instance_variable_get(:@server_thread) }
+
   context ".boot" do
     it "starts the server unless already running" do
       server = ->(app, port) {}
@@ -16,7 +18,8 @@ describe Watir::Rails do
       expect(server).to receive(:call).once
 
       described_class.boot
-      wait_until_server_started
+
+      thread.join(10) || raise("Server thread not finished")
     end
 
     it "does nothing if server is already running" do
@@ -39,22 +42,21 @@ describe Watir::Rails do
         described_class.boot
       }.to raise_error(Timeout::Error)
     end
-
-    def wait_until_server_started
-      Timeout.timeout(10) { sleep 0.1 while described_class.instance_variable_get(:@server_thread).alive? }
-    end
   end
 
   context ".server" do
+    let(:server) { ->(app, port) {} }
+
     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
+
+      thread.join(10) || raise("Server thread not finished")
     end
   end
 
@@ -81,17 +83,7 @@ describe Watir::Rails do
       expect(described_class).not_to be_ignore_exceptions
     end
 
-    it "true if Rails.action_dispatch.show_exceptions is set to true for older Rails" do
-      allow(described_class).to receive_messages(legacy_rails?: true)
-      described_class.ignore_exceptions = nil
-      allow(::Rails).to receive_message_chain(:configuration,
-        :action_dispatch, :show_exceptions).and_return(true)
-
-      expect(described_class).to be_ignore_exceptions
-    end
-
-    it "true if Rails.action_dispatch.show_exceptions is set to true for Rails 3" do
-      allow(described_class).to receive_messages(legacy_rails?: false)
+    it "true if Rails.action_dispatch.show_exceptions is set to true" do
       described_class.ignore_exceptions = nil
       allow(::Rails).to receive_message_chain(:application,
         :config, :action_dispatch, :show_exceptions).and_return(true)
@@ -99,17 +91,7 @@ describe Watir::Rails do
       expect(described_class).to be_ignore_exceptions
     end
 
-    it "false if Rails.action_dispatch.show_exceptions is set to false for older Rails" do
-      allow(described_class).to receive_messages(legacy_rails?: true)
-      described_class.ignore_exceptions = nil
-      allow(::Rails).to receive_message_chain(:configuration,
-        :action_dispatch, :show_exceptions).and_return(false)
-
-      expect(described_class).not_to be_ignore_exceptions
-    end
-
-    it "true if Rails.action_dispatch.show_exceptions is set to false for Rails 3" do
-      allow(described_class).to receive_messages(legacy_rails?: false)
+    it "true if Rails.action_dispatch.show_exceptions is set to false" do
       described_class.ignore_exceptions = nil
       allow(::Rails).to receive_message_chain(:application,
         :config, :action_dispatch, :show_exceptions).and_return(false)

data/watir-rails.gemspec

@@ -1,26 +1,27 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/watir/rails/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ["Jarmo Pertman"]
-  gem.email         = ["jarmo.p@gmail.com"]
-  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($\)
-  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-rails"
-  gem.require_paths = ["lib"]
-  gem.license       = "MIT"
-  gem.version       = Watir::Rails::VERSION
-
-  gem.add_dependency "rack"
-  gem.add_dependency "rails"
-  gem.add_dependency "watir", ">= 6.0.0.beta4"
-
-  gem.add_development_dependency "yard"
-  gem.add_development_dependency "redcarpet"
-  gem.add_development_dependency "rspec", "~> 3.0"
-end
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/watir/rails/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jarmo Pertman"]
+  gem.email         = ["jarmo.p@gmail.com"]
+  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($\)
+  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-rails"
+  gem.require_paths = ["lib"]
+  gem.license       = "MIT"
+  gem.version       = Watir::Rails::VERSION
+  gem.required_ruby_version = ">= 2.4.0"
+
+  gem.add_dependency "rack"
+  gem.add_dependency "rails", ">= 3"
+  gem.add_dependency "watir", ">= 6.0.0.beta4"
+
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "redcarpet"
+  gem.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watir-rails
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.3.0
 platform: ruby
 authors:
 - Jarmo Pertman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-16 00:00:00.000000000 Z
+date: 2023-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: watir
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".travis.yml"
 - ".yardopts"
@@ -109,7 +110,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/Gemfile.rails-2.x
 - gemfiles/Gemfile.rails-3.x
 - gemfiles/Gemfile.rails-4.x
 - lib/watir/rails.rb
@@ -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
@@ -134,16 +134,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.3.25
+signing_key:
 specification_version: 4
 summary: Use Watir (http://github.com/watir/watir) in Rails.
 test_files:

data/gemfiles/Gemfile.rails-2.x

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