assert_dirs_equal 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa4cdc7043d5798e78745e4a6fa8e03659516168
-  data.tar.gz: 54334a10d86c433bafa573757102dbd0a915a906
+  metadata.gz: 002b57d9c03d727d23f6ac8059eb6e1de156be63
+  data.tar.gz: ed8ebb85d512aa507f22f24269f3d2f5cbc90997
 SHA512:
-  metadata.gz: b61f753c46796ed63928ee2f0ab1fe06b1ed0be71f6f6cb6cb180d0e31b9eb8667d993131070938833b247b71d3ed77b31096a14d3dc9d0a2fda6eb2acc3dbaf
-  data.tar.gz: 606d3e449e37a2050a84834363513cb6dfdb576a8e9c02ac73574b800b460136f1bb02b6bdf5c6a4d455ca4a53058645485708100c7e7fc6dc3a894c8f6ecf10
+  metadata.gz: fd82b42b05ce266279c30771d5490bfee1d63e7e113a8bfcbbabd913668010701d474c759f1eef100ab39621c634d64fd737972134e8fa3ee3f82c09d15c7709
+  data.tar.gz: 44a8ccd5535dcca0f4a537dc259b5a98a3c6d54350da07f00be9c0512278648a06605c8bef278e45aae3813806764b03b9ad109aabb4d78e7024c64a86d61282

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Unreleased
 
+### 0.2.0
+
+### Enhancements
+
+* Allow to compare dirs without exact match (i.e. there can be other files and directories inside
+`target_dir` that the matcher won't care about)
+
 ## 0.1.1
 
 ### Bug fixes

data/README.md

@@ -12,7 +12,7 @@ Production ready.
 
 ## Documentation
 
-[Released version](http://rubydoc.info/gems/assert_dirs_equal/0.1.1)
+[Released version](http://rubydoc.info/gems/assert_dirs_equal/0.2.0)
 
 ## Why
 

data/assert_dirs_equal.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "assert_dirs_equal"
-  spec.version       = "0.1.1"
+  spec.version       = "0.2.0"
   spec.authors       = ["Andrii Malyshko"]
   spec.email         = ["mail@nashbridges.me"]
   spec.description   = "Test assertion for directories equality by tree and content comparison"

data/lib/assert_dirs_equal/matcher.rb

@@ -14,12 +14,21 @@ module AssertDirsEqual
     # @return [String]
     attr_reader :failure_message
 
-    def initialize(expected)
+    # @param [String] expected path to a directory which contains expected structure and content.
+    # @param [Hash] options
+    # @option options [Boolean] exact_match (true) specifies whether `expected` should mirror `target`,
+    #   or just be a subset of it.
+    def initialize(expected, options = {})
       @expected = expected
+      @exact_match = options.fetch(:exact_match, true)
     end
 
-    # @return [true] if `target` mirrors subdirectory of `expected` directory.
-    # @return [false] if `target` lacks some files, or has extra files, or any file in subdirectory differs from according file content.
+    # @param [String] target path to a directory which contains result of executing a method under test.
+    # @return [true] when `exact_match` is true and `target` mirrors `expected` directory.
+    # @return [true] when `exact_match` is false and `target` contains all files from `expected` directory.
+    #   Extra files in `target` does not affect the result.
+    # @return [false] if `target` lacks some files, or has extra files (when `exact_match` is true), or any
+    #   file in subdirectory differs from according file content.
     def matches?(target)
       @target = target
       assert_exists(@expected) && assert_exists(@target) &&
@@ -28,9 +37,14 @@ module AssertDirsEqual
         refute_extra_files_in_target
     end
 
+    # @!attribute [r]
     # @return [String]
     def failure_message_when_negated
-      "expected #{@target.inspect} to not be equal to #{@expected.inspect}, but they are equal"
+      if @exact_match
+        "expected #{@target.inspect} to not be equal to #{@expected.inspect}, but they are equal"
+      else
+        "expected files from #{@target.inspect} to not be present in #{@expected.inspect}, but they are"
+      end
     end
 
     private
@@ -69,6 +83,8 @@ module AssertDirsEqual
     end
 
     def refute_extra_files_in_target
+      return true unless @exact_match
+
       expected_files = both_paths_in(@expected, @target).map { |pair| pair[1] }
       actual_expected_files = Dir.glob(File.join(@target, "**/*"))
       diff = actual_expected_files - expected_files

data/lib/minitest/assert_dirs_equal.rb

@@ -12,13 +12,47 @@ module AssertDirsEqual
 end
 
 class Minitest::Test
+  # Fails if `target` lacks some files, or has extra files, or any file in the directory differs
+  # from according content in `expected`.
+  #
+  # @param [String] expected path to a directory which contains expected structure and content.
+  # @param [String] target path to a directory which contains result of executing a method under test.
+  # @raise [Minitest::Assertion]
+  # @since 0.1.0
   def assert_dirs_equal(expected, target)
     matcher = AssertDirsEqual::Matcher.new(expected)
     assert matcher.matches?(target), matcher.failure_message
   end
 
+  # Fails if `target` has exactly the same file tree structure and content.
+  #
+  # @param (see #assert_dirs_equal)
+  # @raise [Minitest::Assertion]
+  # @since 0.1.0
   def refute_dirs_equal(expected, target)
     matcher = AssertDirsEqual::Matcher.new(expected)
     refute matcher.matches?(target), matcher.failure_message_when_negated
   end
+
+  # Fails if `target` lacks some files, or any file in the directory differs from according content
+  # in `expected`. Should be read as 'Content from `expected` is expected to be "included" in `target`'.
+  # @note Extra files in `target` are ignored.
+  #
+  # @param (see #assert_dirs_equal)
+  # @raise [Minitest::Assertion]
+  # @since 0.2.0
+  def assert_dir_included(expected, target)
+    matcher = AssertDirsEqual::Matcher.new(expected, exact_match: false)
+    assert matcher.matches?(target), matcher.failure_message
+  end
+
+  # Fails if `target` includes the same files from `expected`.
+  # @note Extra files in `target` are ignored.
+  #
+  # @param (see #assert_dirs_equal)
+  # @since 0.2.0
+  def refute_dir_included(expected, target)
+    matcher = AssertDirsEqual::Matcher.new(expected, exact_match: false)
+    refute matcher.matches?(target), matcher.failure_message_when_negated
+  end
 end

data/test/matcher_test.rb

@@ -2,7 +2,7 @@ require "test_helper"
 require "assert_dirs_equal/matcher"
 
 module AssertDirsEqual
-  class MatcherTest < Minitest::Test
+  class MatcherEqTest < Minitest::Test
     def matcher
       @matcher ||= Matcher.new(expected_dir)
     end
@@ -100,4 +100,21 @@ MSG
       assert_equal "expected \"#{target_dir}\" to not be equal to \"#{expected_dir}\", but they are equal", matcher.failure_message_when_negated
     end
   end
+
+  class MatcherIncludesTest < MatcherEqTest
+    def matcher
+      @matcher ||= Matcher.new(expected_dir, exact_match: false)
+    end
+
+    def test_extra_file_in_target
+      @case_directory = "test/cases/extra_file_in_target"
+      assert matcher.matches?(target_dir), matcher.failure_message
+    end
+
+    def test_failure_message_negated
+      @case_directory = "test/cases/empty_dirs_are_equal"
+      matcher.matches?(target_dir)
+      assert_equal "expected files from \"#{target_dir}\" to not be present in \"#{expected_dir}\", but they are", matcher.failure_message_when_negated
+    end
+  end
 end

data/test/minitest_integration_test.rb

@@ -3,12 +3,12 @@ require "minitest/assert_dirs_equal"
 
 module AssertDirsEqual
   class MinitestIntegrationTest < Minitest::Test
-    def test_successful_assert
+    def test_successful_assert_dirs_equal
       @case_directory = "test/cases/empty_files_are_equal"
       assert_dirs_equal expected_dir, target_dir
     end
 
-    def test_failed_assert
+    def test_failed_assert_dirs_equal
       @case_directory = "test/cases/missing_expected"
 
       error = assert_raises(Minitest::Assertion) do
@@ -18,12 +18,12 @@ module AssertDirsEqual
       assert_equal "expected \"#{expected_dir}\" to exist", error.message
     end
 
-    def test_successful_refute
+    def test_successful_refute_dirs_equal
       @case_directory = "test/cases/missing_expected"
       refute_dirs_equal expected_dir, target_dir
     end
 
-    def test_failed_refute
+    def test_failed_refute_dirs_equal
       @case_directory = "test/cases/empty_files_are_equal"
 
       error = assert_raises(Minitest::Assertion) do
@@ -33,6 +33,36 @@ module AssertDirsEqual
       assert_equal "expected \"#{target_dir}\" to not be equal to \"#{expected_dir}\", but they are equal", error.message
     end
 
+    def test_successful_assert_dir_included
+      @case_directory = "test/cases/extra_file_in_target"
+      assert_dir_included expected_dir, target_dir
+    end
+
+    def test_failed_assert_dir_included
+      @case_directory = "test/cases/missing_expected"
+
+      error = assert_raises(Minitest::Assertion) do
+        assert_dir_included expected_dir, target_dir
+      end
+
+      assert_equal "expected \"#{expected_dir}\" to exist", error.message
+    end
+
+    def test_successful_refute_dir_included
+      @case_directory = "test/cases/missing_expected"
+      refute_dir_included expected_dir, target_dir
+    end
+
+    def test_failed_refute_dir_included
+      @case_directory = "test/cases/empty_files_are_equal"
+
+      error = assert_raises(Minitest::Assertion) do
+        refute_dir_included expected_dir, target_dir
+      end
+
+      assert_equal "expected files from \"#{target_dir}\" to not be present in \"#{expected_dir}\", but they are", error.message
+    end
+
     def test_minitest_powered_diff
       @case_directory = "test/cases/large_different_text_files"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assert_dirs_equal
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrii Malyshko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-02 00:00:00.000000000 Z
+date: 2016-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,7 +82,9 @@ files:
 - test/cases/expected_is_not_a_dir/expected
 - test/cases/expected_is_not_a_dir/target/.keep
 - test/cases/extra_file_in_target/expected/.keep
+- test/cases/extra_file_in_target/expected/common_file
 - test/cases/extra_file_in_target/target/.keep
+- test/cases/extra_file_in_target/target/common_file
 - test/cases/extra_file_in_target/target/file
 - test/cases/large_different_text_files/expected/file
 - test/cases/large_different_text_files/target/file
@@ -139,7 +141,9 @@ test_files:
 - test/cases/expected_is_not_a_dir/expected
 - test/cases/expected_is_not_a_dir/target/.keep
 - test/cases/extra_file_in_target/expected/.keep
+- test/cases/extra_file_in_target/expected/common_file
 - test/cases/extra_file_in_target/target/.keep
+- test/cases/extra_file_in_target/target/common_file
 - test/cases/extra_file_in_target/target/file
 - test/cases/large_different_text_files/expected/file
 - test/cases/large_different_text_files/target/file