aruba 0.14.9 → 1.0.0

data/lib/aruba/platforms/unix_environment_variables.rb

@@ -9,15 +9,7 @@ module Aruba
         attr_reader :other_env, :block
 
         def initialize(other_env, &block)
-          @other_env = other_env
-
-          @other_env = if RUBY_VERSION <= '1.9.3'
-                         # rubocop:disable Style/EachWithObject
-                         @other_env.to_hash.inject({}) { |a, (k, v)| a[k] = v.to_s; a }
-                         # rubocop:enable Style/EachWithObject
-                       else
-                         @other_env.to_h.each_with_object({}) { |(k, v), a| a[k] = v.to_s }
-                       end
+          @other_env = other_env.to_h.each_with_object({}) { |(k, v), a| a[k] = v.to_s }
 
           @block = if block_given?
                      block
@@ -60,11 +52,7 @@ module Aruba
       def initialize(env = ENV)
         @actions = []
 
-        @env = if RUBY_VERSION < '2.0'
-                 env.to_hash
-               else
-                 env.to_h
-               end
+        @env = env.to_h
       end
 
       # Update environment with other en
@@ -77,7 +65,7 @@ module Aruba
       def update(other_env)
         actions << UpdateAction.new(other_env)
 
-        UnixEnvironmentVariables.new(to_h)
+        self
       end
 
       # Fetch variable from environment
@@ -137,7 +125,7 @@ module Aruba
         name  = name.to_s
         value = self[name].to_s + value.to_s
 
-        actions << UpdateAction.new(name => value )
+        actions << UpdateAction.new(name => value)
 
         value
       end
@@ -188,11 +176,7 @@ module Aruba
       # @return [Hash]
       #   A new hash from environment
       def to_h
-        if RUBY_VERSION < '2.0'
-          Marshal.load(Marshal.dump(prepared_environment.to_hash))
-        else
-          Marshal.load(Marshal.dump(prepared_environment.to_h))
-        end
+        actions.inject(hash_from_env.merge(env)) { |a, e| e.call(a) }
       end
 
       # Reset environment
@@ -204,14 +188,21 @@ module Aruba
         value
       end
 
+      def nest
+        old_actions = @actions.dup
+        yield(self)
+      ensure
+        @actions = old_actions
+      end
+
+      def self.hash_from_env
+        ENV.to_hash
+      end
+
       private
 
-      def prepared_environment
-        if RUBY_VERSION <= '1.9.3'
-          actions.inject(ENV.to_hash.merge(env)) { |a, e| e.call(a) }
-        else
-          actions.each_with_object(ENV.to_hash.merge(env)) { |e, a| a = e.call(a) }
-        end
+      def hash_from_env
+        self.class.hash_from_env
       end
     end
   end

data/lib/aruba/platforms/unix_platform.rb

@@ -62,8 +62,8 @@ module Aruba
         DetermineFileSize.new.call(*args)
       end
 
-      def determine_disk_usage(*args)
-        DetermineDiskUsage.new.call(*args)
+      def determine_disk_usage(paths)
+        DetermineDiskUsage.new.call(paths)
       end
 
       def create_file(*args)
@@ -83,7 +83,7 @@ module Aruba
       end
 
       def detect_ruby(cmd)
-        if cmd =~ /^ruby\s/
+        if /^ruby\s/.match?(cmd)
           cmd.gsub(/^ruby\s/, "#{current_ruby} ")
         else
           cmd
@@ -98,20 +98,8 @@ module Aruba
         ::File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
       end
 
-      # @deprecated
-      # Add newline at the end
-      def ensure_newline(str)
-        deprecated('The use of "#ensure_newline" is deprecated. It will be removed soon')
-
-        str.chomp << "\n"
-      end
-
       def require_matching_files(pattern, base)
-        if RUBY_VERSION < '1.9.3'
-          ::Dir.glob(::File.expand_path(pattern, base)).each { |f| require File.join(File.dirname(f), File.basename(f, '.rb')) }
-        else
-          ::Dir.glob(::File.expand_path(pattern, base)).each { |f| require_relative f }
-        end
+        ::Dir.glob(::File.expand_path(pattern, base)).each { |f| require_relative f }
       end
 
       # Create directory and subdirectories
@@ -125,7 +113,7 @@ module Aruba
       def rm(paths, options = {})
         paths = Array(paths).map { |p| ::File.expand_path(p) }
 
-        FileUtils.rm_r(paths, options)
+        FileUtils.rm_r(paths, **options)
       end
 
       # Get current working directory
@@ -144,22 +132,22 @@ module Aruba
 
       # Touch file, directory
       def touch(args, options)
-        FileUtils.touch(args, options)
+        FileUtils.touch(args, **options)
       end
 
       # Copy file/directory
-      def cp(args, options)
-        FileUtils.cp_r(args, options)
+      def cp(src, dest)
+        FileUtils.cp_r(src, dest)
       end
 
       # Move file/directory
-      def mv(args, options)
-        FileUtils.mv(args, options)
+      def mv(src, dest)
+        FileUtils.mv(src, dest)
       end
 
       # Change mode of file/directory
       def chmod(mode, args, options)
-        FileUtils.chmod_R(mode, args, options)
+        FileUtils.chmod_R(mode, args, **options)
       end
 
       # Exists and is file
@@ -199,7 +187,7 @@ module Aruba
 
       # Check if command is relative
       #
-      # @return [TrueClass, FalseClass]
+      # @return [Boolean]
       #   true
       #     * bin/command.sh
       #
@@ -207,13 +195,13 @@ module Aruba
       #     * /bin/command.sh
       #     * command.sh
       def relative_command?(path)
-        p = ArubaPath.new(path)
-        p.relative? && p.depth > 1
+        p = Pathname.new(path)
+        p.relative? && p.basename != p
       end
 
       # Check if command is relative
       #
-      # @return [TrueClass, FalseClass]
+      # @return [Boolean]
       #   true
       #     * command.sh
       #
@@ -227,30 +215,7 @@ module Aruba
 
       # Write to file
       def write_file(path, content)
-        if RUBY_VERSION < '1.9.3'
-          File.open(path, 'wb') do |f|
-            f.print content
-          end
-        else
-          File.write(path, content)
-        end
-      end
-
-      # Unescape string
-      #
-      # @param [String] string
-      #   The string which should be unescaped, e.g. the output of a command
-      #
-      # @return
-      #   The string stripped from escape sequences
-      def unescape(string, keep_ansi = true)
-        # rubocop:disable Metrics/LineLength
-        deprecated('The use of "Aruba.platform.unescape" is deprecated. Please use "#unescape_text" and "#sanitize_text" instead. But be aware it uses a different implementation')
-        # rubocop:enable Metrics/LineLength
-
-        string = string.gsub('\n', "\n").gsub('\"', '"').gsub('\e', "\e")
-        string = string.gsub(/\e\[\d+(?>(;\d+)*)m/, '') unless keep_ansi
-        string
+        File.write(path, content)
       end
 
       # Transform hash to a string table which can be output on stderr/stdout
@@ -271,6 +236,10 @@ module Aruba
       def which(program, path = ENV['PATH'])
         UnixWhich.new.call(program, path)
       end
+
+      def builtin_shell_commands
+        []
+      end
     end
   end
 end

data/lib/aruba/platforms/unix_which.rb

@@ -23,7 +23,7 @@ module Aruba
           Aruba.platform.absolute_path?(program) || Aruba.platform.relative_command?(program)
         end
 
-        def call(program, path)
+        def call(program, _path)
           return File.expand_path(program) if Aruba.platform.executable?(program)
 
           nil
@@ -72,6 +72,7 @@ module Aruba
       #   ENV['PATH']
       def call(program, path = ENV['PATH'])
         raise ArgumentError, "ENV['PATH'] cannot be empty" if path.nil? || path.empty?
+
         program = program.to_s
 
         whiches.find { |w| w.match? program }.new.call(program, path)

data/lib/aruba/platforms/windows_command_string.rb

@@ -1,5 +1,3 @@
-require 'delegate'
-
 # Aruba
 module Aruba
   # Platforms
@@ -9,20 +7,27 @@ module Aruba
     # This adds `cmd.exec` in front of commmand
     #
     # @private
-    class WindowsCommandString < SimpleDelegator
+    class WindowsCommandString
+      def initialize(command, *arguments)
+        @command = command
+        @arguments = arguments
+      end
+
       # Convert to array
       def to_a
-        [cmd_path, '/c', __getobj__]
+        [cmd_path, '/c', [escaped_command, *escaped_arguments].join(' ')]
       end
 
-      if RUBY_VERSION < '1.9'
-        def to_s
-          __getobj__.to_s
-        end
-        alias inspect to_s
+      private
+
+      def escaped_arguments
+        @arguments.map { |arg| arg.gsub(/"/, '"""') }
+                  .map { |arg| / /.match?(arg) ? "\"#{arg}\"" : arg }
       end
 
-      private
+      def escaped_command
+        @command.gsub(/ /, '""" """')
+      end
 
       def cmd_path
         Aruba.platform.which('cmd.exe')

data/lib/aruba/platforms/windows_environment_variables.rb

@@ -5,56 +5,41 @@ 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 = if RUBY_VERSION <= '1.9.3'
-                 # rubocop:disable Style/EachWithObject
-                 env.inject({}) { |a, (k,v)| a[k.to_s.upcase] = v; a }
-               # rubocop:enable Style/EachWithObject
-               else
-                 env.each_with_object({}) { |(k,v), a| a[k.to_s.upcase] = v }
-               end
+      def initialize(env = ENV)
+        super(upcase_env env)
       end
 
       def update(other_env, &block)
-        other_env = if RUBY_VERSION <= '1.9.3'
-                      # rubocop:disable Style/EachWithObject
-                      other_env.inject({}) { |a, (k,v)| a[k.to_s.upcase] = v; a }
-                    # rubocop:enable Style/EachWithObject
-                    else
-                      other_env.each_with_object({}) { |(k,v), a| a[k.to_s.upcase] = v }
-                    end
-
-        super(other_env, &block)
+        super(upcase_env(other_env), &block)
       end
 
       def fetch(name, default = UnixEnvironmentVariables::UNDEFINED)
@@ -81,8 +66,22 @@ module Aruba
         super(name.upcase, value)
       end
 
-      def delete(name, value)
-        super(name.upcase, value)
+      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

data/lib/aruba/platforms/windows_platform.rb

@@ -37,6 +37,10 @@ module Aruba
       def which(program, path = ENV['PATH'])
         WindowsWhich.new.call(program, path)
       end
+
+      def builtin_shell_commands
+        %w(cd dir echo exit set type)
+      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
@@ -36,7 +39,7 @@ module Aruba
 
       # Output pid of process
       def pid
-        'No implemented'
+        raise NotImplementedError
       end
 
       # Output stderr and stdout
@@ -45,39 +48,39 @@ module Aruba
       end
 
       def write(*)
-        NotImplementedError
+        raise NotImplementedError
       end
 
       def stdin(*)
-        NotImplementedError
+        raise NotImplementedError
       end
 
       def stdout(*)
-        NotImplementedError
+        raise NotImplementedError
       end
 
       def stderr(*)
-        NotImplementedError
+        raise NotImplementedError
       end
 
       def close_io(*)
-        NotImplementedError
+        raise NotImplementedError
       end
 
       def send_signal(*)
-        NotImplementedError
+        raise NotImplementedError
       end
 
       def filesystem_status
-        NotImplementedError
+        raise NotImplementedError
       end
 
       def content
-        NotImplementedError
+        raise NotImplementedError
       end
 
       def wait
-        NotImplementedError
+        raise NotImplementedError
       end
 
       # Restart a command
@@ -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
 
@@ -116,19 +111,14 @@ module Aruba
       def after_run; end
 
       def inspect
-        out = stdout(:wait_for_io => 0) + stderr(:wait_for_io => 0)
+        out = truncate(stdout(wait_for_io: 0).inspect, 35)
+        err = truncate(stderr(wait_for_io: 0).inspect, 35)
 
-        out = if out.length > 76
-                out[0, 75] + ' ...'
-              else
-                out
-              end
-
-        format '#<%s:%s commandline="%s": output="%s">', self.class, self.object_id, commandline, out
+        fmt = '#<%s:%s commandline="%s": stdout=%s stderr=%s>'
+        format fmt, self.class, object_id, commandline, out, err
       end
-      alias to_s inspect
 
-      private
+      alias to_s inspect
 
       def command
         Shellwords.split(commandline).first
@@ -139,6 +129,14 @@ module Aruba
 
         []
       end
+
+      private
+
+      def truncate(string, max_length)
+        return string if string.length <= max_length
+
+        string[0, max_length - 1] + ' ...'
+      end
     end
   end
 end

data/lib/aruba/processes/debug_process.rb

@@ -4,10 +4,14 @@ require 'aruba/processes/spawn_process'
 module Aruba
   # Processes
   module Processes
-    # Run your command in `systemd()` to make debugging it easier
+    # Run your command in `system()` to make debugging it easier. This will
+    # make the process use the default input and output streams so the
+    # developer can interact with it directly. This means that part of Aruba's
+    # functionality is disabled. I.e., checks for output, and passing input
+    # programmatically will not work.
     #
-    # `DebugProcess` is not meant for direct use - `InProcess.new` - by
-    # users. Only it's public methods are part of the public API of aruba, e.g.
+    # `DebugProcess` is not meant for direct use - `DebugProcess.new` - by
+    # users. Only its public methods are part of the public API of aruba, e.g.
     # `#stdin`, `#stdout`.
     #
     # @private
@@ -18,6 +22,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 +69,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