spreewald 2.4.2 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c226a047c194764d7645b43c70ab3b07d1a3e7a0d609a4e87dd8baab8e3c3a88
-  data.tar.gz: ecdfa9f9aa7fe19da7bc3a8e2f7852a80d4d397f4342e873fe89a32276c9f9d0
+  metadata.gz: 59c446ad46ae093a7bb103d7e4959dbbc7e29327cbc30e5730aff221f8488e36
+  data.tar.gz: e23e4bd833a6234e6ce2b4e6ab104f102708bab13ab54f10aad8b97df08cd39b
 SHA512:
-  metadata.gz: d2e322bb7fb70096255ade88045b40408f0d1b0899120f159ea5831b65a40bc5a4d7d2bfb0b9b9ede7ba3f7b8aca0a904129076c7c49cafc7c6780bcd0e329d1
-  data.tar.gz: 190918ee162ba71606593416c1ae87f1f963a92f316f10f0c7c50f6a3217c7bc1670ccd1412372faa75504d4c0bbff98bd7dd49b88470a3ee162f477052fff5b
+  metadata.gz: 8d7b6e7ddd55b75433d7c800045c09f68b7175646de8a3f9ac11a5741ee83ce39c22d8bb5a8b5d9d77b4d22df01eda5de51093de4a76cabf73ae354308b12abc
+  data.tar.gz: bc169b566a8878be0ad26b2b1522b960b57772d80d135ffbe4a34476c673282d75b7666d9ccf14a585c229739b3d543620f578c3b59a7e6f62cf036a5df2f90c

data/CHANGELOG.md

@@ -3,8 +3,35 @@ 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.8.0
+- Add radio buttons to the `the "..." (field|button|checkbox|radio button) should( not)? be disabled` step.
+
+## 2.7.2
+- Fix the step `I follow the ... link in the email` if the email contains non-HTTP(S) links
+
+## 2.7.1
+- Support RFC-compliant encoding of filenames in `Content-Disposition` header (e.g. send_data), as provided by Rails 6.
+
+## 2.7.0
+- Add a step modifier to control different Capybara sessions: `... in the browser session "..."`. (see issue [#66](https://github.com/makandra/spreewald/issues/66))
+
+## 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.
+- Fix the step `I should( not)? see a link labeled "STRING"`, it is now overridable.
 
 ## 2.4.1
 
@@ -21,7 +48,7 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## 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)
@@ -41,7 +68,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/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 
@@ -192,6 +247,9 @@ the step definitions.
 
 * **When I follow the (first|second|third)? link in the e?mail**
 
+  Please note that this step will only follow HTTP and HTTPS links.
+  Other links (such as mailto: or ftp:// links) are ignored.
+
 
 * **Then no e?mail should have been sent**
 
@@ -231,6 +289,18 @@ the step definitions.
   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.
 
 
+### session_steps.rb 
+
+* **When ... in the browser session "..."**
+
+  You can append `in the browser session "name"` to any other step to execute
+  the step in a different browser session.
+  
+  You may need to update other steps to allow multiple sessions (e.g. your
+  authentication steps have to support multiple logged in users).
+  More details [here](https://makandracards.com/makandra/474480-how-to-make-a-cucumber-test-work-with-multiple-browser-sessions).
+
+
 ### table_steps.rb 
 
 * **Then I should( not)? see a table with (exactly )?the following rows( in any order)?:?**
@@ -240,11 +310,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 using [Timecop](https://github.com/jtrupiano/timecop).
+Steps to travel through time
 
-See [this article](https://makandracards.com/makandra/1222-useful-cucumber-steps-to-travel-through-time-with-timecop) for details.
+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.
+
+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})?)"?**
@@ -262,7 +335,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:
   
@@ -270,6 +343,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.
@@ -298,7 +373,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.
@@ -608,7 +683,7 @@ deprecation notice. Decide for yourself whether you want to use them:
   
       Then "Sponsor" should link to "http://makandra.com/"
   
-  Don't forget the trailing slash. Otherwise you'll get the error 
+  Don't forget the trailing slash. Otherwise you'll get the error
     expected: /http:\/\/makandra.com(\?[^\/]*)?$/
          got: "http://makandra.com/" (using =~)
 
@@ -643,12 +718,9 @@ 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**
+* **Then the "..." (field|button|checkbox|radio button) should( not)? be disabled**
 
-  Tests that an input, button or checkbox with the given label is disabled.
+  Tests that an input, button, checkbox or radio button with the given label is disabled.
 
 
 * **Then the "..." field should( not)? be visible**

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/examples/paths.rb

@@ -13,6 +13,30 @@ module NavigationHelpers
     when /^the home\s?page$/
       root_path
 
+    when /^the (page|form) for the (.*?) above$/
+      action_prose = Regexp.last_match(1)
+      model_prose = Regexp.last_match(2)
+      route = "#{(action_prose == 'form') ? 'edit_' : ''}#{model_prose_to_route_segment(model_prose)}_path"
+      model = model_prose_to_class(model_prose)
+      send(route, model.reorder(:id).last!)
+
+    when /^the (page|form) for the (.*?) "(.*?)"$/
+      action_prose = Regexp.last_match(1)
+      model_prose = Regexp.last_match(2)
+      identifier = Regexp.last_match(3)
+      path_to_show_or_edit(action_prose, model_prose, identifier)
+
+    when /^the (.*?) (page|form) for "(.*?)"$/
+      model_prose = Regexp.last_match(1)
+      action_prose = Regexp.last_match(2)
+      identifier = Regexp.last_match(3)
+      path_to_show_or_edit(action_prose, model_prose, identifier)
+
+    when /^the (.*?) form$/
+      model_prose = Regexp.last_match(1)
+      route = "new_#{model_prose_to_route_segment(model_prose)}_path"
+      send(route)
+
     else
       begin
         page_name =~ /^the (.*) page$/
@@ -24,6 +48,18 @@ module NavigationHelpers
       end
     end
   end
+
+  private
+
+  def model_prose_to_class(model_prose)
+    model_prose.gsub(' ', '_').classify.constantize
+  end
+
+  def model_prose_to_route_segment(model_prose)
+    model_prose = model_prose.downcase
+    model_prose.gsub(/[\ \/]/, '_')
+  end
+
 end
 
 World(NavigationHelpers)

data/examples/selectors.rb

@@ -12,6 +12,27 @@ module HtmlSelectorsHelpers
     when "the page"
       "html > body"
 
+    # Auto-mapper for BEM classes and ARIA labels
+    #
+    # Usage examples:
+    #   the main menu -> '.main-menu, [aria-label="main menu"]'
+    #   the item box's header -> '.item-box--header, [aria-label="item box's header"]'
+    #   the slider's item that is current -> '.slider--item.is-current, [aria-label="slider's item that is current"]'
+    when /^the (.*)$/
+      match = Regexp.last_match(1)
+      match =~ /^(.+?)(?:'s (.+?))?(?: that (.+))?$/
+
+      bem_selector = '.'
+      bem_selector << selectorify(Regexp.last_match(1))
+      bem_selector << '--' << selectorify(Regexp.last_match(2)) if Regexp.last_match(2)
+      bem_selector << '.' << selectorify(Regexp.last_match(3)) if Regexp.last_match(3)
+
+      aria_selector = '[aria-label="'
+      aria_selector << match.gsub('"', '\\"')
+      aria_selector << '"]'
+
+      [bem_selector, aria_selector].join(', ')
+
     # Add more mappings here.
     # Here is an example that pulls values out of the Regexp:
     #
@@ -35,6 +56,13 @@ module HtmlSelectorsHelpers
         "Now, go and add a mapping in #{__FILE__}"
     end
   end
+
+  private
+
+  def selectorify(string)
+    string.gsub(/ /, '-')
+  end
+
 end
 
 World(HtmlSelectorsHelpers)

data/lib/spreewald/all_steps.rb

@@ -1,9 +1,12 @@
 # coding: UTF-8
 require 'rspec/matchers'
 
+ALREADY_LOADED_FILES = %w[all_steps timecop_steps]
+
 Dir[File.join(File.dirname(__FILE__), '*_steps.rb')].each do |f|
   name = File.basename(f, '.rb')
-  unless name == 'all_steps'
+
+  unless ALREADY_LOADED_FILES.include?(name)
     require "spreewald/#{name}"
   end
 end

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