imw 0.1.1 → 0.2.0

data/spec/imw/resource_spec.rb

@@ -0,0 +1,79 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe IMW::Resource do
+
+  describe "handling missing methods" do
+    before do
+      @resource = IMW::Resource.new('/home/foof.txt', :skip_modules => true)
+    end
+
+    it "should return false when querying with a method that isn't defined" do
+      @resource.is_remote?.should be_false
+    end
+
+    it "should raise an IMW::NoMethodError in any other case" do
+      lambda { @resource.do_seomthing }.should raise_error(IMW::NoMethodError)
+    end
+
+    it "should print the modules it's been extended by when raising an IMW::NoMethodError" do
+      begin
+        @resource.extend(IMW::Resources::LocalObj)
+        @resource.do_something
+      rescue IMW::NoMethodError => e
+        e.message.should match(/extended by IMW::Resources::LocalObj/)
+      end
+    end
+  end
+
+  describe "parsing various and sundry URIs should correctly parse a" do
+    
+    before do
+      IMW::Resources.should_receive(:extend_resource!).with(an_instance_of(IMW::Resource))
+    end
+
+    it "local file path" do
+      resource = IMW::Resource.new("/home/foo.txt")
+      resource.stub!(:path).and_return("/home/foo.txt")
+
+      resource.scheme.should    be_nil
+      resource.dirname.should   == '/home'
+      resource.basename.should  == 'foo.txt'
+      resource.extname.should   == '.txt'
+      resource.extension.should == 'txt'
+      resource.name.should      == 'foo'
+    end
+
+    it "local file path with spaces in the name" do
+      resource = IMW::Resource.new("/home/foo bar.txt")
+      resource.stub!(:path).and_return("/home/foo bar.txt")
+      resource.name.should == 'foo bar'
+    end
+
+    it "local file path with an explicit file:// scheme" do
+      resource = IMW::Resource.new("file:///home/foo.txt")
+      resource.scheme.should == 'file'
+    end
+
+    it "web URL with query and fragment" do
+      resource = IMW::Resource.new("http://mysite.com/some/page?param=value#frag")
+      resource.stub!(:path).and_return("/some/page")
+      resource.scheme.should        == 'http'
+      resource.dirname.should       == '/some'
+      resource.basename.should      == 'page'
+      resource.extname.should       == ''
+      resource.extension.should     == ''
+      resource.name.should          == 'page'
+    end
+
+  end
+
+  it "should open a URI without attempting to extend with modules if so asked" do
+    IMW::Resources.should_not_receive(:extend_resource!)
+    IMW::Resource.new("/path/to/some/file.txt", :skip_modules => true)
+  end
+   
+end
+
+
+
+

data/spec/imw/resources/archive_spec.rb

@@ -0,0 +1,69 @@
+require File.join(File.dirname(__FILE__),'../../spec_helper')
+
+# To use this shared example group define instance variables
+# <tt>@extension</tt> and <tt>@cannot_append</tt> in your tests:
+#
+#   @cannot_append = true
+#   before do
+#     # Notice that there is NO leading '.'
+#     @extension = 'tar.bz2'
+#   end
+#
+#   it_should_behave_like "an archive of files"
+#
+# The <tt>@extension</tt> should correspond to an IMW::Resources
+# module with a registered handler.
+#
+# If <tt>@cannot_append</tt> evaluates to true then the specs for
+# appending to files will check for an error (this is because one
+# typically cannot append to compressed archives).  This instance
+# variable should be defined OUTSIDE a before block.
+
+share_examples_for "an archive of files" do
+  include Spec::Matchers::IMW
+
+  before do
+    @root = File.join(IMWTest::TMP_DIR, 'an_archive_of_files_shared_example_group')
+    @initial_directory    = 'initial'
+    @appending_directory  = 'appending'
+    @extraction_directory = 'extraction'
+    FileUtils.mkdir_p(@root)
+    FileUtils.cd(@root)
+    IMWTest::Random.directory_with_files(@initial_directory)
+    IMWTest::Random.directory_with_files(@appending_directory)
+    FileUtils.mkdir(@extraction_directory)
+    @archive = IMW::Resource.new("archive.#{@extension}") # define @extension in another spec
+  end
+
+  it "can create an archive" do
+    @archive.create(*Dir[@initial_directory + '/**/*'])
+    @archive.should contain_paths_like(@initial_directory, :relative_to => @root)
+  end
+
+  if @cannot_append
+    it "cannot append to an archive which already exists" do
+      @archive.create(*Dir[@initial_directory + "/**/*"])
+      lambda { @archive.append(*Dir[@appending_directory + "/**/*"]) }.should raise_error(IMW::Error)
+    end
+  else
+    it "can append to an archive which already exists" do
+      @archive.create(*Dir[@initial_directory + "/**/*"])
+      @archive.append(*Dir[@appending_directory + "/**/*"])
+      @archive.should contain_paths_like([@initial_directory,@appending_directory], :relative_to => @root)
+    end
+    
+    it "can append to an archive which doesn't already exist" do
+      @archive.append(*Dir[@appending_directory + "/**/*"])    
+      @archive.should contain_paths_like(@appending_directory, :relative_to => @root)
+    end
+  end
+
+  it "can extract files which match the original ones it archived" do
+    @archive.create(*Dir[@initial_directory + "/**/*"])
+    FileUtils.cd @extraction_directory do
+      @archive.extract
+    end
+    @initial_directory.should contain_paths_like(@extraction_directory, :given_base => File.join(@root, @extraction_directory, @initial_directory), :to_match_base => File.join(@root, @initial_directory))
+  end
+
+end

data/spec/imw/resources/archives_and_compressed/bz2_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/../../../spec_helper"
+require File.dirname(__FILE__) + "/../compressed_file_spec"
+
+describe IMW::Resources::CompressedFiles::Bz2 do
+  
+  before do
+    @extension = 'bz2'
+  end
+
+  it_should_behave_like 'a compressed file'
+end
+
+
+
+

data/spec/imw/resources/archives_and_compressed/gz_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/../../../spec_helper"
+require File.dirname(__FILE__) + "/../compressed_file_spec"
+
+describe IMW::Resources::CompressedFiles::Gz do
+  
+  before do
+    @extension = 'gz'
+  end
+
+  it_should_behave_like 'a compressed file'
+end
+
+
+
+

data/spec/imw/resources/archives_and_compressed/rar_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + "/../../../spec_helper"
+require File.dirname(__FILE__) + "/../archive_spec"
+
+describe IMW::Resources::Archives::Rar do
+  
+  before do
+    @extension = 'rar'
+  end
+
+  it_should_behave_like 'an archive of files'
+
+end
+
+
+
+

data/spec/imw/resources/archives_and_compressed/tar_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + "/../../../spec_helper"
+require File.dirname(__FILE__) + "/../archive_spec"
+
+describe IMW::Resources::Archives::Tar do
+  
+  before do
+    @extension = 'tar'
+  end
+
+  it_should_behave_like 'an archive of files'
+
+end
+
+
+
+

data/spec/imw/resources/archives_and_compressed/tarbz2_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + "/../../../spec_helper"
+require File.dirname(__FILE__) + "/../archive_spec"
+require File.dirname(__FILE__) + "/../compressed_file_spec"
+
+describe IMW::Resources::Archives::Tarbz2 do
+  @cannot_append = true
+  before do
+    @extension = 'tar.bz2'
+  end
+
+  it_should_behave_like 'an archive of files'
+end
+
+describe IMW::Resources::Archives::Tarbz2 do
+  before do
+    @extension = 'tar.bz2'
+  end
+  it_should_behave_like 'a compressed file'
+end
+
+
+
+
+

data/spec/imw/resources/archives_and_compressed/targz_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + "/../../../spec_helper"
+require File.dirname(__FILE__) + "/../archive_spec"
+require File.dirname(__FILE__) + "/../compressed_file_spec"
+
+describe IMW::Resources::Archives::Targz do
+  @cannot_append = true
+  before do
+    @extension = 'tar.gz'
+  end
+
+  it_should_behave_like 'an archive of files'
+end
+
+
+describe IMW::Resources::Archives::Targz do
+  before do
+    @extension = 'tar.gz'
+  end
+
+  it_should_behave_like 'a compressed file'
+end

data/spec/imw/resources/archives_and_compressed/zip_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + "/../../../spec_helper"
+require File.dirname(__FILE__) + "/../archive_spec"
+
+describe IMW::Resources::Archives::Zip do
+  
+  before do
+    @extension = 'zip'
+  end
+
+  it_should_behave_like 'an archive of files'
+
+end
+
+
+
+

data/spec/imw/resources/compressed_file_spec.rb

@@ -0,0 +1,48 @@
+require File.join(File.dirname(__FILE__),'../../spec_helper')
+
+# To use this shared example group define an instance variable
+# <tt>@extension</tt> in your tests:
+#
+#   before do
+#     # Notice that there is NO leading '.'
+#     @extension = 'gz'
+#   end
+#
+#   it_should_behave_like "a compressed file"
+#
+# The <tt>@extension</tt> should correspond to an IMW::Resources
+# module with a registered handler.
+
+share_examples_for "a compressed file" do
+  include Spec::Matchers::IMW
+
+  before do
+    @root = File.join(IMWTest::TMP_DIR, 'a_compressed_file_shared_example_group')
+    FileUtils.mkdir_p(@root)
+    FileUtils.cd(@root)
+    IMWTest::Random.file("compressed_file.#{@extension}") # define @extension in another spec
+    @compressed_file = IMW::Resource.new("compressed_file.#{@extension}")
+  end
+
+  it "should know that it is compressed" do
+    @compressed_file.is_compressed?.should   be_true
+    @compressed_file.is_compressible?.should be_false
+  end
+
+  it "can decompress the file in place" do
+    uncompressed_file = @compressed_file.decompress!
+    @compressed_file.exist?.should  be_false
+    uncompressed_file.exist?.should be_true
+    uncompressed_file.is_compressed?.should be_false
+    uncompressed_file.is_compressible?.should be_true
+  end
+
+  it "can decompress the file without deleting the original file" do
+    uncompressed_file = @compressed_file.decompress
+    @compressed_file.exist?.should  be_true
+    uncompressed_file.exist?.should be_true
+    uncompressed_file.is_compressed?.should be_false
+    uncompressed_file.is_compressible?.should be_true
+  end
+  
+end

data/spec/imw/resources/compressible_spec.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__),'../../spec_helper')
+
+describe IMW::Resources::Compressible do
+
+  before do
+    IMWTest::Random.file('foobar.txt')
+    @resource = IMW::Resource.new('foobar.txt')
+  end
+
+  it "should extend a local resource " do
+    @resource.is_compressible?.should be_true
+    @resource.is_compressed?.should   be_false
+  end
+
+  it "can compress a resource in place" do
+    compressed_file = @resource.compress!
+
+    # only the compressed file should now exist
+    compressed_file.exist?.should        be_true
+    @resource.exist?.should              be_false
+    
+    compressed_file.is_compressed?.should   be_true
+    compressed_file.is_compressible?.should be_false
+  end
+
+  it "can compress a resource without overwriting the original file" do
+    compressed_file = @resource.compress
+
+    # both files should now exist
+    compressed_file.exist?.should        be_true
+    @resource.exist?.should              be_true
+    
+    compressed_file.is_compressed?.should   be_true
+    compressed_file.is_compressible?.should be_false
+  end
+end

data/spec/imw/resources/formats/delimited_spec.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__),'../../../spec_helper')
+
+describe IMW::Resources::Formats::Csv do
+  # we don't test Tsv as the differences from Csv are trivial and
+  # effect only code within the FasterCSV library
+
+  before do
+    @sample = IMW.open(File.join(IMWTest::DATA_DIR, 'sample.csv'))
+  end
+
+  it "should be able to parse the CSV" do
+    @sample.load[1].last.should == 'lemurinus'
+  end
+
+  it "should be able to write CSV" do
+    data = [['foobar', 1, 2], ['bazbooz', 3, 4]]
+    IMW.open!('test.csv').dump(data)
+    IMW.open('test.csv').load[1].last.should == "4"
+  end
+
+  it "should yield each row when load is given a block" do
+    @sample.load do |row|
+      row.class.should == Array
+      break
+    end
+  end
+
+  it "can map each row with a block" do
+    @sample.map do |row|
+      row.first
+    end.class.should == Array
+  end
+end

data/spec/imw/resources/formats/json_spec.rb

@@ -0,0 +1,32 @@
+require File.join(File.dirname(__FILE__),'../../../spec_helper')
+
+describe IMW::Resources::Formats::Json do
+
+  before do
+    @sample = IMW.open(File.join(IMWTest::DATA_DIR, 'sample.json'))
+  end
+
+  it "should be able to parse the JSON" do
+    @sample.load['monkeys'].first['monkey']['id'].should == 1
+  end
+
+  it "should be able to write JSON" do
+    IMW.open!('test.json').dump({ 'foobar' => 3, 'bazbooz' => 4 })
+    IMW.open('test.json').load['foobar'].should == 3
+  end
+  
+  it "should yield each key and value when the JSON is a hash and it's given a block" do
+    @sample.load do |key, value|
+      value.size.should == 130
+    end
+  end
+
+  it "should yield each element when the JSON is an array and it's given a block" do
+    IMW.open!('test.json').dump([1,2,3])
+    num = 1
+    IMW.open('test.json').load do |parsed_num|
+      parsed_num.should == num
+      num +=1
+    end
+  end
+end

data/spec/imw/resources/formats/sgml_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__),'../../../spec_helper')
+
+describe IMW::Resources::Formats::Xml do
+  # just spec Xml now as the others are identical
+
+  before do
+    @sample = IMW.open(File.join(IMWTest::DATA_DIR, 'sample.xml'))
+  end
+
+  it "should be able to load the XML" do
+    ((@sample.load/"monkey").first/"genus").inner_text.should == 'Aotus'
+  end
+
+  it "should yield the XML when load is given a block" do
+    @sample.load do |xml|
+      ((xml/"monkey").first/"genus").inner_text.should == 'Aotus'
+    end
+  end
+
+  it "should parse the XML" do
+    @sample.parse(:monkeys => ['monkey'])[:monkeys].size.should == 130
+  end
+end
+

data/spec/imw/resources/formats/yaml_spec.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__),'../../../spec_helper')
+
+describe IMW::Resources::Formats::Yaml do
+
+  before do
+    @sample = IMW.open(File.join(IMWTest::DATA_DIR, 'sample.yaml'))
+  end
+
+  it "should be able to parse the YAML" do
+    @sample.load['monkeys'].first['monkey']['id'].should == 1
+  end
+
+  it "should be able to write YAML" do
+    data = { 'foobar' => 3, 'bazbooz' => 4 }
+    IMW.open!('test.yaml').dump(data)
+    IMW.open('test.yaml').load['foobar'].should == 3
+  end
+  
+  it "should yield each key and value when the YAML is a hash and it's given a block" do
+    @sample.load do |key, value|
+      value.size.should == 130
+    end
+  end
+
+  it "should yield each element when the YAML is an array and it's given a block" do
+    IMW.open!('test.yaml').dump([1,2,3])
+    num = 1
+    IMW.open('test.yaml').load do |parsed_num|
+      parsed_num.should == num
+      num +=1
+    end
+  end
+
+  it "should yield a string when the YAML is a string and it's given a block" do
+    IMW.open!('test.yaml').dump('foobar')
+    IMW.open('test.yaml').load do |string|
+      string.should == 'foobar'
+    end
+  end
+  
+end

data/spec/imw/resources/local_spec.rb

@@ -0,0 +1,98 @@
+require File.join(File.dirname(__FILE__),'../../spec_helper')
+
+describe IMW::Resources::LocalObj do
+
+  it "should not extend a local file with LocalDirectory" do
+    @file = IMW::Resource.new('foo.txt', :skip_modules => true)
+    @file.should_not_receive(:extend).with(IMW::Resources::LocalDirectory)
+    @file.extend_appropriately!
+  end
+
+  it "should not extend a local directory with LocalFile" do
+    @dir = IMW::Resource.new(IMWTest::TMP_DIR, :skip_modules => true)
+    @dir.should_not_receive(:extend).with(IMW::Resources::LocalFile)
+    @dir.extend_appropriately!
+  end
+
+  it "should correctly resolve relative paths" do
+    IMW.open('foobar').dirname.should == IMWTest::TMP_DIR
+  end
+end
+
+describe IMW::Resources::LocalFile do
+  before do
+    IMWTest::Random.file('original.txt')
+    @file = IMW::Resource.new('original.txt')
+  end
+
+  it "can delete the file" do
+    @file.rm
+    @file.exist?.should be_false
+  end
+
+
+  it "can read a file" do
+    @file.read.size.should > 0
+  end
+
+  it "can load the lines of a file" do
+    data = @file.load
+    data.size.should > 0
+    data.class.should == Array
+  end
+
+  it "can iterate over the lines of a file" do
+    @file.load do |line|
+      line.class.should == String
+      break
+    end
+  end
+
+  it "can map the lines of a file" do
+    @file.map do |line|
+      line[0..5]
+    end.class.should == Array
+  end
+end
+
+describe IMW::Resources::LocalDirectory do
+  before do
+    FileUtils.mkdir_p('dir')
+    FileUtils.mkdir_p('dir/subdir')
+    FileUtils.cd('dir') do
+      IMWTest::Random.file('file1.tsv')
+      IMWTest::Random.file('file2.tsv')
+      FileUtils.cd('subdir') do
+        IMWTest::Random.file('file3.csv')
+      end
+    end
+    @dir = IMW::Resource.new('dir')
+  end
+
+  it "can delete an empty directory" do
+    FileUtils.mkdir('empty')
+    dir = IMW.open('empty')
+    dir.rmdir
+    dir.exist?.should be_false
+  end
+
+  it "can recursively delete a directory" do
+    @dir.rm_rf
+    @dir.exist?.should be_false
+  end
+
+  it "can list its contents" do
+    @dir.contents.size.should == 3
+  end
+
+  it "can list its contents recursively" do
+    @dir.all_contents.size.should == 4
+  end
+
+  it "can list its contents recursively as IMW::Resource objects" do
+    @dir.resources.map(&:class).uniq.first.should == IMW::Resource
+  end
+
+end
+
+

data/spec/imw/resources/remote_spec.rb

@@ -0,0 +1,35 @@
+require File.join(File.dirname(__FILE__),'../../spec_helper')
+
+describe IMW::Resources::RemoteObj do
+end
+
+describe IMW::Resources::RemoteFile do
+
+  before { @file = IMW.open('http://www.google.com') }
+
+  describe 'with the file' do
+
+    it "can read a remote file" do
+      @file.read.size.should > 0
+    end
+
+    it "can load the lines of a remote file" do
+      data = @file.load
+      data.size.should > 0
+      data.class.should == Array
+    end
+
+    it "can iterate over the lines of a remote file" do
+      @file.load do |line|
+        line.class.should == String
+        break
+      end
+    end
+
+    it "can map the lines of a remote file" do
+      @file.map do |line|
+        line[0..5]
+      end.class.should == Array
+    end
+  end
+end