spreewald 2.4.2 → 2.8.0

data/lib/spreewald/development_steps.rb

@@ -57,7 +57,7 @@ AfterStep('@slow-motion') do
   sleep 2
 end
 
-# Waits for keypress after each step
+# Waits for a keypress after each step
 AfterStep('@single-step') do
   print "Single Stepping. Hit enter to continue"
   STDIN.getc

data/lib/spreewald/email_steps.rb

@@ -65,6 +65,8 @@ Then /^(an|no) e?mail should have been sent((?: |and|with|from "[^"]+"|bcc "[^"]
   end
 end.overridable
 
+# Please note that this step will only follow HTTP and HTTPS links.
+# Other links (such as mailto: or ftp:// links) are ignored.
 When /^I follow the (first|second|third)? ?link in the e?mail$/ do |index_in_words|
   mail = @mail || ActionMailer::Base.deliveries.last
   index = { nil => 0, 'first' => 0, 'second' => 1, 'third' => 2 }[index_in_words]
@@ -72,7 +74,7 @@ When /^I follow the (first|second|third)? ?link in the e?mail$/ do |index_in_wor
 
   paths = if mail.html_part
     dom = Nokogiri::HTML(mail.html_part.body.to_s)
-    (dom / 'a[href]').map { |a| a['href'].match(url_pattern)[1] }
+    (dom / 'a[href]').map { |a| a['href'].match(url_pattern) }.compact.map { |match| match[1] }
   else
     mail_body = MailFinder.email_text_body(mail).to_s
     mail_body.scan(url_pattern).flatten(1)

data/lib/spreewald/session_steps.rb

@@ -0,0 +1,18 @@
+# You can append `in the browser session "name"` to any other step to execute
+# the step in a different browser session.
+#
+# You may need to update other steps to allow multiple sessions (e.g. your
+# authentication steps have to support multiple logged in users).
+# More details [here](https://makandracards.com/makandra/474480-how-to-make-a-cucumber-test-work-with-multiple-browser-sessions).
+When /^(.*) in the browser session "([^"]+)"$/ do |nested_step, session_name|
+  Capybara.using_session(session_name) do
+    step(nested_step)
+  end
+end.overridable(priority: 5)
+
+# nodoc
+When /^(.*) in the browser session "([^"]+)":$/ do |nested_step, session_name, table_or_string|
+  Capybara.using_session(session_name) do
+    step("#{nested_step}:", table_or_string)
+  end
+end.overridable(priority: 5)

data/lib/spreewald/time_steps.rb

@@ -0,0 +1,102 @@
+# coding: UTF-8
+
+
+# Steps to travel through time
+#
+# This uses [Timecop](https://github.com/jtrupiano/timecop) or Active Support 4.1+ to stub Time.now / Time.current.
+# The user is responsible for including one of the two gems.
+#
+# Please note that the two approaches branch. While ActiveSupport will freeze the time, Timecop will keep it running.
+# FILE_COMMENT_END
+
+major_minor_rails_version = defined?(ActiveSupport) ? [ActiveSupport::VERSION::MAJOR, ActiveSupport::VERSION::MINOR] : [0, 0]
+is_at_least_rails_4_1 = (major_minor_rails_version <=> [4, 1]) != -1
+
+if defined?(Timecop) || is_at_least_rails_4_1
+
+  module TimeHelpers
+
+    # When you have to make your rails app time zone aware you have to go 100%
+    # otherwise you are better off ignoring time zones at all.
+    # https://makandracards.com/makandra/8723-guide-to-localizing-a-rails-application
+
+    def use_timezones?
+      active_record_loaded = defined?(ActiveRecord::Base)
+      (!active_record_loaded || ActiveRecord::Base.default_timezone != :local) && Time.zone
+    end
+
+    def parse_time(str)
+      if use_timezones?
+        Time.zone.parse(str)
+      else
+        Time.parse(str)
+      end
+    end
+
+    def current_time
+      if use_timezones?
+        Time.current
+      else
+        Time.now
+      end
+    end
+
+    if defined?(Timecop)
+      # Emulate ActiveSupport time helper methods with Timecop - don't rename these methods
+      def travel(duration)
+        Timecop.travel(current_time + duration)
+      end
+
+      def travel_to(date_or_time)
+        Timecop.travel(date_or_time)
+      end
+
+      def travel_back
+        Timecop.return
+      end
+    else
+      require 'active_support/testing/time_helpers'
+      include ActiveSupport::Testing::TimeHelpers
+    end
+
+  end
+
+  World(TimeHelpers)
+
+  # Example:
+  #
+  #     Given the date is 2012-02-10
+  #     Given the time is 2012-02-10 13:40
+  When /^the (?:date|time) is "?(\d{4}-\d{2}-\d{2}(?: \d{1,2}:\d{2})?)"?$/ do |time|
+    travel_to parse_time(time)
+  end.overridable
+
+  # Example:
+  #
+  #     Given the time is 13:40
+  When /^the time is "?(\d{1,2}:\d{2})"?$/ do |time_without_date|
+    travel_to parse_time(time_without_date) # date will be today
+  end.overridable
+
+  # Example:
+  #
+  #     When it is 10 minutes later
+  #     When it is a few hours earlier
+  When /^it is (\d+|an?|some|a few) (seconds?|minutes?|hours?|days?|weeks?|months?|years?) (later|earlier)$/ do |amount, unit, direction|
+    amount = case amount
+    when 'a', 'an'
+      1
+    when 'some', 'a few'
+      10
+    else
+      amount.to_i
+    end
+    amount = -amount if direction == 'earlier'
+    travel amount.send(unit)
+  end.overridable
+
+  After do
+    travel_back
+  end
+
+end

data/lib/spreewald/timecop_steps.rb

@@ -1,79 +1,9 @@
-# coding: UTF-8
-
-
-# Steps to travel through time using [Timecop](https://github.com/jtrupiano/timecop).
-#
-# See [this article](https://makandracards.com/makandra/1222-useful-cucumber-steps-to-travel-through-time-with-timecop) for details.
+# nodoc
 # FILE_COMMENT_END
 
+warn <<-WARNING
+Warning: The file spreewald/timecop_steps.rb is deprecated. It was moved to
+spreewald/time_steps.rb. Please require the new file instead.
+WARNING
 
-if defined?(Timecop)
-
-  module TimecopHarness
-
-    # When you have to make your rails app time zone aware you have to go 100%
-    # otherwise you are better off ignoring time zones at all.
-    # https://makandracards.com/makandra/8723-guide-to-localizing-a-rails-application
-
-    def use_timezones?
-      active_record_loaded = defined?(ActiveRecord::Base)
-      (!active_record_loaded || ActiveRecord::Base.default_timezone != :local) && Time.zone
-    end
-
-    def parse_time(str)
-      if use_timezones?
-        Time.zone.parse(str)
-      else
-        Time.parse(str)
-      end
-    end
-
-    def current_time
-      if use_timezones?
-        Time.current
-      else
-        Time.now
-      end
-    end
-
-  end
-
-  World(TimecopHarness)
-
-  # Example:
-  #
-  #     Given the date is 2012-02-10
-  #     Given the time is 2012-02-10 13:40
-  When /^the (?:date|time) is "?(\d{4}-\d{2}-\d{2}(?: \d{1,2}:\d{2})?)"?$/ do |time|
-    Timecop.travel(parse_time(time))
-  end.overridable
-
-  # Example:
-  #
-  #     Given the time is 13:40
-  When /^the time is "?(\d{1,2}:\d{2})"?$/ do |time_without_date|
-    Timecop.travel(parse_time(time_without_date)) # date will be today
-  end.overridable
-
-  # Example:
-  #
-  #     When it is 10 minutes later
-  #     When it is a few hours earlier
-  When /^it is (\d+|a|some|a few) (seconds?|minutes?|hours?|days?|weeks?|months?|years?) (later|earlier)$/ do |amount, unit, direction|
-    amount = case amount
-      when 'a'
-        1
-      when 'some', 'a few'
-        10
-      else
-        amount.to_i
-    end
-    amount = -amount if direction == 'earlier'
-    Timecop.travel(current_time + amount.send(unit))
-  end.overridable
-
-  After do
-    Timecop.return
-  end
-
-end
+require 'spreewald/time_steps'

data/lib/spreewald/web_steps.rb

@@ -35,7 +35,7 @@ require 'uri'
 require 'cgi'
 
 
-# You can append `within [selector]` to any other web step.
+# You can append `within [selector]` to any other web step, even multiple times.
 # Be aware that within will only look at the first element that matches.
 # If this is a problem for you following links, you might want to have a look
 # at the 'When I follow "..." inside any "..."'-step.
@@ -463,7 +463,18 @@ end.overridable
 #
 # Attention: Doesn't work with Selenium, see https://github.com/jnicklas/capybara#gotchas
 Then /^I should get a download with filename "([^\"]*)"$/ do |filename|
-  expect(page.response_headers['Content-Disposition']).to match /filename="#{Regexp.escape(filename)}"(;|$)/
+  content_disposition = page.response_headers['Content-Disposition']
+  expect(content_disposition).to be_present
+
+  fields = content_disposition.split(/;\s*/)
+
+  # Rails 6+ encodes filenames as defined in https://tools.ietf.org/html/rfc5987.
+  # If available, we prefer the UTF-8 filename.
+  download_filename = [/^filename\*=UTF-8''(.+)/, /^filename="(.+?)"/].each do |regexp|
+    matched_filename = fields.map { |field| field.scan(regexp).flatten.first }.compact.first
+    break CGI.unescape(matched_filename) if matched_filename
+  end
+  expect(download_filename).to eq(filename)
 end.overridable
 
 # Checks that a certain option is selected for a text field
@@ -595,7 +606,7 @@ end.overridable(priority: -5) # priority lower than within
 #
 #     Then "Sponsor" should link to "http://makandra.com/"
 #
-# Don't forget the trailing slash. Otherwise you'll get the error 
+# Don't forget the trailing slash. Otherwise you'll get the error
 #   expected: /http:\/\/makandra.com(\?[^\/]*)?$/
 #        got: "http://makandra.com/" (using =~)
 Then /^"([^"]*)" should link to "([^"]*)"$/ do |link_label, target|
@@ -641,49 +652,38 @@ end.overridable
 
 When /^I confirm the browser dialog$/ do
   patiently do
-    page.driver.browser.switch_to.alert.accept
+    browser.switch_to.alert.accept
   end
 end.overridable
 
 When /^I cancel the browser dialog$/ do
   patiently do
-    page.driver.browser.switch_to.alert.dismiss
+    browser.switch_to.alert.dismiss
   end
 end.overridable
 
 When /^I enter "([^"]*)" into the browser dialog$/ do |text|
   patiently do
-    alert = page.driver.browser.switch_to.alert
+    alert = browser.switch_to.alert
     alert.send_keys(text)
     alert.accept
   end
 end.overridable
 
-When /^I switch to the new tab$/ do
-  if javascript_capable?
-    page.driver.browser.switch_to.window(page.driver.browser.window_handles.last)
+# Tests that an input, button, checkbox or radio button with the given label is disabled.
+Then /^the "([^\"]*)" (field|button|checkbox|radio button) should( not)? be disabled$/ do |label, kind, negate|
+  element = if kind == 'button'
+    find_with_disabled(:button, label)
   else
-    raise("This step works only with selenium")
+    find_with_disabled(:field, label)
   end
-end.overridable
 
-# Tests that an input, button or checkbox with the given label is disabled.
-Then /^the "([^\"]*)" (field|button|checkbox) should( not)? be disabled$/ do |label, kind, negate|
   if Spreewald::Comparison.compare_versions(Capybara::VERSION, :<, "2.1")
-    if kind == 'field' || kind == 'checkbox'
-      element = find_field(label)
-    else
-      element = find_button(label)
-    end
     expect(element[:disabled]).send(negate ? :to : :not_to, eq(nil))
   else
-    if kind == 'field' || kind == 'checkbox'
-      element = find_field(label, disabled: !negate)
-    else
-      element = find_button(label, disabled: !negate)
-    end
-    expect(element).to be_present
+    expect(!!element.disabled?).to be !negate
   end
+
 end.overridable
 
 # Tests that a field with the given label is visible.
@@ -728,7 +728,7 @@ When /^I perform basic authentication as "([^\"]*)\/([^\"]*)" and go to (.*)$/ d
     visit("http://#{user}:#{password}@#{server.host}:#{server.port}#{path}")
   else
     authorizers = [
-      (page.driver.browser if page.driver.respond_to?(:browser)),
+      (browser),
       (self),
       (page.driver)
     ].compact

data/lib/spreewald_support/driver_info.rb

@@ -17,6 +17,14 @@ module Spreewald
       Object.const_defined?('Capybara::Webkit') && Capybara.current_session.driver.is_a?(Capybara::Webkit::Driver)
     end
 
+    def browser
+      page.driver.browser if page.driver.respond_to?(:browser)
+    end
+
+    def require_selenium!
+      raise 'This step only works with Selenium' unless selenium_driver?
+    end
+
   end
 end
 

data/lib/spreewald_support/tolerance_for_selenium_sync_issues.rb

@@ -38,22 +38,28 @@ module ToleranceForSeleniumSyncIssues
     WAIT_PERIOD = 0.05
 
     def patiently(seconds, &block)
-      started = Time.now
+      started = monotonic_time
       tries = 0
       begin
         tries += 1
         block.call
       rescue Exception => e
         raise e unless retryable_error?(e)
-        raise e if (Time.now - started > seconds && tries >= 2)
+        raise e if (monotonic_time - started > seconds && tries >= 2)
         sleep(WAIT_PERIOD)
-        raise Capybara::FrozenInTime, "time appears to be frozen, Capybara does not work with libraries which freeze time, consider using time travelling instead" if Time.now == started
+        raise Capybara::FrozenInTime, "time appears to be frozen, Capybara does not work with libraries which freeze time, consider using time travelling instead" if monotonic_time == started
         retry
       end
     end
 
     private
 
+    def monotonic_time
+      # We use the system clock (i.e. seconds since boot) to calculate the time,
+      # because Time.now may be frozen
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    end
+
     def retryable_error?(e)
       RETRY_ERRORS.include?(e.class.name)
     end

data/lib/spreewald_support/version.rb

@@ -1,3 +1,3 @@
 module Spreewald
-  VERSION = '2.4.2'
+  VERSION = '2.8.0'
 end

data/lib/spreewald_support/web_steps_helpers.rb

@@ -1,3 +1,5 @@
+require 'spreewald_support/comparison'
+
 module WebStepsHelpers
 
   def assert_visible(options)
@@ -8,6 +10,21 @@ module WebStepsHelpers
     visibility_test(options.merge(:expectation => :hidden))
   end
 
+  def find_with_disabled(*args, **options, &optional_filter_block)
+    if Spreewald::Comparison.compare_versions(Capybara::VERSION, :<, "2.0")
+      find(:xpath, XPath::HTML.send(args[0], args[1])) # Versions < 2.0 will find both enabled and disabled fields, nothing to do
+    elsif Spreewald::Comparison.compare_versions(Capybara::VERSION, :<, "2.6")
+      begin
+        find(*args, **options, disabled: false, &optional_filter_block)
+      rescue Capybara::ElementNotFound
+        find(*args, **options, disabled: true, &optional_filter_block)
+      end
+    else
+      options_with_disabled = { disabled: :all }.merge(options)
+      find(*args, **options_with_disabled, &optional_filter_block)
+    end
+  end
+
   private
 
   def visibility_test(options)

data/support/step_definition.rb

@@ -37,7 +37,7 @@ class StepDefinition
 
   def pretty_step
     if kind == 'AfterStep'
-      step[/@\w+/]
+      step[/@[\w-]+/]
     elsif step =~ /^'(.*)'$/ # Surrounded by single quotes
       $1
     else

data/support/step_definition_file.rb

@@ -16,6 +16,8 @@ class StepDefinitionFile
   end
 
   def to_markdown
+    return '' if @comment =~ /\bnodoc\b/
+
     spaced_comment = "\n\n" + @comment if @comment
 
     <<-TEXT

data/tests/rails-3_capybara-1/Gemfile

@@ -16,4 +16,5 @@ group :test do
   gem 'selenium-webdriver'
   gem 'rspec-rails'
   gem 'spreewald', :path => '../..'
-end
+  gem 'timecop'
+end