spreewald 2.99.3 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71f40dbc5a327e21940b95c4a4a9b1946e0c30b2090e3f46e927b81f3f44a18b
-  data.tar.gz: c464bee9033caa6ae2b32984058aa0e37128483a2aa299780e60297b5c81b7d4
+  metadata.gz: 6b97388391eda8359eab973a0a92896ee7d10e7fc4db749b7f22fb326eddf268
+  data.tar.gz: 77aea5e617594133107957b887d5f4848a91532fc46b835b1b5af07164f652e2
 SHA512:
-  metadata.gz: a927120e6558399206bbd0c97e08c7410f7af5e700b1756daa091e961f9407c237509496791d4dc8f58a7c3e74ab3b78a6b97bca2b1bffa1dc1824ebf999a040
-  data.tar.gz: 12964e9c67396df967c29d1fa3925b6e01f0d0ba747ed016d15fa1cbee2c02e8b71173f6cf57e953cec9ad0d3df7dba6caf71d253e54739e3444c1b22687c2ef
+  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,16 +3,57 @@ 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).
 
-## 2.99.3
-- Introduce wildcard for the beginning of a line. (see issue #155)
+## 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))
+
+## 3.0.2
+
+- Introduce wildcard for the beginning of a line. (see issue [#155](https://github.com/makandra/spreewald/issues/155))
   - This will allow you to check for a specific sentence inside the body
 
-## 2.99.2
+## 3.0.1
 
 - Fix deduplication of linebreaks for html mails in mail finder. (see issue [#153](https://github.com/makandra/spreewald/issues/153))
 
-## 2.99.1
+## 3.0.0
 
+### Breaking changes
+
+- The following steps have been removed:
+  - `/^the file "([^"]*)" was attached(?: as (?:([^"]*)\/)?([^"]*))? to the ([^"]*) above(?: at "([^"]*)")?$/` (see [#106](https://github.com/makandra/spreewald/issues/106), this functionality was moved to [CucumberFactory](https://github.com/makandra/cucumber_factory))
+  - `/^the "([^"]*)" field should have no error$/` (see [#134](https://github.com/makandra/spreewald/issues/134))
+  - `/^I should get a text response$/` (see [#135](https://github.com/makandra/spreewald/issues/135))
+  - `/^I wait for the page to load$/` (see [#136](https://github.com/makandra/spreewald/issues/136))
+  - `debugger` (was an alias for `console`)
+- These email steps have been removed in favor of `(an?|no)( HTML| plain-text|) e?mail should have been sent with:` (see [#132](https://github.com/makandra/spreewald/issues/132#issuecomment-631457290)):
+  - `/^(an|no) e?mail should have been sent((?: |and|with|from "[^"]+"|bcc "[^"]+"|cc "[^"]+"|to "[^"]+"|the subject "[^"]+"|the body "[^"]+"|the attachments "[^"]+")+)$/`
+  - `/^that e?mail should( not)? have the following lines in the body$/`
+  - `/^that e?mail should have the following (?:|content in the )body:$/`
+- The `and disabled` modifier of the step `the "..." checkbox should( not)? be checked` has been removed. Use the step without the modifier together with the step `the "..." checkbox should be disabled` to achieve the old behavior.
+- The step `/^(the tag )?"([^\"]+)" should( not)? be visible$/` lost its `not` modifier (Use `Then (the tag )?"..." should be hidden` or `Then I should not see "..."`)
+- The file `lib/spreewald/timecop_steps.rb` was removed (was an alias for `lib/spreewald/time_steps.rb`).
+- The step `(an?|no)( HTML| plain-text|) e?mail should have been sent with:` does now require that the whole body is matched.
+- All web steps interacting with forms will now find both enabled and disabled fields. We encourage you to assert the "disabled" state in a separate step when needed, Spreewald offers these steps as well.
+
+  The following steps have been adjusted:
+  - `I should( not)? see a field "..."`
+  - `the "..." field should( not)? contain "..."`
+  - `I should see a form with the following values:`
+  - `the "..." field should have the error "..."`
+  - `the "..." field should( not)? have an error`
+  - `the "..." checkbox should( not)? be checked`
+  - `"..." should be selected for "..."`
+  - `nothing should be selected for "..."`
+  - `"..." should( not)? be an option for "..."`
+  - `the "..." field should( not)? be visible`
+  - `the "..." select should( not)? be sorted`
+  
+### Compatible changes
 - Reintroduced support for emails with CRLF line ending
 
 ## 2.99.0

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
 
@@ -197,8 +197,7 @@ the step definitions.
 * **Then console**
 
   Pauses test execution and opens an IRB shell with current context. Does not halt the application-
-  under-test. (Replaces the "Then debugger" step that has never been adequate
-  for its job)
+  under-test.
 
 
 * **AfterStep @slow-motion**
@@ -238,10 +237,9 @@ the step definitions.
   
         """
   
-  Because of backwards-compatibility, the body currently only has to be a prefix
-  of the real body. However, this is deprecated and will be removed in a future
-  version. Use wildcards instead.
-  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**
@@ -269,11 +267,40 @@ the step definitions.
   This uses the same syntax as `Then an email should have been sent with:`
 
 
-### file_attachment_steps.rb 
+### frame_steps.rb 
 
-* **Given the file "..." was attached( as (.../)?...)? to the ... above( at "...")?**
+* **When ... inside the ... iframe**
 
-  This step is deprecated and will be removed from spreewald. If you still want to use it, copy the code to your project's own steps.
+  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 
@@ -330,8 +357,6 @@ Please note that the two approaches branch. While ActiveSupport will freeze the
       When it is a few hours earlier
 
 
-
-
 ### web_steps.rb 
 
 Most of cucumber-rails' original web steps plus a few of our own.
@@ -559,10 +584,7 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **Then the "..." field should( not)? have an error**
 
 
-* **Then the "..." field should have no error**
-
-
-* **Then the "..." checkbox should( not)? be checked( and disabled)?**
+* **Then the "..." checkbox should( not)? be checked?**
 
 
 * **Then the radio button "..." should( not)? be (checked|selected)**
@@ -615,14 +637,12 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **When I reload the page**
 
 
-* **Then (the tag )?"..." should( not)? be visible**
+* **Then (the tag )?"..." should be visible**
 
   Checks that an element is actually present and visible, also considering styles.
   Within a selenium test, the browser is asked whether the element is really visible
   In a non-selenium test, we only check for `.hidden`, `.invisible` or `style: display:none`
   
-  The step 'Then (the tag )?"..." should **not** be visible' is ambiguous. Please use 'Then (the tag )?"..." should be hidden' or 'Then I should not see "..."' instead. Note that the **not** option will be removed in future versions of Spreewald.
-  
   More details [here](https://makandracards.com/makandra/1049-capybara-check-that-a-page-element-is-hidden-via-css)
 
 
@@ -675,11 +695,6 @@ deprecation notice. Decide for yourself whether you want to use them:
          got: "http://makandra.com/" (using =~)
 
 
-* **Then I should get a text response**
-
-  Checks that the result has content type `text/plain`
-
-
 * **When I follow "..." inside any "..."**
 
   Click a link within an element matching the given selector. Will try to be clever
@@ -715,13 +730,6 @@ deprecation notice. Decide for yourself whether you want to use them:
   Tests that a field with the given label is visible.
 
 
-* **When I wait for the page to load**
-
-  Waits for the page to finish loading and AJAX requests to finish.
-  
-  More details [here](https://makandracards.com/makandra/12139-waiting-for-page-loads-and-ajax-requests-to-finish-with-capybara).
-
-
 * **When I perform basic authentication as ".../..." and go to ...**
 
   Performs HTTP basic authentication with the given credentials and visits the given path.

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