assert_dirs_equal 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 002b57d9c03d727d23f6ac8059eb6e1de156be63
-  data.tar.gz: ed8ebb85d512aa507f22f24269f3d2f5cbc90997
+  metadata.gz: 997e5ede3b2a6e68211dc6eccb594b7463ed616a
+  data.tar.gz: da6a2c8807685d0cfb40e01b8bdefa3b8375e27d
 SHA512:
-  metadata.gz: fd82b42b05ce266279c30771d5490bfee1d63e7e113a8bfcbbabd913668010701d474c759f1eef100ab39621c634d64fd737972134e8fa3ee3f82c09d15c7709
-  data.tar.gz: 44a8ccd5535dcca0f4a537dc259b5a98a3c6d54350da07f00be9c0512278648a06605c8bef278e45aae3813806764b03b9ad109aabb4d78e7024c64a86d61282
+  metadata.gz: 001f3da0d0a268910f316196d90c1ff0dd48eabb0796cac42753ef55166d6f53fc184d7db09d3e9e5a50c62e48c3574943095ac8b00966a5ba9b9d2d36f3b411
+  data.tar.gz: 8031936c26969471a6a6bf80db2dc7dae9bf04eeb45768c370055424faa0d82a9b4ffa9dc78b5699d73cfe290292a8c85060ffe23251b3447cc73ee9338d0fc5

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1
   - 2.2
+  - 2.3
+  - 2.4
   - jruby-19mode
-  - rbx-2
+  - rbx-3
 bundler_args: --without doc debug

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## Unreleased
 
-### 0.2.0
+## 0.3.0
+
+### Enhancements
+
+* Allow to provide glob patterns in file names
+
+## 0.2.0
 
 ### Enhancements
 

data/README.md

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

data/assert_dirs_equal.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "assert_dirs_equal"
-  spec.version       = "0.2.0"
+  spec.version       = "0.3.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

@@ -1,3 +1,5 @@
+require "cgi"
+
 # @since 0.1.0
 module AssertDirsEqual
   class Diff
@@ -23,6 +25,21 @@ module AssertDirsEqual
       @exact_match = options.fetch(:exact_match, true)
     end
 
+    # Takes each file that exists in `expected` directory and expects to find exactly the same (by name and
+    # by content) file in `target` directory.
+    #
+    # Since 0.3.0 you can use {https://ruby-doc.org/core-2.2.3/Dir.html#method-c-glob glob patterns} in a filename.
+    # This is handy, for example, than you match fingerprinted files and don't want to deal with fingerprinting
+    # algorithm. Pattern should be {https://en.wikipedia.org/wiki/Percent-encoding percent-encoded}. Make sure it is
+    # strict enough to match only one file in `target` directory.
+    #
+    # @example Using percent-encoded glob patterns in filenames (file*.txt)
+    #     expected\
+    #       file%2A.txt
+    #
+    #     target\
+    #       file_that_will_be_matched.txt
+    #
     # @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.
@@ -49,8 +66,19 @@ module AssertDirsEqual
 
     private
 
+    def first_with_glob(path)
+      Dir.glob(path).first
+    end
+
     def assert_exists(path, msg = nil)
-      File.exist?(path) || fail_with(msg || "expected #{path.inspect} to exist")
+      actual_paths = Dir.glob(path)
+
+      case actual_paths.size
+      when 0 then fail_with(msg || "expected #{path.inspect} to exist")
+      when 1 then true
+      else
+        fail_with("found multiple matches for #{path.inspect}, should be just one of the following #{actual_paths.map(&:inspect).join(", ")}")
+      end
     end
 
     def assert_directory(directory)
@@ -61,7 +89,7 @@ module AssertDirsEqual
       return true if File.directory?(expected) && File.directory?(target)
 
       expected_content = File.read(expected)
-      target_content = File.read(target)
+      target_content = File.read(first_with_glob(target))
 
       expected_content = expected_content.strip
       target_content = target_content.strip
@@ -85,7 +113,7 @@ module AssertDirsEqual
     def refute_extra_files_in_target
       return true unless @exact_match
 
-      expected_files = both_paths_in(@expected, @target).map { |pair| pair[1] }
+      expected_files = both_paths_in(@expected, @target).map { |(_, target_path)| first_with_glob(target_path) }
       actual_expected_files = Dir.glob(File.join(@target, "**/*"))
       diff = actual_expected_files - expected_files
       diff.empty? || fail_with("found unexpected files #{diff.inspect}")
@@ -101,7 +129,7 @@ module AssertDirsEqual
         glob = File.join(expected, "**/*")
         Dir.glob(glob).each do |expected_full_path|
           path = expected_full_path.sub(expected, "")
-          target_full_path = File.join(target, path)
+          target_full_path = File.join(target, CGI.unescape(path))
           y << [expected_full_path, target_full_path]
         end
       end

data/test/cases/glob_filename_matches_exactly_once/expected/%7Bone%2Ctwo%7D.txt

@@ -0,0 +1 @@
+hello

data/test/cases/glob_filename_matches_exactly_once/target/two.txt

@@ -0,0 +1 @@
+hello

data/test/cases/glob_filename_matches_more_than_once/expected/%7Bone%2Ctwo%7D.txt

@@ -0,0 +1 @@
+hello

data/test/cases/glob_filename_matches_more_than_once/target/one.txt

@@ -0,0 +1 @@
+hello

data/test/cases/glob_filename_matches_more_than_once/target/two.txt

@@ -0,0 +1 @@
+hello

data/test/cases/glob_filename_missing_file/expected/%7Bone%2Ctwo%7D.txt

@@ -0,0 +1 @@
+hello

data/test/matcher_test.rb

@@ -99,6 +99,23 @@ MSG
       matcher.matches?(target_dir)
       assert_equal "expected \"#{target_dir}\" to not be equal to \"#{expected_dir}\", but they are equal", matcher.failure_message_when_negated
     end
+
+    def test_glob_filename_matches_exactly_once
+      @case_directory = "test/cases/glob_filename_matches_exactly_once"
+      assert matcher.matches?(target_dir), matcher.failure_message
+    end
+
+    def test_glob_filename_matches_more_than_once
+      @case_directory = "test/cases/glob_filename_matches_more_than_once"
+      refute matcher.matches?(target_dir)
+      assert_equal "found multiple matches for \"#{target_dir}/{one,two}.txt\", should be just one of the following \"#{target_dir}/one.txt\", \"#{target_dir}/two.txt\"", matcher.failure_message
+    end
+
+    def test_glob_filename_missing_file
+      @case_directory = "test/cases/glob_filename_missing_file"
+      refute matcher.matches?(target_dir)
+      assert_equal "expected \"#{target_dir}/{one,two}.txt\" to exist since \"#{expected_dir}/%7Bone%2Ctwo%7D.txt\" exists", matcher.failure_message
+    end
   end
 
   class MatcherIncludesTest < MatcherEqTest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assert_dirs_equal
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrii Malyshko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-03 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,6 +86,13 @@ files:
 - 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/glob_filename_matches_exactly_once/expected/%7Bone%2Ctwo%7D.txt
+- test/cases/glob_filename_matches_exactly_once/target/two.txt
+- test/cases/glob_filename_matches_more_than_once/expected/%7Bone%2Ctwo%7D.txt
+- test/cases/glob_filename_matches_more_than_once/target/one.txt
+- test/cases/glob_filename_matches_more_than_once/target/two.txt
+- test/cases/glob_filename_missing_file/expected/%7Bone%2Ctwo%7D.txt
+- test/cases/glob_filename_missing_file/target/.keep
 - test/cases/large_different_text_files/expected/file
 - test/cases/large_different_text_files/target/file
 - test/cases/missing_expected/.keep
@@ -125,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Test assertion for directories equality by tree and content comparison
@@ -145,6 +152,13 @@ test_files:
 - 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/glob_filename_matches_exactly_once/expected/%7Bone%2Ctwo%7D.txt
+- test/cases/glob_filename_matches_exactly_once/target/two.txt
+- test/cases/glob_filename_matches_more_than_once/expected/%7Bone%2Ctwo%7D.txt
+- test/cases/glob_filename_matches_more_than_once/target/one.txt
+- test/cases/glob_filename_matches_more_than_once/target/two.txt
+- test/cases/glob_filename_missing_file/expected/%7Bone%2Ctwo%7D.txt
+- test/cases/glob_filename_missing_file/target/.keep
 - test/cases/large_different_text_files/expected/file
 - test/cases/large_different_text_files/target/file
 - test/cases/missing_expected/.keep
@@ -164,4 +178,3 @@ test_files:
 - test/matcher_test.rb
 - test/minitest_integration_test.rb
 - test/test_helper.rb
-has_rdoc: