minitest-filesystem 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b364d783dce84d3efbc20abb86664ed9b236b416
+  data.tar.gz: 094022ba019ef0e6035cb831244e63a389317b8f
+SHA512:
+  metadata.gz: 9334f162c83d5baf45d0f00ca8798e2933fca944ac6eee2fb41098062e7a3d1d45dacb76cec9d8d6800062f58b35c45a462df4b37c34d91dd9b81cc310c24fc2
+  data.tar.gz: 5b4bd753d6241f2104ce3c3e8b876190130274dc81c66c8baecf644c48b0711dddd903d4c9ccf249c62fa8c0a475cc33521a6ffcf4b7694b7cc0d2444cd8c414

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p195

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+
+install: bundle install --path vendor/bundle
+
+script:
+  - bundle exec rake test

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stefano Zanella
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# Minitest::Filesystem
+
+[![Gem Version](https://badge.fury.io/rb/minitest-filesystem.png)](http://badge.fury.io/rb/minitest-filesystem)
+[![Build Status](https://travis-ci.org/stefanozanella/minitest-filesystem.png?branch=master)](https://travis-ci.org/stefanozanella/minitest-filesystem)
+[![Code Climate](https://codeclimate.com/github/stefanozanella/minitest-filesystem.png)](https://codeclimate.com/github/stefanozanella/minitest-filesystem)
+[![Coverage Status](https://coveralls.io/repos/stefanozanella/minitest-filesystem/badge.png?branch=master)](https://coveralls.io/r/stefanozanella/minitest-filesystem?branch=master)
+
+Adds assertions and expectations to check filesystem content in a communicative way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'minitest-filesystem'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-filesystem
+
+Once the gem is installed, just add this line to your `test_helper.rb`:
+
+```ruby
+require 'minitest/filesystem'
+```
+
+## Usage
+
+Let's suppose the following filesystem structure exists:
+
+* `root_dir/`
+  * `file_1`
+  * `file_2`
+  * `subdir_1/`
+      * `subfile_1`
+      * `subfile_2`
+      * `subsubdir_1/`
+  * `subdir_2/`
+
+You can check if `root_dir` contains a specific structure:
+
+```ruby
+assert_contains_filesystem("root_dir") do
+  file "file_1"
+  dir "subdir_1" do
+    file "subfile_1"
+  end
+  dir "subdir_2"
+end
+```
+
+or, if you prefer the expectation style:
+
+```ruby
+filesystem {
+  file "file_1"
+  dir "subdir_1" do
+    file "subfile_1"
+  end
+  dir "subdir_2"
+}.must_exist_within "root_dir"
+```
+
+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).
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Changelog
+
+### 0.0.1
+
+* Extract assertion and matcher from current projects

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*.rb"
+  t.verbose = true
+end
+
+task :default => :test

data/lib/minitest/filesystem/matcher.rb

@@ -0,0 +1,95 @@
+require 'pathname'
+
+module MiniTest
+  module FileSystem
+    class Matcher
+      def initialize(root, &block)
+        @actual_tree = MatchingTree.new(root)
+        @expected_tree = block
+        @is_matching = true
+      end
+
+      def file(file)
+        entry(:file, file) && is_a?(:file, file)
+      end
+
+      def dir(dir, &block)
+        matcher = self.class.new(@actual_tree.root + 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
+      end
+
+      def message
+        @failure_msg || ""
+      end
+
+      private
+
+      def subtree(matcher)
+        @is_matching = @is_matching && matcher.match_found? if matcher
+        set_failure_msg(matcher.message) unless @is_matching
+
+        @is_matching
+      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
+
+        @is_matching
+      end
+
+      def set_failure_msg_for(kind, entry)
+        set_failure_msg "Expected `#{@actual_tree.root}` to contain #{kind} `#{entry}`."
+      end
+
+      def set_failure_msg(msg)
+        @failure_msg ||= msg
+      end
+
+      def set_mismatch_failure_msg_for(kind, entry)
+        @failure_msg ||=
+          "Expected `#{entry}` to be a #{kind}, but it was not."
+      end
+
+      class MatchingTree
+        attr_reader :root
+
+        def initialize(root)
+          @root = Pathname.new(root)
+          @tree = expand_tree_under @root
+        end
+
+        def include?(entry)
+          @tree.include?(root_slash(entry))
+        end
+
+        def is_a?(kind, entry)
+          (root_slash entry).send("#{kind}?")
+        end
+
+        private
+        
+        def expand_tree_under(dir)
+          Pathname.glob(dir.join("**/*"))
+        end
+
+        def root_slash(file)
+          @root + Pathname.new(file)
+        end
+      end
+    end
+  end
+end

data/lib/minitest/filesystem/version.rb

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

data/lib/minitest/filesystem.rb

@@ -0,0 +1,9 @@
+require "minitest/filesystem/version"
+require "minitest/filesystem/matcher"
+
+module MiniTest::Assertions
+  def assert_contains_filesystem(dir, msg = nil, &block)
+    matcher = MiniTest::FileSystem::Matcher.new(dir, &block)
+    assert matcher.match_found?, msg || matcher.message
+  end
+end

data/minitest-filesystem.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitest/filesystem/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "minitest-filesystem"
+  gem.version       = Minitest::Filesystem::VERSION
+  gem.authors       = ["Stefano Zanella"]
+  gem.email         = ["zanella.stefano@gmail.com"]
+  gem.description   = %q{Minitest exstension to check filesystem contents}
+  gem.summary       = %q{Adds assertions and expectations to check the content
+                         of a filesystem tree with minitest}
+  gem.homepage      = "https://github.com/stefanozanella/minitest-filesystem"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|gem|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+end

data/test/filesystem_test.rb

@@ -0,0 +1,96 @@
+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 + '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 + 'unchecked_file')
+  end
+
+  after do
+    FileUtils.rm_rf @root_dir
+  end
+
+  it "passes with empty expected tree" do
+    assert_contains_filesystem(@root_dir) {}
+  end
+
+  it "passes when single file found" do
+    assert_contains_filesystem(@root_dir) do
+      file "a_file"
+    end
+  end
+
+  it "passes when single directory found" do
+    assert_contains_filesystem(@root_dir) do
+      dir "a_directory"
+    end
+  end
+
+  it "passes when a file within a subdirectory is found" do
+    assert_contains_filesystem(@root_dir) do
+      dir "a_subdirectory" do
+        file "another_file"
+      end
+    end
+  end
+
+  it "fails when an expected file isn't found" 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)
+  end
+
+  it "fails when an expected directory isn't found" 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)
+  end
+
+  it "fails when an expected file within a subdirectory isn't found" do
+    l = lambda { assert_contains_filesystem(@root_dir) do
+      dir "a_subdirectory" do
+        file "missing_file"
+      end
+    end }
+
+    error = assert_raises(MiniTest::Assertion, &l)
+    error.message.must_match(
+      /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
+      file "not_a_file"
+    end }
+
+    error = assert_raises(MiniTest::Assertion, &l)
+    error.message.must_match(/expected `not_a_file` to be a file/im)
+  end
+
+  it "fails when a file is expected to be a directory" do
+    l = lambda { assert_contains_filesystem(@root_dir) do
+      dir "not_a_dir"
+    end }
+
+    error = assert_raises(MiniTest::Assertion, &l)
+    error.message.must_match(/expected `not_a_dir` to be a directory/im)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+
+require 'minitest/filesystem'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: minitest-filesystem
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefano Zanella
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-21 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'
+description: Minitest exstension to check filesystem contents
+email:
+- zanella.stefano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minitest/filesystem.rb
+- lib/minitest/filesystem/matcher.rb
+- lib/minitest/filesystem/version.rb
+- minitest-filesystem.gemspec
+- test/filesystem_test.rb
+- test/test_helper.rb
+homepage: https://github.com/stefanozanella/minitest-filesystem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+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/test_helper.rb