spreewald 2.5.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1168c34206078cc51317c0b55250cd4413120277f76dd08207e33ab0ad14defb
-  data.tar.gz: 203c60be6904e5fbd56cc114a9e2b2bcc08cb50be8fa2f30159ef0a8041b4d6f
+  metadata.gz: 05a2f0dc08e4a044c5da09e999a488eeeab8d0ef21fd26fccf9306651e27d6ba
+  data.tar.gz: bc1753072141059f502b634a9a7347e63c602a072bc04f2a9aaf73a98ebd9eca
 SHA512:
-  metadata.gz: 17930b95e19e14be451f87fc2ebf13877b1b377f57a15a29f8d7feba1bcfbbd0f35405c107db24a3955e2741070f91fba5e77c6c4ff0f66199b46aee9a9cbd9c
-  data.tar.gz: 95584eefb31f7b90a6b9c49ec9bc9930aed8bead0fc4930075af317c9a5dd9131291d8f59b8696f30d409b77779fe8dcfdadf04dfe113344eba6374116523e8b
+  metadata.gz: 0b59488dcad4d0e94203fdc4b28463f69b6ccf93011f42c19dbc84582f0cca5e988a1b69c5f74520142198023dda9362e60c595d58a1bdc5abdde5b8a9e093ab
+  data.tar.gz: f324ae1ccd2ee7dbe97a71c4fbf614cd6888dd91846b42d2d60d900ae085413e6da55669d58ebe8275519354f10cf1a2826c5ef08323f30140d756572143dc76

data/CHANGELOG.md

@@ -3,6 +3,27 @@ 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.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))
+
+## 2.6.0
+- The time steps do now work with the time helpers in ActiveSupport 4.1+ if the timecop gem is not included in the bundle. Please note that the two approaches branch. While ActiveSupport will freeze the time, Timecop will keep it running.
+- The steps in the file `spreewald/timecop.rb` file were moved to `spreewald/time.rb` and importing `spreewald/timecop` directly is deprecated now.
+
 ## 2.5.0
 - Add a set of steps to control browser tabs (Selenium only):
   * `I open ... in a new browser tab`
@@ -32,7 +53,7 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## 2.2.4
 - Fix "..." field should have the error "..." test by removing old should syntax
-- Add single-line mail step to READNE
+- Add single-line mail step to README
 
 ## 2.2.3
 - Fix 'the window should be titled' step - closes: [#102](https://github.com/makandra/spreewald/issues/102)
@@ -52,7 +73,7 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## 2.2.0
 - Add a new step `I should( not)? see a link labeled "STRING"`.
-- Refer to Capybara 3's new flag `Capybara.default_normalize_ws = true` in the READNE,
+- Refer to Capybara 3's new flag `Capybara.default_normalize_ws = true` in the README,
 
 ## 2.1.3
 The `I should(not )? see /REGEXP/` step no longer refuses slashes as part of the regular expression. You can thus match full domains and more.

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**
-
-  Print all sent emails to STDOUT.
+* **Then show me the e?mail( header)?s**
 
-
-* **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 
@@ -286,6 +276,18 @@ the step definitions.
   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.
 
 
+### session_steps.rb 
+
+* **When ... in the browser session "..."**
+
+  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).
+
+
 ### table_steps.rb 
 
 * **Then I should( not)? see a table with (exactly )?the following rows( in any order)?:?**
@@ -295,11 +297,14 @@ the step definitions.
   See [this article](https://makandracards.com/makandra/763-cucumber-step-to-match-table-rows-with-capybara) for details.
 
 
-### timecop_steps.rb 
+### time_steps.rb 
 
-Steps to travel through time using [Timecop](https://github.com/jtrupiano/timecop).
+Steps to travel through time
 
-See [this article](https://makandracards.com/makandra/1222-useful-cucumber-steps-to-travel-through-time-with-timecop) for details.
+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.
 
 
 * **When the (date|time) is "?(\d{4}-\d{2}-\d{2}( \d{1,2}:\d{2})?)"?**
@@ -317,7 +322,7 @@ See [this article](https://makandracards.com/makandra/1222-useful-cucumber-steps
       Given the time is 13:40
 
 
-* **When it is (\d+|a|some|a few) (seconds?|minutes?|hours?|days?|weeks?|months?|years?) (later|earlier)**
+* **When it is (\d+|an?|some|a few) (seconds?|minutes?|hours?|days?|weeks?|months?|years?) (later|earlier)**
 
   Example:
   
@@ -325,6 +330,8 @@ See [this article](https://makandracards.com/makandra/1222-useful-cucumber-steps
       When it is a few hours earlier
 
 
+
+
 ### web_steps.rb 
 
 Most of cucumber-rails' original web steps plus a few of our own.
@@ -353,7 +360,7 @@ deprecation notice. Decide for yourself whether you want to use them:
 
 * **When ... within ...**
 
-  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.
@@ -663,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 =~)
 
@@ -698,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/examples/paths.rb

@@ -13,6 +13,30 @@ module NavigationHelpers
     when /^the home\s?page$/
       root_path
 
+    when /^the (page|form) for the (.*?) above$/
+      action_prose = Regexp.last_match(1)
+      model_prose = Regexp.last_match(2)
+      route = "#{(action_prose == 'form') ? 'edit_' : ''}#{model_prose_to_route_segment(model_prose)}_path"
+      model = model_prose_to_class(model_prose)
+      send(route, model.reorder(:id).last!)
+
+    when /^the (page|form) for the (.*?) "(.*?)"$/
+      action_prose = Regexp.last_match(1)
+      model_prose = Regexp.last_match(2)
+      identifier = Regexp.last_match(3)
+      path_to_show_or_edit(action_prose, model_prose, identifier)
+
+    when /^the (.*?) (page|form) for "(.*?)"$/
+      model_prose = Regexp.last_match(1)
+      action_prose = Regexp.last_match(2)
+      identifier = Regexp.last_match(3)
+      path_to_show_or_edit(action_prose, model_prose, identifier)
+
+    when /^the (.*?) form$/
+      model_prose = Regexp.last_match(1)
+      route = "new_#{model_prose_to_route_segment(model_prose)}_path"
+      send(route)
+
     else
       begin
         page_name =~ /^the (.*) page$/
@@ -24,6 +48,18 @@ module NavigationHelpers
       end
     end
   end
+
+  private
+
+  def model_prose_to_class(model_prose)
+    model_prose.gsub(' ', '_').classify.constantize
+  end
+
+  def model_prose_to_route_segment(model_prose)
+    model_prose = model_prose.downcase
+    model_prose.gsub(/[\ \/]/, '_')
+  end
+
 end
 
 World(NavigationHelpers)

data/examples/selectors.rb

@@ -12,6 +12,27 @@ module HtmlSelectorsHelpers
     when "the page"
       "html > body"
 
+    # Auto-mapper for BEM classes and ARIA labels
+    #
+    # Usage examples:
+    #   the main menu -> '.main-menu, [aria-label="main menu"]'
+    #   the item box's header -> '.item-box--header, [aria-label="item box's header"]'
+    #   the slider's item that is current -> '.slider--item.is-current, [aria-label="slider's item that is current"]'
+    when /^the (.*)$/
+      match = Regexp.last_match(1)
+      match =~ /^(.+?)(?:'s (.+?))?(?: that (.+))?$/
+
+      bem_selector = '.'
+      bem_selector << selectorify(Regexp.last_match(1))
+      bem_selector << '--' << selectorify(Regexp.last_match(2)) if Regexp.last_match(2)
+      bem_selector << '.' << selectorify(Regexp.last_match(3)) if Regexp.last_match(3)
+
+      aria_selector = '[aria-label="'
+      aria_selector << match.gsub('"', '\\"')
+      aria_selector << '"]'
+
+      [bem_selector, aria_selector].join(', ')
+
     # Add more mappings here.
     # Here is an example that pulls values out of the Regexp:
     #
@@ -35,6 +56,13 @@ module HtmlSelectorsHelpers
         "Now, go and add a mapping in #{__FILE__}"
     end
   end
+
+  private
+
+  def selectorify(string)
+    string.gsub(/ /, '-')
+  end
+
 end
 
 World(HtmlSelectorsHelpers)

data/lib/spreewald/all_steps.rb

@@ -1,9 +1,12 @@
 # coding: UTF-8
 require 'rspec/matchers'
 
+ALREADY_LOADED_FILES = %w[all_steps timecop_steps]
+
 Dir[File.join(File.dirname(__FILE__), '*_steps.rb')].each do |f|
   name = File.basename(f, '.rb')
-  unless name == 'all_steps'
+
+  unless ALREADY_LOADED_FILES.include?(name)
     require "spreewald/#{name}"
   end
 end

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