aruba 0.11.0.pre → 0.11.0.pre2

data/lib/aruba/config.rb

@@ -2,7 +2,7 @@ require 'contracts'
 
 require 'aruba/version'
 require 'aruba/basic_configuration'
-require 'aruba/config_wrapper'
+require 'aruba/in_config_wrapper'
 require 'aruba/hooks'
 
 require 'aruba/contracts/relative_path'
@@ -11,8 +11,11 @@ require 'aruba/contracts/enum'
 
 require 'aruba/contracts/is_power_of_two'
 
+# Aruba
 module Aruba
   # Aruba Configuration
+  #
+  # This defines the configuration options of aruba
   class Configuration < BasicConfiguration
     if Aruba::VERSION >= '1.0.0'
       option_reader :root_directory, :contract => { None => String }, :default => Dir.getwd
@@ -64,13 +67,21 @@ module Aruba
   end
 end
 
-# Main Module
+# Aruba
 module Aruba
   @config = Configuration.new
 
   class << self
     attr_reader :config
 
+    # Configure aruba
+    #
+    # @example How to configure aruba
+    #
+    #   Aruba.configure do |config|
+    #     config.<option> = <value>
+    #   end
+    #
     def configure(&block)
       @config.configure(&block)
 
@@ -79,10 +90,12 @@ module Aruba
   end
 end
 
+# Aruba
 module Aruba
   # Old Config
   #
   # @private
+  # @deprecated
   class Config < Configuration
     def initialize(*args)
       warn('The use of "Aruba::Config" is deprecated. Use "Aruba::Configuration" instead.')

data/lib/aruba/config_wrapper.rb

@@ -1,17 +1,58 @@
 module Aruba
+  # This wraps the current runtime configuration of aruba.
+  # If an option is changed, it notifies the event queue.
+  #
+  # This class is not meant for direct use - ConfigWrapper.new - by normal
+  # users.
+  #
+  # @private
   class ConfigWrapper
-    attr_reader :config
-    private :config
+    private
 
-    def initialize(config)
-      @config = config.dup
+    attr_reader :config, :event_bus
+
+    public
+
+    # Create proxy
+    #
+    # @param [Config] config
+    #   An aruba config object.
+    #
+    # @param [#notify] event_bus
+    #   The event queue which should be notified.
+    def initialize(config, event_bus)
+      @config      = config
+      @event_bus = event_bus
+    end
+
+    # Proxy all methods
+    #
+    # If one method ends with "=", e.g. ":option1=", then notify the event
+    # queue, that the user changes the value of "option1"
+    def method_missing(name, *args, &block)
+      event_bus.notify Events::ChangedConfiguration.new(:changed => { :name => name.to_s.gsub(/=$/, ''), :value => args.first }) if name.to_s.end_with? '='
+
+      config.send(name, *args, &block)
+    end
+
+    # Pass on respond_to?-calls
+    def respond_to_missing?(name, _include_private)
+      config.respond_to? name
     end
 
-    def method_missing(name, *args)
-      fail ArgumentError, 'Options take no argument' if args.count > 0
-      fail UnknownOptionError, %(Option "#{name}" is unknown. Please use only earlier defined options) unless config.key? name
+    # Compare two configs
+    #
+    # The comparism is done based on their values. No hooks are compared.
+    #
+    # Somehow `#respond_to_missing?`, `method_missing?` and `respond_to?` don't
+    # help here.
+    def ==(other)
+      config == other
+    end
 
-      config[name]
+    # Pass on respond_to?-calls
+    def respond_to?(m)
+      config.respond_to? m
     end
   end
 end

data/lib/aruba/console.rb

@@ -3,8 +3,12 @@ require 'irb'
 require 'aruba/api'
 require 'aruba/console/help'
 
+# Aruba
 module Aruba
+  # Consule
   class Console
+    # Start the aruba console
+    #
     # rubocop:disable Metrics/MethodLength
     def start
       # Start IRB with current context:
@@ -17,7 +21,6 @@ module Aruba
       IRB.conf[:PROMPT] = {}
       IRB.conf[:PROMPT][:ARUBA] = {
         :PROMPT_I => '%N:%03n:%i> ',
-        :PROMPT_N => '%N:%03n:%i> ',
         :PROMPT_S => '%N:%03n:%i%l ',
         :PROMPT_C => '%N:%03n:%i* ',
         :RETURN => "# => %s\n"

data/lib/aruba/console/help.rb

@@ -1,6 +1,8 @@
 require 'aruba/api'
 
+# Aruba
 module Aruba
+  # Consule
   class Console
     # Helpers for Aruba::Console
     module Help

data/lib/aruba/contracts/absolute_path.rb

@@ -1,8 +1,15 @@
 require 'aruba/aruba_path'
 
+# Aruba
 module Aruba
+  # Contracts
   module Contracts
+    # Check if path is absolute
     class AbsolutePath
+      # Check
+      #
+      # @param [Object] value
+      #   The value to be checked
       def self.valid?(value)
         ArubaPath.new(value).absolute?
       rescue

data/lib/aruba/contracts/enum.rb

@@ -1,7 +1,10 @@
 require 'contracts'
 
+# Aruba
 module Aruba
+  # Contracts
   module Contracts
+    # Enum
     class Enum < ::Contracts::CallableClass
       private
 
@@ -9,10 +12,12 @@ module Aruba
 
       public
 
+      # Create contract
       def initialize(*vals)
         @vals = vals
       end
 
+      # Check if value is part of array
       def valid?(val)
         vals.include? val
       end

data/lib/aruba/contracts/is_power_of_two.rb

@@ -1,12 +1,19 @@
 require 'aruba/aruba_path'
 
+# Aruba
 module Aruba
+  # Contracts
   module Contracts
+    # Is value power of two
     class IsPowerOfTwo
-      def self.valid?(x)
+      # Check value
+      #
+      # @param [Integer] value
+      #   The value to be checked
+      def self.valid?(value)
         # explanation for algorithm can be found here:
         # http://www.exploringbinary.com/ten-ways-to-check-if-an-integer-is-a-power-of-two-in-c/
-        x != 0 && (x & (x - 1)) == 0 ? true : false
+        value != 0 && (value & (value - 1)) == 0 ? true : false
       rescue
         false
       end

data/lib/aruba/contracts/relative_path.rb

@@ -1,8 +1,15 @@
 require 'aruba/aruba_path'
 
+# Aruba
 module Aruba
+  # Contracts
   module Contracts
+    # Is value relative path
     class RelativePath
+      # Check
+      #
+      # @param [String] value
+      #   The path to be checked
       def self.valid?(value)
         ArubaPath.new(value).relative?
       rescue

data/lib/aruba/cucumber/command.rb

@@ -11,7 +11,7 @@ end
 
 When(/^I run `([^`]*)`$/)do |cmd|
   cmd = sanitize_text(cmd)
-  run_simple(cmd, false)
+  run_simple(cmd, fail_on_error: false)
 end
 
 When(/^I successfully run "(.*)"$/)do |cmd|
@@ -25,7 +25,7 @@ end
 ## I successfully run `sleep 29` for up to 30 seconds
 When(/^I successfully run `(.*?)`(?: for up to (\d+) seconds)?$/)do |cmd, secs|
   cmd = sanitize_text(cmd)
-  run_simple(cmd, true, secs && secs.to_i)
+  run_simple(cmd, fail_on_error: true, exit_timeout: secs && secs.to_i)
 end
 
 When(/^I run "([^"]*)" interactively$/) do |cmd|
@@ -107,9 +107,6 @@ When(/^I stop the command(?: started last)? if (output|stdout|stderr) contains:$
     end
   rescue ChildProcess::TimeoutError, TimeoutError
     last_command_started.terminate
-  ensure
-    announcer.announce :stdout, last_command_started.stdout
-    announcer.announce :stderr, last_command_started.stderr
   end
 end
 
@@ -158,7 +155,7 @@ Then(/^(?:the )?(output|stderr|stdout)(?: from "([^"]*)")? should( not)? contain
             end
 
   commands = if cmd
-               [process_monitor.get_process(Aruba.platform.detect_ruby(cmd))]
+               [aruba.command_monitor.find(Aruba.platform.detect_ruby(cmd))]
              else
                all_commands
              end
@@ -171,7 +168,7 @@ Then(/^(?:the )?(output|stderr|stdout)(?: from "([^"]*)")? should( not)? contain
 
   if Aruba::VERSION < '1.0'
     combined_output = commands.map do |c|
-      c.stop(announcer)
+      c.stop
       c.send(channel.to_sym).chomp
     end.join("\n")
 
@@ -206,7 +203,7 @@ Then(/^(?:the )?(output|stderr|stdout)(?: from "([^"]*)")? should( not)? contain
             end
 
   commands = if cmd
-               [process_monitor.get_process(Aruba.platform.detect_ruby(cmd))]
+               [aruba.command_monitor.find(Aruba.platform.detect_ruby(cmd))]
              else
                all_commands
              end
@@ -219,7 +216,7 @@ Then(/^(?:the )?(output|stderr|stdout)(?: from "([^"]*)")? should( not)? contain
 
   if Aruba::VERSION < '1.0'
     combined_output = commands.map do |c|
-      c.stop(announcer)
+      c.stop
       c.send(channel.to_sym).chomp
     end.join("\n")
 

data/lib/aruba/cucumber/file.rb

@@ -88,7 +88,7 @@ Then(/^the following files should (not )?exist:$/) do |negated, files|
   end
 end
 
-Then(/^(?:a|the) file(?: named)? "([^"]*)" should (not )?exist$/) do |file, expect_match|
+Then(/^(?:a|the) file(?: named)? "([^"]*)" should (not )?exist(?: anymore)?$/) do |file, expect_match|
   if expect_match
     expect(file).not_to be_an_existing_file
   else

data/lib/aruba/cucumber/hooks.rb

@@ -21,7 +21,7 @@ end
 After do
   restore_env
   terminate_all_commands
-  process_monitor.clear
+  aruba.command_monitor.clear
 end
 
 Before('~@no-clobber') do
@@ -29,85 +29,92 @@ Before('~@no-clobber') do
 end
 
 Before('@puts') do
-  announcer.mode = :puts
+  aruba.announcer.mode = :puts
 end
 
 Before('@announce-command') do
-  announcer.activate :command
+  aruba.announcer.activate :command
 end
 
 Before('@announce-cmd') do
   Aruba.platform.deprecated 'The use of "@announce-cmd"-hook is deprecated. Please use "@announce-command"'
 
-  announcer.activate :command
+  aruba.announcer.activate :command
 end
 
 Before('@announce-output') do
-  announcer.activate :stdout
-  announcer.activate :stderr
+  aruba.announcer.activate :stdout
+  aruba.announcer.activate :stderr
 end
 
 Before('@announce-stdout') do
-  announcer.activate :stdout
+  aruba.announcer.activate :stdout
 end
 
 Before('@announce-stderr') do
-  announcer.activate :stderr
+  aruba.announcer.activate :stderr
 end
 
 Before('@announce-dir') do
   Aruba.platform.deprecated 'The use of "@announce-dir"-hook is deprecated. Please use "@announce-directory"'
 
-  announcer.activate :directory
+  aruba.announcer.activate :directory
 end
 
 Before('@announce-directory') do
-  announcer.activate :directory
+  aruba.announcer.activate :directory
 end
 
 Before('@announce-stop-signal') do
-  announcer.activate :stop_signal
+  aruba.announcer.activate :stop_signal
 end
 
 Before('@announce-env') do
-  Aruba.platform.deprecated 'The use of "@announce-env"-hook is deprecated. Please use "@announce-modified-environment"'
+  Aruba.platform.deprecated 'The use of "@announce-env"-hook is deprecated. Please use "@announce-changed-environment"'
 
-  announcer.activate :environment
+  aruba.announcer.activate :environment
 end
 
 Before('@announce-environment') do
-  Aruba.platform.deprecated '@announce-environment is deprecated. Use @announce-modified-environment instead'
+  Aruba.platform.deprecated '@announce-environment is deprecated. Use @announce-changed-environment instead'
 
-  announcer.activate :modified_environment
+  aruba.announcer.activate :changed_environment
 end
 
 Before('@announce-full-environment') do
-  announcer.activate :full_environment
+  aruba.announcer.activate :full_environment
 end
 
 Before('@announce-modified-environment') do
-  announcer.activate :modified_environment
+  Aruba.platform.deprecated '@announce-modified-environment is deprecated. Use @announce-changed-environment instead'
+
+  aruba.announcer.activate :changed_environment
+end
+
+Before('@announce-changed-environment') do
+  aruba.announcer.activate :changed_environment
 end
 
 Before('@announce-timeout') do
-  announcer.activate :timeout
+  aruba.announcer.activate :timeout
 end
 
 Before('@announce-wait-time') do
-  announcer.activate :wait_time
+  aruba.announcer.activate :wait_time
 end
 
 Before('@announce') do
-  announcer.activate :command
-  announcer.activate :stdout
-  announcer.activate :stderr
-  announcer.activate :directory
-  announcer.activate :modified_environment
-  announcer.activate :full_environment
-  announcer.activate :environment
-  announcer.activate :timeout
-  announcer.activate :wait_time
-  announcer.activate :stop_signal
+  aruba.announcer.activate :changed_environment
+  aruba.announcer.activate :command
+  aruba.announcer.activate :directory
+  aruba.announcer.activate :environment
+  aruba.announcer.activate :full_environment
+  aruba.announcer.activate :modified_environment
+  aruba.announcer.activate :stderr
+  aruba.announcer.activate :stdout
+  aruba.announcer.activate :stop_signal
+  aruba.announcer.activate :timeout
+  aruba.announcer.activate :wait_time
 end
 
 Before('@debug') do

data/lib/aruba/errors.rb

@@ -11,6 +11,21 @@ module Aruba
   # Raised if one tries to use an unknown configuration option
   class UnknownOptionError < ArgumentError; end
 
-  # Rais if command already died
+  # Raised if command already died
   class CommandAlreadyStoppedError < Error; end
+
+  # Raised if one tries to access last command started, but no command
+  # has been started
+  class NoCommandHasBeenStartedError < Error; end
+
+  # Raised if one tries to access last command stopped, but no command
+  # has been stopped
+  class NoCommandHasBeenStoppedError < Error; end
+
+  # Raised if one looked for a command, but no matching was found
+  class CommandNotFoundError < ArgumentError; end
+
+  # Raised if command was already started, otherwise aruba forgets about the
+  # previous pid and you've got hidden commands run
+  class CommandAlreadyStartedError < Error; end
 end