spreewald 2.2.4 → 2.6.0

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

data/lib/spreewald/development_steps.rb

@@ -7,6 +7,7 @@ end.overridable
 
 # nodoc
 Then 'debugger' do
+  warn 'The step "Then debugger" will be removed in future versions of Spreewald. Please use "Then console" instead.'
   step 'console' # Alias
 end.overridable
 
@@ -56,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/email_steps.rb

@@ -68,10 +68,17 @@ end.overridable
 When /^I follow the (first|second|third)? ?link in the e?mail$/ do |index_in_words|
   mail = @mail || ActionMailer::Base.deliveries.last
   index = { nil => 0, 'first' => 0, 'second' => 1, 'third' => 2 }[index_in_words]
-  url_pattern = %r{(?:http|https)://[^/]+([^"'\s\\]*)}
-  mail_body = MailFinder.email_text_body(mail).to_s
-  only_path = mail_body.scan(url_pattern)[index][0]
-  visit only_path
+  url_pattern = %r((?:https?://[^/]+)([^"'\s]+))
+
+  paths = if mail.html_part
+    dom = Nokogiri::HTML(mail.html_part.body.to_s)
+    (dom / 'a[href]').map { |a| a['href'].match(url_pattern)[1] }
+  else
+    mail_body = MailFinder.email_text_body(mail).to_s
+    mail_body.scan(url_pattern).flatten(1)
+  end
+
+  visit paths[index]
 end.overridable
 
 Then /^no e?mail should have been sent$/ do

data/lib/spreewald/file_attachment_steps.rb

@@ -1,27 +1,9 @@
-# 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.
 Given /^the file "([^"]*)" was attached(?: as (?:([^"]*)\/)?([^"]*))? to the ([^"]*) above(?: at "([^"]*)")?$/ do
   |path_to_file, container_name, relation_name, model_name, time_string|
 
+  warn "The step 'the file ... was attached to the ... above' will soon be removed from Spreewald, because we want Spreewald to be a library of steps that interact with a user interface and instead of manipulating the database directly. If you wish to further use this step please copy it over to your project's own steps."
+
   object = model_name.camelize.constantize.last
   time = Time.parse(time_string) if time_string.present?
   relation_name ||= 'file'

data/lib/spreewald/time_steps.rb

@@ -0,0 +1,102 @@
+# coding: UTF-8
+
+
+# Steps to travel through time
+#
+# 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.
+# FILE_COMMENT_END
+
+major_minor_rails_version = defined?(ActiveSupport) ? [ActiveSupport::VERSION::MAJOR, ActiveSupport::VERSION::MINOR] : [0, 0]
+is_at_least_rails_4_1 = (major_minor_rails_version <=> [4, 1]) != -1
+
+if defined?(Timecop) || is_at_least_rails_4_1
+
+  module TimeHelpers
+
+    # When you have to make your rails app time zone aware you have to go 100%
+    # otherwise you are better off ignoring time zones at all.
+    # https://makandracards.com/makandra/8723-guide-to-localizing-a-rails-application
+
+    def use_timezones?
+      active_record_loaded = defined?(ActiveRecord::Base)
+      (!active_record_loaded || ActiveRecord::Base.default_timezone != :local) && Time.zone
+    end
+
+    def parse_time(str)
+      if use_timezones?
+        Time.zone.parse(str)
+      else
+        Time.parse(str)
+      end
+    end
+
+    def current_time
+      if use_timezones?
+        Time.current
+      else
+        Time.now
+      end
+    end
+
+    if defined?(Timecop)
+      # Emulate ActiveSupport time helper methods with Timecop - don't rename these methods
+      def travel(duration)
+        Timecop.travel(current_time + duration)
+      end
+
+      def travel_to(date_or_time)
+        Timecop.travel(date_or_time)
+      end
+
+      def travel_back
+        Timecop.return
+      end
+    else
+      require 'active_support/testing/time_helpers'
+      include ActiveSupport::Testing::TimeHelpers
+    end
+
+  end
+
+  World(TimeHelpers)
+
+  # Example:
+  #
+  #     Given the date is 2012-02-10
+  #     Given the time is 2012-02-10 13:40
+  When /^the (?:date|time) is "?(\d{4}-\d{2}-\d{2}(?: \d{1,2}:\d{2})?)"?$/ do |time|
+    travel_to parse_time(time)
+  end.overridable
+
+  # Example:
+  #
+  #     Given the time is 13:40
+  When /^the time is "?(\d{1,2}:\d{2})"?$/ do |time_without_date|
+    travel_to parse_time(time_without_date) # date will be today
+  end.overridable
+
+  # Example:
+  #
+  #     When it is 10 minutes later
+  #     When it is a few hours earlier
+  When /^it is (\d+|an?|some|a few) (seconds?|minutes?|hours?|days?|weeks?|months?|years?) (later|earlier)$/ do |amount, unit, direction|
+    amount = case amount
+    when 'a', 'an'
+      1
+    when 'some', 'a few'
+      10
+    else
+      amount.to_i
+    end
+    amount = -amount if direction == 'earlier'
+    travel amount.send(unit)
+  end.overridable
+
+  After do
+    travel_back
+  end
+
+end

data/lib/spreewald/timecop_steps.rb

@@ -1,79 +1,9 @@
-# coding: UTF-8
-
-
-# Steps to travel through time using [Timecop](https://github.com/jtrupiano/timecop).
-#
-# See [this article](https://makandracards.com/makandra/1222-useful-cucumber-steps-to-travel-through-time-with-timecop) for details.
+# nodoc
 # FILE_COMMENT_END
 
+warn <<-WARNING
+Warning: The file spreewald/timecop_steps.rb is deprecated. It was moved to
+spreewald/time_steps.rb. Please require the new file instead.
+WARNING
 
-if defined?(Timecop)
-
-  module TimecopHarness
-
-    # When you have to make your rails app time zone aware you have to go 100%
-    # otherwise you are better off ignoring time zones at all.
-    # https://makandracards.com/makandra/8723-guide-to-localizing-a-rails-application
-
-    def use_timezones?
-      active_record_loaded = defined?(ActiveRecord::Base)
-      (!active_record_loaded || ActiveRecord::Base.default_timezone != :local) && Time.zone
-    end
-
-    def parse_time(str)
-      if use_timezones?
-        Time.zone.parse(str)
-      else
-        Time.parse(str)
-      end
-    end
-
-    def current_time
-      if use_timezones?
-        Time.current
-      else
-        Time.now
-      end
-    end
-
-  end
-
-  World(TimecopHarness)
-
-  # Example:
-  #
-  #     Given the date is 2012-02-10
-  #     Given the time is 2012-02-10 13:40
-  When /^the (?:date|time) is "?(\d{4}-\d{2}-\d{2}(?: \d{1,2}:\d{2})?)"?$/ do |time|
-    Timecop.travel(parse_time(time))
-  end.overridable
-
-  # Example:
-  #
-  #     Given the time is 13:40
-  When /^the time is "?(\d{1,2}:\d{2})"?$/ do |time_without_date|
-    Timecop.travel(parse_time(time_without_date)) # date will be today
-  end.overridable
-
-  # Example:
-  #
-  #     When it is 10 minutes later
-  #     When it is a few hours earlier
-  When /^it is (\d+|a|some|a few) (seconds?|minutes?|hours?|days?|weeks?|months?|years?) (later|earlier)$/ do |amount, unit, direction|
-    amount = case amount
-      when 'a'
-        1
-      when 'some', 'a few'
-        10
-      else
-        amount.to_i
-    end
-    amount = -amount if direction == 'earlier'
-    Timecop.travel(current_time + amount.send(unit))
-  end.overridable
-
-  After do
-    Timecop.return
-  end
-
-end
+require 'spreewald/time_steps'