aruba 1.0.0.pre.alpha.2 → 1.0.1

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

@@ -4,7 +4,7 @@
 #   @param [Integer] status
 #     The value of the exit status
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if command does not have exit status
@@ -23,16 +23,28 @@ RSpec::Matchers.define :have_exit_status do |expected|
     @old_actual.stop
     @actual = actual.exit_status
 
-    next false 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
 
   failure_message do |actual|
-    format(%(expected that command "%s" has exit status of "%s", but has "%s".), @old_actual.commandline, expected.to_s, actual.to_s)
+    format(
+      %(expected that command "%s" has exit status of "%s", but has "%s".),
+      @old_actual.commandline,
+      expected.to_s,
+      actual.to_s
+    )
   end
 
   failure_message_when_negated do |actual|
-    format(%(expected that command "%s" does not have exit status of "%s", but has "%s".), @old_actual.commandline, expected.to_s, actual.to_s)
+    format(
+      %(expected that command "%s" does not have exit status of "%s", but has "%s".),
+      @old_actual.commandline,
+      expected.to_s,
+      actual.to_s
+    )
   end
 end

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

@@ -4,7 +4,7 @@ require 'rspec/expectations/version'
 #   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.
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if command not to run too long
@@ -24,7 +24,9 @@ RSpec::Matchers.define :have_finished_in_time do
     @old_actual = actual
     @actual     = @old_actual.commandline
 
-    next false 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
 
@@ -32,6 +34,4 @@ RSpec::Matchers.define :have_finished_in_time do
   end
 end
 
-if RSpec::Expectations::Version::STRING >= '3.1'
-  RSpec::Matchers.define_negated_matcher :run_too_long, :have_finished_in_time
-end
+RSpec::Matchers.define_negated_matcher :run_too_long, :have_finished_in_time

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

@@ -1,7 +1,9 @@
+require 'aruba/matchers/base/message_indenter'
+
 # @!method have_output
 #   This matchers checks if <command> has created output
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if command has not created output
@@ -17,7 +19,9 @@ RSpec::Matchers.define :have_output do |expected|
   match do |actual|
     @old_actual = actual
 
-    next false unless @old_actual.respond_to? :output
+    unless @old_actual.respond_to? :output
+      raise "Expected #{@old_actual} to respond to #output"
+    end
 
     @old_actual.stop
 
@@ -29,8 +33,11 @@ RSpec::Matchers.define :have_output do |expected|
   diffable
 
   description { "have output: #{description_of expected}" }
-end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :a_command_having_output, :have_output
+  failure_message do |_actual|
+    "expected `#{@old_actual.commandline}` to have output #{description_of expected}\n" \
+      "but was:\n#{Aruba::Matchers::Base::MessageIndenter.indent_multiline_message @actual}"
+  end
 end
+
+RSpec::Matchers.alias_matcher :a_command_having_output, :have_output

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

@@ -1,7 +1,7 @@
 # @!method have_output_on_stderr
 #   This matchers checks if <command> has created output on stderr
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if command has not created output on stderr
@@ -17,7 +17,9 @@ RSpec::Matchers.define :have_output_on_stderr do |expected|
   match do |actual|
     @old_actual = actual
 
-    next false 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

@@ -1,7 +1,7 @@
 # @!method have_output_on_stdout
 #   This matchers checks if <command> has created output on stdout
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if command has not created output on stdout
@@ -17,7 +17,9 @@ RSpec::Matchers.define :have_output_on_stdout do |expected|
   match do |actual|
     @old_actual = actual
 
-    next false 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/command/have_output_size.rb

@@ -4,7 +4,7 @@
 #   @param [String] output
 #     The content which should be checked
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if output does not have size
@@ -18,7 +18,7 @@
 #     end
 RSpec::Matchers.define :have_output_size do |expected|
   match do |actual|
-    next false unless actual.respond_to? :size
+    raise "Expected #{actual} to respond to #size" unless actual.respond_to? :size
 
     @actual = actual.size
     values_match? expected, @actual

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

@@ -3,7 +3,7 @@ require 'rspec/expectations/version'
 # @!method be_an_existing_directory
 #   This matchers checks if <directory> exists in filesystem
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if directory does not exist
@@ -19,20 +19,18 @@ RSpec::Matchers.define :be_an_existing_directory do |_|
   match do |actual|
     stop_all_commands
 
-    next false unless actual.is_a? String
+    raise 'String expected' unless actual.is_a? String
 
     directory?(actual)
   end
 
   failure_message do |actual|
-    format("expected that directory \"%s\" exists", actual)
+    format('expected that directory "%s" exists', actual)
   end
 
   failure_message_when_negated do |actual|
-    format("expected that directory \"%s\" does not exist", actual)
+    format('expected that directory "%s" does not exist', actual)
   end
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :an_existing_directory, :be_an_existing_directory
-end
+RSpec::Matchers.alias_matcher :an_existing_directory, :be_an_existing_directory

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

@@ -6,7 +6,7 @@ require 'rspec/expectations/version'
 #   @param [Array] sub_directory
 #      A list of sub-directory relative to current directory
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if directory does not have sub-directory
@@ -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,14 +41,16 @@ 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
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :a_directory_having_sub_directory, :have_sub_directory
-end
+RSpec::Matchers.alias_matcher :a_directory_having_sub_directory, :have_sub_directory

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

@@ -3,7 +3,7 @@ require 'rspec/expectations/version'
 # @!method be_a_command_found_in_path
 #   This matchers checks if <command> can be found in path
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if command was not found in PATH
@@ -31,6 +31,4 @@ RSpec::Matchers.define :be_a_command_found_in_path do
   end
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :a_command_found_in_path, :be_a_command_found_in_path
-end
+RSpec::Matchers.alias_matcher :a_command_found_in_path, :be_a_command_found_in_path

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

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

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

@@ -3,7 +3,7 @@ require 'rspec/expectations/version'
 # @!method be_an_existing_file
 #   This matchers checks if <file> exists in filesystem
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if file does not exist
@@ -19,20 +19,18 @@ RSpec::Matchers.define :be_an_existing_file do |_|
   match do |actual|
     stop_all_commands
 
-    next false unless actual.is_a? String
+    raise 'String expected' unless actual.is_a? String
 
     file?(actual)
   end
 
   failure_message do |actual|
-    format("expected that file \"%s\" exists", actual)
+    format('expected that file "%s" exists', actual)
   end
 
   failure_message_when_negated do |actual|
-    format("expected that file \"%s\" does not exist", actual)
+    format('expected that file "%s" does not exist', actual)
   end
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :an_existing_file, :be_an_existing_file
-end
+RSpec::Matchers.alias_matcher :an_existing_file, :be_an_existing_file

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

@@ -7,7 +7,7 @@ require 'rspec/expectations/version'
 #   @param [String, Regexp, Matcher] content
 #     Specifies the content of the file
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if file does not exist
@@ -54,9 +54,9 @@ RSpec::Matchers.define :have_file_content do |expected|
     values_match?(@expected, @actual)
   end
 
+  diffable if expected.is_a? String
+
   description { "have file content: #{description_of expected}" }
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :a_file_having_content, :have_file_content
-end
+RSpec::Matchers.alias_matcher :a_file_having_content, :have_file_content

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

@@ -6,7 +6,7 @@ require 'rspec/expectations/version'
 #   @param [Fixnum] size
 #     The size to check
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if path does not have size
@@ -33,15 +33,15 @@ RSpec::Matchers.define :have_file_size do |expected|
     values_match?(@expected, @actual)
   end
 
-  failure_message do |actual|
-    format("expected that file \"%s\" has size \"%s\", but has \"%s\"", @old_actual, @actual, @expected)
+  failure_message do |_actual|
+    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)
+  failure_message_when_negated do |_actual|
+    format('expected that file "%s" does not have size "%s", but has "%s"',
+           @old_actual, @actual, @expected)
   end
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :a_file_of_size, :have_file_size
-end
+RSpec::Matchers.alias_matcher :a_file_of_size, :have_file_size

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

@@ -1,15 +1,14 @@
 require 'rspec/expectations/version'
-
 require 'fileutils'
 
-# @!method have_same_file_content_like(file_name)
+# @!method have_same_file_content_as(file_name)
 #   This matchers checks if <file1> has the same content like <file2>
 #
 #   @param [String] file_name
 #     The name of the file which should be compared with the file in the
 #     `expect()`-call.
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if file1 is not equal file2
@@ -19,10 +18,10 @@ require 'fileutils'
 #   @example Use matcher
 #
 #     RSpec.describe do
-#       it { expect(file1).to have_same_file_content_like(file2) }
-#       it { expect(files).to include a_file_with_same_content_like(file2) }
+#       it { expect(file1).to have_same_file_content_as(file2) }
+#       it { expect(files).to include a_file_with_same_content_as(file2) }
 #     end
-RSpec::Matchers.define :have_same_file_content_like do |expected|
+RSpec::Matchers.define :have_same_file_content_as do |expected|
   match do |actual|
     stop_all_commands
 
@@ -31,18 +30,16 @@ RSpec::Matchers.define :have_same_file_content_like do |expected|
     @actual = expand_path(actual)
     @expected = expand_path(expected)
 
-    FileUtils.compare_file(@actual,@expected)
+    FileUtils.compare_file(@actual, @expected)
   end
 
   failure_message do |actual|
-    format("expected that file \"%s\" is the same as file \"%s\".", actual, expected)
+    format('expected that file "%s" is the same as file "%s".', actual, expected)
   end
 
   failure_message_when_negated do |actual|
-    format("expected that file \"%s\" differs from file \"%s\".", actual, expected)
+    format('expected that file "%s" differs from file "%s".', actual, expected)
   end
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :a_file_with_same_content_like, :have_same_file_content_like
-end
+RSpec::Matchers.alias_matcher :a_file_with_same_content_as, :have_same_file_content_as

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

@@ -7,7 +7,7 @@ require 'rspec/expectations/version'
 #   @param [String, Regexp, Matcher] pattern
 #     Specifies the pattern
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if pattern does not match
@@ -20,6 +20,4 @@ require 'rspec/expectations/version'
 #     RSpec.describe do
 #       it { expect(files).to include a_path_matching_pattern /asdf/ }
 #     end
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :a_path_matching_pattern, :match
-end
+RSpec::Matchers.alias_matcher :a_path_matching_pattern, :match

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

@@ -3,7 +3,7 @@ require 'rspec/expectations/version'
 # @!method be_an_absolute_path
 #   This matchers checks if <path> exists in filesystem
 #
-#   @return [TrueClass, FalseClass] The result
+#   @return [Boolean] The result
 #
 #     false:
 #     * if path is not absolute
@@ -27,10 +27,8 @@ RSpec::Matchers.define :be_an_absolute_path do |_|
   end
 
   failure_message_when_negated do |actual|
-    format("expected that path \"%s\" is not absolute, but it is", actual)
+    format('expected that path "%s" is not absolute, but it is', actual)
   end
 end
 
-if RSpec::Expectations::Version::STRING >= '3.0'
-  RSpec::Matchers.alias_matcher :an_absolute_path, :be_an_absolute_path
-end
+RSpec::Matchers.alias_matcher :an_absolute_path, :be_an_absolute_path