gollum 1.0.1 → 1.1.0

data/lib/gollum/frontend/templates/compare.mustache

@@ -1,7 +1,7 @@
 <div class="guide">
   <div class="main">
     <div class="actions">
-      <a href="/{{name}}">&laquo; Back</a>
+      <a href="/{{escaped_name}}">&laquo; Back</a>
     </div>
     <h1>{{title}}: {{before}} &rarr; {{after}}</h1>
     <div id="files">

data/lib/gollum/frontend/templates/create.mustache

@@ -2,7 +2,7 @@
   <a href="/">&laquo; Home</a>
   <h1>{{title}}</h1>
 
-  <form class="new_wiki" method="post" action="/create/{{name}}">
+  <form class="new_wiki" method="post" action="/create/{{escaped_name}}">
     <div>
       <label>
         Title<br />

data/lib/gollum/frontend/templates/edit.mustache

@@ -1,8 +1,8 @@
 <div class="write">
-  <a href="/{{name}}">&laquo; Back</a>
+  <a href="/{{escaped_name}}">&laquo; Back</a>
   <h1>{{title}}</h1>
 
-  <form class="edit_wiki" method="post" action="/edit/{{name}}">
+  <form class="edit_wiki" method="post" action="/edit/{{escaped_name}}">
     <div>
       <label>
         Title<br />

data/lib/gollum/frontend/templates/error.mustache

@@ -0,0 +1,11 @@
+<div class="guide">
+  <div class="main">
+    <div class="actions">
+      <a href="/">Home</a>
+    </div>
+    <h1>Error</h1>
+    <div class="error">
+      {{message}}
+    </div>
+  </div>
+</div>

data/lib/gollum/frontend/templates/history.mustache

@@ -1,10 +1,10 @@
 <div class="guide">
   <div class="main">
     <div class="actions">
-      <a href="/{{name}}">&laquo; Back</a>
+      <a href="/{{escaped_name}}">&laquo; Back</a>
     </div>
     <h1>{{title}}</h1>
-    <form id="history" method="post" action="/compare/{{name}}">
+    <form id="history" method="post" action="/compare/{{escaped_name}}">
       <table class="commits" cellpadding="0" cellspacing="0">
         <tr>
           <th colspan="5">
@@ -17,7 +17,7 @@
               <input name="versions[]" type="checkbox" value="{{id}}" />
             </td>
             <td class="sha">
-              <a href="/{{name}}/{{id}}">{{id7}}</a>
+              <a href="/{{escaped_name}}/{{id}}">{{id7}}</a>
             </td>
             <td nowrap class="author">
               <img src="http://www.gravatar.com/avatar/{{gravatar}}?s=16" alt="Gravatar" />

data/lib/gollum/frontend/templates/page.mustache

@@ -1,7 +1,13 @@
 <div class="guide">
   <div class="main">
     <div class="actions">
-      <a href="/">Home</a> | <a href="/edit/{{name}}">Edit</a>
+      <form action="/search" method="get">
+        <div>
+          <a href="/">Home</a> | 
+          <a href="/edit/{{escaped_name}}">Edit</a> | 
+          <input type="search" name="q" size="10" /> <input type="submit" value="search" />
+        </div>
+      </form>
     </div>
     <h1>{{title}}</h1>
     <div class="content wikistyle gollum {{format}}">
@@ -18,10 +24,10 @@
   <div style="float: left;">
     <small>Last edited by <b>{{author}}</b>, {{date}}</small>
     <div class="actions">
-      <a href="/">Home</a> | <a href="/edit/{{name}}">Edit</a>
+      <a href="/">Home</a> | <a href="/edit/{{escaped_name}}">Edit</a>
     </div>
   </div>
   <div style="float: right;">
-    <a href="/history/{{name}}">View Revision History</a>
+    <a href="/history/{{escaped_name}}">View Revision History</a>
   </div>
 </div>

data/lib/gollum/frontend/templates/search.mustache

@@ -0,0 +1,19 @@
+<div class="guide">
+  <div class="main">
+    <div class="actions">
+      <form action="/search" method="get">
+        <a href="/">Home</a> | <input type="search" name="q" size="10" /> <input type="submit" value="search" />
+      </form>
+    </div>
+    <h1>Search for “{{query}}”</h1>
+    <div class="content wikistyle gollum">
+      {{#has_results}}
+        <ul>
+        {{#results}}
+            <li><a href="/{{name}}">{{name}} ({{count}})</a></li>
+        {{/results}}
+        </ul>
+      {{/has_results}}
+    </div>
+  </div>
+</div>

data/lib/gollum/frontend/views/error.rb

@@ -0,0 +1,7 @@
+module Precious
+  module Views
+    class Error < Layout
+      attr_reader :message
+    end
+  end
+end

data/lib/gollum/frontend/views/layout.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module Precious
   module Views
     class Layout < Mustache
@@ -6,6 +8,10 @@ module Precious
 
       attr_reader :name
 
+      def escaped_name
+        CGI.escape(@name)
+      end
+
       def title
         "Home"
       end

data/lib/gollum/frontend/views/search.rb

@@ -0,0 +1,12 @@
+module Precious
+  module Views
+    class Search < Layout
+      attr_reader :content, :page, :footer, :results, :query
+
+      def has_results
+        !@results.empty?
+      end
+
+    end
+  end
+end

data/lib/gollum/markup.rb

@@ -1,4 +1,5 @@
 require 'digest/sha1'
+require 'cgi'
 
 module Gollum
   class Markup
@@ -21,8 +22,14 @@ module Gollum
     # Render the content with Gollum wiki syntax on top of the file's own
     # markup language.
     #
+    # no_follow - Boolean that determines if rel="nofollow" is added to all
+    #             <a> tags.
+    #
     # Returns the formatted String content.
-    def render
+    def render(no_follow = false)
+      sanitize_options = no_follow   ? 
+        HISTORY_SANITIZATION_OPTIONS : 
+        SANITIZATION_OPTIONS
       data = extract_tex(@data)
       data = extract_code(data)
       data = extract_tags(data)
@@ -36,9 +43,9 @@ module Gollum
       end
       data = process_tags(data)
       data = process_code(data)
-      data = Sanitize.clean(data, SANITIZATION_OPTIONS)
+      data = Sanitize.clean(data, sanitize_options)
       data = process_tex(data)
-      data = data.gsub(/<p><\/p>/, '')
+      data.gsub!(/<p><\/p>/, '')
       data
     end
 
@@ -114,28 +121,33 @@ module Gollum
     # Process all tags from the tagmap and replace the placeholders with the
     # final markup.
     #
-    # data - The String data (with placeholders).
+    # data      - The String data (with placeholders).
+    # no_follow - Boolean that determines if rel="nofollow" is added to all
+    #             <a> tags.
     #
     # Returns the marked up String data.
-    def process_tags(data)
+    def process_tags(data, no_follow = false)
       @tagmap.each do |id, tag|
-        data.gsub!(id, process_tag(tag))
+        data.gsub!(id, process_tag(tag, no_follow))
       end
       data
     end
 
     # Process a single tag into its final HTML form.
     #
-    # tag - The String tag contents (the stuff inside the double brackets).
+    # tag       - The String tag contents (the stuff inside the double 
+    #             brackets).
+    # no_follow - Boolean that determines if rel="nofollow" is added to all
+    #             <a> tags.
     #
     # Returns the String HTML version of the tag.
-    def process_tag(tag)
+    def process_tag(tag, no_follow = false)
       if html = process_image_tag(tag)
-        return html
-      elsif html = process_file_link_tag(tag)
-        return html
+        html
+      elsif html = process_file_link_tag(tag, no_follow)
+        html
       else
-        return process_page_link_tag(tag)
+        process_page_link_tag(tag, no_follow)
       end
     end
 
@@ -150,7 +162,7 @@ module Gollum
       name  = parts[0].strip
       path  = if file = find_file(name)
         ::File.join @wiki.base_path, file.path
-      elsif name =~ /^https?:\/\/.+(jpg|png|gif|svg|bmp)$/
+      elsif name =~ /^https?:\/\/.+(jpg|png|gif|svg|bmp)$/i
         name
       end
 
@@ -200,7 +212,7 @@ module Gollum
           classes << 'frame' if opts['frame']
           %{<span class="#{classes.join(' ')}">} +
           %{<span>} +
-          %{<img src="/#{file.path}" #{attr_string}/>} +
+          %{<img src="#{path}" #{attr_string}/>} +
           (alt ? %{<span>#{alt}</span>} : '') +
           %{</span>} +
           %{</span>}
@@ -228,11 +240,14 @@ module Gollum
 
     # Attempt to process the tag as a file link tag.
     #
-    # tag - The String tag contents (the stuff inside the double brackets).
+    # tag       - The String tag contents (the stuff inside the double 
+    #             brackets).
+    # no_follow - Boolean that determines if rel="nofollow" is added to all
+    #             <a> tags.
     #
     # Returns the String HTML if the tag is a valid file link tag or nil
     #   if it is not.
-    def process_file_link_tag(tag)
+    def process_file_link_tag(tag, no_follow = false)
       parts = tag.split('|')
       name  = parts[0].strip
       path  = parts[1] && parts[1].strip
@@ -244,37 +259,49 @@ module Gollum
         nil
       end
 
-      if name && path && file
+      tag = if name && path && file
         %{<a href="#{::File.join @wiki.base_path, file.path}">#{name}</a>}
       elsif name && path
         %{<a href="#{path}">#{name}</a>}
       else
         nil
       end
+      if tag && no_follow
+        tag.sub! /^<a/, '<a ref="nofollow"'
+      end
+      tag
     end
 
     # Attempt to process the tag as a page link tag.
     #
-    # tag - The String tag contents (the stuff inside the double brackets).
+    # tag       - The String tag contents (the stuff inside the double 
+    #             brackets).
+    # no_follow - Boolean that determines if rel="nofollow" is added to all
+    #             <a> tags.
     #
     # Returns the String HTML if the tag is a valid page link tag or nil
     #   if it is not.
-    def process_page_link_tag(tag)
+    def process_page_link_tag(tag, no_follow = false)
       parts = tag.split('|')
       name  = parts[0].strip
       cname = Page.cname((parts[1] || parts[0]).strip)
-      if name =~ %r{^https?://} && parts[1].nil?
+      tag = if name =~ %r{^https?://} && parts[1].nil?
         %{<a href="#{name}">#{name}</a>}
       else
-        if page = @wiki.page(cname)
-          link = ::File.join(@wiki.base_path, Page.cname(page.name))
-          presence = "present"
-        else
-          link = ::File.join(@wiki.base_path, cname)
-          presence = "absent"
+        presence    = "absent"
+        link_name   = cname
+        page, extra = find_page_from_name(cname)
+        if page
+          link_name = Page.cname(page.name)
+          presence  = "present"
         end
-        %{<a class="internal #{presence}" href="#{link}">#{name}</a>}
+        link = ::File.join(@wiki.base_path, CGI.escape(link_name))
+        %{<a class="internal #{presence}" href="#{link}#{extra}">#{name}</a>}
       end
+      if tag && no_follow
+        tag.sub! /^<a/, '<a ref="nofollow"'
+      end
+      tag
     end
 
     # Find the given file in the repo.
@@ -291,6 +318,23 @@ module Gollum
       end
     end
 
+    # Find a page from a given cname.  If the page has an anchor (#) and has
+    # no match, strip the anchor and try again.
+    #
+    # cname - The String canonical page name.
+    #
+    # Returns a Gollum::Page instance if a page is found, or an Array of 
+    # [Gollum::Page, String extra] if a page without the extra anchor data
+    # is found.
+    def find_page_from_name(cname)
+      if page = @wiki.page(cname)
+        return page
+      end
+      if pos = cname.index('#')
+        [@wiki.page(cname[0...pos]), cname[pos..-1]]
+      end
+    end
+
     #########################################################################
     #
     # Code
@@ -320,7 +364,7 @@ module Gollum
       @codemap.each do |id, spec|
         lang = spec[:lang]
         code = spec[:code]
-        if code.all? { |line| line =~ /\A\r?\n\Z/ || line =~ /^(  |\t)/ }
+        if code.lines.all? { |line| line =~ /\A\r?\n\Z/ || line =~ /^(  |\t)/ }
           code.gsub!(/^(  |\t)/m, '')
         end
         data.gsub!(id, Gollum::Albino.new(code, lang).colorize)
@@ -328,4 +372,4 @@ module Gollum
       data
     end
   end
-end
+end

data/lib/gollum/page.rb

@@ -14,6 +14,11 @@ module Gollum
                      :asciidoc => "AsciiDoc",
                      :pod      => "Pod" }
 
+    # Sets a Boolean determing whether this page is a historical version.
+    #
+    # Returns nothing.
+    attr_writer :historical
+
     # Checks if a filename has a valid extension understood by GitHub::Markup.
     #
     # filename - String filename, like "Home.md".
@@ -35,6 +40,14 @@ module Gollum
       filename =~ /^_/ ? false : match
     end
 
+    # Reusable filter to turn a filename (without path) into a canonical name.
+    # Strips extension, converts spaces to dashes.
+    #
+    # Returns the filtered String.
+    def self.canonicalize_filename(filename)
+      filename.split('.')[0..-2].join('.').gsub('-', ' ')
+    end
+
     # Public: Initialize a page.
     #
     # wiki - The Gollum::Wiki in question.
@@ -57,7 +70,7 @@ module Gollum
     #
     # Returns the String name.
     def name
-      filename.split('.')[0..-2].join('.').gsub('-', ' ')
+      self.class.canonicalize_filename(filename)
     end
 
     # Public: If the first element of a formatted page is an <h1> tag it can
@@ -107,7 +120,7 @@ module Gollum
     #
     # Returns the String data.
     def formatted_data
-      @blob && Gollum::Markup.new(self).render
+      @blob && Gollum::Markup.new(self).render(historical?)
     end
 
     # Public: The format of the page.
@@ -174,20 +187,24 @@ module Gollum
 
       dirs = self.path.split('/')
       dirs.pop
+      map = @wiki.tree_map_for(self.version.id)
       while !dirs.empty?
-        tree = self.version.tree / dirs.join('/')
-        if page = find_page_in_this_tree(tree, dirs.join('/'), '_Footer')
+        if page = find_page_in_tree(map, '_Footer', dirs.join('/'))
           return page
         end
         dirs.pop
       end
 
-      tree = self.version.tree
-      if page = find_page_in_this_tree(tree, '', '_Footer')
-        return page
-      end
+      find_page_in_tree(map, '_Footer', '')
+    end
 
-      return nil
+    # Gets a Boolean determining whether this page is a historical version.  
+    # Historical pages are pulled using exact SHA hashes and format all links
+    # with rel="nofollow"
+    #
+    # Returns true if the page is pulled from a named branch or tag, or false.
+    def historical?
+      !!@historical
     end
 
     #########################################################################
@@ -207,7 +224,9 @@ module Gollum
     #
     # Returns the String canonical name.
     def self.cname(name)
-      name.gsub(%r{[ /<>]}, '-')
+      name.respond_to?(:gsub)      ?
+        name.gsub(%r{[ /<>]}, '-') :
+        ''
     end
 
     # Convert a format Symbol into an extension String.
@@ -251,61 +270,35 @@ module Gollum
     #
     # Returns a Gollum::Page or nil if the page could not be found.
     def find(name, version)
-      if commit = @wiki.repo.commit(version)
-        if page = find_page_in_tree(commit.tree, name)
-          page.version = commit
-          page
-        end
+      map = @wiki.tree_map_for(version)
+      if page = find_page_in_tree(map, name)
+        sha = @wiki.ref_map[version] || version
+        page.version    = Grit::Commit.create(@wiki.repo, :id => sha)
+        page.historical = sha == version
+        page
       end
+    rescue Grit::GitRuby::Repository::NoSuchShaFound
     end
 
     # Find a page in a given tree.
     #
-    # tree - The Grit::Tree in which to look.
-    # name - The canonical String page name.
+    # map         - The Array tree map from Wiki#tree_map.
+    # name        - The canonical String page name.
+    # checked_dir - Optional String of the directory a matching page needs
+    #               to be in.  The string should 
     #
     # Returns a Gollum::Page or nil if the page could not be found.
-    def find_page_in_tree(tree, name)
-      treemap = {}
-      trees = [tree]
-
-      while !trees.empty?
-        ptree = trees.shift
-        ptree.contents.each do |item|
-          case item
-            when Grit::Blob
-              if page_match(name, item.name)
-                return self.class.new(@wiki).populate(item, tree_path(treemap, ptree))
-              end
-            when Grit::Tree
-              treemap[item] = ptree
-              trees << item
-          end
-        end
+    def find_page_in_tree(map, name, checked_dir = nil)
+      return nil if name.to_s.empty?
+      if checked_dir = BlobEntry.normalize_dir(checked_dir)
+        checked_dir.downcase!
       end
 
-      return nil # nothing was found
-    end
-
-    # Find a page in a given tree without recursing into subtrees.
-    #
-    # tree - The Grit::Tree in which to look.
-    # dir  - The String path of the given Grit::Tree.
-    # name - The canonical String page name.
-    #
-    # Returns a Gollum::Page or nil if the page could not be found.
-    def find_page_in_this_tree(tree, dir, name)
-      treemap = {}
-      tree.contents.each do |item|
-        case item
-          when Grit::Blob
-            if page_match(name, item.name)
-              path = dir == '' ? '' : ::File.join('/', dir)
-              page = self.class.new(@wiki).populate(item, path)
-              page.version = self.version
-              return page
-            end
-        end
+      map.each do |entry|
+        next if entry.name.to_s.empty?
+        next unless checked_dir.nil? || entry.dir.downcase == checked_dir
+        next unless page_match(name, entry.name)
+        return entry.page(@wiki, @version)
       end
 
       return nil # nothing was found