aruba 0.14.14 → 1.0.0

data/lib/aruba/api/environment.rb

@@ -13,6 +13,8 @@ module Aruba
       #
       # @param [String] value
       #   The value of the environment variable. Needs to be a string.
+      #
+      # @return [self]
       def set_environment_variable(name, value)
         name = name.to_s
         value = value.to_s
@@ -21,7 +23,8 @@ module Aruba
         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 })
+        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: value } }
+        aruba.event_bus.notify Events::AddedEnvironmentVariable.new(environment_change)
 
         self
       end
@@ -33,6 +36,8 @@ module Aruba
       #
       # @param [String] value
       #   The value of the environment variable. Needs to be a string.
+      #
+      # @return [self]
       def append_environment_variable(name, value)
         name = name.to_s
         value = value.to_s
@@ -41,7 +46,8 @@ module Aruba
         aruba.environment.append name, value
         new_environment = aruba.environment.to_h
 
-        aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(:old => old_environment, :new => new_environment, :changed => { :name => name, :value => value })
+        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: value } }
+        aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)
 
         self
       end
@@ -53,6 +59,8 @@ module Aruba
       #
       # @param [String] value
       #   The value of the environment variable. Needs to be a string.
+      #
+      # @return [self]
       def prepend_environment_variable(name, value)
         name = name.to_s
         value = value.to_s
@@ -61,18 +69,18 @@ module Aruba
         aruba.environment.prepend name, value
         new_environment = aruba.environment.to_h
 
-        aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(:old => old_environment, :new => new_environment, :changed => { :name => name, :value => value })
+        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: value } }
+        aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)
 
         self
       end
 
       # Remove existing environment variable
       #
-      # @param [String] key
+      # @param [String] name
       #   The name of the environment variable as string, e.g. 'HOME'
       #
-      # @param [String] value
-      #   The value of the environment variable. Needs to be a string.
+      # @return [self]
       def delete_environment_variable(name)
         name = name.to_s
 
@@ -80,7 +88,8 @@ module Aruba
         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 => '' })
+        environment_change = { old: old_environment, new: new_environment, changed: { name: name, value: '' } }
+        aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(environment_change)
 
         self
       end

data/lib/aruba/api/filesystem.rb

@@ -1,9 +1,8 @@
-require 'aruba/platform'
+require 'pathname'
 
+require 'aruba/platform'
 require 'aruba/extensions/string/strip'
 
-require 'aruba/aruba_path'
-
 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__)
@@ -40,8 +39,10 @@ module Aruba
 
       # Check if file exist and is executable
       #
-      # @param [String] file
-      #   The file which should exist
+      # @param [String] path
+      #   The path which should exist and be executable
+      #
+      # @return [Boolean]
       def executable?(path)
         path = expand_path(path)
 
@@ -50,18 +51,16 @@ module Aruba
 
       # Check if path is absolute
       #
-      # @return [TrueClass, FalseClass]
-      #   Result of check
+      # @return [Boolean]
       def absolute?(path)
-        ArubaPath.new(path).absolute?
+        Aruba.platform.absolute_path?(path)
       end
 
       # Check if path is relative
       #
-      # @return [TrueClass, FalseClass]
-      #   Result of check
+      # @return [Boolean]
       def relative?(path)
-        ArubaPath.new(path).relative?
+        Aruba.platform.relative_path?(path)
       end
 
       # Return all existing paths (directories, files) in current dir
@@ -69,7 +68,7 @@ module Aruba
       # @return [Array]
       #   List of files and directories
       def all_paths
-        list('.').map { |p| expand_path(p) }
+        list('.').map { |path| expand_path(path) }
       end
 
       # Return all existing files in current directory
@@ -107,9 +106,9 @@ module Aruba
         fail ArgumentError, %(Only directories are supported. Path "#{name}" is not a directory.) unless directory? name
 
         existing_files            = Dir.glob(expand_path(File.join(name, '**', '*')))
-        current_working_directory = ArubaPath.new(expand_path('.'))
+        current_working_directory = Pathname.new(expand_path('.'))
 
-        existing_files.map { |d| ArubaPath.new(d).relative_path_from(current_working_directory).to_s }
+        existing_files.map { |d| Pathname.new(d).relative_path_from(current_working_directory).to_s }
       end
 
       # Return content of file
@@ -128,10 +127,10 @@ module Aruba
       # The method does not check if file already exists. If the file name is a
       # path the method will create all neccessary directories.
       #
-      # @param [String] file_name
+      # @param [String] name
       #   The name of the file
       #
-      # @param [String] file_content
+      # @param [String] content
       #   The content which should be written to the file
       def write_file(name, content)
         Aruba.platform.create_file(expand_path(name), content, false)
@@ -181,8 +180,13 @@ module Aruba
           raise ArgumentError, %(The following source "#{s}" does not exist.) unless exist? s
         end
 
-        raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported" if destination.start_with? aruba.config.fixtures_path_prefix
-        raise ArgumentError, "Multiples sources can only be copied to a directory" if source.count > 1 && exist?(destination) && !directory?(destination)
+        if destination.start_with? aruba.config.fixtures_path_prefix
+          raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported"
+        end
+
+        if source.count > 1 && exist?(destination) && !directory?(destination)
+          raise ArgumentError, 'Multiples sources can only be copied to a directory'
+        end
 
         source_paths     = source.map { |f| expand_path(f) }
         destination_path = expand_path(destination)
@@ -222,13 +226,17 @@ module Aruba
           raise ArgumentError, "Using a fixture as source (#{source}) is not supported" if s.start_with? aruba.config.fixtures_path_prefix
         end
 
-        raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported" if destination.start_with? aruba.config.fixtures_path_prefix
+        if destination.start_with? aruba.config.fixtures_path_prefix
+          raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported"
+        end
 
         source.each do |s|
           raise ArgumentError, %(The following source "#{s}" does not exist.) unless exist? s
         end
 
-        raise ArgumentError, "Multiple sources can only be copied to a directory" if source.count > 1 && exist?(destination) && !directory?(destination)
+        if source.count > 1 && exist?(destination) && !directory?(destination)
+          raise ArgumentError, 'Multiple sources can only be copied to a directory'
+        end
 
         source_paths     = source.map { |f| expand_path(f) }
         destination_path = expand_path(destination)
@@ -252,10 +260,10 @@ module Aruba
       # The method does not check if file already exists. If the file name is a
       # path the method will create all neccessary directories.
       #
-      # @param [String] file_name
+      # @param [String] name
       #   The name of the file
       #
-      # @param [Integer] file_size
+      # @param [Integer] size
       #   The size of the file
       def write_fixed_size_file(name, size)
         Aruba.platform.create_fixed_size_file(expand_path(name), size, false)
@@ -297,8 +305,8 @@ module Aruba
                  mode
                end
 
-        args.each { |p| raise "Expected #{p} to be present" unless exist?(p) }
-        paths = args.map { |p| expand_path(p) }
+        args.each { |path| raise "Expected #{path} to be present" unless exist?(path) }
+        paths = args.map { |path| expand_path(path) }
 
         Aruba.platform.chmod(mode, paths, options)
 
@@ -342,7 +350,7 @@ module Aruba
                     {}
                   end
 
-        args = args.map { |p| expand_path(p) }
+        args = args.map { |path| expand_path(path) }
 
         Aruba.platform.rm(args, options)
       end
@@ -354,7 +362,7 @@ module Aruba
       #
       # @yield
       #   Pass the content of the given file to this block
-      def with_file_content(file, &block)
+      def with_file_content(file)
         expect(file).to be_an_existing_path
 
         content = read(file).join("\n")
@@ -370,20 +378,25 @@ module Aruba
       # @param [Array, Path] paths
       #   The paths
       #
-      # @result [FileSize]
+      # @return [FileSize]
       #   Bytes on disk
       def disk_usage(*paths)
-        expect(paths.flatten).to Aruba::Matchers.all be_an_existing_path
+        paths = paths.flatten
+        expect(paths).to Aruba::Matchers.all be_an_existing_path
+        expanded = paths.map { |path| expand_path(path) }
 
-        Aruba.platform.determine_disk_usage paths.flatten.map { |p| ArubaPath.new(expand_path(p)) }, aruba.config.physical_block_size
+        Aruba.platform.determine_disk_usage(expanded)
       end
 
       # Get size of file
       #
+      # @param [String] name
+      #   File name
+      #
       # @return [Numeric]
       #   The size of the file
       def file_size(name)
-        raise ArgumentError, "#{name} does not exist" unless exist? name
+        expect(name).to be_an_existing_file
 
         Aruba.platform.determine_file_size expand_path(name)
       end

data/lib/aruba/api/text.rb

@@ -22,11 +22,7 @@ module Aruba
       # @param [#to_s] text
       #   Input
       def extract_text(text)
-        if Aruba::VERSION < '1'
-          text.gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, '')
-        else
-          text.gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, '').gsub(/\\\[|\\\]/, '').gsub(/\007|\016|\017/, '')
-        end
+        text.gsub(/(?:\e|\033)\[\d+(?>(;\d+)*)m/, '').gsub(/\\\[|\\\]/, '').gsub(/\007|\016|\017/, '')
       end
 
       # Unescape special characters and remove ANSI characters
@@ -35,14 +31,12 @@ module Aruba
       #   The text to sanitize
       def sanitize_text(text)
         text = unescape_text(text)
-        text = extract_text(text) if !aruba.config.keep_ansi || aruba.config.remove_ansi_escape_sequences
+        text = extract_text(text) if aruba.config.remove_ansi_escape_sequences
 
         text.chomp
       end
 
-      # @experimental
-      #
-      # Replace variables in command string
+      # Replace variables in command string (experimental)
       #
       # @param [#to_s] text
       #   The text to parse

data/lib/aruba/api.rb

@@ -8,10 +8,6 @@ require 'aruba/platform'
 require 'aruba/api/core'
 require 'aruba/api/commands'
 
-if Aruba::VERSION <= '1.0.0'
-  require 'aruba/api/deprecated'
-end
-
 require 'aruba/api/environment'
 require 'aruba/api/filesystem'
 require 'aruba/api/text'
@@ -23,12 +19,11 @@ Aruba.platform.require_matching_files('../matchers/**/*.rb', __FILE__)
 module Aruba
   # Api
   module Api
-    include Aruba::Api::Core
-    include Aruba::Api::Commands
-    include Aruba::Api::Environment
-    include Aruba::Api::Filesystem
-    include Aruba::Api::Bundler
-    include Aruba::Api::Deprecated
-    include Aruba::Api::Text
+    include Core
+    include Commands
+    include Environment
+    include Filesystem
+    include Text
+    include Bundler
   end
 end

data/lib/aruba/aruba_path.rb

@@ -1,30 +1,21 @@
 require 'pathname'
-require 'delegate'
-
-require 'aruba/file_size'
 
 # Aruba
 module Aruba
   # Pathname for aruba files and directories
   #
   # @private
-  class ArubaPath < Delegator
+  class ArubaPath
     def initialize(path)
-      obj = [path.to_s].flatten
-
-      super obj
-
-      @delegate_sd_obj = obj
+      @obj = [path.to_s].flatten
     end
 
-    # Get path
-    def __getobj__
-      ::Pathname.new(::File.join(*@delegate_sd_obj))
+    def to_str
+      to_pathname.to_s
     end
 
-    # Set path
-    def __setobj__(obj)
-      @delegate_sd_obj = [obj.to_s].flatten
+    def to_s
+      to_str
     end
 
     # Add directory/file to path
@@ -39,95 +30,42 @@ module Aruba
     #   puts path
     #   # => path/to/dir.d/subdir.d
     def push(p)
-      @delegate_sd_obj << p
+      @obj << p
     end
     alias << push
 
-    # Remove last component of path
+    # Remove last pushed component of path
     #
     # @example
-    #   path = ArubaPath.new 'path/to/dir.d'
+    #   path = ArubaPath.new 'path/to'
+    #   path.push 'dir'
     #   path.pop
-    #   puts path
-    #   # => path/to
+    #   puts path # => path/to
     def pop
-      @delegate_sd_obj.pop
-    end
-
-    if RUBY_VERSION < '1.9'
-      def to_s
-        __getobj__.to_s
-      end
-
-      def relative?
-        !(%r{\A/} === to_s)
-      end
-
-      def absolute?
-        (%r{\A/} === to_s)
-      end
-
-      def to_ary
-        to_a
-      end
-    end
-
-    # How many parts has the file name
-    #
-    # @return [Integer]
-    #   The count of file name parts
-    #
-    # @example
-    #
-    # path = ArubaPath.new('path/to/file.txt')
-    # path.depth # => 3
-    #
-    def depth
-      if RUBY_VERSION < '1.9'
-        items = []
-        __getobj__.each_filename { |f| items << f }
-
-        items.size
-      else
-        __getobj__.each_filename.to_a.size
-      end
-    end
-
-    # Path ends with string
-    #
-    # @param [String] string
-    #   The string to check
-    def end_with?(string)
-      to_s.end_with? string
-    end
-
-    # Path starts with string
-    #
-    # @param [String] string
-    #   The string to check
-    def start_with?(string)
-      to_s.start_with? string
+      @obj.pop
     end
 
     # Return string at index
     #
     # @param [Integer, Range] index
     def [](index)
-      if RUBY_VERSION < '1.9'
-        to_s.chars.to_a[index].to_a.join('')
-      else
-        to_s[index]
-      end
+      to_s[index]
     end
 
-    # Report count of blocks allocated on disk
-    #
-    # This reports the amount of blocks which are allocated by the path.
-    #
-    # @return [Integer]
-    #   The count of blocks on disk
-    def blocks
-      File::Stat.new(to_s).blocks
+    private
+
+    # Get path
+    def to_pathname
+      current_path = @obj.inject do |path, element|
+        if element.start_with? '~'
+          element
+        elsif Aruba.platform.absolute_path? element
+          element
+        else
+          File.join(path, element)
+        end
+      end
+      ::Pathname.new(current_path)
     end
   end
 end

data/lib/aruba/basic_configuration.rb

@@ -72,7 +72,7 @@ module Aruba
         define_method("#{name}=") { |v| find_option(name).value = v }
 
         # Add reader
-        option_reader name, :contract => { None => contract.values.first }
+        option_reader name, contract: { None => contract.values.first }
       end
 
       private
@@ -80,7 +80,7 @@ module Aruba
       def add_option(name, value = nil)
         return if known_options.key?(name)
 
-        known_options[name] = Option.new(:name => name, :value => value)
+        known_options[name] = Option.new(name: name, value: value)
 
         self
       end
@@ -114,29 +114,13 @@ module Aruba
 
     # Make deep dup copy of configuration
     def make_copy
-      obj = self.dup
+      obj = dup
       obj.local_options = Marshal.load(Marshal.dump(local_options))
       obj.hooks         = @hooks
 
       obj
     end
 
-    # Get access to hooks
-    def hooks
-      # rubocop:disable Metrics/LineLength
-      Aruba.platform.deprecated 'The use of the "#aruba.config.hooks" is deprecated. Please use "#aruba.config.before(:name) {}" to define and "#aruba.config.before(:name, *args)" to run a hook. This method will become private in the next major version.'
-      # rubocop:enable Metrics/LineLength
-
-      @hooks
-    end
-
-    # @deprecated
-    def before_cmd(&block)
-      Aruba.platform.deprecated 'The use of the "#before_cmd"-hook is deprecated. Please define with "#before(:command) {}" instead'
-
-      before(:command, &block)
-    end
-
     # Define or run before-hook
     #
     # @param [Symbol, String] name
@@ -215,11 +199,7 @@ module Aruba
 
     # Set if name is option
     def set_if_option(name, *args)
-      if RUBY_VERSION < '1.9'
-        send("#{name}=".to_sym, *args) if option? name
-      else
-        public_send("#{name}=".to_sym, *args) if option? name
-      end
+      public_send("#{name}=".to_sym, *args) if option? name
     end
 
     private

data/lib/aruba/cli.rb

@@ -18,7 +18,7 @@ module Aruba
     end
 
     desc 'init', 'Initialize aruba'
-    option :test_framework, :default => 'cucumber', :enum => %w(cucumber rspec minitest), :desc => 'Choose which test framework to use'
+    option :test_framework, default: 'cucumber', enum: %w(cucumber rspec minitest), desc: 'Choose which test framework to use'
     def init
       Aruba::Initializer.new.call(options[:test_framework])
     end

data/lib/aruba/command.rb

@@ -48,6 +48,8 @@ module Aruba
 
     # Stop command
     def stop(*)
+      return if __getobj__.stopped?
+
       __getobj__.stop
       event_bus.notify Events::CommandStopped.new(self)
 

data/lib/aruba/config/jruby.rb

@@ -17,7 +17,7 @@ Aruba.configure do |config|
 
     env['JRUBY_OPTS'] = jruby_opts
 
-    if RbConfig::CONFIG['host_os'] =~ /solaris|sunos/i
+    if /solaris|sunos/i.match?(RbConfig::CONFIG['host_os'])
       java_opts = env['JAVA_OPTS'] || ''
 
       # force jRuby to use client JVM for faster startup times

data/lib/aruba/config_wrapper.rb

@@ -30,7 +30,7 @@ module Aruba
     # 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? '='
+      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

data/lib/aruba/configuration.rb

@@ -0,0 +1,92 @@
+require 'contracts'
+
+require 'aruba/version'
+require 'aruba/basic_configuration'
+require 'aruba/in_config_wrapper'
+require 'aruba/hooks'
+
+require 'aruba/contracts/relative_path'
+require 'aruba/contracts/absolute_path'
+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
+    option_reader :root_directory, contract: { None => String }, default: Dir.getwd
+
+    option_accessor :working_directory,
+                    contract: { Aruba::Contracts::RelativePath => Aruba::Contracts::RelativePath },
+                    default: 'tmp/aruba'
+
+    option_reader :fixtures_path_prefix, contract: { None => String }, default: '%'
+
+    option_accessor :exit_timeout, contract: { Num => Num }, default: 15
+    option_accessor :stop_signal, contract: { Maybe[String] => Maybe[String] }, default: nil
+    option_accessor :io_wait_timeout, contract: { Num => Num }, default: 0.1
+    option_accessor :startup_wait_time, contract: { Num => Num }, default: 0
+    option_accessor :fixtures_directories,
+                    contract: { Array => ArrayOf[String] },
+                    default: %w(features/fixtures spec/fixtures test/fixtures fixtures)
+
+    option_accessor :command_runtime_environment, contract: { Hash => Hash }, default: {}
+    option_accessor :command_search_paths,
+                    contract: { ArrayOf[String] => ArrayOf[String] } do |config|
+                      [File.join(config.root_directory.value, 'bin'), File.join(config.root_directory.value, 'exe')]
+                    end
+    option_accessor :remove_ansi_escape_sequences, contract: { Bool => Bool }, default: true
+    option_accessor :command_launcher,
+                    contract: { Aruba::Contracts::Enum[:in_process, :spawn, :debug] => Aruba::Contracts::Enum[:in_process, :spawn, :debug] },
+                    default: :spawn
+    option_accessor :main_class, contract: { Class => Maybe[Class] }, default: nil
+
+    option_accessor :home_directory,
+                    contract: { Or[Aruba::Contracts::AbsolutePath, Aruba::Contracts::RelativePath] =>
+                                Or[Aruba::Contracts::AbsolutePath, Aruba::Contracts::RelativePath] } do |config|
+      File.join(config.root_directory.value, config.working_directory.value)
+    end
+
+    option_accessor :log_level,
+                    contract: { Aruba::Contracts::Enum[:fatal, :warn, :debug, :info, :error, :unknown, :silent] =>
+                                Aruba::Contracts::Enum[:fatal, :warn, :debug, :info, :error, :unknown, :silent] },
+                    default: :info
+
+    # TODO: deprecate this value and replace with "filesystem allocation unit"
+    # equal to 4096 by default. "filesystem allocation unit" would represent
+    # the actual MINIMUM space taken in bytes by a 1-byte file
+    option_accessor :physical_block_size,
+                    contract: { Aruba::Contracts::IsPowerOfTwo => Aruba::Contracts::IsPowerOfTwo },
+                    default: 512
+    option_accessor :console_history_file, contract: { String => String }, default: '~/.aruba_history'
+
+    option_accessor :activate_announcer_on_command_failure, contract: { ArrayOf[Symbol] => ArrayOf[Symbol] }, default: []
+    option_accessor :allow_absolute_paths, contract: { Bool => Bool }, default: false
+  end
+end
+
+# 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)
+
+      self
+    end
+  end
+end