aruba 1.0.0.pre.alpha.5 → 1.0.4

data/lib/aruba/api.rb

@@ -2,7 +2,6 @@ require 'rspec/expectations'
 require 'shellwords'
 
 require 'aruba/version'
-require 'aruba/extensions/string/strip'
 
 require 'aruba/platform'
 require 'aruba/api/core'

data/lib/aruba/api/bundler.rb

@@ -7,8 +7,23 @@ module Aruba
 
       # Unset variables used by bundler
       def unset_bundler_env_vars
-        %w[RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE].each do |key|
-          delete_environment_variable(key)
+        empty_env = with_environment { with_unbundled_env { ENV.to_h } }
+        aruba_env = aruba.environment.to_h
+        (aruba_env.keys - empty_env.keys).each do |key|
+          delete_environment_variable key
+        end
+        empty_env.each do |k, v|
+          set_environment_variable k, v
+        end
+      end
+
+      private
+
+      def with_unbundled_env(&block)
+        if ::Bundler.respond_to?(:with_unbundled_env)
+          ::Bundler.with_unbundled_env(&block)
+        else
+          ::Bundler.with_clean_env(&block)
         end
       end
     end

data/lib/aruba/api/commands.rb

@@ -64,7 +64,7 @@ module Aruba
       #   If block is given use it to filter the commands which should be
       #   stoppend.
       def stop_all_commands(&block)
-        cmds = if block_given?
+        cmds = if block
                  all_commands.select(&block)
                else
                  all_commands
@@ -81,7 +81,7 @@ module Aruba
       #   If block is given use it to filter the commands which should be
       #   terminated.
       def terminate_all_commands(&block)
-        cmds = if block_given?
+        cmds = if block
                  all_commands.select(&block)
                else
                  all_commands
@@ -168,16 +168,16 @@ module Aruba
       # @param [String] cmd
       #   The command to be executed
       #
-      # @param [Hash] options
+      # @param [Hash] opts
       #   Options for aruba
       #
-      # @option options [Boolean] fail_on_error
+      # @option opts [Boolean] :fail_on_error
       #   Should aruba fail on error?
       #
-      # @option options [Numeric] exit_timeout
+      # @option opts [Numeric] :exit_timeout
       #   Timeout for execution
       #
-      # @option options [Numeric] io_wait_timeout
+      # @option opts [Numeric] :io_wait_timeout
       #   Timeout for IO - STDERR, STDOUT
       #
       def run_command_and_stop(cmd, opts = {})
@@ -220,12 +220,11 @@ module Aruba
 
       private
 
-      # rubocop:disable Metrics/MethodLength
       def prepare_command(cmd, opts)
-        exit_timeout      = opts[:exit_timeout].nil? ? aruba.config.exit_timeout : opts[:exit_timeout]
-        io_wait_timeout   = opts[:io_wait_timeout].nil? ? aruba.config.io_wait_timeout : opts[:io_wait_timeout]
-        stop_signal       = opts[:stop_signal].nil? ? aruba.config.stop_signal : opts[:stop_signal]
-        startup_wait_time = opts[:startup_wait_time].nil? ? aruba.config.startup_wait_time : opts[:startup_wait_time]
+        exit_timeout      = opts[:exit_timeout] || aruba.config.exit_timeout
+        io_wait_timeout   = opts[:io_wait_timeout] || aruba.config.io_wait_timeout
+        stop_signal       = opts[:stop_signal] || aruba.config.stop_signal
+        startup_wait_time = opts[:startup_wait_time] || aruba.config.startup_wait_time
 
         cmd = replace_variables(cmd)
 
@@ -256,17 +255,17 @@ module Aruba
         )
       end
 
-      # rubocop:enable Metrics/MethodLength
-
       def start_command(command)
-        aruba.config.before(:command, self, command)
+        aruba.config.run_before_hook(:command, self, command)
 
-        command.start
+        in_current_directory do
+          command.start
+        end
 
         stop_signal = command.stop_signal
         aruba.announcer.announce(:stop_signal, command.pid, stop_signal) if stop_signal
 
-        aruba.config.after(:command, self, command)
+        aruba.config.run_after_hook(:command, self, command)
       end
     end
   end

data/lib/aruba/api/core.rb

@@ -15,8 +15,10 @@ module Aruba
 
       # Aruba Runtime
       def aruba
-        # TODO: Check this variable being accessed inconsistently. Should only be using the memo!
-        # Renaming this to `aruba` causes 100's of rspec failures. Needs a deeper dive, approach with caution!
+        # TODO: Check this variable being accessed inconsistently. Should only
+        # be using the memo!
+        # Renaming this to `aruba` causes 100's of rspec failures. Needs a
+        # deeper dive, approach with caution!
         @_aruba_runtime ||= Runtime.new
       end
 
@@ -54,27 +56,30 @@ module Aruba
       # @example Run code in directory
       #   result = cd('some-dir') { Dir.getwd }
       #
-      # rubocop:disable Metrics/MethodLength
       def cd(dir, &block)
-        if block_given?
+        if block
           begin
-            unless Aruba.platform.directory? expand_path(dir)
-              fail ArgumentError, "#{expand_path(dir)} is not a directory or does not exist."
+            unless Aruba.platform.directory?(expand_path(dir))
+              raise ArgumentError,
+                    "#{expand_path(dir)} is not a directory or does not exist."
             end
 
             old_directory = expand_path('.')
             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
 
-            Aruba.platform.chdir File.join(aruba.root_directory, aruba.current_directory)
+            real_new_directory = File.expand_path(aruba.current_directory,
+                                                  aruba.root_directory)
+            Aruba.platform.chdir real_new_directory
 
             result = with_environment(
               'OLDPWD' => old_dir,
-              'PWD' => File.expand_path(File.join(aruba.root_directory, aruba.current_directory)),
+              'PWD' => real_new_directory,
               &block
             )
           ensure
@@ -85,19 +90,19 @@ module Aruba
           return result
         end
 
-        unless Aruba.platform.directory? expand_path(dir)
-          fail ArgumentError, "#{expand_path(dir)} is not a directory or does not exist."
+        unless Aruba.platform.directory?(expand_path(dir))
+          raise ArgumentError, "#{expand_path(dir)} is not a directory or does not exist."
         end
 
         old_directory = expand_path('.')
         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
-      # rubocop:enable Metrics/MethodLength
 
       # Expand file name
       #
@@ -135,57 +140,70 @@ module Aruba
       #   # => /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)
-        # 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
+        unless file_name.is_a?(String) && !file_name.empty?
+          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."
 
-        fail ArgumentError, message unless file_name.is_a?(String) && !file_name.empty?
-
-        # rubocop:disable Metrics/LineLength
-        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)
+          raise ArgumentError, message
+        end
 
-        # rubocop:enable Metrics/LineLength
+        unless Aruba.platform.directory? File.join(aruba.config.root_directory,
+                                                   aruba.config.working_directory)
+          raise "Aruba's working directory does not exist." \
+            ' Maybe you forgot to run `setup_aruba` before using its API.'
+        end
 
         prefix = file_name[0]
-        rest = file_name[2..-1]
 
         if aruba.config.fixtures_path_prefix == prefix
+          rest = file_name[2..-1]
           path = File.join(*[aruba.fixtures_directory, rest].compact)
-
-          # 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
+          unless Aruba.platform.exist? path
+            aruba_fixture_candidates = aruba.config.fixtures_directories
+                                            .map { |p| format('"%s"', p) }.join(', ')
+
+            raise 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_fixture_candidates}."
+          end
 
           path
         elsif prefix == '~'
           path = with_environment do
-            ArubaPath.new(File.expand_path(file_name))
+            File.expand_path(file_name)
           end
 
-          fail ArgumentError, 'Expanding "~/" to "/" is not allowed' if path.to_s == '/'
-          fail ArgumentError, %(Expanding "~/" to a relative path "#{path}" is not allowed) unless path.absolute?
+          raise ArgumentError, 'Expanding "~/" to "/" is not allowed' if path == '/'
+
+          unless Aruba.platform.absolute_path? path
+            raise ArgumentError,
+                  "Expanding \"~\" to a relative path \"#{path}\" is not allowed"
+          end
 
           path.to_s
-        elsif absolute? file_name
+        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'
+            caller_location = caller_locations(1, 1).first
+            caller_file_line = "#{caller_location.path}:#{caller_location.lineno}"
+            aruba.logger.warn \
+              "Aruba's `expand_path` method was called with an absolute path" \
+              " at #{caller_file_line}, which is not recommended." \
+              ' Change the call to pass a relative path or set '\
+              '`config.allow_absolute_paths = true` to silence this warning'
           end
           file_name
         else
-          directory = File.join(aruba.root_directory, aruba.current_directory)
-          directory = File.expand_path(dir_string, directory) if dir_string
-          File.expand_path(file_name, directory)
+          with_environment do
+            directory = File.expand_path(aruba.current_directory, aruba.root_directory)
+            directory = File.expand_path(dir_string, directory) if dir_string
+            File.expand_path(file_name, directory)
+          end
         end
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
 
       # Run block with environment
       #
@@ -195,14 +213,10 @@ module Aruba
       # @yield
       #   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
-
-        # make sure the old environment is really restored in "ENV"
-        Aruba.platform.with_environment aruba.environment.update(env).to_h, &block
-      ensure
-        # make sure the old environment is really restored in "aruba.environment"
-        aruba.environment.clear
-        aruba.environment.update old_aruba_env
+        aruba.environment.nest do |nested_env|
+          nested_env.update(env)
+          Aruba.platform.with_environment nested_env.to_h, &block
+        end
       end
     end
   end

data/lib/aruba/api/environment.rb

@@ -23,7 +23,9 @@ module Aruba
         aruba.environment[name] = value
         new_environment = aruba.environment.to_h
 
-        environment_change = { 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
@@ -46,7 +48,9 @@ module Aruba
         aruba.environment.append name, value
         new_environment = aruba.environment.to_h
 
-        environment_change = { 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
@@ -69,7 +73,9 @@ module Aruba
         aruba.environment.prepend name, value
         new_environment = aruba.environment.to_h
 
-        environment_change = { 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
@@ -88,7 +94,9 @@ module Aruba
         aruba.environment.delete name
         new_environment = aruba.environment.to_h
 
-        environment_change = { 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

data/lib/aruba/api/filesystem.rb

@@ -1,8 +1,6 @@
-require 'aruba/platform'
-
-require 'aruba/extensions/string/strip'
+require 'pathname'
 
-require 'aruba/aruba_path'
+require 'aruba/platform'
 
 Aruba.platform.require_matching_files('../matchers/file/*.rb', __FILE__)
 Aruba.platform.require_matching_files('../matchers/directory/*.rb', __FILE__)
@@ -54,14 +52,14 @@ module Aruba
       #
       # @return [Boolean]
       def absolute?(path)
-        ArubaPath.new(path).absolute?
+        Aruba.platform.absolute_path?(path)
       end
 
       # Check if path is relative
       #
       # @return [Boolean]
       def relative?(path)
-        ArubaPath.new(path).relative?
+        Aruba.platform.relative_path?(path)
       end
 
       # Return all existing paths (directories, files) in current dir
@@ -93,7 +91,7 @@ module Aruba
       # @return [Dir]
       #   The directory object
       def directory(path)
-        fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
+        raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
 
         Dir.new(expand_path(path))
       end
@@ -103,24 +101,31 @@ module Aruba
       # @return [Array]
       #   The content of directory
       def list(name)
-        fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
+        raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
+
         unless directory? name
-          fail ArgumentError, %(Only directories are supported. Path "#{name}" is not a directory.)
+          raise ArgumentError,
+                %(Only directories are supported. Path "#{name}" is not a directory.)
         end
 
         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 do |d|
+          Pathname.new(d).relative_path_from(current_working_directory).to_s
+        end
       end
 
       # Return content of file
       #
       # @return [Array]
-      #   The content of file, without "\n" or "\r\n" at the end. To rebuild the file use `content.join("\n")`
+      #   The content of file, without "\n" or "\r\n" at the end.
+      #   To rebuild the file use `content.join("\n")`
       def read(name)
-        fail ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
-        fail ArgumentError, %(Only files are supported. Path "#{name}" is not a file.) unless file? name
+        raise ArgumentError, %(Path "#{name}" does not exist.) unless exist? name
+        unless file? name
+          raise ArgumentError, %(Only files are supported. Path "#{name}" is not a file.)
+        end
 
         File.readlines(expand_path(name)).map(&:chomp)
       end
@@ -148,7 +153,7 @@ module Aruba
       def touch(*args)
         args = args.flatten
 
-        options = if args.last.kind_of? Hash
+        options = if args.last.is_a? Hash
                     args.pop
                   else
                     {}
@@ -171,9 +176,6 @@ module Aruba
       # @param [String] destination
       #   A file or directory name. If multiple sources are given the destination
       #   needs to be a directory
-      #
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # def copy(*source, destination)
       def copy(*args)
         args = args.flatten
         destination = args.pop
@@ -184,7 +186,8 @@ module Aruba
         end
 
         if destination.start_with? aruba.config.fixtures_path_prefix
-          raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported"
+          raise ArgumentError,
+                "Using a fixture as destination (#{destination}) is not supported"
         end
 
         if source.count > 1 && exist?(destination) && !directory?(destination)
@@ -205,7 +208,6 @@ module Aruba
 
         self
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Move a file and/or directory
       #
@@ -217,9 +219,6 @@ module Aruba
       # @param [String] destination
       #   A file or directory name. If multiple sources are given the destination
       #   needs to be a directory
-      #
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/MethodLength
       def move(*args)
         args = args.flatten
         destination = args.pop
@@ -232,7 +231,8 @@ module Aruba
         end
 
         if destination.start_with? aruba.config.fixtures_path_prefix
-          raise ArgumentError, "Using a fixture as destination (#{destination}) is not supported"
+          raise ArgumentError,
+                "Using a fixture as destination (#{destination}) is not supported"
         end
 
         source.each do |s|
@@ -257,8 +257,6 @@ module Aruba
 
         self
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/CyclomaticComplexity
 
       # Create a file with the given size
       #
@@ -290,21 +288,21 @@ module Aruba
       # Change file system  permissions of file
       #
       # @param [Octal] mode
-      #   File system mode, eg. 0755
+      #   File system mode, eg. 0o755
       #
       # @param [String] file_name
       #   Name of file to be modified. This file needs to be present to succeed
       def chmod(*args)
         args = args.flatten
 
-        options = if args.last.kind_of? Hash
+        options = if args.last.is_a? Hash
                     args.pop
                   else
                     {}
                   end
 
         mode = args.shift
-        mode = if mode.kind_of? String
+        mode = if mode.is_a? String
                  mode.to_i(8)
                else
                  mode
@@ -349,7 +347,7 @@ module Aruba
       def remove(*args)
         args = args.flatten
 
-        options = if args.last.kind_of? Hash
+        options = if args.last.is_a? Hash
                     args.pop
                   else
                     {}
@@ -386,23 +384,11 @@ module Aruba
       # @return [FileSize]
       #   Bytes on disk
       def disk_usage(*paths)
-        expect(paths.flatten).to Aruba::Matchers.all be_an_existing_path
-        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
-
-        typical_fs_unit = 4096 # very typical, except for giant or embedded filesystems
-        typical_dev_bsize = 512 # google dev_bsize for more info
-
-        block_multiplier = typical_fs_unit / typical_dev_bsize
-        fs_unit_size = aruba.config.physical_block_size * block_multiplier
+        paths = paths.flatten
+        expect(paths).to Aruba::Matchers.all be_an_existing_path
+        expanded = paths.map { |path| expand_path(path) }
 
-        # TODO: the size argument here is unnecessary - ArubaPath should decide
-        # what the disk usage of a file is (even if Aruba.config needs to be
-        # read)
-        deprecated_block_count = fs_unit_size / block_multiplier
-        Aruba.platform.determine_disk_usage(expanded, deprecated_block_count)
+        Aruba.platform.determine_disk_usage(expanded)
       end
 
       # Get size of file