aruba 0.11.0.pre → 0.11.0.pre2

data/lib/aruba/platforms/aruba_file_creator.rb

@@ -1,7 +1,11 @@
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
     # Normal File Creator
     # This class is not meant to be used directly by users.
+    #
+    # @private
     class ArubaFileCreator
       # Write File
       #

data/lib/aruba/platforms/aruba_fixed_size_file_creator.rb

@@ -1,4 +1,6 @@
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
     # Create files with fixed size
     #
@@ -6,6 +8,8 @@ module Aruba
     #
     # It uses a single null byte as content and really creates so called sparse
     # files.
+    #
+    # @private
     class ArubaFixedSizeFileCreator
       # Write File
       #

data/lib/aruba/{aruba_logger.rb → platforms/aruba_logger.rb}

@@ -1,6 +1,10 @@
 require 'logger'
 
+# Aruba
 module Aruba
+  # Logger
+  #
+  # @private
   class ArubaLogger
     attr_reader :mode
 

data/lib/aruba/platforms/command_monitor.rb

@@ -0,0 +1,229 @@
+require 'aruba/errors'
+
+# Aruba
+module Aruba
+  # The command monitor is part of the private API of Aruba.
+  #
+  # @private
+  class CommandMonitor
+    private
+
+    attr_reader :announcer
+
+    public
+
+    attr_reader :registered_commands, :last_command_started
+
+    class DefaultLastCommandStopped
+      def nil?
+        true
+      end
+
+      def method_missing(*)
+        fail NoCommandHasBeenStoppedError, 'No last command stopped available'
+      end
+    end
+
+    class DefaultLastCommandStarted
+      def nil?
+        true
+      end
+
+      def method_missing(*)
+        fail NoCommandHasBeenStartedError, 'No last command started available'
+      end
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    def initialize(opts = {})
+      @registered_commands = []
+      @announcer = opts.fetch(:announcer)
+
+      @last_command_stopped = DefaultLastCommandStopped.new
+      @last_command_started = DefaultLastCommandStarted.new
+
+    rescue KeyError => e
+      raise ArgumentError, e.message
+    end
+
+    if Aruba::VERSION < '1'
+      # Return the last command stopped
+      def last_command_stopped
+        return @last_command_stopped unless @last_command_stopped.nil?
+
+        registered_commands.each(&:stop)
+
+        @last_command_stopped
+      end
+    else
+      attr_reader :last_command_stopped
+    end
+
+    # Set last command started
+    #
+    # @param [String] cmd
+    #   The commandline of the command
+    def last_command_started=(cmd)
+      @last_command_started = find(cmd)
+    end
+
+    # Set last command started
+    #
+    # @param [String] cmd
+    #   The commandline of the command
+    def last_command_stopped=(cmd)
+      @last_command_stopped = find(cmd)
+    end
+
+    # Find command
+    #
+    # @yield [Command]
+    #   This yields the found command
+    def find(cmd)
+      cmd = cmd.commandline if cmd.respond_to? :commandline
+      command = registered_commands.reverse.find { |c| c.commandline == cmd }
+
+      fail CommandNotFoundError, "No command named '#{cmd}' has been started" if command.nil?
+
+      command
+    end
+
+    # Clear list of known commands
+    def clear
+      registered_commands.each(&:terminate)
+      registered_commands.clear
+
+      self
+    end
+
+    # @deprecated
+    # Fetch output (stdout, stderr) from command
+    #
+    # @param [String] cmd
+    #   The command
+    def output_from(cmd)
+      cmd = Utils.detect_ruby(cmd)
+      find(cmd).output
+    end
+
+    # @deprecated
+    # Fetch stdout from command
+    #
+    # @param [String] cmd
+    #   The command
+    def stdout_from(cmd)
+      cmd = Utils.detect_ruby(cmd)
+      find(cmd).stdout
+    end
+
+    # @deprecated
+    # Fetch stderr from command
+    #
+    # @param [String] cmd
+    #   The command
+    def stderr_from(cmd)
+      cmd = Utils.detect_ruby(cmd)
+      find(cmd).stderr
+    end
+
+    # @deprecated
+    # Get stdout of all commands
+    #
+    # @return [String]
+    #   The stdout of all command which have run before
+    def all_stdout
+      registered_commands.each(&:stop)
+
+      if RUBY_VERSION < '1.9.3'
+        # rubocop:disable Style/EachWithObject
+        registered_commands.inject("") { |a, e| a << e.stdout; a }
+        # rubocop:enable Style/EachWithObject
+      else
+        registered_commands.each_with_object("") { |e, a| a << e.stdout }
+      end
+    end
+
+    # @deprecated
+    # Get stderr of all commands
+    #
+    # @return [String]
+    #   The stderr of all command which have run before
+    def all_stderr
+      registered_commands.each(&:stop)
+
+      if RUBY_VERSION < '1.9.3'
+        # rubocop:disable Style/EachWithObject
+        registered_commands.inject("") { |a, e| a << e.stderr; a }
+        # rubocop:enable Style/EachWithObject
+      else
+        registered_commands.each_with_object("") { |e, a| a << e.stderr }
+      end
+    end
+
+    # @deprecated
+    # Get stderr and stdout of all commands
+    #
+    # @return [String]
+    #   The stderr and stdout of all command which have run before
+    def all_output
+      all_stdout << all_stderr
+    end
+
+    # @deprecated
+    def last_exit_status
+      Aruba.platform.deprecated('The use of "#last_exit_status" is deprecated. Use "last_command_(started|stopped).exit_status" instead')
+
+      return @last_exit_status if @last_exit_status
+      registered_commands.each(&:stop)
+      @last_exit_status
+    end
+
+    # @deprecated
+    def stop_process(process)
+      @last_command_stopped = process
+      @last_exit_status     = process.stop(announcer)
+    end
+
+    # @deprecated
+    def terminate_process!(process)
+      process.terminate
+    end
+
+    # @deprecated
+    def stop_processes!
+      Aruba.platform.deprecated('The use of "#stop_processes!" is deprecated.')
+
+      registered_commands.each(&:stop)
+    end
+
+    # @deprecated
+    # Terminate all running processes
+    def terminate_processes
+      Aruba.platform.deprecated('The use of "#terminate_processes" is deprecated.')
+
+      registered_commands.each(&:terminate)
+    end
+
+    # @deprecated
+    def only_processes
+      Aruba.platform.deprecated('The use of "#only_processes" is deprecated.')
+
+      registered_commands
+    end
+
+    # @deprecated
+    def get_process(wanted)
+      command = find(wanted)
+      raise ArgumentError.new("No process named '#{wanted}' has been started") unless command
+
+      command
+    end
+
+    # Register command to monitor
+    def register_command(cmd)
+      registered_commands << cmd
+
+      self
+    end
+  end
+end

data/lib/aruba/platforms/determine_disk_usage.rb

@@ -1,7 +1,12 @@
 require 'aruba/platforms/disk_usage_calculator'
 
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
+    # Determinate disk usage
+    #
+    # @private
     class DetermineDiskUsage
       def call(*args)
         args = args.flatten

data/lib/aruba/platforms/determine_file_size.rb

@@ -1,5 +1,14 @@
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
+    # Determine size of a file
+    #
+    # @param [String] path
+    #   The path to file
+    #
+    # @return [Integer]
+    #   Returns size if exists. Returns -1 if path does not exist
     class DetermineFileSize
       def call(path)
         return -1 unless File.file? path

data/lib/aruba/platforms/disk_usage_calculator.rb

@@ -1,8 +1,17 @@
 require 'aruba/file_size'
 
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
+    # Calculate disk usage
     class DiskUsageCalculator
+      # Calc
+      #
+      # @param [Integer] blocks
+      #   Count of blocks
+      # @param [Integer] block_size
+      #   The size of a single block
       def call(blocks, block_size)
         Aruba::FileSize.new(blocks * block_size)
       end

data/lib/aruba/platforms/local_environment.rb

@@ -1,6 +1,18 @@
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
+    # Local environemnt
+    #
+    # Wraps logic to make enviroment local and restorable
     class LocalEnvironment
+      # Run in environment
+      #
+      # @param [Hash] env
+      #   The environment
+      #
+      # @yield
+      #   The block of code which should with local ENV
       def call(env, &block)
         old_env = ENV.to_hash.dup
 

data/lib/aruba/platforms/simple_table.rb

@@ -1,5 +1,8 @@
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
+    # Generate simple table
     class SimpleTable
       private
 
@@ -7,10 +10,18 @@ module Aruba
 
       public
 
+      # Create
+      #
+      # @param [Hash] hash
+      #   Input
       def initialize(hash)
         @hash = hash
       end
 
+      # Generate table
+      #
+      # @return [String]
+      #   The table
       def to_s
         longest_key = hash.keys.map(&:to_s).max_by(&:length)
         return [] if longest_key.nil?

data/lib/aruba/platforms/unix_command_string.rb

@@ -1,7 +1,9 @@
 require 'delegate'
 require 'shellwords'
 
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
     # This is a command which should be run
     class UnixCommandString < SimpleDelegator
@@ -9,6 +11,7 @@ module Aruba
         __setobj__ cmd
       end
 
+      # Convert to array
       def to_a
         Shellwords.split __getobj__
       end

data/lib/aruba/platforms/unix_environment_variables.rb

@@ -1,5 +1,8 @@
+# Aruba
 module Aruba
+  # Platforms
   module Platforms
+    # Abstract environment variables
     class UnixEnvironmentVariables
       # We need to use this, because `nil` is a valid value as default
       UNDEFINED = Object.new.freeze

data/lib/aruba/platforms/unix_platform.rb

@@ -11,7 +11,11 @@ require 'aruba/platforms/determine_disk_usage'
 require 'aruba/platforms/aruba_file_creator'
 require 'aruba/platforms/aruba_fixed_size_file_creator'
 require 'aruba/platforms/local_environment'
+require 'aruba/platforms/aruba_logger'
+require 'aruba/platforms/announcer'
+require 'aruba/platforms/command_monitor'
 
+# Aruba
 module Aruba
   # This abstracts OS-specific things
   module Platforms
@@ -22,6 +26,8 @@ module Aruba
     # any further notice.
     #
     # This includes all methods for the UNIX platform
+    #
+    # @private
     class UnixPlatform
       def self.match?
         !FFI::Platform.windows?
@@ -35,6 +41,18 @@ module Aruba
         UnixCommandString
       end
 
+      def announcer
+        Announcer
+      end
+
+      def command_monitor
+        CommandMonitor
+      end
+
+      def logger
+        ArubaLogger
+      end
+
       def determine_file_size(*args)
         DetermineFileSize.new.call(*args)
       end
@@ -151,8 +169,8 @@ module Aruba
       end
 
       # Path is executable
-      def executable_file?(f)
-        File.file?(f) && File.executable?(f)
+      def executable?(f)
+        File.executable?(f)
       end
 
       # Expand path