gollum 2.0.0 → 2.1.0

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

@@ -1,6 +1,8 @@
 module Precious
   module Views
     class History < Layout
+      include HasPage
+
       attr_reader :page, :page_num
 
       def title
@@ -15,8 +17,8 @@ module Precious
             :id7      => v.id[0..6],
             :num      => i,
             :selected => @page.version.id == v.id,
-            :author   => v.author.name,
-            :message  => v.message,
+            :author   => v.author.name.respond_to?(:force_encoding) ? v.author.name.force_encoding('UTF-8') : v.author.name,
+            :message  => v.message.respond_to?(:force_encoding) ? v.message.force_encoding('UTF-8') : v.message,
             :date     => v.committed_date.strftime("%B %d, %Y"),
             :gravatar => Digest::MD5.hexdigest(v.author.email) }
         end
@@ -27,14 +29,16 @@ module Precious
         if @page_num == 1
           %(<span class="disabled">#{label}</span>)
         else
-          %(<a href="/history/#{@page.name}?page=#{@page_num-1}" hotkey="h">#{label}</a>)
+          link = url("/history/#{@page.name}?page=#{@page_num-1}")
+          %(<a href="#{link}" hotkey="h">#{label}</a>)
         end
       end
 
       def next_link
         label = "Next &raquo;"
         if @versions.size == Gollum::Page.per_page
-          %(<a href="/history/#{@page.name}?page=#{@page_num+1}" hotkey="l">#{label}</a>)
+          link = "/history/#{@page.name}?page=#{@page_num+1}"
+          %(<a href="#{link}" hotkey="l">#{label}</a>)
         else
           %(<span class="disabled">#{label}</span>)
         end

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

@@ -6,7 +6,7 @@ module Precious
       include Rack::Utils
       alias_method :h, :escape_html
 
-      attr_reader :name
+      attr_reader :name, :path
 
       def escaped_name
         CGI.escape(@name)
@@ -15,6 +15,14 @@ module Precious
       def title
         "Home"
       end
+
+      def has_path
+        !@path.nil?
+      end
+
+      def base_url
+        @base_url
+      end
     end
   end
 end

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

@@ -1,32 +1,47 @@
 module Precious
   module Views
     class Page < Layout
-      attr_reader :content, :page, :footer
+      include HasPage
+
+      attr_reader :content, :page, :header, :footer
       DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
       DEFAULT_AUTHOR = 'you'
 
       def title
-        @page.title
-      end
-
-      def format
-        @page.format.to_s
+        @page.url_path.gsub("-", " ")
       end
 
       def author
-        return DEFAULT_AUTHOR unless @page.version
-        @page.version.author.name
+        page_versions = @page.versions
+        first = page_versions ? page_versions.first : false
+        return DEFAULT_AUTHOR unless first
+        first.author.name.respond_to?(:force_encoding) ? first.author.name.force_encoding('UTF-8') : first.author.name
       end
 
       def date
-        return Time.now.strftime(DATE_FORMAT) unless @page.version
-        @page.version.authored_date.strftime(DATE_FORMAT)
+        page_versions = @page.versions
+        first = page_versions ? page_versions.first : false
+        return Time.now.strftime(DATE_FORMAT) unless first
+        first.authored_date.strftime(DATE_FORMAT)
       end
 
       def editable
         @editable
       end
 
+      def has_header
+        @header = (@page.header || false) if @header.nil?
+        !!@header
+      end
+
+      def header_content
+        has_header && @header.formatted_data
+      end
+
+      def header_format
+        has_header && @header.format.to_s
+      end
+
       def has_footer
         @footer = (@page.footer || false) if @footer.nil?
         !!@footer
@@ -52,6 +67,18 @@ module Precious
       def sidebar_format
         has_sidebar && @sidebar.format.to_s
       end
+
+      def has_toc
+        !@toc_content.nil?
+      end
+
+      def toc_content
+        @toc_content
+      end
+
+      def mathjax
+        @mathjax
+      end
     end
   end
 end

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

@@ -1,3 +1,5 @@
+require "pathname"
+
 module Precious
   module Views
     class Pages < Layout
@@ -7,6 +9,52 @@ module Precious
         "All pages in #{@ref}"
       end
 
+      def breadcrumb
+        if @path
+          path = Pathname.new(@path)
+          breadcrumb = [%{<a href="#{@base_url}pages/">Home</a>}]
+          path.descend do |crumb|
+            title = crumb.basename
+
+            if title == path.basename
+              breadcrumb << title
+            else
+              breadcrumb << %{<a href="#{@base_url}pages/#{crumb}/">#{title}</a>}
+            end
+          end
+
+          breadcrumb.join(" / ")
+        else
+          "Home"
+        end
+      end
+
+      def files_folders
+        if has_results
+          folder_links = []
+
+          @results.map { |page|
+            page_path = page.path.sub(/^#{@path}\//,'')
+
+            if page_path.include?('/')
+              folder      = page_path.split('/').first
+              folder_path = @path ? "#{@path}/#{folder}" : folder
+              folder_link = %{<li><a href="#{@base_url}pages/#{folder_path}/" class="folder">#{folder}</a></li>}
+
+              unless folder_links.include?(folder_link)
+                folder_links << folder_link
+
+                folder_link
+              end
+            elsif page_path != ".gitkeep"
+              %{<li><a href="#{@base_url}#{page.escaped_url_path}" class="file">#{page.name}</a></li>}
+            end
+          }.compact.join("\n")
+        else
+          ""
+        end
+      end
+
       def has_results
         !@results.empty?
       end

data/lib/gollum/git_access.rb

@@ -9,10 +9,10 @@ module Gollum
     # page_file_dir - String the directory in which all page files reside
     #
     # Returns this instance.
-    def initialize(path, page_file_dir = nil)
+    def initialize(path, page_file_dir = nil, bare = false)
       @page_file_dir = page_file_dir
       @path = path
-      @repo = Grit::Repo.new(path)
+      @repo = Grit::Repo.new(path, { :is_bare => bare })
       clear
     end
 

data/lib/gollum/markup.rb

@@ -6,6 +6,7 @@ require 'base64'
 module Gollum
 
   class Markup
+    attr_accessor :toc
     # Initialize a new Markup object.
     #
     # page - The Gollum::Page.
@@ -17,12 +18,15 @@ module Gollum
       @data    = page.text_data
       @version = page.version.id if page.version
       @format  = page.format
+      @sub_page = page.sub_page
+      @parent_page = page.parent_page
       @dir     = ::File.dirname(page.path)
       @tagmap  = {}
       @codemap = {}
       @texmap  = {}
       @wsdmap  = {}
       @premap  = {}
+      @toc = nil
     end
 
     # Render the content with Gollum wiki syntax on top of the file's own
@@ -53,18 +57,61 @@ module Gollum
       end
       data = process_tags(data)
       data = process_code(data, encoding)
-      if sanitize || block_given?
-        doc  = Nokogiri::HTML::DocumentFragment.parse(data)
-        doc  = sanitize.clean_node!(doc) if sanitize
-        yield doc if block_given?
-        data = doc.to_html
-      end
+
+      doc = Nokogiri::HTML::DocumentFragment.parse(data)
+      doc = sanitize.clean_node!(doc) if sanitize
+      doc,toc = process_headers(doc)
+      @toc = @sub_page ? ( @parent_page ? @parent_page.toc_data : "[[_TOC_]]" ) : toc
+      yield doc if block_given?
+      data = doc.to_html
+
+      data = process_toc_tags(data)
       data = process_tex(data)
       data = process_wsd(data)
       data.gsub!(/<p><\/p>/, '')
       data
     end
 
+    # Inserts header anchors and creates TOC
+    #
+    # doc - Nokogiri parsed document
+    #
+    # Returns doc Document and toc String
+    def process_headers(doc)
+      toc = nil
+      doc.css('h1,h2,h3,h4,h5,h6').each do |h|
+        id = CGI::escape(h.content.gsub(' ','-'))
+        level = h.name.gsub(/[hH]/,'').to_i
+
+        # Add anchors
+        anchor = Nokogiri::XML::Node.new('a', doc)
+        anchor['class'] = 'anchor'
+        anchor['id'] = id
+        anchor['href'] = '#' + id
+        h.add_child(anchor)
+
+        # Build TOC
+        toc ||= Nokogiri::XML::DocumentFragment.parse('<div class="toc"><div class="toc-title">Table of Contents</div></div>')
+        tail ||= toc.child
+        tail_level ||= 0
+
+        while tail_level < level
+          node = Nokogiri::XML::Node.new('ul', doc)
+          tail = tail.add_child(node)
+          tail_level += 1
+        end          
+        while tail_level > level
+          tail = tail.parent
+          tail_level -= 1
+        end
+        node = Nokogiri::XML::Node.new('li', doc)
+        node.add_child("<a href='##{id}'>#{h.content}</a>")
+        tail.add_child(node)
+      end
+      toc = toc.to_xhtml if toc != nil
+      [doc, toc]
+    end
+
     #########################################################################
     #
     # TeX
@@ -99,7 +146,22 @@ module Gollum
     def process_tex(data)
       @texmap.each do |id, spec|
         type, tex = *spec
-        out = %{<img src="#{::File.join(@wiki.base_path, '_tex.png')}?type=#{type}&data=#{Base64.encode64(tex).chomp}" alt="#{CGI.escapeHTML(tex)}">}
+
+        # Obtain the formula with parameters
+        out = nil
+        begin 
+          width, height, align, base64 = Gollum::Tex.render_formula(tex, true)
+
+          # TODO: Should we load the binary inside the html?
+          #out = %{<img width="#{width}" height="#{height}" style="vertical-align: #{align}px;" src="data:image/png;base64,\n#{base64}" alt="#{CGI.escapeHTML(tex)}" />}
+
+          # Use the alignment values from the formula rendering but still use the call to '_tex.png'. Although it will call render_formula()
+          # again, it will use the already cached formula and it might have some advantages from the point of view of browser caching (really not sure here).
+          out = %{<img width="#{width}" height="#{height}" style="vertical-align: #{align}px;" src="#{::File.join(@wiki.base_path, '_tex.png')}?type=#{type}&data=#{Base64.encode64(tex).chomp}" alt="#{CGI.escapeHTML(tex)}" />}
+        rescue # In case of error
+          out = CGI.escapeHTML(tex)
+        end
+        
         data.gsub!(id, out)
       end
       data
@@ -153,11 +215,29 @@ module Gollum
     # Returns the marked up String data.
     def process_tags(data)
       @tagmap.each do |id, tag|
-        data.gsub!(id, process_tag(tag))
+        # If it's preformatted, just put the tag back
+        if is_preformatted?(data, id)
+          data.gsub!(id, "[[#{tag}]]")
+        else
+          data.gsub!(id, process_tag(tag))
+        end
       end
       data
     end
 
+    # Find `id` within `data` and determine if it's within
+    # preformatted tags.
+    #
+    # data      - The String data (with placeholders).
+    # id        - The String SHA1 hash.
+    PREFORMATTED_TAGS = %w(code tt)
+    def is_preformatted?(data, id)
+      doc = Nokogiri::HTML::DocumentFragment.parse(data)
+      node = doc.search("[text()*='#{id}']").first
+      node && (PREFORMATTED_TAGS.include?(node.name) ||
+        node.ancestors.any? { |a| PREFORMATTED_TAGS.include?(a.name) })
+    end
+
     # Process a single tag into its final HTML form.
     #
     # tag       - The String tag contents (the stuff inside the double
@@ -165,7 +245,9 @@ module Gollum
     #
     # Returns the String HTML version of the tag.
     def process_tag(tag)
-      if html = process_image_tag(tag)
+      if tag =~ /^_TOC_$/
+        %{[[#{tag}]]}
+      elsif html = process_image_tag(tag)
         html
       elsif html = process_file_link_tag(tag)
         html
@@ -322,6 +404,17 @@ module Gollum
       end
     end
 
+
+    # Process the special table of contents tag [[_TOC_]]
+    #
+    # data      - The String data (with placeholders).
+    #
+    # Returns the marked up String data.
+    def process_toc_tags(data)
+      data.gsub!("[[_TOC_]]", @toc.nil? ? '' : @toc)
+      data
+    end
+
     # Find the given file in the repo.
     #
     # name - The String absolute or relative path of the file.
@@ -366,11 +459,12 @@ module Gollum
     # Returns the placeholder'd String data.
     def extract_code(data)
       data.gsub!(/^([ \t]*)``` ?([^\r\n]+)?\r?\n(.+?)\r?\n\1```\r?$/m) do
-        id     = Digest::SHA1.hexdigest("#{$2}.#{$3}")
+        lang   = $2 ? $2.strip : nil
+        id     = Digest::SHA1.hexdigest("#{lang}.#{$3}")
         cached = check_cache(:code, id)
         @codemap[id] = cached   ?
           { :output => cached } :
-          { :lang => $2, :code => $3, :indent => $1 }
+          { :lang => lang, :code => $3, :indent => $1 }
         "#{$1}#{id}" # print the SHA1 ID with the proper indentation
       end
       data
@@ -410,15 +504,17 @@ module Gollum
         blocks << [spec[:lang], code]
       end
 
-      highlighted = begin
+      highlighted = []
+      blocks.each do |lang, code|
         encoding ||= 'utf-8'
-        blocks.map { |lang, code|
-          Pygments.highlight(code, :lexer => lang, :options => {:encoding => encoding.to_s})
-        }
-      rescue ::RubyPython::PythonError
-        []
+        begin
+          hl_code = Pygments.highlight(code, :lexer => lang, :options => {:encoding => encoding.to_s})
+        rescue ::RubyPython::PythonError
+          hl_code = code
+        end
+        highlighted << hl_code
       end
-
+      
       @codemap.each do |id, spec|
         body = spec[:output] || begin
           if (body = highlighted.shift.to_s).size > 0
@@ -447,7 +543,7 @@ module Gollum
     #
     # Returns the placeholder'd String data.
     def extract_wsd(data)
-      data.gsub(/^\{\{\{ ?(.+?)\r?\n(.+?)\r?\n\}\}\}\r?$/m) do
+      data.gsub(/^\{\{\{\{\{\{ ?(.+?)\r?\n(.+?)\r?\n\}\}\}\}\}\}\r?$/m) do
         id = Digest::SHA1.hexdigest($2)
         @wsdmap[id] = { :style => $1, :code => $2 }
         id

data/lib/gollum/page.rb

@@ -20,6 +20,11 @@ module Gollum
     # Returns nothing.
     attr_writer :historical
 
+    # Parent page if this is a sub page
+    #
+    # Returns a Page
+    attr_accessor :parent_page
+
     # Checks if a filename has a valid extension understood by GitHub::Markup.
     #
     # filename - String filename, like "Home.md".
@@ -99,7 +104,9 @@ module Gollum
     # Returns a newly initialized Gollum::Page.
     def initialize(wiki)
       @wiki = wiki
-      @blob = @footer = @sidebar = nil
+      @blob = @header = @footer = @sidebar = nil
+      @doc = nil
+      @parent_page = nil
     end
 
     # Public: The on-disk filename of the page including extension.
@@ -130,7 +137,15 @@ module Gollum
     #
     # Returns the fully sanitized String title.
     def title
-      header = Sanitize.clean(name).strip
+      Sanitize.clean(name).strip
+    end
+
+    # Public: Determines if this is a sub-page
+    # Sub-pages have filenames beginning with an underscore
+    #
+    # Returns true or false.
+    def sub_page
+      filename =~ /^_/
     end
 
     # Public: The path of the page within the repo.
@@ -138,6 +153,27 @@ module Gollum
     # Returns the String path.
     attr_reader :path
 
+    # Public: The url path required to reach this page within the repo.
+    #
+    # Returns the String url_path
+    def url_path
+      path = if self.path.include?('/')
+        self.path.sub(/\/[^\/]+$/, '/')
+      else
+        ''
+      end
+
+      path << Page.cname(self.name, '-', '-')
+      path
+    end
+
+    # Public: The url_path, but CGI escaped.
+    #
+    # Returns the String url_path
+    def escaped_url_path
+      CGI.escape(self.url_path).gsub('%2F','/')
+    end
+
     # Public: The raw contents of the page.
     #
     # Returns the String data.
@@ -164,7 +200,21 @@ module Gollum
     #
     # Returns the String data.
     def formatted_data(encoding = nil, &block)
-      @blob && markup_class.render(historical?, encoding, &block)
+      @blob && markup_class.render(historical?, encoding) do |doc|
+        @doc = doc
+        yield doc if block_given?
+      end
+    end
+
+    # Public: The table of contents of the page.
+    #
+    # formatted_data - page already marked up in html.
+    #
+    # Returns the String data.
+    def toc_data()
+      return @parent_page.toc_data if @parent_page and @sub_page
+      formatted_data if markup_class.toc == nil
+      markup_class.toc
     end
 
     # Public: The format of the page.
@@ -209,6 +259,20 @@ module Gollum
       end
     end
 
+    # Public: The first 7 characters of the current version.
+    #
+    # Returns the first 7 characters of the current version.
+   def version_short
+     version.to_s[0,7]
+   end
+
+    # Public: The header Page.
+    #
+    # Returns the header Page or nil if none exists.
+    def header
+      @header ||= find_sub_page(:header)
+    end
+
     # Public: The footer Page.
     #
     # Returns the footer Page or nil if none exists.
@@ -300,9 +364,9 @@ module Gollum
     # version - The String version ID to find.
     #
     # Returns a Gollum::Page or nil if the page could not be found.
-    def find(name, version)
+    def find(name, version, dir = nil)
       map = @wiki.tree_map_for(version.to_s)
-      if page = find_page_in_tree(map, name)
+      if page = find_page_in_tree(map, name, dir)
         page.version    = version.is_a?(Grit::Commit) ?
           version : @wiki.commit_for(version)
         page.historical = page.version.to_s == version.to_s
@@ -376,8 +440,10 @@ module Gollum
       false
     end
 
-    # Loads a sub page.  Sub page nanes (footers) are prefixed with
-    # an underscore to distinguish them from other Pages.
+    # Loads a sub page.  Sub page names (footers, headers, sidebars) are prefixed with
+    # an underscore to distinguish them from other Pages. If there is not one within
+    # the current directory, starts walking up the directory tree to try and find one
+    # within parent directories.
     #
     # name - String page name.
     #
@@ -390,15 +456,19 @@ module Gollum
 
       dirs = self.path.split('/')
       dirs.pop
-      map = @wiki.tree_map_for(self.version.id)
+      map = @wiki.tree_map_for(@wiki.ref, true)
       while !dirs.empty?
         if page = find_page_in_tree(map, name, dirs.join('/'))
+          page.parent_page = self
           return page
         end
         dirs.pop
       end
 
-      find_page_in_tree(map, name, '')
+      if page = find_page_in_tree(map, name, '')
+        page.parent_page = self
+      end
+      page
     end
 
     def inspect