file-spec 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1 @@
+--format nested --color

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+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.markdown

@@ -0,0 +1,39 @@
+# File spec
+
+RSpec 2 matcher to specify expected file structures.
+
+## Usage
+
+See /spec folder for usage examples.
+
+## TODO
+
+Currently these do not check file type of target but are just alias of generic have_symlink.
+This must be fixed!
+
+* have_symlink_file sym_file
+* have_symlink_dir sym_dir
+
+* have_symlink_files sym_file1, sym_file2
+* have_symlink_dirs sym_dir1, sym_dir2
+
+## TODO - advanced
+
+* have_file_structure yaml
+
+Should test that the files and dirs match the tree structure of the yaml string (or file).
+This is very convenient for more complex file structure specs!
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "file-spec"
+    gem.summary = 'RSpec 2 matchers for files, directories and symlinks'
+    gem.description = 'RSpec 2 matchers for files, directories and symlinks'
+    gem.email = "kmandrup@gmail.com"
+    gem.homepage = "http://github.com/kristianmandrup/file-spec"
+    gem.authors = ["Kristian Mandrup"]
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta.19"
+    gem.add_dependency "require_all", ">= 1.1.0"
+    # gem.add_dependency "active_support", ">= 3.0.0.rc"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/file-spec.rb

@@ -0,0 +1,16 @@
+require 'rspec'
+require 'require_all'      
+require 'fileutils'
+require 'active_support/inflector'      
+
+module RSpec
+  module FileMatchers
+  end
+end
+
+require_all File.dirname(__FILE__) + '/file_spec/matchers/abstract'
+require_all File.dirname(__FILE__) + '/file_spec/matchers'
+
+RSpec.configure do |config|
+  config.include(RSpec::FileMatchers)  
+end

data/lib/file_spec/file_helper.rb

@@ -0,0 +1,131 @@
+module FileHelper
+  def test_file
+    'test.txt'
+  end
+
+  def test_files
+    [test_file, 'test2.txt'] 
+  end
+
+  def sym_test_file
+    'sym-test.txt'
+  end
+
+  def sym_test_files
+    test_files.map{|f| "sym-#{f}" }
+  end
+
+  def test_dir
+    'test'
+  end
+
+  def test_dirs
+    [test_dir, 'test2']
+  end
+
+  def sym_test_dir
+    'sym-test'
+  end
+
+  def sym_test_dirs
+    [sym_test_dir, 'sym-test2']
+  end
+
+  def remove_all_test
+    remove_test_files
+    remove_test_dirs
+    remove_test_symlinks
+    remove_test_symlink_dirs
+  end
+    
+  def make_test_file 
+    make_file test_file
+  end
+
+  def make_test_files
+    test_files.each{|f| make_file f}    
+  end
+  
+  def make_file file
+    File.open(file, 'w') {|f| f.write "hello" }    
+  end
+
+  def remove_file file
+    ::FileUtils.rm_f file
+  end
+
+  def remove_test_file
+    remove_file test_file
+  end
+
+  def remove_test_files
+    test_files.each{|f| remove_file f}    
+  end
+
+  def make_dir dir
+    ::FileUtils.mkdir dir
+  end
+
+  def make_test_dir
+    make_dir test_dir
+  end
+
+  def make_test_dirs
+    test_dirs.each{|dir| make_dir dir}
+  end
+
+  def remove_dir dir
+    ::FileUtils.rm_rf dir
+  end
+
+  def remove_test_dir
+    remove_dir test_dir
+  end
+
+  def remove_test_dirs
+    test_dirs.each{|dir| remove_dir dir}
+  end
+
+  def make_file_symlink orig_file, sym_file
+    make_file orig_file if !File.file?(orig_file)
+    File.symlink(orig_file, sym_file) if !File.symlink?(sym_file)
+  end
+
+  def make_test_symlink  
+    make_file_symlink test_file, sym_test_file
+  end
+
+  def make_test_symlinks
+    test_files.each_with_index{|file, i| make_file_symlink(file, sym_test_files[i])}
+  end
+
+  def remove_test_symlink
+    remove_file sym_test_file
+  end
+
+  def remove_test_symlinks
+    sym_test_files.each{|f| remove_file f} 
+  end
+
+  def make_dir_symlink orig_dir, sym_dir
+    make_dir orig_dir if !File.directory?(orig_dir)
+    File.symlink(orig_dir, sym_dir) if !File.symlink?(sym_dir)
+  end
+
+  def make_test_symlink_dir             
+    make_dir_symlink test_dir, sym_test_dir    
+  end
+
+  def make_test_symlink_dirs
+    test_dirs.each_with_index{|file, i| make_dir_symlink(file, sym_test_dirs[i])}
+  end
+
+  def remove_test_symlink_dir
+    remove_dir sym_test_dir
+  end
+  
+  def remove_test_symlink_dirs
+    sym_test_dirs.each{|dir| remove_dir dir}
+  end
+  
+end

data/lib/file_spec/matchers/abstract/have_file_item.rb

@@ -0,0 +1,44 @@
+module RSpec::FileMatchers
+  class HaveFileItem         
+    attr_accessor :location
+
+    def initialize(*args)
+      self.location = get_location(args).to_s
+    end
+
+    def get_location(*args)
+      args = args.flatten
+      loc = if args.size > 1
+        dir, name = *args
+        File.join(dir.to_s, name.to_s)
+      else
+        args[0].to_s
+      end
+    end
+
+    def matches? x=nil, &block
+      puts location.inspect
+      match = File.send :"#{artifact}?", location
+      yield if block && match
+      match
+    end          
+
+    def artifact
+      raise "artifact method must be overridden by subclass"
+    end
+  
+    def failure_message
+      "Expected #{artifact} at: #{location} to exist, but it did not"
+    end
+
+    def negative_failure_message
+      "Did not expected #{artifact} at: #{location} to exist, but it did"
+    end    
+  end
+
+  def have_file(*args)
+    HaveFile.new(args)
+  end
+  alias_method :contain_file, :have_file
+end
+

data/lib/file_spec/matchers/abstract/have_file_items.rb

@@ -0,0 +1,39 @@
+module RSpec::FileMatchers
+  class HaveFileItems
+    attr_accessor :file_items
+
+    def initialize(*file_items)
+      self.file_items = file_items.flatten
+    end
+
+    def matches? x=nil, &block
+      file_item_names.each do |location|       
+        return false if  !File.send(:"#{artifact}?", location)
+      end
+      true
+    end          
+
+    def file_item_names
+      @file_item_names ||= file_items.map(&:to_s)
+    end
+
+    def artifact
+      raise "artifact method must be overridden by subclass"
+    end
+  
+    def failure_message                                                               
+      return "Expected #{artifact} #{file_item_names.first} to exist, but it did not" if file_items.size == 1
+      "Expected #{artifact.pluralize} [#{file_item_names}] to exist, but they did not"
+    end
+
+    def negative_failure_message
+      return "Did not expect #{artifact} #{file_item_names.first} to exist, but it did" if file_items.size == 1
+      "Did not expect #{artifact.pluralize} [#{file_item_names}] to exist, but they did"
+    end    
+  end
+
+  def have_file_items(*args)
+    HaveFileItems.new(args)
+  end
+end
+

data/lib/file_spec/matchers/have_dir.rb

@@ -0,0 +1,26 @@
+module RSpec::FileMatchers
+  class HaveDir < HaveFileItem
+
+    def artifact
+      'directory'
+    end  
+  end
+
+  def have_dir(dir)
+    HaveDir.new(dir)
+  end
+end
+
+module RSpec::FileMatchers
+  class HaveDirs < HaveFileItems
+
+    def artifact
+      'directory'
+    end  
+  end
+
+  def have_dirs(*dirs)
+    HaveDirs.new(dirs)
+  end
+end
+

data/lib/file_spec/matchers/have_file.rb

@@ -0,0 +1,29 @@
+module RSpec::FileMatchers
+  class HaveFile < HaveFileItem
+    
+    def artifact
+      'file'
+    end
+  end
+
+  def have_file(*args)
+    HaveFile.new(args)
+  end
+  alias_method :contain_file, :have_file
+end
+    
+module RSpec::FileMatchers
+  class HaveFiles < HaveFileItems
+    
+    def artifact
+      'file'
+    end
+  end
+
+  def have_files(*args)
+    HaveFiles.new(args)
+  end
+  alias_method :contain_files, :have_files
+end
+
+

data/lib/file_spec/matchers/have_symlink.rb

@@ -0,0 +1,41 @@
+module RSpec::FileMatchers
+  class HaveSymlink < HaveFileItem
+
+    def artifact
+      'symlink'
+    end    
+  end
+
+  def have_symlink(*args)
+    HaveSymlink.new(args)
+  end
+  alias_method :contain_symlink, :have_symlink
+  
+  alias_method :contain_symlink_file, :have_symlink
+  alias_method :have_symlink_file, :have_symlink
+  
+  alias_method :contain_symlink_dir, :have_symlink
+  alias_method :have_symlink_dir, :have_symlink  
+end
+
+module RSpec::FileMatchers
+  class HaveSymlinks < HaveFileItems
+
+    def artifact
+      'symlink'
+    end    
+  end
+
+  def have_symlinks(*args)
+    HaveSymlinks.new(args)
+  end
+  alias_method :contain_symlinks, :have_symlinks
+
+  # TODO
+  alias_method :contain_symlink_files, :have_symlinks
+  alias_method :have_symlink_files, :have_symlinks
+  
+  alias_method :contain_symlink_dirs, :have_symlinks  
+  alias_method :have_symlink_dirs, :have_symlinks
+end
+

data/spec/file-spec/matchers/multiple/have_directories_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module RSpec::FileMatchers
+  describe HaveFiles do
+    describe '#have_dirs' do
+      include FileHelper
+      
+      before :each do   
+        remove_test_dirs
+      end
+
+      after :each do
+        remove_test_dirs
+      end
+
+      it "should not have 'test' dirs" do
+        nil.should_not have_dirs test_dirs
+      end
+    
+      it "should have 'test' dirs" do      
+        make_test_dirs
+        nil.should have_dirs test_dirs
+      end
+    end
+  end
+end

data/spec/file-spec/matchers/multiple/have_files_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module RSpec::FileMatchers
+  describe HaveFiles do
+    describe '#have_files' do
+      include FileHelper
+      
+      before :each do   
+        remove_test_files
+      end
+
+      after :each do
+        remove_test_files
+      end
+
+      it "should have file" do
+        nil.should_not have_files test_files
+      end
+    
+      it "should have file" do      
+        make_test_files
+        nil.should have_files test_files
+      end
+    end
+  end
+end

data/spec/file-spec/matchers/multiple/have_symlinks_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module RSpec::FileMatchers
+  describe HaveSymlinks do
+    describe '#have_symlinks' do
+      include FileHelper
+      
+      before :each do   
+        remove_all_test
+      end
+
+      after :each do
+        remove_all_test
+      end
+
+      it "should not have symlink files" do
+        nil.should_not have_symlinks sym_test_files
+      end
+
+      it "should have symlink files" do
+        make_test_symlinks        
+        nil.should have_symlinks sym_test_files
+      end
+    
+      it "should not have symlink dirs" do
+        nil.should_not have_symlink_dirs sym_test_dirs
+      end
+      
+      it "should have symlink dirs" do      
+        make_test_symlink_dirs
+        nil.should have_symlink_dirs sym_test_dirs
+      end
+    end
+  end
+end

data/spec/file-spec/matchers/single/have_directory_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module RSpec::FileMatchers
+  describe HaveDir do
+    describe '#have_dir' do
+      include FileHelper
+      
+      before :each do   
+        remove_test_dir
+      end
+
+      after :each do
+        remove_test_dir
+      end
+
+      it "should not have 'test' dir" do
+        nil.should_not have_dir test_dir
+      end
+    
+      it "should have 'test' dir" do      
+        make_test_dir
+        nil.should have_dir test_dir
+      end
+
+      it "should have 'test' dirs" do      
+        make_test_dirs
+        nil.should have_dirs test_dirs
+      end
+
+    end
+  end
+end

data/spec/file-spec/matchers/single/have_file_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+module RSpec::FileMatchers
+  describe HaveFile do
+    describe '#have_file' do
+      include FileHelper
+      
+      before :each do   
+        remove_test_file
+      end
+
+      after :each do
+        remove_test_file
+      end
+
+      it "should have file" do
+        nil.should_not have_file test_file
+      end
+    
+      it "should have file" do      
+        make_test_file
+        nil.should have_file test_file
+      end
+    end
+  end
+end

data/spec/file-spec/matchers/single/have_symlink_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+module RSpec::FileMatchers
+  describe HaveSymlink do
+    describe '#have_symlink' do
+      include FileHelper
+      
+      before :each do   
+        remove_all_test
+      end
+
+      after :each do
+        remove_all_test
+      end
+
+      it "should not have symlink file" do
+        nil.should_not have_symlink sym_test_file
+      end
+
+      it "should have symlink file" do
+        make_test_symlink        
+        nil.should have_symlink sym_test_file
+      end
+    
+      it "should not have symlink dir" do
+        nil.should_not have_symlink sym_test_dir
+      end
+      
+      it "should have symlink dir" do      
+        make_test_symlink_dir
+        nil.should have_symlink sym_test_dir
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+require 'rspec/autorun'
+require 'file-spec'
+require 'file_spec/file_helper'
+require 'fileutils'

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: file-spec
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-16 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 19
+        version: 2.0.0.beta.19
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: require_all
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id002
+description: RSpec 2 matchers for files, directories and symlinks
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- .rspec
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/file-spec.rb
+- lib/file_spec/file_helper.rb
+- lib/file_spec/matchers/abstract/have_file_item.rb
+- lib/file_spec/matchers/abstract/have_file_items.rb
+- lib/file_spec/matchers/have_dir.rb
+- lib/file_spec/matchers/have_file.rb
+- lib/file_spec/matchers/have_symlink.rb
+- spec/file-spec/matchers/multiple/have_directories_spec.rb
+- spec/file-spec/matchers/multiple/have_files_spec.rb
+- spec/file-spec/matchers/multiple/have_symlinks_spec.rb
+- spec/file-spec/matchers/single/have_directory_spec.rb
+- spec/file-spec/matchers/single/have_file_spec.rb
+- spec/file-spec/matchers/single/have_symlink_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/file-spec
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: RSpec 2 matchers for files, directories and symlinks
+test_files: 
+- spec/file-spec/matchers/multiple/have_directories_spec.rb
+- spec/file-spec/matchers/multiple/have_files_spec.rb
+- spec/file-spec/matchers/multiple/have_symlinks_spec.rb
+- spec/file-spec/matchers/single/have_directory_spec.rb
+- spec/file-spec/matchers/single/have_file_spec.rb
+- spec/file-spec/matchers/single/have_symlink_spec.rb
+- spec/spec_helper.rb