aruba 0.11.0.pre → 0.11.0.pre2

data/lib/aruba/api/core.rb

@@ -1,12 +1,13 @@
 require 'rspec/expectations'
-require 'aruba/announcer'
 require 'aruba/runtime'
 require 'aruba/errors'
+require 'aruba/setup'
 
 require 'aruba/config/jruby'
-require 'aruba/aruba_logger'
 
+# Aruba
 module Aruba
+  # Api
   module Api
     # Core methods of aruba
     #
@@ -25,9 +26,7 @@ module Aruba
       # artifacts of your tests. This does NOT clean up the current working
       # directory.
       def setup_aruba
-        Aruba.platform.rm File.join(Aruba.config.root_directory, Aruba.config.working_directory), :force => true
-        Aruba.platform.mkdir File.join(Aruba.config.root_directory, Aruba.config.working_directory)
-        Aruba.platform.chdir Aruba.config.root_directory
+        Aruba::Setup.new(aruba).call
 
         self
       end
@@ -52,8 +51,11 @@ module Aruba
           begin
             fail ArgumentError, "#{expand_path(dir)} is not a directory or does not exist." unless Aruba.platform.directory? expand_path(dir)
 
+            old_directory = expand_path('.')
             aruba.current_directory << dir
-            announcer.announce :directory, expand_path(dir)
+            new_directory = expand_path('.')
+
+            aruba.event_bus.notify Events::ChangedWorkingDirectory.new(:old => old_directory, :new => new_directory)
 
             old_dir    = Aruba.platform.getwd
 
@@ -74,8 +76,11 @@ module Aruba
 
         fail ArgumentError, "#{expand_path(dir)} is not a directory or does not exist." unless Aruba.platform.directory? expand_path(dir)
 
+        old_directory = expand_path('.')
         aruba.current_directory << dir
-        announcer.announce :directory, expand_path(dir)
+        new_directory = expand_path('.')
+
+        aruba.event_bus.notify Events::ChangedWorkingDirectory.new(:old => old_directory, :new => new_directory)
 
         self
       end
@@ -170,7 +175,7 @@ module Aruba
       #   The variables to be used for block.
       #
       # @yield
-      #   The block of code which should be run with the modified environment variables
+      #   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
 

data/lib/aruba/api/deprecated.rb

@@ -1,5 +1,10 @@
+require 'aruba/platforms/announcer'
+
+# Aruba
 module Aruba
+  # Api
   module Api
+    # Deprecated
     module Deprecated
       # @deprecated
       # The path to the directory which should contain all your test data
@@ -376,7 +381,7 @@ module Aruba
       #   The variables to be used for block.
       #
       # @yield
-      #   The block of code which should be run with the modified environment variables
+      #   The block of code which should be run with the changed environment variables
       def with_env(env = {}, &block)
         Aruba.platform.deprecated('The use of "#with_env" is deprecated. Use "#with_environment {}" instead. But be careful this uses a different implementation')
 
@@ -415,8 +420,9 @@ module Aruba
       def set_env(key, value)
         Aruba.platform.deprecated('The use of "#set_env" is deprecated. Please use "set_environment_variable" instead. But be careful, this method uses a different kind of implementation')
 
-        announcer.announce(:environment, key, value)
+        aruba.announcer.announce(:environment, key, value)
         set_environment_variable key, value
+
         original_env[key] = ENV.delete(key) unless original_env.key? key
         ENV[key] = value
       end
@@ -879,9 +885,9 @@ module Aruba
       #
       # Access to announcer
       def announcer
-        # Aruba.platform.deprecated('The use of "#announcer" is deprecated. Use "aruba.announcer" instead')
+        Aruba.platform.deprecated('The use of "#announcer" is deprecated. Use "aruba.announcer" instead')
 
-        @announcer ||= Announcer.new(
+        @announcer ||= Platforms::Announcer.new(
           self,
           :stdout => defined?(@announce_stdout),
           :stderr => defined?(@announce_stderr),
@@ -892,6 +898,22 @@ module Aruba
 
         @announcer
       end
+
+      # @private
+      # @deprecated
+      def process_monitor
+        Aruba.platform.deprecated('The use of "#process_monitor" is deprecated.')
+
+        aruba.command_monitor
+      end
+
+      # @private
+      # @deprecated
+      def processes
+        Aruba.platform.deprecated('The use of "#process_monitor" is deprecated. Please use "#all_commands" instead.')
+
+        aruba.command_monitor.send(:processes)
+      end
     end
   end
 end

data/lib/aruba/api/environment.rb

@@ -1,12 +1,14 @@
 require 'aruba/platform'
 
+# Aruba
 module Aruba
+  # Api
   module Api
     # Environment methods of aruba
     module Environment
       # Set environment variable
       #
-      # @param [String] key
+      # @param [String] name
       #   The name of the environment variable as string, e.g. 'HOME'
       #
       # @param [String] value
@@ -15,17 +17,18 @@ module Aruba
         name = name.to_s
         value = value.to_s
 
-        announcer.announce(:environment, name, value)
-        announcer.announce(:modified_environment, name, value)
-
+        old_environment = aruba.environment.to_h
         aruba.environment[name] = value
+        new_environment = aruba.environment.to_h
+
+        aruba.event_bus.notify Events::AddedEnvironmentVariable.new(:old => old_environment, :new => new_environment, :changed => { :name => name, :value => value })
 
         self
       end
 
       # Append environment variable
       #
-      # @param [String] key
+      # @param [String] name
       #   The name of the environment variable as string, e.g. 'HOME'
       #
       # @param [String] value
@@ -34,16 +37,18 @@ module Aruba
         name = name.to_s
         value = value.to_s
 
+        old_environment = aruba.environment.to_h
         aruba.environment.append name, value
-        announcer.announce(:environment, name, aruba.environment[name])
-        announcer.announce(:modified_environment, name, aruba.environment[name])
+        new_environment = aruba.environment.to_h
+
+        aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(:old => old_environment, :new => new_environment, :changed => { :name => name, :value => value })
 
         self
       end
 
       # Prepend environment variable
       #
-      # @param [String] key
+      # @param [String] name
       #   The name of the environment variable as string, e.g. 'HOME'
       #
       # @param [String] value
@@ -52,9 +57,11 @@ module Aruba
         name = name.to_s
         value = value.to_s
 
+        old_environment = aruba.environment.to_h
         aruba.environment.prepend name, value
-        announcer.announce(:environment, name, aruba.environment[name])
-        announcer.announce(:modified_environment, name, aruba.environment[name])
+        new_environment = aruba.environment.to_h
+
+        aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(:old => old_environment, :new => new_environment, :changed => { :name => name, :value => value })
 
         self
       end
@@ -69,10 +76,11 @@ module Aruba
       def delete_environment_variable(name)
         name = name.to_s
 
-        announcer.announce(:environment, name, '')
-        announcer.announce(:modified_environment, name, '')
-
+        old_environment = aruba.environment.to_h
         aruba.environment.delete name
+        new_environment = aruba.environment.to_h
+
+        aruba.event_bus.notify Events::DeletedEnvironmentVariable.new(:old => old_environment, :new => new_environment, :changed => { :name => name, :value => '' })
 
         self
       end

data/lib/aruba/api/filesystem.rb

@@ -8,8 +8,11 @@ Aruba.platform.require_matching_files('../matchers/file/*.rb', __FILE__)
 Aruba.platform.require_matching_files('../matchers/directory/*.rb', __FILE__)
 Aruba.platform.require_matching_files('../matchers/path/*.rb', __FILE__)
 
+# Aruba
 module Aruba
+  # Api
   module Api
+    # Filesystem methods
     module Filesystem
       # Check if file or directory exist
       #
@@ -35,6 +38,16 @@ module Aruba
         Aruba.platform.directory? expand_path(file)
       end
 
+      # Check if file exist and is executable
+      #
+      # @param [String] file
+      #   The file which should exist
+      def executable?(path)
+        path =  expand_path(path)
+
+        Aruba.platform.file?(path) && Aruba.platform.executable?(path)
+      end
+
       # Check if path is absolute
       #
       # @return [TrueClass, FalseClass]

data/lib/aruba/api/rvm.rb

@@ -1,8 +1,13 @@
 require 'aruba/api/environment'
 require 'aruba/api/command'
 
+# Aruba
 module Aruba
+  # Api
   module Api
+    # RVM
+    #
+    # @deprecated
     module Rvm
       # Use a clean rvm gemset
       #

data/lib/aruba/api/text.rb

@@ -1,5 +1,8 @@
+# Aruba
 module Aruba
+  # Api
   module Api
+    # Text manipulation
     module Text
       # Unescape text
       #
@@ -40,8 +43,11 @@ module Aruba
       # @experimental
       #
       # Replace variables in command string
+      #
+      # @param [#to_s] text
+      #   The text to parse
       def replace_variables(text)
-        text = text.gsub(/<pid-last-command-started>/, last_command_started.pid.to_s)
+        text = text.gsub(/<pid-last-command-started>/, last_command_started.pid.to_s) if text.include? '<pid-last-command-started>'
 
         text
       end

data/lib/aruba/aruba_path.rb

@@ -3,7 +3,11 @@ require 'delegate'
 
 require 'aruba/file_size'
 
+# Aruba
 module Aruba
+  # Pathname for aruba files and directories
+  #
+  # @private
   class ArubaPath < Delegator
     def initialize(path)
       obj = [path.to_s].flatten
@@ -13,10 +17,12 @@ module Aruba
       @delegate_sd_obj = obj
     end
 
+    # Get path
     def __getobj__
       ::Pathname.new(::File.join(*@delegate_sd_obj))
     end
 
+    # Set path
     def __setobj__(obj)
       @delegate_sd_obj = [obj.to_s].flatten
     end

data/lib/aruba/basic_configuration.rb

@@ -1,8 +1,12 @@
 require 'contracts'
 require 'aruba/basic_configuration/option'
+require 'aruba/in_config_wrapper'
 
+# Aruba
 module Aruba
-  # Basic configuration for ProxyPacRb
+  # Basic configuration for Aruba
+  #
+  # @private
   class BasicConfiguration
     include Contracts
 
@@ -11,6 +15,19 @@ module Aruba
         @known_options ||= {}
       end
 
+      # Define an option reader
+      #
+      # @param [Symbol] name
+      #   The name of the reader
+      #
+      # @param [Hash] opts
+      #   Options
+      #
+      # @option [Class, Module] contract
+      #   The contract for the option
+      #
+      # @option [Object] default
+      #   The default value
       def option_reader(name, opts = {})
         contract = opts[:contract]
         default  = opts[:default]
@@ -19,13 +36,27 @@ module Aruba
         fail ArgumentError, 'contract-options is required' if contract.nil?
 
         Contract contract
-        add_option(name, block_given? ? yield(ConfigWrapper.new(known_options)) : default)
+        add_option(name, block_given? ? yield(InConfigWrapper.new(known_options)) : default)
 
         define_method(name) { find_option(name).value }
 
         self
       end
 
+      # Define an option reader and writer
+      #
+      # @param [Symbol] name
+      #   The name of the reader
+      #
+      # @param [Hash] opts
+      #   Options
+      #
+      # @option [Class, Module] contract
+      #   The contract for the option
+      #
+      # @option [Object] default
+      #   The default value
+      #
       # rubocop:disable Metrics/CyclomaticComplexity
       def option_accessor(name, opts = {})
         contract = opts[:contract]
@@ -36,7 +67,7 @@ module Aruba
         fail ArgumentError, 'contract-options is required' if contract.nil?
 
         # Add writer
-        add_option(name, block_given? ? yield(ConfigWrapper.new(known_options)) : default)
+        add_option(name, block_given? ? yield(InConfigWrapper.new(known_options)) : default)
 
         Contract contract
         define_method("#{name}=") { |v| find_option(name).value = v }
@@ -66,6 +97,7 @@ module Aruba
 
     public
 
+    # Create configuration
     def initialize
       initialize_configuration
     end

data/lib/aruba/basic_configuration/option.rb

@@ -1,10 +1,16 @@
+# Aruba
 module Aruba
+  # Basic Configuration
+  #
   class BasicConfiguration
     # A configuration option
+    #
+    # @private
     class Option
       attr_accessor :name, :value
       attr_reader :default_value
 
+      # Create option
       def initialize(opts = {})
         name = opts[:name]
         value = opts[:value]
@@ -17,6 +23,7 @@ module Aruba
         @default_value = value
       end
 
+      # Compare option
       def ==(other)
         name == other.name && value == other.value
       end

data/lib/aruba/cli.rb

@@ -2,7 +2,11 @@ require 'thor'
 require 'aruba/console'
 require 'aruba/initializer'
 
+# Aruba
 module Aruba
+  # Command line Interface
+  #
+  # @private
   class Cli < Thor
     def self.exit_on_failure?
       true

data/lib/aruba/command.rb

@@ -1,14 +1,32 @@
+require 'delegate'
 require 'aruba/processes/spawn_process'
 require 'aruba/processes/in_process'
 require 'aruba/processes/debug_process'
 
+# Aruba
 module Aruba
+  # Command
+  #
+  # This class is not meant for direct use - Command.new, though it's API is
+  # public. As it is just a wrapper class, have a look at `BasicProcess` and
+  # the like for the public API.
+  #
+  # @see BasicProcess
+  # @see SpawnProcess
+  #
+  # @private
   class Command < SimpleDelegator
+    private
+
+    attr_reader :event_bus
+
+    public
+
+    # rubocop:disable Metrics/MethodLength
     def initialize(command, opts = {})
       launchers = []
       launchers << Processes::DebugProcess
       launchers << Processes::InProcess
-      launchers << Processes::NullProcess
       launchers << Processes::SpawnProcess
 
       launcher = launchers.find { |l| l.match? opts[:mode] }
@@ -23,8 +41,36 @@ module Aruba
         opts.fetch(:stop_signal),
         opts.fetch(:startup_wait_time)
       )
+
+      @event_bus = opts.fetch(:event_bus)
     rescue KeyError => e
       raise ArgumentError, e.message
     end
+    # rubocop:enable Metrics/MethodLength
+
+    # Stop command
+    def stop(*)
+      __getobj__.stop
+      event_bus.notify Events::CommandStopped.new(self)
+
+      self
+    end
+
+    # Terminate command
+    def terminate(*)
+      __getobj__.terminate
+      event_bus.notify Events::CommandStopped.new(self)
+
+      self
+    end
+
+    # Start command
+    def start
+      __getobj__.start
+      event_bus.notify Events::CommandStarted.new(self)
+
+      self
+    end
+    alias_method :run!, :start
   end
 end