imw 0.1.0

data/spec/imw/files/file_spec.rb

@@ -0,0 +1,144 @@
+#
+# h2. spec/imw/model/files/basicfile_spec.rb -- spec for a file object
+#
+# == About
+#
+# RSpec test code for <tt>IMW::Files::BasicFile</tt>.
+#
+# Author::    (Philip flip Kromer, Dhruv Bansal) for Infinite Monkeywrench Project (mailto:coders@infochimps.org)
+# Copyright:: Copyright (c) 2008 infochimps.org
+# License::   GPL 3.0
+# Website::   http://infinitemonkeywrench.org/
+#
+require File.join(File.dirname(__FILE__),'../../../spec_helper')
+require IMW_SPEC_DIR+'/imw/matchers/file_contents_matcher'
+
+require 'imw/utils/random'
+require 'imw/model/files/basicfile'
+
+describe IMW::Files::BasicFile do
+
+  include Spec::Matchers::IMW
+
+  def create_file
+    IMW::Random.file @path
+  end
+
+  before(:all) do
+    @root_directory = IMW::DIRECTORIES[:dump] + "/file_spec"
+    FileUtils.mkdir @root_directory
+
+    @path = @root_directory + "/file.ext"
+    @copy_of_original_path = @root_directory + "/file_copy.ext"
+
+    @file = IMW::Files::BasicFile.new(@path)
+
+    @new_path_same_extension = @root_directory + "/file_new.ext"
+    @new_path_different_extension = @root_directory + "/file_new.next"
+  end
+
+  after(:each) do
+    FileUtils.rm Dir.glob(@root_directory + "/*")
+  end
+
+  after(:all) do
+    FileUtils.rm_rf @root_directory
+  end
+
+  describe "(attributes)" do
+    it "should have the correct path" do
+      @file.path.should eql(@path)
+    end
+
+    it "should have the correct directory name" do
+      @file.dirname.should eql(@root_directory)
+    end
+
+    it "should have the correct basename" do
+      @file.basename.should eql("file.ext")
+    end
+
+    it "should have the correct extension" do
+      @file.extname.should eql(".ext")
+    end
+
+    it "should have the correct name" do
+      @file.name.should eql("file")
+    end
+    
+  end
+
+  describe "(existence)" do
+    it "should not exist if there is no file matching it on disk" do
+      @file.exist?.should eql(false)
+    end
+
+    it "should exist if there is a file matching it on disk" do
+      create_file
+      @file.exist?.should eql(true)
+    end
+  end
+
+  describe "(deletion)" do
+    it "should raise an error if it tries to delete itself but it doesn't exist" do
+      lambda { @file.rm }.should raise_error(IMW::PathError)
+    end
+
+    it "should delete itself if it it exists on disk" do
+      create_file
+      @file.rm
+      @file.exist?.should eql(false)
+    end
+  end
+
+  describe "(copying)" do
+    it "should raise an error if it tries to copy itself but it doesn't exist" do
+      lambda { @file.cp @new_path_same_extension }.should raise_error(IMW::PathError)
+    end
+
+    it "should copy itself with the same extension" do
+      create_file
+      new_file = @file.cp @new_path_same_extension
+      new_file.path.should have_contents_matching_those_of(@file.path)
+    end
+
+    it "should raise an error if it tries to copy itself with a differing extension without :force" do
+      create_file
+      lambda { @file.cp @new_path_different_extension }.should raise_error(IMW::Error)
+    end
+
+    it "should copy itself with a differing extension with :force" do
+      create_file
+      new_file = @file.cp @new_path_different_extension, :force => true
+      new_file.path.should have_contents_matching_those_of(@file.path)
+    end
+  end
+
+  describe "(moving)" do
+    it "should raise an error if it tries to move itself but it doesn't exist" do
+      lambda { @file.mv @new_path_same_extension }.should raise_error(IMW::PathError)
+    end
+
+    it "should move itself with the same extension" do
+      create_file
+      old_file = @file.cp @copy_of_original_path
+      new_file = @file.mv @new_path_same_extension
+      new_file.path.should have_contents_matching_those_of(old_file.path)
+    end
+
+    it "should raise an error if it tries to move itself with a differing extension without :force" do
+      create_file
+      lambda { @file.mv @new_path_different_extension }.should raise_error(IMW::Error)
+    end
+
+    it "should move itself with a differing extension with :force" do
+      create_file
+      old_file = @file.cp @copy_of_original_path
+      new_file = @file.mv @new_path_different_extension, :force => true
+      new_file.path.should have_contents_matching_those_of(old_file.path)
+    end
+  end
+end
+
+
+# puts "#{File.basename(__FILE__)}: You place the manilla file folder between the rusty teeth of your Monkeywrench and tighten..." # at bottom

data/spec/imw/files/gz_spec.rb

@@ -0,0 +1,32 @@
+#
+# h2. spec/imw/model/files/gz_spec.rb -- spec for gz files
+#
+# == About
+#
+# RSpec code for <tt>IMW::Files::Gz</tt>.
+#
+# Author::    (Philip flip Kromer, Dhruv Bansal) for Infinite Monkeywrench Project (mailto:coders@infochimps.org)
+# Copyright:: Copyright (c) 2008 infochimps.org
+# License::   GPL 3.0
+# Website::   http://infinitemonkeywrench.org/
+#
+require File.join(File.dirname(__FILE__),'../../../spec_helper')
+require IMW_SPEC_DIR+'/imw/model/files/compressed_file_spec'
+
+require 'imw/utils'
+require 'imw/model/files/gz'
+describe IMW::Files::Gz do
+
+  before(:all) do
+    @root_directory = IMW::DIRECTORIES[:dump] + "/gz_spec"
+
+    @path = @root_directory + "/file.txt.gz"
+    @file = IMW::Files::Gz.new(@path)
+
+    @copy_of_original_path = @root_directory + "/file_copy.txt.gz"
+  end
+
+  it_should_behave_like "a compressed file"
+end
+
+# puts "#{File.basename(__FILE__)}: You squeeze yourself and your Monkeywrench through a narrow opening." # at bottom

data/spec/imw/files/rar_spec.rb

@@ -0,0 +1,33 @@
+#
+# h2. test/imw/model/files/rar_spec.rb -- tests of rar file
+#
+# == About
+#
+# RSpec tests for <tt>IMW::Files::Rar</tt> class.
+#
+# Author::    (Philip flip Kromer, Dhruv Bansal) for Infinite Monkeywrench Project (mailto:coders@infochimps.org)
+# Copyright:: Copyright (c) 2008 infochimps.org
+# License::   GPL 3.0
+# Website::   http://infinitemonkeywrench.org/
+#
+require File.join(File.dirname(__FILE__),'../../../spec_helper')
+require IMW_SPEC_DIR+'/imw/model/files/archive_spec'
+
+unless IMW::SpecConfig::SKIP_ARCHIVE_FORMATS.include? :rar
+  require 'imw/model/files/rar'
+  describe IMW::Files::Rar do
+
+    before(:all) do
+      @root_directory = ::IMW::DIRECTORIES[:dump] + "/archive_test"
+      @initial_directory = @root_directory + "/create_and_append/initial"
+      @appending_directory = @root_directory + "/create_and_append/appending"
+      @extraction_directory = ::IMW::DIRECTORIES[:dump] + "/extract"
+      @archive = IMW::Files::Rar.new(@root_directory + "/test.rar")
+    end
+
+    it_should_behave_like "an archive of files"
+
+  end
+end
+
+# puts "#{File.basename(__FILE__)}: You bang your Monkeywrench uselessly on the locked file cabinet." # at bottom

data/spec/imw/files/tar_spec.rb

@@ -0,0 +1,31 @@
+#
+# h2. test/imw/model/files/tar_spec.rb -- tests of tar file
+#
+# == About
+#
+# RSpec tests for <tt>IMW::Files::Tar</tt> class.
+#
+# Author::    (Philip flip Kromer, Dhruv Bansal) for Infinite Monkeywrench Project (mailto:coders@infochimps.org)
+# Copyright:: Copyright (c) 2008 infochimps.org
+# License::   GPL 3.0
+# Website::   http://infinitemonkeywrench.org/
+#
+require File.join(File.dirname(__FILE__),'../../../spec_helper')
+require IMW_SPEC_DIR+'/imw/model/files/archive_spec'
+
+require 'imw/model/files/tar'
+describe IMW::Files::Tar do
+
+  before(:all) do
+    @root_directory = ::IMW::DIRECTORIES[:dump] + "/archive_test"
+    @initial_directory = @root_directory + "/create_and_append/initial"
+    @appending_directory = @root_directory + "/create_and_append/appending"
+    @extraction_directory = ::IMW::DIRECTORIES[:dump] + "/extract"
+    @archive = IMW::Files::Tar.new(@root_directory + "/test.tar")
+  end
+
+  it_should_behave_like "an archive of files"
+
+end
+
+# puts "#{File.basename(__FILE__)}: The tar pits are just /wonderful/ today; really, you should go in for a dip!" # at bottom

data/spec/imw/files/text_spec.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__),'../../spec_helper')
+
+describe IMW::Files::Text do
+
+  before do
+    @path = "foobar.txt"
+    @text = <<EOF
+Here is the first line
+And here is the second
+EOF
+    File.open(@path, 'w') { |f| f.write(@text) }
+  end
+
+  it "should return its entries" do
+    IMW.open(@path).entries.should == ["Here is the first line", "And here is the second"]
+  end
+
+  it "should be able to parse each line" do
+    file = IMW.open(@path)
+    results = file.parse :by_regexp => /^([^\s]+) ([^\s]+)/, :into_fields => [:word1, :word2]
+    file.parser.class.should == IMW::Parsers::RegexpParser
+  end
+end

data/spec/imw/files/zip_spec.rb

@@ -0,0 +1,31 @@
+#
+# h2. test/imw/model/files/zip_spec.rb -- tests of zip file
+#
+# == About
+#
+# RSpec tests for <tt>IMW::Files::Zip</tt> class.
+#
+# Author::    (Philip flip Kromer, Dhruv Bansal) for Infinite Monkeywrench Project (mailto:coders@infochimps.org)
+# Copyright:: Copyright (c) 2008 infochimps.org
+# License::   GPL 3.0
+# Website::   http://infinitemonkeywrench.org/
+#
+require File.join(File.dirname(__FILE__),'../../../spec_helper')
+require IMW_SPEC_DIR+'/imw/model/files/archive_spec'
+
+require 'imw/model/files/zip'
+describe IMW::Files::Zip do
+
+  before(:all) do
+    @root_directory       = ::IMW::DIRECTORIES[:dump] + "/archive_test"
+    @initial_directory    = @root_directory + "/create_and_append/initial"
+    @appending_directory  = @root_directory + "/create_and_append/appending"
+    @extraction_directory = ::IMW::DIRECTORIES[:dump] + "/extract"
+    @archive = IMW::Files::Zip.new(@root_directory + "/test.zip")
+  end
+
+  it_should_behave_like "an archive of files"
+
+end
+
+# puts "#{File.basename(__FILE__)}: No matter how many times you test the integrity of a zipper at the store before you buy something it /will/ break when you take it home!" # at bottom

data/spec/imw/files_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe IMW::Files do
+
+  before do
+    @csv   = "foobar.csv"
+    @weird = "foobar.awefawefawe"
+    @none  = "foobar"
+
+    @files = [@csv, @weird, @none]
+
+    @files.each { |f| IMWTest::Random.file f }
+
+    @new = "newguy.txt"
+  end
+  
+  it "chooses the correct class based upon the extension" do
+    IMW.open(@csv).class.should == IMW::Files::Csv
+  end
+
+  it "uses Text as a default class when there's a weird or no extension" do
+    IMW.open(@weird).class.should == IMW::Files::Text
+    IMW.open(@none).class.should == IMW::Files::Text    
+  end
+
+  it "will use a different class if asked" do
+    IMW.open(@csv, :as => :Text).class.should == IMW::Files::Text
+  end
+  
+  it "can write to a new file" do
+    f = IMW.open!(@new)
+    f.write('whatever')
+    f.close
+    open(@new).read.should == 'whatever'
+  end
+end
+
+  

data/spec/imw/packagers/archiver_spec.rb

@@ -0,0 +1,125 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+describe IMW::Packagers::Archiver do
+  before do
+    @name = 'foobar'
+
+    # regular files
+    @csv  = "foobar-csv.csv"
+    @xml  = "foobar-xml.xml"
+    @txt  = "foobar-txt.txt"
+    @blah = "foobar"
+
+    # compressed files
+    @bz2  = "foobar-bz2.bz2"
+
+    # archives
+    @zip      = "foobar-zip.zip"
+    @tarbz2   = "foobar-tarbz2.tar.bz2"
+    @rar      = "foobar-rar.rar"
+    @archives = [@zip, @tarbz2]
+
+    @files = [@csv, @xml, @txt, @blah, @bz2, @zip, @tarbz2]
+    
+    @files.each do |path|
+      IMWTest::Random.file path
+    end
+  end
+
+
+  describe "when preparing files" do
+    before do
+      @archiver = IMW::Packagers::Archiver.new @name, @files
+      @archiver.prepare!      
+    end
+
+    after do
+      FileUtils.rm_rf @archiver.tmp_dir
+    end
+
+    it "should name its archive directory properly" do
+      @archiver.tmp_dir.should contain(@name)
+    end
+
+    it "should copy regular files to its archive directory" do
+      @archiver.dir.should contain(@csv, @xml, @txt)
+    end
+
+    it "should uncompress compressed files to its archive directory" do
+      @archiver.dir.should     contain('foobar-bz2')
+      @archiver.dir.should_not contain(@bz2)
+    end
+
+    it "should copy the content of archive files to its archive directory (but not the actual archives)" do
+      @archives.each do |archive|
+        @archiver.dir.should_not contain(archive)
+        @archiver.dir.should contain(*IMW.open(archive).contents)
+      end
+    end
+
+    it "should not move any of the original files" do
+      IMWTest::TMP_DIR.should contain(@files)
+    end
+  end
+
+  describe "when preparing files while renaming them" do
+    before do
+
+      # to test renaming, consider the new paths to be the old paths
+      # but with the hyphens mapped to underscores...
+      @renaming_hash = {}
+      @files.each { |f| @renaming_hash[f] = f.gsub(/-/,'_') }
+      
+      @archiver = IMW::Packagers::Archiver.new @name, @renaming_hash
+      @archiver.prepare!
+    end
+
+    after do
+      FileUtils.rm_rf @archiver.tmp_dir
+    end
+
+    it "should copy regular files to its archive directory, renaming them" do
+      @archiver.dir.should_not contain([@csv, @xml, @txt])
+      @archiver.dir.should contain([@csv, @xml, @txt].map { |f| @renaming_hash[f] })
+    end
+
+    it "should uncompress compressed files to its archive directory, renaming them" do
+      @archiver.dir.should     contain('foobar_bz2')
+      @archiver.dir.should_not contain('foobar-bz2')      
+      @archiver.dir.should_not contain(@renaming_hash[@bz2])
+      @archiver.dir.should_not contain(@bz2)
+    end
+  end
+
+  describe "when packaging files" do
+    before do
+      @archiver = IMW::Packagers::Archiver.new @name, @files
+      @archiver.prepare!
+
+      @package_tarbz2 = "package.tar.bz2"
+      @package_zip    = "package.zip"
+      @packages = [@package_tarbz2, @package_zip]
+    end
+
+    after do
+      FileUtils.rm_rf @archiver.tmp_dir
+    end
+
+    it "should create a package file containing the proper files" do
+      @packages.each do |package|
+        @archiver.package! package
+        @archiver.tmp_dir.should contain(IMW.open(package).contents)
+      end
+    end
+
+    it "should return the package file" do
+      @packages.each do |package|
+        output = @archiver.package! package
+        output.basename.should == package
+      end
+    end
+    
+    
+  end
+end
+