aruba 1.0.0.pre.alpha.5 → 1.0.4

data/lib/aruba/matchers/base/message_indenter.rb

@@ -10,7 +10,7 @@ module Aruba
         def indent_multiline_message(message)
           message = message.sub(/\n+\z/, '')
           message.lines.map do |line|
-            line =~ /\S/ ? '   ' + line : line
+            /\S/.match?(line) ? "   #{line}" : line
           end.join
         end
       end

data/lib/aruba/matchers/base/object_formatter.rb

@@ -12,9 +12,6 @@ module Aruba
         prepare_for_inspection(object).inspect
       end
 
-      # rubocop:disable MethodLength
-      # rubocop:disable Metrics/CyclomaticComplexity
-
       # @private
       # Prepares the provided object to be formatted by wrapping it as needed
       # in something that, when `inspect` is called on it, will produce the
@@ -47,8 +44,6 @@ module Aruba
 
         InspectableItem.new(inspection)
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable MethodLength
 
       # @private
       def self.prepare_hash(input)

data/lib/aruba/matchers/collection/include_an_object.rb

@@ -29,9 +29,7 @@ module Aruba
       # @api private
       # @return [String]
       def failure_message
-        unless iterable?
-          return "#{improve_hash_formatting(super)}, but was not iterable"
-        end
+        return "#{improve_hash_formatting(super)}, but was not iterable" unless iterable?
 
         return failed_objects.first if failed_objects.size == 1
 
@@ -91,7 +89,9 @@ module Aruba
 
       def failure_message_for_item(index, failure_message)
         failure_message = indent_multiline_message(add_new_line_if_needed(failure_message))
-        indent_multiline_message("object at index #{index} failed to match:#{failure_message}")
+        indent_multiline_message(
+          "object at index #{index} failed to match:#{failure_message}"
+        )
       end
 
       def add_new_line_if_needed(message)

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

@@ -29,7 +29,9 @@ RSpec::Matchers.define :be_successfully_executed do
   end
 
   failure_message do |_actual|
-    "Expected `#{@actual}` to succeed but got non-zero exit status and the following output:\n\n#{@old_actual.output}\n"
+    "Expected `#{@actual}` to succeed" \
+      ' but got non-zero exit status and the following output:' \
+      "\n\n#{@old_actual.output}\n"
   end
 end
 

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

@@ -23,7 +23,9 @@ RSpec::Matchers.define :have_exit_status do |expected|
     @old_actual.stop
     @actual = actual.exit_status
 
-    raise "Expected #{@old_actual} to respond to #exit_status" unless @old_actual.respond_to? :exit_status
+    unless @old_actual.respond_to? :exit_status
+      raise "Expected #{@old_actual} to respond to #exit_status"
+    end
 
     values_match? expected, @actual
   end

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

@@ -24,7 +24,9 @@ RSpec::Matchers.define :have_finished_in_time do
     @old_actual = actual
     @actual     = @old_actual.commandline
 
-    raise "Expected #{@old_actual} to respond to #timed_out?" unless @old_actual.respond_to? :timed_out?
+    unless @old_actual.respond_to? :timed_out?
+      raise "Expected #{@old_actual} to respond to #timed_out?"
+    end
 
     @old_actual.stop
 

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

@@ -19,7 +19,9 @@ RSpec::Matchers.define :have_output do |expected|
   match do |actual|
     @old_actual = actual
 
-    raise "Expected #{@old_actual} to respond to #output" unless @old_actual.respond_to? :output
+    unless @old_actual.respond_to? :output
+      raise "Expected #{@old_actual} to respond to #output"
+    end
 
     @old_actual.stop
 

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

@@ -17,7 +17,9 @@ RSpec::Matchers.define :have_output_on_stderr do |expected|
   match do |actual|
     @old_actual = actual
 
-    raise "Expected #{@old_actual} to respond to #stderr" unless @old_actual.respond_to? :stderr
+    unless @old_actual.respond_to? :stderr
+      raise "Expected #{@old_actual} to respond to #stderr"
+    end
 
     @old_actual.stop
 

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

@@ -17,7 +17,9 @@ RSpec::Matchers.define :have_output_on_stdout do |expected|
   match do |actual|
     @old_actual = actual
 
-    raise "Expected #{@old_actual} to respond to #stdout" unless @old_actual.respond_to? :stdout
+    unless @old_actual.respond_to? :stdout
+      raise "Expected #{@old_actual} to respond to #stdout"
+    end
 
     @old_actual.stop
 

data/lib/aruba/matchers/directory/have_sub_directory.rb

@@ -23,7 +23,8 @@ require 'rspec/expectations/version'
 #
 #     RSpec.describe do
 #       it { expect('dir1.d').to have_sub_directory(['subdir.1.d', 'subdir.2.d']) }
-#       it { expect(directories).to include a_directory_with_sub_directory(['subdir.1.d', 'subdir.2.d']) }
+#       it { expect(directories)
+#       .  to include a_directory_with_sub_directory(['subdir.1.d', 'subdir.2.d']) }
 #     end
 RSpec::Matchers.define :have_sub_directory do |expected|
   match do |actual|
@@ -40,11 +41,15 @@ RSpec::Matchers.define :have_sub_directory do |expected|
   diffable
 
   failure_message do |actual|
-    format('expected that directory "%s" has the following sub-directories: %s.', actual.join(', '), expected)
+    format('expected that directory "%s" has the following sub-directories: %s.',
+           actual.join(', '),
+           expected)
   end
 
   failure_message_when_negated do |actual|
-    format('expected that directory "%s" does not have the following sub-directories: %s.', actual.join(', '), expected)
+    format('expected that directory "%s" does not have the following sub-directories: %s.',
+           actual.join(', '),
+           expected)
   end
 end
 

data/lib/aruba/matchers/file/have_file_size.rb

@@ -34,11 +34,13 @@ RSpec::Matchers.define :have_file_size do |expected|
   end
 
   failure_message do |_actual|
-    format('expected that file "%s" has size "%s", but has "%s"', @old_actual, @actual, @expected)
+    format('expected that file "%s" has size "%s", but has "%s"',
+           @old_actual, @actual, @expected)
   end
 
   failure_message_when_negated do |_actual|
-    format('expected that file "%s" does not have size "%s", but has "%s"', @old_actual, @actual, @expected)
+    format('expected that file "%s" does not have size "%s", but has "%s"',
+           @old_actual, @actual, @expected)
   end
 end
 

data/lib/aruba/matchers/path/have_permissions.rb

@@ -39,9 +39,10 @@ RSpec::Matchers.define :have_permissions do |expected|
     @old_actual = actual
     @actual = permissions(expand_path(@old_actual))
 
-    @expected = if expected.is_a? Integer
+    @expected = case expected
+                when Integer
                   expected.to_s(8)
-                elsif expected.is_a? String
+                when String
                   expected.gsub(/^0*/, '')
                 else
                   expected
@@ -51,11 +52,13 @@ RSpec::Matchers.define :have_permissions do |expected|
   end
 
   failure_message do |_actual|
-    format('expected that path "%s" has permissions "%s", but has "%s".', @old_actual, @expected, @actual)
+    format('expected that path "%s" has permissions "%s", but has "%s".',
+           @old_actual, @expected, @actual)
   end
 
   failure_message_when_negated do |_actual|
-    format('expected that path "%s" does not have permissions "%s", but has "%s".', @old_actual, @expected, @actual)
+    format('expected that path "%s" does not have permissions "%s", but has "%s".',
+           @old_actual, @expected, @actual)
   end
 end
 

data/lib/aruba/platforms/announcer.rb

@@ -1,7 +1,7 @@
 require 'shellwords'
 require 'aruba/colorizer'
 
-Aruba::Colorizer.coloring = false if !STDOUT.tty? && !ENV.key?('AUTOTEST')
+Aruba::Colorizer.coloring = false if !$stdout.tty? && !ENV.key?('AUTOTEST')
 
 # Aruba
 module Aruba
@@ -21,7 +21,9 @@ module Aruba
     #
     #   before do
     #     current_example = context.example
-    #     aruba.announcer.activate :my_channel if current_example.metadata[:announce_my_channel]
+    #     if current_example.metadata[:announce_my_channel]
+    #       aruba.announcer.activate :my_channel
+    #     end
     #   end
     #
     #   Aruba.announcer.announce(:my_channel, 'my message')
@@ -80,25 +82,37 @@ module Aruba
 
       def after_init
         output_format :changed_configuration, proc { |n, v| format('# %s = %s', n, v) }
-        output_format :changed_environment, proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
+        output_format :changed_environment,
+                      proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
         output_format :command, '$ %s'
         output_format :directory, '$ cd %s'
-        output_format :environment, proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
-        output_format :full_environment, proc { |h| format("<<-ENVIRONMENT\n%s\nENVIRONMENT", Aruba.platform.simple_table(h)) }
-        output_format :modified_environment, proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
+        output_format :environment,
+                      proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
+        output_format :full_environment,
+                      proc { |h|
+                        format("<<-ENVIRONMENT\n%s\nENVIRONMENT",
+                               Aruba.platform.simple_table(h))
+                      }
+        output_format :modified_environment,
+                      proc { |n, v| format('$ export %s=%s', n, Shellwords.escape(v)) }
         output_format :stderr, "<<-STDERR\n%s\nSTDERR"
         output_format :stdout, "<<-STDOUT\n%s\nSTDOUT"
         output_format :command_content, "<<-COMMAND\n%s\nCOMMAND"
-        output_format :stop_signal, proc { |p, s| format('Command will be stopped with `kill -%s %s`', s, p) }
+        output_format :stop_signal,
+                      proc { |p, s|
+                        format('Command will be stopped with `kill -%s %s`', s, p)
+                      }
         output_format :timeout, '# %s-timeout: %s seconds'
         output_format :wait_time, '# %s: %s seconds'
-        output_format :command_filesystem_status, proc { |status|
-          format("<<-COMMAND FILESYSTEM STATUS\n%s\nCOMMAND FILESYSTEM STATUS",
-                 Aruba.platform.simple_table(status.to_h, sort: false)) }
+        output_format :command_filesystem_status,
+                      proc { |status|
+                        format("<<-COMMAND FILESYSTEM STATUS\n%s\nCOMMAND FILESYSTEM STATUS",
+                               Aruba.platform.simple_table(status.to_h, sort: false))
+                      }
       end
 
       def output_format(channel, string = '%s', &block)
-        output_formats[channel.to_sym] = if block_given?
+        output_formats[channel.to_sym] = if block
                                            block
                                          elsif string.is_a?(Proc)
                                            string

data/lib/aruba/platforms/aruba_file_creator.rb

@@ -18,7 +18,9 @@ module Aruba
       # @param [Boolean] check_presence (false)
       #   Check if file exist
       def call(path, content, check_presence = false)
-        fail "Expected #{path} to be present" if check_presence && !Aruba.platform.file?(path)
+        if check_presence && !Aruba.platform.file?(path)
+          raise "Expected #{path} to be present"
+        end
 
         Aruba.platform.mkdir(File.dirname(path))
 

data/lib/aruba/platforms/aruba_fixed_size_file_creator.rb

@@ -22,11 +22,16 @@ module Aruba
       # @param [Boolean] check_presence (false)
       #   Check if file exist
       def call(path, size, check_presence)
-        fail "Expected #{path} to be present" if check_presence && !Aruba.platform.file?(path)
+        if check_presence && !Aruba.platform.file?(path)
+          raise "Expected #{path} to be present"
+        end
 
         Aruba.platform.mkdir(File.dirname(path))
 
-        File.open(path, 'wb') { |f| f.seek(size - 1); f.write("\0") }
+        File.open(path, 'wb') do |f|
+          f.seek(size - 1)
+          f.write("\0")
+        end
 
         self
       end

data/lib/aruba/platforms/aruba_logger.rb

@@ -47,20 +47,21 @@ module Aruba
     def logger
       l = ::Logger.new($stderr)
 
-      case mode
-      when :debug
-        l.level = ::Logger::DEBUG
+      if mode == :debug
         format_debug(l)
-      when :silent
-        l.level = 9_999
-      when :info
-        l.level = ::Logger::INFO
-        format_standard(l)
       else
-        l.level = ::Logger::INFO
         format_standard(l)
       end
 
+      l.level = case mode
+                when :debug
+                  ::Logger::DEBUG
+                when :silent
+                  9_999
+                else
+                  ::Logger::INFO
+                end
+
       l
     end
 

data/lib/aruba/platforms/command_monitor.rb

@@ -12,7 +12,7 @@ module Aruba
 
     public
 
-    attr_reader :registered_commands, :last_command_started
+    attr_reader :registered_commands, :last_command_started, :last_command_stopped
 
     class DefaultLastCommandStopped
       def nil?
@@ -20,7 +20,7 @@ module Aruba
       end
 
       def method_missing(*)
-        fail NoCommandHasBeenStoppedError, 'No last command stopped available'
+        raise NoCommandHasBeenStoppedError, 'No last command stopped available'
       end
 
       def respond_to_missing?(*)
@@ -34,7 +34,7 @@ module Aruba
       end
 
       def method_missing(*)
-        fail NoCommandHasBeenStartedError, 'No last command started available'
+        raise NoCommandHasBeenStartedError, 'No last command started available'
       end
 
       def respond_to_missing?(*)
@@ -52,8 +52,6 @@ module Aruba
       raise ArgumentError, e.message
     end
 
-    attr_reader :last_command_stopped
-
     # Set last command started
     #
     # @param [String] cmd
@@ -78,7 +76,7 @@ module Aruba
       cmd = cmd.commandline if cmd.respond_to? :commandline
       command = registered_commands.reverse.find { |c| c.commandline == cmd }
 
-      fail CommandNotFoundError, "No command named '#{cmd}' has been started" if command.nil?
+      raise CommandNotFoundError, "No command named '#{cmd}' has been started" if command.nil?
 
       command
     end

data/lib/aruba/platforms/determine_disk_usage.rb

@@ -1,33 +1,68 @@
-require 'aruba/platforms/disk_usage_calculator'
+require 'aruba/file_size'
 
-# Aruba
 module Aruba
-  # Platforms
   module Platforms
     # Determinate disk usage
     #
     # @private
     class DetermineDiskUsage
-      def call(*args)
-        args = args.flatten
-
-        deprecated_block_size = args.pop
-        paths = args
-
-        size = paths.flatten.map do |p|
-          # TODO: replace the `call` methods signature so that you can use just
-          # p.minimum_disk_space_used
-          #
-          # (Same result, since the values are multiplied, so
-          # deprecated_block_size is canceled out
-          DiskUsageCalculator.new.call(
-            (p.minimum_disk_space_used / deprecated_block_size),
-            deprecated_block_size
-          )
-        end.inject(0, &:+)
+      def call(paths)
+        size = paths.flatten.sum { |path| minimum_disk_space_used path }
 
         FileSize.new(size)
       end
+
+      private
+
+      # TODO: Aruba.config.physical_block_size could be allowed to be nil
+      # (So the unit size can be autodetected)
+
+      # Report minimum disk space used
+      #
+      # This estimates the minimum bytes allocated by the path.
+      #
+      # E.g. a 1-byte text file on a typical EXT-3 filesystem takes up 4096 bytes
+      # (could be more if it was truncated or less for sparse files).
+      #
+      # Both `File::Stat` and the `stat()` system call will report 8 `blocks`
+      # (each "usually" represents 512 bytes). So 8 * 512 is exactly 4096 bytes.
+      #
+      # (The "magic" 512 bye implied makes the value of "blocks" so confusing).
+      #
+      # Currently Aruba allows you to set what's called the `physical_block_size`,
+      # which is a bit misleading - it's the "512" value. So if you somehow have a
+      # "filesystem unit size" of 8192 (instead of a typical 4KB), set the
+      # `physical_block_size` to 1024 (yes, divide by 8: 8192/8 = 1024).
+      #
+      # Ideally, Aruba should provide e.g. `Aruba.config.fs_allocation_unit`
+      # (with 4096 as the default), so you wouldn't have to "divide by 8".
+      #
+      # (typical_fs_unit / typical_dev_bsize = 4096 / 512 = 8)
+      #
+      #
+      # @return [Integer]
+      #   Total bytes allocate
+      #
+      # TODO: this is recommended over the above "blocks"
+      def minimum_disk_space_used(path)
+        # TODO: replace Aruba.config.physical_block_size
+        # with something like Aruba.config.fs_allocation_unit
+        dev_bsize = Aruba.config.physical_block_size
+
+        stat = File::Stat.new(path.to_s)
+
+        blocks = stat.blocks
+        return (blocks * dev_bsize) if blocks
+
+        typical_fs_unit = 4096
+        typical_dev_bsize = 512 # google dev_bsize for more info
+
+        block_multiplier = typical_fs_unit / typical_dev_bsize
+        fs_unit_size = dev_bsize * block_multiplier
+        fs_units = (stat.size + fs_unit_size - 1) / fs_unit_size
+        fs_units = 1 if fs_units.zero?
+        fs_units * fs_unit_size
+      end
     end
   end
 end