aruba 1.0.0.pre.alpha.4 → 1.0.3

data/CONTRIBUTING.md

@@ -129,11 +129,11 @@ Or use these Rake tasks:
 # Run the whole test suite
 rake test
 # Run RSpec tests
-rake test:rspec
+rake spec
 # Run Cucumber features
-rake test:cucumber
+rake cucumber
 # Run Cucumber features which are "WORK IN PROGRESS" and are allowed to fail
-rake test:cucumber_wip
+rake cucumber:wip
 ```
 
 If you have problems because our assumptions about your local setup are wrong,
@@ -186,7 +186,6 @@ Aruba's Rakefile provides the following linting tasks
 bundle exec rake lint                         # Run all linters
 bundle exec rake lint:coding_guidelines       # Lint our code with "rubocop"
 bundle exec rake lint:licenses                # Check for relevant licenses in project
-bundle exec rake lint:travis                  # Lint our .travis.yml
 ```
 
 ### Building and installing your local Aruba version
@@ -195,11 +194,11 @@ You can use the following Rake tasks to build and install your work-in-progress
 
 ```bash
 # Build your copy
-bundle exec rake rubygem:build
+bundle exec rake build
 # Build and install your copy
-bundle exec rake rubygem:install
+bundle exec rake install
 # Build and install your copy without network access
-bundle exec rake rubygem:install:local
+bundle exec rake install:local
 ```
 
 ## Getting started as a "Maintainer"
@@ -211,8 +210,6 @@ bundle exec rake rubygem: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:
 
@@ -225,13 +222,7 @@ bin/test
 
 # Release gem
 git commit -m "Version bump"
-bin/release
-
-# If it's a major relase:
-# Merge changes back to have correct documentation
-git checkout still
-git merge master
-git push
+bundle exec rake release
 ```
 
 Now send a PR to [cucumber/website] adding an article

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2016 Aslak Hellesøy, David Chelimsky, Mike Sassak, Jarl Friis, Matt Wynne, Dennis Günnewig
+Copyright (c) 2010-2020 Aslak Hellesøy, David Chelimsky, Mike Sassak, Jarl Friis, Matt Wynne, Dennis Günnewig and Matijs van Zuijlen
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,66 +1,70 @@
-[![GitHub 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/master/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)
 [![Support](https://img.shields.io/badge/cucumber-support-orange.svg)](https://cucumber.io/support)
 
-[![Build Status for "master" on Linux/Mac OS](https://travis-ci.org/cucumber/aruba.svg?branch=master)](https://travis-ci.org/cucumber/aruba) 
-[![Build status for "master" on Windows](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl/branch/master?svg=true&passingText=master%20windows%20passing&failingText=master%20windows%20failing&pendingText=master%20windows%20pending)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/master)
-
-**This is the [latest](https://github.com/cucumber/aruba/blob/master/README.md) version of our README.md (Branch: "[master](https://github.com/cucumber/aruba/tree/master)"). There is also [the README of the latest released version of "aruba"](https://github.com/cucumber/aruba/blob/still/README.md) (Branch: "[still](https://github.com/cucumber/aruba/tree/still)").**
+[![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)
 
 ## Install
 
 Add this line to your application's `Gemfile`:
 
-~~~ruby
+```ruby
 gem 'aruba'
-~~~
+```
 
 And then execute:
 
-~~~bash
+```bash
 bundle
-~~~
+```
 
 Or install it yourself as:
 
-~~~bash
+```bash
 gem install aruba
-~~~
+```
 
 ## Usage
 
-### As a user getting started with "aruba"
+### As a user getting started with Aruba
 
-Our most current documentation to get started with `aruba` as a user can be found on [![See our documentation on Cucumber Pro](https://github.com/cucumber-ltd/brand/raw/master/images/png/notm/cucumber-pro-black/cucumber-pro-black-32.png)](https://app.cucumber.pro/projects/aruba). It is generated from our feature files describing the use of `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.
 
 ### As a user getting started with a ruby testing framework
 
 * **Cucumber**:
 
-    If you're new to the "Cucumber" ecosystem, it's worth to visit
+    If you're new to the Cucumber ecosystem, it's worth to visit
 [the project's documentation site](https://cucumber.io/docs). This also includes
-information about how to write feature files in "Gherkin".
+information about how to write feature files in Gherkin.
 
 * **RSpec**:
 
-    If you want to use "aruba" with "RSpec" and you need some information about how to use "RSpec", please visit [their website](http://rspec.info/documentation/).
+    If you want to use Aruba with RSpec and you need some information about how to use RSpec, please visit [their website](http://rspec.info/documentation/).
 
 * **minitest**:
 
-    The documentation for "minitest" can be found [here](http://docs.seattlerb.org/minitest/).
+    The documentation for minitest can be found [here](http://docs.seattlerb.org/minitest/).
 
-### As a developer getting started with "aruba"
+### As a developer getting started with Aruba
 
 A full documentation of the API for developers can be found on
-[RubyDoc](http://www.rubydoc.info/github/cucumber/aruba/master/frames).
+[RubyDoc](http://www.rubydoc.info/gems/aruba).
 
 ## 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. "aruba-devs" or "general" ([Register account](https://cucumberbdd-slack-invite.herokuapp.com/)) and the "Issues" page on [GitHub](https://github.com/cucumber/aruba/issues). Addressing one of the maintainers directly would be helpful.
+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
+[Issues page on GitHub](https://github.com/cucumber/aruba/issues).
 
 ### Maintainers
 
@@ -74,7 +78,13 @@ We try to comply with [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.
 
 ## Supported Ruby versions
 
-For an up-to-date list of all supported Ruby versions, please see our [`.travis.yml`](https://github.com/cucumber/aruba/blob/master/.travis.yml). We only test against the latest version of a version branch - most times.
+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.
+
+## Supported operating systems
+
+Aruba is fully tested in CI on Linux and MacOS. On Windows, only RSpec tests
+are run, so YMMV. Full Windows support is a work in progress.
 
 ## Contributing
 
@@ -82,14 +92,11 @@ Please see the [CONTRIBUTING](CONTRIBUTING.md) file.
 
 ## Code branches
 
-We use two branches for development: "master" and "still". The "master" branch
-contains the code of the current major version. The "still" branch is used for the
-old major version. New features are only added to "master". The "still" branch is
-still maintained, but only get fixes for major bugs. The "still" branch should be considered as experimental, as we need to find out how much work it is to maintain two branches of code.
+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.
 
-## Build Status
+## License
 
-|Version|Linux / OS X|Windows|
-| ------ | ------ | ------ |
-| master | [![Build Status](https://travis-ci.org/cucumber/aruba.svg?branch=master)](https://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl/branch/master?svg=true&passingText=master%20windows%20passing&failingText=master%20windows%20failing&pendingText==master%20windows%20pending)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/master)|
-| still | [![Build Status](https://travis-ci.org/cucumber/aruba.svg?branch=still)](https://travis-ci.org/cucumber/aruba) | [![Build status](https://ci.appveyor.com/api/projects/status/jfo2tkqhnrqqcivl/branch/still?svg=true&passingText=still%20windows%20passing&failingText=still%20windows%20failing&pendingText=master%20windows%20pending)](https://ci.appveyor.com/project/cucumberbdd/aruba/branch/still)
+See the file [LICENSE](LICENSE).

data/exe/aruba

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+$LOAD_PATH << File.expand_path('../lib', __dir__)
 
 require 'aruba/cli'
 

data/lib/aruba/api.rb

@@ -19,11 +19,11 @@ Aruba.platform.require_matching_files('../matchers/**/*.rb', __FILE__)
 module Aruba
   # Api
   module Api
-    include Aruba::Api::Core
-    include Aruba::Api::Commands
-    include Aruba::Api::Environment
-    include Aruba::Api::Filesystem
-    include Aruba::Api::Text
-    include Aruba::Api::Bundler
+    include Core
+    include Commands
+    include Environment
+    include Filesystem
+    include Text
+    include Bundler
   end
 end

data/lib/aruba/api/bundler.rb

@@ -7,7 +7,7 @@ module Aruba
 
       # Unset variables used by bundler
       def unset_bundler_env_vars
-        %w[RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE].each do |key|
+        %w(RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE).each do |key|
           delete_environment_variable(key)
         end
       end

data/lib/aruba/api/commands.rb

@@ -92,6 +92,30 @@ module Aruba
         self
       end
 
+      # Get stdout of all processes
+      #
+      # @return [String]
+      #   The stdout of all processes which have run before
+      def all_stdout
+        aruba.command_monitor.all_stdout
+      end
+
+      # Get stderr of all processes
+      #
+      # @return [String]
+      #   The stderr of all processes which have run before
+      def all_stderr
+        aruba.command_monitor.all_stderr
+      end
+
+      # Get stderr and stdout of all processes
+      #
+      # @return [String]
+      #   The stderr and stdout of all processes which have run before
+      def all_output
+        aruba.command_monitor.all_output
+      end
+
       # Find a started command
       #
       # @param [String, Command] commandline
@@ -128,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)
@@ -144,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 = {})
@@ -196,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)
 
@@ -232,12 +255,12 @@ module Aruba
         )
       end
 
-      # rubocop:enable Metrics/MethodLength
-
       def start_command(command)
         aruba.config.before(:command, self, command)
 
-        command.start
+        in_current_directory do
+          command.start
+        end
 
         stop_signal = command.stop_signal
         aruba.announcer.announce(:stop_signal, command.pid, stop_signal) if stop_signal

data/lib/aruba/api/core.rb

@@ -3,8 +3,6 @@ require 'aruba/runtime'
 require 'aruba/errors'
 require 'aruba/setup'
 
-require 'aruba/config/jruby'
-
 # Aruba
 module Aruba
   # Api
@@ -17,6 +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!
         @_aruba_runtime ||= Runtime.new
       end
 
@@ -31,6 +33,15 @@ module Aruba
         self
       end
 
+      # Execute block in Aruba's current directory
+      #
+      # @yield
+      #   The block which should be run in current directory
+      def in_current_directory(&block)
+        create_directory '.' unless directory?('.')
+        cd('.', &block)
+      end
+
       # Switch to directory
       #
       # @param [String] dir
@@ -45,25 +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?
           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('.')
             aruba.current_directory << dir
             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
 
-            Aruba.platform.chdir File.join(aruba.root_directory, aruba.current_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' => File.expand_path(File.join(aruba.root_directory, aruba.current_directory)),
+              'PWD' => real_new_directory,
               &block
             )
           ensure
@@ -74,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('.')
         aruba.current_directory << dir
         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
       #
@@ -122,57 +140,70 @@ 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 Metrics/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 Metrics/LineLength
+        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."
 
-        fail ArgumentError, message unless file_name.is_a?(String) && !file_name.empty?
-
-        # rubocop:disable Metrics/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 Metrics/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 Metrics/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 Metrics/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 == '~'
           path = with_environment do
-            ArubaPath.new(File.expand_path(file_name))
+            File.expand_path(file_name)
           end
 
-          fail ArgumentError, 'Expanding "~/" to "/" is not allowed' if path.to_s == '/'
-          fail ArgumentError, %(Expanding "~/" to a relative path "#{path}" is not allowed) unless path.absolute?
+          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
-            aruba.logger.warn 'Using absolute paths in Aruba is not recommended.' \
-              ' Set config.allow_absolute_paths = true to silence this warning'
+            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'
           end
           file_name
         else
-          directory = File.join(aruba.root_directory, aruba.current_directory)
-          directory = File.expand_path(dir_string, directory) if dir_string
-          File.expand_path(file_name, directory)
+          with_environment do
+            directory = File.expand_path(aruba.current_directory, aruba.root_directory)
+            directory = File.expand_path(dir_string, directory) if dir_string
+            File.expand_path(file_name, directory)
+          end
         end
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
 
       # Run block with environment
       #
@@ -182,14 +213,10 @@ module Aruba
       # @yield
       #   The block of code which should be run with the changed environment variables
       def with_environment(env = {}, &block)
-        old_aruba_env = aruba.environment.to_h
-
-        # make sure the old environment is really restored in "ENV"
-        Aruba.platform.with_environment aruba.environment.update(env).to_h, &block
-      ensure
-        # make sure the old environment is really restored in "aruba.environment"
-        aruba.environment.clear
-        aruba.environment.update old_aruba_env
+        aruba.environment.nest do |nested_env|
+          nested_env.update(env)
+          Aruba.platform.with_environment nested_env.to_h, &block
+        end
       end
     end
   end