virtualfs 0.0.2 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    virtualfs (0.0.1)
+    virtualfs (0.0.2)
       github_api (~> 0.8)
 
 GEM
@@ -11,7 +11,7 @@ GEM
     fakefs (0.4.2)
     faraday (0.8.4)
       multipart-post (~> 1.1)
-    github_api (0.8.6)
+    github_api (0.8.7)
       faraday (~> 0.8.1)
       hashie (~> 1.2.0)
       multi_json (~> 1.4)
@@ -30,7 +30,7 @@ GEM
       jwt (~> 0.1.4)
       multi_json (~> 1.0)
       rack (~> 1.2)
-    rack (1.4.1)
+    rack (1.4.4)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)

data/lib/virtualfs/backend.rb

@@ -29,6 +29,10 @@ module VirtualFS
       end
     end
 
+    def dotfolders_for(path)
+      [VirtualFS::Dir.new(::File.join(path, '.'), self), VirtualFS::Dir.new(::File.join(path, '..'), self)]
+    end
+
     def entries(path=nil)
       # override this
       raise NotImplementedError

data/lib/virtualfs/dir.rb

@@ -1,19 +1,32 @@
 module VirtualFS
   class Dir
     include Enumerable
-    attr_reader :path
 
     def initialize(path, backend)
       @path = path
+      @realpath = VirtualFS.realpath(path)
       @backend = backend
     end
 
+    def path
+      @realpath
+    end
+
+    def name
+      name = @path.rpartition('/').last
+      name.empty? ? '/' : name
+    end
+
+    def directory?
+      true
+    end
+
     def entries
-      @backend.entries @path
+      @backend.entries @realpath
     end
 
     def glob(pattern)
-      @backend.glob pattern, @path
+      @backend.glob pattern, @realpath
     end
 
     def each(&block)
@@ -21,7 +34,13 @@ module VirtualFS
     end
 
     def inspect
-      "<#{@backend.class.name} '#{@path}' (dir)>"
+      if ['.','..'].include? name
+        p = @path
+      else
+        p = @realpath
+      end
+
+      "<#{@backend.class.name} '#{p}' (dir)>"
     end
 
     alias_method :[], :glob

data/lib/virtualfs/file.rb

@@ -3,10 +3,18 @@ module VirtualFS
     attr_reader :path
 
     def initialize(path, backend)
-      @path = path
+      @path = VirtualFS.realpath(path)
       @backend = backend
     end
 
+    def name
+      @path.rpartition('/').last
+    end
+
+    def directory?
+      false
+    end
+
     def method_missing(method, *args)
       @stream ||= @backend.stream_for(@path)
       @stream.send(method, *args)

data/lib/virtualfs/github.rb

@@ -11,27 +11,34 @@ module VirtualFS
     def initialize(opts={})
       super opts
 
-      @gh = ::Github.new
-
       @user = opts.fetch(:user)
       @repo = opts.fetch(:repo)
       @branch = opts.fetch(:branch, 'master')
+
+      @gh = ::Github::GitData.new(opts)
     end
 
-    def entries(path=nil)
-      contents = path.nil? ? toplevel_contents : tree_contents(path)
+    def entries(path='/')
+      path = '/' << path unless path.start_with? '/'
+      p = path[1..-1]
 
-      map_entries(contents.values, :path) { |item| item.type == 'tree' }
+      contents = path == '/' ? toplevel_contents : tree_contents(p)
+      dotfolders_for(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)
+    def glob(pattern, path='/')
+      path = '/' << path unless path.start_with? '/'
+      p = path[1..-1]
 
+      contents = path == '/' ? internal_items : tree_contents(p, 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)
+      path = '/' << path unless path.start_with? '/'
+      p = path[1..-1]
+
+      item = internal_items.fetch(p)
       raise 'Not a file' unless item.type == 'blob'
 
       StringIO.new internal_blob(item.sha)
@@ -43,7 +50,7 @@ module VirtualFS
 
     def internal_items
       cache do
-        @gh.git_data.trees.get(@user, @repo, @branch, :recursive => true).tree.reduce({}) { |hash, item| hash[item.path] = item; hash }
+        @gh.trees.get(@user, @repo, @branch, :recursive => true).tree.reduce({}) { |hash, item| hash[item.path] = item; hash }
       end
     end
 
@@ -57,7 +64,7 @@ module VirtualFS
 
     def internal_blob(sha)
       cache do
-        Base64.decode64 @gh.git_data.blobs.get(@user, @repo, sha).content
+        Base64.decode64 @gh.blobs.get(@user, @repo, sha).content
       end
     end
   end

data/lib/virtualfs/local.rb

@@ -8,30 +8,33 @@ module VirtualFS
     def initialize(opts={})
       super opts
 
-      @path = opts.fetch(:path)
+      @path = ::File.realpath(opts.fetch(:path))
     end
 
-    def entries(path=nil)
-      p = path || @path
+    def entries(path='/')
+      p = VirtualFS.realpath(path)
 
-      contents = ::Dir.glob(::File.join(p, '*'), ::File::FNM_DOTMATCH)
+      contents = ::Dir.entries(::File.join(@path, p)).map { |entry| ::File.join(p, entry) }
 
       cache do
-        # The slice is for removing the '.' and '..' entries
-        map_entries(contents.slice(2, contents.length)) { |path| ::File.directory? path }
+        map_entries(contents) { |path| ::File.directory?(::File.join(@path, path)) }
       end
     end
 
-    def glob(pattern, path=nil)
-      p = path || @path
+    def glob(pattern, path='/')
+      p = VirtualFS.realpath(path)
+
+      contents = ::Dir.glob(::File.join(@path, p, pattern)).map { |entry| entry.sub(@path, '') }
 
       cache do
-        map_entries(::Dir.glob(::File.join(p, pattern))) { |path| ::File.directory? path }
+        map_entries(contents) { |path| ::File.directory?(::File.join(@path, path)) }
       end
     end
 
     def stream_for(path)
-      StringIO.new( open(::File.join(@path, path), 'r') { |io| io.read } )
+      path = VirtualFS.realpath(path)
+
+      StringIO.new( ::File.open(::File.join(@path, path), 'r') { |io| io.read } )
     end
 
     alias_method :[], :glob

data/lib/virtualfs/version.rb

@@ -1,3 +1,3 @@
 module VirtualFS
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/virtualfs.rb

@@ -1,5 +1,25 @@
 require "virtualfs/version"
 
+module VirtualFS
+  @@SELF_RX = /(\/|^)\.(\/|$)/
+  @@PARENT_RX = /([^\/.]+\/|^\/?)\.\.(\/|$)/
+
+  def self.realpath(path)
+    return nil if path.nil?
+
+    # Remove . dirs
+    p = path.gsub @@SELF_RX, '\2'
+
+    # Remove .. dirs
+    while p =~ @@PARENT_RX
+      p.gsub! @@PARENT_RX, ''
+    end
+
+    # Keep a slash at the beginning, remove at the end
+    '/' << p.sub(%r{^/+}, '').chomp('/')
+  end
+end
+
 # Backends
 require "virtualfs/local"
 require "virtualfs/github"

data/spec/local_spec.rb

@@ -0,0 +1,120 @@
+require 'virtualfs'
+require 'fakefs/safe'
+
+class FakeFS::File
+  def self.realpath(p)
+    RealFile.realpath(p)
+  end
+end
+
+describe VirtualFS::Local do
+  let(:fs) { VirtualFS::Local.new :path => '/' }
+
+  context 'when the directory is empty' do
+    before :all do
+      FakeFS.activate!
+      FakeFS::FileSystem.clear
+    end
+    after :all do
+      FakeFS.deactivate!
+    end
+
+    it 'contains only the . and .. entries' do
+      fs.entries.map(&:name).should == ['.', '..']
+    end
+
+    it 'glob is empty' do
+      fs.glob('*').should be_empty
+    end
+  end
+
+  context 'when the directory is not empty' do
+    before :all do
+      FakeFS.activate!
+      FakeFS::FileSystem.clear
+
+      FileUtils.mkdir_p '/a/b'
+      FileUtils.mkdir_p '/b'
+      FileUtils.touch '/content.txt'
+      FileUtils.touch '/test.txt'
+      FileUtils.touch '/a/test.txt'
+      FileUtils.touch '/b/test.txt'
+      FileUtils.touch '/a/b/test.txt'
+
+      File.open('/content.txt', "w") do |file|
+        file.puts 'Line 1'
+        file.puts 'Line 2'
+        file.puts 'Line 3'
+      end
+    end
+    after :all do
+      FakeFS.deactivate!
+    end
+
+    it '#[] works exactly like #glob' do
+      fs['*'].map(&:path).should == fs.glob('*').map(&:path)
+    end
+
+    it 'passing the exact filename returns a list of 1 element' do
+      result = fs['test.txt']
+
+      result.should be_instance_of(Array)
+      result.length.should eq(1)
+      result.first.name.should == 'test.txt'
+    end
+
+    it '. points to the same directory' do
+      fs['.'].first.path.should eq('/')
+      fs['a'].first.glob('.').first.path.should == '/a'
+    end
+
+    it '.. on root level point to the same directory' do
+      fs['..'].first.path.should == '/'
+    end
+
+    it '.. points to the parent directory when not in root directory' do
+      fs['a'].first.glob('..').first.path.should == '/'
+    end
+
+    it '#entries lists the top level' do
+      names = fs.entries.map(&:name)
+
+      names.should include('.')
+      names.should include('..')
+      names.should include('a')
+      names.should include('b')
+      names.should include('content.txt')
+      names.should include('test.txt')
+    end
+
+    it '#glob does not list . and ..' do
+      names = fs['*'].map(&:name)
+
+      names.should_not include('.')
+      names.should_not include('..')
+    end
+
+    it '#glob supports recursive patterns' do
+      paths = fs['**/*.txt'].map(&:path)
+
+      paths.should include('/a/test.txt')
+      paths.should include('/b/test.txt')
+      paths.should include('/a/b/test.txt')
+    end
+
+    it '#glob returns an empty list when looking for a nonexistent file' do
+      fs['nonexistent.txt'].should be_empty
+    end
+
+    it 'reopens the stream every time' do
+      fs['content.txt'].first.readline.should eq("Line 1\n")
+      fs['content.txt'].first.readline.should eq("Line 1\n")
+    end
+
+    it 'does not reopen the stream when assigned to a variable' do
+      s = fs['content.txt'].first
+      s.readline.should eq("Line 1\n")
+      s.readline.should eq("Line 2\n")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: virtualfs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-05 00:00:00.000000000 Z
+date: 2013-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github_api
@@ -81,6 +81,7 @@ files:
 - lib/virtualfs/local.rb
 - lib/virtualfs/runtime_cache.rb
 - lib/virtualfs/version.rb
+- spec/local_spec.rb
 - virtualfs.gemspec
 homepage: https://github.com/evoL/virtualfs
 licenses: []
@@ -106,4 +107,5 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Allows accessing remote datastores in a unified way.
-test_files: []
+test_files:
+- spec/local_spec.rb