spreewald 3.0.2 → 4.1.2

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/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

@@ -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,20 +1,29 @@
 # 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
 
+      # Interpret all lines as body if there are no header-link lines
+      if conditions.blank?
+        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]),
@@ -58,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)

data/lib/spreewald_support/mail_to_plaintext_converter.rb

@@ -0,0 +1,42 @@
+require 'nokogiri'
+
+module Spreewald
+  class MailToPlaintextConverter
+    def initialize(mail, type = '')
+      @mail = mail
+      @type = type
+    end
+  
+    def run
+      body = ''
+      if mail.multipart?
+        body = if mail.html_part && type != 'plain-text'
+          text_from_html(mail.html_part.body.to_s)
+        elsif mail.text_part && type != 'HTML'
+          mail.text_part.body.to_s
+        else
+          mail.body.to_s
+        end
+      else
+        if body_text_html?
+          body = text_from_html(mail.body.to_s)
+        else
+          body = mail.body.to_s
+        end
+      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
+  
+    private
+  
+    attr_reader :mail, :type
+  
+    def body_text_html?
+      mail.body.to_s.include? "<html>"
+    end
+  
+    def text_from_html(html)
+      Nokogiri::HTML(html).at_css('body').text.gsub(/[\r\n]+/, "\n")
+    end
+  end
+end

data/lib/spreewald_support/unsupported_email_header.rb

@@ -0,0 +1,22 @@
+module Spreewald
+  SUPPORTED_EMAIL_HEADERS = ["To", "CC", "BCC", "From", "Reply-To", "Subject", "Attachments"]
+
+  class UnsupportedEmailHeader < StandardError
+    attr_reader :header, :value
+
+    def initialize(header, value)
+      @header, @value = header, value
+      error_message = <<-MESSAGE.strip_heredoc
+        It looks like you're trying to match against an unsupported header "#{header}".
+        The following headers are supported: #{supported_headers_list}
+      MESSAGE
+      super(error_message)
+    end
+
+    private
+
+    def supported_headers_list
+      SUPPORTED_EMAIL_HEADERS.join(", ")
+    end
+  end
+end

data/lib/spreewald_support/version.rb

@@ -1,3 +1,3 @@
 module Spreewald
-  VERSION = '3.0.2'
+  VERSION = '4.1.2'
 end

data/spec/spreewald_support/mail_to_plaintext_converter_spec.rb

@@ -0,0 +1,60 @@
+require "spreewald_support/mail_to_plaintext_converter"
+require "mail"
+
+describe Spreewald::MailToPlaintextConverter do
+  describe '#run' do
+    context 'with multipart email' do
+      let(:multipart_email) do
+        Mail.new do
+          text_part do
+            body "email text part"
+          end
+
+          html_part do
+            body "<html><body><p>html email text</p></body></html>"
+          end
+        end
+      end
+
+      it 'uses the html part as source as default' do
+        output = Spreewald::MailToPlaintextConverter.new(multipart_email).run
+        expect(output).to eq 'html email text'
+      end
+
+      it 'uses the text part as source if specified as type' do
+        output = Spreewald::MailToPlaintextConverter.new(multipart_email, 'plain-text').run
+        expect(output).to eq 'email text part'
+      end
+
+      it 'uses the html part as source if specified as type' do
+        output = Spreewald::MailToPlaintextConverter.new(multipart_email, 'HTML').run
+        expect(output).to eq 'html email text'
+      end
+    end
+
+    context 'without multipart email' do
+      it 'recognizes the plaintext' do
+        plaintext_email = Mail.new(body: 'Hello RSpec')
+        output = Spreewald::MailToPlaintextConverter.new(plaintext_email).run
+        expect(output).to eq 'Hello RSpec'
+      end
+
+      it 'recognizes html content' do
+        plaintext_email = Mail.new(body: <<-HTML)
+        <html><body><p>this is html!</p></body></html>
+        HTML
+        output = Spreewald::MailToPlaintextConverter.new(plaintext_email).run
+        expect(output).to eq 'this is html!'
+      end
+
+      it 'recognizes multiple paragraph content' do
+        plaintext_email = Mail.new(body: <<~HTML)
+        <html><body><p>this is line1</p>
+        <p>this is line2</p></body></html>
+        HTML
+        output = Spreewald::MailToPlaintextConverter.new(plaintext_email).run
+        expect(output).to eq "this is line1\nthis is line2"
+      end
+    end
+  end
+end

data/tests/{rails-4_capybara-3 → rails-4_capybara-2}/Gemfile

@@ -14,7 +14,7 @@ end
 
 group :test do
   gem 'database_cleaner'
-  gem 'capybara', "~>3"
+  gem 'capybara', '<3'
   gem 'capybara-screenshot'
   gem 'cucumber-rails', require: false
   gem 'cucumber'

data/tests/{rails-4_capybara-3 → rails-4_capybara-2}/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (3.0.2)
+    spreewald (4.1.2)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)
@@ -43,20 +43,19 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     arel (6.0.4)
     backports (3.12.0)
     builder (3.2.3)
     byebug (10.0.2)
-    capybara (3.14.0)
+    capybara (2.18.0)
       addressable
       mini_mime (>= 0.1.3)
-      nokogiri (~> 1.8)
-      rack (>= 1.6.0)
-      rack-test (>= 0.6.3)
-      regexp_parser (~> 1.2)
-      xpath (~> 3.2)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (>= 2.0, < 4.0)
     capybara-screenshot (1.0.22)
       capybara (>= 1.0, < 4)
       launchy
@@ -93,7 +92,7 @@ GEM
     diff-lcs (1.3)
     erubis (2.7.0)
     ffi (1.10.0)
-    gemika (0.3.4)
+    gemika (0.5.0)
     gherkin (5.1.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
@@ -124,18 +123,18 @@ GEM
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2018.0812)
-    mini_mime (1.0.1)
+    mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
     multi_json (1.13.1)
     multi_test (0.1.2)
-    nokogiri (1.10.1)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.0.3)
-    rack (1.6.12)
+    public_suffix (4.0.6)
+    rack (1.6.13)
     rack-test (0.6.3)
       rack (>= 1.0)
     rails (4.2.11)
@@ -163,7 +162,6 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (12.3.2)
-    regexp_parser (1.3.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -214,7 +212,7 @@ PLATFORMS
 
 DEPENDENCIES
   byebug
-  capybara (~> 3)
+  capybara (< 3)
   capybara-screenshot
   cucumber
   cucumber-rails
@@ -229,4 +227,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   1.17.3
+   2.2.4