spreewald 3.0.3 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a51defb2267ab0f0f6e9123b474e0069758e59eaa3f18cadefdfdb81a5f5760
-  data.tar.gz: f47297c29b676ee194c1dbc2f335eab608afefa9730e124e8811d4542089031e
+  metadata.gz: 6b97388391eda8359eab973a0a92896ee7d10e7fc4db749b7f22fb326eddf268
+  data.tar.gz: 77aea5e617594133107957b887d5f4848a91532fc46b835b1b5af07164f652e2
 SHA512:
-  metadata.gz: 3b93c18acce9d744364898f65e6f3597d06b37ed85d69bb81e3593521d0433bc56338b974c32133c0fce749190ee8af63c146b355e12601397b3641d4424380d
-  data.tar.gz: b675ad24c9c6e9836880d9111f1538d8f3b5c2d91e390dc5ee5165842cb19298d039fa428405dd47df20daa40b59234f641fcc3e4cab2cf0f6405449ecad981c
+  metadata.gz: 43272a84d5e31da1f22426ef84908591696765e4ca394a7ac85ad1d87ffa194aefb7169a104743c162f79b4ab4e9048966c760a51741be2e78d29d3263a3760a
+  data.tar.gz: 4bb7a38423937d4b5675dfdff73c3309632d7400152389b9e0617f178be076cd156234e7519faa71f97df7bc90a386c5cd87858cb9a96e6ea1c1f163c468dd30

data/.github/workflows/test.yml

@@ -0,0 +1,40 @@
+---
+name: Tests
+'on':
+  push:
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        # Test projects
+        - ruby: 2.4.5
+          gemfile: tests/rails-4_capybara-2/Gemfile
+        - ruby: 2.6.6
+          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
+    env:
+      BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "${{ matrix.ruby }}"
+    - name: Bundle
+      run: |
+        gem install bundler:1.17.3
+        bundle install --no-deployment
+    - name: Run tests
+      run: bundle exec rake matrix:single_test[${{ matrix.gemfile }},${{ matrix.ruby }}]

data/CHANGELOG.md

@@ -3,6 +3,10 @@ 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.0.0
+
+- Dropped support for capybara 1, Ruby 2.1 and Rails 3.2. 
+
 ## 3.0.3
 
 - The `an email should have been sent with` step now interprets all lines as body when not specifying headers (see issue [#157](https://github.com/makandra/spreewald/issues/157))

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
 gem 'rake'
-gem 'gemika'
+gem 'gemika'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    gemika (0.4.0)
+    gemika (0.5.0)
     rake (12.3.2)
 
 PLATFORMS
@@ -12,4 +12,4 @@ DEPENDENCIES
   rake
 
 BUNDLED WITH
-   1.17.3
+   2.2.14

data/Gemfile.ruby245

@@ -1,7 +1,10 @@
 source 'https://rubygems.org'
 
+gem 'rake'
 gem 'rspec'
 gem 'cucumber'
 gem 'aruba'
 
 gem 'gemika'
+gem 'mail'
+gem 'nokogiri'

data/Gemfile.ruby245.lock

@@ -31,10 +31,16 @@ GEM
     cucumber-wire (0.0.1)
     diff-lcs (1.3)
     ffi (1.10.0)
-    gemika (0.3.4)
+    gemika (0.5.0)
     gherkin (5.1.0)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
     multi_json (1.13.1)
     multi_test (0.1.2)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
     rake (12.3.2)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -58,6 +64,9 @@ DEPENDENCIES
   aruba
   cucumber
   gemika
+  mail
+  nokogiri
+  rake
   rspec
 
 BUNDLED WITH

data/Gemfile.ruby266

@@ -2,8 +2,11 @@ source 'https://rubygems.org'
 
 ruby '2.6.6'
 
+gem 'rake'
 gem 'rspec'
 gem 'cucumber'
 gem 'aruba'
 
 gem 'gemika'
+gem 'mail'
+gem 'nokogiri'

data/Gemfile.ruby266.lock

@@ -30,10 +30,17 @@ GEM
     cucumber-wire (0.0.1)
     diff-lcs (1.3)
     ffi (1.12.2)
-    gemika (0.4.0)
+    gemika (0.5.0)
     gherkin (5.1.0)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    mini_mime (1.0.2)
     multi_json (1.14.1)
     multi_test (0.1.2)
+    nokogiri (1.11.1-x86_64-linux)
+      racc (~> 1.4)
+    racc (1.5.2)
+    rake (13.0.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -56,10 +63,13 @@ DEPENDENCIES
   aruba
   cucumber
   gemika
+  mail
+  nokogiri
+  rake
   rspec
 
 RUBY VERSION
    ruby 2.6.6p146
 
 BUNDLED WITH
-   2.1.4
+   2.2.14

data/README.md

@@ -19,9 +19,9 @@ Or install it yourself as:
     $ gem install spreewald
 
 
-## Supported RSpec versions
+## Supported versions
 
-Spreewald supports RSpec >= 2.13.0
+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.
 
 ## Usage
 
@@ -237,7 +237,9 @@ the step definitions.
   
         """
   
-  You may skip lines in the header, of course.
+  You may skip lines in the header.
+  Please note: In older versions of Spreewald, unmentioned body lines were skipped.
+  Now you have to use the asterisk explicitly to omit lines in the body.
 
 
 * **When I follow the (first|second|third)? link in the e?mail**
@@ -265,6 +267,42 @@ the step definitions.
   This uses the same syntax as `Then an email should have been sent with:`
 
 
+### frame_steps.rb 
+
+* **When ... inside the ... iframe**
+
+  You can append `inside the [name or number] iframe` to any other step.
+  Then the step will operate inside the given iframe.
+  Examples:
+  
+      Then I should see "Kiwi" inside the 1st iframe
+      Then I should see "Cherry" inside the fruits iframe
+      When I press "Save" inside the 2nd iframe
+
+
+
+* **When I switch to the ... iframe**
+
+  This step will switch to the iframe identified by its name or number.
+  All further steps will operate inside the iframe.
+  To switch to operating on the main page again, use the step
+  "I switch back to the whole page".
+  Examples:
+  
+      When I switch to the 1st iframe
+      When I switch to the fruits iframe
+  
+  Please note: This step is only available for Capybara >= 3.
+
+
+* **When I switch back to the whole page**
+
+  This step can be used to switch back to the whole page if you switched
+  to operating inside an iframe before (step `I switch to the ... iframe`)
+  
+  Please note: This step is only available for Capybara >= 3.
+
+
 ### session_steps.rb 
 
 * **When ... in the browser session "..."**

data/Rakefile

@@ -10,28 +10,25 @@ end
 task :default => 'matrix:tests'
 
 namespace :matrix do
+  desc 'Run tests for a single row of the matrix'
+  task :single_test, [:gemfile, :ruby] do |_t, args|
+    gemfile = args[:gemfile]
+    ruby = args[:ruby]
 
-  desc "Run all tests which are available for current Ruby (#{RUBY_VERSION})"
-  task :tests do
-    Gemika::Matrix.from_travis_yml.each do |row|
-      directory = File.dirname(row.gemfile)
-      if directory.start_with?('tests')
-        # Run integration tests (uses embedded projects)
-        system(cucumber_command(directory, row.ruby))
-      else
-        # Run specs and tests for spreewald binary
-        [
-          system("BUNDLE_GEMFILE=#{row.gemfile} bundle exec rspec"),
-          system("BUNDLE_GEMFILE=#{row.gemfile} bundle exec cucumber"),
-        ].all?
-      end
+    if gemfile.nil? || ruby.nil?
+      warn 'Please state the Gemfile and Ruby version to be used for the Testrun!'
+    else
+      run_tests(gemfile, ruby)
     end
-
-    travis_yml = YAML.load_file('.travis.yml')
-    rubies = travis_yml.fetch('rvm') - [RUBY_VERSION]
-    puts "Please remember to run tests for the other ruby versions as well: #{rubies.join(", ")}"
   end
 
+
+  desc "Run all tests which are available for current Ruby (#{RUBY_VERSION})"
+  task :tests, [:gemfile, :ruby] do |_t, args|
+    Gemika::Matrix.from_ci_config.each do |row|
+      run_tests(row.gemfile, row.ruby)
+    end
+  end
 end
 
 
@@ -59,12 +56,30 @@ task :update_readme do
   puts '', '> Done (diff applied).'
 end
 
+def run_tests(gemfile, ruby)
+  directory = File.dirname(gemfile)
+  if directory.start_with?('tests')
+    # Run integration tests (uses embedded projects)
+    system(cucumber_command(directory, ruby))
+  else
+    # Run specs and integration tests for Spreewald binary
+    [
+      system("BUNDLE_GEMFILE=#{gemfile} bundle exec rspec"),
+      system("BUNDLE_GEMFILE=#{gemfile} bundle exec cucumber"),
+    ].all?
+  end
+end
+
 def cucumber_command(directory, ruby_version)
-  command = "cd #{directory} && BUNDLE_GEMFILE=Gemfile geordi cucumber"
+  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
 end

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 3."
+    Then the output should contain /Spreewald \d./
 
     When I run `spreewald -v`
-    Then the output should contain "Spreewald 3."
+    Then the output should contain /Spreewald \d./

data/features/support/step_definitions/custom_steps.rb

@@ -0,0 +1,10 @@
+Then /^the output should( not)? contain \/(.*)\/$/ do |negated, regexp|
+  output = all_commands.map { |c| c.output }.join("\n")
+  regexp = Regexp.new(regexp)
+
+  if negated
+    expect(output).not_to match(regexp)
+  else
+    expect(output).to match(regexp)
+  end
+end

data/lib/spreewald.rb

@@ -3,3 +3,4 @@
 require 'cucumber_priority'
 require "spreewald_support/version"
 require "spreewald_support/github"
+require "spreewald_support/unsupported_email_header"

data/lib/spreewald/email_steps.rb

@@ -30,7 +30,9 @@ end.overridable
 #
 #       """
 #
-# You may skip lines in the header, of course.
+# You may skip lines in the header.
+# Please note: In older versions of Spreewald, unmentioned body lines were skipped.
+# Now you have to use the asterisk explicitly to omit lines in the body.
 Then /^(an?|no)( HTML| plain-text|) e?mail should have been sent with:$/ do |mode, type, raw_data|
   patiently do
     results = MailFinder.find(raw_data, type.strip)

data/lib/spreewald/frame_steps.rb

@@ -0,0 +1,77 @@
+# You can append `inside the [name or number] iframe` to any other step.
+# Then the step will operate inside the given iframe.
+# Examples:
+#
+#     Then I should see "Kiwi" inside the 1st iframe
+#     Then I should see "Cherry" inside the fruits iframe
+#     When I press "Save" inside the 2nd iframe
+#
+When /^(.*?) inside the (.*?) iframe$/ do |nested_step, frame_identifier|
+  patiently do
+    frame = find_frame(frame_identifier)
+    page.within_frame(frame) do
+      step nested_step
+    end
+  end
+end.overridable
+
+# nodoc
+When /^(.*?) inside the (.*?) iframe:$/ do |nested_step, frame_identifier, table_or_string|
+  patiently do
+    frame = find_frame(frame_identifier)
+    page.within_frame(frame) do
+      step("#{nested_step}:", table_or_string)
+    end
+  end
+end.overridable
+
+if Gem::Version.new(Capybara::VERSION) >= Gem::Version.new('3')
+
+  # This step will switch to the iframe identified by its name or number.
+  # All further steps will operate inside the iframe.
+  # To switch to operating on the main page again, use the step
+  # "I switch back to the whole page".
+  # Examples:
+  #
+  #     When I switch to the 1st iframe
+  #     When I switch to the fruits iframe
+  #
+  # Please note: This step is only available for Capybara >= 3.
+  When /^I switch to the (.*?) iframe$/ do |frame_identifier|
+    frame = find_frame(frame_identifier)
+    page.driver.switch_to_frame(frame)
+  end.overridable
+
+  # This step can be used to switch back to the whole page if you switched
+  # to operating inside an iframe before (step `I switch to the ... iframe`).
+  #
+  # Please note: This step is only available for Capybara >= 3.
+  When /^I switch back to the whole page$/ do
+    handle = page.driver.current_window_handle
+    page.driver.switch_to_window(handle)
+  end
+end
+
+module IframeStepsHelper
+  def find_frame(frame_identifier)
+    frame_id = convert_frame_identifier(frame_identifier)
+    case frame_id
+    when Integer
+      frames = page.find_all('iframe')
+      frames[frame_id]
+    when String
+      page.find("iframe[name='#{frame_id}']")
+    end
+  end
+
+  def convert_frame_identifier(frame_identifier)
+    number_regex = /\A(?<number>\d+)(st|nd|rd|th|\.)\z/
+    matches = frame_identifier.match(number_regex)
+    if matches && matches[:number]
+      matches[:number].to_i - 1 # selenium starts counting a 0
+    else
+      frame_identifier
+    end
+  end
+end
+World(IframeStepsHelper)

data/lib/spreewald_support/mail_finder.rb

@@ -1,16 +1,20 @@
 # coding: UTF-8
+require "spreewald_support/mail_to_plaintext_converter"
+require "forwardable"
 
 class MailFinder
+
   class << self
 
     attr_accessor :user_identity
 
     def find(raw_data, type = '')
-      header, body = raw_data.split(/\n\n/, 2) # 2: maximum number of fields
+      header, body = raw_data.split(/\n\n/, 2).map(&:strip_heredoc) # 2: maximum number of fields
       conditions = {}
       header.split("\n").each do |row|
         if row.match(/^[A-Za-z\-]+: /i)
           key, value = row.split(": ", 2)
+          raise Spreewald::UnsupportedEmailHeader.new(key, value) unless Spreewald::SUPPORTED_EMAIL_HEADERS.include? key.strip
           conditions[key.strip.underscore.to_sym] = value.strip
         end
       end
@@ -63,15 +67,7 @@ class MailFinder
     end
 
     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.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.
+      Spreewald::MailToPlaintextConverter.new(mail, type).run
     end
 
     def show_mails(mails, only_header = false)