aruba 1.0.2 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f5a2c9af56d4b502edae4592455415530bd8077f5078608ac174fdd42828e84
-  data.tar.gz: e057fc77eb5bf2680b08978f90d3d4bf5c166e3a400a3d691124f5d624e37e67
+  metadata.gz: 310ecfb205a45e39a9822c3d40272f5b1121eaa132ee597589c816b53b478ae2
+  data.tar.gz: 664722acb2e5e82421f25b1a9be77720af6b191935bdc3e177ee4c962697f0fe
 SHA512:
-  metadata.gz: 41edd733387784f50d386c5fd718610a00970c5e2d1cb60cc87dae9e79a8883d2447136782c3e7e101e208b949f7451fe99ac8ebc91ab0547b529f097da04286
-  data.tar.gz: f7c553b8fc220a0e1b49ddcbe92d8d1da179330c05dff80e70dbcac6ed9ef501ff27b2e663afdecaff18a471d718e249e0b3d7b704baafb80603c187045321b2
+  metadata.gz: ddc31e116d5d122e70e4cc95ad0596318ffcfb4955b02b54f64a3800ea6917c461ca0332108e586811931f31253e34cae5ca011f4a7094aa2686f724ff9141a4
+  data.tar.gz: f63cd42a52b764686866d0a9070429830979136927270cd704d47ab7cd5533e656a7fc2b055cbee9d14e3dd8ed27a3ab7c8727a446bee89da9f88ec8e130735a

data/CHANGELOG.md

@@ -6,6 +6,44 @@ This project adheres to [Semantic Versioning][1].
 
 This document is formatted according to the principles of [Keep A CHANGELOG][2].
 
+## [Unreleased]
+
+## [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)
+* Turn off Cucumber publish warning in CI ([#737] by [olleolleolle])
+* Move CI from Travis CI to GitHub Actions ([#738] by [mvz])
+* Remove superfluous :each from before hooks in RSpec-related cucumber
+  scenarios ([#748] by [mvz])
+* Make disabling Bundler more robust ([#750] by [mvz])
+* Officially support Ruby 3.0 ([#763] by [mvz])
+* Clean up hook methods in configuration ([#751] by [mvz])
+* Speed up RSpec suite ([#767] by [mvz])
+* Speed up Cucumber suite ([#766] and [#771] by [mvz])
+* Remove obsolete `String#strip_heredoc` monkey-patch ([#769] by [mvz])
+* Simplify configuration option specification ([#772] by [mvz])
+
+## [1.0.3]
+
+* Loosen Cucumber dependency to allow Cucumber 5.0 ([#727] by [mvz])
+* Update rubocop and fix new offenses ([#719] and [#724] by [mvz])
+* Rework gemspec to avoid dependency on git ([#721] by [utkarsh2102], [#725] by [mvz])
+
 ## [1.0.2]
 
 * Loosen childprocess dependency
@@ -936,12 +974,21 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 [scottj97]:       https://github.com/scottj97
 [stamhankar999]:  https://github.com/stamhankar999
 [taylor]:         https://github.com/taylor
+[utkarsh2102]:    https://github.com/utkarsh2102
 [tdreyno]:        https://github.com/tdreyno
 [xtrasimplicity]: https://github.com/xtrasimplicity
 [y-higuchi]:      https://github.com/y-higuchi
 
 <!-- issues & pull requests -->
 
+[#810]: https://github.com/cucumber/aruba/pull/810
+[#804]: https://github.com/cucumber/aruba/pull/804
+[#801]: https://github.com/cucumber/aruba/pull/801
+[#727]: https://github.com/cucumber/aruba/pull/727
+[#725]: https://github.com/cucumber/aruba/pull/725
+[#724]: https://github.com/cucumber/aruba/pull/724
+[#721]: https://github.com/cucumber/aruba/pull/721
+[#719]: https://github.com/cucumber/aruba/pull/719
 [#717]: https://github.com/cucumber/aruba/pull/717
 [#715]: https://github.com/cucumber/aruba/pull/715
 [#712]: https://github.com/cucumber/aruba/pull/712
@@ -1215,7 +1262,12 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 
 <!-- Releases -->
 
-[Unreleased]:     https://github.com/cucumber/aruba/compare/v1.0.2...master
+[Unreleased]:     https://github.com/cucumber/aruba/compare/v1.1.2...main
+[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
 [1.0.0]:          https://github.com/cucumber/aruba/compare/v1.0.0.pre.alpha.5...v1.0.0
@@ -1318,4 +1370,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,4 +1,4 @@
-[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/cucumber/aruba/master/LICENSE)
+[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/cucumber/aruba/main/LICENSE)
 [![Docs](https://img.shields.io/badge/cucumber.pro-aruba-3d10af.svg)](https://app.cucumber.pro/projects/aruba)
 [![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)
@@ -32,8 +32,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 +57,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:
 
@@ -92,7 +91,7 @@ Please see the [CONTRIBUTING](CONTRIBUTING.md) file.
 
 ## Code branches
 
-Development takes place in the `master` branch and currently targets the 1.x
+Development takes place in the `main` 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.

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,19 +1,18 @@
-require 'rspec/expectations'
-require 'shellwords'
+require "rspec/expectations"
+require "shellwords"
 
-require 'aruba/version'
-require 'aruba/extensions/string/strip'
+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
@@ -7,8 +8,23 @@ module Aruba
 
       # Unset variables used by bundler
       def unset_bundler_env_vars
-        %w(RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE).each do |key|
-          delete_environment_variable(key)
+        empty_env = with_environment { with_unbundled_env { ENV.to_h } }
+        aruba_env = aruba.environment.to_h
+        (aruba_env.keys - empty_env.keys).each do |key|
+          delete_environment_variable key
+        end
+        empty_env.each do |k, v|
+          set_environment_variable k, v
+        end
+      end
+
+      private
+
+      def with_unbundled_env(&block)
+        if ::Bundler.respond_to?(:with_unbundled_env)
+          ::Bundler.with_unbundled_env(&block)
+        else
+          ::Bundler.with_clean_env(&block)
         end
       end
     end

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
@@ -64,7 +64,7 @@ module Aruba
       #   If block is given use it to filter the commands which should be
       #   stoppend.
       def stop_all_commands(&block)
-        cmds = if block_given?
+        cmds = if block
                  all_commands.select(&block)
                else
                  all_commands
@@ -81,7 +81,7 @@ module Aruba
       #   If block is given use it to filter the commands which should be
       #   terminated.
       def terminate_all_commands(&block)
-        cmds = if block_given?
+        cmds = if block
                  all_commands.select(&block)
                else
                  all_commands
@@ -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)
@@ -256,7 +256,7 @@ module Aruba
       end
 
       def start_command(command)
-        aruba.config.before(:command, self, command)
+        aruba.config.run_before_hook(:command, self, command)
 
         in_current_directory do
           command.start
@@ -265,7 +265,7 @@ module Aruba
         stop_signal = command.stop_signal
         aruba.announcer.announce(:stop_signal, command.pid, stop_signal) if stop_signal
 
-        aruba.config.after(:command, self, command)
+        aruba.config.run_after_hook(:command, self, command)
       end
     end
   end

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
@@ -57,16 +57,16 @@ module Aruba
       #   result = cd('some-dir') { Dir.getwd }
       #
       def cd(dir, &block)
-        if block_given?
+        if block
           begin
             unless Aruba.platform.directory?(expand_path(dir))
               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)
@@ -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)
@@ -143,7 +143,7 @@ module Aruba
       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. '\
+            " It cannot be nil or empty either. "\
             "Please use `expand_path('.')` if you want the current directory to be expanded."
 
           raise ArgumentError, message
@@ -152,7 +152,7 @@ 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]
@@ -162,22 +162,22 @@ module Aruba
           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,
@@ -192,8 +192,8 @@ module Aruba
             aruba.logger.warn \
               "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'
+              " Change the call to pass a relative path or set "\
+              "`config.allow_absolute_paths = true` to silence this warning"
           end
           file_name
         else