minitest-filesystem 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1f50869c9e1a8567409b58a165057b3e23766bc
-  data.tar.gz: f51c45d5eb02b7efa117ba22ae50086750379e04
+  metadata.gz: 3112ef0d0c7fec41ca692952474b708b221a0eb6
+  data.tar.gz: 28ccf465c1ac8610e782050e335c05f187a464a8
 SHA512:
-  metadata.gz: e482bc5bfe18c51fcc4288d57462f5927b9c6378b84e291d99eadd425731332beddaa6674ad66ecc021ba7f522d4e1c91e3922fe0f01a99b8c875da763e13de3
-  data.tar.gz: 5f4e68d4dc3563af02e74348e69c2fbb2c2c9ab647d3ccc8e338c54c6d69a95beea86209de2abeb3bf71492b950c847edd783a86ffd1d2f66849055a315a87c7
+  metadata.gz: 21056eab24d7f14771b6873c81b692a6da6fa5bc88b081b607387103559a832fc016f6492b0f008894a37e7bf08e784686c663cbd5daa2f13df84bdf59022ac2
+  data.tar.gz: c705157c1ebd517dd702d8397c7e19a1f18718866b3c8a7fee8ec416a5d4cc757d9caac47252ada8db240937bfd52ee3ffa1cd1ac79f3120d3bc68bb5a069a4b

data/.gitignore

@@ -20,3 +20,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+vendor

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p195
+ruby-2.1

data/.travis.yml

@@ -2,13 +2,11 @@
 language: ruby
 
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
-  - jruby-18mode
+  - 2.1
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
+  - rbx
 
 bundler_args: --path vendor/bundle
 

data/README.md

@@ -29,6 +29,7 @@ require 'minitest/filesystem'
 
 ## Usage
 
+### Testing for a filesystem subtree
 Let's suppose the following filesystem structure exists:
 
 * `root_dir/`
@@ -76,6 +77,37 @@ filesystem {
 Note that the match **need not to be exact** (i.e. there can be other files and
 directories inside `root_dir` that the matcher won't care about).
 
+### Syntactic sugar
+
+As a nicety, some custom assertions/matchers are provided to make your test
+suites look better. They're almost just syntactic sugar around the methods
+provided by `File`, `Dir` et al, but allow for improved code readability. So,
+for example, instead of writing
+
+    assert File.exists? "/a/file"
+
+you can write
+
+    assert_exists "/a/file"
+
+or, even better
+
+    "/a/file".must_exist
+
+**Assertions**
+
+* `assert_exists`: test whether a specific path exists (no matter if file, dir,
+  symlink)
+* `refute_exists`: test whether a specific path doesn't exist (no matter if file, dir,
+  symlink)
+
+**Expectations**
+
+The meaning of the following expectation is the same as their assertive
+counterpart:
+* `must_exist`
+* `wont_exist`
+
 ## Contributing
 
 1. Fork it
@@ -86,6 +118,11 @@ directories inside `root_dir` that the matcher won't care about).
 
 ## Changelog
 
+### 1.2.0
+
+* Added `assert_exists`, `refute_exists`, `must_exist`, `wont_exist`
+* Refactored previous test code to lighter syntax
+
 ### 1.1.1
 
 * Minor refactorings and project infrastructure updates.

data/lib/minitest/filesystem.rb

@@ -7,6 +7,14 @@ module Minitest::Assertions
     assert matcher.match_found?, msg || matcher.message
   end
 
+  def assert_exists(path, msg = nil, &block)
+    assert File.exists?(path), msg || "expected `#{path}` to exist, but it doesn't"
+  end
+
+  def refute_exists(path, msg = nil, &block)
+    refute File.exists?(path), msg || "expected `#{path}` not to exist, but it does"
+  end
+
   def filesystem(&block)
     block
   end
@@ -14,4 +22,6 @@ end
 
 module Minitest::Expectations
   infect_an_assertion :assert_contains_filesystem, :must_exist_within
+  infect_an_assertion :assert_exists, :must_exist, :unary
+  infect_an_assertion :refute_exists, :wont_exist, :unary
 end

data/lib/minitest/filesystem/version.rb

@@ -1,5 +1,5 @@
 module Minitest
   module Filesystem
-    VERSION = "1.1.1"
+    VERSION = "1.2.0"
   end
 end

data/test/{assertion_test.rb → assertions/assert_contains_filesystem_test.rb}

@@ -1,62 +1,58 @@
 require 'test_helper'
 
-require 'tmpdir'
-require 'fileutils'
-
 describe "assert_contains_filesystem" do
+  let(:root_dir) { Pathname.new(Dir.mktmpdir('minitestfs')) }
   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
+    (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 + 'actual_file')
-    FileUtils.ln_s(@root_dir + 'doesnt_matter', @root_dir + 'a_link')
-    FileUtils.ln_s(@root_dir + 'actual_file', @root_dir + 'link_to')
-    FileUtils.touch(@root_dir + 'not_a_dir')
-    FileUtils.touch(@root_dir + 'not_a_link')
-    FileUtils.touch(@root_dir + 'a_subdirectory' + 'deeper_subdirectory' + 'another_file')
-    FileUtils.touch(@root_dir + 'unchecked_file')
+    touch root_dir + 'a_file'
+    touch root_dir + 'actual_file'
+    symlink root_dir + 'doesnt_matter', root_dir + 'a_link'
+    symlink root_dir + 'actual_file', root_dir + 'link_to'
+    touch root_dir + 'not_a_dir'
+    touch root_dir + 'not_a_link'
+    touch root_dir + 'a_subdirectory' + 'deeper_subdirectory' + 'another_file'
+    touch root_dir + 'unchecked_file'
   end
   
   after do
-    FileUtils.rm_rf @root_dir
+    rm root_dir
   end
 
   it "passes with empty expected tree" do
-    assert_contains_filesystem(@root_dir) {}
+    assert_contains_filesystem(root_dir) {}
   end
 
   it "passes when single file found" do
-    assert_contains_filesystem(@root_dir) do
+    assert_contains_filesystem(root_dir) do
       file "a_file"
     end
   end
 
   it "passes when single link found" do
-    assert_contains_filesystem(@root_dir) do
+    assert_contains_filesystem(root_dir) do
       link "a_link"
     end
   end
 
   it "passes when a link points to the correct target" do
-    assert_contains_filesystem(@root_dir) do
+    assert_contains_filesystem(root_dir) do
       link "link_to", "actual_file"
     end
   end
 
   it "passes when single directory found" do
-    assert_contains_filesystem(@root_dir) do
+    assert_contains_filesystem(root_dir) do
       dir "a_directory"
     end
   end
 
   it "passes when a file within a nested subtree is found" do
-    assert_contains_filesystem(@root_dir) do
+    assert_contains_filesystem(root_dir) do
       dir "a_subdirectory" do
         dir "deeper_subdirectory" do
           file "another_file"
@@ -66,25 +62,25 @@ describe "assert_contains_filesystem" do
   end
 
   it "fails when an expected file isn't found" do
-    l = lambda { assert_contains_filesystem(@root_dir) do
+    l = lambda { assert_contains_filesystem(root_dir) do
       file "foo"
     end }
 
     error = assert_raises(Minitest::Assertion, &l)
-    error.message.must_match(/expected `#{@root_dir}` to contain file `foo`/im)
+    error.message.must_match(/expected `#{root_dir}` to contain file `foo`/im)
   end
 
   it "fails when an expected symlink isn't found" do
-    l = lambda { assert_contains_filesystem(@root_dir) do
+    l = lambda { assert_contains_filesystem(root_dir) do
       link "foo"
     end }
 
     error = assert_raises(Minitest::Assertion, &l)
-    error.message.must_match(/expected `#{@root_dir}` to contain symlink `foo`/im)
+    error.message.must_match(/expected `#{root_dir}` to contain symlink `foo`/im)
   end
 
   it "fails when a symlink points to the wrong file" do
-    l = lambda { assert_contains_filesystem(@root_dir) do
+    l = lambda { assert_contains_filesystem(root_dir) do
       link "link_to", "nonexistent_target"
     end }
 
@@ -93,16 +89,16 @@ describe "assert_contains_filesystem" do
   end
 
   it "fails when an expected directory isn't found" do
-    l = lambda { assert_contains_filesystem(@root_dir) do
+    l = lambda { assert_contains_filesystem(root_dir) do
       dir "bar"
     end }
 
     error = assert_raises(Minitest::Assertion, &l)
-    error.message.must_match(/expected `#{@root_dir}` to contain directory `bar`/im)
+    error.message.must_match(/expected `#{root_dir}` to contain directory `bar`/im)
   end
 
   it "fails when an expected file within a subdirectory isn't found" do
-    l = lambda { assert_contains_filesystem(@root_dir) do
+    l = lambda { assert_contains_filesystem(root_dir) do
       dir "a_subdirectory" do
         file "missing_file"
       end
@@ -110,11 +106,11 @@ 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
-    l = lambda { assert_contains_filesystem(@root_dir) do
+    l = lambda { assert_contains_filesystem(root_dir) do
       file "not_a_file"
     end }
 
@@ -123,7 +119,7 @@ describe "assert_contains_filesystem" do
   end
 
   it "fails when a file is expected to be a directory" do
-    l = lambda { assert_contains_filesystem(@root_dir) do
+    l = lambda { assert_contains_filesystem(root_dir) do
       dir "not_a_dir"
     end }
 
@@ -132,7 +128,7 @@ describe "assert_contains_filesystem" do
   end
 
   it "fails when a file is expected to be a symlink" do
-    l = lambda { assert_contains_filesystem(@root_dir) do
+    l = lambda { assert_contains_filesystem(root_dir) do
       link "not_a_link"
     end }
 
@@ -143,7 +139,7 @@ describe "assert_contains_filesystem" do
   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
+    l = lambda { assert_contains_filesystem(root_dir, failure_msg) do
       file "baz"
     end }
 

data/test/assertions/assert_exists_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+describe "assert_exists" do
+  let(:root_dir) { Pathname.new(Dir.mktmpdir("minitestfs")) }
+  let(:a_path) { root_dir + "a_file" }
+
+  it "fails when the given path is not found" do
+    l = lambda { assert_exists(a_path) }
+
+    error = assert_raises(Minitest::Assertion, &l)
+    error.message.must_match(/expected `#{a_path}` to exist/im)
+  end
+
+  it "allows to print custom error messages" do
+    failure_msg = "I really miss this path a lot"
+
+    l = lambda { assert_exists(a_path, failure_msg) }
+
+    error = assert_raises(Minitest::Assertion, &l)
+    error.message.must_equal(failure_msg)
+  end
+end

data/test/assertions/refute_exists_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe "refute_exists" do
+  let(:root_dir) { Pathname.new(Dir.mktmpdir("minitestfs")) }
+
+  it "fails when the given path is found" do
+    l = lambda { refute_exists(root_dir) }
+
+    error = assert_raises(Minitest::Assertion, &l)
+    error.message.must_match(/expected `#{root_dir}` not to exist/im)
+  end
+end
+

data/test/expectations/filesystem_must_exist_within_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+
+describe "filesystem must_exist_within" do
+  let(:root_dir) { Pathname.new(Dir.mktmpdir('minitestfs')) }
+
+  before do
+    (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
+  
+    touch root_dir + 'a_file'
+    touch root_dir + 'not_a_dir'
+    touch root_dir + 'a_subdirectory' + 'deeper_subdirectory' + 'another_file'
+    touch root_dir + 'unchecked_file'
+  end
+  
+  after do
+    rm 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/expectations/must_exist_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+describe "must_exist" do
+  let(:a_path) { Pathname.new("/lmao/if/this/exists") }
+
+  it "fails when the expected path doesn't exist" do
+    l = lambda { a_path.must_exist }
+    assert_raises(Minitest::Assertion, &l)
+  end
+end

data/test/expectations/wont_exist_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+describe "wont_exist" do
+  let(:a_path) { Pathname.new(Dir.mktmpdir('minitestfs')) }
+
+  it "fails when the expected path exists" do
+    l = lambda { a_path.wont_exist }
+    assert_raises(Minitest::Assertion, &l)
+  end
+end
+

data/test/test_helper.rb

@@ -5,3 +5,18 @@ require 'minitest/autorun'
 require 'minitest/spec'
 
 require 'minitest/filesystem'
+
+require 'tmpdir'
+require 'fileutils'
+
+def touch(path)
+  FileUtils.touch(path)
+end
+
+def rm(path)
+  FileUtils.rm_rf(path)
+end
+
+def symlink(path, link)
+  FileUtils.ln_s(path, link)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-filesystem
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Stefano Zanella
@@ -29,90 +29,90 @@ cert_chain:
   RigBD0E3/t/ABjCXkmqwp5gnAZmP8JiVUkn8rp5E0FXvC8T7nsPs2TW/TAmUV6rN
   hK25FX8YWgT9fD9y3PpWjiYcrCo=
   -----END CERTIFICATE-----
-date: 2013-09-06 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: minitest
   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'
 - !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'
 - !ruby/object:Gem::Dependency
   name: flog
   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'
 - !ruby/object:Gem::Dependency
   name: flay
   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
@@ -122,9 +122,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -134,8 +134,12 @@ files:
 - lib/minitest/filesystem/version.rb
 - minitest-filesystem.gemspec
 - rubygems-stefanozanella.crt
-- test/assertion_test.rb
-- test/expectation_test.rb
+- test/assertions/assert_contains_filesystem_test.rb
+- test/assertions/assert_exists_test.rb
+- test/assertions/refute_exists_test.rb
+- test/expectations/filesystem_must_exist_within_test.rb
+- test/expectations/must_exist_test.rb
+- test/expectations/wont_exist_test.rb
 - test/test_helper.rb
 homepage: https://github.com/stefanozanella/minitest-filesystem
 licenses:
@@ -147,22 +151,26 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Adds assertions and expectations to check the content of a filesystem tree
   with minitest
 test_files:
-- test/assertion_test.rb
-- test/expectation_test.rb
+- test/assertions/assert_contains_filesystem_test.rb
+- test/assertions/assert_exists_test.rb
+- test/assertions/refute_exists_test.rb
+- test/expectations/filesystem_must_exist_within_test.rb
+- test/expectations/must_exist_test.rb
+- test/expectations/wont_exist_test.rb
 - test/test_helper.rb

data/test/expectation_test.rb

@@ -1,48 +0,0 @@
-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