aruba 2.1.0 → 2.3.0

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

@@ -1,5 +1,7 @@
-require "aruba/matchers/command/have_exit_status"
-require "aruba/matchers/command/have_finished_in_time"
+# frozen_string_literal: true
+
+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
@@ -27,8 +29,8 @@ 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:" \
+    "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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method have_exit_status(status)
 #   This matchers checks if <command> has exit status <status>
 #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method run_too_long
 #   This matchers checks if <command> run too long. Say the timeout is 10
 #   seconds and it takes <command> to finish in 15. This matchers will succeed.

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

@@ -1,4 +1,6 @@
-require "aruba/matchers/base/message_indenter"
+# frozen_string_literal: true
+
+require 'aruba/matchers/base/message_indenter'
 
 # @!method have_output
 #   This matchers checks if <command> has created output

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method have_output_on_stderr
 #   This matchers checks if <command> has created output on stderr
 #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method have_output_on_stdout
 #   This matchers checks if <command> has created output on stdout
 #

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

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 # @!method have_output_size(output)
 #   This matchers checks if output has size.
 #
-#   @param [String] output
-#     The content which should be checked
+#   @param [String,Aruba::Process:BasicProcess] output or process
+#     The content which should be checked, or the process whose output should be checked
+#
+#     Use of this matcher with a string is deprecated.
 #
 #   @return [Boolean] The result
 #
@@ -16,12 +20,24 @@
 #     RSpec.describe do
 #       it { expect(file1).to have_output_size(256) }
 #     end
+#
+#     RSpec.describe do
+#       it { expect(last_command_started).to have_output_size(256) }
+#     end
 RSpec::Matchers.define :have_output_size do |expected|
   match do |actual|
-    raise "Expected #{actual} to respond to #size" unless actual.respond_to? :size
+    if actual.respond_to? :size
+      Aruba.platform.deprecated \
+        'Application of the have_output_size matcher to a string is deprecated. ' \
+        'Apply the matcher directly to the process object instead'
+      actual_size = actual.size
+    elsif actual.respond_to? :output
+      actual_size = actual.output.size
+    else
+      raise "Expected #{actual} to respond to #size or #output"
+    end
 
-    @actual = actual.size
-    values_match? expected, @actual
+    values_match? expected, actual_size
   end
 
   description { "output has size #{description_of expected}" }

data/lib/aruba/matchers/command.rb

@@ -1 +1,3 @@
-Aruba.platform.require_matching_files("../command/**/*.rb", __FILE__)
+# frozen_string_literal: true
+
+Aruba.platform.require_matching_files('../command/**/*.rb', __FILE__)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method be_an_existing_directory
 #   This matchers checks if <directory> exists in filesystem
 #
@@ -17,7 +19,7 @@ RSpec::Matchers.define :be_an_existing_directory do |_|
   match do |actual|
     stop_all_commands
 
-    raise "String expected" unless actual.is_a? String
+    raise 'String expected' unless actual.is_a? String
 
     directory?(actual)
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method have_sub_directory(sub_directory)
 #   This matchers checks if <directory> has given sub-directory
 #
@@ -40,13 +42,13 @@ RSpec::Matchers.define :have_sub_directory do |expected|
 
   failure_message do |actual|
     format('expected that directory "%s" has the following sub-directories: %s.',
-           actual.join(", "),
+           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(", "),
+           actual.join(', '),
            expected)
   end
 end

data/lib/aruba/matchers/directory.rb

@@ -1 +1,3 @@
-Aruba.platform.require_matching_files("../directory/**/*.rb", __FILE__)
+# frozen_string_literal: true
+
+Aruba.platform.require_matching_files('../directory/**/*.rb', __FILE__)

data/lib/aruba/matchers/environment.rb

@@ -1 +1,3 @@
-Aruba.platform.require_matching_files("../matchers/environment/*.rb", __FILE__)
+# frozen_string_literal: true
+
+Aruba.platform.require_matching_files('../matchers/environment/*.rb', __FILE__)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method be_a_command_found_in_path
 #   This matchers checks if <command> can be found in path
 #
@@ -15,17 +17,17 @@
 #     end
 RSpec::Matchers.define :be_a_command_found_in_path do
   match do |actual|
-    @actual = Shellwords.split(actual.commandline).first if actual.respond_to? :commandline
-
-    !which(@actual).nil?
+    !which(actual).nil?
   end
 
   failure_message do |actual|
-    format(%(expected that command "%s" can be found in PATH "#{ENV['PATH']}".), actual)
+    format(%(expected that command "%s" can be found in PATH "%s".),
+           actual, aruba.environment['PATH'])
   end
 
   failure_message_when_negated do |actual|
-    format(%(expected that command "%s" cannot be found in PATH "#{ENV['PATH']}".), actual)
+    format(%(expected that command "%s" cannot be found in PATH "%s".),
+           actual, aruba.environment['PATH'])
   end
 end
 

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

@@ -1,4 +1,6 @@
-require "shellwords"
+# frozen_string_literal: true
+
+require 'shellwords'
 
 # @!method be_an_existing_executable
 #   This matchers checks if <file> exists in filesystem

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method be_an_existing_file
 #   This matchers checks if <file> exists in filesystem
 #
@@ -17,7 +19,7 @@ RSpec::Matchers.define :be_an_existing_file do |_|
   match do |actual|
     stop_all_commands
 
-    raise "String expected" unless actual.is_a? String
+    raise 'String expected' unless actual.is_a? String
 
     file?(actual)
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method have_file_content(content)
 #   This matchers checks if <file> has content. `content` can be a string,
 #   regexp or an RSpec matcher.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method have_file_size(size)
 #   This matchers checks if path has file size
 #

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

@@ -1,4 +1,6 @@
-require "fileutils"
+# frozen_string_literal: true
+
+require 'fileutils'
 
 # @!method have_same_file_content_as(file_name)
 #   This matchers checks if <file1> has the same content like <file2>

data/lib/aruba/matchers/file.rb

@@ -1 +1,3 @@
-Aruba.platform.require_matching_files("../file/**/*.rb", __FILE__)
+# frozen_string_literal: true
+
+Aruba.platform.require_matching_files('../file/**/*.rb', __FILE__)

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method a_path_matching_pattern(/pattern/)
 #   This matchers checks if <path> matches pattern. `pattern` can be a string,
 #   regexp or an RSpec matcher.

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method be_an_absolute_path
 #   This matchers checks if <path> exists in filesystem
 #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method be_an_existing_path
 #   This matchers checks if <path> exists in filesystem
 #

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method have_permissions(permissions)
 #   This matchers checks if <file> or <directory> has <perm> permissions
 #
@@ -41,7 +43,7 @@ RSpec::Matchers.define :have_permissions do |expected|
                 when Integer
                   expected.to_s(8)
                 when String
-                  expected.gsub(/^0*/, "")
+                  expected.gsub(/^0*/, '')
                 else
                   expected
                 end

data/lib/aruba/matchers/path.rb

@@ -1 +1,3 @@
-Aruba.platform.require_matching_files("../path/**/*.rb", __FILE__)
+# frozen_string_literal: true
+
+Aruba.platform.require_matching_files('../path/**/*.rb', __FILE__)

data/lib/aruba/matchers/string/include_output_string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method include_output_string(string)
 #   This matchers checks if the output string of a command includes string.
 #
@@ -18,7 +20,7 @@
 #     end
 RSpec::Matchers.define :include_output_string do |expected|
   match do |actual|
-    actual.force_encoding("UTF-8")
+    actual.force_encoding('UTF-8')
     @expected = Regexp.new(Regexp.escape(sanitize_text(expected.to_s)), Regexp::MULTILINE)
     @actual   = sanitize_text(actual)
 

data/lib/aruba/matchers/string/match_output_string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method match_output_string(string)
 #   This matchers checks if the output string of a command matches regular expression.
 #
@@ -18,7 +20,7 @@
 #     end
 RSpec::Matchers.define :match_output_string do |expected|
   match do |actual|
-    actual.force_encoding("UTF-8")
+    actual.force_encoding('UTF-8')
     @expected = Regexp.new(unescape_text(expected), Regexp::MULTILINE)
     @actual   = sanitize_text(actual)
 

data/lib/aruba/matchers/string/output_string_eq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @!method output_string_eq(string)
 #   This matchers checks if the output string of a command includes string.
 #
@@ -18,7 +20,7 @@
 #     end
 RSpec::Matchers.define :output_string_eq do |expected|
   match do |actual|
-    actual.force_encoding("UTF-8")
+    actual.force_encoding('UTF-8')
     @expected = sanitize_text(expected.to_s)
     @actual   = sanitize_text(actual.to_s)
 

data/lib/aruba/matchers/string.rb

@@ -1 +1,3 @@
-Aruba.platform.require_matching_files("../string/**/*.rb", __FILE__)
+# frozen_string_literal: true
+
+Aruba.platform.require_matching_files('../string/**/*.rb', __FILE__)

data/lib/aruba/platform.rb

@@ -1,5 +1,7 @@
-require "aruba/platforms/unix_platform"
-require "aruba/platforms/windows_platform"
+# frozen_string_literal: true
+
+require 'aruba/platforms/unix_platform'
+require 'aruba/platforms/windows_platform'
 
 # Aruba
 module Aruba

data/lib/aruba/platforms/announcer.rb

@@ -1,7 +1,9 @@
-require "shellwords"
-require "aruba/colorizer"
+# frozen_string_literal: true
 
-Aruba::Colorizer.coloring = false if !$stdout.tty? && !ENV.key?("AUTOTEST")
+require 'shellwords'
+require 'aruba/colorizer'
+
+Aruba::Colorizer.coloring = false if !$stdout.tty? && !ENV.key?('AUTOTEST')
 
 # Aruba
 module Aruba
@@ -81,29 +83,29 @@ module Aruba
       private
 
       def after_init
-        output_format :changed_configuration, proc { |n, v| format("# %s = %s", n, v) }
+        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 :command, "$ %s"
-        output_format :directory, "$ cd %s"
+                      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)) }
+                      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)) }
+                      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)
+                        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 :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",
@@ -111,7 +113,7 @@ module Aruba
                       }
       end
 
-      def output_format(channel, string = "%s", &block)
+      def output_format(channel, string = '%s', &block)
         output_formats[channel.to_sym] = if block
                                            block
                                          elsif string.is_a?(Proc)
@@ -178,7 +180,7 @@ module Aruba
         the_output_format = if output_formats.key? channel
                               output_formats[channel]
                             else
-                              proc { |v| format("%s", v) }
+                              proc { |v| format('%s', v) }
                             end
 
         return unless activated?(channel)

data/lib/aruba/platforms/aruba_file_creator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # Platforms

data/lib/aruba/platforms/aruba_fixed_size_file_creator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # Platforms
@@ -28,7 +30,7 @@ module Aruba
 
         Aruba.platform.mkdir(File.dirname(path))
 
-        File.open(path, "wb") do |f|
+        File.open(path, 'wb') do |f|
           f.seek(size - 1)
           f.write("\0")
         end

data/lib/aruba/platforms/determine_disk_usage.rb

@@ -1,4 +1,6 @@
-require "aruba/file_size"
+# frozen_string_literal: true
+
+require 'aruba/file_size'
 
 module Aruba
   module Platforms

data/lib/aruba/platforms/determine_file_size.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # Platforms

data/lib/aruba/platforms/filesystem_status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aruba
   module Platforms
     # File System Status object
@@ -36,7 +38,7 @@ module Aruba
 
       # Return permissions
       def mode
-        format("%o", status.mode)[-4, 4].gsub(/^0*/, "")
+        format('%o', status.mode)[-4, 4].gsub(/^0*/, '')
       end
 
       # Return owner

data/lib/aruba/platforms/local_environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # Platforms
@@ -6,6 +8,12 @@ module Aruba
     #
     # Wraps logic to make enviroment local and restorable
     class LocalEnvironment
+      def initialize(platform)
+        @platform = platform
+      end
+
+      attr_reader :platform
+
       # Run in environment
       #
       # @param [Hash] env
@@ -14,7 +22,7 @@ module Aruba
       # @yield
       #   The block of code which should with local ENV
       def call(env)
-        old_env = Aruba.platform.environment_variables.hash_from_env
+        old_env = platform.environment_variables.hash_from_env
 
         ENV.clear
         ENV.update env

data/lib/aruba/platforms/simple_table.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # Platforms
@@ -27,12 +29,12 @@ module Aruba
       #   The table
       def to_s
         longest_key = hash.keys.map(&:to_s).max_by(&:length)
-        return "" if longest_key.nil?
+        return '' if longest_key.nil?
 
         name_size = longest_key.length
 
         rows = hash.map do |k, v|
-          format("# %-#{name_size}s => %s", k, v)
+          format('# %-*s => %s', name_size, k, v)
         end
 
         if opts[:sort] == true

data/lib/aruba/platforms/unix_command_string.rb

@@ -1,5 +1,7 @@
-require "delegate"
-require "shellwords"
+# frozen_string_literal: true
+
+require 'delegate'
+require 'shellwords'
 
 # Aruba
 module Aruba

data/lib/aruba/platforms/unix_environment_variables.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Aruba
 module Aruba
   # Platforms
@@ -156,10 +158,10 @@ module Aruba
       end
 
       # Pass on checks
-      def method_missing(name, *args, &block)
+      def method_missing(name, ...)
         super unless to_h.respond_to? name
 
-        to_h.send name, *args, &block
+        to_h.send(name, ...)
       end
 
       # Check for respond_to