gollum-lib 1.0.2 → 1.0.3

data/gollum-lib.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 1.8.7"
 
   s.name              = 'gollum-lib'
-  s.version           = '1.0.2'
-  s.date              = '2013-06-15'
+  s.version           = '1.0.3'
+  s.date              = '2013-06-18'
   s.rubyforge_project = 'gollum-lib'
   s.license           = 'MIT'
 

data/lib/gollum-lib.rb

@@ -30,7 +30,7 @@ $KCODE = 'U' if RUBY_VERSION[0,3] == '1.8'
 
 module Gollum
   module Lib
-    VERSION = '1.0.2'
+    VERSION = '1.0.3'
   end
 
   def self.assets_path

data/lib/gollum-lib/file.rb

@@ -12,6 +12,8 @@ module Gollum
       @wiki = wiki
       @blob = nil
       @path = nil
+      @on_disk = false
+      @on_disk_path = nil
     end
 
     # Public: The url path required to reach this page within the repo.
@@ -34,6 +36,7 @@ module Gollum
     #
     # Returns the String name.
     def name
+      return @path if on_disk?
       @blob && @blob.name
     end
     alias filename name
@@ -42,6 +45,7 @@ module Gollum
     #
     # Returns the String data.
     def raw_data
+      return IO.read(@on_disk_path) if on_disk?
       return nil unless @blob
 
       if !@wiki.repo.bare && @blob.is_symlink
@@ -52,6 +56,20 @@ module Gollum
       @blob.data
     end
 
+    # Public: Is this an on-disk file reference?
+    #
+    # Returns true if this is a pointer to an on-disk file
+    def on_disk?
+      return @on_disk
+    end
+
+    # Public: The path to this file on disk
+    #
+    # Returns nil if on_disk? is false.
+    def on_disk_path
+      return @on_disk_path
+    end
+
     # Public: The Grit::Commit version of the file.
     attr_accessor :version
 
@@ -60,7 +78,7 @@ module Gollum
 
     # Public: The String mime type of the file.
     def mime_type
-      @blob.mime_type
+      @blob && @blob.mime_type
     end
 
     # Populate the File with information from the Blob.
@@ -72,6 +90,8 @@ module Gollum
     def populate(blob, path=nil)
       @blob = blob
       @path = "#{path}/#{blob.name}"[1..-1]
+      @on_disk = false
+      @on_disk_path = nil
       self
     end
 
@@ -81,19 +101,49 @@ module Gollum
     #
     #########################################################################
 
+    # Return the file path to this file on disk, if available.
+    #
+    # Returns nil if the file isn't available on disk. This can occur if the
+    # repo is bare, if the commit isn't the HEAD, or if there are problems
+    # resolving symbolic links.
+    def get_disk_reference(name, commit)
+      return false if @wiki.repo.bare
+      return false if commit.sha != @wiki.repo.head.commit.sha
+
+      # This will try to resolve symbolic links, as well
+      pathname = Pathname.new(::File.join(@wiki.repo.path, '..', name))
+      realpath = pathname.realpath
+      return false unless realpath.exist?
+
+      @on_disk_path = realpath.to_s
+      return true
+    end
+
     # Find a file in the given Gollum repo.
     #
     # name    - The full String path.
     # version - The String version ID to find.
+    # try_on_disk - If true, try to return just a reference to a file
+    #               that exists on the disk.
     #
-    # Returns a Gollum::File or nil if the file could not be found.
-    def find(name, version)
+    # Returns a Gollum::File or nil if the file could not be found. Note
+    # that if you specify try_on_disk=true, you may or may not get a file
+    # for which on_disk? is actually true.
+    def find(name, version, try_on_disk=false)
       checked = name.downcase
       map     = @wiki.tree_map_for(version)
+      commit  = version.is_a?(Grit::Commit) ? version : @wiki.commit_for(version)
+
       if entry = map.detect { |entry| entry.path.downcase == checked }
         @path    = name
-        @blob    = entry.blob(@wiki.repo)
-        @version = version.is_a?(Grit::Commit) ? version : @wiki.commit_for(version)
+        @version = commit
+
+        if try_on_disk && get_disk_reference(name, commit)
+          @on_disk = true
+        else
+          @blob = entry.blob(@wiki.repo)
+        end
+
         self
       end
     end

data/lib/gollum-lib/wiki.rb

@@ -257,10 +257,14 @@ module Gollum
     #
     # name    - The full String pathname to the file.
     # version - The String version ID to find (default: @ref).
-    #
-    # Returns a Gollum::File or nil if no matching file was found.
-    def file(name, version = @ref)
-      @file_class.new(self).find(name, version)
+    # try_on_disk - If true, try to return just a reference to a file
+    #               that exists on the disk.
+    #
+    # Returns a Gollum::File or nil if no matching file was found. Note
+    # that if you specify try_on_disk=true, you may or may not get a file
+    # for which on_disk? is actually true.
+    def file(name, version = @ref, try_on_disk = false)
+      @file_class.new(self).find(name, version, try_on_disk)
     end
 
     # Public: Create an in-memory Page with the given data and format. This

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gollum-lib
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-15 00:00:00.000000000 Z
+date: 2013-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
@@ -442,3 +442,4 @@ signing_key:
 specification_version: 2
 summary: A simple, Git-powered wiki.
 test_files: []
+has_rdoc: