gollum-site 0.1.7 → 0.1.8

data/README.md

@@ -59,12 +59,79 @@ generation with the following data made available to it:
 * `page.author`          The author of the last edit
 * `page.date`            The date of the last edit
 
+**A note about wiki.base_path**
+
+*tl;dr* - Don't use "." or "" as base paths. Use "./" if relative paths are required.
+
+The application of base path differs between Gollum page links and the layout.
+Gollum uses `File.join` to combine the base path and the page link. The layout simply
+renders the base path provided by the user. This can result in differing URLs.
+
+Scenario 1: Don't include a forward slash after wiki.base_path in layouts
+
+<table border="1" cellspacing="0" cellpadding="10">
+<thead>
+<tr>
+<th>base_path</th>
+<th>Gollum Link</th>
+<th>URL</th>
+<th>Layout Link</th>
+<th>URL</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>"."</td>
+<td>[[Page]]</td>
+<td>"./Page"</td>
+<td>"{{ wiki.base_path }}Page"</td>
+<td>".Page"</td>
+</tr>
+<tr>
+<td>""</td>
+<td>[[Page]]</td>
+<td>"/Page"</td>
+<td>"{{ wiki.base_path }}Page"</td>
+<td>"Page"</td>
+</tr>
+</tbody>
+</table>
+
+Scenario 2: Include a forward slash after wiki.base_path in layouts
+
+
+<table border="1" cellspacing="0" cellpadding="10">
+<thead>
+<tr>
+<th>base_path</th>
+<th>Gollum Link</th>
+<th>URL</th>
+<th>Layout Link</th>
+<th>URL</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>"/"</td>
+<td>[[Page]]</td>
+<td>"/Page"</td>
+<td>"{{ wiki.base_path }}/Page"</td>
+<td>"//Page"</td>
+</tr>
+</tbody>
+</table>
+
+Considering scenario 2 breaks links when using the default base path it is advised
+to use scenario 1 and not use "." and "" as base paths. Use "./" if relative paths
+are required.
+
 ## Import
 
 The gollum-site executable provides the ability to import the default layout to
 the current wiki. The import command will copy the required "_Layout.html", css
 and javascript to the current wiki. These files must be committed to the wiki
-repository before the 'generate' command will recognize them.
+repository before the 'generate' command will recognize them unless you use the
+"--working" option.
 
        $ gollum-site import
 

data/bin/gollum-site

@@ -22,7 +22,7 @@ Options:
 HELP
 
 options = {
-  'ref' => ( head = Grit::Repo.new('.').head ) ? head.name : 'master', # current branch
+  'ref' => Grit::Repo.new('.').git.rev_parse({}, "HEAD"), # current HEAD
   'working' => false,
   'base_path' => '/',
   'output_path' => '_site',
@@ -97,7 +97,7 @@ when 'generate'
   start = Time.now
   site.generate()
   stop = Time.now
-  Gollum::SiteLog.debug("Generated site in #{stop - start}(s)")
+  puts "Generated site in #{stop - start}(s)"
 when 'serve'
   if options['watch']
     require 'directory_watcher'

data/gollum-site.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "gollum-site"
 
-  s.add_dependency('gollum', '>= 1.1.0')
+  s.add_dependency('gollum', '>= 1.2.0')
   s.add_dependency('liquid', '>= 2.2.2')
   s.add_dependency('mixlib-log', '>= 1.1.0')
 

data/lib/gollum-site/markup.rb

@@ -1,36 +1,5 @@
 module Gollum
-  class Markup
-    # Removing sanitization; this will be configurable after Gollum 1.1.0
-    def render(no_follow = false)
-      sanitize_options = no_follow   ?
-        HISTORY_SANITIZATION_OPTIONS :
-        SANITIZATION_OPTIONS
-      if @data.respond_to?(:force_encoding)
-        data = @data.force_encoding('UTF-8')
-      else
-        data = @data
-      end
-      data = extract_tex(data)
-      data = extract_code(data)
-      data = extract_tags(data)
-      begin
-        data = GitHub::Markup.render(@name, data)
-        if data.nil?
-          raise "There was an error converting #{@name} to HTML."
-        end
-      rescue Object => e
-        data = %{<p class="gollum-error">#{e.message}</p>}
-      end
-      data = process_tags(data)
-      data = process_code(data)
-      sanitize_options[:elements] << 'iframe'
-      sanitize_options[:attributes][:all] << 'frameborder'
-      data = Sanitize.clean(data, sanitize_options)
-      data = process_tex(data)
-      data.gsub!(/<p><\/p>/, '')
-      data
-    end
-
+  class SiteMarkup < Gollum::Markup
     # Attempt to process the tag as a page link tag.
     #
     # tag       - The String tag contents (the stuff inside the double

data/lib/gollum-site/site.rb

@@ -10,9 +10,7 @@ module Gollum
 
     def initialize(path, options = {})
       @wiki = Gollum::Wiki.new(path, {
-                                 # markup_class should work after v1.1.0 of Gollum
-                                 # need to change class name in markup.rb
-                                 #:markup_class => Gollum::SiteMarkup,
+                                 :markup_class => Gollum::SiteMarkup,
                                  :page_class => Gollum::SitePage,
                                  :base_path => options[:base_path],
                                  :sanitization => false,
@@ -81,7 +79,7 @@ module Gollum
         deleted = @wiki.repo.git.native(:ls_files, ls_opts_del).split("\0")
         working = @wiki.repo.git.native(:ls_files, ls_opts).split("\0")
         work_tree = (working - deleted).map do |path|
-          path = @wiki.decode_git_path(path)
+          path = decode_git_path(path)
           OpenStruct.new(:path => path, :data => IO.read(path))
         end
         Dir.chdir(cwd) # change back to original directory
@@ -144,5 +142,19 @@ module Gollum
     def to_liquid
       { "pages" => @pages }
     end
+
+    # Decode octal sequences (\NNN) in tree path names.
+    #
+    # path - String path name.
+    #
+    # Returns a decoded String.
+    def decode_git_path(path)
+      if path[0] == ?" && path[-1] == ?"
+        path = path[1...-1]
+        path.gsub!(/\\\d{3}/)   { |m| m[1..-1].to_i(8).chr }
+      end
+      path.gsub!(/\\[rn"\\]/) { |m| eval(%("#{m.to_s}")) }
+      path
+    end
   end
 end

data/lib/gollum-site/version.rb

@@ -1,5 +1,5 @@
 module Gollum
   class Site
-    VERSION = "0.1.7"
+    VERSION = "0.1.8"
   end
 end

data/lib/gollum-site.rb

@@ -7,7 +7,6 @@ require 'gollum-site/page'
 
 # Markup does not use page version :(
 # Markup does not handle anchor tags for absent pages
-# Use custom Markup class once Gollum supports it (>v1.1.0)
 require 'gollum-site/markup'
 
 # Absolutely awful hack

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Daniel Reverri
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-28 00:00:00 -08:00
+date: 2011-03-31 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,9 +27,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 1
-        - 1
+        - 2
         - 0
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency