spreewald 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c226a047c194764d7645b43c70ab3b07d1a3e7a0d609a4e87dd8baab8e3c3a88
-  data.tar.gz: ecdfa9f9aa7fe19da7bc3a8e2f7852a80d4d397f4342e873fe89a32276c9f9d0
+  metadata.gz: 1168c34206078cc51317c0b55250cd4413120277f76dd08207e33ab0ad14defb
+  data.tar.gz: 203c60be6904e5fbd56cc114a9e2b2bcc08cb50be8fa2f30159ef0a8041b4d6f
 SHA512:
-  metadata.gz: d2e322bb7fb70096255ade88045b40408f0d1b0899120f159ea5831b65a40bc5a4d7d2bfb0b9b9ede7ba3f7b8aca0a904129076c7c49cafc7c6780bcd0e329d1
-  data.tar.gz: 190918ee162ba71606593416c1ae87f1f963a92f316f10f0c7c50f6a3217c7bc1670ccd1412372faa75504d4c0bbff98bd7dd49b88470a3ee162f477052fff5b
+  metadata.gz: 17930b95e19e14be451f87fc2ebf13877b1b377f57a15a29f8d7feba1bcfbbd0f35405c107db24a3955e2741070f91fba5e77c6c4ff0f66199b46aee9a9cbd9c
+  data.tar.gz: 95584eefb31f7b90a6b9c49ec9bc9930aed8bead0fc4930075af317c9a5dd9131291d8f59b8696f30d409b77779fe8dcfdadf04dfe113344eba6374116523e8b

data/CHANGELOG.md

@@ -3,8 +3,19 @@ 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.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.
+- Fix the step `I should( not)? see a link labeled "STRING"`, it is now overridable.
 
 ## 2.4.1
 

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:
 
@@ -99,6 +100,12 @@ Furthermore, we recommend setting [Capybara's matching strategy](https://github.
 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
 
 ### Testing
@@ -132,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...?**
@@ -146,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 
@@ -643,9 +698,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

@@ -44,11 +44,16 @@ 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).'

data/lib/spreewald/browser_tab_steps.rb

@@ -0,0 +1,91 @@
+Before do
+  @previous_browser_tabs_count = nil
+end
+
+# Close all but the first browser tab
+After do
+  next unless selenium_driver?
+
+  browser.switch_to.window(browser.window_handles.last)
+  while browser.window_handles.size > 1 do
+    browser.close
+    browser.switch_to.window(browser.window_handles.last)
+  end
+end
+
+# Opens [the page](https://github.com/makandra/spreewald/blob/master/examples/paths.rb) in a new browser tab and switches to it.
+When /^I open (.+?) in a new browser tab$/ do |page_name|
+  require_selenium!
+  previous_handles_count = browser.window_handles.size
+  relative_target_path = path_to(page_name)
+
+  page.execute_script "window.open('#{relative_target_path}', '_blank')"
+  step "there should be #{previous_handles_count + 1} browser tabs"
+  step "I switch to the new browser tab"
+end.overridable
+
+# Closes the current browser tab and switches back to the first tab.
+When 'I close the browser tab' do
+  require_selenium!
+  # Wait for browser tab to close
+  previous_handles_count = browser.window_handles.size
+  raise 'Cannot close the last remaining browser tab' if previous_handles_count == 1
+
+  browser.close
+  step "there should be #{previous_handles_count - 1} browser tabs"
+
+  # Closing the current tab causes Selenium to continue using a stale invalid tab handle
+  browser.switch_to.window(browser.window_handles.first)
+end.overridable
+
+# Waits for the new browser tab to appear, then switches to it.
+When /^I switch to the new(?:ly opened)? browser tab$/ do
+  require_selenium!
+  step 'there should be at least 2 browser tabs'
+  browser.switch_to.window(browser.window_handles.last)
+end.overridable
+
+# Changes the browser context to the second-last browser tab.
+When /^I switch(?: back)? to the previous browser tab$/ do
+  require_selenium!
+  previous_handle = browser.window_handles[-2] # Second last should be the previous browser tab
+  previous_handle ||= browser.window_handles.first # Fall back if only one tab is left
+  browser.switch_to.window(previous_handle)
+end.overridable
+
+# Required for the check whether a new browser tab was opened or not.
+When 'I may open a new browser tab' do
+  @previous_browser_tabs_count = browser.window_handles.size
+end.overridable
+
+# 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 /^I should( not)? have opened a new browser tab$/ do |negate|
+  raise "you need to use the 'I may open a new tab' step beforehand" unless @previous_browser_tabs_count
+  expected_browser_tab_count = negate ? @previous_browser_tabs_count : (@previous_browser_tabs_count + 1)
+
+  step "there should be #{expected_browser_tab_count} browser tabs"
+end.overridable
+
+Then /^there should be (\d+) browser tabs?$/ do |expected_browser_tabs|
+  patiently do
+    actual_browser_tabs = browser.window_handles.size
+    expect(actual_browser_tabs).to eq(expected_browser_tabs.to_i), "Expected #{expected_browser_tabs} browser tab to be open, but found #{actual_browser_tabs}"
+  end
+end.overridable
+
+Then /^there should be at least (\d+) browser tabs?$/ do |expected_browser_tabs|
+  patiently do
+    actual_browser_tabs = browser.window_handles.size
+    expect(actual_browser_tabs).to be >= (expected_browser_tabs.to_i), "Expected at least #{expected_browser_tabs} browser tab to be open, but found #{actual_browser_tabs}"
+  end
+end.overridable

data/lib/spreewald/development_steps.rb

@@ -57,7 +57,7 @@ AfterStep('@slow-motion') do
   sleep 2
 end
 
-# Waits for keypress after each step
+# Waits for a keypress after each step
 AfterStep('@single-step') do
   print "Single Stepping. Hit enter to continue"
   STDIN.getc

data/lib/spreewald/web_steps.rb

@@ -641,32 +641,24 @@ end.overridable
 
 When /^I confirm the browser dialog$/ do
   patiently do
-    page.driver.browser.switch_to.alert.accept
+    browser.switch_to.alert.accept
   end
 end.overridable
 
 When /^I cancel the browser dialog$/ do
   patiently do
-    page.driver.browser.switch_to.alert.dismiss
+    browser.switch_to.alert.dismiss
   end
 end.overridable
 
 When /^I enter "([^"]*)" into the browser dialog$/ do |text|
   patiently do
-    alert = page.driver.browser.switch_to.alert
+    alert = browser.switch_to.alert
     alert.send_keys(text)
     alert.accept
   end
 end.overridable
 
-When /^I switch to the new tab$/ do
-  if javascript_capable?
-    page.driver.browser.switch_to.window(page.driver.browser.window_handles.last)
-  else
-    raise("This step works only with selenium")
-  end
-end.overridable
-
 # Tests that an input, button or checkbox with the given label is disabled.
 Then /^the "([^\"]*)" (field|button|checkbox) should( not)? be disabled$/ do |label, kind, negate|
   if Spreewald::Comparison.compare_versions(Capybara::VERSION, :<, "2.1")
@@ -728,7 +720,7 @@ When /^I perform basic authentication as "([^\"]*)\/([^\"]*)" and go to (.*)$/ d
     visit("http://#{user}:#{password}@#{server.host}:#{server.port}#{path}")
   else
     authorizers = [
-      (page.driver.browser if page.driver.respond_to?(:browser)),
+      (browser),
       (self),
       (page.driver)
     ].compact

data/lib/spreewald_support/driver_info.rb

@@ -17,6 +17,14 @@ module Spreewald
       Object.const_defined?('Capybara::Webkit') && Capybara.current_session.driver.is_a?(Capybara::Webkit::Driver)
     end
 
+    def browser
+      page.driver.browser if page.driver.respond_to?(:browser)
+    end
+
+    def require_selenium!
+      raise 'This step only works with Selenium' unless selenium_driver?
+    end
+
   end
 end
 

data/lib/spreewald_support/version.rb

@@ -1,3 +1,3 @@
 module Spreewald
-  VERSION = '2.4.2'
+  VERSION = '2.5.0'
 end

data/support/step_definition.rb

@@ -37,7 +37,7 @@ class StepDefinition
 
   def pretty_step
     if kind == 'AfterStep'
-      step[/@\w+/]
+      step[/@[\w-]+/]
     elsif step =~ /^'(.*)'$/ # Surrounded by single quotes
       $1
     else

data/tests/rails-3_capybara-1/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.4.2)
+    spreewald (2.5.0)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/rails-3_capybara-2/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.4.2)
+    spreewald (2.5.0)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/rails-4_capybara-3/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.4.1)
+    spreewald (2.5.0)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/rails-6_capybara-3/Gemfile

@@ -22,4 +22,4 @@ group :test do
   gem 'selenium-webdriver'
   gem 'rspec-rails'
   gem 'spreewald', :path => '../..'
-end
+end

data/tests/rails-6_capybara-3/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    spreewald (2.4.1)
+    spreewald (2.5.0)
       cucumber
       cucumber_priority (>= 0.3.0)
       rspec (>= 2.13.0)

data/tests/shared/app/controllers/static_pages_controller.rb

@@ -21,6 +21,15 @@ class StaticPagesController < ApplicationController
   def see_element
   end
 
+  def tab_1
+  end
+
+  def tab_2
+  end
+
+  def tab_3
+  end
+
   def visibility
   end
 

data/tests/shared/app/views/static_pages/tab_1.haml

@@ -0,0 +1,3 @@
+%h1 First browser tab
+%a(href='/static_pages/tab_2' target='_blank') Click to open tab 2
+%a(href='/static_pages/tab_2') Follow link WITHOUT opening a new tab

data/tests/shared/app/views/static_pages/tab_2.haml

@@ -0,0 +1,2 @@
+%h1 Second browser tab
+%a(href='/static_pages/tab_3' target='_blank') Click to open tab 3

data/tests/shared/app/views/static_pages/tab_3.haml

@@ -0,0 +1 @@
+%h1 Third browser tab

data/tests/shared/config/routes.rb

@@ -18,15 +18,18 @@ Rails.application.routes.draw do
 
   get '/static_pages/click_on', to: 'static_pages#click_on'
   get '/static_pages/home', to: 'static_pages#home'
+  get '/static_pages/link_target', to: 'static_pages#link_target'
   get '/static_pages/link_to_home', to: 'static_pages#link_to_home'
   get '/static_pages/links', to: 'static_pages#links'
   get '/static_pages/numbers', to: 'static_pages#numbers'
   get '/static_pages/overridden', to: 'static_pages#overridden'
+  get '/static_pages/second_link_target', to: 'static_pages#second_link_target'
   get '/static_pages/see_element', to: 'static_pages#see_element'
+  get '/static_pages/tab_1', to: 'static_pages#tab_1'
+  get '/static_pages/tab_2', to: 'static_pages#tab_2'
+  get '/static_pages/tab_3', to: 'static_pages#tab_3'
   get '/static_pages/visibility', to: 'static_pages#visibility'
   get '/static_pages/within', to: 'static_pages#within'
-  get '/static_pages/link_target', to: 'static_pages#link_target'
-  get '/static_pages/second_link_target', to: 'static_pages#second_link_target'
 
   get '/tables/table1', to: 'tables#table1'
   get '/tables/table_with_weird_spaces', to: 'tables#table_with_weird_spaces'

data/tests/shared/features/shared/browser_tab_steps.feature

@@ -0,0 +1,103 @@
+@javascript
+Feature: Browser tab steps
+
+  Background: Access some content in a first tab
+    Given I go to "/static_pages/tab_1"
+    Then I should see "First browser tab"
+      And there should be 1 browser tab
+
+
+  Scenario: I open (.+?) in a new browser tab
+    When I open "/static_pages/tab_2" in a new browser tab
+    Then I should see "Second browser tab"
+      And there should be 2 browser tabs
+
+    When I open "/static_pages/tab_3" in a new browser tab
+    Then I should see "Third browser tab"
+      And there should be 3 browser tabs
+
+
+  Scenario: I close the browser tab
+    When I open "/static_pages/tab_2" in a new browser tab
+      And I open "/static_pages/tab_3" in a new browser tab
+    Then I should see "Third browser tab"
+      And there should be 3 browser tabs
+
+    When I close the browser tab
+    Then there should be 2 browser tabs
+      And I should see "First browser tab"
+
+    When I close the browser tab
+    Then there should be 1 browser tab
+      And I should see "Second browser tab"
+
+
+  Scenario: I switch to the new(?:ly opened)? browser tab
+    When I follow "Click to open tab 2"
+    Then I should see "First browser tab"
+
+    When I switch to the newly opened browser tab
+    Then I should see "Second browser tab"
+
+    When I follow "Click to open tab 3"
+      And I switch to the new browser tab
+    Then I should see "Third browser tab"
+
+
+  Scenario: I switch(?: back)? to the previous browser tab
+    When I open "/static_pages/tab_2" in a new browser tab
+    Then I should see "Second browser tab"
+      And there should be 2 browser tabs
+
+    When I switch back to the previous browser tab
+    Then I should see "First browser tab"
+      And there should be 2 browser tabs
+
+    And I open "/static_pages/tab_3" in a new browser tab
+    Then I should see "Third browser tab"
+      And there should be 3 browser tabs
+
+    When I switch to the previous browser tab
+    Then I should see "Second browser tab"
+      And there should be 3 browser tabs
+
+
+    Scenario: I should have opened a new browser tab
+      This step must be preceded by "I may open a new browser tab"
+
+      When I may open a new browser tab
+        And I follow "Click to open tab 2"
+      Then I should have opened a new browser tab
+        And there should be 2 browser tabs
+
+
+    Scenario: I should not have opened a new browser tab
+      This step must be preceded by "I may open a new browser tab"
+
+      When I may open a new browser tab
+        And I follow "Follow link WITHOUT opening a new tab"
+      Then I should not have opened a new browser tab
+        And there should be 1 browser tabs
+
+
+    Scenario: there should be (\d+) browser tabs?
+      Given there should be 1 browser tab
+      When I open "/static_pages/tab_2" in a new browser tab
+      Then there should be 2 browser tabs
+
+      When I open "/static_pages/tab_3" in a new browser tab
+      Then there should be 3 browser tabs
+
+      When I open "/static_pages/tab_3" in a new browser tab
+      Then there should be 4 browser tabs
+
+
+    Scenario: there should be at least (\d+) browser tabs?
+      Given there should be at least 1 browser tab
+      When I open "/static_pages/tab_2" in a new browser tab
+      Then there should be at least 2 browser tabs
+
+      When I open "/static_pages/tab_3" in a new browser tab
+      Then there should be at least 1 browser tabs
+      Then there should be at least 2 browser tabs
+      Then there should be at least 3 browser tabs

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spreewald
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.0
 platform: ruby
 authors:
 - Tobias Kraze
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber
@@ -154,6 +154,7 @@ files:
 - features/support/aruba.rb
 - lib/spreewald.rb
 - lib/spreewald/all_steps.rb
+- lib/spreewald/browser_tab_steps.rb
 - lib/spreewald/development_steps.rb
 - lib/spreewald/email_steps.rb
 - lib/spreewald/file_attachment_steps.rb
@@ -349,6 +350,9 @@ files:
 - tests/shared/app/views/static_pages/numbers.html.haml
 - tests/shared/app/views/static_pages/overridden.html.haml
 - tests/shared/app/views/static_pages/see_element.html.haml
+- tests/shared/app/views/static_pages/tab_1.haml
+- tests/shared/app/views/static_pages/tab_2.haml
+- tests/shared/app/views/static_pages/tab_3.haml
 - tests/shared/app/views/static_pages/visibility.html.haml
 - tests/shared/app/views/static_pages/within.html.haml
 - tests/shared/app/views/tables/table1.html.haml
@@ -359,6 +363,7 @@ files:
 - tests/shared/db/development.sqlite3
 - tests/shared/db/migrate/.keep
 - tests/shared/db/schema.rb
+- tests/shared/features/shared/browser_tab_steps.feature
 - tests/shared/features/shared/development_steps.feature
 - tests/shared/features/shared/email_steps.feature
 - tests/shared/features/shared/overriding.feature
@@ -391,7 +396,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Collection of useful cucumber steps.
@@ -564,6 +569,9 @@ test_files:
 - tests/shared/app/views/static_pages/numbers.html.haml
 - tests/shared/app/views/static_pages/overridden.html.haml
 - tests/shared/app/views/static_pages/see_element.html.haml
+- tests/shared/app/views/static_pages/tab_1.haml
+- tests/shared/app/views/static_pages/tab_2.haml
+- tests/shared/app/views/static_pages/tab_3.haml
 - tests/shared/app/views/static_pages/visibility.html.haml
 - tests/shared/app/views/static_pages/within.html.haml
 - tests/shared/app/views/tables/table1.html.haml
@@ -574,6 +582,7 @@ test_files:
 - tests/shared/db/development.sqlite3
 - tests/shared/db/migrate/.keep
 - tests/shared/db/schema.rb
+- tests/shared/features/shared/browser_tab_steps.feature
 - tests/shared/features/shared/development_steps.feature
 - tests/shared/features/shared/email_steps.feature
 - tests/shared/features/shared/overriding.feature