vfs 0.3.11 → 0.3.12

data/lib/vfs/entries/file.rb

@@ -67,7 +67,7 @@ module Vfs
           if block        
             fs.write_file(path, options[:append], &block)
           else
-            fs.write_file(path, options[:append]){|writer| writer.call data}
+            fs.write_file(path, options[:append]){|writer| writer.write data}
           end
         rescue StandardError => error
           entry = self.entry
@@ -162,7 +162,7 @@ module Vfs
       end
       
       target.write options do |writer|
-        read(options){|buff| writer.call buff}
+        read(options){|buff| writer.write buff}
       end
       
       target

data/lib/vfs/storages/local.rb

@@ -4,6 +4,16 @@ require 'tempfile'
 module Vfs
   module Storages
     class Local
+      class Writer
+        def initialize out
+          @out = out
+        end
+        
+        def write data
+          @out.write data
+        end
+      end
+      
       module LocalVfsHelper
         DEFAULT_BUFFER = 1000 * 1024
         
@@ -51,9 +61,8 @@ module Vfs
           raise "can't write, entry #{path} already exist!" if !append and ::File.exist?(path)
           
           option = append ? 'a' : 'w'          
-          ::File.open path, option do |os|
-            writer = -> buff {os.write buff}
-            block.call writer
+          ::File.open path, option do |out|
+            block.call Writer.new(out)
           end
         end
 

data/lib/vfs/storages/specification.rb

@@ -36,7 +36,7 @@ shared_examples_for 'vfs storage' do
     it "file attributes" do
       @storage.open_fs do |fs|
         fs.attributes(@remote_file).should == {}
-        fs.write_file(@remote_file, false){|w| w.call 'something'}
+        fs.write_file(@remote_file, false){|w| w.write 'something'}
         attrs = fs.attributes(@remote_file)      
         fs.attributes(@remote_file).subset(:file, :dir).should == {file: true, dir: false}
       end
@@ -44,7 +44,7 @@ shared_examples_for 'vfs storage' do
 
     it "read, write & append" do
       @storage.open_fs do |fs|
-        fs.write_file(@remote_file, false){|w| w.call 'something'}
+        fs.write_file(@remote_file, false){|w| w.write 'something'}
         fs.attributes(@remote_file)[:file].should be_true
       
         data = ""  
@@ -52,7 +52,7 @@ shared_examples_for 'vfs storage' do
         data.should == 'something'
       
         # append
-        fs.write_file(@remote_file, true){|w| w.call ' another'}
+        fs.write_file(@remote_file, true){|w| w.write ' another'}
         data = ""  
         fs.read_file(@remote_file){|buff| data << buff}
         data.should == 'something another'
@@ -61,7 +61,7 @@ shared_examples_for 'vfs storage' do
   
     it "delete_file" do
       @storage.open_fs do |fs|
-        fs.write_file(@remote_file, false){|w| w.call '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 == {}
@@ -92,7 +92,7 @@ shared_examples_for 'vfs storage' 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.call 'something'}         
+        fs.write_file("#{@remote_dir}/dir/file", false){|w| w.write 'something'}         
         fs.delete_dir(@remote_dir)
         fs.attributes(@remote_dir).should == {}
       end
@@ -106,7 +106,7 @@ shared_examples_for 'vfs storage' do
       
         dir, file = "#{@tmp_dir}/dir", "#{@tmp_dir}/file"
         fs.create_dir(dir)
-        fs.write_file(file, false){|w| w.call 'something'}
+        fs.write_file(file, false){|w| w.write 'something'}
       
         list = {}
         fs.each_entry(@tmp_dir, nil){|path, type| list[path] = type}

data/readme.md

@@ -1,7 +1,7 @@
 # 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). 
-The Vfs for File System is the same as ActiveRecord is for Relational Databases.
+The Vfs for File System is kinda the same as ActiveRecord is for Relational Databases.
 
 Currently, there are following implementations available:
 
@@ -11,45 +11,53 @@ Currently, there are following implementations available:
 ## Goals
 
 - **handy, simple and clean** API.
-- **high performance** - the same as by using low-level storage API, there should be no extra calls **.
 - same API for different storages (Local FS, SSH, Hadoop, or any other , ...).
 - should work **simultaneously with different storages**.
 - small codebase, easy to extend by others.
 - simple storage-driver implementation, easy add new storage types (Hadoop DFS, LDAP, Document Oriented DB, In-Memory, ...).
 
-** all methods should have the same performance as native system calls, except for :move and :rename. Right now they are implemented 
-ASAP by using copy+destroy approach, will be fixed as soon as I'll have free time to do it.
+**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.
+- right now :move and :rename implemented ASAP by copy & destroy, will be fixed as soon as I'll have time to do it.
 
 ## Installation
 
-```bash
+``` bash
 $ gem install vfs
 $ gem install vos
 ```
 
 ## Code samples:
 
-```ruby
+``` ruby
 gem 'vfs'                                    # Virtual File System
 require 'vfs'                              
 
 gem 'vos'                                    # Virtual Operating System
 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'}                                                  
 me = '~'.to_dir                              # handy shortcut for local FS
 
 deploy_dir = server['apps/cool_app']
 projects = me['projects']
-
+```
 
 # Working with dirs, copying dir from any source to any destination (local/remote/custom_storage_type)
-projects['cool_app'].copy_to deploy_dir        
 
+``` ruby
+projects['cool_app'].copy_to deploy_dir        
+```
 
 # Working with files
+
+``` ruby
 dbc = deploy_dir.file('config/database.yml') # <= the 'config' dir not exist yet
 dbc.write("user: root\npassword: secret")    # <= now the 'database.yml' and parent 'config' has been created
 dbc.content =~ /database/                    # => false, we forgot to add the database
@@ -61,9 +69,9 @@ 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
-
+There are also streaming support (read/write/append) with &block, please go to specs for details
 
 # Checks
 deploy_dir['config'].exist?                  # => true

data/spec/file_spec.rb

@@ -90,7 +90,7 @@ describe 'File' do
       @path.read.should == 'something'
 
       @path.write! do |writer|
-        writer.call 'another'
+        writer.write 'another'
       end
       @path.read.should == 'another'
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vfs
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.3.12
   prerelease: 
 platform: ruby
 authors: