spreewald 2.2.4 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 722a4a8f8f3355dddbbd3abd5df49ba0316c1b57
-  data.tar.gz: 694c570012da6abd82412c1160342a6c09ebf80d
+SHA256:
+  metadata.gz: 782da77b76273a09876285f8cc37e9855cec78b891ae80fdff94413d0b0747d1
+  data.tar.gz: 3c85f3a589f466b48d2fce57b99a8bdb468c5672628becba955c69ded5cb642d
 SHA512:
-  metadata.gz: d88a0c8e05b5542bdb58eb49954e96d2c15df249110bd548619292015b2c1fc815fc24366c474f0e91c13405c62e6f1b1e992478eaf5ff5cbd2acead55e8f0fc
-  data.tar.gz: 30942d57ee1f144a0afad41c1eafc5b132128109a2e0cf25afa3738b17c5233a1222f1feefbc383a41fa5af041c11e9d6ed9c2c1f399c1a2a3ec0ef596c3f53e
+  metadata.gz: 07de3d07cc658fbbc41f8441d897cbae26f5e2a03de17e159fbad72739f237ac20c3c762e9ab1a56a12d0a61b503a38fc9c49eb16c00481aad63bd267414f3a9
+  data.tar.gz: 22c6e544d8555dc5ef1978a8de23595e183ef3288c2fe90006229db5ded468e89f0308998428ee84d437b7810bdc9f79ba7c081dce3e4ed1677573554b7efa3f

data/.gitignore

@@ -11,4 +11,4 @@ InstalledFiles
 tmp
 _yardoc
 *.log
-tests/shared/db/test.sqlite3
+tests/shared/db/*.sqlite3

data/.travis.yml

@@ -6,25 +6,24 @@ language: ruby
 rvm:
   - 2.1.8
   - 2.4.5
-
-gemfile:
-  # Test projects
-  - tests/rails-3_capybara-1/Gemfile
-  - tests/rails-3_capybara-2/Gemfile
-  - tests/rails-4_capybara-3/Gemfile
-  # Used to run rspec and tests for spreewald binary:
-  - Gemfile.ruby218
-  - Gemfile.ruby245
+  - 2.6.6
 
 matrix:
-  exclude:
+  include:
+    # Test projects
     - gemfile: tests/rails-3_capybara-1/Gemfile
-      rvm: 2.4.5
+      rvm: 2.1.8
     - gemfile: tests/rails-3_capybara-2/Gemfile
-      rvm: 2.4.5
-    - gemfile: tests/rails-4_capybara-3/Gemfile
       rvm: 2.1.8
-    - gemfile: Gemfile.ruby218
+    - gemfile: tests/rails-4_capybara-3/Gemfile
       rvm: 2.4.5
-    - gemfile: Gemfile.ruby245
+    - gemfile: tests/rails-6_capybara-3/Gemfile
+      rvm: 2.6.6
+    # Used to run rspec and tests for spreewald binary:
+    - gemfile: Gemfile.ruby218
       rvm: 2.1.8
+    - gemfile: Gemfile.ruby245
+      rvm: 2.4.5
+    - gemfile: Gemfile.ruby266
+      rvm: 2.6.6
+

data/CHANGELOG.md

@@ -3,9 +3,41 @@ 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.6.0
+- The time steps do now work with the time helpers in ActiveSupport 4.1+ if the timecop gem is not included in the bundle. Please note that the two approaches branch. While ActiveSupport will freeze the time, Timecop will keep it running.
+- The steps in the file `spreewald/timecop.rb` file were moved to `spreewald/time.rb` and importing `spreewald/timecop` directly is deprecated now.
+
+
+## 2.5.0
+- Add a set of steps to control browser tabs (Selenium only):
+  * `I open ... in a new browser tab`
+  * `I close the browser tab`
+  * `I switch to the new browser tab`
+  * `I switch to the previous browser tab`
+  * `I may open a new browser tab` (required for the following step)
+  * `I should( not)? have opened a new browser tab`
+  * `there should be (\d+) browser tabs?`
+  * `there should be at least (\d+) browser tabs?`
+
+## 2.4.2
+- Fix the step `I should( not)? see a link labeled "STRING"`, it is now overridable.
+
+## 2.4.1
+
+- Adapt `I should get a download with filename "..."` step to also work if the `filename` is not the last attribute in `Content-Disposition` header.
+
+## 2.4.0
+
+- Fix "I follow the ... link in the email" step for HTML e-mails to only follow URLs from `<a href="...">` links.
+
+## 2.3.0
+- Deprecate two steps:
+  - (Given) the file ... was attached to the ... above
+  - (Then) debugger
+
 ## 2.2.4
 - Fix "..." field should have the error "..." test by removing old should syntax
-- Add single-line mail step to READNE
+- Add single-line mail step to README
 
 ## 2.2.3
 - Fix 'the window should be titled' step - closes: [#102](https://github.com/makandra/spreewald/issues/102)
@@ -25,7 +57,7 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## 2.2.0
 - Add a new step `I should( not)? see a link labeled "STRING"`.
-- Refer to Capybara 3's new flag `Capybara.default_normalize_ws = true` in the READNE,
+- Refer to Capybara 3's new flag `Capybara.default_normalize_ws = true` in the README,
 
 ## 2.1.3
 The `I should(not )? see /REGEXP/` step no longer refuses slashes as part of the regular expression. You can thus match full domains and more.

data/Gemfile

@@ -1,5 +1,4 @@
 source 'https://rubygems.org'
 
 gem 'rake'
-gem 'gemika'
-gem 'rspec', '>=2.14.0'
+gem 'gemika'

data/Gemfile.lock

@@ -1,22 +1,8 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    gemika (0.3.4)
+    gemika (0.4.0)
     rake (12.3.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
 
 PLATFORMS
   ruby
@@ -24,7 +10,6 @@ PLATFORMS
 DEPENDENCIES
   gemika
   rake
-  rspec (>= 2.14.0)
 
 BUNDLED WITH
    1.17.3

data/Gemfile.ruby266

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+ruby '2.6.6'
+
+gem 'rspec'
+gem 'cucumber'
+gem 'aruba'
+
+gem 'gemika'

data/Gemfile.ruby266.lock

@@ -0,0 +1,65 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (1.0.0)
+      childprocess (~> 3.0)
+      contracts (~> 0.16.0)
+      cucumber (>= 2.4, < 4.0)
+      ffi (~> 1.9)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
+    backports (3.17.0)
+    builder (3.2.4)
+    childprocess (3.0.0)
+    contracts (0.16.0)
+    cucumber (3.1.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 3.2.0)
+      cucumber-expressions (~> 6.0.1)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (~> 1.3)
+      gherkin (~> 5.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (3.2.1)
+      backports (>= 3.8.0)
+      cucumber-tag_expressions (~> 1.1.0)
+      gherkin (~> 5.0)
+    cucumber-expressions (6.0.1)
+    cucumber-tag_expressions (1.1.1)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    ffi (1.12.2)
+    gemika (0.4.0)
+    gherkin (5.1.0)
+    multi_json (1.14.1)
+    multi_test (0.1.2)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thor (1.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  cucumber
+  gemika
+  rspec
+
+RUBY VERSION
+   ruby 2.6.6p146
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -38,6 +38,7 @@ single files like this:
     require 'spreewald/email_steps'
     require 'spreewald/web_steps'
 
+Have a look at our [recommended Capybara defaults](#recommended-capybara-defaults) as they impact the behavior of many Spreewald steps.
 
 ## Spreewald binary
 
@@ -83,7 +84,7 @@ More info [here](https://makandracards.com/makandra/12139-waiting-for-page-load-
 Thanks to [cucumber_priority](https://github.com/makandra/cucumber_priority) you can override any step definition from Spreewald with your own pattern. Cucumber will not raise `Cucumber::Ambiguous` if your custom steps collide with a Spreewald step.
 
 
-## A note on Capybara 3
+## Recommended Capybara defaults
 
 If you are upgrading from Capybara 2 to Capybara 3, you might [see failing tests](https://github.com/makandra/spreewald/issues/95) with Spreewald steps like `I should see`. This is caused by a breaking change in [Capybara's Finders](https://www.rubydoc.info/github/jnicklas/capybara/Capybara/Node/Finders) that accept a `:text` option. To activate Capybara 2 behavior globally in your project, enable this flag:
 
@@ -93,6 +94,17 @@ Capybara.default_normalize_ws = true
 
 This will affect all Spreewald steps that are using Capybara's `:text` option.
 
+Furthermore, we recommend setting [Capybara's matching strategy](https://github.com/teamcapybara/capybara/blob/master/README.md#strategy) to `:prefer_exact`. This will positively affect Spreewald steps as it prevents the `Capybara::Ambiguous` error in the edge case when two fields are matching the given name, but one of the matches includes the name only as a substring,
+
+```ruby
+Capybara.match = :prefer_exact
+````
+
+If you want Spreewald to match fields, links and buttons against the `aria-label` attribute, enable the following global configuration in Capybara 2.8+: 
+
+```ruby
+Capybara.enable_aria_label = true
+```
 
 ## Contributing
 
@@ -127,6 +139,54 @@ the step definitions.
 
 ## Steps
 
+### browser_tab_steps.rb 
+
+* **When I open ... in a new browser tab**
+
+  Opens [the page](https://github.com/makandra/spreewald/blob/master/examples/paths.rb) in a new browser tab and switches to it.
+
+
+* **When I close the browser tab**
+
+  Closes the current browser tab and switches back to the first tab.
+
+
+* **When I switch to the new(ly opened)? browser tab**
+
+  Waits for the new browser tab to appear, then switches to it.
+
+
+* **When I switch( back)? to the previous browser tab**
+
+  Changes the browser context to the second-last browser tab.
+
+
+* **When I may open a new browser tab**
+
+  Required for the check whether a new browser tab was opened or not.
+
+
+* **Then I should( not)? have opened a new browser tab**
+
+  Example (positive expectation):
+  
+      When I may open a new browser tab
+        And I click on "Open link in new browser tab"
+      Then I should have opened a new browser tab
+  
+  Example (negative expectation):
+  
+      When I may open a new browser tab
+        And I click on "Open link in current browser tab"
+      Then I should not have opened a new browser tab
+
+
+* **Then there should be (\d+) browser tabs?**
+
+
+* **Then there should be at least (\d+) browser tabs?**
+
+
 ### development_steps.rb 
 
 * **Then it should work...?**
@@ -141,14 +201,14 @@ the step definitions.
   for its job)
 
 
-* **AfterStep @slow**
+* **AfterStep @slow-motion**
 
   Waits 2 seconds after each step
 
 
-* **AfterStep @single**
+* **AfterStep @single-step**
 
-  Waits for keypress after each step
+  Waits for a keypress after each step
 
 
 ### email_steps.rb 
@@ -223,27 +283,7 @@ the step definitions.
 
 * **Given the file "..." was attached( as (.../)?...)? to the ... above( at "...")?**
 
-  Attach a file to the given model's last record.
-  
-  Example (Company has a `file` attribute):
-  
-      Given the file "image.png" was attached to the company above
-  
-  You may specify the attribute under which the file is stored …
-  
-  Example (Company has a `logo` attribute):
-  
-      Given the file "image.png" was attached as logo to the company above
-  
-  … or both a container class and its attribute name
-  
-  Example (Company has many `Image`s, `Image` has a `file` attribute)
-  
-      Given the file "image.png" was attached as Image/file to the company above
-  
-  To simultaneously set the `updated_at` timestamp:
-  
-      Given the file "some_file" was attached to the profile above at "2011-11-11 11:11"
+  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.
 
 
 ### table_steps.rb 
@@ -255,11 +295,14 @@ the step definitions.
   See [this article](https://makandracards.com/makandra/763-cucumber-step-to-match-table-rows-with-capybara) for details.
 
 
-### timecop_steps.rb 
+### time_steps.rb 
+
+Steps to travel through time
 
-Steps to travel through time using [Timecop](https://github.com/jtrupiano/timecop).
+This uses [Timecop](https://github.com/jtrupiano/timecop) or Active Support 4.1+ to stub Time.now / Time.current.
+The user is responsible for including one of the two gems.
 
-See [this article](https://makandracards.com/makandra/1222-useful-cucumber-steps-to-travel-through-time-with-timecop) for details.
+Please note that the two approaches branch. While ActiveSupport will freeze the time, Timecop will keep it running.
 
 
 * **When the (date|time) is "?(\d{4}-\d{2}-\d{2}( \d{1,2}:\d{2})?)"?**
@@ -277,7 +320,7 @@ See [this article](https://makandracards.com/makandra/1222-useful-cucumber-steps
       Given the time is 13:40
 
 
-* **When it is (\d+|a|some|a few) (seconds?|minutes?|hours?|days?|weeks?|months?|years?) (later|earlier)**
+* **When it is (\d+|an?|some|a few) (seconds?|minutes?|hours?|days?|weeks?|months?|years?) (later|earlier)**
 
   Example:
   
@@ -285,6 +328,8 @@ See [this article](https://makandracards.com/makandra/1222-useful-cucumber-steps
       When it is a few hours earlier
 
 
+
+
 ### web_steps.rb 
 
 Most of cucumber-rails' original web steps plus a few of our own.
@@ -313,7 +358,7 @@ deprecation notice. Decide for yourself whether you want to use them:
 
 * **When ... within ...**
 
-  You can append `within [selector]` to any other web step.
+  You can append `within [selector]` to any other web step, even multiple times.
   Be aware that within will only look at the first element that matches.
   If this is a problem for you following links, you might want to have a look
   at the 'When I follow "..." inside any "..."'-step.
@@ -574,7 +619,7 @@ deprecation notice. Decide for yourself whether you want to use them:
   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.
+  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)
 
@@ -658,9 +703,6 @@ deprecation notice. Decide for yourself whether you want to use them:
 * **When I enter "..." into the browser dialog**
 
 
-* **When I switch to the new tab**
-
-
 * **Then the "..." (field|button|checkbox) should( not)? be disabled**
 
   Tests that an input, button or checkbox with the given label is disabled.

data/Rakefile

@@ -1,5 +1,5 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 begin
   require 'gemika/tasks'
@@ -17,7 +17,7 @@ namespace :matrix do
       directory = File.dirname(row.gemfile)
       if directory.start_with?('tests')
         # Run integration tests (uses embedded projects)
-        system("cd #{directory} && BUNDLE_GEMFILE=Gemfile geordi cucumber")
+        system(cucumber_command(directory, row.ruby))
       else
         # Run specs and tests for spreewald binary
         [
@@ -44,16 +44,31 @@ task :update_readme do
     require 'support/step_manager'
   end
 
-  readme = File.read('README.md')
-  start_of_steps_section = readme =~ /^## Steps/
-  length_of_steps_section = (readme[(start_of_steps_section+1)..-1] =~ /^##[^#]/) || readme.size - start_of_steps_section
-  readme[start_of_steps_section, length_of_steps_section] = "## Steps\n\n" + StepManager.new('lib/spreewald').to_markdown
-  File.open(readme_path, 'w') { |f| f.write(readme) }
+  readme = File.read(readme_path)
+  File.open(readme_path, 'w') do |file|
+    start_of_steps_section = readme =~ /^## Steps/
+    length_of_steps_section = readme[(start_of_steps_section+1)..-1] =~ /^##[^#]/
+    length_of_steps_section ||= readme.size - start_of_steps_section
+    step_documentation = StepManager.new('lib/spreewald').to_markdown
+    readme[start_of_steps_section, length_of_steps_section] = "## Steps\n\n#{step_documentation}"
+
+    file.write(readme)
+  end
 
   system "git diff #{readme_path}"
   puts '', '> Done (diff applied).'
 end
 
+def cucumber_command(directory, ruby_version)
+  command = "cd #{directory} && BUNDLE_GEMFILE=Gemfile geordi 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'
+  end
+  command
+end
+
 def warn(text)
   puts "\e[31m#{text}\e[0m" # red text
 end