spreewald 2.7.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02a43b32f16090f64a87cea6adc814baaceb590ef8388863224620f782565e25
-  data.tar.gz: d474b73278a9b3c309c0898e83e1238715012f38cce70e3d8d13d77f9bcd8680
+  metadata.gz: 64749212dae1262a16bb92a588740444cf7ede78c5980fbdf15f66271a4b081d
+  data.tar.gz: 7384baaed65e17289ff4d4c52874e1c257b315b0e9026fac51bbea9a414f4141
 SHA512:
-  metadata.gz: c8c2ca98760710ddbda7a2aca39ec3208a1a01ab57e842a448dd14d5b3ba969834d6dc08638440e6979140f2fa22ef2ee152276ae2ae19363ef7294cad213cf5
-  data.tar.gz: 9eea3e603ab1e9cb5d3346c948f09ee3b8c4bbfdd811b76eef3a0fc778c3015c48a85f97c31d6be8833f94e22d2d4ed159ab374b1aa345f51ffeba7d0f5fa23e
+  metadata.gz: e06ba20e5252696bd8ce7aecb6f3a6f9f21eb16c3e2f7ba2cb6223bdfdfdf1cb05c34ada79e06bcd94631ea7288e802fab3f9cce98f8d59d34f7b0b9117300c3
+  data.tar.gz: d09e69ad26c4e76a09bfaa44989bcd870b1eb160de410be081bf0d40889e3a7ffc901e02c7e208538e8c92719752a3cb7fa396a9f7dada600c257dcbcf72fef3

data/CHANGELOG.md

@@ -3,6 +3,63 @@ 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).
 
+## 3.0.0
+
+### Breaking changes
+
+- The following steps have been removed:
+  - `/^the file "([^"]*)" was attached(?: as (?:([^"]*)\/)?([^"]*))? to the ([^"]*) above(?: at "([^"]*)")?$/` (see [#106](https://github.com/makandra/spreewald/issues/106), this functionality was moved to [CucumberFactory](https://github.com/makandra/cucumber_factory))
+  - `/^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))
+  - `debugger` (was an alias for `console`)
+- These email steps have been removed in favor of `(an?|no)( HTML| plain-text|) e?mail should have been sent with:` (see [#132](https://github.com/makandra/spreewald/issues/132#issuecomment-631457290)):
+  - `/^(an|no) e?mail should have been sent((?: |and|with|from "[^"]+"|bcc "[^"]+"|cc "[^"]+"|to "[^"]+"|the subject "[^"]+"|the body "[^"]+"|the attachments "[^"]+")+)$/`
+  - `/^that e?mail should( not)? have the following lines in the body$/`
+  - `/^that e?mail should have the following (?:|content in the )body:$/`
+- The `and disabled` modifier of the step `the "..." checkbox should( not)? be checked` has been removed. Use the step without the modifier together with the step `the "..." checkbox should be disabled` to achieve the old behavior.
+- The step `/^(the tag )?"([^\"]+)" should( not)? be visible$/` lost its `not` modifier (Use `Then (the tag )?"..." should be hidden` or `Then I should not see "..."`)
+- The file `lib/spreewald/timecop_steps.rb` was removed (was an alias for `lib/spreewald/time_steps.rb`).
+- The step `(an?|no)( HTML| plain-text|) e?mail should have been sent with:` does now require that the whole body is matched.
+- All web steps interacting with forms will now find both enabled and disabled fields. We encourage you to assert the "disabled" state in a separate step when needed, Spreewald offers these steps as well.
+
+  The following steps have been adjusted:
+  - `I should( not)? see a field "..."`
+  - `the "..." field should( not)? contain "..."`
+  - `I should see a form with the following values:`
+  - `the "..." field should have the error "..."`
+  - `the "..." field should( not)? have an error`
+  - `the "..." checkbox should( not)? be checked`
+  - `"..." should be selected for "..."`
+  - `nothing should be selected for "..."`
+  - `"..." should( not)? be an option for "..."`
+  - `the "..." field should( not)? be visible`
+  - `the "..." select should( not)? be sorted`
+  
+### Compatible changes
+- 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 +112,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 +145,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 +159,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

@@ -197,8 +197,7 @@ the step definitions.
 * **Then console**
 
   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.
 
 
 * **AfterStep @slow-motion**
@@ -216,7 +215,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,65 +224,45 @@ 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.
+  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**
-
-  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.
-
-
-* **Then that e?mail should have the following (|content in the )body:**
-
-  Checks that the text should be included anywhere in the retrieved email body
+* **Then show me the e?mail( header)?s**
 
+  Print all sent emails to STDOUT (optionally only the headers).
 
-### file_attachment_steps.rb 
 
-* **Given the file "..." was attached( as (.../)?...)? to the ... above( at "...")?**
+* **Then show me the e?mail( header)?s with:**
 
-  This step is deprecated and will be removed from spreewald. If you still want to use it, copy the code to your project's own steps.
+  Print a subset of all sent emails to STDOUT
+  This uses the same syntax as `Then an email should have been sent with:`
 
 
 ### session_steps.rb 
@@ -340,8 +319,6 @@ Please note that the two approaches branch. While ActiveSupport will freeze the
       When it is a few hours earlier
 
 
-
-
 ### web_steps.rb 
 
 Most of cucumber-rails' original web steps plus a few of our own.
@@ -569,10 +546,7 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **Then the "..." field should( not)? have an error**
 
 
-* **Then the "..." field should have no error**
-
-
-* **Then the "..." checkbox should( not)? be checked( and disabled)?**
+* **Then the "..." checkbox should( not)? be checked?**
 
 
 * **Then the radio button "..." should( not)? be (checked|selected)**
@@ -625,14 +599,12 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **When I reload the page**
 
 
-* **Then (the tag )?"..." should( not)? be visible**
+* **Then (the tag )?"..." should be visible**
 
   Checks that an element is actually present and visible, also considering styles.
   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)
 
 
@@ -680,16 +652,11 @@ 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 =~)
 
 
-* **Then I should get a text response**
-
-  Checks that the result has content type `text/plain`
-
-
 * **When I follow "..." inside any "..."**
 
   Click a link within an element matching the given selector. Will try to be clever
@@ -715,9 +682,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**
@@ -725,13 +692,6 @@ deprecation notice. Decide for yourself whether you want to use them:
   Tests that a field with the given label is visible.
 
 
-* **When I wait for the page to load**
-
-  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 perform basic authentication as ".../..." and go to ...**
 
   Performs HTTP basic authentication with the given credentials and visits the given path.

data/features/binary.feature

@@ -240,7 +240,7 @@ Feature: The `spreewald` binary
 
   Scenario: Print version
     When I run `spreewald --version`
-    Then the output should contain "Spreewald 2."
+    Then the output should contain "Spreewald 3."
 
     When I run `spreewald -v`
-    Then the output should contain "Spreewald 2."
+    Then the output should contain "Spreewald 3."

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

@@ -17,54 +17,58 @@ 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|
+# 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.
-Then /^(an|no) e?mail should have been sent((?: |and|with|from "[^"]+"|bcc "[^"]+"|cc "[^"]+"|to "[^"]+"|the subject "[^"]+"|the body "[^"]+"|the attachments "[^"]+")+)$/ do |mode, query|
-  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)
-    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 +76,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,45 +90,31 @@ 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.
-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 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
 
-# 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.
-Then /^that e?mail should( not)? have the following lines in the body:$/ do |negate, body|
-  expectation = negate ? 'not_to' : 'to'
-  mail = @mail || ActionMailer::Base.deliveries.last
-  email_text_body = MailFinder.email_text_body(mail)
+end.overridable
 
-  body.to_s.strip.split(/\n/).each do |line|
-    expect(email_text_body).send(expectation, include(line.strip))
+# 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
-end.overridable
 
-# Checks that the text should be included anywhere in the retrieved email body
-Then /^that e?mail should have the following (?:|content in the )body:$/ do |body|
-  mail = @mail || ActionMailer::Base.deliveries.last
-  expect(MailFinder.email_text_body(mail)).to include(body.strip)
+  print MailFinder.show_mails(results.mails, only_header)
 end.overridable