vfs 0.3.12 → 0.3.13

data/lib/vfs/storages/specification.rb

@@ -2,7 +2,7 @@
 require 'rspec_ext'
 require 'ruby_ext'
 
-shared_examples_for 'vfs storage' do  
+shared_examples_for 'vfs storage' do
   before do
     @storage.open_fs do |fs|
       @tmp_dir = fs.tmp
@@ -15,29 +15,29 @@ shared_examples_for 'vfs storage' do
       fs.delete_dir @tmp_dir if attrs && attrs[:dir]
     end
   end
-  
+
   it 'should respond to :local?' do
     @storage.open_fs{|fs| fs.should respond_to(:local?)}
   end
-  
+
   it 'should respond to :host'
-  
+
   it 'should have root dir' do
     @storage.open_fs do |fs|
       fs.attributes('/').subset(:file, :dir).should == {file: false, dir: true}
     end
   end
-    
-  describe "files" do  
+
+  describe "files" do
     before do
       @remote_file = "#{@tmp_dir}/remote_file"
     end
-    
+
     it "file attributes" do
       @storage.open_fs do |fs|
         fs.attributes(@remote_file).should == {}
         fs.write_file(@remote_file, false){|w| w.write 'something'}
-        attrs = fs.attributes(@remote_file)      
+        attrs = fs.attributes(@remote_file)
         fs.attributes(@remote_file).subset(:file, :dir).should == {file: true, dir: false}
       end
     end
@@ -46,39 +46,39 @@ shared_examples_for 'vfs storage' do
       @storage.open_fs do |fs|
         fs.write_file(@remote_file, false){|w| w.write 'something'}
         fs.attributes(@remote_file)[:file].should be_true
-      
-        data = ""  
+
+        data = ""
         fs.read_file(@remote_file){|buff| data << buff}
         data.should == 'something'
-      
+
         # append
         fs.write_file(@remote_file, true){|w| w.write ' another'}
-        data = ""  
+        data = ""
         fs.read_file(@remote_file){|buff| data << buff}
         data.should == 'something another'
       end
     end
-  
+
     it "delete_file" do
       @storage.open_fs do |fs|
-        fs.write_file(@remote_file, false){|w| w.write 'something'}        
+        fs.write_file(@remote_file, false){|w| w.write 'something'}
         fs.attributes(@remote_file)[:file].should be_true
         fs.delete_file(@remote_file)
         fs.attributes(@remote_file).should == {}
       end
     end
   end
-  
+
   describe 'directories' do
     # before do
     #   @from_local, @remote_path, @to_local = "#{@local_dir}/dir", "#{@tmp_dir}/upload", "#{@local_dir}/download"
     # end
-    
+
     before do
       @remote_dir = "#{@tmp_dir}/some_dir"
     end
-    
-    it "directory_exist?, create_dir, delete_dir" do        
+
+    it "directory_exist?, create_dir, delete_dir" do
       @storage.open_fs do |fs|
         fs.attributes(@remote_dir).should == {}
         fs.create_dir(@remote_dir)
@@ -87,43 +87,43 @@ shared_examples_for 'vfs storage' do
         fs.attributes(@remote_dir).should == {}
       end
     end
-    
+
     it 'should delete not-empty directories' do
       @storage.open_fs do |fs|
         fs.create_dir(@remote_dir)
         fs.create_dir("#{@remote_dir}/dir")
-        fs.write_file("#{@remote_dir}/dir/file", false){|w| w.write 'something'}         
+        fs.write_file("#{@remote_dir}/dir/file", false){|w| w.write 'something'}
         fs.delete_dir(@remote_dir)
         fs.attributes(@remote_dir).should == {}
       end
     end
-    
+
     it 'each' do
       @storage.open_fs do |fs|
         list = {}
         fs.each_entry(@tmp_dir, nil){|path, type| list[path] = type}
         list.should be_empty
-      
+
         dir, file = "#{@tmp_dir}/dir", "#{@tmp_dir}/file"
         fs.create_dir(dir)
         fs.write_file(file, false){|w| w.write 'something'}
-      
+
         list = {}
         fs.each_entry(@tmp_dir, nil){|path, type| list[path] = type}
         list.should == {'dir' => :dir, 'file' => :file}
       end
     end
-  
+
     # it "upload_directory & download_directory" do
     #   upload_path_check = "#{@remote_path}/dir2/file"
-    #   check_attributes upload_path_check, nil        
+    #   check_attributes upload_path_check, nil
     #   fs.upload_directory(@from_local, @remote_path)
     #   check_attributes upload_path_check, file: true, dir: false
-    #   
+    #
     #   download_path_check = "#{@to_local}/dir2/file"
     #   File.exist?(download_path_check).should be_false
     #   fs.download_directory(@remote_path, @to_local)
     #   File.exist?(download_path_check).should be_true
     # end
-  end  
+  end
 end

data/lib/vfs/vfs.rb

@@ -3,28 +3,28 @@ module Vfs
     def default_storage
       ::Vfs::Storages::Local.new
     end
-    
+
     def to_entry
       '/'.to_entry
     end
-    
+
     def to_file
       to_entry.file
     end
-    
+
     def to_dir
       to_entry.dir
     end
-    
+
     # def [] path
     #   to_entry[path]
     # end
     # alias_method :/, :[]
-          
+
     %w(
-      entry dir file 
+      entry dir file
       entries dirs files
-      [] / 
+      [] /
       tmp
     ).each do |m|
       script = <<-RUBY

data/readme.md

@@ -1,6 +1,6 @@
 # Vfs - Virtual File System
 
-Handy and simple abstraction over any storage that can represent concept of File and Directory (or at least part of it). 
+Handy and simple abstraction over any storage that can represent concept of File and Directory (or at least part of it).
 The Vfs for File System is kinda the same as ActiveRecord is for Relational Databases.
 
 Currently, there are following implementations available:
@@ -19,7 +19,7 @@ Currently, there are following implementations available:
 **Performance**:
 
 - sometimes there's extra call to check if file or dir exist before overriding it
-- copy: it doesn't use FileUtils.cp_r, it walks on the directory tree and copy each entry individually, so it's probably a little slover.
+- copy: right now it doesn't use FileUtils.cp_r, it walks on the directory tree and copy each entry individually, so it's probably a little slover.
 - right now :move and :rename implemented ASAP by copy & destroy, will be fixed as soon as I'll have time to do it.
 
 ## Installation
@@ -33,7 +33,7 @@ $ gem install vos
 
 ``` ruby
 gem 'vfs'                                    # Virtual File System
-require 'vfs'                              
+require 'vfs'
 
 gem 'vos'                                    # Virtual Operating System
 require 'vos'
@@ -42,7 +42,7 @@ require 'vos'
 # Connections, let's deploy our 'cool_app' project from our local box to remote server
 
 ``` ruby
-server = Box.new('cool_app.com')             # it will use id_rsa, or You can add {user: 'me', password: 'secret'}                                                  
+server = Box.new('cool_app.com')             # it will use id_rsa, or You can add {user: 'me', password: 'secret'}
 me = '~'.to_dir                              # handy shortcut for local FS
 
 deploy_dir = server['apps/cool_app']
@@ -52,7 +52,7 @@ projects = me['projects']
 # Working with dirs, copying dir from any source to any destination (local/remote/custom_storage_type)
 
 ``` ruby
-projects['cool_app'].copy_to deploy_dir        
+projects['cool_app'].copy_to deploy_dir
 ```
 
 # Working with files
@@ -65,12 +65,12 @@ dbc.append("\ndatabase: mysql")              # let's do it
 
 dbc.update do |content|                      # and add host info
   content + "\nhost: cool_app.com "
-end                                       
+end
 
 projects['cool_app/config/database.yml'].    # or just overwrite it with our local dev version
   copy_to! dbc
 ```
-  
+
 There are also streaming support (read/write/append) with &block, please go to specs for details
 
 # Checks
@@ -94,15 +94,15 @@ deploy_dir.dirs                              # => list of dirs, also support &bl
 ```
 
 For more please go to specs (create/update/move/copy/destroy/...)
-      
+
 ## Integration with [Vos][vos] (Virtual Operating System)
-    
-```ruby  
+
+```ruby
 server['apps/cool_app'].bash 'rails production'
 ```
 
-For more details please go to [Vos][vos] project page. 
-Or checkout configuration I use to control my production servers [My Cluster][my_cluster] in conjunction with small 
+For more details please go to [Vos][vos] project page.
+Or checkout configuration I use to control my production servers [My Cluster][my_cluster] in conjunction with small
 configuration tool [Cluster Management][cluster_management].
 
 # Why?
@@ -114,31 +114,10 @@ is to provide 1-to-1 clone of underlying OS API, instead of provididing handy to
 
 And if you want to use remote FS - things are getting even worse and more complicated (Net::SSH & Net::SFTP use a little
 different API than local FS, and you has to remember all thouse little quirks).
-  
-## Roadmap
-
-### some future
-
-- add storages: Hadoop DFS, MongoDB, Amazon S3
-
-### v 0.2
-
-- refactor specs with :fakefs
-- remove :host from Vfs to Vos
-- efficient (not copy/destroy) versions of move_to, rename
-- access via attributes and helpers for unix chmod
-- add storages: remote FS over HTTP.
-
-Done:
-
-- glob search for directories: Dir['**/*.yml']
 
-### v 0.1 (all done)
+Copyright (c) Alexey Petrushin http://petrush.in, released under the MIT license.
 
-- Vos: Dir.bash
-- File.append
-- list of entries/files/dirs
-- support for efficient copy for Local and SSH storages
+## Please let me know about bugs and Your proposals, there's the 'Issues' tab at the top, feel free to submit.
 
 [vos]: http://github.com/alexeypetrushin/vos
 [cluster_management]: http://github.com/alexeypetrushin/cluster_management

data/spec/container_spec.rb

@@ -2,26 +2,26 @@ require 'spec_helper'
 
 describe 'Container' do
   with_test_fs
-  
+
   it "should threat paths as UniversalEntry except it ends with '/'" do
     test_fs.should_receive(:entry).with('tmp/a/b')
     test_fs['tmp/a/b']
-    
+
     test_fs.should_receive(:dir).with('tmp/a/b')
     test_fs['tmp/a/b/']
   end
-  
+
   it '/' do
     test_fs[:some_path].should == test_fs / :some_path
     test_fs[:some_path][:another_path].should == test_fs / :some_path / :another_path
   end
-  
+
   it "UniversalEntry should be wrapped inside of proxy, Dir and File should not" do
     -> {test_fs.dir.proxy?}.should raise_error(NoMethodError)
     -> {test_fs.file.proxy?}.should raise_error(NoMethodError)
     test_fs.entry.proxy?.should be_true
   end
-  
+
   it "sometimes it also should inexplicitly guess that path is a Dir instead of UniversalEntry (but still wrap it inside of Proxy)" do
     dir = test_fs['tmp/a/..']
     dir.proxy?.should be_true

data/spec/dir_spec.rb

@@ -2,11 +2,11 @@ require 'spec_helper'
 
 describe 'Dir' do
   with_test_fs
-  
+
   before do
     @path = test_fs['a/b/c']
   end
-  
+
   describe 'existence' do
     it "should check only dirs" do
       @path.should_not exist
@@ -18,29 +18,29 @@ describe 'Dir' do
       @path.dir.should exist
     end
   end
-    
+
   it "should not respond to read and write methods" do
     -> {@path.dir.read}.should raise_error(NoMethodError)
     -> {@path.dir.write}.should raise_error(NoMethodError)
   end
-  
+
   describe 'create' do
     it 'should be chainable' do
       @path.dir.create.should == @path
       @path.dir.create!.should == @path
     end
-    
+
     it 'should create parent dirs if not exists' do
       @path.parent.should_not exist
       @path.dir.create
       @path.should be_dir
     end
-    
+
     it 'should silently exit if dir already exist' do
       @path.dir.create
       @path.dir.create
     end
-    
+
     it 'should override existing file if override specified' do
       @path.file.create
       @path.should be_file
@@ -48,7 +48,7 @@ describe 'Dir' do
       @path.dir.create!
       @path.should be_dir
     end
-    
+
     it 'should override existing dir if override specified' do
       @path.dir.create
       @path.should be_dir
@@ -56,7 +56,7 @@ describe 'Dir' do
       @path.should be_dir
     end
   end
-  
+
   describe 'destroying' do
     it "should raise error if it's trying to destroy a file (unless force specified)" do
       @path.file.create
@@ -64,36 +64,36 @@ describe 'Dir' do
       @path.dir.destroy!
       @path.entry.should_not exist
     end
-    
+
     it "shouldn't raise if dir not exist" do
       @path.dir.destroy
     end
-    
+
     it 'should destroy recursivelly' do
       dir = @path.dir
       dir.create
       dir.file('file').write 'something'
       dir.dir('dir').create.tap do |dir|
-        dir.file('file2').write 'something2'        
+        dir.file('file2').write 'something2'
       end
-      
+
       dir.destroy
       dir.should_not exist
     end
-    
+
     it 'should be chainable' do
       @path.dir.destroy.should == @path
       @path.dir.destroy!.should == @path
     end
   end
-  
+
   describe 'entries, files, dirs' do
     before do
       @path.dir('dir').create
       @path.dir('dir/another_dir').create
-      @path.file('file').create      
+      @path.file('file').create
     end
-    
+
     it 'entries' do
       -> {@path['non_existing'].entries}.should raise_error(Vfs::Error, /not exist/)
       @path['non_existing'].entries(bang: false).should == []
@@ -102,71 +102,71 @@ describe 'Dir' do
       @path.entries{|e| list << e}
       list.to_set.should be_eql([@path.dir('dir'), @path.file('file')].to_set)
     end
-    
+
     it "glob search support"
-    
+
     it 'should raise error if trying :entries on file' do
       @path.file('some_file').create
       -> {@path.dir('some_file').entries}.should raise_error(/File/)
     end
-    
+
     it 'files' do
       @path.files.should be_eql([@path.file('file')])
     end
-    
+
     it 'dirs' do
       @path.dirs.should be_eql([@path.dir('dir')])
     end
-    
+
     it 'has? & include?' do
       @path.include?('dir').should be_true
       @path.include?('dir/another_dir').should be_true
       @path.include?('file').should be_true
       @path.include?('non_existing').should be_false
     end
-    
+
     it 'empty?'
   end
-  
+
   describe 'copying' do
-    before do 
+    before do
       @from = @path.dir
       @from.create
       @from.file('file').write 'something'
       @from.dir('dir').create.tap do |dir|
-        dir.file('file2').write 'something2'        
+        dir.file('file2').write 'something2'
       end
     end
-    
+
     it 'should not copy to itself' do
       -> {@from.copy_to @from}.should raise_error(Vfs::Error, /itself/)
     end
-    
+
     shared_examples_for 'copy_to behavior' do
       it 'should not copy to file (and overwrite if forced)' do
         -> {@from.copy_to @to.file}.should raise_error(/can't copy Dir to File/)
-        
+
         @from.copy_to! @to.file
         @to['file'].read.should == 'something'
       end
-      
+
       it 'should not override files (and override if forced)' do
         @from.copy_to @to
         -> {@from.copy_to @to}.should raise_error(/already exist/)
-        
+
         @from['dir/file2'].write! 'another'
         @from.copy_to! @to
         @to['dir/file2'].read.should == 'another'
       end
-    
+
       it 'should copy to UniversalEntry (and overwrite if forced)' do
         @from.copy_to @to.entry
         -> {@from.copy_to @to.entry}.should raise_error(/already exist/)
-        
+
         @from.copy_to! @to.entry
-        @to['file'].read.should == 'something'        
+        @to['file'].read.should == 'something'
       end
-      
+
       it "shouldn't delete existing content of directory" do
         @to.dir.create!
         @to.file('existing_file').write 'existing_content'
@@ -181,25 +181,25 @@ describe 'Dir' do
         @to.file('existing_file').read.should == 'existing_content'
         @to.dir('existing_dir').should exist
         @to.file('dir/existing_file2').read.should == 'existing_content2'
-      end      
-      
+      end
+
       it 'should be chainable' do
         @from.copy_to(@to).should == @to
         @from.copy_to!(@to).should == @to
       end
-      
+
       it "should override without deleting other files" do
-        @from.copy_to(@to).should == @to 
+        @from.copy_to(@to).should == @to
         @to.file('other_file').write 'other'
-                       
+
         @from.copy_to!(@to).should == @to
         @to.file('other_file').read.should == 'other'
       end
     end
 
-    describe 'general copy' do   
+    describe 'general copy' do
       it_should_behave_like 'copy_to behavior'
-      
+
       before do
         # prevenging usage of :efficient_dir_copy
         # Vfs::Dir.dont_use_efficient_dir_copy = true
@@ -209,29 +209,29 @@ describe 'Dir' do
       # after do
       #   Vfs::Dir.dont_use_efficient_dir_copy = false
       # end
-    end    
-    
+    end
+
     # describe 'effective copy' do
     #   it_should_behave_like 'copy_to behavior'
-    #   
+    #
     #   before do
     #     @to = test_fs['to']
     #   end
     # end
   end
-    
+
   describe 'moving' do
     it 'move_to' do
       from, to = @path.file('from'), @path.file('to')
       from.should_receive(:copy_to).with(to, {})
       from.should_receive(:destroy).with({})
       from.move_to to
-    
+
       from.should_receive(:move_to).with(to, override: true)
       from.move_to! to
     end
-    
-    it 'should be chainable' do      
+
+    it 'should be chainable' do
       from, to = @path.dir('from').create, @path.dir('to')
       from.move_to(to).should == to
       from.create