aruba 1.0.0.pre.alpha.2 → 1.0.0.pre.alpha.3

data/lib/aruba/platforms/windows_environment_variables.rb

@@ -5,44 +5,35 @@ module Aruba
   # Platforms
   module Platforms
     # Windows is case-insensitive when it accesses its environment variables.
-    # That means that at the Windows command line:
     #
-    #  C:>set Path
-    #  C:>Path=.;.\bin;c:\rubys\ruby-2.1.6-p336\bin;
-    #  C:>set PATH
-    #  C:>Path=.;.\bin;c:\rubys\ruby-2.1.6-p336\bin;
+    # To work around this we turn all of the environment variable keys to
+    # upper-case so that aruba is ensured that accessing environment variables
+    # with upper-case keys will always work. See the following examples.
     #
-    # If you access environment variables through ENV, you can access values no
-    # matter the case of the key:
+    # @example Setting Windows environment variables using mixed case
+    #   C:>set Path
+    #   C:>Path=.;.\bin;c:\rubys\ruby-2.1.6-p336\bin;
+    #   C:>set PATH
+    #   C:>Path=.;.\bin;c:\rubys\ruby-2.1.6-p336\bin;
     #
-    #  irb: > ENV["Path"]
-    #  => ".;.\bin;c:\rubys\ruby-2.1.6-p336\bin;"
-    #  irb: > ENV["Path"]
-    #  => ".;.\bin;c:\rubys\ruby-2.1.6-p336\bin;"
+    # @example If you access environment variables through ENV, you can access values no matter the case of the key:
+    #     ENV["Path"] # => ".;.\bin;c:\rubys\ruby-2.1.6-p336\bin;"
+    #     ENV["PATH"] # => ".;.\bin;c:\rubys\ruby-2.1.6-p336\bin;"
     #
-    # But if you copy the ENV to a hash, Ruby treats the keys as case sensitive:
-    #
-    #  irb: > env_copy = ENV.to_hash
-    #  => {"ALLUSERSPROFILE"=>"C:\\ProgramData", "ANSICON"=>"119x1000 (119x58)", "ANSICON_DEF"=>"7",  APPDATA"=>"C:\\Users\\blorf\\AppData\\Roaming", ....}
-    #  irb: > env["Path"]
-    #  => ".;.\bin;c:\rubys\ruby-2.1.6-p336\bin;"
-    #  irb: > env["PATH"]
-    #  => nil
-    #
-    # Thus we turn all of the environment variable keys to upper case so that
-    # aruba is ensured that accessing environment variables with upper case keys
-    # will always work.
+    # @example But if you copy the ENV to a hash, Ruby treats the keys as case sensitive:
+    #   env_copy = ENV.to_hash
+    #   # => {"ALLUSERSPROFILE"=>"C:\\ProgramData", "ANSICON"=>"119x1000 (119x58)", "ANSICON_DEF"=>"7",  APPDATA"=>"C:\\Users\\blorf\\AppData\\Roaming", ....}
+    #   env["Path"]
+    #   # => ".;.\bin;c:\rubys\ruby-2.1.6-p336\bin;"
+    #   env["PATH"]
+    #   # => nil
     class WindowsEnvironmentVariables < UnixEnvironmentVariables
-      def initialize(env = ENV.to_hash)
-        @actions = []
-
-        @env = env.each_with_object({}) { |(k,v), a| a[k.to_s.upcase] = v }
+      def initialize(env = ENV)
+        super(upcase_env env)
       end
 
       def update(other_env, &block)
-        other_env = other_env.each_with_object({}) { |(k,v), a| a[k.to_s.upcase] = v }
-
-        super(other_env, &block)
+        super(upcase_env(other_env), &block)
       end
 
       def fetch(name, default = UnixEnvironmentVariables::UNDEFINED)
@@ -72,6 +63,20 @@ module Aruba
       def delete(name)
         super(name.upcase)
       end
+
+      def self.hash_from_env
+        upcase_env(ENV)
+      end
+
+      def self.upcase_env(env)
+        env.each_with_object({}) { |(k, v), a| a[k.to_s.upcase] = v }
+      end
+
+      private
+
+      def upcase_env(env)
+        self.class.upcase_env(env)
+      end
     end
   end
 end

data/lib/aruba/platforms/windows_which.rb

@@ -23,11 +23,12 @@ module Aruba
           Aruba.platform.absolute_path?(program) || Aruba.platform.relative_command?(program)
         end
 
-        def call(program, path)
+        def call(program, _path)
           # Expand `#path_exts`
           found = Dir[program].first
 
           return File.expand_path(found) if found && Aruba.platform.executable?(found)
+
           nil
         end
       end
@@ -48,7 +49,7 @@ module Aruba
             file = File.join(dir, program)
             # Dir[] doesn't handle backslashes properly, so convert them. Also, if
             # the program name doesn't have an extension, try them all.
-            file = file.tr("\\", "/")
+            file = file.tr('\\', '/')
 
             found = Dir[file].first
 
@@ -95,7 +96,7 @@ module Aruba
       private
 
       def windows_executable_extentions
-        ENV['PATHEXT'] ? format('.{%s}', ENV['PATHEXT'].tr(';', ',').tr('.','')).downcase : '.{exe,com,bat}'
+        ENV['PATHEXT'] ? format('.{%s}', ENV['PATHEXT'].tr(';', ',').tr('.', '')).downcase : '.{exe,com,bat}'
       end
     end
   end

data/lib/aruba/processes/basic_process.rb

@@ -11,9 +11,12 @@ module Aruba
     #
     # @private
     class BasicProcess
-      attr_reader :exit_status, :environment, :working_directory, :main_class, :io_wait_timeout, :exit_timeout, :startup_wait_time
+      attr_reader :exit_status, :environment, :working_directory, :main_class,
+        :io_wait_timeout, :exit_timeout, :startup_wait_time, :stop_signal
 
-      def initialize(cmd, exit_timeout, io_wait_timeout, working_directory, environment = ENV.to_hash.dup, main_class = nil, stop_signal = nil, startup_wait_time = 0)
+      def initialize(cmd, exit_timeout, io_wait_timeout, working_directory,
+                     environment = Aruba.platform.environment_variables.hash_from_env,
+                     main_class = nil, stop_signal = nil, startup_wait_time = 0)
         @cmd               = cmd
         @working_directory = working_directory
         @environment       = environment
@@ -101,14 +104,6 @@ module Aruba
         @timed_out == true
       end
 
-      # @deprecated
-      # @private
-      def run!
-        Aruba.platform.deprecated('The use of "command#run!" is deprecated. You can simply use "command#start" instead.')
-
-        start
-      end
-
       # Hook which is run before command is run
       def before_run; end
 
@@ -117,18 +112,16 @@ module Aruba
 
       def inspect
         # rubocop:disable Style/UnneededInterpolation
-        out = truncate("#{stdout(:wait_for_io => 0).inspect}", 35)
-        err = truncate("#{stderr(:wait_for_io => 0).inspect}", 35)
+        out = truncate("#{stdout(wait_for_io: 0).inspect}", 35)
+        err = truncate("#{stderr(wait_for_io: 0).inspect}", 35)
         # rubocop:enable Style/UnneededInterpolation
 
         fmt = '#<%s:%s commandline="%s": stdout=%s stderr=%s>'
-        format fmt, self.class, self.object_id, commandline, out, err
+        format fmt, self.class, object_id, commandline, out, err
       end
 
       alias to_s inspect
 
-      private
-
       def command
         Shellwords.split(commandline).first
       end
@@ -139,8 +132,11 @@ module Aruba
         []
       end
 
+      private
+
       def truncate(string, max_length)
         return string if string.length <= max_length
+
         string[0, max_length - 1] + ' ...'
       end
     end

data/lib/aruba/processes/debug_process.rb

@@ -18,6 +18,7 @@ module Aruba
       end
 
       def start
+        @started = true
         Dir.chdir @working_directory do
           Aruba.platform.with_environment(environment) do
             @exit_status = system(command, *arguments) ? 0 : 1
@@ -64,6 +65,10 @@ module Aruba
       def terminate(*)
         stop
       end
+
+      def interactive?
+        true
+      end
     end
   end
 end

data/lib/aruba/processes/in_process.rb

@@ -33,19 +33,22 @@ module Aruba
         end
 
         def exit(exitstatus)
-          @exitstatus = exitstatus
+          @exitstatus =
+            case exitstatus
+            when Numeric then Integer(exitstatus)
+            when TrueClass then 0
+            when FalseClass then 1
+            else raise TypeError, "no implicit conversion of #{exitstatus.class} into Integer"
+            end
         end
       end
 
-      class << self
-        # @deprecated
-        attr_accessor :main_class
-      end
-
       # @private
       attr_reader :main_class
 
-      def initialize(cmd, exit_timeout, io_wait_timeout, working_directory, environment = ENV.to_hash.dup, main_class = nil, stop_signal = nil, startup_wait_time = 0)
+      def initialize(cmd, exit_timeout, io_wait_timeout, working_directory,
+                     environment = Aruba.platform.environment_variables.hash_from_env,
+                     main_class = nil, stop_signal = nil, startup_wait_time = 0)
         @cmd               = cmd
         @argv              = arguments
         @stdin             = StringIO.new
@@ -58,7 +61,9 @@ module Aruba
 
       # Start command
       def start
-        fail "You need to call aruba.config.main_class = YourMainClass" unless main_class
+        fail 'You need to call aruba.config.main_class = YourMainClass' unless main_class
+
+        @started = true
 
         Dir.chdir @working_directory do
           before_run
@@ -120,6 +125,10 @@ module Aruba
       def pid
         $PROCESS_ID
       end
+
+      def interactive?
+        false
+      end
     end
   end
 end

data/lib/aruba/processes/spawn_process.rb

@@ -19,24 +19,38 @@ module Aruba
     # @private
     class SpawnProcess < BasicProcess
       # Use as default launcher
-      def self.match?(mode)
+      def self.match?(_mode)
         true
       end
 
       # Create process
       #
-      # @params [String] cmd
+      # @param [String] cmd
       #   Command string
       #
-      # @params [Integer] exit_timeout
+      # @param [Numeric] exit_timeout
       #   The timeout until we expect the command to be finished
       #
-      # @params [Integer] io_wait_timeout
+      # @param [Numeric] io_wait_timeout
       #   The timeout until we expect the io to be finished
       #
-      # @params [String] working_directory
+      # @param [String] working_directory
       #   The directory where the command will be executed
-      def initialize(cmd, exit_timeout, io_wait_timeout, working_directory, environment = ENV.to_hash.dup, main_class = nil, stop_signal = nil, startup_wait_time = 0)
+      #
+      # @param [Hash] environment
+      #   Environment variables
+      #
+      # @param [Class] main_class
+      #   E.g. Cli::App::Runner
+      #
+      # @param [String] stop_signal
+      #   Name of signal to send to stop process. E.g. 'HUP'.
+      #
+      # @param [Numeric] startup_wait_time
+      #   The amount of seconds to wait after Aruba has started a command.
+      def initialize(cmd, exit_timeout, io_wait_timeout, working_directory,
+                     environment = Aruba.platform.environment_variables.hash_from_env,
+                     main_class = nil, stop_signal = nil, startup_wait_time = 0)
         super
 
         @process      = nil
@@ -53,11 +67,12 @@ module Aruba
       def start
         # rubocop:disable Metrics/LineLength
         fail CommandAlreadyStartedError, %(Command "#{commandline}" has already been started. Please `#stop` the command first and `#start` it again. Alternatively use `#restart`.\n#{caller.join("\n")}) if started?
+
         # rubocop:enable Metrics/LineLength
 
         @started = true
 
-        @process = ChildProcess.build(*[command_string.to_a, arguments].flatten)
+        @process = ChildProcess.build(*command_string.to_a)
         @stdout_file = Tempfile.new('aruba-stdout-')
         @stderr_file = Tempfile.new('aruba-stderr-')
 
@@ -139,14 +154,6 @@ module Aruba
         end
       end
 
-      def read_stdout
-        # rubocop:disable Metrics/LineLength
-        Aruba.platform.deprecated('The use of "#read_stdout" is deprecated. Use "#stdout" instead. To reduce the time to wait for io, pass `:wait_for_io => 0` or some suitable for your use case')
-        # rubocop:enable Metrics/LineLength
-
-        stdout(:wait_for_io => 0)
-      end
-
       def write(input)
         return if stopped?
 
@@ -233,7 +240,7 @@ module Aruba
       # @return [Aruba::Platforms::FilesystemStatus]
       #   This returns a File::Stat-object
       def filesystem_status
-        Aruba.platform.filesystem_status.new(command_string.to_s)
+        Aruba.platform.filesystem_status.new(command_path)
       end
 
       # Content of command
@@ -242,22 +249,27 @@ module Aruba
       #   The content of the script/command. This might be binary output as
       #   string if your command is a binary executable.
       def content
-        File.read command_string.to_s
+        File.read command_path
+      end
+
+      def interactive?
+        true
       end
 
       private
 
       def command_string
-        # gather fully qualified path
-        cmd = Aruba.platform.which(command, environment['PATH'])
+        fail LaunchError, %(Command "#{command}" not found in PATH-variable "#{environment['PATH']}".) if command_path.nil?
 
-        fail LaunchError, %(Command "#{command}" not found in PATH-variable "#{environment['PATH']}".) if cmd.nil?
+        Aruba.platform.command_string.new(command_path, *arguments)
+      end
 
-        Aruba.platform.command_string.new(cmd)
+      def command_path
+        @command_path ||= Aruba.platform.which(command, environment['PATH'])
       end
 
-      def wait_for_io(time_to_wait, &block)
-        sleep time_to_wait.to_i
+      def wait_for_io(time_to_wait)
+        sleep time_to_wait
         yield
       end
 

data/lib/aruba/rspec.rb

@@ -5,16 +5,16 @@ require 'aruba/api'
 require 'aruba/version'
 
 RSpec.configure do |config|
-  config.include Aruba::Api, :type => :aruba
+  config.include Aruba::Api, type: :aruba
 
   # Setup environment for aruba
   config.around :each do |example|
     if self.class.include? Aruba::Api
-      restore_env
       setup_aruba
 
       # Modify PATH to include project/bin
-      prepend_environment_variable 'PATH', aruba.config.command_search_paths.join(':') + ':'
+      prepend_environment_variable 'PATH',
+        aruba.config.command_search_paths.join(File::PATH_SEPARATOR) + File::PATH_SEPARATOR
 
       # Use configured home directory as HOME
       set_environment_variable 'HOME', aruba.config.home_directory
@@ -23,18 +23,17 @@ RSpec.configure do |config|
     example.run
 
     next unless self.class.include? Aruba::Api
+
     stop_all_commands
   end
 
-  if Aruba::VERSION >= '1.0.0'
-    config.around :each do |example|
-      if self.class.include? Aruba::Api
-        with_environment do
-          example.run
-        end
-      else
+  config.around :each do |example|
+    if self.class.include? Aruba::Api
+      with_environment do
         example.run
       end
+    else
+      example.run
     end
   end
 
@@ -48,21 +47,9 @@ RSpec.configure do |config|
   config.before :each do |example|
     next unless self.class.include?(Aruba::Api)
 
-    if example.metadata[:announce_environment]
-      Aruba.platform.deprecated 'announce_environment is deprecated. Use announce_changed_environment instead'
-
-      aruba.announcer.activate(:changed_environment)
-    end
-
     aruba.announcer.activate(:full_environment)     if example.metadata[:announce_full_environment]
     aruba.announcer.activate(:changed_environment)  if example.metadata[:announce_changed_environment]
 
-    if example.metadata[:announce_modified_environment]
-      Aruba.platform.deprecated 'announce_modified_environment is deprecated. Use announce_changed_environment instead'
-
-      aruba.announcer.activate(:changed_environment)
-    end
-
     aruba.announcer.activate(:command)                   if example.metadata[:announce_command]
     aruba.announcer.activate(:directory)                 if example.metadata[:announce_directory]
     aruba.announcer.activate(:full_environment)          if example.metadata[:announce_full_environment]

data/lib/aruba/runtime.rb

@@ -1,4 +1,4 @@
-require 'aruba/config'
+require 'aruba/configuration'
 require 'aruba/aruba_path'
 require 'aruba/config_wrapper'
 require 'aruba/events'
@@ -49,7 +49,7 @@ module Aruba
 
       @environment.update(@config.command_runtime_environment)
 
-      @command_monitor = opts.fetch(:command_monitor, Aruba.platform.command_monitor.new(:announcer => @announcer))
+      @command_monitor = opts.fetch(:command_monitor, Aruba.platform.command_monitor.new(announcer: @announcer))
 
       @logger = opts.fetch(:logger, Aruba.platform.logger.new)
       @logger.mode = @config.log_level
@@ -77,11 +77,13 @@ module Aruba
     # @return [ArubaPath]
     #   The directory to where your fixtures are stored
     def fixtures_directory
-      unless @fixtures_directory
+      @fixtures_directory ||= begin
         candidates = config.fixtures_directories.map { |dir| File.join(root_directory, dir) }
-        @fixtures_directory = candidates.find { |d| Aruba.platform.directory? d }
+        directory = candidates.find { |d| Aruba.platform.directory? d }
 
-        fail "No existing fixtures directory found in #{candidates.map { |d| format('"%s"', d) }.join(', ')}. " unless @fixtures_directory
+        fail "No existing fixtures directory found in #{candidates.map { |d| format('"%s"', d) }.join(', ')}." unless directory
+
+        directory
       end
 
       fail %(Fixtures directory "#{@fixtures_directory}" is not a directory) unless Aruba.platform.directory?(@fixtures_directory)