capybara-mechanize 1.10.1 → 1.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fac6d6b89beecdd33ed71713054e9cbd050628d4
-  data.tar.gz: 8ae6b1fc58d4297a814ae3c48af443b93ac6fd71
+SHA256:
+  metadata.gz: d9de2bac559fc9346c178d9ca419cb01abf385dd4f918947b163f683f5a78f55
+  data.tar.gz: bfd5d3bf408fd0f4d3f695e9be255006b71e10fca7ca79668430c5e2fc1a2504
 SHA512:
-  metadata.gz: 0621533dcd84882381f6bb8628cb1b9831b4ddd737b825641b10b1dc04588cd73d04b13105e14147b123d030dd07fc386bd21160497a5569bf17de0ce5f77fbb
-  data.tar.gz: 52c00e76830baf8c5c76cb8c978bd39baea65a58fef18f82d005944c53b0c8cb64726c7984f08832d09f026804c1398996cf49da0cf98b4820a91770fcfe1932
+  metadata.gz: 96b828606020d6384de2faa8fa8ca3e3746f620b5baeda8fb1c2943d2b401e17236f24ad58049716389de9424b97e0d5be65ee662ece82ea71c0156a3352167b
+  data.tar.gz: 5747632a6fc871169ccd81960e62e53cc081c6dfdbff8fbc4cb6401f03ceada59e58a96bb2faa9f7a91035a704ed1cf97e9599bbffab97d31723ac16a978f197

data/README.mdown

@@ -1,9 +1,9 @@
 Capybara-mechanize
 ==================
 
-[![Build Status](https://travis-ci.org/jeroenvandijk/capybara-mechanize.png?branch=master)](https://travis-ci.org/jeroenvandijk/capybara-mechanize)
+[![.github/workflows/test_and_release.yml](https://github.com/phillbaker/capybara-mechanize/actions/workflows/test_and_release.yml/badge.svg)](https://github.com/phillbaker/capybara-mechanize/actions/workflows/test_and_release.yml)
 
-This gems makes it possible to use Capybara for (partially) remote testing. It inherits most functionality from the RackTest driver and only uses [Mechanize](https://github.com/sparklemotion/mechanize) for remote requests. 
+This gem makes it possible to use Capybara for (partially) remote testing. It inherits most functionality from the RackTest driver and only uses [Mechanize](https://github.com/sparklemotion/mechanize) for remote requests. 
 
 It is currently in use to test the integration between a Rails application and Twitter authorization and sharing.
 
@@ -15,6 +15,12 @@ Thanks to [Pinkelstar](http://www.pinkelstar.com) for giving me the time and the
 
     gem install capybara-mechanize
 
+### Compatibility
+
+For support with:
+* Capybara 2.x, use versions of this gem less than or equal 1.11.0
+* Capybara 3.x, use versions of this gem greater than or equal to 1.12.0
+
 ### Usage without Cucumber
 
     require 'capybara/mechanize'
@@ -35,7 +41,19 @@ Capybara.register_driver :mechanize do |app|
   driver
 end
 ```
+### Usage without rack app
 
+You can configure it to use for external servers. Until this issue https://github.com/jeroenvandijk/capybara-mechanize/issues/66  is resolved, you can configure with
+```
+Capybara.register_driver :mechanize do |app|
+  Capybara::Mechanize::Driver.new(proc {})
+end
+```
+and use like this
+```
+session = Capybara::Session.new :mechanize
+session.visit 'https://github.com'
+```
 ### Usage with Cucumber and tags
 
 A @mechanize tag is added to your hooks when you add the following line to your env.rb
@@ -56,6 +74,10 @@ When you want to use this driver to test a remote application. You have to set t
     
 Note that I haven't tested this case for my self yet. The Capybara tests pass for this situation though so it should work! Please provide me with feedback if it doesn't.
 
+### HTTP errors
+
+If you receive the error `Net::HTTP::Persistent::Error: too many connection resets`, try setting a timeout value: `page.driver.browser.agent.idle_timeout = 0.4`.
+
 ## Running tests
 
 Run bundler

data/lib/capybara/mechanize/browser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'capybara/rack_test/driver'
 require 'mechanize'
 require 'capybara/mechanize/node'
@@ -31,11 +33,15 @@ class Capybara::Mechanize::Browser < Capybara::RackTest::Browser
     last_request_remote? ? remote_response : super
   end
 
+  def last_request
+    last_request_remote? ? OpenStruct.new(request_method: @last_method, params: @last_params) : super
+  end
+
   # For each of these http methods, we want to intercept the method call.
   # Then we determine if the call is remote or local.
   # Remote: Handle it with our process_remote_request method.
   # Local: Register the local request and call super to let RackTest get it.
-  [:get, :post, :put, :delete].each do |method|
+  %i[get post put delete].each do |method|
     define_method(method) do |path, params = {}, env = {}, &block|
       path = @last_path if path.nil? || path.empty?
 
@@ -77,7 +83,7 @@ class Capybara::Mechanize::Browser < Capybara::RackTest::Browser
   end
 
   def find(format, selector)
-    if format==:css
+    if format == :css
       dom.css(selector, Capybara::RackTest::CSSHandlers.new)
     else
       dom.xpath(selector)
@@ -106,39 +112,37 @@ class Capybara::Mechanize::Browser < Capybara::RackTest::Browser
   end
 
   def process_remote_request(method, url, attributes, headers)
-    if remote?(url)
-      uri = URI.parse(url)
-      @last_remote_uri = uri
-      url = uri.to_s
-
-      reset_cache!
-      begin
-        if method == :post
-          if attributes.is_a? Mechanize::Form
-            submit_mechanize_form(url, attributes, headers)
-          else
-            @agent.send(method, url, attributes, headers)
-          end
-        elsif method == :get
-          if attributes.is_a? Mechanize::Form
-            submit_mechanize_form(url, attributes, headers)
-          else
-            referer = headers['HTTP_REFERER']
-            @agent.send(method, url, attributes, referer, headers)
-          end
+    return unless remote?(url)
+
+    uri = URI.parse(url)
+    @last_remote_uri = uri
+    url = uri.to_s
+
+    reset_cache!
+    begin
+      if method == :post
+        if attributes.is_a? Mechanize::Form
+          submit_mechanize_form(url, attributes, headers)
         else
           @agent.send(method, url, attributes, headers)
         end
-        @errored_remote_response = nil
-      rescue Mechanize::ResponseCodeError => e
-        @errored_remote_response = e.page
-
-        if Capybara.raise_server_errors
-          raise "Received the following error for a #{method.to_s.upcase} request to #{url}: '#{e.message}'"
+      elsif method == :get
+        if attributes.is_a? Mechanize::Form
+          submit_mechanize_form(url, attributes, headers)
+        else
+          referer = headers['HTTP_REFERER']
+          @agent.send(method, url, attributes, referer, headers)
         end
+      else
+        @agent.send(method, url, attributes, headers)
       end
-      @last_request_remote = true
+      @errored_remote_response = nil
+    rescue Mechanize::ResponseCodeError => e
+      @errored_remote_response = e.page
+
+      raise "Received the following error for a #{method.to_s.upcase} request to #{url}: '#{e.message}'" if Capybara.raise_server_errors
     end
+    @last_request_remote = true
   end
 
   def submit_mechanize_form(url, form, headers)
@@ -150,12 +154,12 @@ class Capybara::Mechanize::Browser < Capybara::RackTest::Browser
     if errored_remote_response
       ResponseProxy.new(errored_remote_response)
     elsif @agent.current_page
-      ResponseProxy.new(@agent.current_page)
+      ResponseProxy.new(@agent.current_page, current_fragment: @current_fragment)
     end
   end
 
   def default_user_agent
-    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_0) AppleWebKit/535.2 (KHTML, like Gecko) Chrome/15.0.853.0 Safari/535.2"
+    'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_0) AppleWebKit/535.2 (KHTML, like Gecko) Chrome/15.0.853.0 Safari/535.2'
   end
 
   class ResponseProxy
@@ -165,18 +169,21 @@ class Capybara::Mechanize::Browser < Capybara::RackTest::Browser
 
     attr_reader :page
 
-    def initialize(page)
+    def initialize(page, current_fragment: nil)
       @page = page
+      @current_fragment = current_fragment
     end
 
     def current_url
-      page.uri.to_s
+      uri = page.uri.dup
+      uri.fragment = @current_fragment if @current_fragment
+      uri.to_s
     end
 
     def headers
       # Hax the content-type contains utf8, so Capybara specs are failing, need to ask mailinglist
       headers = page.response
-      headers["content-type"].gsub!(';charset=utf-8', '') if headers["content-type"]
+      headers['content-type']&.gsub!(';charset=utf-8', '')
       headers
     end
 
@@ -191,8 +198,5 @@ class Capybara::Mechanize::Browser < Capybara::RackTest::Browser
     def redirect?
       status >= 300 && status < 400
     end
-
   end
-
 end
-

data/lib/capybara/mechanize/cucumber.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'capybara/mechanize'
 
 Before('@mechanize') do
   Capybara.current_driver = :mechanize
-end
+end

data/lib/capybara/mechanize/driver.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'capybara/mechanize/browser'
 
 class Capybara::Mechanize::Driver < Capybara::RackTest::Driver
-
   def initialize(app, **options)
-    raise ArgumentError, "mechanize requires a rack application, but none was given" unless app
+    raise ArgumentError, 'mechanize requires a rack application, but none was given' unless app
 
     super
   end
@@ -12,11 +13,16 @@ class Capybara::Mechanize::Driver < Capybara::RackTest::Driver
     browser.remote?(url)
   end
 
-  def configure(&block)
+  def configure
     yield(browser.agent) if block_given?
   end
 
   def browser
     @browser ||= Capybara::Mechanize::Browser.new(self)
   end
+
+  def reset!
+    @browser.agent.shutdown
+    super
+  end
 end

data/lib/capybara/mechanize/form.rb

@@ -1,25 +1,20 @@
-class Capybara::Mechanize::Form < Capybara::RackTest::Form
+# frozen_string_literal: true
 
+class Capybara::Mechanize::Form < Capybara::RackTest::Form
   def params(button)
-    if !use_mechanize?
-      return super
-    end
+    return super unless use_mechanize?
 
     node = {}
     # Create a fake form
     class << node
-      def search(*args); []; end
+      def search(*_args); []; end
     end
 
     node['method'] = button && button['formmethod']
 
     node['method'] ||= (respond_to?(:request_method, true) ? request_method : method).to_s.upcase
 
-    if self.multipart?
-      node['enctype'] = 'multipart/form-data'
-    else
-      node['enctype'] = 'application/x-www-form-urlencoded'
-    end
+    node['enctype'] = multipart? ? 'multipart/form-data' : 'application/x-www-form-urlencoded'
 
     @m_form = Mechanize::Form.new(node, nil, form_referer)
 
@@ -31,20 +26,16 @@ class Capybara::Mechanize::Form < Capybara::RackTest::Form
   private
 
   def merge_param!(params, key, value)
-    if !use_mechanize?
-      return super
-    end
+    return super unless use_mechanize?
 
-    if value.is_a? NilUploadedFile
-      # Adding a nil value here will result in the form element existing with the empty string as its value.
-      # Instead don't add the form element at all.
-      return params
-    end
+    # Adding a nil value here will result in the form element existing with the empty string as its value.
+    # Instead don't add the form element at all.
+    return params if value.is_a? NilUploadedFile
 
     if value.is_a? Rack::Test::UploadedFile
       @m_form.enctype = 'multipart/form-data'
 
-      ul = Mechanize::Form::FileUpload.new({'name' => key.to_s}, value.original_filename)
+      ul = Mechanize::Form::FileUpload.new({ 'name' => key.to_s }, value.original_filename)
       ul.mime_type = value.content_type
       ul.file_data = (value.rewind; value.read)
 
@@ -53,7 +44,7 @@ class Capybara::Mechanize::Form < Capybara::RackTest::Form
       return params
     end
 
-    @m_form.fields << Mechanize::Form::Field.new({'name' => key.to_s}, value)
+    @m_form.fields << Mechanize::Form::Field.new({ 'name' => key.to_s }, value)
 
     params
   end

data/lib/capybara/mechanize/node.rb

@@ -1,18 +1,16 @@
+# frozen_string_literal: true
+
 class Capybara::Mechanize::Node < Capybara::RackTest::Node
-  def click(keys = [], offset = {})
-    raise ArgumentError, "The mechanize driver does not support click options" unless keys.empty? && offset.empty?
+  def click(keys = [], **options)
+    raise ArgumentError, 'The mechanize driver does not support click options' unless keys.empty? && options.empty?
 
     submits = respond_to?(:submits?) ? submits? :
-      ((tag_name == 'input' and %w(submit image).include?(type)) or
-        ((tag_name == 'button') and type.nil? or type == "submit"))
+      ((tag_name == 'input' and %w[submit image].include?(type)) or
+        ((tag_name == 'button') and type.nil? or type == 'submit'))
 
     if tag_name == 'a' or tag_name == 'label' or
-        (tag_name == 'input' and %w(checkbox radio).include?(type))
-      if Capybara::VERSION > '3.0.0'
-        super
-      else
-        super()
-      end
+        (tag_name == 'input' and %w[checkbox radio].include?(type))
+      Capybara::VERSION > '3.0.0' ? super : super()
     elsif submits
       associated_form = form
       Capybara::Mechanize::Form.new(driver, form).submit(self) if associated_form

data/lib/capybara/mechanize/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Capybara
   module Mechanize
-    VERSION = '1.10.1'
+    VERSION = '1.12.1'
   end
 end

data/lib/capybara/mechanize.rb

@@ -1,19 +1,18 @@
+# frozen_string_literal: true
+
 require 'capybara'
 
 module Capybara::Mechanize
   class << self
-
     # Host that should be considered local (includes default_host)
     def local_hosts
       @local_hosts ||= begin
-        default_host = URI.parse(Capybara.default_host || "").host || Capybara.default_host
+        default_host = URI.parse(Capybara.default_host || '').host || Capybara.default_host
         [default_host].compact
       end
     end
-    
-    def local_hosts=(hosts)
-      @local_hosts = hosts
-    end
+
+    attr_writer :local_hosts
   end
 end
 
@@ -21,4 +20,4 @@ require 'capybara/mechanize/driver'
 
 Capybara.register_driver :mechanize do |app|
   Capybara::Mechanize::Driver.new(app)
-end
+end

data/lib/capybara/spec/extended_test_app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'capybara/spec/test_app'
 
 class ExtendedTestApp < TestApp
@@ -9,19 +11,19 @@ class ExtendedTestApp < TestApp
   end
 
   get '/form_with_relative_action_to_host' do
-    %{<form action="/request_info/host" method="post">
+    %(<form action="/request_info/host" method="post">
        <input type="submit" value="submit" />
-      </form>}
+      </form>)
   end
 
   get '/request_info/form_with_no_action' do
-    %{<form method="post">
+    %(<form method="post">
        <input type="submit" value="submit" />
-      </form>}
+      </form>)
   end
 
   get '/relative_link_to_host' do
-    %{<a href="/request_info/host">host</a>}
+    %(<a href="/request_info/host">host</a>)
   end
 
   get '/request_info/user_agent' do
@@ -37,15 +39,15 @@ class ExtendedTestApp < TestApp
   end
 
   get '/subsite/relative_link_to_host' do
-    %{<a href="/subsite/request_info2/host">host</a>}
+    %(<a href="/subsite/request_info2/host">host</a>)
   end
 
   get '/subsite/local_link_to_host' do
-    %{<a href="request_info2/host">host</a>}
+    %(<a href="request_info2/host">host</a>)
   end
 
   get '/subsite/request_info2/*' do
-    "subsite: " + current_request_info
+    'subsite: ' + current_request_info
   end
 
   get '/redirect_with_http_param' do
@@ -53,25 +55,26 @@ class ExtendedTestApp < TestApp
   end
 
   get '/redirect_target' do
-    %{correct redirect}
+    %(correct redirect)
   end
 
   get %r{/form_posts_to/(.*)} do
-    %{
+    %(
       <form action="#{params[:captures].first}" method="post">
         <input type="submit" value="submit" />
       </form>
-    }
+    )
   end
 
   post '/get_referer' do
-    request.referer.nil? ? "No referer" : "Got referer: #{request.referer}"
+    request.referer.nil? ? 'No referer' : "Got referer: #{request.referer}"
   end
 
+  @form_post_count = 0
+
   private
 
-    def current_request_info
-      "Current host is #{request.url}, method #{request.request_method.downcase}"
-    end
+  def current_request_info
+    "Current host is #{request.url}, method #{request.request_method.downcase}"
+  end
 end
-