aruba 1.0.0 → 1.0.1

data/CONTRIBUTING.md

@@ -210,8 +210,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:
 
@@ -225,12 +223,6 @@ bin/test
 # 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/Gemfile

@@ -4,7 +4,9 @@ source 'https://rubygems.org'
 gemspec
 
 # Load local Gemfile
-load File.expand_path('Gemfile.local', __dir__) if File.file? File.expand_path('Gemfile.local', __dir__)
+if File.file? File.expand_path('Gemfile.local', __dir__)
+  load File.expand_path('Gemfile.local', __dir__)
+end
 
 unless RUBY_PLATFORM.include?('java')
   gem 'byebug', '~> 11.0'

data/Rakefile

@@ -18,13 +18,13 @@ require 'cucumber/rake/task'
 require 'rspec/core/rake_task'
 
 Cucumber::Rake::Task.new do |t|
-  t.cucumber_opts = %w{--format progress}
+  t.cucumber_opts = %w(--format progress)
 end
 
 Cucumber::Rake::Task.new('cucumber:wip', 'Run Cucumber features '\
                          'which are "WORK IN PROGRESS" and '\
                          'are allowed to fail') do |t|
-  t.cucumber_opts = %w{--format progress}
+  t.cucumber_opts = %w(--format progress)
   t.profile = 'wip'
 end
 
@@ -53,7 +53,8 @@ namespace :docker do
     args.with_defaults(version: 'latest')
     args.with_defaults(cache: true)
 
-    docker_compose_file = Aruba::DockerComposeFile.new(File.expand_path('docker-compose.yml', __dir__))
+    docker_compose_file =
+      Aruba::DockerComposeFile.new(File.expand_path('docker-compose.yml', __dir__))
     docker_run_instance = Aruba::DockerRunInstance.new(docker_compose_file, :base)
 
     builder = Aruba::DockerBuildCommandLineBuilder.new(
@@ -67,7 +68,8 @@ namespace :docker do
 
   desc 'Run docker container'
   task :run, :command do |_, args|
-    docker_compose_file = Aruba::DockerComposeFile.new(File.expand_path('docker-compose.yml', __dir__))
+    docker_compose_file =
+      Aruba::DockerComposeFile.new(File.expand_path('docker-compose.yml', __dir__))
     docker_run_instance = Aruba::DockerRunInstance.new(docker_compose_file, :base)
 
     builder = Aruba::DockerRunCommandLineBuilder.new(

data/appveyor.yml

@@ -6,7 +6,6 @@ version: "{build}"
 branches:
   only:
     - master
-    - still
 
 # Disable normal Windows builds in favor of our test script.
 build: off

data/aruba.gemspec

@@ -6,8 +6,10 @@ Gem::Specification.new do |spec|
   spec.name        = 'aruba'
   spec.version     = Aruba::VERSION
   spec.author      = 'Aslak Hellesøy, Matt Wynne and other Aruba Contributors'
-  spec.description = 'Extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest",
-to make testing commandline applications meaningful, easy and fun.'
+  spec.description = <<~TEXT
+    Extension for popular TDD and BDD frameworks like "Cucumber", "RSpec" and "Minitest",
+    to make testing commandline applications meaningful, easy and fun.
+  TEXT
   spec.summary     = "aruba-#{spec.version}"
   spec.license     = 'MIT'
   spec.email       = 'cukes@googlegroups.com'
@@ -23,7 +25,7 @@ to make testing commandline applications meaningful, easy and fun.'
 
   spec.add_runtime_dependency 'childprocess', '~> 3.0'
   spec.add_runtime_dependency 'contracts', '~> 0.16.0'
-  spec.add_runtime_dependency 'cucumber', ['>= 2.4', '< 4.0']
+  spec.add_runtime_dependency 'cucumber', ['>= 2.4', '< 5.0']
   spec.add_runtime_dependency 'ffi', '~> 1.9'
   spec.add_runtime_dependency 'rspec-expectations', '~> 3.4'
   spec.add_runtime_dependency 'thor', '~> 1.0'
@@ -34,8 +36,9 @@ to make testing commandline applications meaningful, easy and fun.'
   spec.add_development_dependency 'pry-doc', '~> 1.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.6'
-  spec.add_development_dependency 'rubocop', '~> 0.79.0'
+  spec.add_development_dependency 'rubocop', '~> 0.84.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.39'
   spec.add_development_dependency 'simplecov', '~> 0.18.0'
   spec.add_development_dependency 'yard-junk', '~> 0.0.7'
 

data/fixtures/cli-app/cli-app.gemspec

@@ -15,11 +15,12 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0")
+                                        .reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.9'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
 end

data/fixtures/cli-app/spec/spec_helper.rb

@@ -4,4 +4,5 @@ require 'cli/app'
 
 require_relative 'support/aruba'
 
-::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
+::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__))
+     .each { |f| require_relative f }

data/fixtures/empty-app/cli-app.gemspec

@@ -15,11 +15,12 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0")
+                                        .reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.9'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
 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

@@ -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)
 
@@ -256,8 +255,6 @@ module Aruba
         )
       end
 
-      # rubocop:enable Metrics/MethodLength
-
       def start_command(command)
         aruba.config.before(:command, self, command)
 

data/lib/aruba/api/core.rb

@@ -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
 
@@ -54,21 +56,25 @@ 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
 
-            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(
@@ -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('.')
         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
       #
@@ -132,31 +140,34 @@ 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?
+        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 unless file_name.is_a?(String) && !file_name.empty?
 
-        # 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
           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 == '~'
@@ -164,16 +175,23 @@ module Aruba
             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 +202,6 @@ module Aruba
           end
         end
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
 
       # Run block with environment
       #

data/lib/aruba/api/environment.rb

@@ -23,7 +23,9 @@ module Aruba
         aruba.environment[name] = value
         new_environment = aruba.environment.to_h
 
-        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: value } }
+        environment_change = { old: old_environment,
+                               new: new_environment,
+                               changed: { name: name, value: value } }
         aruba.event_bus.notify Events::AddedEnvironmentVariable.new(environment_change)
 
         self
@@ -46,7 +48,9 @@ module Aruba
         aruba.environment.append name, value
         new_environment = aruba.environment.to_h
 
-        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: value } }
+        environment_change = { old: old_environment,
+                               new: new_environment,
+                               changed: { name: name, value: value } }
         aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)
 
         self
@@ -69,7 +73,9 @@ module Aruba
         aruba.environment.prepend name, value
         new_environment = aruba.environment.to_h
 
-        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: value } }
+        environment_change = { old: old_environment,
+                               new: new_environment,
+                               changed: { name: name, value: value } }
         aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)
 
         self
@@ -88,7 +94,9 @@ module Aruba
         aruba.environment.delete name
         new_environment = aruba.environment.to_h
 
-        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: '' } }
+        environment_change = { old: old_environment,
+                               new: new_environment,
+                               changed: { name: name, value: '' } }
         aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)
 
         self

data/lib/aruba/api/filesystem.rb

@@ -92,7 +92,7 @@ module Aruba
       # @return [Dir]
       #   The directory object
       def directory(path)
-        fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
+        raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
 
         Dir.new(expand_path(path))
       end
@@ -102,22 +102,31 @@ module Aruba
       # @return [Array]
       #   The content of directory
       def list(name)
-        fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
-        fail ArgumentError, %(Only directories are supported. Path "#{name}" is not a directory.) unless directory? name
+        raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
+
+        unless directory? name
+          raise ArgumentError,
+                %(Only directories are supported. Path "#{name}" is not a directory.)
+        end
 
         existing_files            = Dir.glob(expand_path(File.join(name, '**', '*')))
         current_working_directory = Pathname.new(expand_path('.'))
 
-        existing_files.map { |d| Pathname.new(d).relative_path_from(current_working_directory).to_s }
+        existing_files.map do |d|
+          Pathname.new(d).relative_path_from(current_working_directory).to_s
+        end
       end
 
       # Return content of file
       #
       # @return [Array]
-      #   The content of file, without "\n" or "\r\n" at the end. To rebuild the file use `content.join("\n")`
+      #   The content of file, without "\n" or "\r\n" at the end.
+      #   To rebuild the file use `content.join("\n")`
       def read(name)
-        fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
-        fail ArgumentError, %(Only files are supported. Path "#{name}" is not a file.) unless file? name
+        raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
+        unless file? name
+          raise ArgumentError, %(Only files are supported. Path "#{name}" is not a file.)
+        end
 
         File.readlines(expand_path(name)).map(&:chomp)
       end
@@ -145,7 +154,7 @@ module Aruba
       def touch(*args)
         args = args.flatten
 
-        options = if args.last.kind_of? Hash
+        options = if args.last.is_a? Hash
                     args.pop
                   else
                     {}
@@ -168,9 +177,6 @@ module Aruba
       # @param [String] destination
       #   A file or directory name. If multiple sources are given the destination
       #   needs to be a directory
-      #
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # def copy(*source, destination)
       def copy(*args)
         args = args.flatten
         destination = args.pop
@@ -181,7 +187,8 @@ module Aruba
         end
 
         if destination.start_with? aruba.config.fixtures_path_prefix
-          raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported"
+          raise ArgumentError,
+                "Using a fixture as destination (#{destination}) is not supported"
         end
 
         if source.count > 1 && exist?(destination) && !directory?(destination)
@@ -202,7 +209,6 @@ module Aruba
 
         self
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Move a file and/or directory
       #
@@ -214,20 +220,20 @@ module Aruba
       # @param [String] destination
       #   A file or directory name. If multiple sources are given the destination
       #   needs to be a directory
-      #
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/MethodLength
       def move(*args)
         args = args.flatten
         destination = args.pop
         source = args
 
         source.each do |s|
-          raise ArgumentError, "Using a fixture as source (#{source}) is not supported" if s.start_with? aruba.config.fixtures_path_prefix
+          if s.start_with? aruba.config.fixtures_path_prefix
+            raise ArgumentError, "Using a fixture as source (#{source}) is not supported"
+          end
         end
 
         if destination.start_with? aruba.config.fixtures_path_prefix
-          raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported"
+          raise ArgumentError,
+                "Using a fixture as destination (#{destination}) is not supported"
         end
 
         source.each do |s|
@@ -252,8 +258,6 @@ module Aruba
 
         self
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Create a file with the given size
       #
@@ -292,14 +296,14 @@ module Aruba
       def chmod(*args)
         args = args.flatten
 
-        options = if args.last.kind_of? Hash
+        options = if args.last.is_a? Hash
                     args.pop
                   else
                     {}
                   end
 
         mode = args.shift
-        mode = if mode.kind_of? String
+        mode = if mode.is_a? String
                  mode.to_i(8)
                else
                  mode
@@ -344,7 +348,7 @@ module Aruba
       def remove(*args)
         args = args.flatten
 
-        options = if args.last.kind_of? Hash
+        options = if args.last.is_a? Hash
                     args.pop
                   else
                     {}