aruba 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26d3e68b36ad2938d35b9f147b8b776b3eb1e25b2e2a271f5346b8b423888964
-  data.tar.gz: 4a70c60f9ccb254e8c5edb7b9c91cc51274f11912c2c1554df61ed8d96cb3b5f
+  metadata.gz: 274e6609a41e03eb74e7fa94a41c6165f5db84e5cff6787c8793afdde8c56cef
+  data.tar.gz: 1252caf02a2a758f334ce58e8da97c21015e7477cfb8266695ae7b54b2db6e57
 SHA512:
-  metadata.gz: 10d08cceb237bb14cd0c0559163326c3340eba5a7db7275d876f6836ec11323b37e734dff617f727c783b653cbdbf47c333952177b0cea4b2117ea4d8ba4d2a7
-  data.tar.gz: 9c71d0e7409899b56b36d53c2a4581ea7143093bacd6dd8fbacac60c211512e7bd4118ef69f7f4e8bca651010609079f05c90f746cdb9f2fdcba41ae9e684430
+  metadata.gz: afa76ddef7027ba2e46f5db09114a9430b520f970ef03a8fb4989ffd383abece8629f20e3ea0ca657037b9a68b1a7cb8fff383342fced0ea4841a204c6b4389d
+  data.tar.gz: c3c7ef6f78b7a67e8a8cb44edd7ca7c72ee5fda00601ceee4eceba5663fb782a575933949b89389242454cef176e6ca89579380943c98a363e76db54fde5ba2c

data/CHANGELOG.md

@@ -6,6 +6,36 @@ This project adheres to [Semantic Versioning][1].
 
 This document is formatted according to the principles of [Keep A CHANGELOG][2].
 
+## [2.0.0] / 2021-07-26
+
+Potentially breaking changes:
+
+* Bump miminum cucumber version to 4 ([#814] by [mvz])
+* Drop support for Ruby 2.4 ([#820] by [mvz])
+* Remove deprecated ability to append to non-existent file ([#829] by [mvz])
+* Make absolute file name warning an error ([#783] by [mvz])
+
+Other changes
+
+* Use Ruby's built-in windows platform detection ([#813] by [mvz])
+* Update some step definitions to use Cucumber Expression syntax ([#822] by [mvz])
+* Update cucumber dependency to allow use of cucumber 7 ([#828] by [dependabot])
+
+## [1.1.2] / 2021-06-20
+
+* Add Bundler as an explicit runtime dependency ([#810] by [luke-hill])
+
+## [1.1.1] / 2021-05-14
+
+* Loosen dependency on the contracts gem ([#804] by [mvz])
+
+## [1.1.0] / 2021-04-14
+
+* Add step and API to add whole lines to a file ([#780] by [mvz])
+* Deprecate file creation when using `append_to_file` ([#781] by [mvz])
+* Update dependencies to cucumber to allow working with incoming major versions
+  ([#801] by [mattwynne])
+
 ## [1.0.4] / 2021-01-04
 
 * Update rubocop and fix new offenses (various pull requests)
@@ -964,6 +994,29 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 
 <!-- issues & pull requests -->
 
+[#829]: https://github.com/cucumber/aruba/pull/829
+[#828]: https://github.com/cucumber/aruba/pull/828
+[#822]: https://github.com/cucumber/aruba/pull/822
+[#820]: https://github.com/cucumber/aruba/pull/820
+[#814]: https://github.com/cucumber/aruba/pull/814
+[#813]: https://github.com/cucumber/aruba/pull/813
+[#810]: https://github.com/cucumber/aruba/pull/810
+[#804]: https://github.com/cucumber/aruba/pull/804
+[#801]: https://github.com/cucumber/aruba/pull/801
+[#783]: https://github.com/cucumber/aruba/pull/783
+[#781]: https://github.com/cucumber/aruba/pull/781
+[#780]: https://github.com/cucumber/aruba/pull/780
+[#772]: https://github.com/cucumber/aruba/pull/772
+[#771]: https://github.com/cucumber/aruba/pull/771
+[#769]: https://github.com/cucumber/aruba/pull/769
+[#767]: https://github.com/cucumber/aruba/pull/767
+[#766]: https://github.com/cucumber/aruba/pull/766
+[#763]: https://github.com/cucumber/aruba/pull/763
+[#751]: https://github.com/cucumber/aruba/pull/751
+[#750]: https://github.com/cucumber/aruba/pull/750
+[#748]: https://github.com/cucumber/aruba/pull/748
+[#738]: https://github.com/cucumber/aruba/pull/738
+[#737]: https://github.com/cucumber/aruba/pull/737
 [#727]: https://github.com/cucumber/aruba/pull/727
 [#725]: https://github.com/cucumber/aruba/pull/725
 [#724]: https://github.com/cucumber/aruba/pull/724
@@ -1242,7 +1295,12 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 
 <!-- Releases -->
 
-[Unreleased]:     https://github.com/cucumber/aruba/compare/v1.0.3...master
+[Unreleased]:     https://github.com/cucumber/aruba/compare/v2.0.0...main
+[2.0.0]:          https://github.com/cucumber/aruba/compare/v1.1.2...v2.0.0
+[1.1.2]:          https://github.com/cucumber/aruba/compare/v1.1.1...v1.1.2
+[1.1.1]:          https://github.com/cucumber/aruba/compare/v1.1.0...v1.1.1
+[1.1.0]:          https://github.com/cucumber/aruba/compare/v1.0.4...v1.1.0
+[1.0.4]:          https://github.com/cucumber/aruba/compare/v1.0.3...v1.0.4
 [1.0.3]:          https://github.com/cucumber/aruba/compare/v1.0.2...v1.0.3
 [1.0.2]:          https://github.com/cucumber/aruba/compare/v1.0.1...v1.0.2
 [1.0.1]:          https://github.com/cucumber/aruba/compare/v1.0.0...v1.0.1
@@ -1346,4 +1404,4 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 
 [1]:  http://semver.org
 [2]:  http://keepachangelog.com
-[3]:  https://github.com/cucumber/aruba/blob/master/CONTRIBUTING.md
+[3]:  https://github.com/cucumber/aruba/blob/main/CONTRIBUTING.md

data/CONTRIBUTING.md

@@ -73,7 +73,7 @@ Please...
 
 * Use pull requests for larger or controversial changes made by yourself or
   changes you might expected to break the build.
-* Commit smaller changes directly to master, e.g. fixing typos, adding tests or
+* Commit smaller changes directly to `main`, e.g. fixing typos, adding tests or
   adding documentation.
 * Update [`CHANGELOG.md`][] when a pull request is merged.
 * Make sure all tests are green before merging a pull request.
@@ -118,22 +118,15 @@ bundle install
 
 Run the following command to run the test suite.
 
-```bash
-# Run the test suite
-bin/test
-```
-
-Or use these Rake tasks:
-
 ```bash
 # Run the whole test suite
-rake test
+bundle exec rake
 # Run RSpec tests
-rake spec
+bundle exec rake spec
 # Run Cucumber features
-rake cucumber
+bundle exec rake cucumber
 # Run Cucumber features which are "WORK IN PROGRESS" and are allowed to fail
-rake cucumber:wip
+bundle exec rake cucumber:wip
 ```
 
 If you have problems because our assumptions about your local setup are wrong,
@@ -142,19 +135,22 @@ installed on your local system.
 
 ```bash
 # Build the docker container
-bundle exec rake docker:build
+docker build -t test-aruba .
 
-# Alternative: Build with disabled cache
-bundle exec rake 'docker:build[false]'
+# Open a bash shell inside the container with attached volume so changes to the
+# code will be picked up automatically.
+docker run -v $PWD:/aruba --rm -it test-aruba:latest bash
 
-# Build image with version tag
-bundle exec rake 'docker:build[false, 0.1.0]'
+# Run the test suite
+bundle exec rake
+```
 
-# Run the whole test suite in "docker"-container
-RUN_IN_DOCKER=1 bin/test
+If you want to run the test suite against specific versions of Aruba's
+dependencies, you can use [appraisal](https://github.com/thoughtbot/appraisal):
 
-# Run only selected scenario
-RUN_IN_DOCKER=1 bin/test cucumber features/steps/command/shell.feature:14
+```bash
+bundle exec appraisal cucumber_6 bundle install
+bundle exec appraisal cucumber_6 bundle exec rake
 ```
 
 ### Installing your own gems used for development
@@ -218,7 +214,7 @@ Now release it:
 bundle update
 
 # Run test suite
-bin/test
+bundle exec rake
 
 # Release gem
 git commit -m "Version bump"

data/README.md

@@ -1,11 +1,7 @@
-[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/cucumber/aruba/master/LICENSE)
-[![Docs](https://img.shields.io/badge/cucumber.pro-aruba-3d10af.svg)](https://app.cucumber.pro/projects/aruba)
+[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/cucumber/aruba/main/LICENSE)
 [![Gem Version](https://badge.fury.io/rb/aruba.svg)](http://badge.fury.io/rb/aruba)
-[![Code Climate](https://codeclimate.com/github/cucumber/aruba.svg)](https://codeclimate.com/github/cucumber/aruba)
 [![Support](https://img.shields.io/badge/cucumber-support-orange.svg)](https://cucumber.io/support)
-
-[![Travis CI build status](https://travis-ci.org/cucumber/aruba.svg)](https://travis-ci.org/cucumber/aruba) 
-[![Appveyor build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl?svg=true)](https://ci.appveyor.com/project/cucumberbdd/aruba)
+[![Build Status](https://github.com/cucumber/aruba/actions/workflows/ruby.yml/badge.svg)](https://github.com/cucumber/aruba/actions/workflows/ruby.yml)
 
 ## Install
 
@@ -32,8 +28,7 @@ gem install aruba
 ### As a user getting started with Aruba
 
 Our most current documentation to get started with Aruba as a user can be
-found on [Cucumber Jam](https://app.cucumber.pro/projects/aruba).
-It is generated from our feature files describing the use of Aruba.
+found in [./features/](https://github.com/cucumber/aruba/tree/main/features/).
 
 ### As a user getting started with a ruby testing framework
 
@@ -58,15 +53,15 @@ A full documentation of the API for developers can be found on
 
 ## Support
 
-### Channels
-
 For support, please have a look at the [support website](https://cucumber.io/support)
 of Cucumber. You have different options to reach out for help: Recommended for
 Aruba are using the Slack channels — e.g. `committers-aruba` or `help-cucumber-ruby`
-— ([register account](https://cucumberbdd-slack-invite.herokuapp.com/)), and the
+— ([register account](https://cucumberbdd-slack-invite.herokuapp.com/))
+
+Concrete issues can be reported via the
 [Issues page on GitHub](https://github.com/cucumber/aruba/issues).
 
-### Maintainers
+## Maintainers
 
 Currently, this gem is mainly maintained by this group of people:
 
@@ -78,8 +73,8 @@ We try to comply with [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.
 
 ## Supported Ruby versions
 
-Aruba is supported on Ruby 2.4 and up, and tested against CRuby 2.4, 2.5, 2.6
-and 2.7, and JRuby 9.2.
+Aruba is supported on Ruby 2.5 and up, and tested against CRuby 2.5, 2.6 and
+2.7, and JRuby 9.2.
 
 ## Supported operating systems
 
@@ -92,10 +87,10 @@ Please see the [CONTRIBUTING](CONTRIBUTING.md) file.
 
 ## Code branches
 
-Development takes place in the `master` branch and currently targets the 1.x
-releases. If necessary, maintenance of the old 0.14.x releases takes place in
-the `0-14-stable` branch. Stable branches will not be created until absolutely
-necessary.
+Development takes place in the `main` branch and currently targets the 2.x
+releases. If necessary, maintenance of the old 1.1.x releases will take place
+in a `1-1-stable` branch, and of 0.14.x releases in the `0-14-stable` branch.
+Stable branches will not be created until absolutely necessary.
 
 ## License
 

data/exe/aruba

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH << File.expand_path('../lib', __dir__)
+$LOAD_PATH << File.expand_path("../lib", __dir__)
 
-require 'aruba/cli'
+require "aruba/cli"
 
 Aruba::Cli.start

data/lib/aruba.rb

@@ -1 +1 @@
-require 'aruba/api'
+require "aruba/api"

data/lib/aruba/api.rb

@@ -1,18 +1,18 @@
-require 'rspec/expectations'
-require 'shellwords'
+require "rspec/expectations"
+require "shellwords"
 
-require 'aruba/version'
+require "aruba/version"
 
-require 'aruba/platform'
-require 'aruba/api/core'
-require 'aruba/api/commands'
+require "aruba/platform"
+require "aruba/api/core"
+require "aruba/api/commands"
 
-require 'aruba/api/environment'
-require 'aruba/api/filesystem'
-require 'aruba/api/text'
-require 'aruba/api/bundler'
+require "aruba/api/environment"
+require "aruba/api/filesystem"
+require "aruba/api/text"
+require "aruba/api/bundler"
 
-Aruba.platform.require_matching_files('../matchers/**/*.rb', __FILE__)
+Aruba.platform.require_matching_files("../matchers/**/*.rb", __FILE__)
 
 # Aruba
 module Aruba

data/lib/aruba/api/bundler.rb

@@ -1,4 +1,5 @@
-require 'aruba/api/environment'
+require "aruba/api/environment"
+require "bundler"
 
 module Aruba
   module Api

data/lib/aruba/api/commands.rb

@@ -1,7 +1,7 @@
-require 'pathname'
+require "pathname"
 
-require 'aruba/platform'
-require 'aruba/command'
+require "aruba/platform"
+require "aruba/command"
 
 # require 'win32/file' if File::ALT_SEPARATOR
 
@@ -22,7 +22,7 @@ module Aruba
       def which(program, path = nil)
         with_environment do
           # ENV is set within this block
-          path = ENV['PATH'] if path.nil?
+          path = ENV["PATH"] if path.nil?
 
           Aruba.platform.which(program, path)
         end
@@ -35,7 +35,7 @@ module Aruba
       def pipe_in_file(file_name)
         file_name = expand_path(file_name)
 
-        File.open(file_name, 'r').each_line do |line|
+        File.open(file_name, "r").each_line do |line|
           last_command_started.write(line)
         end
       end
@@ -152,7 +152,7 @@ module Aruba
 
         unless command.interactive?
           raise NotImplementedError,
-                'Running interactively is not supported with this process launcher.'
+                "Running interactively is not supported with this process launcher."
         end
 
         start_command(command)
@@ -232,7 +232,7 @@ module Aruba
         @commands << cmd
 
         environment       = aruba.environment
-        working_directory = expand_path('.')
+        working_directory = expand_path(".")
         event_bus         = aruba.event_bus
 
         cmd = Aruba.platform.detect_ruby(cmd)

data/lib/aruba/api/core.rb

@@ -1,7 +1,7 @@
-require 'rspec/expectations'
-require 'aruba/runtime'
-require 'aruba/errors'
-require 'aruba/setup'
+require "rspec/expectations"
+require "aruba/runtime"
+require "aruba/errors"
+require "aruba/setup"
 
 # Aruba
 module Aruba
@@ -38,8 +38,8 @@ module Aruba
       # @yield
       #   The block which should be run in current directory
       def in_current_directory(&block)
-        create_directory '.' unless directory?('.')
-        cd('.', &block)
+        create_directory "." unless directory?(".")
+        cd(".", &block)
       end
 
       # Switch to directory
@@ -64,9 +64,9 @@ module Aruba
                     "#{expand_path(dir)} is not a directory or does not exist."
             end
 
-            old_directory = expand_path('.')
+            old_directory = expand_path(".")
             aruba.current_directory << dir
-            new_directory = expand_path('.')
+            new_directory = expand_path(".")
 
             aruba.event_bus.notify Events::ChangedWorkingDirectory.new(old: old_directory,
                                                                        new: new_directory)
@@ -78,8 +78,8 @@ module Aruba
             Aruba.platform.chdir real_new_directory
 
             result = with_environment(
-              'OLDPWD' => old_dir,
-              'PWD' => real_new_directory,
+              "OLDPWD" => old_dir,
+              "PWD" => real_new_directory,
               &block
             )
           ensure
@@ -94,9 +94,9 @@ module Aruba
           raise ArgumentError, "#{expand_path(dir)} is not a directory or does not exist."
         end
 
-        old_directory = expand_path('.')
+        old_directory = expand_path(".")
         aruba.current_directory << dir
-        new_directory = expand_path('.')
+        new_directory = expand_path(".")
 
         aruba.event_bus.notify Events::ChangedWorkingDirectory.new(old: old_directory,
                                                                    new: new_directory)
@@ -117,34 +117,36 @@ module Aruba
       #
       # @example Single file name
       #
-      #   # => <path>/tmp/aruba/file
       #   expand_path('file')
+      #   # => <path>/tmp/aruba/file
       #
       # @example Single Dot
       #
-      #   # => <path>/tmp/aruba
       #   expand_path('.')
+      #   # => <path>/tmp/aruba
       #
       # @example using home directory
       #
-      #   # => <path>/home/<name>/file
       #   expand_path('~/file')
+      #   # => <path>/home/<name>/file
       #
       # @example using fixtures directory
       #
-      #   # => <path>/test/fixtures/file
       #   expand_path('%/file')
+      #   # => <path>/test/fixtures/file
       #
-      # @example Absolute directory
+      # @example Absolute directory (requires aruba.config.allow_absolute_paths
+      # to be set)
       #
-      #   # => /foo/bar
       #   expand_path('/foo/bar')
+      #   # => /foo/bar
       #
       def expand_path(file_name, dir_string = nil)
         unless file_name.is_a?(String) && !file_name.empty?
           message = "Filename #{file_name} needs to be a string." \
-            ' It cannot be nil or empty either. '\
-            "Please use `expand_path('.')` if you want the current directory to be expanded."
+                    " It cannot be nil or empty either."\
+                    " Please use `expand_path('.')` if you want" \
+                    " the current directory to be expanded."
 
           raise ArgumentError, message
         end
@@ -152,32 +154,32 @@ module Aruba
         unless Aruba.platform.directory? File.join(aruba.config.root_directory,
                                                    aruba.config.working_directory)
           raise "Aruba's working directory does not exist." \
-            ' Maybe you forgot to run `setup_aruba` before using its API.'
+                " Maybe you forgot to run `setup_aruba` before using its API."
         end
 
         prefix = file_name[0]
 
-        if aruba.config.fixtures_path_prefix == prefix
+        if prefix == aruba.config.fixtures_path_prefix
           rest = file_name[2..-1]
           path = File.join(*[aruba.fixtures_directory, rest].compact)
           unless Aruba.platform.exist? path
             aruba_fixture_candidates = aruba.config.fixtures_directories
-                                            .map { |p| format('"%s"', p) }.join(', ')
+                                            .map { |p| format('"%s"', p) }.join(", ")
 
             raise ArgumentError,
                   "Fixture \"#{rest}\" does not exist" \
                   " in fixtures directory \"#{aruba.fixtures_directory}\"." \
-                  ' This was the one we found first on your system from all possible' \
+                  " This was the one we found first on your system from all possible" \
                   " candidates: #{aruba_fixture_candidates}."
           end
 
           path
-        elsif prefix == '~'
+        elsif prefix == "~"
           path = with_environment do
             File.expand_path(file_name)
           end
 
-          raise ArgumentError, 'Expanding "~/" to "/" is not allowed' if path == '/'
+          raise ArgumentError, 'Expanding "~/" to "/" is not allowed' if path == "/"
 
           unless Aruba.platform.absolute_path? path
             raise ArgumentError,
@@ -189,11 +191,13 @@ module Aruba
           unless aruba.config.allow_absolute_paths
             caller_location = caller_locations(1, 1).first
             caller_file_line = "#{caller_location.path}:#{caller_location.lineno}"
-            aruba.logger.warn \
+            message =
               "Aruba's `expand_path` method was called with an absolute path" \
               " at #{caller_file_line}, which is not recommended." \
-              ' Change the call to pass a relative path or set '\
-              '`config.allow_absolute_paths = true` to silence this warning'
+              " The path passed was '#{file_name}'." \
+              " Change the call to pass a relative path or set "\
+              "`config.allow_absolute_paths = true` to silence this warning"
+            raise UserError, message
           end
           file_name
         else