aruba 0.14.9 → 1.0.0

data/{bin → 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/fixtures/cli-app/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/fixtures/cli-app/bin/aruba-test-cli

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

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

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cli/app/version'
 

data/fixtures/cli-app/features/support/aruba.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/fixtures/cli-app/features/support/env.rb

@@ -1 +1 @@
-require 'aruba/cucumber'
+require_relative 'aruba'

data/fixtures/cli-app/lib/cli/app/suppress_simple_cov_output.rb

@@ -2,12 +2,12 @@ module SimpleCov
   module Formatter
     class HTMLFormatter
       def format(result)
-        Dir[File.join(File.dirname(__FILE__), "../public/*")].each do |path|
+        Dir[File.join(File.dirname(__FILE__), '../public/*')].each do |path|
           FileUtils.cp_r(path, asset_output_path)
         end
 
-        File.open(File.join(output_path, "index.html"), "wb") do |file|
-          file.puts template("layout").result(binding)
+        File.open(File.join(output_path, 'index.html'), 'wb') do |file|
+          file.puts template('layout').result(binding)
         end
       end
     end

data/fixtures/cli-app/lib/cli/app/version.rb

@@ -1,5 +1,5 @@
 module Cli
   module App
-    VERSION = "0.1.0".freeze
+    VERSION = '0.1.0'.freeze
   end
 end

data/fixtures/cli-app/lib/cli/app.rb

@@ -1,10 +1,6 @@
 require 'cli/app/version'
 
-if RUBY_VERSION < '1.9.3'
-  ::Dir.glob(::File.expand_path('../**/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
-else
-  ::Dir.glob(File.expand_path('../**/*.rb', __FILE__)).each { |f| require_relative f }
-end
+::Dir.glob(File.expand_path('**/*.rb', __dir__)).each { |f| require_relative f }
 
 module Cli
   module App

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

@@ -1,9 +1,7 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
 require 'cli/app'
 
-if RUBY_VERSION < '1.9.3'
-  ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
-else
-  ::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }
-end
+require_relative 'support/aruba'
+
+::Dir.glob(::File.expand_path('../support/**/*.rb', __FILE__)).each { |f| require_relative f }

data/fixtures/empty-app/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

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

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cli/app/version'
 

data/fixtures/empty-app/lib/cli/app/version.rb

@@ -1,5 +1,5 @@
 module Cli
   module App
-    VERSION = "0.1.0".freeze
+    VERSION = '0.1.0'.freeze
   end
 end

data/fixtures/empty-app/lib/cli/app.rb

@@ -1,11 +1,5 @@
 require 'cli/app/version'
 
-if RUBY_VERSION < '1.9.3'
-  ::Dir.glob(::File.expand_path('../**/*.rb', __FILE__)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
-else
-  ::Dir.glob(File.expand_path('../**/*.rb', __FILE__)).each { |f| require_relative f }
-end
-
 module Cli
   module App
     # Your code goes here...

data/fixtures/getting-started-app/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
+gem 'aruba', path: File.expand_path('../../..', __dir__)
 gem 'cucumber'
-gem 'aruba', path: File.expand_path('../../../../', __FILE__)

data/lib/aruba/api/commands.rb

@@ -5,17 +5,6 @@ require 'aruba/command'
 
 # require 'win32/file' if File::ALT_SEPARATOR
 
-# Aruba
-module Aruba
-  class << self
-    # @deprecated
-    attr_accessor :process
-  end
-
-  # @deprecated
-  # self.process = Aruba::Processes::SpawnProcess
-end
-
 # Aruba
 module Aruba
   # Api
@@ -103,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
@@ -119,108 +132,33 @@ module Aruba
       # @param [Hash] opts
       #   Options
       #
-      # @option [Integer] exit_timeout
+      # @option opts [Numeric] exit_timeout
       #   If the timeout is reached the command will be killed
       #
-      # @option [Integer] io_wait_timeout
+      # @option opts [Numeric] io_wait_timeout
       #   Wait for IO to finish
       #
-      # @option [Integer] startup_wait_time
+      # @option opts [Numeric] startup_wait_time
       #   Wait for a command to start
       #
-      # @option [String] stop_signal
+      # @option opts [String] stop_signal
       #   Use signal to stop command
       #
       # @yield [SpawnProcess]
       #   Run block with process
       #
-      # rubocop:disable Metrics/MethodLength
-      # rubocop:disable Metrics/CyclomaticComplexity
-      def run_command(*args)
-        fail ArgumentError, 'Please pass at least a command as first argument.' if args.empty?
-
-        cmd = args.shift
-
-        if args.last.is_a? Hash
-          opts = args.pop
-
-          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]
-        else
-          if args.size > 0
-            Aruba.platform.deprecated(
-              "Please pass options to `#run_command` as named parameters/hash and don\'t use the old style, e.g. `#run_command('cmd', :exit_timeout => 5)`.")
-          end
-
-          exit_timeout      = args[0].nil? ? aruba.config.exit_timeout : args[0]
-          io_wait_timeout   = args[1].nil? ? aruba.config.io_wait_timeout : args[1]
-          stop_signal       = args[2].nil? ? aruba.config.stop_signal : args[2]
-          startup_wait_time = args[3].nil? ? aruba.config.startup_wait_time : args[3]
-        end
-
-        cmd = replace_variables(cmd)
-
-        @commands ||= []
-        @commands << cmd
-
-        environment       = aruba.environment
-        working_directory = expand_path('.')
-        event_bus         = aruba.event_bus
-
-        cmd = Aruba.platform.detect_ruby(cmd)
-
-        mode = if Aruba.process
-                 # rubocop:disable Metrics/LineLength
-                 Aruba.platform.deprecated('The use of "Aruba.process = <process>" and "Aruba.process.main_class" is deprecated. Use "Aruba.configure { |config| config.command_launcher = :in_process|:debug|:spawn }" and "Aruba.configure { |config| config.main_class = <klass> }" instead.')
-                 # rubocop:enable Metrics/LineLength
-                 Aruba.process
-               else
-                 aruba.config.command_launcher
-               end
-
-        main_class = if Aruba.process.respond_to?(:main_class) && Aruba.process.main_class
-                       # rubocop:disable Metrics/LineLength
-                       Aruba.platform.deprecated('The use of "Aruba.process = <process>" and "Aruba.process.main_class" is deprecated. Use "Aruba.configure { |config| config.command_launcher = :in_process|:debug|:spawn }" and "Aruba.configure { |config| config.main_class = <klass> }" instead.')
-                       # rubocop:enable Metrics/LineLength
-                       Aruba.process.main_class
-                     else
-                       aruba.config.main_class
-                     end
-
-        command = Command.new(
-          cmd,
-          :mode              => mode,
-          :exit_timeout      => exit_timeout,
-          :io_wait_timeout   => io_wait_timeout,
-          :working_directory => working_directory,
-          :environment       => environment.to_hash,
-          :main_class        => main_class,
-          :stop_signal       => stop_signal,
-          :startup_wait_time => startup_wait_time,
-          :event_bus         => event_bus
-        )
+      def run_command(cmd, opts = {})
+        command = prepare_command(cmd, opts)
 
-        if aruba.config.before? :cmd
-          # rubocop:disable Metrics/LineLength
-          Aruba.platform.deprecated('The use of "before"-hook" ":cmd" is deprecated. Use ":command" instead. Please be aware that this hook gets the command passed in not the cmdline itself. To get the commandline use "#cmd.commandline"')
-          # rubocop:enable Metrics/LineLength
-          aruba.config.before(:cmd, self, cmd)
+        unless command.interactive?
+          raise NotImplementedError,
+                'Running interactively is not supported with this process launcher.'
         end
 
-        aruba.config.before(:command, self, command)
-
-        command.start
-
-        aruba.announcer.announce(:stop_signal, command.pid, stop_signal) if stop_signal
-
-        aruba.config.after(:command, self, command)
+        start_command(command)
 
         block_given? ? yield(command) : command
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/MethodLength
 
       # Run a command with aruba
       #
@@ -233,70 +171,45 @@ module Aruba
       # @param [Hash] options
       #   Options for aruba
       #
-      # @option [TrueClass,FalseClass] fail_on_error
+      # @option options [Boolean] fail_on_error
       #   Should aruba fail on error?
       #
-      # @option [Integer] exit_timeout
+      # @option options [Numeric] exit_timeout
       #   Timeout for execution
       #
-      # @option [Integer] io_wait_timeout
+      # @option options [Numeric] io_wait_timeout
       #   Timeout for IO - STDERR, STDOUT
       #
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/MethodLength
-      def run_command_and_stop(*args)
-        fail ArgumentError, 'Please pass at least a command as first argument.' if args.empty?
-
-        cmd = args.shift
-
-        if args.last.is_a? Hash
-          opts = args.pop
-          fail_on_error = opts.delete(:fail_on_error) == true ? true : false
-        else
-          if args.size > 0
-            # rubocop:disable Metrics/LineLength
-            Aruba.platform.deprecated("Please pass options to `#run_command_and_stop` as named parameters/hash and don\'t use the old style with positional parameters, NEW: e.g. `#run_command_and_stop('cmd', :exit_timeout => 5)`.")
-            # rubocop:enable Metrics/LineLength
-          end
-
-          fail_on_error = args[0] == false ? false : true
-
-          opts = {
-            :exit_timeout      => (args[1] || aruba.config.exit_timeout),
-            :io_wait_timeout   => (args[2] || aruba.config.io_wait_timeout),
-            :stop_signal       => (args[3] || aruba.config.stop_signal),
-            :startup_wait_time => (args[4] || aruba.config.startup_wait_time)
-          }
-        end
-
-        command = run_command(cmd, opts)
+      def run_command_and_stop(cmd, opts = {})
+        fail_on_error = if opts.key?(:fail_on_error)
+                          opts.delete(:fail_on_error) == true
+                        else
+                          true
+                        end
+
+        command = prepare_command(cmd, opts)
+        start_command(command)
         command.stop
 
-        if Aruba::VERSION < '1'
-          @last_exit_status = command.exit_status
-          @timed_out = command.timed_out?
-        end
+        return unless fail_on_error
 
-        if fail_on_error
-          begin
-            expect(command).to have_finished_in_time
-            expect(command).to be_successfully_executed
-          rescue RSpec::Expectations::ExpectationNotMetError => e
-            aruba.announcer.activate(aruba.config.activate_announcer_on_command_failure)
-            aruba.event_bus.notify Events::CommandStopped.new(command)
-            raise e
-          end
+        begin
+          expect(command).to have_finished_in_time
+          expect(command).to be_successfully_executed
+        rescue ::RSpec::Expectations::ExpectationNotMetError => e
+          aruba.announcer.activate(aruba.config.activate_announcer_on_command_failure)
+          aruba.event_bus.notify Events::CommandStopped.new(command)
+          raise e
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/MethodLength
 
       # Provide data to command via stdin
       #
       # @param [String] input
       #   The input for the command
       def type(input)
-        return close_input if "" == input
+        return close_input if input == "\u0004"
+
         last_command_started.write(input << "\n")
       end
 
@@ -304,6 +217,59 @@ module Aruba
       def close_input
         last_command_started.close_io(:stdin)
       end
+
+      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]
+
+        cmd = replace_variables(cmd)
+
+        @commands ||= []
+        @commands << cmd
+
+        environment       = aruba.environment
+        working_directory = expand_path('.')
+        event_bus         = aruba.event_bus
+
+        cmd = Aruba.platform.detect_ruby(cmd)
+
+        mode = aruba.config.command_launcher
+
+        main_class = aruba.config.main_class
+
+        Command.new(
+          cmd,
+          mode: mode,
+          exit_timeout: exit_timeout,
+          io_wait_timeout: io_wait_timeout,
+          working_directory: working_directory,
+          environment: environment.to_hash,
+          main_class: main_class,
+          stop_signal: stop_signal,
+          startup_wait_time: startup_wait_time,
+          event_bus: event_bus
+        )
+      end
+
+      # rubocop:enable Metrics/MethodLength
+
+      def start_command(command)
+        aruba.config.before(:command, self, command)
+
+        in_current_directory do
+          command.start
+        end
+
+        stop_signal = command.stop_signal
+        aruba.announcer.announce(:stop_signal, command.pid, stop_signal) if stop_signal
+
+        aruba.config.after(:command, self, command)
+      end
     end
   end
 end

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,8 @@ 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 +31,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
@@ -55,15 +64,16 @@ module Aruba
             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
@@ -80,7 +90,7 @@ module Aruba
         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
@@ -117,58 +127,66 @@ module Aruba
       #   # => <path>/test/fixtures/file
       #   expand_path('%/file')
       #
+      # @example Absolute directory
+      #
+      #   # => /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)
-        check_for_deprecated_variables if Aruba::VERSION < '1'
-
-        # rubocop:disable Metrics/LineLength
+        # 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 Metrics/LineLength
+        # rubocop:enable Layout/LineLength
 
         fail ArgumentError, message unless file_name.is_a?(String) && !file_name.empty?
 
-        # rubocop:disable Metrics/LineLength
-        aruba.logger.warn %(`aruba`'s working directory does not exist. Maybe you forgot to run `setup_aruba` before using it's API. This warning will be an error from 1.0.0) unless Aruba.platform.directory? File.join(aruba.config.root_directory, aruba.config.working_directory)
-        # rubocop:enable Metrics/LineLength
-
-        if RUBY_VERSION < '1.9'
-          prefix = file_name.chars.to_a[0].to_s
-          rest = if file_name.chars.to_a[2..-1].nil?
-                   nil
-                 else
-                   file_name.chars.to_a[2..-1].join
-                 end
-        else
-          prefix = file_name[0]
-          rest = file_name[2..-1]
-        end
+        # 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)
+
+        # rubocop:enable Layout/LineLength
+
+        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 Metrics/LineLength
+          # 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 Metrics/LineLength
+
+          # rubocop:enable Layout/LineLength
 
           path
-        elsif '~' == prefix
+        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?
+          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
 
           path.to_s
+        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'
+          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/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
 
       # Run block with environment
       #
@@ -178,14 +196,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