aruba 1.0.0.pre.alpha.2 → 1.0.0.pre.alpha.3

data/lib/aruba/api/core.rb

@@ -25,8 +25,8 @@ module Aruba
       # This will only clean up aruba's working directory to remove all
       # artifacts of your tests. This does NOT clean up the current working
       # directory.
-      def setup_aruba
-        Aruba::Setup.new(aruba).call
+      def setup_aruba(clobber = true)
+        Aruba::Setup.new(aruba).call(clobber)
 
         self
       end
@@ -55,7 +55,7 @@ module Aruba
             aruba.current_directory << dir
             new_directory = expand_path('.')
 
-            aruba.event_bus.notify Events::ChangedWorkingDirectory.new(:old => old_directory, :new => new_directory)
+            aruba.event_bus.notify Events::ChangedWorkingDirectory.new(old: old_directory, new: new_directory)
 
             old_dir = Aruba.platform.getwd
 
@@ -80,7 +80,7 @@ module Aruba
         aruba.current_directory << dir
         new_directory = expand_path('.')
 
-        aruba.event_bus.notify Events::ChangedWorkingDirectory.new(:old => old_directory, :new => new_directory)
+        aruba.event_bus.notify Events::ChangedWorkingDirectory.new(old: old_directory, new: new_directory)
 
         self
       end
@@ -117,11 +117,15 @@ module Aruba
       #   # => <path>/test/fixtures/file
       #   expand_path('%/file')
       #
+      # @example Absolute directory
+      #
+      #   # => /foo/bar
+      #   expand_path('/foo/bar')
+      #
       # rubocop:disable Metrics/MethodLength
       # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
       def expand_path(file_name, dir_string = nil)
-        check_for_deprecated_variables if Aruba::VERSION < '1'
-
         # rubocop:disable Metrics/LineLength
         message = %(Filename "#{file_name}" needs to be a string. It cannot be nil or empty either.  Please use `expand_path('.')` if you want the current directory to be expanded.)
         # rubocop:enable Metrics/LineLength
@@ -129,7 +133,8 @@ module Aruba
         fail ArgumentError, message unless file_name.is_a?(String) && !file_name.empty?
 
         # rubocop:disable Metrics/LineLength
-        aruba.logger.warn %(`aruba`'s working directory does not exist. Maybe you forgot to run `setup_aruba` before using it's API. This warning will be an error from 1.0.0) unless Aruba.platform.directory? File.join(aruba.config.root_directory, aruba.config.working_directory)
+        fail %(Aruba's working directory does not exist. Maybe you forgot to run `setup_aruba` before using its API.) unless Aruba.platform.directory? File.join(aruba.config.root_directory, aruba.config.working_directory)
+
         # rubocop:enable Metrics/LineLength
 
         prefix = file_name[0]
@@ -140,10 +145,11 @@ module Aruba
 
           # rubocop:disable Metrics/LineLength
           fail ArgumentError, %(Fixture "#{rest}" does not exist in fixtures directory "#{aruba.fixtures_directory}". This was the one we found first on your system from all possible candidates: #{aruba.config.fixtures_directories.map { |p| format('"%s"', p) }.join(', ')}.) unless Aruba.platform.exist? path
+
           # rubocop:enable Metrics/LineLength
 
           path
-        elsif '~' == prefix
+        elsif prefix == '~'
           path = with_environment do
             ArubaPath.new(File.expand_path(file_name))
           end
@@ -152,13 +158,21 @@ module Aruba
           fail ArgumentError, %(Expanding "~/" to a relative path "#{path}" is not allowed) unless path.absolute?
 
           path.to_s
+        elsif absolute? file_name
+          unless aruba.config.allow_absolute_paths
+            aruba.logger.warn 'Using absolute paths in Aruba is not recommended.' \
+              ' Set config.allow_absolute_paths = true to silence this warning'
+          end
+          file_name
         else
           directory = File.join(aruba.root_directory, aruba.current_directory)
-          ArubaPath.new(File.join(*[directory, dir_string, file_name].compact)).expand_path.to_s
+          directory = File.expand_path(dir_string, directory) if dir_string
+          File.expand_path(file_name, directory)
         end
       end
       # rubocop:enable Metrics/MethodLength
-      # rubocop:enable  Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
 
       # Run block with environment
       #

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,7 @@ 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 })
+        aruba.event_bus.notify Events::AddedEnvironmentVariable.new(old: old_environment, new: new_environment, changed: { name: name, value: value })
 
         self
       end
@@ -33,6 +35,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 +45,7 @@ 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 })
+        aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(old: old_environment, new: new_environment, changed: { name: name, value: value })
 
         self
       end
@@ -53,6 +57,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 +67,17 @@ 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 })
+        aruba.event_bus.notify Events::ChangedEnvironmentVariable.new(old: old_environment, new: new_environment, changed: { name: name, value: value })
 
         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 +85,7 @@ 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 => '' })
+        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

@@ -40,8 +40,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,16 +52,14 @@ module Aruba
 
       # Check if path is absolute
       #
-      # @return [TrueClass, FalseClass]
-      #   Result of check
+      # @return [Boolean]
       def absolute?(path)
         ArubaPath.new(path).absolute?
       end
 
       # Check if path is relative
       #
-      # @return [TrueClass, FalseClass]
-      #   Result of check
+      # @return [Boolean]
       def relative?(path)
         ArubaPath.new(path).relative?
       end
@@ -69,7 +69,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
@@ -128,10 +128,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)
@@ -182,7 +182,7 @@ module Aruba
         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)
+        raise ArgumentError, 'Multiples sources can only be copied to a directory' if source.count > 1 && exist?(destination) && !directory?(destination)
 
         source_paths     = source.map { |f| expand_path(f) }
         destination_path = expand_path(destination)
@@ -228,7 +228,7 @@ module Aruba
           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)
+        raise ArgumentError, 'Multiple sources can only be copied to a directory' if source.count > 1 && exist?(destination) && !directory?(destination)
 
         source_paths     = source.map { |f| expand_path(f) }
         destination_path = expand_path(destination)
@@ -252,10 +252,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 +297,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 +342,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 +354,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,12 +370,11 @@ 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
-        expanded = paths.flatten.map { |p| ArubaPath.new(expand_path(p)) }
+        expanded = paths.flatten.map { |path| ArubaPath.new(expand_path(path)) }
 
         # TODO: change the API so that you could set something like
         # aruba.config.fs_allocation_unit_size directly
@@ -395,6 +394,9 @@ module Aruba
 
       # Get size of file
       #
+      # @param [String] name
+      #   File name
+      #
       # @return [Numeric]
       #   The size of the file
       def file_size(name)

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/aruba_path.rb

@@ -48,8 +48,7 @@ module Aruba
     # @example
     #   path = ArubaPath.new 'path/to/dir.d'
     #   path.pop
-    #   puts path
-    #   # => path/to
+    #   puts path # => path/to
     def pop
       @delegate_sd_obj.pop
     end
@@ -60,9 +59,8 @@ module Aruba
     #   The count of file name parts
     #
     # @example
-    #
-    # path = ArubaPath.new('path/to/file.txt')
-    # path.depth # => 3
+    #   path = ArubaPath.new('path/to/file.txt')
+    #   path.depth # => 3
     #
     def depth
       __getobj__.each_filename.to_a.size
@@ -91,19 +89,6 @@ module Aruba
       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
-    #
-    # @deprecated
-    def blocks
-      min_bytes_used = minimum_disk_space_used
-      min_bytes_used / Aruba.config.physical_block_size
-    end
-
     # TODO: Aruba.config.physical_block_size could be allowed to be nil
     # (So the unit size can be autodetected)
 

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

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/colorizer.rb

@@ -4,34 +4,34 @@ module Aruba
   module AnsiColor
     # :stopdoc:
     ATTRIBUTES = [
-      [ :clear        ,   0 ],
-      [ :reset        ,   0 ],     # synonym for :clear
-      [ :bold         ,   1 ],
-      [ :dark         ,   2 ],
-      [ :italic       ,   3 ],     # not widely implemented
-      [ :underline    ,   4 ],
-      [ :underscore   ,   4 ],     # synonym for :underline
-      [ :blink        ,   5 ],
-      [ :rapid_blink  ,   6 ],     # not widely implemented
-      [ :negative     ,   7 ],     # no reverse because of String#reverse
-      [ :concealed    ,   8 ],
-      [ :strikethrough,   9 ],     # not widely implemented
-      [ :black        ,  30 ],
-      [ :red          ,  31 ],
-      [ :green        ,  32 ],
-      [ :yellow       ,  33 ],
-      [ :blue         ,  34 ],
-      [ :magenta      ,  35 ],
-      [ :cyan         ,  36 ],
-      [ :white        ,  37 ],
-      [ :on_black     ,  40 ],
-      [ :on_red       ,  41 ],
-      [ :on_green     ,  42 ],
-      [ :on_yellow    ,  43 ],
-      [ :on_blue      ,  44 ],
-      [ :on_magenta   ,  45 ],
-      [ :on_cyan      ,  46 ],
-      [ :on_white     ,  47 ]
+      [:clear,   0],
+      [:reset,   0], # synonym for :clear
+      [:bold,   1],
+      [:dark,   2],
+      [:italic, 3], # not widely implemented
+      [:underline, 4],
+      [:underscore, 4], # synonym for :underline
+      [:blink, 5],
+      [:rapid_blink, 6], # not widely implemented
+      [:negative, 7], # no reverse because of String#reverse
+      [:concealed, 8],
+      [:strikethrough, 9], # not widely implemented
+      [:black, 30],
+      [:red, 31],
+      [:green, 32],
+      [:yellow, 33],
+      [:blue, 34],
+      [:magenta, 35],
+      [:cyan, 36],
+      [:white, 37],
+      [:on_black, 40],
+      [:on_red, 41],
+      [:on_green, 42],
+      [:on_yellow, 43],
+      [:on_blue, 44],
+      [:on_magenta, 45],
+      [:on_cyan, 46],
+      [:on_white, 47]
     ].freeze
 
     ATTRIBUTE_NAMES = ATTRIBUTES.transpose.first
@@ -62,7 +62,7 @@ module Aruba
         elsif respond_to?(:to_str)
           result << to_str
         else
-          return result #only switch on
+          return result # only switch on
         end
         result << "\e[0m" if Aruba::AnsiColor.coloring?
         result
@@ -74,10 +74,10 @@ module Aruba
     COLORED_REGEXP = /\e\[(?:[34][0-7]|[0-9])?m/
 
     def self.included(klass)
-      if klass == String
-        ATTRIBUTES.delete(:clear)
-        ATTRIBUTE_NAMES.delete(:clear)
-      end
+      return unless klass == String
+
+      ATTRIBUTES.delete(:clear)
+      ATTRIBUTE_NAMES.delete(:clear)
     end
 
     # Returns an uncolored version of the string, that is all