rspec-file-transfer-matchers 1.0.0

data/History.txt

@@ -0,0 +1,5 @@
+=== 1.0.0 / 2009-04-06
+
+* 1 major enhancement
+
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,8 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/file_transfer_matchers.rb
+lib/file_transfer_matchers/file_transfer_matchers.rb
+lib/file_transfer_matchers/file_transfer_matcher.rb
+spec/file_transfer_matchers_spec.rb

data/README.rdoc

@@ -0,0 +1,162 @@
+= FileTransferMatchers
+
+* Project: https://rubyforge.org/projects/aef/
+* RDoc: http://aef.rubyforge.org/rspec-file-transfer-matchers/
+* Github: http://github.com/aef/rspec-file-transfer-matchers/
+
+== DESCRIPTION:
+
+FileTransferMatchers are able to verify file movement, copying and deletion in
+RSpec based automated tests.
+
+== FEATURES/PROBLEMS:
+
+* Tested and fully working on:
+  * Ubuntu Linux 8.10 i386_64 (Ruby 1.8.7 and 1.9.1p0)
+  * Debian GNU/Linux 4.0 i386 (Ruby 1.8.6)
+  * On Windows XP i386 (Ruby 1.8.6)
+
+== SYNOPSIS:
+
+Load the gem:
+
+  require 'file_transfer_matchers'
+
+Include the matcher methods into the test case:
+
+  descripe Example do
+    include Aef::FileTransferMatchers
+    ...
+  end
+
+Test file movement:
+
+  it "should move a file" do
+    source = 'abc'
+    target = 'def'
+
+    lamda {
+      FileUtils.mv(source, target)
+    }.should move(source, :to => target)
+  end
+
+Test file copying:
+
+  it "should copy file" do
+    source = 'abc'
+    target = 'def'
+
+    lamda {
+      FileUtils.cp(source, target)
+    }.should copy(source, :to => target)
+  end
+
+Test file deletion:
+
+  it "should delete file" do
+    file = 'abc'
+
+    lamda {
+      FileUtils.rm(file)
+    }.should delete(file)
+  end
+
+If you want to ignore an already existing target for move or copy:
+
+  it "should move a file" do
+    source = 'abc'
+    target = 'def'
+
+    lamda {
+      FileUtils.mv(source, target)
+    }.should move(source, :to => target, :overwrite => true)
+  end
+
+== REQUIREMENTS:
+
+* rspec
+
+=== Additional for automated testing
+* hoe
+
+== INSTALL:
+
+=== Normal
+
+  gem install rspec-file-transfer-matchers
+
+=== High security (recommended)
+
+There is a high security installation option available through rubygems. It is
+highly recommended over the normal installation, although it may be a bit less
+comfortable. To use the installation method, you will need my public key, which
+I use for cryptographic signatures on all my gems. You can find the public key
+and more detailed verification information in the aef-certificates section of my
+rubyforge project[https://rubyforge.org/frs/?group_id=7890&release_id=31749]
+
+Add the key to your rubygems' trusted certificates by the following command:
+
+  gem cert --add aef.pem
+
+Now you can install the gem while automatically verifying it's signature by the
+following command:
+
+  gem install rspec-file-transfer-matchers --ignore-dependencies -P HighSecurity
+
+Please notice that you will need other keys for dependent libraries, so you may
+have to install dependencies manually.
+
+=== Automated testing
+
+You can test this package through rspec on your system. First find the path
+where the gem was installed to:
+
+  gem which rspec-file-transfer-matchers
+
+Go into the root directory of the installed gem and run the following command
+to start the test runner:
+
+  rake spec
+
+On Windows systems you have to run the following instead:
+
+  spec spec/**/*_spec.rb
+
+If something goes wrong you should be noticed through failing examples.
+
+== DEVELOPMENT:
+
+This software is developed in the source code management system git hosted
+at github.com. You can download the most recent sourcecode through the following
+command:
+
+  git clone git://github.com/aef/rspec-file-transfer-matchers.git
+
+Help on making this software better is always very appreciated. If you want your
+changes to be included in the official release, please send me a patch through
+the project's tracker[https://rubyforge.org/tracker/?group_id=7890] at
+rubyforge.org. You can generate a patch-file by the following command:
+
+  git diff > patch.diff
+
+Please make sure to write tests for your changes and notice that I can't promise
+to include your changes before reviewing them.
+
+== LICENSE:
+
+Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+
+This file is part of FileTransferMatchers.
+
+FileTransferMatchers is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/file_transfer_matchers.rb'
+
+Hoe.new('rspec-file-transfer-matchers', Aef::FileTransferMatchers::VERSION) do |p|
+  p.rubyforge_name = 'aef'
+  p.developer('Alexander E. Fischer', 'aef@raxys.net')
+  p.extra_deps = %w{rspec}
+  p.url = 'https://rubyforge.org/projects/aef/'
+  p.readme_file = 'README.rdoc'
+  p.extra_rdoc_files = %w{README.rdoc}
+  p.spec_extras = {
+    :rdoc_options => ['--main', 'README.rdoc', '--inline-source', '--line-numbers', '--title', 'FileTransferMatchers']
+  }
+end
+
+# vim: syntax=Ruby

data/lib/file_transfer_matchers.rb

@@ -0,0 +1,31 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of FileTransferMatchers.
+#
+# FileTransferMatchers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Namespace for projects of Alexander E. Fischer <aef@raxys.net>
+#
+# If you want to be able to simply type Example instead of Aef::Example to
+# address classes in this namespace simply write the following before using the
+# classes:
+#
+#  include Aef
+module Aef
+
+end
+
+libdir = File.dirname(__FILE__)
+require File.join(libdir, 'file_transfer_matchers/file_transfer_matcher')
+require File.join(libdir, 'file_transfer_matchers/file_transfer_matchers')

data/lib/file_transfer_matchers/file_transfer_matcher.rb

@@ -0,0 +1,100 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of FileTransferMatchers.
+#
+# FileTransferMatchers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Aef
+  class FileTransferMatcherError < StandardError; nil end
+  class SourceNotExistentError < FileTransferMatcherError; nil end
+  class TargetAlreadyExistentError < FileTransferMatcherError; nil end
+  class TargetNotExistentError < FileTransferMatcherError; nil end
+  class SourceStillExistentError < FileTransferMatcherError; nil end
+
+  class FileTransferMatcher
+    def initialize(from, options)
+      @from = from
+      @to = options[:to]
+      @copy_mode = options[:copy_mode]
+      @overwrite = options[:overwrite]
+
+      raise 'A target must be given in copy mode' if @copy_mode and not @to
+    end
+
+    def matches?(event_proc)
+      raise_block_syntax_error if block_given?
+
+      raise SourceNotExistentError unless File.exist?(@from)
+      raise TargetAlreadyExistentError if @to and File.exist?(@to) and not @overwrite
+
+      event_proc.call
+
+      raise TargetNotExistentError if @to and not File.exist?(@to)
+      raise SourceStillExistentError if not @copy_mode and File.exist?(@from)
+
+      true
+    rescue FileTransferMatcherError
+      @error = $!
+      false
+    end
+
+    def raise_block_syntax_error
+      raise MatcherError.new(<<-MESSAGE
+  block passed to should or should_not move/copy/delete must use {} instead of do/end
+        MESSAGE
+      )
+    end
+
+    def failure_message
+      case @error
+      when SourceNotExistentError
+        if @copy_mode
+          "File #{@from} could not be copied, as it does not exist"
+        elsif @to
+          "File #{@from} could not be moved, as it does not exist"
+        else
+          "File #{@from} could not be deleted, as it does not exist"
+        end
+      when TargetAlreadyExistentError
+        if @copy_mode
+          "File #{@from} could not be copied, as target #{@to} already exists"
+        else
+          "File #{@from} could not be moved, as target #{@to} already exists"
+        end
+      when TargetNotExistentError
+        if @copy_mode
+          "File #{@from} should have been copied to #{@to}, but target wasn't created"
+        else
+          "File #{@from} should have been moved to #{@to}, but target wasn't created"
+        end
+      when SourceStillExistentError
+        if @to
+          "File #{@from} should have been moved, but source file still exists"
+        else
+          "File #{@from} should have been deleted, but source file still exists"
+        end
+      end
+    end
+
+    def negative_failure_message
+      if @copy_mode
+        "File #{@from} was copied to #{@to}"
+      elsif @to
+        "File #{@from} was moved to #{@to}"
+      else
+        "File #{@from} was deleted"
+      end
+    end
+  end
+end

data/lib/file_transfer_matchers/file_transfer_matchers.rb

@@ -0,0 +1,34 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of FileTransferMatchers.
+#
+# FileTransferMatchers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Aef::FileTransferMatchers
+  VERSION = '1.0.0'
+
+  def move(from, options = {}, &block)
+    options[:copy_mode] = false
+    Aef::FileTransferMatcher.new(from, options, &block)
+  end
+
+  def copy(from, options = {}, &block)
+    options[:copy_mode] = true
+    Aef::FileTransferMatcher.new(from, options, &block)
+  end
+
+  def delete(file, &block)
+    Aef::FileTransferMatcher.new(file, :copy_mode => false, &block)
+  end
+end

data/spec/file_transfer_matchers_spec.rb

@@ -0,0 +1,247 @@
+# Copyright 2009 Alexander E. Fischer <aef@raxys.net>
+#
+# This file is part of FileTransferMatchers.
+#
+# FileTransferMatchers is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'fileutils'
+require 'tmpdir'
+
+require 'lib/file_transfer_matchers'
+
+describe Aef::FileTransferMatchers do
+  include Aef::FileTransferMatchers
+
+  before(:each) do
+    # Before ruby 1.8.7, the tmpdir standard library had no method to create
+    # a temporary directory (mktmpdir).
+    if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.8.7')
+      @folder_path = File.join(Dir.tmpdir, 'file_transfer_matcher_spec')
+      Dir.mkdir(@folder_path)
+    else
+      @folder_path = Dir.mktmpdir('file_transfer_matcher_spec')
+    end
+  end
+
+  after(:each) do
+    FileUtils.rm_rf(@folder_path)
+  end
+
+  it "should positively recognize a file deletion" do
+    file = File.join(@folder_path, 'toDelete')
+
+    FileUtils.touch(file)
+
+    action = lambda {
+      FileUtils.rm(file)
+    }
+    
+    matcher = delete(file)
+    matcher.matches?(action).should be_true
+    matcher.negative_failure_message.should eql(
+      "File #{file} was deleted")
+
+  end
+
+  it "should positively recognize a file movement" do
+    file = File.join(@folder_path, 'toMove')
+    target = file + '.bak'
+
+    FileUtils.touch(file)
+
+    action = lambda {
+      FileUtils.mv(file, target)
+    }
+    
+    matcher = move(file, :to => target)
+    matcher.matches?(action).should be_true
+    matcher.negative_failure_message.should eql(
+      "File #{file} was moved to #{target}")
+  end
+
+  it "should positively recognize a file copying" do
+    file = File.join(@folder_path, 'toCopy')
+    target = file + '.bak'
+
+    FileUtils.touch(file)
+
+    action = lambda {
+      FileUtils.cp(file, target)
+    }
+    
+    matcher = copy(file, :to => target)
+    matcher.matches?(action).should be_true
+    matcher.negative_failure_message.should eql(
+      "File #{file} was copied to #{target}")
+  end
+
+  it "should negatively recognize a failed file deletion" do
+    file = File.join(@folder_path, 'toDelete')
+
+    action = lambda {}
+    
+    matcher = delete(file)
+    matcher.matches?(action).should be_false
+    matcher.failure_message.should eql(
+      "File #{file} could not be deleted, as it does not exist")
+  end
+
+  it "should negatively recognize if a move source is not existent" do
+    file = File.join(@folder_path, 'toMove')
+    target = file + '.bak'
+
+    action = lambda {}
+    
+    matcher = move(file, :to => target)
+    matcher.matches?(action).should be_false
+    matcher.failure_message.should eql(
+      "File #{file} could not be moved, as it does not exist")
+  end
+
+  it "should negatively recognize if a copy source is not existent" do
+    file = File.join(@folder_path, 'toCopy')
+    target = file + '.bak'
+
+    action = lambda {}
+    
+    matcher = copy(file, :to => target)
+    matcher.matches?(action).should be_false
+    matcher.failure_message.should eql(
+      "File #{file} could not be copied, as it does not exist")
+  end
+
+  it "should negativly recognize if a move target already exists" do
+    file = File.join(@folder_path, 'toMove')
+    target = file + '.bak'
+
+    FileUtils.touch(file)
+    FileUtils.touch(target)
+
+    action = lambda {
+      FileUtils.mv(file, target)
+    }
+
+    matcher = move(file, :to => target)
+    matcher.matches?(action).should be_false
+    matcher.failure_message.should eql(
+      "File #{file} could not be moved, as target #{target} already exists")
+  end
+
+  it "should positively recognize if a move target already exists but overwrite is active" do
+    file = File.join(@folder_path, 'toMove')
+    target = file + '.bak'
+
+    FileUtils.touch(file)
+    FileUtils.touch(target)
+
+    action = lambda {
+      FileUtils.mv(file, target)
+    }
+
+    matcher = move(file, :to => target, :overwrite => true)
+    matcher.matches?(action).should be_true
+  end
+
+  it "should negativly recognize if a copy target already exists" do
+    file = File.join(@folder_path, 'toCopy')
+    target = file + '.bak'
+
+    FileUtils.touch(file)
+    FileUtils.touch(target)
+
+    action = lambda {
+      FileUtils.cp(file, target)
+    }
+
+    matcher = copy(file, :to => target)
+    matcher.matches?(action).should be_false
+    matcher.failure_message.should eql(
+      "File #{file} could not be copied, as target #{target} already exists")
+  end
+
+  it "should positively recognize if a copy target already exists but overwrite is active" do
+    file = File.join(@folder_path, 'toCopy')
+    target = file + '.bak'
+
+    FileUtils.touch(file)
+    FileUtils.touch(target)
+
+    action = lambda {
+      FileUtils.cp(file, target)
+    }
+
+    matcher = copy(file, :to => target, :overwrite => true)
+    matcher.matches?(action).should be_true
+  end
+
+  it "should negatively recognize if a move target doesn't get created" do
+    file = File.join(@folder_path, 'toMove')
+    target = file + '.bak'
+
+    FileUtils.touch(file)
+
+    action = lambda {}
+
+    matcher = move(file, :to => target)
+    matcher.matches?(action).should be_false
+    matcher.failure_message.should eql(
+      "File #{file} should have been moved to #{target}, but target wasn't created")
+  end
+
+  it "should negatively recognize if a copy target doesn't get created" do
+    file = File.join(@folder_path, 'toCopy')
+    target = file + '.bak'
+
+    FileUtils.touch(file)
+
+    action = lambda {}
+
+    matcher = copy(file, :to => target)
+    matcher.matches?(action).should be_false
+    matcher.failure_message.should eql(
+      "File #{file} should have been copied to #{target}, but target wasn't created")
+  end
+
+  it "should negatively recognize if a move source doesn't get deleted" do
+    file = File.join(@folder_path, 'toCopy')
+    target = file + '.bak'
+
+    FileUtils.touch(file)
+
+    action = lambda {
+      FileUtils.cp(file, target)
+    }
+
+    matcher = move(file, :to => target)
+    matcher.matches?(action).should be_false
+    matcher.failure_message.should eql(
+      "File #{file} should have been moved, but source file still exists")
+  end
+
+  it "should negatively recognize if a file doesn't get deleted" do
+    file = File.join(@folder_path, 'toCopy')
+    target = file + '.bak'
+
+    FileUtils.touch(file)
+
+    action = lambda {
+      FileUtils.cp(file, target)
+    }
+
+    matcher = delete(file)
+    matcher.matches?(action).should be_false
+    matcher.failure_message.should eql(
+      "File #{file} should have been deleted, but source file still exists")
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: rspec-file-transfer-matchers
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Alexander E. Fischer
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDKDCCAhCgAwIBAgIBADANBgkqhkiG9w0BAQUFADA6MQwwCgYDVQQDDANhZWYx
+  FTATBgoJkiaJk/IsZAEZFgVyYXh5czETMBEGCgmSJomT8ixkARkWA25ldDAeFw0w
+  OTAyMjUyMDM5MDhaFw0xMDAyMjUyMDM5MDhaMDoxDDAKBgNVBAMMA2FlZjEVMBMG
+  CgmSJomT8ixkARkWBXJheHlzMRMwEQYKCZImiZPyLGQBGRYDbmV0MIIBIjANBgkq
+  hkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoYtj0qad5/MpbdttITzBH0h1SNe6eO7R
+  7qVeqNYu6qDQAQ0rYc0JhubJCWYrZEJorHEBhUFU6cdQgQOs78wiJaDgkeU7YfXB
+  q2l125kJ8aHkA1ukrK2/DRzp2AHEmzxHIYpXV5/63h+NWjCP+uKvTELYsotS2MKt
+  3d43E0QajsPZu2ZuNFwkroqeue872gMHUldGOVy5WtSd9ajw2xI/CociY6746dL+
+  pYriV3QaYtR/ezeaLpKBLsc5T1UQ07t7Xs7mI281tdmRvpLdP5dQhjzInfio0CJv
+  1Pf5bZUjGG0K9RW2Gb/tGPSYEETiLMubjH61OwBooXKiWR5cs4/1BQIDAQABozkw
+  NzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUSYvjhG2EWnR5kx5l
+  DAewXCkJOVEwDQYJKoZIhvcNAQEFBQADggEBAB2ryDbU4bQtnunKv/AXq4CuO3LS
+  kik9Xhye8E/5dTcsgitCZJXAqx0rHcK0u2EHnjA5CDcdF5JB7XgSvRrQkFWoW/9K
+  lCB4ih+sB2AI2IUiYBeoCGctXdBQ020prqop/oTQEudzFk/gyQ686lp06HdLRt+O
+  HoQjTIab8vmfgIubjPdIRzokMfHbelvhLi+mQfWVghRhs2jpEfdXbL0w5nNw+trp
+  rO70Dw59hduDUOpgpxew+PLbs4vP1tb1QKPG+39C+PZtosbbf1fai0hqYV1txMCx
+  55akF+N8NbO6tpVDy6TMagqa10LfEpiQH6dvDHe/xdAqYOCrXKpmqzwu2PI=
+  -----END CERTIFICATE-----
+
+date: 2009-04-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.12.1
+    version: 
+description: FileTransferMatchers are able to verify file movement, copying and deletion in RSpec based automated tests.
+email: 
+- aef@raxys.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/file_transfer_matchers.rb
+- lib/file_transfer_matchers/file_transfer_matchers.rb
+- lib/file_transfer_matchers/file_transfer_matcher.rb
+- spec/file_transfer_matchers_spec.rb
+has_rdoc: true
+homepage: https://rubyforge.org/projects/aef/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --inline-source
+- --line-numbers
+- --title
+- FileTransferMatchers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: aef
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: FileTransferMatchers are able to verify file movement, copying and deletion in RSpec based automated tests.
+test_files: []
+