aruba 0.7.4 → 0.8.0.pre

data/lib/aruba/cucumber/hooks.rb

@@ -1,25 +1,50 @@
-Before('@disable-bundler') do
-  unset_bundler_env_vars
-end
+require 'aruba/aruba_path'
+require 'aruba/api'
+World(Aruba::Api)
+
+# Activate on 1.0.0
+#
+# Around do |_, block|
+#   begin
+#     if RUBY_VERSION < '1.9'
+#       old_env = ENV.to_hash
+#     else
+#       old_env = ENV.to_h
+#     end
+#
+#     block.call
+#   ensure
+#     ENV.clear
+#     ENV.update old_env
+#   end
+# end
 
 Before do
-  @__aruba_original_paths = (ENV['PATH'] || '').split(File::PATH_SEPARATOR)
-  ENV['PATH'] = ([File.expand_path('bin')] + @__aruba_original_paths).join(File::PATH_SEPARATOR)
+  aruba.environment.update aruba.config.command_runtime_environment
+  prepend_environment_variable 'PATH', aruba.config.command_search_paths.join(':') + ':'
 end
 
 After do
-  ENV['PATH'] = @__aruba_original_paths.join(File::PATH_SEPARATOR)
+  restore_env
+  process_monitor.stop_processes!
+  process_monitor.clear
 end
 
 Before('~@no-clobber') do
-  clean_current_directory
+  setup_aruba
 end
 
 Before('@puts') do
   announcer.mode = :puts
 end
 
+Before('@announce-command') do
+  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
 end
 
@@ -32,19 +57,36 @@ Before('@announce-stderr') do
 end
 
 Before('@announce-dir') do
+  Aruba::Platform.deprecated 'The use of "@announce-dir"-hook is deprecated. Please use "@announce-directory"'
+
+  announcer.activate :directory
+end
+
+Before('@announce-directory') do
   announcer.activate :directory
 end
 
 Before('@announce-env') do
+  Aruba::Platform.deprecated 'The use of "@announce-env"-hook is deprecated. Please use "@announce-environment"'
+
+  announcer.activate :environment
+end
+
+Before('@announce-environment') do
   announcer.activate :environment
 end
 
+Before('@announce-timeout') do
+  announcer.activate :timeout
+end
+
 Before('@announce') do
   announcer.activate :command
   announcer.activate :stdout
   announcer.activate :stderr
   announcer.activate :directory
   announcer.activate :environment
+  announcer.activate :timeout
 end
 
 Before('@debug') do
@@ -52,11 +94,24 @@ Before('@debug') do
   Aruba.process = Aruba::Processes::DebugProcess
 end
 
+After('@debug') do
+  Aruba.process = Aruba::Processes::SpawnProcess
+end
+
 Before('@ansi') do
   @aruba_keep_ansi = true
 end
 
-After do
-  restore_env
-  process_monitor.clear
+Before '@mocked_home_directory' do
+  Aruba::Platform.deprecated('The use of "@mocked_home_directory" is deprecated. Use "@mocked-home-directory" instead')
+
+  set_environment_variable 'HOME', expand_path('.')
+end
+
+Before '@mocked-home-directory' do
+  set_environment_variable 'HOME', expand_path('.')
+end
+
+Before('@disable-bundler') do
+  unset_bundler_env_vars
 end

data/lib/aruba/environment.rb

@@ -0,0 +1,121 @@
+module Aruba
+  class Environment
+    private
+
+    attr_reader :env
+
+    public
+
+    def initialize
+      @env = ENV.to_hash
+    end
+
+    # Update environment with other en
+    #
+    # @param [#to_hash, #to_h] other_env
+    #   Another environment object or hash
+    #
+    # @yield
+    #   Pass block to env
+    def update(other_env, &block)
+      if RUBY_VERSION <= '1.9.3'
+        # rubocop:disable Style/EachWithObject
+        other_env = other_env.to_hash.inject({}) { |a, (k, v)| a[k] = v.to_s; a }
+        # rubocop:enable Style/EachWithObject
+      else
+        other_env = other_env.to_h.each_with_object({}) { |(k, v), a| a[k] = v.to_s }
+      end
+
+      env.update(other_env, &block)
+
+      self
+    end
+
+    # Fetch variable from environment
+    #
+    # @param [#to_s] name
+    #   The name of the variable
+    #
+    # @param [Object] default
+    #   The default value used, if the variable is not defined
+    def fetch(name, default)
+      env.fetch name.to_s, default
+    end
+
+    # Check if variable exist
+    #
+    # @param [#to_s] name
+    #   The name of the variable
+    def key?(name)
+      env.key? name.to_s
+    end
+
+    # Get value of variable
+    #
+    # @param [#to_s] name
+    #   The name of the variable
+    def [](name)
+      env[name.to_s]
+    end
+
+    # Set value of variable
+    #
+    # @param [#to_s] name
+    #   The name of the variable
+    #
+    # @param [#to_s] value
+    #   The value of the variable
+    def []=(name, value)
+      env[name.to_s] = value.to_s
+
+      self
+    end
+
+    # Append value to variable
+    #
+    # @param [#to_s] name
+    #   The name of the variable
+    #
+    # @param [#to_s] value
+    #   The value of the variable
+    def append(name, value)
+      name = name.to_s
+      env[name] = env[name].to_s + value.to_s
+
+      self
+    end
+
+    # Prepend value to variable
+    #
+    # @param [#to_s] name
+    #   The name of the variable
+    #
+    # @param [#to_s] value
+    #   The value of the variable
+    def prepend(name, value)
+      name = name.to_s
+      env[name] = value.to_s + env[name].to_s
+
+      self
+    end
+
+    # Convert to hash
+    #
+    # @return [Hash]
+    #   A new hash from environment
+    def to_h
+      if RUBY_VERSION < '2.0'
+        env.to_hash.dup
+      else
+        env.to_h.dup
+      end
+    end
+
+    # Reset environment
+    def clear
+      env.clear
+
+      self
+    end
+  end
+end

data/lib/aruba/errors.rb

@@ -7,4 +7,7 @@ module Aruba
 
   # Raised on launch error
   class LaunchError < Error; end
+
+  # Raised if one tries to use an unknown configuration option
+  class UnknownOptionError < ArgumentError; end
 end

data/lib/aruba/extensions/string/strip.rb

@@ -0,0 +1,24 @@
+class String
+  # Strips indentation in heredocs.
+  #
+  # For example in
+  #
+  #   if options[:usage]
+  #     puts <<-USAGE.strip_heredoc
+  #       This command does such and such.
+  #
+  #       Supported options are:
+  #         -h         This message
+  #         ...
+  #     USAGE
+  #   end
+  #
+  # the user would see the usage message aligned against the left margin.
+  #
+  # Technically, it looks for the least indented line in the whole string, and removes
+  # that amount of leading whitespace.
+  def strip_heredoc
+    indent = scan(/^[ \t]*(?=\S)/).min.to_s.size
+    gsub(/^[ \t]{#{indent}}/, '')
+  end
+end

data/lib/aruba/hooks.rb

@@ -0,0 +1,54 @@
+module Aruba
+  # Aruba Hooks
+  class Hooks
+    private
+
+    attr_reader :store
+
+    public
+
+    def initialize
+      @store = {}
+    end
+
+    # Add new hook
+    #
+    # @param [String, Symbol] label
+    #   The name of the hook
+    #
+    # @para [Proc] block
+    #   The block which should be run for the hook
+    def append(label, block)
+      if store.key?(label.to_sym) && store[label.to_sym].respond_to?(:<<)
+        store[label.to_sym] << block
+      else
+        store[label.to_sym] = []
+        store[label.to_sym] << block
+      end
+    end
+
+    # Run hook
+    #
+    # @param [String, Symbol] label
+    #   The name of the hook
+    #
+    # @param [Object] context
+    #   The context in which the hook is run
+    #
+    # @param [Array] args
+    #   Other arguments
+    def execute(label, context, *args)
+      Array(store[label.to_sym]).each do |block|
+        context.instance_exec(*args, &block)
+      end
+    end
+
+    # Check if hook exist
+    #
+    # @param [String, Symbol] label
+    #   The name of the hook
+    def exist?(label)
+      store.key? label.to_sym
+    end
+  end
+end

data/lib/aruba/jruby.rb

@@ -1,9 +1,4 @@
-# ideas taken from: http://blog.headius.com/2010/03/jruby-startup-time-tips.html
-Aruba.configure do |config|
-  config.before_cmd do
-    # disable JIT since these processes are so short lived
-    set_env('JRUBY_OPTS', "-X-C #{ENV['JRUBY_OPTS']}")
-    # force jRuby to use client JVM for faster startup times
-    set_env('JAVA_OPTS', "-d32 #{ENV['JAVA_OPTS']}") if RbConfig::CONFIG['host_os'] =~ /solaris|sunos/i
-  end
-end if RUBY_PLATFORM == 'java'
+require 'aruba/platform'
+Aruba::Platform.deprecated('The use of "aruba/jruby" is deprecated. Use "aruba/config/jruby" instead')
+
+require 'aruba/config/jruby'

data/lib/aruba/matchers/command.rb

@@ -1,79 +1 @@
-# @!method have_exit_status(status)
-#   This matchers checks if <command> has exit status <status>
-#
-#   @param [Integer] status
-#     The value of the exit status
-#
-#   @return [TrueClass, FalseClass] The result
-#
-#     false:
-#     * if command does not have exit status
-#     true:
-#     * if command has exit status
-#
-#   @example Use matcher
-#
-#     RSpec.describe do
-#       it { expect(last_command).to have_exit_status(0) }
-#     end
-RSpec::Matchers.define :have_exit_status do |expected|
-  match do |actual|
-    @old_actual = actual
-
-    @announcer ||= Aruba::Announcer.new(
-      self,
-      :stdout => @announce_stdout,
-      :stderr => @announce_stderr,
-      :dir    => @announce_dir,
-      :cmd    => @announce_cmd,
-      :env    => @announce_env
-    )
-
-    @old_actual.stop(@announcer) unless @old_actual.stopped?
-    @actual = actual.exit_status
-
-    next false unless @old_actual.respond_to? :exit_status
-
-    values_match? expected, @actual
-  end
-
-  failure_message do |actual|
-    format(%(expected that command "%s" has exit status of "%s", but has "%s".), @old_actual.commandline, expected.to_s, actual.to_s)
-  end
-
-  failure_message_when_negated do |actual|
-    format(%(expected that command "%s" does not have exit status of "%s", but has "%s".), @old_actual.commandline, expected.to_s, actual.to_s)
-  end
-end
-
-# @!method be_successfuly_executed
-#   This matchers checks if execution of <command> was successful
-#
-#   @return [TrueClass, FalseClass] The result
-#
-#     false:
-#     * if command was not successful
-#     true:
-#     * if command was successful
-#
-#   @example Use matcher
-#
-#     RSpec.describe do
-#       it { expect(last_command).to be_successfully_executed }
-#     end
-RSpec::Matchers.define :be_successfully_executed do
-  match do |actual|
-    @old_actual = actual
-    @actual = actual.exit_status
-
-    expect(@old_actual).to have_exit_status 0
-  end
-
-  failure_message do |actual|
-    format(%(expected that command "%s" has exit status of "%s", but has "%s".), @old_actual.commandline, '0', actual.to_s)
-  end
-
-  failure_message_when_negated do |actual|
-    format(%(expected that command "%s" does not have exit status of "%s", but has "%s".), @old_actual.commandline, '0', actual.to_s)
-  end
-end
+Aruba::Platform.require_matching_files('../command/**/*.rb', __FILE__)

data/lib/aruba/matchers/command/be_successfully_executed.rb

@@ -0,0 +1,30 @@
+require 'aruba/matchers/command/have_exit_status'
+require 'aruba/matchers/command/have_finished_in_time'
+
+# @!method be_successfuly_executed
+#   This matchers checks if execution of <command> was successful
+#
+#   @return [TrueClass, FalseClass] The result
+#
+#     false:
+#     * if command was not successful
+#     true:
+#     * if command was successful
+#
+#   @example Use matcher
+#
+#     RSpec.describe do
+#       it { expect(last_command).to be_successfully_executed }
+#       it { expect(last_command).not_to be_successfully_executed }
+#       it { expect(last_command).to have_failed_running }
+#     end
+RSpec::Matchers.define :be_successfully_executed do
+  match do |actual|
+    @old_actual = actual
+    @actual     = @old_actual.commandline
+
+    expect(@old_actual).to have_exit_status(0)
+  end
+end
+
+RSpec::Matchers.define_negated_matcher :have_failed_running, :be_successfully_executed