minitest-filesystem 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b364d783dce84d3efbc20abb86664ed9b236b416
-  data.tar.gz: 094022ba019ef0e6035cb831244e63a389317b8f
+  metadata.gz: 06e28053de722c8cc02a8e8679ec05b41fe86e39
+  data.tar.gz: f8e11b3bd7ff63311b7699a9f739f7e91bcac9d1
 SHA512:
-  metadata.gz: 9334f162c83d5baf45d0f00ca8798e2933fca944ac6eee2fb41098062e7a3d1d45dacb76cec9d8d6800062f58b35c45a462df4b37c34d91dd9b81cc310c24fc2
-  data.tar.gz: 5b4bd753d6241f2104ce3c3e8b876190130274dc81c66c8baecf644c48b0711dddd903d4c9ccf249c62fa8c0a475cc33521a6ffcf4b7694b7cc0d2444cd8c414
+  metadata.gz: 5375f8b89900b5e6a05eb32289cb8aaf4bf2e144ccf302890dcbd08958f1e8b7d93bdea120be1ebbd22b1fc0fdee7a3134d69d0ff34fc95a9017786ab165d69c
+  data.tar.gz: d58bdf3707630ca24a3a26901bcbff36aaf19439e8e9eadbca43e5d40629db6743acacf6fb66d7acdc126151279cf3e2959523b05567b709bacc863b68432a67

data/.gitignore

@@ -1,8 +1,12 @@
+.DS_Store
+*.swp
+*.swo
 *.gem
 *.rbc
 .bundle
 .config
 .yardoc
+.yardopts
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -7,7 +7,7 @@ rvm:
   - jruby-19mode
   - rbx-19mode
 
-install: bundle install --path vendor/bundle
+bundler_args: --path vendor/bundle
 
 script:
   - bundle exec rake test

data/README.md

@@ -80,3 +80,9 @@ directories inside `root_dir` that the matcher won't care about).
 ### 0.0.1
 
 * Extract assertion and matcher from current projects
+
+### 0.1.0
+
+* Refactor existing code
+* Add more tests around assertion
+* Infect `must_exist_within` expectation

data/lib/minitest/filesystem.rb

@@ -6,4 +6,12 @@ module MiniTest::Assertions
     matcher = MiniTest::FileSystem::Matcher.new(dir, &block)
     assert matcher.match_found?, msg || matcher.message
   end
+
+  def filesystem(&block)
+    block
+  end
+end
+
+module MiniTest::Expectations
+  infect_an_assertion :assert_contains_filesystem, :must_exist_within
 end

data/lib/minitest/filesystem/matcher.rb

@@ -14,18 +14,11 @@ module MiniTest
       end
 
       def dir(dir, &block)
-        matcher = self.class.new(@actual_tree.root + dir, &block) if block_given?
+        matcher = self.class.new(@actual_tree.expand_path(dir), &block) if block_given?
 
         entry(:directory, dir) && is_a?(:directory, dir) && subtree(matcher)
       end
 
-      def entry(kind = :entry, entry)
-        @is_matching = @is_matching && @actual_tree.include?(entry)
-        set_failure_msg_for(kind, entry) unless @is_matching
-
-        @is_matching
-      end
-
       def match_found?
         instance_eval(&@expected_tree)
         @is_matching
@@ -37,31 +30,39 @@ module MiniTest
 
       private
 
-      def subtree(matcher)
-        @is_matching = @is_matching && matcher.match_found? if matcher
-        set_failure_msg(matcher.message) unless @is_matching
+      def entry(kind = :entry, entry)
+        update_matching_status(
+          @actual_tree.include?(entry),
+          not_found_msg_for(kind, entry))
+      end
 
-        @is_matching
+      def subtree(matcher)
+        update_matching_status(matcher.match_found?, matcher.message) if matcher
       end
 
       def is_a?(kind, entry)
-        @is_matching = @is_matching && (@actual_tree.is_a?(kind, entry))
-        set_mismatch_failure_msg_for(kind, entry) unless @is_matching
+        update_matching_status(
+          @actual_tree.is_a?(kind, entry),
+          mismatch_msg_for(kind, entry))
+      end
+
+      def update_matching_status(check, msg)
+        @is_matching = @is_matching && check
+        set_failure_msg(msg) unless @is_matching
 
         @is_matching
       end
 
-      def set_failure_msg_for(kind, entry)
-        set_failure_msg "Expected `#{@actual_tree.root}` to contain #{kind} `#{entry}`."
+      def not_found_msg_for(kind, entry)
+        "Expected `#{@actual_tree.root}` to contain #{kind} `#{entry}`."
       end
 
-      def set_failure_msg(msg)
-        @failure_msg ||= msg
+      def mismatch_msg_for(kind, entry)
+        "Expected `#{entry}` to be a #{kind}, but it was not."
       end
 
-      def set_mismatch_failure_msg_for(kind, entry)
-        @failure_msg ||=
-          "Expected `#{entry}` to be a #{kind}, but it was not."
+      def set_failure_msg(msg)
+        @failure_msg ||= msg
       end
 
       class MatchingTree
@@ -73,11 +74,15 @@ module MiniTest
         end
 
         def include?(entry)
-          @tree.include?(root_slash(entry))
+          @tree.include?(expand_path(entry))
         end
 
         def is_a?(kind, entry)
-          (root_slash entry).send("#{kind}?")
+          (expand_path entry).send("#{kind}?")
+        end
+
+        def expand_path(file)
+          @root + Pathname.new(file)
         end
 
         private
@@ -85,10 +90,6 @@ module MiniTest
         def expand_tree_under(dir)
           Pathname.glob(dir.join("**/*"))
         end
-
-        def root_slash(file)
-          @root + Pathname.new(file)
-        end
       end
     end
   end

data/lib/minitest/filesystem/version.rb

@@ -1,5 +1,5 @@
 module Minitest
   module Filesystem
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/minitest-filesystem.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "bundler", "~> 1.3"
   gem.add_development_dependency "rake"
   gem.add_development_dependency "minitest"
+  gem.add_development_dependency "coveralls"
 end

data/test/{filesystem_test.rb → assertion_test.rb}

@@ -1,22 +1,24 @@
 require 'test_helper'
+
 require 'tmpdir'
 require 'fileutils'
 
 describe "assert_contains_filesystem" do
   before do
     @root_dir = Pathname.new(Dir.mktmpdir('minitestfs'))
-
+  
     (@root_dir + 'a_directory').mkdir
     (@root_dir + 'a_subdirectory').mkdir
+    (@root_dir + 'a_subdirectory' + 'deeper_subdirectory').mkdir
     (@root_dir + 'not_a_file').mkdir
     (@root_dir + 'unchecked_dir').mkdir
-
+  
     FileUtils.touch(@root_dir + 'a_file')
     FileUtils.touch(@root_dir + 'not_a_dir')
-    FileUtils.touch(@root_dir + 'a_subdirectory' + 'another_file')
+    FileUtils.touch(@root_dir + 'a_subdirectory' + 'deeper_subdirectory' + 'another_file')
     FileUtils.touch(@root_dir + 'unchecked_file')
   end
-
+  
   after do
     FileUtils.rm_rf @root_dir
   end
@@ -37,10 +39,12 @@ describe "assert_contains_filesystem" do
     end
   end
 
-  it "passes when a file within a subdirectory is found" do
+  it "passes when a file within a nested subtree is found" do
     assert_contains_filesystem(@root_dir) do
       dir "a_subdirectory" do
-        file "another_file"
+        dir "deeper_subdirectory" do
+          file "another_file"
+        end
       end
     end
   end
@@ -72,8 +76,7 @@ describe "assert_contains_filesystem" do
 
     error = assert_raises(MiniTest::Assertion, &l)
     error.message.must_match(
-      /expected `#{@root_dir + 'a_subdirectory'}` to contain file `missing_file`/im
-    )
+      /expected `#{@root_dir + 'a_subdirectory'}` to contain file `missing_file`/im)
   end
 
   it "fails when a directory is expected to be a file" do
@@ -93,4 +96,15 @@ describe "assert_contains_filesystem" do
     error = assert_raises(MiniTest::Assertion, &l)
     error.message.must_match(/expected `not_a_dir` to be a directory/im)
   end
+
+  it "allows to print custom error messages" do
+    failure_msg = "I really miss this file a lot"
+
+    l = lambda { assert_contains_filesystem(@root_dir, failure_msg) do
+      file "baz"
+    end }
+
+    error = assert_raises(MiniTest::Assertion, &l)
+    error.message.must_equal(failure_msg)
+  end
 end

data/test/expectation_test.rb

@@ -0,0 +1,48 @@
+require 'test_helper'
+
+require 'tmpdir'
+require 'fileutils'
+
+describe "filesystem must_exist_within" do
+  before do
+    @root_dir = Pathname.new(Dir.mktmpdir('minitestfs'))
+  
+    (@root_dir + 'a_directory').mkdir
+    (@root_dir + 'a_subdirectory').mkdir
+    (@root_dir + 'a_subdirectory' + 'deeper_subdirectory').mkdir
+    (@root_dir + 'not_a_file').mkdir
+    (@root_dir + 'unchecked_dir').mkdir
+  
+    FileUtils.touch(@root_dir + 'a_file')
+    FileUtils.touch(@root_dir + 'not_a_dir')
+    FileUtils.touch(@root_dir + 'a_subdirectory' + 'deeper_subdirectory' + 'another_file')
+    FileUtils.touch(@root_dir + 'unchecked_file')
+  end
+  
+  after do
+    FileUtils.rm_rf @root_dir
+  end
+
+  it "passes when the expected tree is found" do
+    filesystem {
+      file "a_file"
+      dir "a_subdirectory" do
+        dir "deeper_subdirectory" do
+          file "another_file"
+        end
+      end
+    }.must_exist_within(@root_dir)
+  end
+
+  it "fails when the expected tree is not found" do
+    l = lambda { filesystem {
+      file "a_file"
+      dir "a_subdirectory"
+      file "missing_file"
+    }.must_exist_within(@root_dir) }
+
+    error = assert_raises(MiniTest::Assertion, &l)
+    error.message.must_match(
+      /expected `#{@root_dir}` to contain file `missing_file`/im)
+  end
+end

data/test/test_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'minitest/autorun'
 require 'minitest/spec'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-filesystem
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Stefano Zanella
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Minitest exstension to check filesystem contents
 email:
 - zanella.stefano@gmail.com
@@ -70,7 +84,8 @@ files:
 - lib/minitest/filesystem/matcher.rb
 - lib/minitest/filesystem/version.rb
 - minitest-filesystem.gemspec
-- test/filesystem_test.rb
+- test/assertion_test.rb
+- test/expectation_test.rb
 - test/test_helper.rb
 homepage: https://github.com/stefanozanella/minitest-filesystem
 licenses:
@@ -98,5 +113,6 @@ specification_version: 4
 summary: Adds assertions and expectations to check the content of a filesystem tree
   with minitest
 test_files:
-- test/filesystem_test.rb
+- test/assertion_test.rb
+- test/expectation_test.rb
 - test/test_helper.rb