spreewald 2.7.0 → 2.99.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02a43b32f16090f64a87cea6adc814baaceb590ef8388863224620f782565e25
-  data.tar.gz: d474b73278a9b3c309c0898e83e1238715012f38cce70e3d8d13d77f9bcd8680
+  metadata.gz: 00603bf8e54cec9e5ceab37fec65ebc1ed2e0a83b753a2eb63b7c1481470cd0b
+  data.tar.gz: 713310e4fd479da1786534a0c6c33769483d87b6199e47ff2fa432f9333245a2
 SHA512:
-  metadata.gz: c8c2ca98760710ddbda7a2aca39ec3208a1a01ab57e842a448dd14d5b3ba969834d6dc08638440e6979140f2fa22ef2ee152276ae2ae19363ef7294cad213cf5
-  data.tar.gz: 9eea3e603ab1e9cb5d3346c948f09ee3b8c4bbfdd811b76eef3a0fc778c3015c48a85f97c31d6be8833f94e22d2d4ed159ab374b1aa345f51ffeba7d0f5fa23e
+  metadata.gz: 1ac94e470ce28516b0aa09dac529631a4208a4eb8dc8ae9959c6d8cbecc779521d74f569f5041a71a2bcd71a1a23a52b4e48a9decc991fed8e5db5e07c5a17a8
+  data.tar.gz: 9d66b30b3fa449c0e69f16b654ccacb4ee10349cf2eb34f328a08cf45cc5390fd73aad455d63232f75ca8df4e9e320763ef8aff39b711108d46dd553f2b2c25c

data/CHANGELOG.md

@@ -3,6 +3,31 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 2.99.1
+
+- Reintroduced support for emails with CRLF line ending
+
+## 2.99.0
+- The following steps were deprecated and will be removed in the upcoming major version:
+  - `/^the "([^"]*)" field should have no error$/` (see [#134](https://github.com/makandra/spreewald/issues/134))
+  - `/^I should get a text response$/` (see [#135](https://github.com/makandra/spreewald/issues/135))
+  - `/^I wait for the page to load$/` (see [#136](https://github.com/makandra/spreewald/issues/136))
+- The step `and disabled` modifier of the step `/^the "([^"]*)" checkbox should( not)? be checked( and disabled)?$/` has been deprecated.
+
+## 2.9.0
+- The step `an email should have been sent with:` does now support wildcards (`*` at the end of a line to ignore the rest of the line, `*` as single character in a line to ignore multiple lines). The step also has better error messages if an email could not be found.
+- The step `show me the emails` got an option to display only the email headers. Additionally, a new step `show me the email( header)?s with:` has been created to only show a subset of all sent emails, with a syntax similar to `an email should have been sent with:`.
+- The email steps `an email should have been sent (from ...) (to ...) (cc ...) ...`, `that email should( not)? have the following lines in the body` and `that email should have the following content in the body:` have been deprecated in favor of `an email should have been sent with:`.
+
+## 2.8.0
+- Add radio buttons to the `the "..." (field|button|checkbox|radio button) should( not)? be disabled` step.
+
+## 2.7.2
+- Fix the step `I follow the ... link in the email` if the email contains non-HTTP(S) links
+
+## 2.7.1
+- Support RFC-compliant encoding of filenames in `Content-Disposition` header (e.g. send_data), as provided by Rails 6.
+
 ## 2.7.0
 - Add a step modifier to control different Capybara sessions: `... in the browser session "..."`. (see issue [#66](https://github.com/makandra/spreewald/issues/66))
 
@@ -55,7 +80,7 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
     * It can now be composed with the 'within' step
     * It can now truly match negative numbers
     * It dropped the hidden dependency on the HTMLEntities gem
-* Fix URLs to the GitHub repository of Spreewald as part of the `_path_to` and `_selector_for` error handling. (see issue [#82](https://github.com/makandra/spreewald/issues/82)) 
+* Fix URLs to the GitHub repository of Spreewald as part of the `_path_to` and `_selector_for` error handling. (see issue [#82](https://github.com/makandra/spreewald/issues/82))
 
 ## 2.2.0
 - Add a new step `I should( not)? see a link labeled "STRING"`.
@@ -88,7 +113,7 @@ The "it should work" step now takes an optional reason.
 The word "within" can now be used in arguments for other steps without causing errors ([Issue #53](https://github.com/makandra/spreewald/issues/80))
 
 ## 1.12.3
-Prevent wall of warnings when `Then console` is used multiple times in on test run ([issue](https://github.com/makandra/spreewald/issues/80)) 
+Prevent wall of warnings when `Then console` is used multiple times in on test run ([issue](https://github.com/makandra/spreewald/issues/80))
 
 ## 1.12.2
 Always check the current driver by its class (see [issue](https://github.com/makandra/spreewald/issues/74))
@@ -102,4 +127,3 @@ Always check the current driver by its class (see [issue](https://github.com/mak
 ## 1.11.6 2018-08-28
 - Added CHANGELOG
 - Replaced `field_labeled` with `find_field` (https://github.com/teamcapybara/capybara/blob/master/History.md#removed)
-

data/README.md

@@ -216,7 +216,7 @@ the step definitions.
 * **When I clear my e?mails**
 
 
-* **Then (an|no) e?mail should have been sent with:**
+* **Then (an?|no)( HTML| plain-text|) e?mail should have been sent with:**
 
   Example:
   
@@ -225,58 +225,48 @@ the step definitions.
         From: max.mustermann@example.com
         Reply-To: mmuster@gmail.com
         To: john.doe@example.com
+        CC: jane.doe@example.com
+        BCC: johnny.doe@example.com
         Subject: The subject may contain "quotes"
-        Attachments: ...
+        Attachments: image.jpg, attachment.pdf
   
-        Message body goes here.
-        """
-  
-  You may skip lines in the header, of course. Note that the mail body is only checked for
-  _inclusion_. That means you can only test a prefix of the body. The subject may also be
-  a prefix.
-
-
-* **Then (an|no) e?mail should have been sent(( |and|with|from "..."|bcc "..."|cc "..."|to "..."|the subject "..."|the body "..."|the attachments "...")+)**
-
-  Example:
+        This is the message body. You can use * as a wildcard to omit the rest
+        of a line *
+        Or you can omit multiple lines if the asterisk is the only
+        character in a single line, like this:
+        *
   
-      Then an email should have been sent from "max.mustermann@example.com" to "john.doe@example.com" with bcc "john.wane@example.com" and with cc "foo@bar.com" and the subject "The subject" and the body "The body" and the attachments "attachment.pdf"
+        """
   
-  You may skip parts, of course.
+  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.
 
 
 * **When I follow the (first|second|third)? link in the e?mail**
 
+  Please note that this step will only follow HTTP and HTTPS links.
+  Other links (such as mailto: or ftp:// links) are ignored.
+
 
 * **Then no e?mail should have been sent**
 
 
-* **Then I should see "..." in the e?mail**
+* **Then I should see "..." in the( HTML| plain-text|) e?mail**
 
   Checks that the last sent email includes some text
 
 
-* **Then show me the e?mails**
+* **Then show me the e?mail( header)?s**
 
-  Print all sent emails to STDOUT.
-
-
-* **Then that e?mail should( not)? have the following lines in the body:**
-
-  Example:
-  
-      And that mail should have the following lines in the body:
-        """
-        All of these lines
-        need to be present
-        """
-  
-  You may skip lines, of course. Note that you may also omit text at the end of each line.
+  Print all sent emails to STDOUT (optionally only the headers).
 
 
-* **Then that e?mail should have the following (|content in the )body:**
+* **Then show me the e?mail( header)?s with:**
 
-  Checks that the text should be included anywhere in the retrieved email body
+  Print a subset of all sent emails to STDOUT
+  This uses the same syntax as `Then an email should have been sent with:`
 
 
 ### file_attachment_steps.rb 
@@ -680,7 +670,7 @@ deprecation notice. Decide for yourself whether you want to use them:
   
       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 =~)
 
@@ -715,9 +705,9 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **When I enter "..." into the browser dialog**
 
 
-* **Then the "..." (field|button|checkbox) should( not)? be disabled**
+* **Then the "..." (field|button|checkbox|radio button) should( not)? be disabled**
 
-  Tests that an input, button or checkbox with the given label is disabled.
+  Tests that an input, button, checkbox or radio button with the given label is disabled.
 
 
 * **Then the "..." field should( not)? be visible**

data/lib/spreewald/email_steps.rb

@@ -17,54 +17,81 @@ end.overridable
 #       From: max.mustermann@example.com
 #       Reply-To: mmuster@gmail.com
 #       To: john.doe@example.com
+#       CC: jane.doe@example.com
+#       BCC: johnny.doe@example.com
 #       Subject: The subject may contain "quotes"
-#       Attachments: ...
+#       Attachments: image.jpg, attachment.pdf
+#
+#       This is the message body. You can use * as a wildcard to omit the rest
+#       of a line *
+#       Or you can omit multiple lines if the asterisk is the only
+#       character in a single line, like this:
+#       *
 #
-#       Message body goes here.
 #       """
 #
-# You may skip lines in the header, of course. Note that the mail body is only checked for
-# _inclusion_. That means you can only test a prefix of the body. The subject may also be
-# a prefix.
-Then /^(an|no) e?mail should have been sent with:$/ do |mode, raw_data|
+# 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.
+Then /^(an?|no)( HTML| plain-text|) e?mail should have been sent with:$/ do |mode, type, raw_data|
   patiently do
-    raw_data.strip!
-    header, body = raw_data.split(/\n\n/, 2) # 2: maximum number of fields
-    conditions = {}
-    header.split("\n").each do |row|
-      if row.match(/^[a-z\-]+: /i)
-        key, value = row.split(": ", 2)
-        conditions[key.underscore.to_sym] = value
+    results = MailFinder.find(raw_data, type.strip)
+
+    if mode == 'no'
+      expect(results).to be_empty
+    else
+      if results.one?
+        @mail = results.mails[0]
+      elsif results.many?
+        warn <<-WARNING
+#{results.size} emails were found with the following conditions.
+You may want to make the description more precise or clear the emails in between.
+#{raw_data}
+WARNING
+      else
+        message = <<-ERROR
+No matching mail was found. There were #{ActionMailer::Base.deliveries.size} mails in total.
+#{results.matching_header.size} of those had matching headers.
+ERROR
+        if results.matching_header.empty?
+          message << "Expected\n" + '-' * 80 + "\n"
+          message << raw_data.split(/\n\n/, 2)[0] # Show the expected header
+          message << "\n" + '-' * 80 + "\n\n"
+          message << MailFinder.show_mails(ActionMailer::Base.deliveries, true)
+        else
+          message << "\nTried to match #{results.body_regex.inspect} in the following mails:\n"
+          message << results.matching_header.map { |mail| MailFinder.email_text_body(mail, type.strip).strip.inspect }.join("\n")
+          message << "\n"
+        end
+        raise RSpec::Expectations::ExpectationNotMetError.new(message)
       end
     end
-    conditions[:body] = body if body
-    @mail = MailFinder.find(conditions)
-    expectation = mode == 'no' ? 'not_to' : 'to'
-    expect(@mail).send(expectation, be_present)
   end
 end.overridable
 
-# Example:
-#
-#     Then an email should have been sent from "max.mustermann@example.com" to "john.doe@example.com" with bcc "john.wane@example.com" and with cc "foo@bar.com" and the subject "The subject" and the body "The body" and the attachments "attachment.pdf"
-#
-# You may skip parts, of course.
+# 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
-    conditions = {}
-    conditions[:to] = $1 if query =~ /to "([^"]+)"/
-    conditions[:Cc] = $1 if query =~ /cc "([^"]+)"/
-    conditions[:bcc] = $1 if query =~ /bcc "([^"]+)"/
-    conditions[:from] = $1 if query =~ /from "([^"]+)"/
-    conditions[:subject] = $1 if query =~ /the subject "([^"]+)"/
-    conditions[:body] = $1 if query =~ /the body "([^"]+)"/
-    conditions[:attachments] = $1 if query =~ /the attachments "([^"]+)"/
-    @mail = MailFinder.find(conditions)
+    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|
   mail = @mail || ActionMailer::Base.deliveries.last
   index = { nil => 0, 'first' => 0, 'second' => 1, 'third' => 2 }[index_in_words]
@@ -72,7 +99,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)
@@ -86,34 +113,38 @@ Then /^no e?mail should have been sent$/ do
 end.overridable
 
 # Checks that the last sent email includes some text
-Then /^I should see "([^\"]*)" in the e?mail$/ do |text|
-  expect(MailFinder.email_text_body(ActionMailer::Base.deliveries.last)).to include(text)
+Then /^I should see "([^\"]*)" in the( HTML| plain-text|) e?mail$/ do |text, type|
+  expect(MailFinder.email_text_body(ActionMailer::Base.deliveries.last, type.strip)).to include(text)
+end.overridable
+
+# Print all sent emails to STDOUT (optionally only the headers).
+Then /^show me the e?mail( header)?s$/ do |only_header|
+  if ActionMailer::Base.deliveries.empty?
+    puts MailFinder.show_mails(ActionMailer::Base.deliveries, only_header)
+  else
+    puts "No emails found" if ActionMailer::Base.deliveries.empty?
+  end
+
 end.overridable
 
-# Print all sent emails to STDOUT.
-Then /^show me the e?mails$/ do
-  ActionMailer::Base.deliveries.each_with_index do |mail, i|
-    puts "E-Mail ##{i}"
-    print "-" * 80
-    puts [ "From:    #{mail.from}",
-           "To:      #{mail.to}",
-           "Subject: #{mail.subject}",
-           "\n" + MailFinder.email_text_body(mail)
-         ].join("\n")
-    print "-" * 80
+# Print a subset of all sent emails to STDOUT
+# This uses the same syntax as `Then an email should have been sent with:`
+Then /^show me the e?mail( header)?s with:$/ do |only_header, raw_data|
+  results = MailFinder.find(raw_data)
+  if results.empty?
+    if results.matching_header.empty?
+      puts "There are no emails matching the given header."
+    else
+      puts "There are no emails matching the given header and body, but #{results.matching_header.size} matching only the header."
+    end
   end
+
+  print MailFinder.show_mails(results.mails, only_header)
 end.overridable
 
-# Example:
-#
-#     And that mail should have the following lines in the body:
-#       """
-#       All of these lines
-#       need to be present
-#       """
-#
-# You may skip lines, of course. Note that you may also omit text at the end of each line.
+# 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)
@@ -123,8 +154,9 @@ Then /^that e?mail should( not)? have the following lines in the body:$/ do |neg
   end
 end.overridable
 
-# Checks that the text should be included anywhere in the retrieved email body
+# 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/web_steps.rb

@@ -397,6 +397,7 @@ Then /^the "([^\"]*)" field should( not)? have an error$/ do |label, negate|
 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(' ')
@@ -408,6 +409,10 @@ end.overridable
 Then /^the "([^"]*)" checkbox should( not)? be checked( and disabled)?$/ do |label, negate, disabled|
   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)
@@ -463,7 +468,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 +611,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|
@@ -607,6 +623,7 @@ 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
 
@@ -659,23 +676,20 @@ When /^I enter "([^"]*)" into the browser dialog$/ do |text|
   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|
+# 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
+    find_with_disabled(:field, label)
+  end
+
   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.
@@ -701,6 +715,7 @@ end.overridable
 #
 # 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

data/lib/spreewald_support/mail_finder.rb

@@ -5,22 +5,38 @@ class MailFinder
 
     attr_accessor :user_identity
 
-    def find(conditions)
+    def find(raw_data, type = '')
+      header, body = raw_data.split(/\n\n/, 2) # 2: maximum number of fields
+      conditions = {}
+      header.split("\n").each do |row|
+        if row.match(/^[A-Za-z\-]+: /i)
+          key, value = row.split(": ", 2)
+          conditions[key.strip.underscore.to_sym] = value.strip
+        end
+      end
+
       filename_method = Rails::VERSION::MAJOR < 3 ? 'original_filename' : 'filename'
-      ActionMailer::Base.deliveries.detect do |mail|
-        mail_body = email_text_body(mail)
+      matching_header = ActionMailer::Base.deliveries.select do |mail|
         [ conditions[:to].nil? || mail.to.include?(resolve_email conditions[:to]),
           conditions[:cc].nil? || mail.cc && mail.cc.include?(resolve_email conditions[:cc]),
           conditions[:bcc].nil? || mail.bcc && mail.bcc.include?(resolve_email conditions[:bcc]),
           conditions[:from].nil? || mail.from.include?(resolve_email conditions[:from]),
           conditions[:reply_to].nil? || mail.reply_to.include?(resolve_email conditions[:reply_to]),
           conditions[:subject].nil? || mail.subject.include?(conditions[:subject]),
-          conditions[:body].nil? || mail_body.include?(conditions[:body]),
           conditions[:attachments].nil? || conditions[:attachments].split(/\s*,\s*/).sort == Array(mail.attachments).collect(&:"#{filename_method}").sort
         ].all?
-      end.tap do |mail|
-        log(mail)
       end
+
+      matching_mails = if body
+        body_regex = expected_body_regex(body)
+        matching_header.select do |mail|
+          body_regex =~ email_text_body(mail, type).strip
+        end
+      else
+        matching_header
+      end
+
+      Results.new(matching_mails, matching_header, body_regex)
     end
 
     def resolve_email(identity)
@@ -31,46 +47,61 @@ class MailFinder
       end
     end
 
-    def log(mail)
-      if mail.present?
-        File.open("log/test_mails.log", "a") do |file|
-          file << "From: #{mail.from}\n"
-          file << "To: #{mail.to.join(', ')}\n" if mail.to
-          file << "Subject: #{mail.subject}\n\n"
-          file << email_text_body(mail)
-          file << "\n-------------------------\n\n"
-        end
-      end
+    def header_representation(mail)
+      header = ""
+      header << "From: #{mail.from}\n"
+      header << "Reply-To: #{mail.reply_to.join(', ')}\n" if mail.reply_to
+      header << "To: #{mail.to.join(', ')}\n" if mail.to
+      header << "CC: #{mail.cc.join(', ')}\n" if mail.cc
+      header << "BCC: #{mail.bcc.join(', ')}\n" if mail.bcc
+      header << "Subject: #{mail.subject}\n"
     end
 
-    def email_text_body(mail)
-      body = if mail.parts.any?
-        mail_bodies = mail.parts.map { |part|
-          if part.header.to_s.include?('Quoted-printable')
-            if Rails.version.starts_with?('2.3')
-              part.body.to_s
-            else
-              part.decoded
-            end
-          elsif part.content_type.include?('multipart/alternative')
-            part.parts.map(&:decoded)
-          else
-            part.decoded
-          end
-        }
-        utf8_parts = mail_bodies.flatten.select{ |part|
-          encoding = part.try(:encoding)
-          encoding.nil? or # Ruby < 1.9.1
-            encoding.name == 'UTF-8' # Ruby > 1.9.1
-        }
-        utf8_parts.join('\n')
-      elsif mail.body.respond_to? :raw_source
-        mail.body.raw_source
+    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(/\n\n/, "\n")
+      elsif mail.text_part && type != 'HTML'
+        mail.text_part.body.to_s
       else
-        mail.body
+        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.
     end
 
+    def show_mails(mails, only_header = false)
+      message = ""
+      mails.each_with_index do |mail, i|
+        message << "E-Mail ##{i}\n"
+        message <<  "-" * 80 + "\n"
+        message << header_representation(mail)
+        message << "\n" + email_text_body(mail).strip + "\n" unless only_header
+        message <<  "-" * 80 + "\n\n"
+      end
+      message
+    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! '\A\n', '\A'
+      expected.gsub! '\n\Z', '' # Change '' to '\Z' to force that the whole body matches
+
+      Regexp.new(expected)
+    end
+
+  end
+end
+
+class MailFinder::Results < Struct.new(:mails, :matching_header, :body_regex)
+  extend Forwardable
+  delegate [:size, :one?, :empty?] => :mails
+
+  def many?
+    size > 1
   end
 end

data/lib/spreewald_support/version.rb

@@ -1,3 +1,3 @@
 module Spreewald
-  VERSION = '2.7.0'
+  VERSION = '2.99.1'
 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/tests/rails-3_capybara-1/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.7.0)
+    spreewald (2.99.1)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/rails-3_capybara-2/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.7.0)
+    spreewald (2.99.1)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/rails-4_capybara-3/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.7.0)
+    spreewald (2.99.1)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/rails-6_capybara-3/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.7.0)
+    spreewald (2.99.1)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/rails-6_capybara-3/app/mailers/spreewald_mailer.rb

@@ -17,7 +17,15 @@ class SpreewaldMailer < ApplicationMailer
       :subject => SUBJECT
     )
   end
-  
+
+  def email_crlf
+    email
+  end
+
+  def email_with_umlauts
+    email
+  end
+
   def html_email_with_links
     email
   end

data/tests/shared/app/controllers/downloads_controller.rb

@@ -1,7 +1,7 @@
 class DownloadsController < ApplicationController
 
   def spreadsheet
-    send_data File.read("#{Rails.root}/public/fixture_files/spreadsheet.ods"), filename: 'test.ods'
+    send_data File.read("#{Rails.root}/public/fixture_files/spreadsheet.ods"), filename: 'test - example (today).ods'
   end
 
 end

data/tests/shared/app/controllers/emails_controller.rb

@@ -9,6 +9,16 @@ class EmailsController < ApplicationController
     render_nothing
   end
 
+  def send_crlf_email
+    deliver :email_crlf
+    render_nothing
+  end
+
+  def send_email_with_umlauts
+    deliver :email_with_umlauts
+    render_nothing
+  end
+
   def send_html_email_with_links
     deliver :html_email_with_links
     render_nothing

data/tests/shared/app/models/mailer.rb

@@ -21,6 +21,14 @@ class Mailer < ActionMailer::Base
       )
     end
 
+    def email_crlf
+      email
+    end
+
+    def email_with_umlauts
+      email
+    end
+
     def html_email_with_links
       email
     end
@@ -42,6 +50,10 @@ class Mailer < ActionMailer::Base
       body BODY
     end
 
+    def email_crlf
+      email
+    end
+
     def html_email_with_links
       email
     end

data/tests/shared/app/views/forms/disabled_elements.html.haml

@@ -51,3 +51,21 @@
 
   = label_tag 'enabled_field_2', 'Enabled field #2'
   = text_field_tag 'enabled_field_2', 'value'
+
+-# radio buttons
+= form_tag do
+  - selected = false
+  = label_tag 'disabled_radio_1', 'Disabled radio button #1'
+  = radio_button_tag 'disabled_radio', '1', selected, disabled: true
+
+  = label_tag 'disabled_radio_2', 'Disabled radio button #2'
+  = radio_button_tag 'disabled_radio', '2', selected, disabled: ''
+
+  = label_tag 'disabled_radio_3', 'Disabled radio button #3'
+  = radio_button_tag 'disabled_radio', '3', selected, disabled: 'aaa'
+
+  = label_tag 'enabled_radio_1', 'Enabled radio button #1'
+  = radio_button_tag 'enabled_radio', '1', selected, disabled: false
+
+  = label_tag 'enabled_radio_2', 'Enabled radio button #2'
+  = radio_button_tag 'enabled_radio', '2', selected

data/tests/shared/app/views/mailer/email_crlf.text.erb

@@ -0,0 +1,5 @@
+Body
+with
+CRLF
+line
+breaks

data/tests/shared/app/views/mailer/email_with_umlauts.text.erb

@@ -0,0 +1 @@
+Viele Grüße

data/tests/shared/app/views/mailer/html_email_with_links.haml

@@ -3,4 +3,6 @@
   %body
     %img(src="https://www.example.com/image.png")
     %a(href="https://www.example.com/static_pages/link_target") Click me
+    %a(href="mailto:user@example.com") mailto links should be ignored
+    %a(href="ftp://ftp.example.com/") FTP links are also ignored
     %a(href="https://www.example.com/static_pages/second_link_target") Other link

data/tests/shared/app/views/mailer/text_email_with_links.text.erb

@@ -1,6 +1,7 @@
 Hello!
 
 First link: https://www.example.com/static_pages/link_target
+Ignored link: ftp://ftp.example.com/
 Second link: https://www.example.com/static_pages/second_link_target
 
 Bye!

data/tests/shared/config/routes.rb

@@ -6,6 +6,8 @@ Rails.application.routes.draw do
 
   get '/emails/do_nothing', to: 'emails#do_nothing'
   get '/emails/send_email', to: 'emails#send_email'
+  get '/emails/send_crlf_email', to: 'emails#send_crlf_email'
+  get '/emails/send_email_with_umlauts', to: 'emails#send_email_with_umlauts'
   get '/emails/send_html_email_with_links', to: 'emails#send_html_email_with_links'
   get '/emails/send_text_email_with_links', to: 'emails#send_text_email_with_links'
 

data/tests/shared/features/shared/email_steps.feature

@@ -1,10 +1,10 @@
 Feature: Test Spreewald's email steps
-  
+
   Scenario: /^no e?mail should have been sent$/
     When I go to "/emails/do_nothing"
     Then the following step should succeed:
       | no email should have been sent |
-  
+
     When I go to "/emails/send_email"
     Then the following step should fail:
       | no email should have been sent |
@@ -50,6 +50,53 @@ Feature: Test Spreewald's email steps
         '''
       """
 
+    # Test with end-of-line wildcards
+    Then the following multiline step should succeed:
+      """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        Bo*
+        wi*
+        li*
+        br*
+        '''
+      """
+
+    # Test with multiple-line wildcards
+    Then the following multiline step should succeed:
+      """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        Body
+        *
+        breaks
+        '''
+      """
+
+    # Test with the whole body being a multiple-line wildcard
+    Then the following multiline step should succeed:
+      """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        *
+        '''
+      """
+
     # Test with incorrect From header
     Then the following multiline step should fail:
       """
@@ -148,12 +195,29 @@ Feature: Test Spreewald's email steps
         with
         line
         breaks
-        
+
         MORE-BODY
         '''
       """
 
-  Scenario: /^(an|no) e?mail should have been sent((?: |and|with|from "[^"]+"|bcc "[^"]+"|cc "[^"]+"|to "[^"]+"|the subject "[^"]+"|the body "[^"]+"|the attachments "[^"]+")+)$/
+    # Test body with wildcard not at the end of a line
+    Then the following multiline step should fail:
+      """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        Body
+        *th
+        line
+        break
+        '''
+      """
+
+  Scenario: Scenario: /^(an|no) e?mail should have been sent((?: |and|with|from "[^"]+"|bcc "[^"]+"|cc "[^"]+"|to "[^"]+"|the subject "[^"]+"|the body "[^"]+"|the attachments "[^"]+")+)$/
     When I go to "/emails/send_email"
 
     # Test with correct conditions
@@ -181,7 +245,7 @@ Feature: Test Spreewald's email steps
         '''
       """
 
-     # Test with wrong body lines
+    # Test with wrong body lines
     Then the following multiline step should fail:
       """
       Then that email should have the following lines in the body:
@@ -215,6 +279,41 @@ Feature: Test Spreewald's email steps
         '''
       """
 
+    When I clear my emails
+      And I go to "/emails/send_crlf_email"
+
+    Then the following multiline step should succeed:
+      """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        Body
+        with
+        CRLF
+        line
+        breaks
+        '''
+      """
+
+    When I clear my emails
+      And I go to "/emails/send_email_with_umlauts"
+
+    Then the following multiline step should succeed:
+     """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        Viele Grüße
+        '''
+      """
 
   Scenario: /^I follow the (first|second|third)? ?link in the e?mail$/ (HTML e-mail body)
     When I go to "/emails/send_html_email_with_links"

data/tests/shared/features/shared/web_steps.feature

@@ -85,7 +85,7 @@ Feature: Web steps
   Scenario: /^I go back$/
     Given I go to "/static_pages/link_to_home"
       And I follow "Home"
-    
+
     When I go back
     Then I should be on "/static_pages/link_to_home"
 
@@ -290,7 +290,7 @@ Feature: Web steps
 
   Scenario: /^I should get a download with filename "([^\"]*)"$/
     When I go to "/downloads/spreadsheet"
-    Then I should get a download with filename "test.ods"
+    Then I should get a download with filename "test - example (today).ods"
 
 
   Scenario: /^I should( not)? see a link labeled "([^"]*)"$/
@@ -341,6 +341,12 @@ Feature: Web steps
     But the "Enabled field #1" field should not be disabled
       And the "Enabled field #2" field should not be disabled
 
+      # radio buttons
+      And the "Disabled radio button #1" radio button should be disabled
+      And the "Disabled radio button #2" radio button should be disabled
+      And the "Disabled radio button #3" radio button should be disabled
+    But the "Enabled radio button #1" radio button should not be disabled
+      And the "Enabled radio button #2" radio button should not be disabled
 
   Scenario: /^the window should be titled "([^"]*)"$/
     When I go to "/static_pages/home"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spreewald
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.99.1
 platform: ruby
 authors:
 - Tobias Kraze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -348,6 +348,8 @@ files:
 - tests/shared/app/views/layouts/mailer.html.erb
 - tests/shared/app/views/layouts/mailer.text.erb
 - tests/shared/app/views/mailer/email.text.erb
+- tests/shared/app/views/mailer/email_crlf.text.erb
+- tests/shared/app/views/mailer/email_with_umlauts.text.erb
 - tests/shared/app/views/mailer/html_email_with_links.haml
 - tests/shared/app/views/mailer/text_email_with_links.text.erb
 - tests/shared/app/views/spreewald_mailer
@@ -410,7 +412,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Collection of useful cucumber steps.
@@ -579,6 +581,8 @@ test_files:
 - tests/shared/app/views/layouts/mailer.html.erb
 - tests/shared/app/views/layouts/mailer.text.erb
 - tests/shared/app/views/mailer/email.text.erb
+- tests/shared/app/views/mailer/email_crlf.text.erb
+- tests/shared/app/views/mailer/email_with_umlauts.text.erb
 - tests/shared/app/views/mailer/html_email_with_links.haml
 - tests/shared/app/views/mailer/text_email_with_links.text.erb
 - tests/shared/app/views/spreewald_mailer