virtualfs 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+*.pstore
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    virtualfs (0.0.1)
+      github_api (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    fakefs (0.4.2)
+    faraday (0.8.4)
+      multipart-post (~> 1.1)
+    github_api (0.8.6)
+      faraday (~> 0.8.1)
+      hashie (~> 1.2.0)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (1.2.0)
+    httpauth (0.2.0)
+    jwt (0.1.5)
+      multi_json (>= 1.0)
+    multi_json (1.5.0)
+    multipart-post (1.1.5)
+    nokogiri (1.5.6)
+    oauth2 (0.8.0)
+      faraday (~> 0.8)
+      httpauth (~> 0.1)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      rack (~> 1.2)
+    rack (1.4.1)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakefs (~> 0.4)
+  rspec (~> 2.12)
+  virtualfs!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rafał Hirsz
+
+MIT License
+
+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/README.md

@@ -0,0 +1,81 @@
+# VirtualFS
+
+This is a library that allows you to access various datastores in a unified way. Local FS and Github support in included, feel free to contibute other backends.
+
+The API is designed to be compatible with the standard File and Dir APIs. Currently data access is read-only.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'virtualfs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install virtualfs
+
+## Usage
+
+### Read a file for a local directory
+
+    fs = VirtualFS::Local.new :path => '/home/evol/hello'
+    file = fs["hello_world"].first  # fs[pattern] is an alias for fs.glob(pattern)
+
+    file.read
+
+### List the root directory of a Github repository
+
+    fs = VirtualFS::Github.new :user => 'evoL', :repo => 'virtualfs'
+    fs.entries
+
+### Find recursively files in subfolders
+
+    fs = VirtualFS::Github.new :user => 'evoL', :repo => 'virtualfs'
+    rb_files = fs.glob('**/*.rb')
+
+### Caching
+
+    cache = VirtualFS::FileCache.new :filename => 'file.cache', :expires_after => 3600
+    fs = VirtualFS::Github.new :user => 'evoL', :repo => 'virtualfs', :cache => cache
+
+Available cache providers are `RuntimeCache` and `FileCache`.
+
+## The Anatomy of a Backend
+
+A backend is a subclass of `VirtualFS::Backend`. It has to define the following methods:
+
+- `#entries` - lists the contents of a directory, like `Dir.entries`. Optionally accepts a `path` parameter, which specifies the path to the directory that will be listed. By default it lists the root directory of the backend.
+- `#glob` - lists files mathing the `pattern`, like `Dir.glob`. Optionally accepts a `path` parameter.
+- `#stream_for` - returns an `IO` object for the file specified by the `path` parameter.
+
+The arrays returned by `#entries` and `#glob` are arrays of `VirtualFS::Dir` and `VirtualFS::File` objects, which mimic the API of the respective standard library classes. The `VirtualFS::Backend` class provides the `#map_entries` method for easy creation of those lists within backends.
+
+Basic usage:
+
+    map_entries(paths) { |path| is_directory? path }
+
+Instead of an array of strings you can supply an array of any objects, as long as they have a method for getting the path. The default method for getting the path of an object is `#to_s`.
+
+    map_entries(objects, :get_path) { |obj| obj.is_directory? }
+
+Also, it is possible to cache the results of your code in the backend. It's simple:
+
+    cache { get_your_remote_data }
+
+The remote data will then be cached using the user specified cache provider.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+(c) 2013 Rafał Hirsz. This work is licensed under the terms of the MIT license.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/virtualfs/backend.rb

@@ -0,0 +1,49 @@
+require 'virtualfs/dir'
+require 'virtualfs/file'
+
+module VirtualFS
+  class NullCache
+    def cache(key)
+      yield
+    end
+  end
+
+  class Backend
+    def initialize(opts={})
+      @cache = opts[:cache] || NullCache.new
+    end
+
+    def cache(&proc)
+      local_variable_values = eval('local_variables.map { |var| eval(var.to_s) }', proc.binding)
+      key = caller[0] << local_variable_values.inspect
+      @cache.cache(key, &proc)
+    end
+
+    def map_entries(paths, method=:to_s, &dir_criteria)
+      paths.map do |path|
+        if dir_criteria.call(path)
+          VirtualFS::Dir.new(path.send(method), self)
+        else
+          VirtualFS::File.new(path.send(method), self)
+        end
+      end
+    end
+
+    def entries(path=nil)
+      # override this
+      raise NotImplementedError
+    end
+
+    def glob(pattern, path=nil)
+      # override this
+      raise NotImplementedError
+    end
+
+    def stream_for(path)
+      # override this
+      raise NotImplementedError
+    end
+
+    alias_method :[], :glob
+  end
+end

data/lib/virtualfs/dir.rb

@@ -0,0 +1,29 @@
+module VirtualFS
+  class Dir
+    include Enumerable
+    attr_reader :path
+
+    def initialize(path, backend)
+      @path = path
+      @backend = backend
+    end
+
+    def entries
+      @backend.entries @path
+    end
+
+    def glob(pattern)
+      @backend.glob pattern, @path
+    end
+
+    def each(&block)
+      entries.each(&block)
+    end
+
+    def inspect
+      "<#{@backend.class.name} '#{@path}' (dir)>"
+    end
+
+    alias_method :[], :glob
+  end
+end

data/lib/virtualfs/file.rb

@@ -0,0 +1,19 @@
+module VirtualFS
+  class File
+    attr_reader :path
+
+    def initialize(path, backend)
+      @path = path
+      @backend = backend
+    end
+
+    def method_missing(method, *args)
+      @stream ||= @backend.stream_for(@path)
+      @stream.send(method, *args)
+    end
+
+    def inspect
+      "<#{@backend.class.name} '#{@path}'>"
+    end
+  end
+end

data/lib/virtualfs/file_cache.rb

@@ -0,0 +1,31 @@
+require 'pstore'
+
+module VirtualFS
+  class FileCache
+    attr_accessor :expires_after
+
+    def initialize(opts={})
+      @expires_after = opts[:expires_after] || -1
+
+      @store = PStore.new(opts[:filename] || 'virtualfs.pstore')
+    end
+
+    def cache(key, &proc)
+      access_time = Time.now
+
+      @store.transaction do
+        data = @store[key] || {:time => access_time, :content => nil}
+
+        # Invalidate cache after some time
+        if (@expires_after > -1) && ((access_time - data[:time]) > @expires_after)
+          data = {:time => access_time, :content => nil}
+        end
+
+        data[:content] ||= yield
+        @store[key] = data
+
+        data[:content]
+      end
+    end
+  end
+end

data/lib/virtualfs/github.rb

@@ -0,0 +1,62 @@
+require 'virtualfs/backend'
+
+require 'base64'
+require 'stringio'
+require 'github_api'
+
+module VirtualFS
+  class Github < Backend
+    attr_reader :user, :repo, :branch
+
+    def initialize(opts={})
+      super opts
+
+      @gh = ::Github.new
+
+      @user = opts.fetch(:user)
+      @repo = opts.fetch(:repo)
+      @branch = opts.fetch(:branch, 'master')
+    end
+
+    def entries(path=nil)
+      contents = path.nil? ? toplevel_contents : tree_contents(path)
+
+      map_entries(contents.values, :path) { |item| item.type == 'tree' }
+    end
+
+    def glob(pattern, path=nil)
+      contents = path.nil? ? internal_items : tree_contents(path, true)
+
+      map_entries(contents.select { |path, _| ::File.fnmatch(pattern, path, ::File::FNM_PATHNAME) }.values, :path) { |item| item.type == 'tree' }
+    end
+
+    def stream_for(path)
+      item = internal_items.fetch(path)
+      raise 'Not a file' unless item.type == 'blob'
+
+      StringIO.new internal_blob(item.sha)
+    end
+
+  private
+
+    def internal_items
+      cache do
+        @gh.git_data.trees.get(@user, @repo, @branch, :recursive => true).tree.reduce({}) { |hash, item| hash[item.path] = item; hash }
+      end
+    end
+
+    def tree_contents(tree, recursive=false)
+      internal_items.select { |item, _| item.start_with?("#{tree}/") && (recursive || !item.slice((tree.length+1)..-1).include?('/')) }
+    end
+
+    def toplevel_contents
+      internal_items.reject { |item, _| item.include? '/' }
+    end
+
+    def internal_blob(sha)
+      cache do
+        Base64.decode64 @gh.git_data.blobs.get(@user, @repo, sha).content
+      end
+    end
+  end
+end

data/lib/virtualfs/local.rb

@@ -0,0 +1,39 @@
+require 'virtualfs/backend'
+require 'virtualfs/dir'
+require 'virtualfs/file'
+require 'stringio'
+
+module VirtualFS
+  class Local < Backend
+    def initialize(opts={})
+      super opts
+
+      @path = opts.fetch(:path)
+    end
+
+    def entries(path=nil)
+      p = path || @path
+
+      contents = ::Dir.glob(::File.join(p, '*'), ::File::FNM_DOTMATCH)
+
+      cache do
+        # The slice is for removing the '.' and '..' entries
+        map_entries(contents.slice(2, contents.length)) { |path| ::File.directory? path }
+      end
+    end
+
+    def glob(pattern, path=nil)
+      p = path || @path
+
+      cache do
+        map_entries(::Dir.glob(::File.join(p, pattern))) { |path| ::File.directory? path }
+      end
+    end
+
+    def stream_for(path)
+      StringIO.new( open(::File.join(@path, path), 'r') { |io| io.read } )
+    end
+
+    alias_method :[], :glob
+  end
+end

data/lib/virtualfs/runtime_cache.rb

@@ -0,0 +1,25 @@
+module VirtualFS
+  class RuntimeCache
+    attr_accessor :expires_after
+
+    def initialize(opts={})
+      @expires_after = opts[:expires_after] || -1
+
+      @store = {}
+      @times = {}
+    end
+
+    def cache(key, &proc)
+      access_time = Time.now
+
+      # Invalidate cache after some time
+      if (@expires_after > -1) && ((access_time - (@times[key] || access_time)) > @expires_after)
+        @times[key] = access_time
+        @store[key] = nil
+      end
+
+      @times[key] ||= access_time
+      @store[key] ||= yield
+    end
+  end
+end

data/lib/virtualfs/version.rb

@@ -0,0 +1,3 @@
+module VirtualFS
+  VERSION = "0.0.1"
+end

data/lib/virtualfs.rb

@@ -0,0 +1,9 @@
+require "virtualfs/version"
+
+# Backends
+require "virtualfs/local"
+require "virtualfs/github"
+
+# Caches
+require "virtualfs/runtime_cache"
+require "virtualfs/file_cache"

data/virtualfs.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/virtualfs/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rafał Hirsz"]
+  gem.email         = ["rafal@hirsz.co"]
+  gem.summary       = %q{Allows accessing remote datastores in a unified way.}
+  gem.homepage      = "https://github.com/evoL/virtualfs"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "virtualfs"
+  gem.require_paths = ["lib"]
+  gem.version       = VirtualFS::VERSION
+
+  gem.add_dependency 'github_api', '~> 0.8'
+
+  gem.add_development_dependency 'rspec', '~> 2.12'
+  gem.add_development_dependency 'fakefs', '~> 0.4'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: virtualfs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rafał Hirsz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: github_api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: 
+email:
+- rafal@hirsz.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/virtualfs.rb
+- lib/virtualfs/backend.rb
+- lib/virtualfs/dir.rb
+- lib/virtualfs/file.rb
+- lib/virtualfs/file_cache.rb
+- lib/virtualfs/github.rb
+- lib/virtualfs/local.rb
+- lib/virtualfs/runtime_cache.rb
+- lib/virtualfs/version.rb
+- virtualfs.gemspec
+homepage: https://github.com/evoL/virtualfs
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Allows accessing remote datastores in a unified way.
+test_files: []