fstest 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fstest.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Jerry Cheung
+
+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,52 @@
+# FSTest
+
+Blatantly stolen file and directory assertion methods from
+Rails::Generators::TestCase. Include the FSTest module for testing file
+existence, and file contents.
+
+## Installation
+
+    gem install fstest
+
+## Example
+
+    class MyClassTest < MiniTest::Unit::TestCase
+      include FSTest
+
+      def test_writes_file
+        assert_no_file '/tmp/foo'
+        File.open('/tmp/foo', 'w') {|fh| fh.puts "nom nom"}
+        assert_file '/tmp/foo', /^nom nom$/
+      end
+    end
+
+## Overview
+
+I couldn't find any good examples of tests for [Rails
+generators](http://guides.rubyonrails.org/generators.html), so I looked at the
+Rails tests. Rails uses a custom test class called
+Rails::Generators::TestCase. This class has methods for testing the output of
+generators. I thought the methods would be useful outside of a Rails context,
+so I wrapped it up in the FSTest gem. Enjoy!
+
+## Extras
+
+If you want to work with relative paths instead of absolute paths, you can
+set the 'base\_directory' in a setup block.
+
+class MyClassTest < MiniTest::Unit::TestCase
+  include FSTest
+
+  def setup
+    # all assert_file assertions will be relative to your homedir
+    self.base_directory = File.expand_path("~")
+  end
+
+  def test_dot_emacs
+    # this will look for ~/.emacs
+    assert_file '.emacs'
+  end
+end
+
+I've also found it useful to use [FakeFS](https://github.com/defunkt/fakefs)
+alongside this.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << ["lib", "test"]
+  t.verbose = true
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/fstest.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fstest/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fstest"
+  s.version     = FSTest::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jerry Cheung"]
+  s.email       = ["jch@whatcodecraves.com"]
+  s.homepage    = "https://github.com/jch/fstest"
+  s.summary     = %q{Extracted file and directory assertion methods from Rails::Generators::TestCase.}
+  s.description = %q{Include the FSTest module for testing file existence, and file contents.}
+
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "fakefs"
+
+  s.rubyforge_project = "fstest"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/fstest.rb

@@ -0,0 +1,69 @@
+module FSTest
+  def self.included(base)
+    base.class_eval {
+      include InstanceMethods
+      include Assertions
+      include FileUtils
+    }
+  end
+
+  module InstanceMethods
+    def base_directory
+      @base_directory
+    end
+
+    def base_directory=(path)
+      @base_directory = File.expand_path(path)
+    end
+  end
+
+  module Assertions
+    # Asserts a given file exists. You need to supply an absolute path or a path relative
+    # to the configured destination:
+    #
+    #   assert_file "config/environment.rb"
+    #
+    # You can also give extra arguments. If the argument is a regexp, it will check if the
+    # regular expression matches the given file content. If it's a string, it compares the
+    # file with the given string:
+    #
+    #   assert_file "config/environment.rb", /initialize/
+    #
+    # Finally, when a block is given, it yields the file content:
+    #
+    #   assert_file "app/controller/products_controller.rb" do |controller|
+    #     assert_instance_method :index, content do |index|
+    #       assert_match /Product\.all/, index
+    #     end
+    #   end
+    #
+    def assert_file(relative, *contents)
+      absolute = File.expand_path(relative, base_directory)
+      assert File.exists?(absolute), "Expected file #{relative.inspect} to exist, but does not"
+
+      read = File.read(absolute) if block_given? || !contents.empty?
+      yield read if block_given?
+
+      contents.each do |content|
+        case content
+          when String
+            assert_equal content, read
+          when Regexp
+            assert_match content, read
+        end
+      end
+    end
+    alias :assert_directory :assert_file
+
+    # Asserts a given file does not exist. You need to supply an absolute path or a
+    # path relative to the configured destination:
+    #
+    #   assert_no_file "config/random.rb"
+    #
+    def assert_no_file(relative)
+      absolute = File.expand_path(relative, base_directory)
+      assert !File.exists?(absolute), "Expected file #{relative.inspect} to not exist, but does"
+    end
+    alias :assert_no_directory :assert_no_file
+  end
+end

data/lib/fstest/version.rb

@@ -0,0 +1,3 @@
+module FSTest
+  VERSION = '0.0.1'
+end

data/test/fstest_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class FSTestTest < MiniTest::Unit::TestCase
+  include FSTest
+
+  def setup
+    @klass = Class.new { include FSTest }
+    @instance = @klass.new
+  end
+
+  def test_include_adds_base_directory_attribute
+    assert @instance.respond_to? :base_directory
+    assert @instance.respond_to? :base_directory=
+    assert @instance.base_directory = '/tmp'
+    assert_equal '/tmp', @instance.base_directory
+  end
+
+  def test_base_directory_is_expanded
+    @instance.base_directory = '~'
+    assert_equal File.expand_path('~'), @instance.base_directory
+  end
+
+  def test_includes_fstest_assertions
+    assert @klass.included_modules.include? FSTest::Assertions
+  end
+
+  def test_includes_file_utils
+    assert @klass.included_modules.include? FileUtils
+  end
+
+  def test_assert_file
+    File.open('/tmp/fstest', 'w') {|fh| fh.write("nom nom nom")}
+    assert_file "/tmp/fstest", /^nom nom nom$/
+    assert_file "/tmp/fstest", "nom nom nom"
+  end
+
+  def test_assert_not_file
+    assert_no_file('/tmp/unknown')
+  end
+
+  def test_assert_directory
+    FileUtils.mkdir_p('/tmp/fstest_dir')
+    assert_directory '/tmp/fstest_dir'
+  end
+
+  def test_assert_no_directory
+    assert_no_directory '/tmp/unknown_dir'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'fakefs'
+require 'fstest'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: fstest
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jerry Cheung
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-20 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakefs
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Include the FSTest module for testing file existence, and file contents.
+email: 
+- jch@whatcodecraves.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fstest.gemspec
+- lib/fstest.rb
+- lib/fstest/version.rb
+- test/fstest_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/jch/fstest
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: fstest
+rubygems_version: 1.6.1
+signing_key: 
+specification_version: 3
+summary: Extracted file and directory assertion methods from Rails::Generators::TestCase.
+test_files: 
+- test/fstest_test.rb
+- test/test_helper.rb