spreewald 4.6.1 → 4.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 256b5e48d9fcbb9c845bc5f8503475a10184d2356f5483307100b43c7ae1a504
-  data.tar.gz: 9374a61e063de94a0b240b24c8f48b292f95d87adc285b9893b3bc2a3d725c2d
+  metadata.gz: f21efaeee956e332f09bf91655335cfc24bcf5f5a46403c11ea6fa4d2f390b25
+  data.tar.gz: '09cae0432a1190dbfc515456705b6977ca4320c688e46ee5e1307a8ca07f9f69'
 SHA512:
-  metadata.gz: 934b5123e15812171d3d3dd1cf9f477024ac8f217b612ac85d6cf165afbd535fb2fd052755e52d389804c1f2b4222bce2c59259dfea1af771d367352e6d1baa8
-  data.tar.gz: 837aa75e2071c48ccca0855746d86c1f4a205be84d15ba8a4c569036f56f51fb940700c1cdf362f253a66acb96b29e467e9353255ec6244501ce9cff1c9df6a8
+  metadata.gz: 295f1e8f0ea1b1b544d622005e020b8ba168eb27612077d55a58613162eb4ee65c0e32ba287ddef7f0fc58408817f48c3093e9b6c8ff94603076de3878ceccfc
+  data.tar.gz: d7ab22c6640d44c85c5b18f7c9e1028194eadd284d872aedf8ed56c64423a2e0409e8e545b2fbacf782d89ef219292797a5dc7a583494dcd5ce54c7bb7790399

data/CHANGELOG.md

@@ -3,6 +3,12 @@ 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).
 
+## 4.6.3
+- Fix email steps not showing the attachments 
+
+## 4.6.2
+- Fix uninitialized constant `XPath::HTML` when using `When I fill in "..." with "..." inside any "..."` ([#210](https://github.com/makandra/spreewald/issues/210))
+
 ## 4.6.1
 - Fix undefined method `irb_at_exit` in new IRB versions ([#208](https://github.com/makandra/spreewald/pull/208))
 

data/Gemfile.ruby266.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spreewald (4.6.1)
+    spreewald (4.6.3)
       capybara
       cucumber
       cucumber_priority (>= 0.3.0)

data/Gemfile.ruby320.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spreewald (4.6.1)
+    spreewald (4.6.3)
       capybara
       cucumber
       cucumber_priority (>= 0.3.0)

data/README.md

@@ -211,6 +211,10 @@ the step definitions.
 
 ### email_steps.rb 
 
+  When specifying the `to`, `cc`, `bcc`, `from` or `reply_to` targets within email steps, you can either specify email addresses or any arbitrary identifier. When an identifier (other than an email address) is given, Spreewald can try to use this information to determine the associated user and gather its email address automatically over the application's `User` model. For this, you may set `Spreewald::MailFinder.user_identity` to an attribute name and Spreewald will call `User.find_by_<user_identity>(identifier)` and then use the `email` of the found user.<br/>
+
+  For example, if you set `reply_to` to the name `John Doe` within a scenario step and specify `Spreewald::MailFinder.user_identity = 'name'`, Spreewald will call `User.find_by_name('John Doe')`, find the according user with this name and expect its email address as `reply_to`.
+
 * **When I clear my e?mails**
 
 
@@ -568,7 +572,11 @@ deprecation notice. Decide for yourself whether you want to use them:
 
 * **Then the "..." field should have the error "..."**
 
-  Checks that an input field was wrapped with a validation error
+  Checks that an input field was wrapped with a validation error. This is done by checking for different error HTML structures that display errors.<br/><br/>
+
+  Spreewald first checks for custom error wrappers (if specified), then Boostrap 3 error wrappers (`.form-group.has-error`), then Bootstrap 4/5 error wrappers (`:invalid` or `is-invalid`) and lastly, Rails error wrappers (`field_with_errors`). You are able to specify a custom error wrapper by setting `Spreewald.field_error_class = 'my-custom-error-class'` which is then used to look for the error class on the current or any ancestor `div`.<br /><br />
+
+  The same principle applies for matching the error message. First, it will look for the message text (starting from the input element) with a custom XPath (if specified), then one targeting a sibling element with a `help-block` class for Bootstrap 3 and then one targeting a sibling element with an `invalid-feedback` class for Bootstrap 4/5. Rails errors are checked specifically over the field title as this one contains the error message. You may specify the custom XPath by setting (e.g.) `Spreewald.error_message_xpath_selector = 'parent::*/child::*[@class="my-error-message"]'`.
 
 
 * **Then the "..." field should( not)? have an error**

data/lib/spreewald/web_steps.rb

@@ -620,7 +620,9 @@ When /^I fill in "([^"]*)" with "([^"]*)" inside any "([^"]*)"$/ do |field, valu
   containers = all(:css, selector)
   input = nil
   containers.detect do |container|
-    input = container.first(:xpath, XPath::HTML.fillable_field(field))
+    input = container.first(:fillable_field, field)
+  rescue Capybara::ElementNotFound
+    # Capybara changed the behavior of #first and raises an error when the first container finds no matching field
   end
   if input
     input.set(value)

data/lib/spreewald_support/mail_finder.rb

@@ -24,7 +24,6 @@ class MailFinder
         body = [header, body].join("\n\n")
       end
 
-      filename_method = Rails::VERSION::MAJOR < 3 ? 'original_filename' : 'filename'
       matching_header = ActionMailer::Base.deliveries.select do |mail|
         [ conditions[:to].nil? || mail.to.include?(resolve_email conditions[:to]),
           conditions[:cc].nil? || mail.cc && mail.cc.include?(resolve_email conditions[:cc]),
@@ -32,7 +31,7 @@ class MailFinder
           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[:attachments].nil? || conditions[:attachments].split(/\s*,\s*/).sort == Array(mail.attachments).collect(&:"#{filename_method}").sort
+          conditions[:attachments].nil? || conditions[:attachments].split(/\s*,\s*/).sort == attachment_filenames(mail)
         ].all?
       end
 
@@ -64,6 +63,9 @@ class MailFinder
       header << "CC: #{mail.cc.join(', ')}\n" if mail.cc
       header << "BCC: #{mail.bcc.join(', ')}\n" if mail.bcc
       header << "Subject: #{mail.subject}\n"
+      header << "Attachments: #{attachment_filenames(mail).join(', ')}\n" if mail.attachments.any?
+
+      header
     end
 
     def email_text_body(mail, type = '')
@@ -94,6 +96,12 @@ class MailFinder
       Regexp.new(expected)
     end
 
+    private
+
+    def attachment_filenames(mail)
+      Array(mail.attachments).collect(&:filename).sort
+    end
+
   end
 end
 

data/lib/spreewald_support/version.rb

@@ -1,3 +1,3 @@
 module Spreewald
-  VERSION = '4.6.1'
+  VERSION = '4.6.3'
 end

data/spec/steps/show_me_the_mails_spec.rb

@@ -93,4 +93,26 @@ describe Spreewald::Steps::ShowMeTheMails do
       expect { step.run }.to output(expected_output).to_stdout
     end
   end
+
+  context "with attachments" do
+    it 'includes the filenames of the attachments' do
+      mail = Mail.new do
+        attachments['attached_file.pdf'] = File.open("tests/shared/public/fixture_files/attachment.pdf") {}
+        attachments['other_attached_file.pdf'] = File.open("tests/shared/public/fixture_files/attachment.pdf") {}
+      end
+
+      expected_output = <<~TXT
+        E-Mail #0
+        --------------------------------------------------------------------------------
+        From: 
+        Subject: 
+        Attachments: attached_file.pdf, other_attached_file.pdf
+        --------------------------------------------------------------------------------
+
+      TXT
+      step = Spreewald::Steps::ShowMeTheMails.new([mail], true)
+      expect { step.run }.to output(expected_output).to_stdout
+    end
+  end
+
 end

data/tests/rails-7_capybara-3/.ruby-version

@@ -1 +1 @@
-3.0.0
+3.2.0

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

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (4.6.1)
+    spreewald (4.6.3)
       capybara
       cucumber
       cucumber_priority (>= 0.3.0)

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

@@ -67,14 +67,7 @@ class EmailsController < ApplicationController
   private
 
   def deliver(method_name)
-    case
-    when Rails.version.to_i >= 5
-      SpreewaldMailer.send(method_name).deliver
-    when Rails.version.to_i >= 3
-      Mailer.public_send(method_name).deliver
-    else
-      Mailer.public_send("deliver_#{method_name}")
-    end
+    SpreewaldMailer.send(method_name).deliver
   end
 
 end

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

@@ -12,6 +12,9 @@ class FormsController < ApplicationController
   def form2
   end
 
+  def form_with_two_inputs_in_separate_css_blocks_with_the_same_selector
+  end
+
   def select_fields
   end
 

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

@@ -7,113 +7,60 @@ class Mailer < ActionMailer::Base
   FROM = "from@example.com"
   SUBJECT = "SUBJECT"
 
-  if Rails.version >= "3"
-
-    def email
-      attachments['attached_file.pdf'] = File.open("#{Rails.root}/public/fixture_files/attachment.pdf", "w") {}
-      mail(
-        :from => FROM,
-        :reply_to => REPLY_TO,
-        :to => TO,
-        :cc => CC,
-        :bcc => BCC,
-        :subject => SUBJECT
-      )
-    end
-
-    def email_crlf
-      email
-    end
-
-    def email_with_umlauts
-      email
-    end
-
-    def html_email_with_links
-      email
-    end
-
-    def text_email_with_links
-      email
-    end
-
-    def html_email_with_linebreaks
-      email
-    end
-
-    def html_email_with_specific_line
-      email
-    end
-
-    def text_email_with_specific_line
-      email
-    end
-
-    def html_email_for_successful_test_without_header
-      email
-    end
-
-    def text_email_for_successful_test_without_header
-      email
-    end
-
-    def html_email_for_failed_test_without_header
-      email
-    end
-
-    def text_email_for_failed_test_without_header
-      email
-    end
-
-  else
+  def email
+    attachments['attached_file.pdf'] = File.open("#{Rails.root}/public/fixture_files/attachment.pdf") {}
+    mail(
+      :from => FROM,
+      :reply_to => REPLY_TO,
+      :to => TO,
+      :cc => CC,
+      :bcc => BCC,
+      :subject => SUBJECT
+    )
+  end
 
-    def email
-      attachments['attached_file.pdf'] = File.open("#{Rails.root}/public/fixture_files/attachment.pdf", "w") {}
-      recipients TO
-      reply_to REPLY_TO
-      from FROM
-      cc CC
-      bcc BCC
-      subject SUBJECT
-      body BODY
-    end
+  def email_crlf
+    email
+  end
 
-    def email_crlf
-      email
-    end
+  def email_with_umlauts
+    email
+  end
 
-    def html_email_with_links
-      email
-    end
+  def html_email_with_links
+    email
+  end
 
-    def text_email_with_links
-      email
-    end
+  def text_email_with_links
+    email
+  end
 
-    def html_email_with_specific_line
-      email
-    end
+  def html_email_with_linebreaks
+    email
+  end
 
-    def text_email_with_specific_line
-      email
-    end
+  def html_email_with_specific_line
+    email
+  end
 
-    def html_email_for_successful_test_without_header
-      email
-    end
+  def text_email_with_specific_line
+    email
+  end
 
-    def text_email_for_successful_test_without_header
-      email
-    end
+  def html_email_for_successful_test_without_header
+    email
+  end
 
-    def html_email_for_failed_test_without_header
-      email
-    end
+  def text_email_for_successful_test_without_header
+    email
+  end
 
-    def text_email_for_failed_test_without_header
-      email
-    end
+  def html_email_for_failed_test_without_header
+    email
+  end
 
+  def text_email_for_failed_test_without_header
+    email
   end
 
 end

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

@@ -0,0 +1,8 @@
+= form_tag do
+  .my-container
+    = label_tag 'first_text_field', 'First Text field'
+    = text_field_tag 'first_text_field', 'First value'
+
+  .my-container
+    = label_tag 'second_text_field', 'Second Text field'
+    = text_field_tag 'second_text_field', 'Second value'

data/tests/shared/config/routes.rb

@@ -22,6 +22,7 @@ Rails.application.routes.draw do
   get '/forms/disabled_elements', to: 'forms#disabled_elements'
   get '/forms/form1', to: 'forms#form1'
   get '/forms/form2', to: 'forms#form2'
+  get '/forms/form_with_two_inputs_in_separate_css_blocks_with_the_same_selector', to: 'forms#form_with_two_inputs_in_separate_css_blocks_with_the_same_selector'
   get '/forms/select_fields', to: 'forms#select_fields'
   get '/forms/invalid_rails_form', to: 'forms#invalid_rails_form'
   get '/forms/invalid_bootstrap3_form', to: 'forms#invalid_bootstrap3_form'

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

@@ -297,6 +297,24 @@ Feature: Test Spreewald's email steps
         '''
       """
 
+    Then the following multiline step should succeed:
+      """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Attachments: attached_file.pdf
+        '''
+      """
+
+    Then the following multiline step should fail:
+      """
+      Then an email should have been sent with:
+        '''
+        From: from@example.com
+        Attachments: not_attached_file.pdf
+        '''
+      """
+
     When I clear my emails
       And I go to "/emails/send_crlf_email"
 

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

@@ -416,3 +416,13 @@ Feature: Web steps
   Scenario: /^the window should be titled "([^"]*)"$/
     When I go to "/static_pages/home"
     Then the window should be titled "spreewald test application"
+
+
+  Scenario: I fill in "..." with "..." inside any "..."
+    When I go to "/forms/form_with_two_inputs_in_separate_css_blocks_with_the_same_selector"
+    Then the "First Text field" field should contain "First value"
+      And the "Second Text field" field should contain "Second value"
+
+    When I fill in "Second Text field" with "My new value" inside any ".my-container"
+    Then the "First Text field" field should contain "First value"
+      And the "Second Text field" field should contain "My new value"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spreewald
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.6.3
 platform: ruby
 authors:
 - Tobias Kraze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-25 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -225,6 +225,7 @@ files:
 - tests/shared/app/views/forms/disabled_elements.html.haml
 - tests/shared/app/views/forms/form1.html.haml
 - tests/shared/app/views/forms/form2.html.haml
+- tests/shared/app/views/forms/form_with_two_inputs_in_separate_css_blocks_with_the_same_selector.html.haml
 - tests/shared/app/views/forms/invalid_bootstrap3_form.html.haml
 - tests/shared/app/views/forms/invalid_bootstrap4_form.html.haml
 - tests/shared/app/views/forms/invalid_custom_form.html.haml
@@ -315,7 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Collection of useful cucumber steps.
@@ -394,6 +395,7 @@ test_files:
 - tests/shared/app/views/forms/disabled_elements.html.haml
 - tests/shared/app/views/forms/form1.html.haml
 - tests/shared/app/views/forms/form2.html.haml
+- tests/shared/app/views/forms/form_with_two_inputs_in_separate_css_blocks_with_the_same_selector.html.haml
 - tests/shared/app/views/forms/invalid_bootstrap3_form.html.haml
 - tests/shared/app/views/forms/invalid_bootstrap4_form.html.haml
 - tests/shared/app/views/forms/invalid_custom_form.html.haml