spreewald 4.2.2 → 4.3.4

data/lib/spreewald/web_steps.rb

@@ -31,6 +31,7 @@ require 'spreewald_support/custom_matchers'
 require 'spreewald_support/web_steps_helpers'
 require 'spreewald_support/driver_info'
 require 'spreewald_support/comparison'
+require 'spreewald_support/field_errors'
 require 'uri'
 require 'cgi'
 
@@ -167,32 +168,23 @@ end.overridable
 # Checks that some text appears on the page
 #
 # Note that this does not detect if the text might be hidden via CSS
-Then /^(?:|I )should see "([^"]*)"$/ do |text|
+Then /^(?:|I )should( not)? see "([^"]*)"$/ do |negate, text|
+  expectation = negate ? :not_to : :to
+
   patiently do
-    expect(page).to have_content(text)
+    expect(page).send(expectation, have_content(text))
   end
 end.overridable
 
 # Checks that a regexp appears on the page
 #
 # Note that this does not detect if the text might be hidden via CSS
-Then /^(?:|I )should see \/(.*)\/$/ do |regexp|
+Then /^(?:|I )should( not)? see \/(.*)\/$/ do |negate, regexp|
+  expectation = negate ? :not_to : :to
   regexp = Regexp.new(regexp)
-  patiently do
-    expect(page).to have_xpath('.//descendant-or-self::*', :text => regexp)
-  end
-end.overridable
 
-Then /^(?:|I )should not see "([^"]*)"$/ do |text|
   patiently do
-    expect(page).to have_no_content(text)
-  end
-end.overridable
-
-Then /^(?:|I )should not see \/(.*)\/$/ do |regexp|
-  patiently do
-    regexp = Regexp.new(regexp)
-    expect(page).to have_no_xpath('.//descendant-or-self::*', :text => regexp)
+    expect(page).send(expectation, have_xpath('.//descendant-or-self::*', text: regexp))
   end
 end.overridable
 
@@ -239,22 +231,20 @@ end.overridable(priority: -5) # priority lower than within
 
 # Like `Then I should see`, but with single instead of double quotes. In case
 # the expected string contains quotes as well.
-Then /^(?:|I )should see '([^']*)'$/ do |text|
+Then /^(?:|I )should( not)? see '([^']*)'$/ do |negate, text|
+  expectation = negate ? :not_to : :to
+
   patiently do
-    expect(page).to have_content(text)
+    expect(page).send(expectation, have_content(text))
   end
 end.overridable
 
 # Check that the raw HTML contains a string
-Then /^I should see "([^\"]*)" in the HTML$/ do |text|
-  patiently do
-    expect(page.body).to include(text)
-  end
-end.overridable
+Then /^I should( not)? see "([^\"]*)" in the HTML$/ do |negate, text|
+  expectation = negate ? :not_to : :to
 
-Then /^I should not see "([^\"]*)" in the HTML$/ do |text|
   patiently do
-    expect(page.body).not_to include(text)
+    expect(page.body).send(expectation, include(text))
   end
 end.overridable
 
@@ -271,7 +261,7 @@ end.overridable
 #     Then I should see the element ".panel"
 #     Then I should not see an element ".sidebar"
 #     Then I should not see the element ".sidebar"
-Then /^I should (not )?see (?:an|the) element "([^"]+)"$/ do |negate, selector|
+Then /^I should( not)? see (?:an|the) element "([^"]+)"$/ do |negate, selector|
   expectation = negate ? :not_to : :to
   patiently do
     expect(page).send(expectation, have_css(selector))
@@ -286,7 +276,7 @@ end.overridable
 #     Then I should see the element for the panel
 #     Then I should not see an element for the sidebar
 #     Then I should not see the element for the sidebar
-Then /^I should (not )?see (?:an|the) element for (.*?)$/ do |negate, locator|
+Then /^I should( not)? see (?:an|the) element for (.*?)$/ do |negate, locator|
   expectation = negate ? :not_to : :to
   selector = _selector_for(locator)
   patiently do
@@ -325,7 +315,7 @@ Then /^I should( not)? see a link labeled "([^"]*)"$/ do |negate, label|
 end.overridable
 
 # Checks that an input field contains some value (allowing * as wildcard character)
-Then /^the "([^"]*)" field should (not )?contain "([^"]*)"$/ do |label, negate, expected_string|
+Then /^the "([^"]*)" field should( not)? contain "([^"]*)"$/ do |label, negate, expected_string|
   patiently do
     field = find_with_disabled(:field, label)
     field_value = case field.tag_name
@@ -345,7 +335,7 @@ Then /^the "([^"]*)" field should (not )?contain "([^"]*)"$/ do |label, negate,
 end.overridable
 
 # Checks that a multiline textarea contains some value (allowing * as wildcard character)
-Then(/^the "(.*?)" field should (not )?contain:$/) do |label, negate, expected_string|
+Then(/^the "(.*?)" field should( not)? contain:$/) do |label, negate, expected_string|
   patiently do
     field = find_with_disabled(:field, label)
     expect(field.value.chomp).send(negate ? :not_to : :to, contain_with_wildcards(expected_string))
@@ -370,17 +360,28 @@ end.overridable
 Then /^the "([^"]*)" field should have the error "([^"]*)"$/ do |field, error_message|
   patiently do
     element = find_with_disabled(:field, field)
-    classes = element.find(:xpath, '..')[:class].split(' ')
+    field_error_finder = Spreewald::FieldErrorFinder.new(page, element)
+    expect(field_error_finder.error_present?).to eq true
 
-    form_for_input = element.find(:xpath, 'ancestor::form[1]')
-    using_formtastic = form_for_input && form_for_input.has_css?('.formtastic')
-    error_class = using_formtastic ? 'error' : 'field_with_errors'
+    if Spreewald.field_error_class
+      unless Spreewald.error_message_xpath_selector
+        raise ArgumentError, 'No XPath was specified for the custom error message element.'
+      end
+    end
 
-    expect(classes).to include(error_class)
+    error_message_element = case
+      when Spreewald.error_message_xpath_selector
+        element.find(:xpath, Spreewald.error_message_xpath_selector)
+      when field_error_finder.bootstrap3_error?
+        element.find(:xpath, 'parent::*/child::*[@class="help-block"]')
+      when field_error_finder.bootstrap45_error?
+        element.find(:xpath, 'parent::*/child::*[@class="invalid-feedback"]')
+      else
+        nil
+    end
 
-    if using_formtastic
-      error_paragraph = element.find(:xpath, '../*[@class="inline-errors"][1]')
-      expect(error_paragraph).to have_content(error_message)
+    if error_message_element
+      expect(error_message_element).to have_content(error_message)
     else
       expect(page).to have_content("#{field.titlecase} #{error_message}")
     end
@@ -390,9 +391,10 @@ end.overridable
 Then /^the "([^\"]*)" field should( not)? have an error$/ do |label, negate|
   patiently do
     expectation = negate ? :not_to : :to
-    field = find_with_disabled(:field, label)
-    expect(field[:id]).to be_present # prevent bad CSS selector if field lacks id
-    expect(page).send(expectation, have_css(".field_with_errors ##{field[:id]}"))
+    element = find_with_disabled(:field, label)
+    field_error_finder = Spreewald::FieldErrorFinder.new(page, element)
+
+    expect(field_error_finder.error_present?).public_send(expectation, (eq true))
   end
 end.overridable
 
@@ -648,18 +650,19 @@ end.overridable
 
 # Tests that an input, button, checkbox or radio button with the given label is disabled.
 Then /^the "([^\"]*)" (field|button|checkbox|radio button) should( not)? be disabled$/ do |label, kind, negate|
-  element = if kind == 'button'
-    find_with_disabled(:button, label)
-  else
-    find_with_disabled(:field, label)
-  end
+  patiently do
+    element = if kind == 'button'
+      find_with_disabled(:button, label)
+    else
+      find_with_disabled(:field, label)
+    end
 
-  if Spreewald::Comparison.compare_versions(Capybara::VERSION, :<, "2.1")
-    expect(element[:disabled]).send(negate ? :to : :not_to, eq(nil))
-  else
-    expect(!!element.disabled?).to be !negate
+    if Spreewald::Comparison.compare_versions(Capybara::VERSION, :<, "2.1")
+      expect(element[:disabled]).send(negate ? :to : :not_to, eq(nil))
+    else
+      expect(!!element.disabled?).to be !negate
+    end
   end
-
 end.overridable
 
 # Tests that a field with the given label is visible.

data/lib/spreewald_support/field_errors.rb

@@ -0,0 +1,56 @@
+require 'spreewald_support/driver_info'
+
+module Spreewald
+  def self.field_error_class
+    self.instance_variable_get('@field_error_class')
+  end
+
+  def self.field_error_class=(error_class)
+    self.instance_variable_set('@field_error_class', error_class)
+  end
+
+  def self.error_message_xpath_selector
+    self.instance_variable_get('@error_message_xpath_selector')
+  end
+
+  # The XPath to the HTML-element that renders your validation/error message.
+  # The current node to start from is the input-field that is validated.
+  def self.error_message_xpath_selector=(message_selector)
+    self.instance_variable_set('@error_message_xpath_selector', message_selector)
+  end
+
+  class FieldErrorFinder
+    include Spreewald::DriverInfo
+
+    def initialize(page, element)
+      @page = page
+      @element = element
+    end
+
+    def error_present?
+      custom_error? || bootstrap3_error? || bootstrap45_error? || rails_error?
+    end
+
+    def custom_error?
+      Spreewald.field_error_class && @element.has_xpath?("ancestor-or-self::div[contains(@class, \"#{Spreewald.field_error_class}\")]")
+    end
+
+    def bootstrap3_error?
+      @element.has_xpath?('ancestor::div[@class="form-group has-error"]')
+    end
+
+    def bootstrap45_error?
+      element_classes = @element[:class] &.split(' ') || []
+      invalid_elements = if javascript_capable?
+        @page.all(':invalid') # Collect all invalid elements as Bootstrap 4 and 5 support client validation
+      end
+
+      element_classes.include?('is-invalid') || (invalid_elements && invalid_elements.include?(@element))
+    end
+
+    def rails_error?
+      parent_element_classes = @element.find(:xpath, '..')[:class] &.split(' ') || []
+      parent_element_classes.include?('field_with_errors')
+    end
+  end
+end

data/lib/spreewald_support/version.rb

@@ -1,3 +1,3 @@
 module Spreewald
-  VERSION = '4.2.2'
+  VERSION = '4.3.4'
 end

data/support/step_definition.rb

@@ -33,6 +33,11 @@ class StepDefinition
     "#{kind} #{pretty_step}"
   end
 
+  def matches_search?(search)
+    regexp = Regexp.new(search)
+    step =~ regexp || matches_without_optional_negation?(regexp)
+  end
+
   private
 
   def pretty_step
@@ -45,4 +50,10 @@ class StepDefinition
     end
   end
 
+  def matches_without_optional_negation?(regexp)
+    without_negation = step.gsub('( not)?', '').gsub('(not )?', '')
+    with_negation = step.gsub('( not)?', ' not').gsub('(not )?', 'not ')
+    with_negation =~ regexp || without_negation =~ regexp
+  end
+
 end

data/support/step_manager.rb

@@ -17,7 +17,7 @@ class StepManager
   def steps(search = nil)
     step_files.collect(&:real_steps).flatten.
       sort_by { |step| [STEP_KINDS.index(step.kind), step.to_s.downcase] }.
-      select { |definition| search.nil? or definition.step =~ Regexp.new(search) }
+      select { |definition| search.nil? || definition.matches_search?(search) }
   end
 
 private

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

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

data/tests/rails-6_capybara-3/features/step_definitions/field_error_steps.rb

@@ -0,0 +1,12 @@
+Then /^I set the custom field error class to "([^"]+)"$/ do |error_class|
+  Spreewald.field_error_class = error_class
+end
+
+Then /^I set the custom error message xpath to "(.+)"$/ do |error_message_xpath|
+  Spreewald.error_message_xpath_selector = error_message_xpath
+end
+
+After('@field_errors') do
+  Spreewald.field_error_class = nil
+  Spreewald.error_message_xpath_selector = nil
+end

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

@@ -15,7 +15,16 @@ class FormsController < ApplicationController
   def select_fields
   end
 
-  def invalid_form
+  def invalid_rails_form
   end
 
-end
+  def invalid_bootstrap3_form
+  end
+
+  def invalid_bootstrap4_form
+  end
+
+  def invalid_custom_form
+  end
+
+end

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

@@ -33,6 +33,9 @@ class StaticPagesController < ApplicationController
   def see_element
   end
 
+  def should_see
+  end
+
   def tab_1
   end
 

data/tests/shared/app/views/forms/invalid_bootstrap3_form.html.haml

@@ -0,0 +1,16 @@
+= form_tag do
+  .form-group.has-error
+    = label_tag 'text_control', 'A'
+    = text_field_tag 'text_control', 'Text control value'
+    .help-block 'A is invalid'
+  .form-group.has-error
+    = label_tag 'textarea_control_1', 'B'
+    = text_area_tag 'textarea_control_1', "Textarea control line 1\nTextarea control line 2\n"
+    .help-block 'B is invalid'
+  .form-group.has-error
+    = label_tag 'disabled_control', 'Disabled'
+    = text_field_tag 'disabled_control', "Disabled control value", disabled: true
+    .help-block 'Disabled is invalid'
+  .form-group
+    = label_tag 'textarea_control_2', 'C'
+    = text_area_tag 'textarea_control_2', "Textarea control line 1\nTextarea control line 2\n"

data/tests/shared/app/views/forms/invalid_bootstrap4_form.html.haml

@@ -0,0 +1,18 @@
+= form_tag do
+  .form-group
+    = label_tag 'text_control', 'A'
+    - # Client validation
+    = text_field_tag 'text_control', '', class: 'form-control', required: true
+    .invalid-feedback 'A is invalid'
+  .form-group
+    = label_tag 'textarea_control_1', 'B'
+    = text_area_tag 'textarea_control_1', '', class: 'form-control', required: true
+    .invalid-feedback 'B is invalid'
+  .form-group
+    = label_tag 'disabled_control', 'Disabled'
+    - # Server validation
+    = text_field_tag 'disabled_control', "Disabled control value", class: 'form-control is-invalid', disabled: true
+    .invalid-feedback 'Disabled is invalid'
+  .form-group
+    = label_tag 'textarea_control_2', 'C'
+    = text_area_tag 'textarea_control_2', "Textarea control line 1\nTextarea control line 2\n"

data/tests/shared/app/views/forms/invalid_custom_form.html.haml

@@ -0,0 +1,19 @@
+= form_tag do
+  .form-group.my-error
+    = label_tag 'text_control', 'A'
+    = text_field_tag 'text_control', 'Text control value'
+    %p.my-error-description
+      A is invalid
+  .form-group.my-error
+    = label_tag 'textarea_control_1', 'B'
+    = text_area_tag 'textarea_control_1', "Textarea control line 1\nTextarea control line 2\n"
+    %p.my-error-description
+      B is invalid
+  .form-group.my-error
+    = label_tag 'disabled_control', 'Disabled'
+    = text_field_tag 'disabled_control', "Disabled control value", disabled: true
+    %p.my-error-description
+      Disabled is invalid
+  .form-group
+    = label_tag 'textarea_control_2', 'C'
+    = text_area_tag 'textarea_control_2', "Textarea control line 1\nTextarea control line 2\n"

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

@@ -0,0 +1,7 @@
+%p Normal text
+
+%p Some text matching a regular expression
+
+%p Some text with "quotes"
+
+%p Some text in the <b>HTML</b>

data/tests/shared/config/routes.rb

@@ -23,7 +23,10 @@ Rails.application.routes.draw do
   get '/forms/form1', to: 'forms#form1'
   get '/forms/form2', to: 'forms#form2'
   get '/forms/select_fields', to: 'forms#select_fields'
-  get '/forms/invalid_form', to: 'forms#invalid_form'
+  get '/forms/invalid_rails_form', to: 'forms#invalid_rails_form'
+  get '/forms/invalid_bootstrap3_form', to: 'forms#invalid_bootstrap3_form'
+  get '/forms/invalid_bootstrap4_form', to: 'forms#invalid_bootstrap4_form'
+  get '/forms/invalid_custom_form', to: 'forms#invalid_custom_form'
 
   get '/iframes/iframe_1_content', to: 'iframes#iframe_1_content'
   get '/iframes/iframe_2_content', to: 'iframes#iframe_2_content'
@@ -41,6 +44,7 @@ Rails.application.routes.draw do
   get '/static_pages/session_1', to: 'static_pages#session_1'
   get '/static_pages/session_2', to: 'static_pages#session_2'
   get '/static_pages/session_3', to: 'static_pages#session_3'
+  get '/static_pages/should_see', to: 'static_pages#should_see'
   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'

data/tests/shared/features/shared/iframe_steps.feature

@@ -1,7 +1,6 @@
 @javascript
 Feature: iframe Steps
 
-  @not-capybara-2
   Scenario: Switch between iframes
     Given I go to "/static_pages/iframe"
     Then I should not see "Kiwi"
@@ -35,4 +34,4 @@ Feature: iframe Steps
       And I should see a table with the following rows inside the 2nd iframe:
         | Color | Fruit  |
         | Red   | Cherry |
-    But I should not see "Content on main page" inside the 1st iframe
+    But I should not see "Content on main page" inside the 1st iframe

data/tests/shared/features/shared/web_steps.feature

@@ -1,6 +1,6 @@
 Feature: Web steps
 
-  Scenario: /^the "([^"]*)" field should (not )?contain "([^"]*)"$/
+  Scenario: /^the "([^"]*)" field should( not)? contain "([^"]*)"$/
     When I go to "/forms/form1"
     Then the "Text control" field should contain "Text control value"
     Then the "Text control" field should not contain "false text"
@@ -11,7 +11,7 @@ Feature: Web steps
     Then the "Empty control" field should contain ""
 
 
-  Scenario: /^the "([^"]*)" field should (not )?contain:/
+  Scenario: /^the "([^"]*)" field should( not)? contain:/
     When I go to "/forms/form2"
     Then the "Text control" field should contain:
       """
@@ -31,20 +31,57 @@ Feature: Web steps
       """
       """
 
-
+  @javascript @field_errors
   Scenario: /^the "([^\"]*)" field should( not)? have an error$/
-    When I go to "/forms/invalid_form"
+    When I go to "/forms/invalid_rails_form"
+    Then the "A" field should have an error
+    Then the "B" field should have an error
+    Then the "Disabled" field should have an error
+    Then the "C" field should not have an error
+
+    When I go to "/forms/invalid_bootstrap3_form"
     Then the "A" field should have an error
     Then the "B" field should have an error
     Then the "Disabled" field should have an error
     Then the "C" field should not have an error
 
+    When I go to "/forms/invalid_bootstrap4_form"
+    Then the "A" field should have an error
+    Then the "B" field should have an error
+    Then the "Disabled" field should have an error
+    Then the "C" field should not have an error
+
+    When I set the custom field error class to "my-error"
+      And I go to "/forms/invalid_custom_form"
+    Then the "A" field should have an error
+    Then the "B" field should have an error
+    Then the "Disabled" field should have an error
+    Then the "C" field should not have an error
+
+
+  @javascript @field_errors
   Scenario: /^the "([^"]*)" field should have the error "([^"]*)"$/
-    When I go to "/forms/invalid_form"
+    When I go to "/forms/invalid_rails_form"
     Then the "A" field should have the error "is invalid"
     Then the "B" field should have the error "is invalid"
     Then the "Disabled" field should have the error "is invalid"
 
+    When I go to "/forms/invalid_bootstrap3_form"
+    Then the "A" field should have the error "is invalid"
+    Then the "B" field should have the error "is invalid"
+    Then the "Disabled" field should have the error "is invalid"
+
+    When I go to "/forms/invalid_bootstrap4_form"
+    Then the "A" field should have the error "is invalid"
+    Then the "B" field should have the error "is invalid"
+    Then the "Disabled" field should have the error "is invalid"
+
+    When I set the custom field error class to "my-error"
+      And I set the custom error message xpath to "parent::*/child::*[contains(@class, "my-error-description")]"
+      And I go to "/forms/invalid_custom_form"
+    Then the "A" field should have the error "is invalid"
+    Then the "B" field should have the error "is invalid"
+    Then the "Disabled" field should have the error "is invalid"
 
   Scenario: /^I should see a form with the following values:$/
     When I go to "/forms/form1"
@@ -200,7 +237,7 @@ Feature: Web steps
     And "div with style: display: none" should be hidden within ".container"
 
 
-  Scenario: /^I should (not )?see (?:an|the) element "([^"]+)"$/
+  Scenario: /^I should( not)? see (?:an|the) element "([^"]+)"$/
     When I go to "/static_pages/see_element"
     Then I should see an element ".panel"
       And I should see the element ".panel"
@@ -210,7 +247,7 @@ Feature: Web steps
       But I should not see the element ".timeline"
 
 
-  Scenario: /^I should (not )?see (?:an|the) element for (.*?)$/
+  Scenario: /^I should( not)? see (?:an|the) element for (.*?)$/
     When I go to "/static_pages/see_element"
     Then I should see an element for a panel
       And I should see the element for a panel
@@ -220,7 +257,26 @@ Feature: Web steps
       And I should not see the element for the timeline
 
 
-  Scenario: /^((?:|I )should see "([^"]*)" within (.*[^:])$/
+  Scenario: /^((?:|I )should( not)? see "([^"]*)"$/
+    When I go to "/static_pages/should_see"
+    Then I should see "Normal text"
+    But I should not see "Some special text"
+
+
+  Scenario: /^((?:|I )should( not)? see '([^']*)'$/
+    When I go to "/static_pages/should_see"
+    Then I should see 'Some text with "quotes"'
+    But I should not see 'Some special text with "quotes"'
+
+
+  Scenario: /^I should( not)? see "([^\"]*)" in the HTML$/
+    When I go to "/static_pages/should_see"
+    Then I should see "Some text in the <b>HTML</b>" in the HTML
+      And I should see "Some text in the HTML"
+    But I should not see "Some text in the <strong>HTML</strong>" in the HTML
+
+
+  Scenario: /^((?:|I )should( not)? see "([^"]*)" within (.*[^:])$/
     When I go to "/static_pages/within"
     Then I should see "Role" within ".table"
       And I should see "Permissions" within a table
@@ -232,7 +288,8 @@ Feature: Web steps
       And I should not see "Outside Table" within a table
     But I should see "Outside Table"
 
-  Scenario: /^(?:|I )should see \/([^\/]*)\/$/
+
+  Scenario: /^(?:|I )should( not)? see \/([^\/]*)\/$/
     When I go to "/static_pages/within"
     Then I should see /Shared Text/
       And I should see /Unique Text/
@@ -241,13 +298,8 @@ Feature: Web steps
     But I should not see /Nonsense/
       And I should not see /http://other-domain.com/
 
-    # making sure it works with a within scope correctly when the same element is available outside
-    Then I should not see /Outside Table/ within ".table"
-      And I should not see /Outside Table/ within a table
-    But I should see /Outside Table/
-
 
-  Scenario: /^(?:|I )should see \/([^\/]*)\/ within (.*[^:])$/
+  Scenario: /^(?:|I )should( not)? see \/([^\/]*)\/ within (.*[^:])$/
     When I go to "/static_pages/within"
     Then I should see /Shared Text/ within ".scoped-element"
       And I should see /Shared Text/ within ".unrelated-element"
@@ -257,6 +309,11 @@ Feature: Web steps
     But I should not see /Unique Text/ within ".unrelated-element"
       And I should not see /http://other-domain.com/ within ".unrelated-element"
 
+    # making sure it works with a within scope correctly when the same element is available outside
+    Then I should not see /Outside Table/ within ".table"
+      And I should not see /Outside Table/ within a table
+    But I should see /Outside Table/
+
 
   Scenario: /^(.*) within (.*[^:])$/ with a Capybara::Node::Element
     When I go to "/static_pages/within"