spreewald 2.8.0 → 3.0.1

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,59 @@ 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(/[\r\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)
+      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', '\Z'
+
+      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.8.0'
+  VERSION = '3.0.1'
 end

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

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.8.0)
+    spreewald (3.0.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.8.0)
+    spreewald (3.0.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.8.0)
+    spreewald (3.0.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.8.0)
+    spreewald (3.0.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
@@ -26,5 +34,9 @@ class SpreewaldMailer < ApplicationMailer
     email
   end
 
+  def html_email_with_linebreaks
+    email
+  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
@@ -19,6 +29,11 @@ class EmailsController < ApplicationController
     render_nothing
   end
 
+  def send_html_email_with_linebreaks
+    deliver :html_email_with_linebreaks
+    render_nothing
+  end
+
   private
 
   def deliver(method_name)

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
@@ -29,6 +37,10 @@ class Mailer < ActionMailer::Base
       email
     end
 
+    def html_email_with_linebreaks
+      email
+    end
+
   else
 
     def email
@@ -42,6 +54,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/checkbox_form.html.haml

@@ -4,6 +4,9 @@
   = label_tag 'checked_name', 'Checked'
   = check_box_tag 'checked_name', 'value', checked
 
+  = label_tag 'checked_disabled_name', 'Checked disabled'
+  = check_box_tag 'checked_disabled_name', 'value', checked, disabled: true
+
   - checked = false
   = label_tag 'unchecked_name', 'Unchecked'
   = check_box_tag 'unchecked_name', 'value', checked

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

@@ -69,3 +69,4 @@
 
   = label_tag 'enabled_radio_2', 'Enabled radio button #2'
   = radio_button_tag 'enabled_radio', '2', selected
+

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

@@ -3,6 +3,9 @@
   = label_tag 'text_control', 'Text control'
   = text_field_tag 'text_control', 'Text control value'
 
+  = label_tag 'disabled_text_control', 'Disabled text control'
+  = text_field_tag 'disabled_text_control', 'Disabled text control value', disabled: true
+
   = label_tag 'select_control', 'Select control'
   = select_tag 'select_control', options_for_select([['Label 1', 'value1'], ['Label 2', 'value2'], ['Label 3', 'value3']], 'value2')
 
@@ -26,4 +29,4 @@
   = label_tag 'radio_button_control_radio1', 'Radio 1'
   = radio_button_tag 'radio_button_control', 'radio1'
   = label_tag 'radio_button_control_radio2', 'Radio 2'
-  = radio_button_tag 'radio_button_control', 'radio2'
+  = radio_button_tag 'radio_button_control', 'radio2'

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

@@ -5,6 +5,9 @@
   .form-group.field_with_errors
     = label_tag 'textarea_control_1', 'B is invalid'
     = text_area_tag 'textarea_control_1', "Textarea control line 1\nTextarea control line 2\n"
+  .form-group.field_with_errors
+    = label_tag 'disabled_control', 'Disabled is invalid'
+    = text_field_tag 'disabled_control', "Disabled control value", disabled: true
   .form-group
     = label_tag 'textarea_control_2', 'C'
     = text_area_tag 'textarea_control_2', "Textarea control line 1\nTextarea control line 2\n"

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_linebreaks.html

@@ -0,0 +1,6 @@
+<p>
+Hello!
+</p>
+<p>
+Bye!
+</p>

data/tests/shared/config/routes.rb

@@ -6,8 +6,11 @@ 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'
+  get '/emails/send_html_email_with_linebreaks', to: 'emails#send_html_email_with_linebreaks'
 
   get '/forms/checkbox_form', to: 'forms#checkbox_form'
   get '/forms/disabled_elements', to: 'forms#disabled_elements'

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,73 +195,96 @@ 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 "[^"]+")+)$/
-    When I go to "/emails/send_email"
-
-    # Test with correct conditions
-    Then the following multiline step should succeed:
-      """
-      Then an email should have been sent from "from@example.com" to "to@example.com" cc "cc@example.com" bcc "bcc@example.com" and the subject "SUBJECT" and the attachments "attached_file.pdf"
-      """
-
-     # Test with wrong conditions
+    # Test body with to few paragraphs
     Then the following multiline step should fail:
       """
-      Then an email should have been sent from "from@example.com" to "to@example.com" cc "cc@example.com" bcc "wrong_bcc@example.com" and the subject "SUBJECT" and the attachments "attached_file.pdf"
-      """
-
-  Scenario: /^that e?mail should have the following lines in the body:$/
-    When I go to "/emails/send_email"
-
-    # Test with correct body lines
-    Then the following multiline step should succeed:
-      """
-      Then that email should have the following lines in the body:
+      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
         line
         '''
       """
 
-     # Test with wrong body lines
+    # Test body with wildcard not at the end of a line
     Then the following multiline step should fail:
       """
-      Then that email should have the following lines in the body:
+      Then an email should have been sent with:
         '''
-        wrong
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        Body
+        *th
         line
+        break
         '''
       """
 
+    When I clear my emails
+      And I go to "/emails/send_crlf_email"
 
-  Scenario: /^that e?mail should have the following( content in the)? body$/
-    When I go to "/emails/send_email"
-
-      # Test with correct body lines
     Then the following multiline step should succeed:
       """
-      Then that email should have the following content in the body:
+      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
         '''
       """
 
-       # Test with wrong body lines
-    Then the following multiline step should fail:
-      """
-      Then that email should have the following body:
+    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:
         '''
-        wrong
-        line
+        From: from@example.com
+        Reply-To: reply-to@example.com
+        To: to@example.com
+        Subject: SUBJECT
+
+        Viele Grüße
         '''
       """
 
+    When I clear my emails
+      And I go to "/emails/send_html_email_with_linebreaks"
+
+    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
+
+        Hello!
+        Bye!
+        '''
+      """
 
   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"