rfusefs 1.0.2.RC1 → 1.1.0

data/.gitignore

@@ -1,9 +0,0 @@
-#No hidden files (except for .gitignore)
-.*
-!.gitignore
-!.travis.yml
-#Files generated by rake
-doc
-pkg
-#Jedit stupid default backup settings
-*'`'

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-rvm:
-  - "1.8.7"
-  - "1.9.3"
-  - "2.0.0"
-before_install:
-  - sudo apt-get update -qq
-  - sudo apt-get install -qq libfuse-dev

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in rfusefs.gemspec
-gemspec

data/History.rdoc

@@ -1,28 +0,0 @@
-=== 1.0.1 / 2013-12-19
-
-* Add FuseFS.main to create pretty usage messages
-
-* Support extended attributes in filesystems
-
-* Updates and cleanup of PathMapperFS
-
-* Provide SqliteMapperFS
-
-=== 1.0.0 / 2012-08-07
-
-* Depend on new rfuse 1.0.0, Ruby 1.9
-
-* API breaking changes
-
-  * order of arguments to {FuseFS.mount}, {FuseFS.start} changed 
-    to account for better option handling in RFuse
-
-=== 0.8.0 / 2011-02-19
-
-* Initial port from fusefs
-
-  * Improved raw methods
-  * new "times" api for including atime,mtime,ctime in stat results
-  * metadir allow mv directories
-  * includes PathMapperFS
-

data/README.rdoc

@@ -1,106 +0,0 @@
-= rfusefs
-
-* https://rubygems.org/gems/rfusefs
-* https://github.com/lwoggardner/rfusefs
-
-== DESCRIPTION
-
-RFuseFS is a port of the FuseFS[http://rubygems.org/gems/fusefs/]
-library aimed at allowing Ruby programmers to quickly and easily create
-virtual filesystems with little more than a few lines of code.
-
-RFuseFS is api compatible with FuseFS (0.7.0)
-
-== SYNOPSIS
-
-FuseFS provides a layer of abstraction to a programmer who wants to create a
-virtual filesystem via FUSE.
-
-First define a virtual directory by subclassing {FuseFS::FuseDir}
-
-See samples under /samples and also the following starter classes
-
-* {FuseFS::FuseDir}
-* {FuseFS::MetaDir}
-* {FuseFS::DirLink}
-* {FuseFS::PathMapperFS}
-* {FuseFS::SqliteMapperFS}
-
-Then start your filesystem with
-
-* {FuseFS.start}
-* {FuseFS.main}
-
-Finally to use the filesystem open up your favourite file browser/terminal and
-explore the contents under <mountpoint>
-
-Happy Filesystem Hacking!
-
-=== the hello world filesystem in 14 LOC
-
-  require 'rfusefs'
-
-  class HelloDir
-
-    def contents(path)
-      ['hello.txt']
-    end
-
-    def file?(path)
-      path == '/hello.txt'
-    end
-
-    def read_file(path)
-      "Hello, World!\n"
-    end
-
-  end
-
-  # Usage: #{$0} mountpoint [mount_options]
-  FuseFS.main() { |options| HelloDir.new }
-
-== REQUIREMENTS:
-
-* FUSE (http://fuse.sourceforge.org)
-* Ruby (>=1.9)
-* rfuse (~> 1.0)
-
-== INSTALL:
-
-* gem install rfusefs
-
-== DEVELOPERS:
-
-After checking out the source, run:
-
-  $ bundle install # install dependencies
-  $ rake spec # run tests
-  $ rake yard # generate docs
-
-
-== LICENSE:
-
-(The MIT License)
-
-* Copyright (c) 2005 Greg Millam. (FuseFS)
-* Copyright (c) 2009 Kyle Maxwell. (FuseFS)
-* Copyright (c) 2012 Grant Gardner. (RFuseFS)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,22 +0,0 @@
-# -*- ruby -*-
-require "bundler/gem_tasks"
-require 'yard'
-require 'rspec/core/rake_task'
-require 'rake/clean'
-
-CLOBBER.include [ "pkg/","doc/" ]
-
-YARD::Rake::YardocTask.new do |t|
-        # Need this because YardocTask does not read the gemspec
-        t.files   = ['lib/**/*.rb', '-','History.rdoc']   # optional
-end
-
-RSpec::Core::RakeTask.new(:spec)
-
-desc "FuseFS compatibility specs"
-RSpec::Core::RakeTask.new("spec:fusefs") do |t|
-  t.pattern = 'spec-fusefs/**/*_spec.rb'
-end
-
-task :default => ["spec","spec:fusefs"]
-# vim: syntax=ruby

data/TODO.txt

@@ -1,6 +0,0 @@
-
-= TODO
-
- Fix (or remove) samples
-
-

data/lib/fuse/fusedir.rb

@@ -1,313 +0,0 @@
-module FuseFS
-
-    # Helper for filesystem accounting
-    class StatsHelper
-
-        # @return [Integer] size of filesystem in bytes
-        attr_accessor :max_space
-        # @return [Integer] maximum number of (virtual) inodes
-        attr_accessor :max_nodes
-
-        # If set true, adjustments that cause space/nodes to exceed
-        # the maximums will raise ENOSPC (no space left on device)
-        # @return [Boolean]
-        attr_accessor :strict
-
-        # @return [Integer] used space in bytes
-        attr_reader :space
-
-        # @return [Integer] used inodes (typically count of files and directories)
-        attr_reader :nodes
-
-        #
-        # @param [Integer] max_space
-        # @param [Integer] max_nodes
-        # @param [Booleanr] strict
-        def initialize(max_space=nil,max_nodes=nil,strict=false)
-            @nodes = 0
-            @space = 0
-            @max_space = max_space
-            @max_nodes = max_nodes
-            @strict = strict
-        end
-
-        # Adjust accumlated statistics
-        # @param [Integer] delta_space change in {#space} usage
-        # @param [Integer] delta_nodes change in {#nodes} usage
-        #
-        # @return [void]
-        # @raise [Errno::ENOSPC] if {#strict} and adjusted {#space}/{#nodes} would exceed {#max_space} or {#max_nodes}
-        def adjust(delta_space,delta_nodes=0)
-            @nodes += delta_nodes
-            @space += delta_space
-            raise Errno::ENOSPC if @strict && ( @nodes >  @max_nodes ||  @space > @max_space )
-        end
-
-        # @overload to_statistics()
-        #   @return [Array<Integer>] in format expected by {FuseDir#statistics}
-        # @overload to_statistics(free_space,free_nodes)
-        #   Calculate total space so that free space remains fixed
-        #   @param [Integer] free_space available space in bytes
-        #   @param [Integer] free_nodes available (virtual) inodes
-        #   @return [Array<Integer>] in format expected by {FuseDir#statistics}
-        def to_statistics(free_space=nil,free_nodes=nil)
-            total_space = free_space ? space + free_space : max_space
-            total_nodes = free_nodes ? nodes + free_nodes : max_nodes
-            [ @space, @nodes, total_space, total_nodes ]
-        end
-    end
-
-    # This class is equivalent to using Object.new() as the virtual directory
-    # for target for {FuseFS.start}. It exists primarily to document the API
-    # but can also be used as a superclass for your filesystem providing sensible defaults
-    #
-    # == Method call sequences
-    #
-    # === Stat (getattr)
-    #
-    # FUSE itself will generally stat referenced files and validate the results
-    # before performing any file/directory operations so this sequence is called
-    # very often
-    #   
-    # 1. {#directory?} is checked first
-    #    * {#can_write?} OR {#can_mkdir?} with .\_rfusefs_check\_ to determine write permissions
-    #    * {#times} is called to determine atime,mtime,ctime info for the directory
-    #
-    # 2. {#file?} is checked next
-    #    * {#can_write?}, {#executable?}, {#size}, {#times} are called to fill out the details
-    #
-    # 3. otherwise we tell FUSE that the path does not exist
-    #
-    # === List directory 
-    # 
-    # FUSE confirms the path is a directory (via stat above) before we call {#contents}
-    #
-    # FUSE will generally go on to stat each directory entry in the results
-    #
-    # === Reading files
-    #
-    # FUSE confirms path is a file before we call {#read_file}
-    #
-    # For fine control of file access see  {#raw_open}, {#raw_read}, {#raw_close}
-    #
-    # === Writing files
-    #
-    # FUSE confirms path for the new file is a directory
-    #
-    # * {#can_write?} is checked at file open
-    # * {#write_to} is called when the file is synced, flushed or closed
-    #
-    # See also {#raw_open}, {#raw_truncate}, {#raw_write}, {#raw_sync}, {#raw_close}
-    #
-    # === Deleting files
-    #
-    # FUSE confirms path is a file before we call {#can_delete?} then {#delete}
-    #
-    # === Creating directories
-    #
-    # FUSE confirms parent is a directory before we call {#can_mkdir?} then {#mkdir}
-    #
-    # === Deleting directories
-    #
-    # FUSE confirms path is a directory before we call {#can_rmdir?} then {#rmdir}
-    #
-    # === Renaming files and directories
-    #
-    # FUSE confirms the rename is valid (eg. not renaming a directory to a file)
-    #
-    # * Try {#rename} to see if the virtual directory wants to handle this itself
-    # * If rename returns false/nil then we try to copy/delete (files only) ie.
-    #   * {#file?}(from), {#can_write?}(to), {#can_delete?}(from) and if all true
-    #   * {#read_file}(from), {#write_to}(to), {#delete}(from)
-    # * otherwise reject the rename
-    class FuseDir
-        INIT_TIMES = Array.new(3,0)
-
-        #   base,rest = split_path(path) 
-        # @return [Array<String,String>] base,rest. base is the first directory in
-        #                                path, and rest is nil> or the remaining path.
-        #                                Typically if rest is not nil? you should 
-        #                                recurse the paths 
-        def split_path(path)
-            cur, *rest = path.scan(/[^\/]+/)
-            if rest.empty?
-                [ cur, nil ]
-            else
-                [ cur, File::SEPARATOR + File.join(rest) ]
-            end
-        end
-
-        #   base,*rest = scan_path(path)
-        # @return [Array<String>] all directory and file elements in path. Useful
-        #                         when encapsulating an entire fs into one object
-        def scan_path(path)
-            path.scan(/[^\/]+/)
-        end
-
-        # @abstract FuseFS api
-        # @return [Boolean] true if path is a directory
-        def directory?(path);return false;end
-
-        # @abstract FuseFS api
-        # @return [Boolean] true if path is a file
-        def file?(path);end
-
-        # @abstract FuseFS api
-        # @return [Array<String>] array of file and directory names within path
-        def contents(path);return [];end
-
-        # @abstract FuseFS api
-        # @return [Boolean] true if path is an executable file
-        def executable?(path);return false;end
-
-        # File size
-        # @abstract FuseFS api
-        # @return [Integer] the size in byte of a file (lots of applications rely on this being accurate )
-        def size(path); read_file(path).length ;end
-
-        # File time information. RFuseFS extension.
-        # @abstract FuseFS api
-        # @return [Array<Integer, Time>] a 3 element array [ atime, mtime. ctime ] (good for rsync etc)
-        def times(path);return INIT_TIMES;end
-
-        # @abstract FuseFS api
-        # @return [String] the contents of the file at path
-        def read_file(path);return "";end
-
-        # @abstract FuseFS api
-        # @return [Boolean] true if the user can write to file at path
-        def can_write?(path);return false;end
-
-        # Write the contents of str to file at path
-        # @abstract FuseFS api
-        # @return [void]
-        def write_to(path,str);end
-
-        # @abstract FuseFS api
-        # @return [Boolean] true if the user can delete the file at path
-        def can_delete?(path);return false;end
-
-        # Delete the file at path
-        # @abstract FuseFS api
-        # @return [void]
-        def delete(path);end
-
-        # @abstract FuseFS api
-        # @return [Boolean] true if user can make a directory at path
-        def can_mkdir?(path);return false;end
-
-        # Make a directory at path
-        # @abstract FuseFS api
-        # @return [void]
-        def mkdir(path);end
-
-        # @abstract FuseFS api
-        # @return [Boolean] true if user can remove a directory at path
-        def can_rmdir?(path);return false;end
-
-        # Remove the directory at path
-        # @abstract FuseFS api
-        # @return [void]
-        def rmdir(path);end
-
-        # Neat toy. Called when a file is touched or has its timestamp explicitly modified
-        # @abstract FuseFS api
-        # @return [void]
-        def touch(path,modtime);end
-
-        # Move a file or directory.
-        # @abstract FuseFS api
-        # @return [Boolean] true to indicate the rename has been handled,
-        #                  otherwise will fallback to copy/delete
-        def rename(from_path,to_path);end
-
-        # Raw file access  
-        # @abstract FuseFS api
-        # @param mode [String] "r","w" or "rw", with "a" if file is opened for append
-        # @param rfusefs [Boolean] will be "true" if RFuseFS extensions are available
-        # @return [nil] to indicate raw operations are not implemented
-        # @return [Object] a filehandle
-        #                  Under RFuseFS this object will be passed back in to the other raw
-        #                  methods as the optional parameter _raw_
-        #
-        def raw_open(path,mode,rfusefs = nil);end
-
-        # RFuseFS extension.
-        # @abstract FuseFS api
-        #
-        # @overload raw_truncate(path,offset,raw)
-        #  Truncate an open file to offset bytes
-        #  @param [String] path
-        #  @param [Integer] offset
-        #  @param [Object] raw the filehandle returned from {#raw_open}
-        #  @return [void]
-        #
-        # @overload raw_truncate(path,offset)
-        #  Optionally truncate a file to offset bytes directly
-        #  @param [String] path
-        #  @param [Integer] offset
-        #  @return [Boolean]
-        #    if truncate has been performed, otherwise the truncation will be performed with {#read_file} and {#write_to}
-        #
-        def raw_truncate(path,offset,raw=nil);end
-
-        # Read _sz_ bytes from file at path (or filehandle raw) starting at offset off
-        #
-        # @param [String] path
-        # @param [Integer] offset
-        # @param [Integer] size
-        # @param [Object] raw the filehandle returned by {#raw_open}
-        # @abstract FuseFS api
-        # @return [void]
-        def raw_read(path,offset,size,raw=nil);end
-
-        # Write _sz_ bytes from file at path (or filehandle raw) starting at offset off
-        # @abstract FuseFS api
-        # @return [void]
-        def raw_write(path,off,sz,buf,raw=nil);end
-
-
-        # Sync buffered data to your filesystem
-        # @param [String] path
-        # @param [Boolena] datasync only sync user data, not metadata
-        # @param [Object] raw the filehandle return by {#raw_open}
-        def raw_sync(path,datasync,raw=nil);end
-
-        # Close the file previously opened at path (or filehandle raw)
-        # @abstract FuseFS api
-        # @return [void]
-        def raw_close(path,raw=nil);end
-
-        # RFuseFS extension.
-        # Extended attributes.
-        # @param [String] path
-        # @return [Hash] extended attributes for this path.
-        #   The returned object  will be manipulated directly using :[] :[]=,, :keys and :delete
-        #   so the default (a new empty hash on every call) will not retain attributes that are set
-        # @abstract FuseFS api
-        def xattr(path); {} ; end
-
-        # RFuseFS extensions.
-        # File system statistics
-        # @param [String] path
-        # @return [Array<Integer>] the statistics
-        #   used_space (in bytes), used_files, max_space, max_files
-        #   See {StatsHelper}
-        # @return [RFuse::StatVfs] or raw statistics
-        # @abstract FuseFS api
-        def statistics(path); [0,0,0,0]; end
-
-        # RFuseFS extension.
-        # Called when the filesystem is mounted
-        # @return [void]
-        def mounted();end
-
-        # RFuseFS extension.
-        # Called when the filesystem is unmounted
-        # @return [void]
-        def unmounted();end
-
-    end
-
-    DEFAULT_FS = FuseDir.new()
-end