imw 0.1.0

data/spec/imw/dataset/datamapper/uri_spec.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__),'../../../spec_helper')
+require File.join(File.dirname(__FILE__),'../datamapper_spec_helper')
+include IMW
+require 'imw/dataset/datamapper/uri'
+
+if IMW::SpecConfig::TEST_WITH_DATAMAPPER
+  IMW::SpecConfig.setup_datamapper_test_db
+  describe IMW do
+    
+    before(:each) do
+      DM_URI.all.each do |u| u.destroy  end
+    end
+
+    it "makes a URI from a barely complete string" do
+      DM_URI.find_or_create_from_url('google.com')
+      u = DM_URI.first
+      u.should_not be_nil
+      u.host.should == 'google.com'
+    end
+
+    it "behaves as normalized" do
+      DM_URI.find_or_create_from_url('google.com')
+      u = DM_URI.first
+      u.path.should   == '/'
+      u.scheme.should == 'http'
+      u.port.should   be_nil
+    end
+
+    it "makes a complicated URI from a complicated string" do
+      DM_URI.find_or_create_from_url('http://me:and@your.mom.com:69/what?orly=yarly&ok=then')
+      dm_uri = DM_URI.first({
+          :scheme => 'http', :host => 'your.mom.com', :port => '69',
+          :query => 'what?orly=yarly&ok=then'
+        })
+    end
+
+    # it converts to a file path
+    # it doesn't leave a trailing / on the file path
+    # it escapes unicode URLs
+    # it escapes non-URL chars in URL
+  end
+
+end

data/spec/imw/dataset/datamapper_spec_helper.rb

@@ -0,0 +1,11 @@
+require 'imw/dataset/datamapper'
+
+module IMW::SpecConfig
+
+  def self.setup_datamapper_test_db
+    IMW::Dataset.setup_remote_connection IMW::DEFAULT_DATABASE_CONNECTION_PARAMS.merge({
+        :dbname => 'imw_dataset_datamapper_test' })
+    DataMapper.auto_migrate!
+  end
+
+end

data/spec/imw/files/archive_spec.rb

@@ -0,0 +1,118 @@
+#
+# h2. spec/imw/model/files/archive_spec.rb -- module for use in testing various archive formats
+#
+# == About
+#
+# The <tt>IMW::Files::Archive</tt> module doesn't implement any
+# functionality of its own but merely adds methods to an including
+# class.  Appropriately, this spec file implements a shared example
+# group ("an archive of files")  which can be including
+# by the spec of an archive class.  This spec must also define the
+# following instance variables:
+#
+# <tt>@archive</tt>:: a subclass of <tt>IMW::Files::BasicFile</tt> which
+# has the <tt>IMW::Files::Archive</tt> module mixed in.
+#
+# <tt>@root_directory</tt>: a string specifying the path where all the
+# files will be created
+#
+# <tt>@initial_directory</tt>: a string specifying the path where some
+# files for the initial creation of the archive will be created.
+#
+# <tt>@appending_directory</tt>: a string specifying the path where
+# all some files for appending to the archive will be created.
+#
+# <tt>@extraction_directory</tt>: a string specifying the path where
+# the archive's files will be extracted.
+#
+# 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/archive_contents_matcher'
+require IMW_SPEC_DIR+'/imw/matchers/directory_contents_matcher'
+
+require 'imw/utils/random'
+require 'imw/utils/extensions/find'
+share_examples_for "an archive of files" do
+  include Spec::Matchers::IMW
+
+  def create_random_files
+    IMW::Random.directory_with_files(@initial_directory)
+    IMW::Random.directory_with_files(@appending_directory)
+    FileUtils.mkdir(@extraction_directory)
+  end
+
+  def delete_random_files
+    FileUtils.rm_rf [@root_directory,@extraction_directory]
+  end
+
+  before(:each) do
+    create_random_files
+  end
+
+  after(:each) do
+    delete_random_files
+    FileUtils.rm(@archive.path) if @archive.exist?
+  end
+
+  describe "(listing)" do
+    it "should raise an error when listing a non-existent archive" do
+      lambda { @archive.contents }.should raise_error(IMW::Error)
+    end
+  end
+
+  describe "(creation)" do
+
+    it "should be able to create archives which match a directory's structure" do
+      @archive.create(@initial_directory + "/*")
+      @archive.should contain_paths_like(@initial_directory, :relative_to => @root_directory)
+    end
+
+    it "should raise an error if trying to overwrite an archive without the :force option" do
+      @archive.create(@initial_directory + "/*")
+      lambda { @archive.create(@initial_directory + "/*") }.should raise_error(IMW::Error)
+    end
+
+    it "should overwrite an archive if the :force option is given" do
+      @archive.create(@initial_directory + "/*")
+      @archive.create(@initial_directory + "/*", :force => true)
+      @archive.should contain_paths_like(@initial_directory, :relative_to => @root_directory)
+    end
+  end
+
+  describe "(appending)" do
+
+    it "should append to an archive which already exists" do
+      @archive.create(@initial_directory + "/*")
+      @archive.append(@appending_directory + "/*")
+      @archive.should contain_paths_like([@initial_directory,@appending_directory], :relative_to => @root_directory)
+    end
+
+    it "should append to an archive which doesn't already exist" do
+      @archive.append(@appending_directory + "/*")
+      @archive.should contain_paths_like(@appending_directory, :relative_to => @root_directory)
+    end
+
+  end
+
+  describe "(extracting)" do
+
+    it "should raise an error when trying to extract from a non-existing archive" do
+      lambda { @archive.extract }.should raise_error(IMW::Error)
+    end
+
+    it "should extract files which match the original ones it archived" do
+      @archive.create(@initial_directory + "/*")
+      @archive.append(@appending_directory + "/*")
+      new_archive = @archive.cp(@extraction_directory + '/' + @archive.basename)
+      new_archive.extract
+      @extraction_directory.should contain_files_matching_directory(@root_directory)
+    end
+
+  end
+end unless defined? IMW_FILES_ARCHIVE_SHARED_SPEC
+
+# puts "#{File.basename(__FILE__)}: How many drunken frat boys can fit in an Internet kiosk?" # at bottom

data/spec/imw/files/basicfile_spec.rb

@@ -0,0 +1,121 @@
+require File.dirname(__FILE__) + "/../../spec_helper"
+
+require "imw"
+
+describe IMW::Files::BasicFile do
+
+  describe "a local file" do
+    before do
+      @path = "foobar.txt"
+      IMWTest::Random.file @path
+      @file = IMW.open(@path)
+      
+      @new_path = "foobar2.txt"
+
+      @new_dir = "bazbaz"
+      FileUtils.mkdir_p(@new_dir)
+    end
+
+    it "should now that it's local" do
+      @file.local?.should be_true
+      @file.remote?.should be_false
+    end
+
+    it "knows the parts of its URI" do
+      @file.host.should == nil
+      @file.path.should == File.join(IMWTest::TMP_DIR, @path)
+      @file.dirname.should == IMWTest::TMP_DIR
+      @file.basename.should == @path
+      @file.extname.should == ".txt"
+      @file.name.should == "foobar"
+    end
+
+    it "can copy a file" do
+      @file.cp(@new_path)
+      @path.should exist
+      @new_path.should exist
+    end
+
+    it "can move a file" do
+      @file.mv(@new_path)
+      @path.should_not exist
+      @new_path.should exist
+    end
+
+    it "can delete a file" do
+      @file.rm!
+      @path.should_not exist
+    end
+
+    it "can copy to a directory" do
+      @file.cp_to_dir(@new_dir)
+      @new_dir.should contain(@path)
+      @path.should exist      
+    end
+
+    it "can move to a directory" do
+      @file.mv_to_dir(@new_dir)
+      @new_dir.should contain(@path)
+      @path.should_not exist
+    end
+
+    [:executable?, :executable_real?, :file?, :directory?, :ftype, :owned?, :pipe?, :readable?, :readable_real?, :setgid?, :setuid?, :size, :size?, :socket?, :split, :stat, :sticky?, :writable?, :writable_real?, :zero?].each do |method|
+      it "should respond to #{method}" do
+        @file.send(method).should == File.send(method, @file.path)
+      end
+    end
+  end
+
+
+  describe "a remote file" do
+    before do
+      @path = "http://www.google.com"      
+      @file = IMW.open(@path)
+      
+      @new_path = "foobar2.txt"
+
+      @new_dir = "bazbaz"
+      FileUtils.mkdir_p(@new_dir)
+      
+    end
+
+    it "should know that it's remote" do
+      @file.local?.should be_false
+      @file.remote?.should be_true
+    end
+
+    it "knows the parts of its URI" do
+      @file.host.should == "www.google.com"
+      @file.path.should == ''
+      @file.dirname.should == '.'
+      @file.basename.should == ''
+      @file.extname.should == ''
+      @file.name.should == ''
+    end
+
+    it "can open the file" do
+      @file.should be
+      @file.class.should == IMW::Files::Text      
+    end
+
+    it "should raise an error when trying to write" do
+      lambda { IMW.open!(@path) }.should raise_error
+    end
+
+    it "can copy a file" do
+      @file.cp(@new_path)
+      @new_path.should exist
+    end
+
+    it "can move a file" do
+      @file.mv(@new_path)
+      @new_path.should exist
+    end
+
+    it "should raise an error when trying to remove" do
+      lambda { @file.rm }.should raise_error
+    end
+  end
+end
+
+  

data/spec/imw/files/bz2_spec.rb

@@ -0,0 +1,32 @@
+#
+# h2. spec/imw/model/files/bz2_spec.rb -- spec for bz2 files
+#
+# == About
+#
+# RSpec code for <tt>IMW::Files::Bz2</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/model/files/bz2'
+describe IMW::Files::Bz2 do
+
+  before(:all) do
+    @root_directory = IMW::DIRECTORIES[:dump] + "/bz2_spec"
+
+    @path = @root_directory + "/file.txt.bz2"
+    @file = IMW::Files::Bz2.new(@path)
+
+    @copy_of_original_path = @root_directory + "/file_copy.txt.bz2"
+  end
+
+  it_should_behave_like "a compressed file"
+end
+
+# puts "#{File.basename(__FILE__)}: You squeeze yourself and your Monkeywrench through a narrow opening, twice." # at bottom
+

data/spec/imw/files/compressed_file_spec.rb

@@ -0,0 +1,96 @@
+#
+# h2. spec/imw/model/files/compressed_file_spec.rb -- shared specs for compressed files
+#
+# == About
+#
+# Defines a shared spec ("a compressed file") for inclusion in specs
+# for classes which subclass <tt>IMW::Files::CompressedFile</tt>.
+#
+# An including spec must define the following instance variables:
+#
+# <tt>@root_directory</tt>:: directory inside which all files will be
+# created
+#
+# <tt>@file</tt>:: the file to be decompressed
+#
+# <tt>@copy_of_original_path</tt>:: path where a copy of
+# <tt>@file</tt> can be put during testing
+#
+# An including spec can also optionally redefine the
+# +create_compressed_file+ method to create the proper file during
+# each example.
+#
+# 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/text'
+share_examples_for "a compressed file" do
+
+  include Spec::Matchers::IMW
+
+  def create_compressed_file
+    text_file_path = @root_directory + "/sample.txt"
+    IMW::Random.file text_file_path
+    text_file = IMW::Files::Text.new(text_file_path)
+    compressed_text_file = text_file.compress! @file.compression[:program]
+    compressed_text_file.mv @file.path
+  end
+
+  describe "when decompressing" do
+
+    before(:each) do
+      FileUtils.mkdir_p @root_directory
+    end
+
+    after(:each) do
+      FileUtils.rm_rf @root_directory
+    end
+
+    describe "and discarding original file" do
+
+      it "should raise an error if the compressed file doesn't exist" do
+        lambda {@file.decompress! }.should raise_error(IMW::PathError)
+      end
+
+      it "should decompress a compressed file which exists" do
+        create_compressed_file
+        decompressed_file = @file.decompress!
+        decompressed_file.exist?.should eql(true)
+      end
+
+      it "should not exist after decompression" do
+        create_compressed_file
+        decompressed_file = @file.decompress!
+        @file.exist?.should eql(false)
+      end
+    end
+
+    describe "and keeping original file" do
+
+      it "should raise an error if the compressed file doesn't exist" do
+        lambda {@file.decompress }.should raise_error(IMW::PathError)
+      end
+
+      it "should decompress a compressed file which exists" do
+        create_compressed_file
+        decompressed_file = @file.decompress
+        decompressed_file.exist?.should eql(true)
+      end
+
+      it "should be identical to how it was before decompression" do
+        create_compressed_file
+        @file.cp @copy_of_original_path
+        decompressed_file = @file.decompress
+        @copy_of_original_path.should have_contents_matching_those_of(@file.path)
+      end
+    end
+  end
+end  unless defined? IMW_FILES_COMPRESSEDFILE_SHARED_SPEC
+
+# puts "#{File.basename(__FILE__)}: You whack the cabinet with your Monkeywrench sending files and papers everywhere.  You smile." # at bottom

data/spec/imw/files/compressible_spec.rb

@@ -0,0 +1,100 @@
+#
+# h2. spec/imw/model/files/compressible_spec.rb -- spec for compressible module
+#
+# == About
+#
+# Defines shared example groups ("a file compressible by bzip2", "a
+# file compressible by gzip") for the
+# <tt>IMW::Files::Compressible</tt> module to be included in specs for
+# classes which mixin the <tt>IMW::Files::Compressible</tt> module.
+# The specs for these classes should define, for each example, the
+# following instance variables:
+#
+# <tt>@file</tt>:: an object to be compressed which is a subclass of
+# <tt>IMW::Files::BasicFile</tt>.
+#
+# <tt>@copy_of_original_path</tt>:: a string giving a path where a
+# copy of <tt>@file</tt> can be made for comparison purposes.
+#
+# The including spec should also define a method +create_file+ for
+# creating a real file at the path corresponding to <tt>@file</tt>.
+#
+# The including spec must handle the +before+ and +after+ clauses for
+# the creation and removal of files and directories; this spec doesn't
+# handle those details.
+#
+# 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/directory_contents_matcher'
+require IMW_SPEC_DIR+'/imw/matchers/file_contents_matcher'
+require 'imw/utils/random'
+
+share_examples_for "a file compressible by bzip2" do
+
+  describe "when compressing with bzip2" do
+    before(:each) do
+      @program = :bzip2
+    end
+
+    it_should_behave_like "a file compressible by a given program"
+  end
+end
+
+share_examples_for "a file compressible by gzip" do
+  describe "when compressing with gzip" do
+    before(:each) do
+      @program = :gzip
+    end
+
+    it_should_behave_like "a file compressible by a given program"
+  end
+end
+
+share_examples_for "a file compressible by a given program" do
+
+  include Spec::Matchers::IMW
+
+  describe "and discarding original file" do
+
+    it "should raise an error when compressing a non-existing file" do
+      lambda { @file.compress! @program }.should raise_error(IMW::PathError)
+    end
+
+    it "should compress itself to the correct path" do
+      create_file
+      compressed_file = @file.compress! @program
+      compressed_file.exist?.should eql(true)
+    end
+
+    it "should not exist after compressing itself" do
+      create_file
+      compressed_file = @file.compress! @program
+      @file.exist?.should eql(false)
+    end
+  end
+
+  describe "and keeping original file" do
+    it "should raise an error when compressing a non-existing file" do
+      lambda { @file.compress @program }.should raise_error(IMW::PathError)
+    end
+
+    it "should compress itself to the correct path" do
+      create_file
+      compressed_file = @file.compress @program
+      compressed_file.exist?.should eql(true)
+    end
+
+    it "should be identical to the way it was before it was compressed" do
+      create_file
+      @file.cp @copy_of_original_path
+      compressed_file = @file.compress @program
+      @file.path.should have_contents_matching_those_of(@copy_of_original_path)
+    end
+  end
+end
+
+# puts "#{File.basename(__FILE__)}: Is it squishy?  Give it a squeeze and see!" # at bottom