spreewald 4.1.0 → 4.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b97388391eda8359eab973a0a92896ee7d10e7fc4db749b7f22fb326eddf268
-  data.tar.gz: 77aea5e617594133107957b887d5f4848a91532fc46b835b1b5af07164f652e2
+  metadata.gz: 9d3a85d0ee7a8a0ebd403ef168a1788a21ce14dd3b3966aa431b1d0481f25e05
+  data.tar.gz: f68eb3cecf0e1792fada9ec58a664f6d8652fb700ebd07cee9a9789c260690a4
 SHA512:
-  metadata.gz: 43272a84d5e31da1f22426ef84908591696765e4ca394a7ac85ad1d87ffa194aefb7169a104743c162f79b4ab4e9048966c760a51741be2e78d29d3263a3760a
-  data.tar.gz: 4bb7a38423937d4b5675dfdff73c3309632d7400152389b9e0617f178be076cd156234e7519faa71f97df7bc90a386c5cd87858cb9a96e6ea1c1f163c468dd30
+  metadata.gz: 8276a0f55cfbdab771e028d05117291ce3cff8ad082e66a8a6828805392ae7e36c26240033fa6f9e37e1de25f2c6c9ff6f5a3a6c7f8b4b16210a1287819a5cf8
+  data.tar.gz: 35d84f7231336eb6edf2e44c91d128b6ebb38a2f7c0119906c0df9f29f94f41d5f2b5ba51532156fd465533adfa8fbc061ce824d9f90b433a0c20ee50fc76d01

data/.github/workflows/test.yml

@@ -14,16 +14,13 @@ jobs:
       fail-fast: false
       matrix:
         include:
-        # Test projects
-        - ruby: 2.4.5
-          gemfile: tests/rails-4_capybara-2/Gemfile
-        - ruby: 2.6.6
+        - ruby: 3.0.0
           gemfile: tests/rails-6_capybara-3/Gemfile
         # Used to run rspec and integration tests for spreewald binary:
-        - ruby: 2.4.5
-          gemfile: Gemfile.ruby245
         - ruby: 2.6.6
           gemfile: Gemfile.ruby266
+        - ruby: 3.0.0
+          gemfile: Gemfile.ruby300
     env:
       BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
     steps:

data/.ruby-version

@@ -1 +1 @@
-2.4.5
+3.0.0

data/CHANGELOG.md

@@ -3,6 +3,33 @@ 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.2.2
+- Fixes the "Show me the email" step (#171)
+- Fixes the "I follow the link in the email" step. (#172, #173)
+  - It works for emails with and without explicit html parts
+  - There's a better error message if no links are found
+
+## 4.1.2
+- Multiple invocations of console don't raise anymore
+
+## 4.1.1
+- The step `I open .. in a new browser tab` is now using the `noopener` option (see issue [#174])
+
+## 4.1.0
+
+- New steps:
+  - When ... inside the ... iframe
+
+- New steps only available for Capybara 3+:
+  - When I switch to the ... iframe
+  - When I switch back to the whole page
+  - The I switch back to the whole page step does not work reliably with Capybara 2 and lead to StaleReferenceErrors, therefore we decided to not make these steps available for Capybara 2.
+
+- Small improvements:
+  - Trying to match against unsupported email headers will raise an error. Supported headers are "To", "CC", "BCC", "From", "Reply-To", "Subject", "Attachments"
+  - It's now possible to have indented header lines in email steps.
+  - If there's not an explicit text part in a mail, Spreewald determines if the email body is HTML or plaintext and converts it to plaintext accordingly.
+
 ## 4.0.0
 
 - Dropped support for capybara 1, Ruby 2.1 and Rails 3.2. 

data/Gemfile.lock

@@ -12,4 +12,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   2.2.14
+   2.2.3

data/{Gemfile.ruby245 → Gemfile.ruby300}

@@ -1,5 +1,7 @@
 source 'https://rubygems.org'
 
+ruby '3.0.0'
+
 gem 'rake'
 gem 'rspec'
 gem 'cucumber'

data/Gemfile.ruby300.lock

@@ -0,0 +1,108 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    aruba (1.0.4)
+      childprocess (>= 2.0, < 5.0)
+      contracts (~> 0.16.0)
+      cucumber (>= 2.4, < 6.0)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
+    builder (3.2.4)
+    childprocess (4.0.0)
+    concurrent-ruby (1.1.8)
+    contracts (0.16.0)
+    cucumber (5.3.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-core (~> 8.0, >= 8.0.1)
+      cucumber-create-meta (~> 2.0, >= 2.0.2)
+      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
+      cucumber-gherkin (~> 15.0, >= 15.0.2)
+      cucumber-html-formatter (~> 9.0, >= 9.0.0)
+      cucumber-messages (~> 13.1, >= 13.1.0)
+      cucumber-wire (~> 4.0, >= 4.0.1)
+      diff-lcs (~> 1.4, >= 1.4.4)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-core (8.0.1)
+      cucumber-gherkin (~> 15.0, >= 15.0.2)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+      cucumber-tag-expressions (~> 2.0, >= 2.0.4)
+    cucumber-create-meta (2.0.4)
+      cucumber-messages (~> 13.1, >= 13.1.0)
+      sys-uname (~> 1.2, >= 1.2.1)
+    cucumber-cucumber-expressions (10.3.0)
+    cucumber-gherkin (15.0.2)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    cucumber-html-formatter (9.0.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    cucumber-messages (13.2.1)
+      protobuf-cucumber (~> 3.10, >= 3.10.8)
+    cucumber-tag-expressions (2.0.4)
+    cucumber-wire (4.0.1)
+      cucumber-core (~> 8.0, >= 8.0.1)
+      cucumber-cucumber-expressions (~> 10.3, >= 10.3.0)
+      cucumber-messages (~> 13.0, >= 13.0.1)
+    diff-lcs (1.4.4)
+    ffi (1.15.0)
+    gemika (0.5.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    middleware (0.1.0)
+    mini_mime (1.0.3)
+    minitest (5.14.4)
+    multi_test (0.1.2)
+    nokogiri (1.11.2-x86_64-linux)
+      racc (~> 1.4)
+    protobuf-cucumber (3.10.8)
+      activesupport (>= 3.2)
+      middleware
+      thor
+      thread_safe
+    racc (1.5.2)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    thor (1.1.0)
+    thread_safe (0.3.6)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  aruba
+  cucumber
+  gemika
+  mail
+  nokogiri
+  rake
+  rspec
+
+RUBY VERSION
+   ruby 3.0.0p0
+
+BUNDLED WITH
+   2.2.3

data/README.md

@@ -21,7 +21,7 @@ Or install it yourself as:
 
 ## Supported versions
 
-Spreewald is currently tested against Ruby 2.4.5 with Rails 4 and Capybara 2 and Ruby 2.6.6 with Rails 6 and Capybara 3.
+Spreewald is currently tested against and Ruby 2.6.6 with Rails 6 and Capybara 3.
 
 ## Usage
 

data/Rakefile

@@ -65,22 +65,14 @@ def run_tests(gemfile, ruby)
     # Run specs and integration tests for Spreewald binary
     [
       system("BUNDLE_GEMFILE=#{gemfile} bundle exec rspec"),
-      system("BUNDLE_GEMFILE=#{gemfile} bundle exec cucumber"),
+      system("BUNDLE_GEMFILE=#{gemfile} bundle exec cucumber --publish-quiet"),
     ].all?
   end
 end
 
 def cucumber_command(directory, ruby_version)
-  command = "cd #{directory} && BUNDLE_GEMFILE=Gemfile bundle exec cucumber"
-  if Gem::Version.new(ruby_version) > Gem::Version.new('2.5')
-    # Modern cucumber sees pending tests as failures.
-    # We don't want this.
-    command << ' --no-strict-pending'
-  else
-    # Ruby < 2.5 means the capybara 2 Test project.
-    # Omit scenarios that only work with modern Capybara.
-    command << ' --tags "not @not-capybara-2"'
-  end
+  command = "cd #{directory} && BUNDLE_GEMFILE=Gemfile bundle exec cucumber --publish-quiet"
+  command << ' --no-strict-pending'
   command
 end
 

data/lib/spreewald/browser_tab_steps.rb

@@ -19,7 +19,7 @@ When /^I open (.+?) in a new browser tab$/ do |page_name|
   previous_handles_count = browser.window_handles.size
   relative_target_path = path_to(page_name)
 
-  page.execute_script "window.open('#{relative_target_path}', '_blank')"
+  page.execute_script "window.open('#{relative_target_path}', '_blank', 'noopener')"
   step "there should be #{previous_handles_count + 1} browser tabs"
   step "I switch to the new browser tab"
 end.overridable

data/lib/spreewald/development_steps.rb

@@ -11,11 +11,6 @@ Then 'console' do
   require 'irb'
   ARGV.clear # IRB takes ARGV as its own arguments
 
-  # `source` is defined by Capybara as a shortcut to `page.source`. IRB tries to
-  # create an alias with the same name and fails with a warning. To avoid this,
-  # we remove the alias here.
-  undef :source
-
   # We adapted the steps of IRB.run
   # https://github.com/ruby/ruby/blob/c08f7b80889b531865e74bc5f573df8fa27f2088/lib/irb.rb#L418
   # with injected workspace. See https://github.com/makandra/spreewald/issues/77 for reasons.
@@ -24,6 +19,11 @@ Then 'console' do
   # "already initialized constant" warnings
   unless IRB.conf[:LOAD_MODULES]
     IRB.setup(nil)
+
+    # `source` is defined by Capybara as a shortcut to `page.source`. IRB tries to
+    # create an alias with the same name and fails with a warning. To avoid this,
+    # we remove the alias here.
+    undef :source
   end
 
   workspace = IRB::WorkSpace.new(binding)

data/lib/spreewald/email_steps.rb

@@ -1,6 +1,8 @@
 # coding: UTF-8
 
 require 'spreewald_support/mail_finder'
+require 'steps/show_me_the_mails'
+require 'steps/follow_the_link'
 
 Before do
   ActionMailer::Base.deliveries.clear
@@ -73,18 +75,7 @@ end.overridable
 # 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]
-  url_pattern = %r((?:https?://[^/]+)([^"'\s]+))
-
-  paths = if mail.html_part
-    dom = Nokogiri::HTML(mail.html_part.body.to_s)
-    (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)
-  end
-
-  visit paths[index]
+  Spreewald::Steps::FollowTheLink.new(mail, index_in_words).run
 end.overridable
 
 Then /^no e?mail should have been sent$/ do
@@ -98,12 +89,7 @@ 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
-
+  Spreewald::Steps::ShowMeTheMails.new(ActionMailer::Base.deliveries, only_header).run
 end.overridable
 
 # Print a subset of all sent emails to STDOUT

data/lib/spreewald_support/version.rb

@@ -1,3 +1,3 @@
 module Spreewald
-  VERSION = '4.1.0'
+  VERSION = '4.2.3'
 end

data/lib/steps/follow_the_link.rb

@@ -0,0 +1,63 @@
+module Spreewald
+  module Steps
+    class FollowTheLink
+      class NoVisitableLinkFound < StandardError
+        def initialize(paths, index)
+          error_message = <<~MESSAGE
+            Could not follow the #{index} link in the email.
+          MESSAGE
+          if paths&.empty?
+            error_message << "Found no link paths in the email."
+          else
+            error_message << "Found these link paths in the email: #{paths.join(', ')}"
+          end
+          super(error_message)
+        end
+      end
+
+      URL_PATTERN = %r((?:https?://[^/]+)([^"'\s]+))
+
+      def initialize(mail, index_in_words)
+        @mail = mail
+        @index_in_words = index_in_words
+      end
+
+      def run
+        index = { nil => 0, 'first' => 0, 'second' => 1, 'third' => 2 }[@index_in_words]
+
+        paths = if @mail.html_part || body_text_html?
+          search_for_links_in_html
+        else
+          search_for_links_in_plaintext
+        end
+
+        if paths[index]
+          visit_path paths[index]
+        else
+          raise NoVisitableLinkFound.new(paths, @index_in_words) unless paths[index]
+        end
+      end
+
+      private
+
+      def visit_path(path)
+        Capybara.visit(path)
+      end
+
+      def body_text_html?
+        @mail.body.to_s.include? "<html>"
+      end
+
+      def search_for_links_in_html
+        body = @mail.html_part ? @mail.html_part.body : @mail.body
+        dom = Nokogiri::HTML(body.to_s)
+        (dom / 'a[href]').map { |a| a['href'].match(URL_PATTERN) }.compact.map { |match| match[1] }
+      end
+
+      def search_for_links_in_plaintext
+        mail_body = MailFinder.email_text_body(@mail).to_s
+        mail_body.scan(URL_PATTERN).flatten(1)
+      end
+    end
+  end
+end

data/lib/steps/show_me_the_mails.rb

@@ -0,0 +1,20 @@
+require 'spreewald_support/mail_finder'
+
+module Spreewald
+  module Steps
+    class ShowMeTheMails
+      def initialize(mails, only_header = false)
+        @mails = mails
+        @only_header = only_header
+      end
+
+      def run
+        if @mails.empty?
+          puts "No emails found"
+        else
+          puts MailFinder.show_mails(@mails, @only_header)
+        end
+      end
+    end
+  end
+end

data/spec/steps/follow_the_link_spec.rb

@@ -0,0 +1,81 @@
+require "steps/follow_the_link"
+
+describe Spreewald::Steps::FollowTheLink do
+  it "raises helpful error message if no link is found" do
+    mail_without_links = Mail.new do
+      html_part do
+        body "<html><body>no link</body></html>"
+      end
+
+      text_part do
+        body "no link either"
+      end
+    end
+
+    step = ->() { Spreewald::Steps::FollowTheLink.new(mail_without_links, "first").run }
+    expect(step).to raise_error Spreewald::Steps::FollowTheLink::NoVisitableLinkFound
+  end
+
+  it "finds links in multipart html email" do
+    mail = Mail.new do
+      html_part do
+        body "<html><body><a href='https://www.example.com/abc'>a link</a><a href='https://www.example.com/def'>second link</a></body></html>"
+      end
+
+      text_part do
+        body "no link here"
+      end
+    end
+
+    step = Spreewald::Steps::FollowTheLink.new(mail, "first") 
+    expect(step).to receive(:visit_path).with("/abc")
+    step.run
+  end
+
+  it "finds the second link in a multipart html email" do
+    mail = Mail.new do
+      html_part do
+        body "<html><body><a href='https://www.example.com/abc'>a link</a><a href='https://www.example.com/def'>second link</a></body></html>"
+      end
+
+      text_part do
+        body "no link here"
+      end
+    end
+
+    step = Spreewald::Steps::FollowTheLink.new(mail, "second") 
+    expect(step).to receive(:visit_path).with("/def")
+    step.run
+  end
+
+  it "finds links in html email" do
+    mail = Mail.new do
+      text_part do
+        body "my link: https://www.example.com/abc"
+      end
+    end
+
+    step = Spreewald::Steps::FollowTheLink.new(mail, "first") 
+    expect(step).to receive(:visit_path).with("/abc")
+    step.run
+  end
+
+  it "finds links in non multipart text emails" do
+    plaintext_email = Mail.new(body: 'a link: https://www.example.com/abc')
+    step = Spreewald::Steps::FollowTheLink.new(plaintext_email, "first") 
+
+    expect(step).to receive(:visit_path).with("/abc")
+    step.run
+  end
+
+  it "finds links in non multipart html emails" do
+    html_mail = Mail.new(body: <<-HTML)
+    <html><body><a href="https://www.example.com/abc">this is a link!</a></body></html>
+    HTML
+    step = Spreewald::Steps::FollowTheLink.new(html_mail, "first") 
+
+    expect(step).to receive(:visit_path).with("/abc")
+    step.run
+  end
+end
+