aruba 1.0.0.pre.alpha.2 → 1.0.1

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

@@ -3,7 +3,7 @@ require 'rspec/expectations/version'
 # @!method be_an_existing_path
 #   This matchers checks if <path> exists in filesystem
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if path does not exist
@@ -24,14 +24,12 @@ RSpec::Matchers.define :be_an_existing_path do |_|
   end
 
   failure_message do |actual|
-    format("expected that path \"%s\" exists", actual)
+    format('expected that path "%s" exists', actual)
   end
 
   failure_message_when_negated do |actual|
-    format("expected that path \"%s\" does not exist", actual)
+    format('expected that path "%s" does not exist', actual)
   end
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :an_existing_path, :be_an_existing_path
-end
+RSpec::Matchers.alias_matcher :an_existing_path, :be_an_existing_path

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

@@ -6,7 +6,7 @@ require 'rspec/expectations/version'
 #   @param [Fixnum, String] permissions
 #     The permissions as octal number, e.g. `0700`, or String, e.g. `'0700'`
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if file has permissions
@@ -50,15 +50,15 @@ RSpec::Matchers.define :have_permissions do |expected|
     values_match? @expected, @actual
   end
 
-  failure_message do |actual|
-    format("expected that path \"%s\" has permissions \"%s\", but has \"%s\".", @old_actual, @expected, @actual)
+  failure_message do |_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)
+  failure_message_when_negated do |_actual|
+    format('expected that path "%s" does not have permissions "%s", but has "%s".',
+           @old_actual, @expected, @actual)
   end
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :a_path_having_permissions, :have_permissions
-end
+RSpec::Matchers.alias_matcher :a_path_having_permissions, :have_permissions

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

@@ -1,24 +1,24 @@
 # @!method include_output_string(string)
 #   This matchers checks if the output string of a command includes string.
 #
-#   @param [Integer] status
-#     The value of the exit status
+#   @param [String] string
+#     The value of the output string
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
-#     false:
+#     False:
 #     * if the output string does not include string
-#     true:
+#     True:
 #     * if the output string includes string
 #
 #   @example Use matcher
-#
 #     RSpec.describe do
 #       it { expect(last_command_started).to have_output an_output_string_including string) }
 #       it { expect(last_command_started).to have_output include_output_string string) }
 #     end
 RSpec::Matchers.define :include_output_string do |expected|
   match do |actual|
+    actual.force_encoding('UTF-8')
     @expected = Regexp.new(Regexp.escape(sanitize_text(expected.to_s)), Regexp::MULTILINE)
     @actual   = sanitize_text(actual)
 
@@ -30,7 +30,5 @@ RSpec::Matchers.define :include_output_string do |expected|
   description { "string includes: #{description_of expected}" }
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :an_output_string_including, :include_output_string
-  RSpec::Matchers.alias_matcher :file_content_including, :include_output_string
-end
+RSpec::Matchers.alias_matcher :an_output_string_including, :include_output_string
+RSpec::Matchers.alias_matcher :file_content_including, :include_output_string

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

@@ -1,24 +1,24 @@
 # @!method match_output_string(string)
 #   This matchers checks if the output string of a command matches regular expression.
 #
-#   @param [Integer] status
-#     The value of the exit status
+#   @param [String] string
+#     The value of the output string
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
-#     false:
+#     False:
 #     * if the output string does not match regex
-#     true:
+#     True:
 #     * if the output string matches regex
 #
 #   @example Use matcher
-#
 #     RSpec.describe do
 #       it { expect(last_command_started).to have_output an_output_string_matching regex) }
 #       it { expect(last_command_started).to have_output match_output_string regex) }
 #     end
 RSpec::Matchers.define :match_output_string do |expected|
   match do |actual|
+    actual.force_encoding('UTF-8')
     @expected = Regexp.new(unescape_text(expected), Regexp::MULTILINE)
     @actual   = sanitize_text(actual)
 
@@ -30,8 +30,6 @@ RSpec::Matchers.define :match_output_string do |expected|
   description { "output string matches: #{description_of expected}" }
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :an_output_string_matching, :match_output_string
-  RSpec::Matchers.alias_matcher :a_file_name_matching, :match_output_string
-  RSpec::Matchers.alias_matcher :file_content_matching, :match_output_string
-end
+RSpec::Matchers.alias_matcher :an_output_string_matching, :match_output_string
+RSpec::Matchers.alias_matcher :a_file_name_matching, :match_output_string
+RSpec::Matchers.alias_matcher :file_content_matching, :match_output_string

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

@@ -1,24 +1,24 @@
 # @!method output_string_eq(string)
 #   This matchers checks if the output string of a command includes string.
 #
-#   @param [Integer] status
-#     The value of the exit status
+#   @param [String] string
+#     The value of the output string
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean]
 #
-#     false:
+#     False:
 #     * if the output string does not include string
-#     true:
+#     True:
 #     * if the output string includes string
 #
 #   @example Use matcher
-#
 #     RSpec.describe do
 #       it { expect(last_command_started).to have_output output_string_eq string) }
 #       it { expect(last_command_started).to have_output an_output_string_begin_eq string) }
 #     end
 RSpec::Matchers.define :output_string_eq do |expected|
   match do |actual|
+    actual.force_encoding('UTF-8')
     @expected = sanitize_text(expected.to_s)
     @actual   = sanitize_text(actual.to_s)
 
@@ -30,6 +30,4 @@ RSpec::Matchers.define :output_string_eq do |expected|
   description { "output string is eq: #{description_of expected}" }
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :an_output_string_being_eq, :output_string_eq
-end
+RSpec::Matchers.alias_matcher :an_output_string_being_eq, :output_string_eq

data/lib/aruba/platform.rb

@@ -1,20 +1,12 @@
-require 'thread'
 require 'aruba/platforms/unix_platform'
 require 'aruba/platforms/windows_platform'
 
 # Aruba
 module Aruba
   PLATFORM_MUTEX = Mutex.new
-end
 
-# Aruba
-module Aruba
-  # Platform
   Platform = [Platforms::WindowsPlatform, Platforms::UnixPlatform].find(&:match?)
-end
 
-# Aruba
-module Aruba
   PLATFORM_MUTEX.synchronize do
     @platform = Platform.new
   end

data/lib/aruba/platforms/announcer.rb

@@ -1,7 +1,7 @@
 require 'shellwords'
 require 'aruba/colorizer'
 
-Aruba::AnsiColor.coloring = false if !STDOUT.tty? && !ENV.key?("AUTOTEST")
+Aruba::Colorizer.coloring = false if !STDOUT.tty? && !ENV.key?('AUTOTEST')
 
 # Aruba
 module Aruba
@@ -21,31 +21,40 @@ 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')
     #
     class Announcer
+      # Base Announcer class
+      class BaseAnnouncer
+        def mode?(m)
+          mode == m
+        end
+      end
+
       # Announcer using Kernel.puts
-      class KernelPutsAnnouncer
+      class KernelPutsAnnouncer < BaseAnnouncer
         def announce(message)
           Kernel.puts message
         end
 
-        def mode?(m)
-          :kernel_puts == m
+        def mode
+          :kernel_puts
         end
       end
 
       # Announcer using Main#puts
-      class PutsAnnouncer
+      class PutsAnnouncer < BaseAnnouncer
         def announce(message)
           puts message
         end
 
-        def mode?(m)
-          :puts == m
+        def mode
+          :puts
         end
       end
 
@@ -55,7 +64,7 @@ module Aruba
 
       public
 
-      def initialize(*args)
+      def initialize
         @announcers = []
         @announcers << PutsAnnouncer.new
         @announcers << KernelPutsAnnouncer.new
@@ -66,56 +75,41 @@ module Aruba
         @channels          = {}
         @output_formats    = {}
 
-        @options           = args[1] || {}
-
         after_init
       end
 
       private
 
-      # rubocop:disable Metrics/MethodLength
       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'
-        # rubocop:disable Metrics/LineLength
-        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)) }
-        # rubocop:enable Metrics/LineLength
-
-        # rubocop:disable Metrics/LineLength
-        if @options[:stdout]
-          warn('The use of "@announce_stdout-instance" variable and "options[:stdout] = true" for Announcer.new is deprecated. Please use "announcer.activate(:stdout)" instead.')
-          activate :stdout
-        end
-        if @options[:stderr]
-          warn('The use of "@announce_stderr-instance" variable and "options[:stderr] = true" for Announcer.new is deprecated. Please use "announcer.activate(:stderr)" instead.')
-          activate :stderr
-        end
-        if @options[:dir]
-          warn('The use of "@announce_dir-instance" variable and "options[:dir] = true" for Announcer.new is deprecated. Please use "announcer.activate(:directory)" instead.')
-          activate :directory
-        end
-        if @options[:cmd]
-          warn('The use of "@announce_cmd-instance" variable and "options[:cmd] = true" for Announcer.new is deprecated. Please use "announcer.activate(:command)" instead.')
-          activate :command
-        end
-        if @options[:env]
-          warn('The use of "@announce_env-instance" variable and "options[:env] = true" for Announcer.new is deprecated. Please use "announcer.activate(:modified_environment)" instead.')
-          activate :modified_enviroment
-        end
-        # rubocop:enable Metrics/LineLength
+        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
-      # rubocop:enable Metrics/MethodLength
 
       def output_format(channel, string = '%s', &block)
         output_formats[channel.to_sym] = if block_given?
@@ -139,11 +133,18 @@ module Aruba
       # @param [Symbol] m
       #   The mode to set
       def mode=(m)
-        @announcer = @announcers.find { |a| f.mode? m.to_sym }
+        @announcer = @announcers.find { |a| a.mode? m.to_sym }
 
         self
       end
 
+      # Fecth mode of announcer
+      #
+      # @return [Symbol] The current announcer mode
+      def mode
+        @announcer.mode
+      end
+
       # Check if channel is activated
       #
       # @param [Symbol] channel
@@ -154,7 +155,7 @@ module Aruba
 
       # Activate a channel
       #
-      # @param [Symbol] channel
+      # @param [Symbol] chns
       #   The name of the channel to activate
       def activate(*chns)
         chns.flatten.each { |c| channels[c.to_sym] = true }
@@ -173,7 +174,7 @@ module Aruba
       # @yield
       #   If block is given, that one is called and the return value is used as
       #   message to be announced.
-      def announce(channel, *args, &block)
+      def announce(channel, *args)
         channel = channel.to_sym
 
         the_output_format = if output_formats.key? channel
@@ -184,49 +185,23 @@ module Aruba
 
         return unless activated?(channel)
 
-        message = if block_given?
-                    the_output_format.call(yield)
-                  else
-                    the_output_format.call(*args)
-                  end
-        message += "\n"
-        message = colorizer.cyan(message)
+        begin
+          if block_given?
+            value = yield
+            args << value
+          end
+
+          message = the_output_format.call(*args)
+          message += "\n"
+          message = colorizer.cyan(message)
+        rescue NotImplementedError => e
+          message = "Error fetching announced value for #{channel}: #{e.message}"
+        end
 
         announcer.announce(message)
 
         nil
       end
-
-      # @deprecated
-      def stdout(content)
-        warn('The announcer now has a new api to activate channels. Please use this one: announce(:stdout, message)')
-        announce :stdout, content
-      end
-
-      # @deprecated
-      def stderr(content)
-        warn('The announcer now has a new api to activate channels. Please use this one: announce(:stderr, message)')
-        announce :stderr, content
-      end
-
-      # @deprecated
-      def dir(dir)
-        warn('The announcer now has a new api to activate channels. Please use this one announce(:directory, message)')
-        announce :directory, dir
-      end
-
-      # @deprecated
-      def cmd(cmd)
-        warn('The announcer now has a new api to activate channels. Please use this one announce(:command, message)')
-        announce :command, cmd
-      end
-
-      # @deprecated
-      def env(name, value)
-        warn('The announcer now has a new api to activate channels. Please use this one: announce(:changed_environment, key, value)')
-
-        announce :changed_environment, name, value
-      end
     end
   end
 end

data/lib/aruba/platforms/aruba_file_creator.rb

@@ -15,10 +15,12 @@ module Aruba
       # @param [Object] content
       #   The content of the file
       #
-      # @param [TrueClass, FalseClass] check_presence (false)
+      # @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))