spreewald 2.99.3 → 4.1.0

data/features/support/step_definitions/custom_steps.rb

@@ -0,0 +1,10 @@
+Then /^the output should( not)? contain \/(.*)\/$/ do |negated, regexp|
+  output = all_commands.map { |c| c.output }.join("\n")
+  regexp = Regexp.new(regexp)
+
+  if negated
+    expect(output).not_to match(regexp)
+  else
+    expect(output).to match(regexp)
+  end
+end

data/lib/spreewald.rb

@@ -3,3 +3,4 @@
 require 'cucumber_priority'
 require "spreewald_support/version"
 require "spreewald_support/github"
+require "spreewald_support/unsupported_email_header"

data/lib/spreewald/development_steps.rb

@@ -5,15 +5,8 @@ Then /^it should work(.+?)?$/ do |message|
   pending(message)
 end.overridable
 
-# nodoc
-Then 'debugger' do
-  warn 'The step "Then debugger" will be removed in future versions of Spreewald. Please use "Then console" instead.'
-  step 'console' # Alias
-end.overridable
-
 # Pauses test execution and opens an IRB shell with current context. Does not halt the application-
-# under-test. (Replaces the "Then debugger" step that has never been adequate
-# for its job)
+# under-test.
 Then 'console' do
   require 'irb'
   ARGV.clear # IRB takes ARGV as its own arguments

data/lib/spreewald/email_steps.rb

@@ -30,10 +30,9 @@ end.overridable
 #
 #       """
 #
-# Because of backwards-compatibility, the body currently only has to be a prefix
-# of the real body. However, this is deprecated and will be removed in a future
-# version. Use wildcards instead.
-# You may skip lines in the header, of course.
+# You may skip lines in the header.
+# Please note: In older versions of Spreewald, unmentioned body lines were skipped.
+# Now you have to use the asterisk explicitly to omit lines in the body.
 Then /^(an?|no)( HTML| plain-text|) e?mail should have been sent with:$/ do |mode, type, raw_data|
   patiently do
     results = MailFinder.find(raw_data, type.strip)
@@ -70,26 +69,6 @@ ERROR
   end
 end.overridable
 
-# nodoc (deprecated)
-Then /^(an|no) e?mail should have been sent((?: |and|with|from "[^"]+"|bcc "[^"]+"|cc "[^"]+"|to "[^"]+"|the subject "[^"]+"|the body "[^"]+"|the attachments "[^"]+")+)$/ do |mode, query|
-  warn "The step `an email should have been sent (from ...) (to ...) (cc ...) ...` has been deprecated in favor of `(an?|no)( HTML| plain-text|) e?mail should have been sent with:`"
-  patiently do
-    filename_method = Rails::VERSION::MAJOR < 3 ? 'original_filename' : 'filename'
-    @mail = ActionMailer::Base.deliveries.find do |mail|
-        [ query =~ /to "([^"]+)"/ && !mail.to.include?(MailFinder.resolve_email $1),
-          query =~ /cc "([^"]+)"/ && !mail.cc.include?(MailFinder.resolve_email $1),
-          query =~ /bcc "([^"]+)"/ && !mail.bcc.include?(MailFinder.resolve_email $1),
-          query =~ /from "([^"]+)"/ && !mail.from.include?(MailFinder.resolve_email $1),
-          query =~ /reply_to "([^"]+)"/ && !mail.reply_to.include?(MailFinder.resolve_email $1),
-          query =~ /subject "([^"]+)"/ && !mail.subject.include?($1),
-          query =~ /the attachments "([^"]+)"/ && $1.split(/\s*,\s*/).sort != Array(mail.attachments).collect(&:"#{filename_method}").sort
-        ].none?
-    end
-    expectation = mode == 'no' ? 'not_to' : 'to'
-    expect(@mail).send(expectation, be_present)
-  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|
@@ -141,22 +120,3 @@ Then /^show me the e?mail( header)?s with:$/ do |only_header, raw_data|
 
   print MailFinder.show_mails(results.mails, only_header)
 end.overridable
-
-# nodoc (deprecated)
-Then /^that e?mail should( not)? have the following lines in the body:$/ do |negate, body|
-  warn "The step /^that e?mail should( not)? have the following lines in the body:$/ has been deprecated in favor of the updated step /^(an?|no)( HTML| plain-text|) e?mail should have been sent with:$/."
-  expectation = negate ? 'not_to' : 'to'
-  mail = @mail || ActionMailer::Base.deliveries.last
-  email_text_body = MailFinder.email_text_body(mail)
-
-  body.to_s.strip.split(/\n/).each do |line|
-    expect(email_text_body).send(expectation, include(line.strip))
-  end
-end.overridable
-
-# nodoc (deprecated)
-Then /^that e?mail should have the following (?:|content in the )body:$/ do |body|
-  warn "The step /^that e?mail should have the following( content in the)? body:$/ has been deprecated in favor of the updated step /^(an?|no)( HTML| plain-text|) e?mail should have been sent with:$/."
-  mail = @mail || ActionMailer::Base.deliveries.last
-  expect(MailFinder.email_text_body(mail)).to include(body.strip)
-end.overridable

data/lib/spreewald/frame_steps.rb

@@ -0,0 +1,77 @@
+# You can append `inside the [name or number] iframe` to any other step.
+# Then the step will operate inside the given iframe.
+# Examples:
+#
+#     Then I should see "Kiwi" inside the 1st iframe
+#     Then I should see "Cherry" inside the fruits iframe
+#     When I press "Save" inside the 2nd iframe
+#
+When /^(.*?) inside the (.*?) iframe$/ do |nested_step, frame_identifier|
+  patiently do
+    frame = find_frame(frame_identifier)
+    page.within_frame(frame) do
+      step nested_step
+    end
+  end
+end.overridable
+
+# nodoc
+When /^(.*?) inside the (.*?) iframe:$/ do |nested_step, frame_identifier, table_or_string|
+  patiently do
+    frame = find_frame(frame_identifier)
+    page.within_frame(frame) do
+      step("#{nested_step}:", table_or_string)
+    end
+  end
+end.overridable
+
+if Gem::Version.new(Capybara::VERSION) >= Gem::Version.new('3')
+
+  # This step will switch to the iframe identified by its name or number.
+  # All further steps will operate inside the iframe.
+  # To switch to operating on the main page again, use the step
+  # "I switch back to the whole page".
+  # Examples:
+  #
+  #     When I switch to the 1st iframe
+  #     When I switch to the fruits iframe
+  #
+  # Please note: This step is only available for Capybara >= 3.
+  When /^I switch to the (.*?) iframe$/ do |frame_identifier|
+    frame = find_frame(frame_identifier)
+    page.driver.switch_to_frame(frame)
+  end.overridable
+
+  # This step can be used to switch back to the whole page if you switched
+  # to operating inside an iframe before (step `I switch to the ... iframe`).
+  #
+  # Please note: This step is only available for Capybara >= 3.
+  When /^I switch back to the whole page$/ do
+    handle = page.driver.current_window_handle
+    page.driver.switch_to_window(handle)
+  end
+end
+
+module IframeStepsHelper
+  def find_frame(frame_identifier)
+    frame_id = convert_frame_identifier(frame_identifier)
+    case frame_id
+    when Integer
+      frames = page.find_all('iframe')
+      frames[frame_id]
+    when String
+      page.find("iframe[name='#{frame_id}']")
+    end
+  end
+
+  def convert_frame_identifier(frame_identifier)
+    number_regex = /\A(?<number>\d+)(st|nd|rd|th|\.)\z/
+    matches = frame_identifier.match(number_regex)
+    if matches && matches[:number]
+      matches[:number].to_i - 1 # selenium starts counting a 0
+    else
+      frame_identifier
+    end
+  end
+end
+World(IframeStepsHelper)

data/lib/spreewald/web_steps.rb

@@ -201,10 +201,10 @@ Then /^I should( not)? see a field "([^"]*)"$/ do |negate, name|
   expectation = negate ? :not_to : :to
   patiently do
     begin
-      # In old Capybaras find_field returns nil, so we assign it to `field`
-      field = find_field(name)
+      # In old Capybaras find returns nil, so we assign it to `field`
+      field = find_with_disabled(:field, name)
     rescue Capybara::ElementNotFound
-      # In Capybara 0.4+ #find_field raises an error instead of returning nil
+      # In Capybara 0.4+ #find raises an error instead of returning nil
       # We must explicitely reset the field variable from a previous patiently iteration
       field = nil
     end
@@ -327,7 +327,7 @@ end.overridable
 # Checks that an input field contains some value (allowing * as wildcard character)
 Then /^the "([^"]*)" field should (not )?contain "([^"]*)"$/ do |label, negate, expected_string|
   patiently do
-    field = find_field(label)
+    field = find_with_disabled(:field, label)
     field_value = case field.tag_name
     when 'select'
       options = field.all('option')
@@ -347,7 +347,7 @@ end.overridable
 # Checks that a multiline textarea contains some value (allowing * as wildcard character)
 Then(/^the "(.*?)" field should (not )?contain:$/) do |label, negate, expected_string|
   patiently do
-    field = find_field(label)
+    field = find_with_disabled(:field, label)
     expect(field.value.chomp).send(negate ? :not_to : :to, contain_with_wildcards(expected_string))
   end
 end.overridable
@@ -369,7 +369,7 @@ end.overridable
 # Checks that an input field was wrapped with a validation error
 Then /^the "([^"]*)" field should have the error "([^"]*)"$/ do |field, error_message|
   patiently do
-    element = find_field(field)
+    element = find_with_disabled(:field, field)
     classes = element.find(:xpath, '..')[:class].split(' ')
 
     form_for_input = element.find(:xpath, 'ancestor::form[1]')
@@ -390,35 +390,17 @@ end.overridable
 Then /^the "([^\"]*)" field should( not)? have an error$/ do |label, negate|
   patiently do
     expectation = negate ? :not_to : :to
-    field = find_field(label)
+    field = find_with_disabled(:field, label)
     expect(field[:id]).to be_present # prevent bad CSS selector if field lacks id
     expect(page).send(expectation, have_css(".field_with_errors ##{field[:id]}"))
   end
 end.overridable
 
-Then /^the "([^"]*)" field should have no error$/ do |field|
-  warn 'The step /^the "([^"]*)" field should have no error$/ is deprecated and scheduled for removal. Use the step /^the "([^\"]*)" field should( not)? have an error$/ instead.'
-  patiently do
-    element = find_field(field)
-    classes = element.find(:xpath, '..')[:class].split(' ')
-    expect(classes).not_to include('field_with_errors')
-    expect(classes).not_to include('error')
-  end
-end.overridable
-
-Then /^the "([^"]*)" checkbox should( not)? be checked( and disabled)?$/ do |label, negate, disabled|
+Then /^the "([^"]*)" checkbox should( not)? be checked?$/ do |label, negate|
   expectation = negate ? :not_to : :to
 
-  if disabled
-    warn 'The step /^the "([^"]*)" checkbox should( not)? be checked( and disabled)?$/ will lose the `and disabled` modifier in Spreewald 3. In that version, the step will find a checkbox regardless of whether it is disabled.'
-  end
-
   patiently do
-    field = if Spreewald::Comparison.compare_versions(Capybara::VERSION, :<, "2.1")
-      find_field(label)
-    else
-      find_field(label, :disabled => !!disabled)
-    end
+    field = find_with_disabled(:field, label)
     expect(field).send expectation, be_checked
   end
 end.overridable
@@ -489,7 +471,7 @@ end.overridable
 
 Then /^nothing should be selected for "([^"]*)"$/ do |field|
   patiently do
-    select = find_field(field)
+    select = find_with_disabled(:field, field)
     begin
       selected_option = select.find(:xpath, ".//option[@selected = 'selected']") || select.all(:css, 'option').first
       value = selected_option ? selected_option.value : nil
@@ -509,11 +491,11 @@ Then /^"([^"]*)" should( not)? be an option for "([^"]*)"$/ do |value, negate, f
   patiently do
     if negate
       begin
-        expect(find_field(field)).to have_no_css(*finder_arguments)
+        expect(find_with_disabled(:field, field)).to have_no_css(*finder_arguments)
       rescue Capybara::ElementNotFound
       end
     else
-      expect(find_field(field)).to have_css(*finder_arguments)
+      expect(find_with_disabled(:field, field)).to have_css(*finder_arguments)
     end
   end
 end.overridable
@@ -542,18 +524,12 @@ end.overridable
 # Within a selenium test, the browser is asked whether the element is really visible
 # In a non-selenium test, we only check for `.hidden`, `.invisible` or `style: display:none`
 #
-# The step 'Then (the tag )?"..." should **not** be visible' is ambiguous. Please use 'Then (the tag )?"..." should be hidden' or 'Then I should not see "..."' instead. Note that the **not** option will be removed in future versions of Spreewald.
-#
 # More details [here](https://makandracards.com/makandra/1049-capybara-check-that-a-page-element-is-hidden-via-css)
-Then /^(the tag )?"([^\"]+)" should( not)? be visible$/ do |tag, selector_or_text, hidden|
-  if hidden
-    warn "The step 'Then ... should not be visible' is prone to misunderstandings. Please use 'Then ... should be hidden' or 'Then I should not see ...' instead."
-  end
-
+Then /^(the tag )?"([^\"]+)" should be visible$/ do |tag, selector_or_text|
   options = {}
   tag ? options.store(:selector, selector_or_text) : options.store(:text, selector_or_text)
 
-  hidden ? assert_hidden(options) : assert_visible(options)
+   assert_visible(options)
 end.overridable
 
 # Checks that an element is actually present and hidden, also considering styles.
@@ -621,12 +597,6 @@ Then /^"([^"]*)" should link to "([^"]*)"$/ do |link_label, target|
   end
 end.overridable
 
-# Checks that the result has content type `text/plain`
-Then /^I should get a text response$/ do
-  warn 'The step /^I should get a text response$/ is deprecated and scheduled for removal. Use `I should get a response with content-type "text/plain"` instead.'
-  step 'I should get a response with content-type "text/plain"'
-end.overridable
-
 # Click a link within an element matching the given selector. Will try to be clever
 # and disregard elements that don't contain a matching link.
 #
@@ -695,11 +665,11 @@ end.overridable
 # Tests that a field with the given label is visible.
 Then /^the "([^\"]*)" field should( not)? be visible$/ do |label, hidden|
   if Spreewald::Comparison.compare_versions(Capybara::VERSION, :<, "2.1")
-    field = find_field(label)
+    field = find_with_disabled(:field, label)
   else
     # Capybara 2.1+ won't usually interact with hidden elements,
     # but we can override this behavior by passing { visible: false }
-    field = find_field(label, :visible => false)
+    field = find_with_disabled(:field, label, :visible => false)
   end
 
   selector = "##{field['id']}"
@@ -711,20 +681,6 @@ Then /^the "([^\"]*)" field should( not)? be visible$/ do |label, hidden|
   end
 end.overridable
 
-# Waits for the page to finish loading and AJAX requests to finish.
-#
-# More details [here](https://makandracards.com/makandra/12139-waiting-for-page-loads-and-ajax-requests-to-finish-with-capybara).
-When /^I wait for the page to load$/ do
-  warn 'The step /^I wait for the page to load$/ is deprecated and scheduled for removal. Please see https://github.com/makandra/spreewald/issues/136'
-  if javascript_capable?
-    patiently do
-      # when no jQuery is loaded, we assume there are no pending AJAX requests
-      page.execute_script("return typeof jQuery === 'undefined' || $.active == 0;").should == true
-    end
-  end
-  page.has_content? ''
-end.overridable
-
 # Performs HTTP basic authentication with the given credentials and visits the given path.
 #
 # More details [here](https://makandracards.com/makandra/971-perform-http-basic-authentication-in-cucumber).
@@ -761,7 +717,7 @@ end.overridable
 # Tests whether a select field is sorted. Uses Array#natural_sort, if defined;
 # Array#sort else.
 Then /^the "(.*?)" select should( not)? be sorted$/ do |label, negate|
-  select = find_field(label)
+  select = find_with_disabled(:field, label)
   options = select.all('option').reject { |o| o.value.blank? }
   option_texts = options.collect(&:text)
 

data/lib/spreewald_support/mail_finder.rb

@@ -1,20 +1,29 @@
 # coding: UTF-8
+require "spreewald_support/mail_to_plaintext_converter"
+require "forwardable"
 
 class MailFinder
+
   class << self
 
     attr_accessor :user_identity
 
     def find(raw_data, type = '')
-      header, body = raw_data.split(/\n\n/, 2) # 2: maximum number of fields
+      header, body = raw_data.split(/\n\n/, 2).map(&:strip_heredoc) # 2: maximum number of fields
       conditions = {}
       header.split("\n").each do |row|
         if row.match(/^[A-Za-z\-]+: /i)
           key, value = row.split(": ", 2)
+          raise Spreewald::UnsupportedEmailHeader.new(key, value) unless Spreewald::SUPPORTED_EMAIL_HEADERS.include? key.strip
           conditions[key.strip.underscore.to_sym] = value.strip
         end
       end
 
+      # Interpret all lines as body if there are no header-link lines
+      if conditions.blank?
+        body = [header, body].join("\n\n")
+      end
+
       filename_method = Rails::VERSION::MAJOR < 3 ? 'original_filename' : 'filename'
       matching_header = ActionMailer::Base.deliveries.select do |mail|
         [ conditions[:to].nil? || mail.to.include?(resolve_email conditions[:to]),
@@ -58,15 +67,7 @@ class MailFinder
     end
 
     def email_text_body(mail, type = '')
-      body = if mail.html_part && type != 'plain-text'
-        dom = Nokogiri::HTML(mail.html_part.body.to_s)
-        dom.at_css('body').text.gsub(/[\r\n]+/, "\n")
-      elsif mail.text_part && type != 'HTML'
-        mail.text_part.body.to_s
-      else
-        mail.body.to_s
-      end
-      body.gsub("\r\n", "\n") # The mail gem (>= 2.7.1) switched from \n to \r\n line breaks (LF to CRLF) in plain text mails.
+      Spreewald::MailToPlaintextConverter.new(mail, type).run
     end
 
     def show_mails(mails, only_header = false)
@@ -82,15 +83,13 @@ class MailFinder
     end
 
     def expected_body_regex(expected_body)
-      # To stay backwards-compatible, this will only check whether an email
-      # starts with the expected body.
       expected = '\A\n' + Regexp.quote(expected_body.strip) + '\n\Z'
       expected.gsub! '\n\*\n', '\n[\s\S]*\n'
       expected.gsub! '\*\n', '.*\n'
       expected.gsub! '\n\*', '\n.*'
 
       expected.gsub! '\A\n', '\A'
-      expected.gsub! '\n\Z', '' # Change '' to '\Z' to force that the whole body matches
+      expected.gsub! '\n\Z', '\Z'
 
       Regexp.new(expected)
     end

data/lib/spreewald_support/mail_to_plaintext_converter.rb

@@ -0,0 +1,42 @@
+require 'nokogiri'
+
+module Spreewald
+  class MailToPlaintextConverter
+    def initialize(mail, type = '')
+      @mail = mail
+      @type = type
+    end
+  
+    def run
+      body = ''
+      if mail.multipart?
+        body = if mail.html_part && type != 'plain-text'
+          text_from_html(mail.html_part.body.to_s)
+        elsif mail.text_part && type != 'HTML'
+          mail.text_part.body.to_s
+        else
+          mail.body.to_s
+        end
+      else
+        if body_text_html?
+          body = text_from_html(mail.body.to_s)
+        else
+          body = mail.body.to_s
+        end
+      end
+      body.gsub("\r\n", "\n") # The mail gem (>= 2.7.1) switched from \n to \r\n line breaks (LF to CRLF) in plain text mails.
+    end
+  
+    private
+  
+    attr_reader :mail, :type
+  
+    def body_text_html?
+      mail.body.to_s.include? "<html>"
+    end
+  
+    def text_from_html(html)
+      Nokogiri::HTML(html).at_css('body').text.gsub(/[\r\n]+/, "\n")
+    end
+  end
+end