aruba 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63d0e00b28a69fa235c0586425c501669cb313ce3dae63a76a33386eb358085e
-  data.tar.gz: be16476fe85c35d571574194c46c426cbb5805fff5fe2277b04b3f32f7098dc8
+  metadata.gz: 9b464d3e65f58bdcafd421ed026c8541de9cc9723258f76175b8b8ad3dab4621
+  data.tar.gz: 2215471629083ac51e4b5e31694ac60408d374f8a0aa504addb79ae70f364e84
 SHA512:
-  metadata.gz: 77fcdcd8b492e23fc72be16b48dd9913a3e7615ade362006cff3754661c0176c4483ce9d78ac7aa9d0c4da08ff1ae2c4f741b0f80ff93a221b10f7f2806b7c5f
-  data.tar.gz: 1d8f1f0f2879f5fef29c3baeee8d2041cd2d130e8cdfed5e77dac075960c0fd6ee0c813f6be1400e176b3a6846819946f1e5b56a02be2933b1e1b7682c313102
+  metadata.gz: 2222d8d29dccca2bcbe973512ae24bbdc14a82d2b7dbb3e1fd84b72c35793af4919043cc077bacb2e48db3fbe9c8f60d2c8ed032a36a93d88a0c2ec3ef2e190f
+  data.tar.gz: 007bda65f38b79499f0fda2243f44539c76e541d871cf66b841adafbe1f9a7800946d96c32637264313a24f381f4f97d176a93a02d0e171f1d116d3467b58c19

data/CHANGELOG.md

@@ -6,6 +6,56 @@ This project adheres to [Semantic Versioning][1].
 
 This document is formatted according to the principles of [Keep A CHANGELOG][2].
 
+## [Unreleased]
+
+## [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
+  ([00cb0789](https://github.com/cucumber/aruba/commit/00cb07897c9f99e59bea630ae164cf5aa78fa76c)
+  by [mvz]).
+* Various small code cleanups ([#717] by [mvz])
+
+## [1.0.1]
+
+### Bug fixes
+
+* Allow use of Aruba with Cucumber 4 ([#715] by [mvz])
+
+### Code quality and documentation improvements
+
+* Fix RuboCop offenses ([#693] and [#708] by [luke-hill], [#710], [#711] and
+  [#712] by [mvz])
+* Use recent Rake version in fixtures ([#709] by [mvz])
+* Repair YARD annotations ([#707] by [olleolleolle])
+
 ## [1.0.0]
 
 ### Breaking changes compared to Aruba 0.14.x
@@ -916,18 +966,34 @@ 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 -->
 
+[#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
+[#711]: https://github.com/cucumber/aruba/pull/711
+[#710]: https://github.com/cucumber/aruba/pull/710
+[#709]: https://github.com/cucumber/aruba/pull/709
+[#708]: https://github.com/cucumber/aruba/pull/708
+[#707]: https://github.com/cucumber/aruba/pull/707
 [#704]: https://github.com/cucumber/aruba/pull/704
 [#703]: https://github.com/cucumber/aruba/pull/703
 [#702]: https://github.com/cucumber/aruba/pull/702
 [#701]: https://github.com/cucumber/aruba/pull/701
 [#698]: https://github.com/cucumber/aruba/pull/698
 [#696]: https://github.com/cucumber/aruba/pull/696
+[#693]: https://github.com/cucumber/aruba/pull/693
 [#692]: https://github.com/cucumber/aruba/pull/692
 [#690]: https://github.com/cucumber/aruba/pull/690
 [#689]: https://github.com/cucumber/aruba/pull/689
@@ -1186,7 +1252,12 @@ Note: These are changes w.r.t. Aruba version 0.14.1.
 
 <!-- Releases -->
 
-[Unreleased]:     https://github.com/cucumber/aruba/compare/v1.0.0...master
+[Unreleased]:     https://github.com/cucumber/aruba/compare/v1.1.0...master
+[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
 [1.0.0.pre.alpha.5]: https://github.com/cucumber/aruba/compare/v1.0.0.pre.alpha.4...v1.0.0.pre.alpha.5
 [1.0.0.pre.alpha.4]: https://github.com/cucumber/aruba/compare/v1.0.0.pre.alpha.3...v1.0.0.pre.alpha.4

data/CONTRIBUTING.md

@@ -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,14 @@ 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 whole test suite in "docker"-container
-RUN_IN_DOCKER=1 bin/test
-
-# Run only selected scenario
-RUN_IN_DOCKER=1 bin/test cucumber features/steps/command/shell.feature:14
+# Run the test suite
+bundle exec rake
 ```
 
 ### Installing your own gems used for development
@@ -210,8 +198,6 @@ bundle exec rake install:local
   entries for all fixes.
 * No need to add a [`CHANGELOG.md`] header at this point - this should be done
   later, when a new change is made.
-* If a major version is released, update the `still` branch, which points to
-  the "old" major version.
 
 Now release it:
 
@@ -220,17 +206,11 @@ Now release it:
 bundle update
 
 # Run test suite
-bin/test
+bundle exec rake
 
 # Release gem
 git commit -m "Version bump"
 bundle exec rake release
-
-# If it's a major relase:
-# Merge changes back to have correct documentation
-git checkout still
-git merge master
-git push
 ```
 
 Now send a PR to [cucumber/website] adding an article

data/README.md

@@ -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/master/features/).
 
 ### As a user getting started with a ruby testing framework
 

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,4 @@
-require 'aruba/api/environment'
+require "aruba/api/environment"
 
 module Aruba
   module Api
@@ -7,8 +7,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)
@@ -168,16 +168,16 @@ module Aruba
       # @param [String] cmd
       #   The command to be executed
       #
-      # @param [Hash] options
+      # @param [Hash] opts
       #   Options for aruba
       #
-      # @option options [Boolean] fail_on_error
+      # @option opts [Boolean] :fail_on_error
       #   Should aruba fail on error?
       #
-      # @option options [Numeric] exit_timeout
+      # @option opts [Numeric] :exit_timeout
       #   Timeout for execution
       #
-      # @option options [Numeric] io_wait_timeout
+      # @option opts [Numeric] :io_wait_timeout
       #   Timeout for IO - STDERR, STDOUT
       #
       def run_command_and_stop(cmd, opts = {})
@@ -220,12 +220,11 @@ module Aruba
 
       private
 
-      # rubocop:disable Metrics/MethodLength
       def prepare_command(cmd, opts)
-        exit_timeout      = opts[:exit_timeout].nil? ? aruba.config.exit_timeout : opts[:exit_timeout]
-        io_wait_timeout   = opts[:io_wait_timeout].nil? ? aruba.config.io_wait_timeout : opts[:io_wait_timeout]
-        stop_signal       = opts[:stop_signal].nil? ? aruba.config.stop_signal : opts[:stop_signal]
-        startup_wait_time = opts[:startup_wait_time].nil? ? aruba.config.startup_wait_time : opts[:startup_wait_time]
+        exit_timeout      = opts[:exit_timeout] || aruba.config.exit_timeout
+        io_wait_timeout   = opts[:io_wait_timeout] || aruba.config.io_wait_timeout
+        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)
 
@@ -233,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,10 +255,8 @@ module Aruba
         )
       end
 
-      # rubocop:enable Metrics/MethodLength
-
       def start_command(command)
-        aruba.config.before(:command, self, command)
+        aruba.config.run_before_hook(:command, self, command)
 
         in_current_directory do
           command.start
@@ -268,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
@@ -15,8 +15,10 @@ module Aruba
 
       # Aruba Runtime
       def aruba
-        # TODO: Check this variable being accessed inconsistently. Should only be using the memo!
-        # Renaming this to `aruba` causes 100's of rspec failures. Needs a deeper dive, approach with caution!
+        # TODO: Check this variable being accessed inconsistently. Should only
+        # be using the memo!
+        # Renaming this to `aruba` causes 100's of rspec failures. Needs a
+        # deeper dive, approach with caution!
         @_aruba_runtime ||= Runtime.new
       end
 
@@ -36,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
@@ -54,26 +56,30 @@ module Aruba
       # @example Run code in directory
       #   result = cd('some-dir') { Dir.getwd }
       #
-      # rubocop:disable Metrics/MethodLength
       def cd(dir, &block)
-        if block_given?
+        if block
           begin
-            fail ArgumentError, "#{expand_path(dir)} is not a directory or does not exist." unless Aruba.platform.directory? expand_path(dir)
+            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)
+            aruba.event_bus.notify Events::ChangedWorkingDirectory.new(old: old_directory,
+                                                                       new: new_directory)
 
             old_dir = Aruba.platform.getwd
 
-            real_new_directory = File.expand_path(aruba.current_directory, aruba.root_directory)
+            real_new_directory = File.expand_path(aruba.current_directory,
+                                                  aruba.root_directory)
             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
@@ -84,17 +90,19 @@ module Aruba
           return result
         end
 
-        fail ArgumentError, "#{expand_path(dir)} is not a directory or does not exist." unless Aruba.platform.directory? expand_path(dir)
+        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)
+        aruba.event_bus.notify Events::ChangedWorkingDirectory.new(old: old_directory,
+                                                                   new: new_directory)
 
         self
       end
-      # rubocop:enable Metrics/MethodLength
 
       # Expand file name
       #
@@ -132,48 +140,60 @@ module Aruba
       #   # => /foo/bar
       #   expand_path('/foo/bar')
       #
-      # rubocop:disable Metrics/MethodLength
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/PerceivedComplexity
       def expand_path(file_name, dir_string = nil)
-        # rubocop:disable Layout/LineLength
-        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.)
-        # rubocop:enable Layout/LineLength
-
-        fail ArgumentError, message unless file_name.is_a?(String) && !file_name.empty?
+        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."
 
-        # rubocop:disable Layout/LineLength
-        fail %(Aruba's working directory does not exist. Maybe you forgot to run `setup_aruba` before using its API.) unless Aruba.platform.directory? File.join(aruba.config.root_directory, aruba.config.working_directory)
+          raise ArgumentError, message
+        end
 
-        # rubocop:enable Layout/LineLength
+        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."
+        end
 
         prefix = file_name[0]
-        rest = file_name[2..-1]
 
         if aruba.config.fixtures_path_prefix == prefix
+          rest = file_name[2..-1]
           path = File.join(*[aruba.fixtures_directory, rest].compact)
-
-          # rubocop:disable Layout/LineLength
-          fail 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 candidates: #{aruba.config.fixtures_directories.map { |p| format('"%s"', p) }.join(', ')}.) unless Aruba.platform.exist? path
-
-          # rubocop:enable Layout/LineLength
+          unless Aruba.platform.exist? path
+            aruba_fixture_candidates = aruba.config.fixtures_directories
+                                            .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" \
+                  " candidates: #{aruba_fixture_candidates}."
+          end
 
           path
-        elsif prefix == '~'
+        elsif prefix == "~"
           path = with_environment do
             File.expand_path(file_name)
           end
 
-          fail ArgumentError, 'Expanding "~/" to "/" is not allowed' if path == '/'
-          fail ArgumentError, %(Expanding "~/" to a relative path "#{path}" is not allowed) unless Aruba.platform.absolute_path? path
+          raise ArgumentError, 'Expanding "~/" to "/" is not allowed' if path == "/"
+
+          unless Aruba.platform.absolute_path? path
+            raise ArgumentError,
+                  "Expanding \"~\" to a relative path \"#{path}\" is not allowed"
+          end
 
           path.to_s
-        elsif absolute? file_name
+        elsif absolute?(file_name)
           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 "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'
+            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"
           end
           file_name
         else
@@ -184,9 +204,6 @@ module Aruba
           end
         end
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
 
       # Run block with environment
       #