RubyGems - vfs-momolog - Versions diffs - 0.0.1 - Mend

vfs-momolog 0.0.1

Files changed (51) hide show

data/.gitignore +8 -0
data/Gemfile +4 -0
data/LICENSE +22 -0
data/Rakefile +2 -0
data/docs/basics.rb +116 -0
data/docs/s3_backup.rb +29 -0
data/docs/s3_backup/app/files/bos.png +0 -0
data/docs/s3_basics.rb +19 -0
data/docs/s3_sandbox.rb +24 -0
data/docs/site/404.html +8 -0
data/docs/site/basics.html +305 -0
data/docs/site/index.html +8 -0
data/docs/site/s3_backup.html +111 -0
data/docs/site/s3_basics.html +84 -0
data/docs/site/s3_sandbox.html +99 -0
data/docs/site/ssh_basics.html +84 -0
data/docs/site/ssh_deployment.html +125 -0
data/docs/site/ssh_sandbox.html +103 -0
data/docs/ssh_basics.rb +19 -0
data/docs/ssh_deployment.rb +35 -0
data/docs/ssh_deployment/app/app.rb +0 -0
data/docs/ssh_sandbox.rb +28 -0
data/lib/vfs.rb +18 -0
data/lib/vfs/drivers/local.rb +180 -0
data/lib/vfs/drivers/specification.rb +169 -0
data/lib/vfs/entries/dir.rb +256 -0
data/lib/vfs/entries/entry.rb +152 -0
data/lib/vfs/entries/file.rb +155 -0
data/lib/vfs/entries/universal_entry.rb +24 -0
data/lib/vfs/entry_proxy.rb +42 -0
data/lib/vfs/error.rb +4 -0
data/lib/vfs/integration.rb +30 -0
data/lib/vfs/path.rb +123 -0
data/lib/vfs/version.rb +3 -0
data/lib/vfs/vfs.rb +38 -0
data/old/hash_fs.rb +216 -0
data/old/hash_fs_spec.rb +10 -0
data/readme.md +143 -0
data/spec/container_spec.rb +31 -0
data/spec/dir_spec.rb +253 -0
data/spec/entry_spec.rb +42 -0
data/spec/file_spec.rb +215 -0
data/spec/misc_spec.rb +19 -0
data/spec/path_spec.rb +127 -0
data/spec/spec_helper.rb +50 -0
data/spec/storages/local_spec.rb +24 -0
data/spec/storages/local_spec/emptygit +0 -0
data/spec/universal_entry_spec.rb +69 -0
data/todo.md +19 -0
data/vfs.gemspec +17 -0
metadata +105 -0

data/docs/site/ssh_sandbox.html ADDED Viewed

@@ -0,0 +1,103 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=utf-8">
+  <title>ssh_sandbox.rb</title>
+  <link rel="stylesheet" href="http://jashkenas.github.com/docco/resources/docco.css">
+</head>
+<body>
+<div id='container'>
+  <div id="background"></div>
+  <div id="jump_to">
+    Jump To &hellip;
+    <div id="jump_wrapper">
+      <div id="jump_page">
+          <a class="source" href="basics.html">basics.rb</a>
+          <a class="source" href="s3_backup.html">s3_backup.rb</a>
+          <a class="source" href="s3_basics.html">s3_basics.rb</a>
+          <a class="source" href="s3_sandbox.html">s3_sandbox.rb</a>
+          <a class="source" href="ssh_basics.html">ssh_basics.rb</a>
+          <a class="source" href="ssh_deployment.html">ssh_deployment.rb</a>
+          <a class="source" href="ssh_sandbox.html">ssh_sandbox.rb</a>
+      </div>
+    </div>
+  </div>
+  <table cellspacing=0 cellpadding=0>
+  <thead>
+    <tr>
+      <th class=docs><h1>ssh_sandbox.rb</h1></th>
+      <th class=code></th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr id='section-1'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-1">&#182;</a>
+        </div>
+        <p>Example of using SFTP as a storage for <a href="index.html">Virtual File System</a></p>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre></pre></div>
+      </td>
+    </tr>
+    <tr id='section-2'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-2">&#182;</a>
+        </div>
+        <p>To use SSH/SFTP we need the SSH driver, You need &lsquo;vos&rsquo;, &lsquo;net-ssh&rsquo; and &lsquo;net-sftp&rsquo; gems installed.</p>
+<pre><code>gem install vos net-ssh net-sftp
+</code></pre>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre><span class="nb">require</span> <span class="s1">&#39;vfs&#39;</span>
+<span class="nb">require</span> <span class="s1">&#39;vos&#39;</span>
+<span class="nb">require</span> <span class="s1">&#39;vos/drivers/ssh&#39;</span></pre></div>
+      </td>
+    </tr>
+    <tr id='section-3'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-3">&#182;</a>
+        </div>
+        <p>Initializing SSH driver, if You can connect to server using identity file provide host only.</p>
+<p>If the connection requires login and password You need to provide it:</p>
+<pre><code>driver = Vos::Drivers::Ssh.new \
+  host:     &lsquo;xxx.com&rsquo;,
+  user:     &lsquo;xxx&rsquo;,
+  password: &lsquo;xxx&rsquo;
+</code></pre>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre><span class="n">driver</span> <span class="o">=</span> <span class="no">Vos</span><span class="o">::</span><span class="no">Drivers</span><span class="o">::</span><span class="no">Ssh</span><span class="o">.</span><span class="n">new</span> <span class="n">host</span><span class="p">:</span> <span class="s1">&#39;xxx.com&#39;</span></pre></div>
+      </td>
+    </tr>
+    <tr id='section-4'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-4">&#182;</a>
+        </div>
+        <p>After creating driver we can create storage.</p>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre><span class="n">box</span> <span class="o">=</span> <span class="no">Vos</span><span class="o">::</span><span class="no">Box</span><span class="o">.</span><span class="n">new</span> <span class="n">driver</span></pre></div>
+      </td>
+    </tr>
+    <tr id='section-5'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-5">&#182;</a>
+        </div>
+        <p>Preparing temporary dir for sample and cleaning it before starting.</p>
+      </td>
+      <td class=code>
+        <div class='highlight'><pre><span class="vg">$sandbox</span> <span class="o">=</span> <span class="n">box</span><span class="o">[</span><span class="s1">&#39;/tmp/vfs_sandbox&#39;</span><span class="o">].</span><span class="n">to_dir</span><span class="o">.</span><span class="n">destroy</span></pre></div>
+      </td>
+    </tr>
+  </table>
+</div>
+</body>

data/docs/ssh_basics.rb ADDED Viewed

@@ -0,0 +1,19 @@
+# Example of [Virtual File System][vfs] working with SFTP.
+#
+# This is exactly the same [basic example][basics] but this time
+# we using SFTP as storage instead of local file system.
+# Adding examples folder to load paths.
+$LOAD_PATH << File.expand_path("#{__FILE__}/../..")
+# Connecting to SFTP and preparing sandbox. You may take a look at
+# the [docs/ssh_sandbox.rb][ssh_sandbox] to see the actual code.
+require 'docs/ssh_sandbox'
+# Now we just executig [basic example][basics]
+# but with the `$storage` set to SFTP.
+require 'docs/basics'
+# [vfs]:         index.html
+# [basics]:      basics.html
+# [ssh_sandbox]: ssh_sandbox.html

data/docs/ssh_deployment.rb ADDED Viewed

@@ -0,0 +1,35 @@
+# Example of Application Deployment using [Virtual File System][vfs].
+#
+# In this example we uploading sample app files to remote server,
+# write database configuration file and restart the server on remote machine.
+# Adding examples folder to load paths.
+$LOAD_PATH << File.expand_path("#{__FILE__}/../..")
+# Connecting to SFTP and preparing sandbox. You may take a look at
+# the [docs/ssh_sandbox.rb][ssh_sandbox] to see the actual code.
+require 'docs/ssh_sandbox'
+sandbox = $sandbox
+# Preparing sample files located in our local folder in
+# current directory.
+current_dir = __FILE__.to_entry.parent
+sample_app = current_dir['ssh_deployment/app']
+# Copying application files to remote machine.
+app = sandbox['apps/app']
+sample_app.copy_to app
+p app['app.rb'].exist?                          # => true
+# Writing database configuration file.
+config = app['config.yml']
+config.write "database: mysql"
+config.append "name: app_production"
+p app['config.yml'].exist?                       # => true
+# Updating gems and restarting the server.
+p app.bash("echo 'bundle install'")              # => bundle install
+p app.bash("echo 'server start'")                # => server start
+# [vfs]:         index.html
+# [ssh_sandbox]: ssh_sandbox.html

data/docs/ssh_deployment/app/app.rb ADDED Viewed

File without changes

data/docs/ssh_sandbox.rb ADDED Viewed

@@ -0,0 +1,28 @@
+# Example of using SFTP as a storage for [Virtual File System][vfs]
+# To use SSH/SFTP we need the SSH driver, You need 'vos', 'net-ssh' and 'net-sftp' gems installed.
+#
+#     gem install vos net-ssh net-sftp
+#
+require 'vfs'
+require 'vos'
+require 'vos/drivers/ssh'
+# Initializing SSH driver, if You can connect to server using identity file provide host only.
+#
+# If the connection requires login and password You need to provide it:
+#
+#     driver = Vos::Drivers::Ssh.new \
+#       host:     'xxx.com',
+#       user:     'xxx',
+#       password: 'xxx'
+#
+driver = Vos::Drivers::Ssh.new host: 'xxx.com'
+# After creating driver we can create storage.
+box = Vos::Box.new driver
+# Preparing temporary dir for sample and cleaning it before starting.
+$sandbox = box['/tmp/vfs_sandbox'].to_dir.destroy
+# [vfs]: index.html

data/lib/vfs.rb ADDED Viewed

@@ -0,0 +1,18 @@
+module Vfs
+  autoload :Path,           'vfs/path'
+  autoload :Error,          'vfs/error'
+  autoload :Entry,          'vfs/entries/entry'
+  autoload :File,           'vfs/entries/file'
+  autoload :Dir,            'vfs/entries/dir'
+  autoload :UniversalEntry, 'vfs/entries/universal_entry'
+  autoload :EntryProxy,     'vfs/entry_proxy'
+  module Drivers
+    autoload :Local, 'vfs/drivers/local'
+  end
+end
+require 'vfs/vfs'
+require 'vfs/integration'

data/lib/vfs/drivers/local.rb ADDED Viewed

@@ -0,0 +1,180 @@
+require 'fileutils'
+require 'tempfile'
+module Vfs
+  module Drivers
+    class Local
+      class Writer
+        def initialize out; @out = out end
+        def write data
+          @out.write data
+        end
+      end
+      DEFAULT_BUFFER = 1000 * 1024
+      def initialize options = {}
+        options = options.clone
+        @root = options.delete(:root) || ''
+        raise "invalid options #{options}" unless options.empty?
+      end
+      def open &block
+        block.call self if block
+      end
+      def close; end
+      attr_writer :buffer
+      def buffer
+        @buffer || DEFAULT_BUFFER
+      end
+      #
+      # Attributes
+      #
+      def attributes path
+        path = with_root path
+        stat = ::File.stat path
+        attrs = {}
+        attrs[:file] = !!stat.file?
+        attrs[:dir]  = !!stat.directory?
+        # attributes special for file system
+        attrs[:created_at] = stat.ctime
+        attrs[:updated_at] = stat.mtime
+        attrs[:size]       = stat.size if attrs[:file]
+        attrs
+      rescue Errno::ENOTDIR
+        nil
+      rescue Errno::ENOENT
+        nil
+      end
+      def set_attributes path, attrs
+        # TODO2 set attributes
+        not_implemented
+      end
+      #
+      # File
+      #
+      def read_file path, &block
+        path = with_root path
+        ::File.open path, 'r' do |is|
+          while buff = is.gets(self.buffer || DEFAULT_BUFFER)
+            block.call buff
+          end
+        end
+      end
+      def write_file original_path, append, &block
+        path = with_root original_path
+        option = append ? 'a' : 'w'
+        ::File.open path, "#{option}b" do |out|
+          block.call Writer.new(out)
+        end
+      end
+      def delete_file path
+        path = with_root path
+        ::File.delete path
+      end
+      # def move_file from, to
+      #   FileUtils.mv from, to
+      # end
+      #
+      # Dir
+      #
+      def create_dir path
+        path = with_root path
+        ::Dir.mkdir path
+      end
+      def delete_dir original_path
+        path = with_root original_path
+        ::FileUtils.rm_r path
+      end
+      def each_entry path, query, &block
+        path = with_root path
+        if query
+          path_with_trailing_slash = path == '/' ? path : "#{path}/"
+          ::Dir["#{path_with_trailing_slash}#{query}"].each do |absolute_path|
+            name = absolute_path.sub path_with_trailing_slash, ''
+            block.call name, ->{::File.directory?(absolute_path) ? :dir : :file}
+            # if ::File.directory? absolute_path
+            #   block.call relative_path, :dir
+            # else
+            #   block.call relative_path, :file
+            # end
+          end
+        else
+          ::Dir.foreach path do |name|
+            next if name == '.' or name == '..'
+            block.call name, ->{::File.directory?("#{path}/#{name}") ? :dir : :file}
+            # if ::File.directory? "#{path}/#{relative_name}"
+            #   block.call relative_name, :dir
+            # else
+            #   block.call relative_name, :file
+            # end
+          end
+        end
+      end
+      # def efficient_dir_copy from, to, override
+      #   return false if override # FileUtils.cp_r doesn't support this behaviour
+      #
+      #   from.driver.open_fs do |from_fs|
+      #     to.driver.open_fs do |to_fs|
+      #       if from_fs.local? and to_fs.local?
+      #         FileUtils.cp_r from.path, to.path
+      #         true
+      #       else
+      #         false
+      #       end
+      #     end
+      #   end
+      # end
+      #
+      # Other
+      #
+      def local?; true end
+      def tmp &block
+        path = "/tmp/#{rand(10**6)}"
+        # tmp_dir = "#{::Dir.tmpdir}/#{rand(10**6)}"
+        if block
+          begin
+            ::FileUtils.mkdir_p with_root(path)
+            block.call path
+          ensure
+            ::FileUtils.rm_r with_root(path) if ::File.exist? with_root(path)
+          end
+        else
+          ::FileUtils.mkdir_p with_root(path)
+          path
+        end
+      end
+      def to_s; '' end
+      protected
+        def root
+          @root || raise('root not defined!')
+        end
+        def with_root path
+          path == '/' ? root : root + path
+        end
+    end
+  end
+end

data/lib/vfs/drivers/specification.rb ADDED Viewed

@@ -0,0 +1,169 @@
+require 'rspec_ext'
+require 'ruby_ext'
+shared_examples_for 'vfs driver basic' do
+  it 'should respond to :local?' do
+    @driver.should respond_to(:local?)
+  end
+  it "should provide open method" do
+    @driver.open
+    @driver.open{'result'}.should == 'result'
+  end
+end
+shared_examples_for 'vfs driver attributes basic' do
+  it 'should have root dir' do
+    attrs = @driver.attributes('/')
+    attrs[:dir].should  be_true
+    attrs[:file].should be_false
+  end
+  it "attributes should return nil if there's no entry" do
+    @driver.attributes('/non_existing_entry').should be_nil
+  end
+end
+shared_examples_for 'vfs driver files' do
+  it "file attributes" do
+    @driver.attributes('/file').should be_nil
+    @driver.write_file('/file', false){|w| w.write 'something'}
+    attrs = @driver.attributes('/file')
+    attrs[:file].should be_true
+    attrs[:dir].should  be_false
+  end
+  it "read, write, append" do
+    # write
+    @driver.write_file('/file', false){|w| w.write 'something'}
+    @driver.attributes('/file')[:file].should == true
+    # read
+    data = ""
+    @driver.read_file('/file'){|buff| data << buff}
+    data.should == 'something'
+    # append
+    @driver.write_file('/file', true){|w| w.write ' another'}
+    data = ""
+    @driver.read_file('/file'){|buff| data << buff}
+    data.should == 'something another'
+  end
+  it "delete_file" do
+    @driver.write_file('/file', false){|w| w.write 'something'}
+    @driver.attributes('/file')[:file].should be_true
+    @driver.delete_file('/file')
+    @driver.attributes('/file').should be_nil
+  end
+end
+shared_examples_for 'vfs driver full attributes for files' do
+  it "attributes for files" do
+    @driver.write_file('/file', false){|w| w.write 'something'}
+    attrs = @driver.attributes('/file')
+    attrs[:file].should be_true
+    attrs[:dir].should  be_false
+    attrs[:created_at].class.should == Time
+    attrs[:updated_at].class.should == Time
+    attrs[:size].should == 9
+  end
+end
+shared_examples_for 'vfs driver dirs' do
+  it "directory crud" do
+    @driver.attributes('/dir').should be_nil
+    @driver.create_dir('/dir')
+    attrs = @driver.attributes('/dir')
+    attrs[:file].should be_false
+    attrs[:dir].should  be_true
+    @driver.delete_dir('/dir')
+    @driver.attributes('/dir').should be_nil
+  end
+  it 'should delete not-empty directories' do
+    @driver.create_dir('/dir')
+    @driver.create_dir('/dir/dir2')
+    @driver.write_file('/dir/dir2/file', false){|w| w.write 'something'}
+    @driver.attributes('/dir').should_not be_nil
+    @driver.delete_dir('/dir')
+    @driver.attributes('/dir').should be_nil
+  end
+  it 'each' do
+    -> {@driver.each_entry('/not_existing_dir', nil){|path, type| list[path] = type}}.should raise_error
+    @driver.create_dir '/dir'
+    @driver.create_dir('/dir/dir2')
+    @driver.write_file('/dir/file', false){|w| w.write 'something'}
+    list = {}
+    @driver.each_entry '/dir', nil do |path, type|
+      type = type.call if type.is_a? Proc
+      list[path] = type
+    end
+    list.should == {'dir2' => :dir, 'file' => :file}
+  end
+  # it "upload_directory & download_directory" do
+  #   upload_path_check = "#{@remote_path}/dir2/file"
+  #   check_attributes upload_path_check, nil
+  #   @driver.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
+  #   @driver.download_directory(@remote_path, @to_local)
+  #   File.exist?(download_path_check).should be_true
+  # end
+end
+shared_examples_for 'vfs driver query' do
+  it 'each with query' do
+    @driver.create_dir '/dir'
+    @driver.create_dir('/dir/dir_a')
+    @driver.create_dir('/dir/dir_b')
+    @driver.write_file('/dir/file_a', false){|w| w.write 'something'}
+    list = {}
+    @driver.each_entry '/dir', '*_a' do |path, type|
+      type = type.call if type.is_a? Proc
+      list[path] = type
+    end
+    list.should == {'dir_a' => :dir, 'file_a' => :file}
+  end
+end
+shared_examples_for 'vfs driver full attributes for dirs' do
+  it "attributes for dirs" do
+    @driver.create_dir('/dir')
+    attrs = @driver.attributes('/dir')
+    attrs[:file].should be_false
+    attrs[:dir].should  be_true
+    attrs[:created_at].class.should == Time
+    attrs[:updated_at].class.should == Time
+    attrs.should_not include(:size)
+  end
+end
+shared_examples_for 'vfs driver tmp dir' do
+  it "tmp dir" do
+    dir = @driver.tmp
+    @driver.attributes(dir).should_not be_nil
+    @driver.delete_dir dir
+    @driver.attributes(dir).should be_nil
+    dir = nil
+    @driver.tmp do |tmp_dir|
+      dir = tmp_dir
+      @driver.attributes(dir).should_not be_nil
+    end
+    @driver.attributes(dir).should be_nil
+  end
+end