aruba 0.7.4 → 0.8.0.pre

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

@@ -0,0 +1,58 @@
+# @!method have_file_content(content)
+#   This matchers checks if <file> has content. `content` can be a string,
+#   regexp or an RSpec matcher.
+#
+#   @param [String, Regexp, Matcher] content
+#     Specifies the content of the file
+#
+#   @return [TrueClass, FalseClass] The result
+#
+#     false:
+#     * if file does not exist
+#     * if file content is not equal string
+#     * if file content does not include regexp
+#     * if file content does not match the content specification
+#
+#     true:
+#     * if file content includes regexp
+#     * if file content is equal string
+#     * if file content matches the content specification
+#
+#   @example Use matcher with string
+#
+#     RSpec.describe do
+#       it { expect(file1).to have_file_content('a') }
+#     end
+#
+#   @example Use matcher with regexp
+#
+#     RSpec.describe do
+#       it { expect(file1).to have_file_content(/a/) }
+#     end
+#
+#   @example Use matcher with an RSpec matcher
+#
+#     RSpec.describe do
+#       it { expect(file1).to have_file_content(a_string_starting_with 'a') }
+#       it { expect(files1).to include a_file_having_content(a_string_starting_with 'a') }
+#     end
+RSpec::Matchers.define :have_file_content do |expected|
+  match do |actual|
+    stop_processes!
+
+    next false unless file? actual
+
+    @actual   = read(actual).join("\n").chomp
+    @expected = if expected.is_a? String
+                  expected.chomp
+                else
+                  expected
+                end
+
+    values_match?(@expected, @actual)
+  end
+
+  description { "have file content: #{description_of expected}" }
+end
+
+RSpec::Matchers.alias_matcher :a_file_having_content, :have_file_content

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

@@ -0,0 +1,43 @@
+# @!method have_file_size(size)
+#   This matchers checks if path has file size
+#
+#   @param [Fixnum] size
+#     The size to check
+#
+#   @return [TrueClass, FalseClass] The result
+#
+#     false:
+#     * if path does not have size
+#     true:
+#     * if path has size
+#
+#   @example Use matcher
+#
+#     RSpec.describe do
+#       it { expect('file.txt').to have_file_size(0) }
+#       it { expect(%w(file.txt file2.txt)).to all have_file_size(0) }
+#       it { expect(%w(file.txt file2.txt)).to include a_file_of_size(0) }
+#     end
+RSpec::Matchers.define :have_file_size do |expected|
+  match do |actual|
+    stop_processes!
+
+    next false unless file?(actual)
+
+    @old_actual = actual
+    @actual = File.size(expand_path(actual))
+    @expected = expected.to_i
+
+    values_match?(@expected, @actual)
+  end
+
+  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)
+  end
+end
+
+RSpec::Matchers.alias_matcher :a_file_of_size, :have_file_size

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

@@ -0,0 +1,44 @@
+require 'fileutils'
+
+# @!method have_same_file_content_like(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
+#
+#     false:
+#     * if file1 is not equal file2
+#     true:
+#     * if file1 is equal file2
+#
+#   @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) }
+#     end
+RSpec::Matchers.define :have_same_file_content_like do |expected|
+  match do |actual|
+    stop_processes!
+
+    next false unless file?(actual) && file?(expected)
+
+    @actual = expand_path(actual)
+    @expected = expand_path(expected)
+
+    FileUtils.compare_file(@actual,@expected)
+  end
+
+  failure_message do |actual|
+    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)
+  end
+end
+
+RSpec::Matchers.alias_matcher :a_file_with_same_content_like, :have_same_file_content_like

data/lib/aruba/matchers/path.rb

@@ -1,99 +1 @@
-# @!method match_path_pattern(pattern)
-#   This matchers checks if <files>/directories match <pattern>
-#
-#   @param [String, Regexp] pattern
-#     The pattern to use.
-#
-#   @return [TrueClass, FalseClass] The result
-#
-#     false:
-#     * if there are no files/directories which match the pattern
-#     true:
-#     * if there are files/directories which match the pattern
-#
-#   @example Use matcher with regex
-#
-#     RSpec.describe do
-#       it { expect(Dir.glob(**/*)).to match_file_pattern(/.txt$/) }
-#     end
-#
-#   @example Use matcher with string
-#
-#     RSpec.describe do
-#       it { expect(Dir.glob(**/*)).to match_file_pattern('.txt$') }
-#     end
-RSpec::Matchers.define :match_path_pattern do |_|
-  match do |actual|
-    next  !actual.select { |a| a == expected }.empty? if expected.is_a? String
-
-    !actual.grep(expected).empty?
-  end
-
-  failure_message do |actual|
-    format("expected that path \"%s\" matches pattern \"%s\".", actual.join(", "), expected)
-  end
-
-  failure_message_when_negated do |actual|
-    format("expected that path \"%s\" does not match pattern \"%s\".", actual.join(", "), expected)
-  end
-end
-
-# @!method be_existing_path
-#   This matchers checks if <path> exists in filesystem
-#
-#   @return [TrueClass, FalseClass] The result
-#
-#     false:
-#     * if path does not exist
-#     true:
-#     * if path exists
-#
-#   @example Use matcher
-#
-#     RSpec.describe do
-#       it { expect(file).to be_existing_path }
-#       it { expect(directory).to be_existing_path }
-#     end
-RSpec::Matchers.define :be_existing_path do |_|
-  match do |actual|
-    exist?(actual)
-  end
-
-  failure_message do |actual|
-    format("expected that path \"%s\" exists", actual)
-  end
-
-  failure_message_when_negated do |actual|
-    format("expected that path \"%s\" does not exist", actual)
-  end
-end
-
-# @!method be_absolute_path
-#   This matchers checks if <path> exists in filesystem
-#
-#   @return [TrueClass, FalseClass] The result
-#
-#     false:
-#     * if path is not absolute
-#     true:
-#     * if path is absolute
-#
-#   @example Use matcher
-#
-#     RSpec.describe do
-#       it { expect(file).to be_absolute_path }
-#       it { expect(directory).to be_absolute_path }
-#     end
-RSpec::Matchers.define :be_absolute_path do |_|
-  match do |actual|
-    absolute?(actual)
-  end
-
-  failure_message do |actual|
-    format("expected that path \"%s\" is absolute, but it's not", actual)
-  end
-
-  failure_message_when_negated do |actual|
-    format("expected that path \"%s\" is not absolute, but it is", actual)
-  end
-end
+Aruba::Platform.require_matching_files('../path/**/*.rb', __FILE__)

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

@@ -0,0 +1,21 @@
+# @!method a_path_matching_pattern(/pattern/)
+#   This matchers checks if <path> matches pattern. `pattern` can be a string,
+#   regexp or an RSpec matcher.
+#
+#   @param [String, Regexp, Matcher] pattern
+#     Specifies the pattern
+#
+#   @return [TrueClass, FalseClass] The result
+#
+#     false:
+#     * if pattern does not match
+#
+#     true:
+#     * if pattern matches
+#
+#   @example Use matcher with regexp
+#
+#     RSpec.describe do
+#       it { expect(files).to include a_path_matching_pattern /asdf/ }
+#     end
+RSpec::Matchers.alias_matcher :a_path_matching_pattern, :match

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

@@ -0,0 +1,32 @@
+# @!method be_an_absolute_path
+#   This matchers checks if <path> exists in filesystem
+#
+#   @return [TrueClass, FalseClass] The result
+#
+#     false:
+#     * if path is not absolute
+#     true:
+#     * if path is absolute
+#
+#   @example Use matcher
+#
+#     RSpec.describe do
+#       it { expect(file).to be_an_absolute_path }
+#       it { expect(directory).to be_an_absolute_path }
+#       it { expect(directories).to include an_absolute_path }
+#     end
+RSpec::Matchers.define :be_an_absolute_path do |_|
+  match do |actual|
+    absolute?(actual)
+  end
+
+  failure_message do |actual|
+    format("expected that path \"%s\" is absolute, but it's not", actual)
+  end
+
+  failure_message_when_negated do |actual|
+    format("expected that path \"%s\" is not absolute, but it is", actual)
+  end
+end
+
+RSpec::Matchers.alias_matcher :an_absolute_path, :be_an_absolute_path

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

@@ -0,0 +1,33 @@
+# @!method be_an_existing_path
+#   This matchers checks if <path> exists in filesystem
+#
+#   @return [TrueClass, FalseClass] The result
+#
+#     false:
+#     * if path does not exist
+#     true:
+#     * if path exists
+#
+#   @example Use matcher
+#
+#     RSpec.describe do
+#       it { expect(file).to be_an_existing_path }
+#       it { expect(directory).to be_an_existing_path }
+#       it { expect(all_directories).to all be_an_existing_path }
+#       it { expect(all_directories).to include an_existing_path }
+#     end
+RSpec::Matchers.define :be_an_existing_path do |_|
+  match do |actual|
+    exist?(actual)
+  end
+
+  failure_message do |actual|
+    format("expected that path \"%s\" exists", actual)
+  end
+
+  failure_message_when_negated do |actual|
+    format("expected that path \"%s\" does not exist", actual)
+  end
+end
+
+RSpec::Matchers.alias_matcher :an_existing_path, :be_an_existing_path

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

@@ -0,0 +1,60 @@
+# @!method have_permissions(permissions)
+#   This matchers checks if <file> or <directory> has <perm> permissions
+#
+#   @param [Fixnum, String] permissions
+#     The permissions as octal number, e.g. `0700`, or String, e.g. `'0700'`
+#
+#   @return [TrueClass, FalseClass] The result
+#
+#     false:
+#     * if file has permissions
+#     true:
+#     * if file does not have permissions
+#
+#   @example Use matcher with octal number
+#
+#     RSpec.describe do
+#       it { expect(file).to have_permissions(0700) }
+#       it { expect(directory).to have_permissions(0700) }
+#     end
+#
+#   @example Use matcher with string
+#
+#     RSpec.describe do
+#       it { expect(file).to have_permissions('0700') }
+#       it { expect(files).to include a_path_with_permissions('0700') }
+#       it { expect(directory).to have_permissions('0700') }
+#       it { expect(directories).to include a_path_with_permissions('0700') }
+#     end
+RSpec::Matchers.define :have_permissions do |expected|
+  def permissions(file)
+    @actual = format("%o", File::Stat.new(file).mode)[-4,4].gsub(/^0*/, '')
+  end
+
+  match do |actual|
+    stop_processes!
+
+    @old_actual = actual
+    @actual = permissions(expand_path(@old_actual))
+
+    @expected = if expected.is_a? Integer
+                  expected.to_s(8)
+                elsif expected.is_a? String
+                  expected.gsub(/^0*/, '')
+                else
+                  expected
+                end
+
+    values_match? @expected, @actual
+  end
+
+  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)
+  end
+end
+
+RSpec::Matchers.alias_matcher :a_path_having_permissions, :have_permissions

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

@@ -0,0 +1,41 @@
+# @!method match_path_pattern(pattern)
+#   This matchers checks if <files>/directories match <pattern>
+#
+#   @param [String, Regexp] pattern
+#     The pattern to use.
+#
+#   @return [TrueClass, FalseClass] The result
+#
+#     false:
+#     * if there are no files/directories which match the pattern
+#     true:
+#     * if there are files/directories which match the pattern
+#
+#   @example Use matcher with regex
+#
+#     RSpec.describe do
+#       it { expect(Dir.glob(**/*)).to match_file_pattern(/.txt$/) }
+#     end
+#
+#   @example Use matcher with string
+#
+#     RSpec.describe do
+#       it { expect(Dir.glob(**/*)).to match_file_pattern('.txt$') }
+#     end
+RSpec::Matchers.define :match_path_pattern do |_|
+  match do |actual|
+    Aruba::Platform.deprecated('The use of `expect().to match_path_pattern` is deprecated. Please use `expect().to include pattern /regex/` instead.')
+
+    next  !actual.select { |a| a == expected }.empty? if expected.is_a? String
+
+    !actual.grep(expected).empty?
+  end
+
+  failure_message do |actual|
+    format("expected that path \"%s\" matches pattern \"%s\".", actual.join(", "), expected)
+  end
+
+  failure_message_when_negated do |actual|
+    format("expected that path \"%s\" does not match pattern \"%s\".", actual.join(", "), expected)
+  end
+end

data/lib/aruba/matchers/rspec_matcher_include_regexp.rb

@@ -18,7 +18,7 @@
 #     end
 RSpec::Matchers.define :include_regexp do |expected|
   match do |actual|
-    warn('The use of "include_regexp"-matchers is deprecated. It will be removed soon.')
+    Aruba::Platform.deprecated('The use of "include_regexp"-matchers is deprecated. It will be removed soon.')
 
     !actual.grep(expected).empty?
   end