aruba 1.1.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 447c91b46467e32b757f7ec3edeaacd9ef1f9e5de47d9df4739fffbabee9bb6c
-  data.tar.gz: bdd36a4d52ada46fab83ae3d8647f93a8c5526431572c3a627e5feea072b65d0
+  metadata.gz: bc48eb26abb5d1e638537ed9eaf53f5758c541ca48e9f979da107bb8a7bdcf6c
+  data.tar.gz: 75d8cc6d3c52b62538f688949ee212abd5c3dad8aca20fd3007860757eaf830e
 SHA512:
-  metadata.gz: ab49be0c20ad8e3ec29df0bad0a1f40403f4a7fbd660e6c820b285279f5766ff6f5b964b2b82b01493b047c5a7dd62b4302b0a74a1663911f299ab3c7b3deb03
-  data.tar.gz: 8e6982a29ba7e6b3abf1c1a74e2701b901672a13278ddae8b6a108abbfbeb88782e99c4e512c82aee4be7630471307b30c8fe581b18ee0e7386320e7c0c60f11
+  metadata.gz: bece1031dfa68f1fa9a80854758558596cc48d073996fb5d3f6440226d18e68c7408d478ffa6a9f7881aa52e3d172c1acaa1bf3bae5948b07af363e6a456c75d
+  data.tar.gz: 7f68b65140bbe200235a6e23aac68a5f4da28ca9cf47171cd28d758a2b70aaa5645b7a45f739a1fa803d5c5770864196224d4797685c0de40328a71db7697d90

data/CHANGELOG.md

@@ -6,7 +6,34 @@ This project adheres to [Semantic Versioning][1].
 
 This document is formatted according to the principles of [Keep A CHANGELOG][2].
 
-## [Unreleased]
+## [2.0.1] / 2022-04-22
+
+* Various cleanups of internal APIs ([#838] by [mvz])
+* Make objects not pretend to be nil ([#843] by [mvz])
+* Remove experimental variables replacement feature ([#846] by [mvz])
+* Support Ruby 3.1 ([#850] by [mvz])
+* Fix steps that wait for output from commands ([#856] by [mvz])
+* Ensure `Gem.win_platform?` is available ([#858] by [mvz])
+* Support JRuby 9.3 ([#867] by [mvz])
+
+## [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
 
@@ -977,8 +1004,36 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 
 <!-- issues & pull requests -->
 
+[#867]: https://github.com/cucumber/aruba/pull/867
+[#858]: https://github.com/cucumber/aruba/pull/858
+[#856]: https://github.com/cucumber/aruba/pull/856
+[#850]: https://github.com/cucumber/aruba/pull/850
+[#846]: https://github.com/cucumber/aruba/pull/846
+[#843]: https://github.com/cucumber/aruba/pull/843
+[#838]: https://github.com/cucumber/aruba/pull/838
+[#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
@@ -1257,7 +1312,10 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 
 <!-- Releases -->
 
-[Unreleased]:     https://github.com/cucumber/aruba/compare/v1.1.1...main
+[Unreleased]:     https://github.com/cucumber/aruba/compare/v2.0.1...main
+[2.0.1]:          https://github.com/cucumber/aruba/compare/v2.0.0...v2.0.1
+[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
@@ -1364,4 +1422,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.
@@ -145,6 +145,14 @@ docker run -v $PWD:/aruba --rm -it test-aruba:latest bash
 bundle exec rake
 ```
 
+If you want to run the test suite against specific versions of Aruba's
+dependencies, you can use [appraisal](https://github.com/thoughtbot/appraisal):
+
+```bash
+bundle exec appraisal cucumber_6 bundle install
+bundle exec appraisal cucumber_6 bundle exec rake
+```
+
 ### Installing your own gems used for development
 
 A `Gemfile.local` file can be used, to have your own gems installed to support
@@ -153,7 +161,6 @@ your normal development workflow.
 Example `Gemfile.local`:
 
 ```ruby
-gem 'pry'
 gem 'pry-byebug'
 gem 'byebug'
 ```

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,7 +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 in [./features/](https://github.com/cucumber/aruba/tree/master/features/).
+found in [./features/](https://github.com/cucumber/aruba/tree/main/features/).
 
 ### As a user getting started with a ruby testing framework
 
@@ -57,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:
 
@@ -73,12 +69,19 @@ Currently, this gem is mainly maintained by this group of people:
 
 ## Release Policy
 
-We try to comply with [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html).
+We use [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html). We
+depend on rubygems to ensure correct dependency versions, so dropping support
+for older dependencies and Ruby versions will not result in a major version
+bump.
 
 ## 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, 2.7, 3.0 and
+3.1, and JRuby 9.2 and 9.2.
+
+## Supported Cucumber versions
+
+Aruba is supported on and tested with Cucumber versions 4 through 7.
 
 ## Supported operating systems
 
@@ -91,10 +94,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/lib/aruba/api/bundler.rb

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

data/lib/aruba/api/commands.rb

@@ -226,8 +226,6 @@ module Aruba
         stop_signal       = opts[:stop_signal] || aruba.config.stop_signal
         startup_wait_time = opts[:startup_wait_time] || aruba.config.startup_wait_time
 
-        cmd = replace_variables(cmd)
-
         @commands ||= []
         @commands << cmd
 

data/lib/aruba/api/core.rb

@@ -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,12 +154,12 @@ 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
@@ -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." \
+              " 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

data/lib/aruba/api/filesystem.rb

@@ -326,12 +326,6 @@ module Aruba
       def append_to_file(file_name, file_content)
         file_name = expand_path(file_name)
 
-        unless File.exist? file_name
-          Aruba.platform.deprecated("The ability to call #append_to_file with a file that" \
-                                    " does not exist is deprecated and will be removed in" \
-                                    " Aruba 2.0.")
-          Aruba.platform.mkdir(File.dirname(file_name))
-        end
         File.open(file_name, "a") { |f| f << file_content }
       end
 
@@ -412,7 +406,7 @@ module Aruba
       #   Bytes on disk
       def disk_usage(*paths)
         paths = paths.flatten
-        expect(paths).to Aruba::Matchers.all be_an_existing_path
+        expect(paths).to all be_an_existing_path
         expanded = paths.map { |path| expand_path(path) }
 
         Aruba.platform.determine_disk_usage(expanded)

data/lib/aruba/api/text.rb

@@ -45,18 +45,6 @@ module Aruba
 
         text.chomp
       end
-
-      # Replace variables in command string (experimental)
-      #
-      # @param [#to_s] text
-      #   The text to parse
-      def replace_variables(text)
-        if text.include? "<pid-last-command-started>"
-          text = text.gsub(/<pid-last-command-started>/, last_command_started.pid.to_s)
-        end
-
-        text
-      end
     end
   end
 end

data/lib/aruba/console.rb

@@ -43,7 +43,7 @@ module Aruba
         end
 
         def inspect
-          "nil"
+          "aruba console"
         end
       end
 

data/lib/aruba/contracts/enum.rb

@@ -14,6 +14,7 @@ module Aruba
 
       # Create contract
       def initialize(*vals)
+        super()
         @vals = vals
       end