spreewald 4.3.5 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8841cf880bda6d58ed1632050b3c3a28292e476acb6f961922beaa3f842498a3
-  data.tar.gz: 830f0798c36a968717bf946ba987372e78df20c2a1ce4a5e4ec570733256c0b1
+  metadata.gz: 892a8b1fc2985989a10ad303aa6be9a65a4ea3542bea9c5d9311fb0f1463b73a
+  data.tar.gz: 2031b66e60406bd9205204a6355fc0f745eed30abf3b14095121f9b04290610e
 SHA512:
-  metadata.gz: 8f4afbf809ee2f17478eea159da1d1659a72e62d45b39bc8e221c4bb0fc94ed5fcad15ca17f4557e3163b2f9d6aa182041ab6aa4f13e1db72d290307a5724e82
-  data.tar.gz: 88b21029149764ec1023134a50e99ced4a51b8fe1e8f4a96ff1681cc4809013d52dcc2e995eba79e315b9626fe36b16bb65bd8da5ca100bbf3213b0ece67932a
+  metadata.gz: e7c84b276c5b1cca99a3beac23d656d206ae68cc8f74b17ca3b316b59703249611c226c85d1cc17305faf588e56a1b689d213b916251db4e876c3644c48ee893
+  data.tar.gz: a61b5d8dd7bf93dca91ea19a69d77de47ddb79b251bacf4ed37b79b1cab91972ea5c2f995d05f9ccf2d83f5a6f37b36882a14ffba178399380da192495a7ac34

data/.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
       matrix:
         include:
         - ruby: 3.0.0
-          gemfile: tests/rails-6_capybara-3/Gemfile
+          gemfile: tests/rails-7_capybara-3/Gemfile
         # Used to run rspec and integration tests for spreewald binary:
         - ruby: 2.6.6
           gemfile: Gemfile.ruby266

data/CHANGELOG.md

@@ -3,6 +3,17 @@ 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).
 
+## 4.4.1
+- Fix deprecation warning for `ActiveRecord::Base.default_timezone` when running with Rails 7.0 ([#191](https://github.com/makandra/spreewald/issues/191))
+- Fix deprecation warning for using keyword arguments as last argument when running with ruby 2.7 ([#192](https://github.com/makandra/spreewald/issues/192))
+
+## 4.4.0
+- Add support for Rails 7.0
+
+## 4.3.6
+- Use capybara's `make_visible` [option](https://github.com/teamcapybara/capybara/blob/0468de5a810aae75ab9de20447e246c5c35473f0/lib/capybara/node/actions.rb#L279) in step `I attach the file "..." to "..."`
+  - This will make CSS-Hacks like setting the opacity in tests obsolete
+
 ## 4.3.5
 - Fix deprecation warning for using keyword arguments as last argument when running with ruby 2.7
 
@@ -29,8 +40,8 @@ did not find the correct elements
 - The search via `spreewald some query here` includes steps with optional negation now.
 
 ## 4.2.2
-- Fixes the "Show me the email" step (#171)
-- Fixes the "I follow the link in the email" step. (#172, #173)
+- Fixes the "Show me the email" step ([#171](https://github.com/makandra/spreewald/issues/171))
+- Fixes the "I follow the link in the email" step. ([#172](https://github.com/makandra/spreewald/issues/172), [#173](https://github.com/makandra/spreewald/issues/173))
   - It works for emails with and without explicit html parts
   - There's a better error message if no links are found
 
@@ -38,7 +49,7 @@ did not find the correct elements
 - Multiple invocations of console don't raise anymore
 
 ## 4.1.1
-- The step `I open .. in a new browser tab` is now using the `noopener` option (see issue [#174])
+- The step `I open .. in a new browser tab` is now using the `noopener` option (see issue [#174](https://github.com/makandra/spreewald/issues/174))
 
 ## 4.1.0
 
@@ -214,7 +225,7 @@ The "it should work" step now takes an optional reason.
 The word "within" can now be used in arguments for other steps without causing errors ([Issue #53](https://github.com/makandra/spreewald/issues/80))
 
 ## 1.12.3
-Prevent wall of warnings when `Then console` is used multiple times in on test run ([issue](https://github.com/makandra/spreewald/issues/80))
+Prevent wall of warnings when `Then console` is used multiple times in on test run ([issue #80](https://github.com/makandra/spreewald/issues/80))
 
 ## 1.12.2
 Always check the current driver by its class (see [issue](https://github.com/makandra/spreewald/issues/74))

data/README.md

@@ -4,6 +4,10 @@ Spreewald is a collection of useful steps for cucumber. Feel free to fork.
 
 You can find a list of all contained steps at the end of this README.
 
+## Supported versions
+
+Spreewald is currently tested against and Ruby 2.6.6 and 3.0.0 with Rails 7 and Capybara 3.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -12,18 +16,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install spreewald
-
-
-## Supported versions
-
-Spreewald is currently tested against and Ruby 2.6.6 with Rails 6 and Capybara 3.
-
-## Usage
+    $ bundle install
 
 Require all Spreewald steps by putting
 
@@ -32,19 +25,28 @@ Require all Spreewald steps by putting
 into either your `support/env.rb` or `step_definitions/spreewald_steps.rb`.
 
 Steps are grouped into a number of categories. If you only want to use a subset
-of Spreewald's steps, you can pick and choose single categories by requiring
-single files like this:
+of Spreewald's steps, insead of `require 'spreewald/all_steps'`, you can pick 
+and choose single categories by requiring [single files](https://github.com/makandra/spreewald/tree/master/lib/spreewald) 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.
+After that you are good to go and use the steps [described below](#steps).
+
+### Recommended additional setup
+
+We recommend using a `features/support/paths.rb` file in your project to define mappings between verbal phrases and your project's routes. You can then use these phrases in steps like `Then I should be on ...` or `When I go to ...`.
+You can find [an example in this repository](https://github.com/makandra/spreewald/blob/master/examples/paths.rb). Please note that you may have to adapt it depending on the namespaces and other setup of your application's routes.
+
+Similarly, you may define a `features/support/paths.rb` file in your project to define mappings of verbal phrases to CSS selectors. You can also find [an example for that in this repository](https://github.com/makandra/spreewald/blob/master/examples/selectors.rb). These mappings can be used with steps like `Then I should( not)? see (an|the) element for ...` or `When I click on the element for ...`.
+
+We also suggest to look at our [recommended Capybara defaults](#recommended-capybara-defaults) as they impact the behavior of many Spreewald steps.
 
 ## Spreewald binary
 
 Spreewald comes with a binary that prints a list of all Cucumber steps from
 Spreewald _and your project_. It will filter the list by any string you
-pass it. Example usage:
+pass it. Example usage (e.g. on a linux shell in the root folder of the project which uses Spreewald):
 
 ```bash
 spreewald # lists all steps
@@ -94,7 +96,7 @@ 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,
+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
@@ -119,14 +121,11 @@ Spreewald has different kind of tests:
 
 Run all tests for your current ruby version with `rake` or `rake matrix:tests`. To bundle use `rake matrix:install` first.
 
-Please note that you need [geordi](https://github.com/makandra/geordi) to run the integration tests.
-
-
 ### If you would like to contribute:
 
 - Fork the repository
 - Push your changes with specs
-- Make sure `rake` passes
+- Make sure `rake matrix:tests` passes
 - Regenerate the "Steps" section of this Readme with `rake update_readme`, if needed
 - Make a pull request
 

data/lib/spreewald/time_steps.rb

@@ -22,7 +22,7 @@ if defined?(Timecop) || is_at_least_rails_4_1
 
     def use_timezones?
       active_record_loaded = defined?(ActiveRecord::Base)
-      (!active_record_loaded || ActiveRecord::Base.default_timezone != :local) && Time.zone
+      (!active_record_loaded || default_timezone != :local) && Time.zone
     end
 
     def parse_time(str)
@@ -41,6 +41,14 @@ if defined?(Timecop) || is_at_least_rails_4_1
       end
     end
 
+    def default_timezone
+      if ActiveRecord.respond_to?(:default_timezone)
+        ActiveRecord.default_timezone
+      else
+        ActiveRecord::Base.default_timezone
+      end
+    end
+
     if defined?(Timecop)
       # Emulate ActiveSupport time helper methods with Timecop - don't rename these methods
       def travel(duration)

data/lib/spreewald/web_steps.rb

@@ -48,7 +48,8 @@ When /^(.*) within (.*[^:])$/ do |nested_step, parent|
   selector = _selector_for(parent)
   if selector.is_a?(String) || selector.is_a?(Array) # could also be a Capybara::Node::Element
     patiently do
-      expect(page).to have_selector(*selector)
+      args, kwargs = deconstruct_selector(selector)
+      expect(page).to have_selector(*args, **kwargs)
     end
   end
   patiently do
@@ -160,8 +161,11 @@ end.overridable
 
 # Attach a file to a file upload form field
 When /^(?:|I )attach the file "([^"]*)" to "([^"]*)"$/ do |path, field|
+  options = {}
+  options[:make_visible] = true if javascript_capable?
+
   patiently do
-    attach_file(field, File.expand_path(path))
+    attach_file(field, File.expand_path(path), options)
   end
 end.overridable
 

data/lib/spreewald_support/path_selector_fallbacks.rb

@@ -31,7 +31,25 @@ World(PathSelectorFallbacks)
 
 module WithinHelpers
   def with_scope(locator)
-    locator ? within(*_selector_for(locator)) { yield } : yield
+    if locator
+      selector = _selector_for(locator)
+      args, kwargs = deconstruct_selector(selector)
+      within(*args, **kwargs) { yield }
+    else
+      yield
+    end
+  end
+
+  def deconstruct_selector(selector)
+    if selector.is_a?(Array)
+      if selector[-1].is_a?(Hash) # selector with keyword arguments, e.g. ['.foo', { text: 'bar', visible: :all }]
+        [selector[0...-1], **selector[-1]]
+      else # xpath selector, e.g. [:xpath, '//header']
+        [selector, {}]
+      end
+    else # String or Capybara::Node::Element
+      [selector, {}]
+    end
   end
 end
 World(WithinHelpers)

data/lib/spreewald_support/version.rb

@@ -1,3 +1,3 @@
 module Spreewald
-  VERSION = '4.3.5'
+  VERSION = '4.4.1'
 end

data/spreewald.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Collection of useful cucumber steps.}
   gem.homepage      = "https://github.com/makandra/spreewald"
   gem.license       = 'MIT'
+  gem.metadata = { 'rubygems_mfa_required' => 'true' }
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/tests/{rails-6_capybara-3 → rails-7_capybara-3}/Gemfile

@@ -3,7 +3,7 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 ruby '3.0.0'
 
-gem 'rails', '~>6.1'
+gem 'rails', '~>7'
 gem 'sqlite3'
 gem 'haml-rails'
 gem 'gemika'

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

@@ -0,0 +1,310 @@
+PATH
+  remote: ../..
+  specs:
+    spreewald (4.4.0)
+      cucumber
+      cucumber_priority (>= 0.3.0)
+      rspec (>= 2.13.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.2.3)
+      actionview (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.2.3)
+      activesupport (= 7.0.2.3)
+      globalid (>= 0.3.6)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activestorage (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    capybara (3.36.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    capybara-screenshot (1.0.25)
+      capybara (>= 1.0, < 4)
+      launchy
+    childprocess (3.0.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    cucumber (7.1.0)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-core (~> 10.1, >= 10.1.0)
+      cucumber-create-meta (~> 6.0, >= 6.0.1)
+      cucumber-cucumber-expressions (~> 14.0, >= 14.0.0)
+      cucumber-gherkin (~> 22.0, >= 22.0.0)
+      cucumber-html-formatter (~> 17.0, >= 17.0.0)
+      cucumber-messages (~> 17.1, >= 17.1.1)
+      cucumber-wire (~> 6.2, >= 6.2.0)
+      diff-lcs (~> 1.4, >= 1.4.4)
+      mime-types (~> 3.3, >= 3.3.1)
+      multi_test (~> 0.1, >= 0.1.2)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-core (10.1.1)
+      cucumber-gherkin (~> 22.0, >= 22.0.0)
+      cucumber-messages (~> 17.1, >= 17.1.1)
+      cucumber-tag-expressions (~> 4.1, >= 4.1.0)
+    cucumber-create-meta (6.0.4)
+      cucumber-messages (~> 17.1, >= 17.1.1)
+      sys-uname (~> 1.2, >= 1.2.2)
+    cucumber-cucumber-expressions (14.0.0)
+    cucumber-gherkin (22.0.0)
+      cucumber-messages (~> 17.1, >= 17.1.1)
+    cucumber-html-formatter (17.0.0)
+      cucumber-messages (~> 17.1, >= 17.1.0)
+    cucumber-messages (17.1.1)
+    cucumber-rails (2.5.0)
+      capybara (>= 2.18, < 4)
+      cucumber (>= 3.2, < 8)
+      mime-types (~> 3.3)
+      nokogiri (~> 1.10)
+      railties (>= 5.0, < 8)
+      rexml (~> 3.0)
+      webrick (~> 1.7)
+    cucumber-tag-expressions (4.1.0)
+    cucumber-wire (6.2.1)
+      cucumber-core (~> 10.1, >= 10.1.0)
+      cucumber-cucumber-expressions (~> 14.0, >= 14.0.0)
+    cucumber_priority (0.3.3)
+      cucumber
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.0)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    diff-lcs (1.5.0)
+    digest (3.1.0)
+    erubi (1.10.0)
+    erubis (2.7.0)
+    ffi (1.15.5)
+    gemika (0.5.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    haml (5.2.1)
+      temple (>= 0.8.0)
+      tilt
+    haml-rails (2.0.1)
+      actionpack (>= 5.1)
+      activesupport (>= 5.1)
+      haml (>= 4.0.6, < 6.0)
+      html2haml (>= 1.0.1)
+      railties (>= 5.1)
+    html2haml (2.2.0)
+      erubis (~> 2.7.0)
+      haml (>= 4.0, < 6)
+      nokogiri (>= 1.6.0)
+      ruby_parser (~> 3.5)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    io-wait (0.2.1)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    loofah (2.15.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    matrix (0.4.2)
+    method_source (1.0.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    mini_mime (1.1.2)
+    minitest (5.15.0)
+    multi_test (0.1.2)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.2)
+      io-wait
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
+    nokogiri (1.13.3-x86_64-linux)
+      racc (~> 1.4)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (7.0.2.3)
+      actioncable (= 7.0.2.3)
+      actionmailbox (= 7.0.2.3)
+      actionmailer (= 7.0.2.3)
+      actionpack (= 7.0.2.3)
+      actiontext (= 7.0.2.3)
+      actionview (= 7.0.2.3)
+      activejob (= 7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activerecord (= 7.0.2.3)
+      activestorage (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      bundler (>= 1.15.0)
+      railties (= 7.0.2.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.2.3)
+      actionpack (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    ruby_parser (3.15.1)
+      sexp_processor (~> 4.9)
+    rubyzip (2.3.0)
+    selenium-webdriver (3.142.7)
+      childprocess (>= 0.5, < 4.0)
+      rubyzip (>= 1.2.2)
+    sexp_processor (4.15.2)
+    sqlite3 (1.4.2)
+    strscan (3.0.1)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    temple (0.8.2)
+    thor (1.2.1)
+    tilt (2.0.10)
+    timeout (0.2.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    webrick (1.7.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  capybara (~> 3)
+  capybara-screenshot
+  cucumber
+  cucumber-rails
+  database_cleaner
+  gemika
+  haml-rails
+  pry
+  rails (~> 7)
+  rexml
+  rspec-rails
+  selenium-webdriver
+  spreewald!
+  sqlite3
+  webrick
+
+RUBY VERSION
+   ruby 3.0.0p0
+
+BUNDLED WITH
+   2.2.24

data/tests/{rails-6_capybara-3 → rails-7_capybara-3}/config/application.rb

@@ -22,7 +22,7 @@ Bundler.require(*Rails.groups)
 module Rails6Capybara3
   class Application < Rails::Application
     # Initialize configuration defaults for originally generated Rails version.
-    config.load_defaults 6.0
+    config.load_defaults 7.0
 
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration can go into files in config/initializers