RubyGems - gollum - Versions diffs - 1.0.0 - Mend

gollum 1.0.0

Potentially problematic release.

This version of gollum might be problematic. Click here for more details.

Files changed (463) hide show

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

@@ -0,0 +1,37 @@
+<div class="guide">
+  <div class="main">
+    <div class="actions">
+      <a href="/{{name}}">&laquo; Back</a>
+    </div>
+    <h1>{{title}}</h1>
+    <form id="history" method="post" action="/compare/{{name}}">
+      <table class="commits" cellpadding="0" cellspacing="0">
+        <tr>
+          <th colspan="5">
+            Select any two versions to <input type="submit" value="Compare" />
+          </th>
+        </tr>
+        {{#versions}}
+          <tr class="commit">
+            <td class="checkbox">
+              <input name="versions[]" type="checkbox" value="{{id}}" />
+            </td>
+            <td class="sha">
+              <a href="/{{name}}/{{id}}">{{id7}}</a>
+            </td>
+            <td nowrap class="author">
+              <img src="http://www.gravatar.com/avatar/{{gravatar}}?s=16" alt="Gravatar" />
+              {{author}}
+            </td>
+            <td class="message">{{message}}</td>
+            <td nowrap class="date">{{date}}</td>
+          </tr>
+        {{/versions}}
+      </table>
+      <div class="pagination">
+        {{{previous_link}}}
+        {{{next_link}}}
+      </div>
+    </form>
+  </div>
+</div>

data/lib/gollum/frontend/templates/layout.mustache ADDED

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+    <title>{{title}}</title>
+    <link rel="stylesheet" href="/css/screen.css" type="text/css" charset="utf-8" />
+    <link rel="stylesheet" href="/css/gollum.css" type="text/css" charset="utf-8" />
+    <link rel="stylesheet" href="/css/syntax.css" type="text/css" charset="utf-8" />
+    <link rel="stylesheet" href="/css/editbar.css" type="text/css" charset="utf-8" />
+    <script src="/javascript/jquery-1.4.2.min.js" type="text/javascript"></script>
+    <script src="/javascript/jquery.text_selection-1.0.0.min.js" type="text/javascript"></script>
+    <script src="/javascript/jquery.previewable_comment_form.js" type="text/javascript"></script>
+    <script src="/javascript/jquery.tabs.js" type="text/javascript"></script>
+    <script src="/javascript/gollum.js" type="text/javascript"></script>
+    <script src="/javascript/MathJax/MathJax.js" type="text/javascript">
+      MathJax.OutputJax.fontDir = "http://github-assets.s3.amazonaws.com/javascripts/MathJax/fonts"
+      MathJax.Hub.Config({
+        jax: ["input/TeX", "output/HTML-CSS"]
+      })
+    </script>
+  </head>
+  <body>
+    <div id="main">
+      <div class="site">
+        <div id="guides">
+          {{{yield}}}
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

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

@@ -0,0 +1,27 @@
+<div class="guide">
+  <div class="main">
+    <div class="actions">
+      <a href="/">Home</a> | <a href="/edit/{{name}}">Edit</a>
+    </div>
+    <h1>{{title}}</h1>
+    <div class="content wikistyle gollum {{format}}">
+      {{{content}}}
+    </div>
+    {{#has_footer}}
+    <div class="footer wikistyle gollum {{footer_format}}">
+      {{{footer_content}}}
+    </div>
+    {{/has_footer}}
+  </div>
+</div>
+<div class="admin">
+  <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>
+    </div>
+  </div>
+  <div style="float: right;">
+    <a href="/history/{{name}}">View Revision History</a>
+  </div>
+</div>

data/lib/gollum/frontend/views/compare.rb ADDED

@@ -0,0 +1,90 @@
+module Precious
+  module Views
+    class Compare < Layout
+      attr_reader :page, :diff, :versions
+      def title
+        "Comparison of #{@page.title}"
+      end
+      def path
+        @page.path
+      end
+      def before
+        @versions[0][0..6]
+      end
+      def after
+        @versions[1][0..6]
+      end
+      def lines
+        lines = []
+        @diff.diff.split("\n")[2..-1].each_with_index do |line, line_index|
+          lines << { :line => line,
+                     :class => line_class(line),
+                     :ldln => left_diff_line_number(0, line),
+                     :rdln => right_diff_line_number(0, line) }
+        end
+        lines
+      end
+      # private
+      def line_class(line)
+        if line =~ /^@@/
+          'gc'
+        elsif line =~ /^\+/
+          'gi'
+        elsif line =~ /^\-/
+          'gd'
+        else
+          ''
+        end
+      end
+      @left_diff_line_number = nil
+      def left_diff_line_number(id, line)
+        if line =~ /^@@/
+          m, li = *line.match(/\-(\d+)/)
+          @left_diff_line_number = li.to_i
+          @current_line_number = @left_diff_line_number
+          ret = '...'
+        elsif line[0] == ?-
+          ret = @left_diff_line_number.to_s
+          @left_diff_line_number += 1
+          @current_line_number = @left_diff_line_number - 1
+        elsif line[0] == ?+
+          ret = ' '
+        else
+          ret = @left_diff_line_number.to_s
+          @left_diff_line_number += 1
+          @current_line_number = @left_diff_line_number - 1
+        end
+        ret
+      end
+      @right_diff_line_number = nil
+      def right_diff_line_number(id, line)
+        if line =~ /^@@/
+          m, ri = *line.match(/\+(\d+)/)
+          @right_diff_line_number = ri.to_i
+          @current_line_number = @right_diff_line_number
+          ret = '...'
+        elsif line[0] == ?-
+          ret = ' '
+        elsif line[0] == ?+
+          ret = @right_diff_line_number.to_s
+          @right_diff_line_number += 1
+          @current_line_number = @right_diff_line_number - 1
+        else
+          ret = @right_diff_line_number.to_s
+          @right_diff_line_number += 1
+          @current_line_number = @right_diff_line_number - 1
+        end
+        ret
+      end
+    end
+  end
+end

data/lib/gollum/frontend/views/create.rb ADDED

@@ -0,0 +1,21 @@
+module Precious
+  module Views
+    class Create < Layout
+      include Editable
+      attr_reader :page, :name
+      def title
+        "Create a new page"
+      end
+      def page_name
+        @name.gsub('-', ' ')
+      end
+      def formats
+        super(:markdown)
+      end
+    end
+  end
+end

data/lib/gollum/frontend/views/edit.rb ADDED

@@ -0,0 +1,13 @@
+module Precious
+  module Views
+    class Edit < Layout
+      include Editable
+      attr_reader :page, :content
+      def title
+        "Editing #{@page.title}"
+      end
+    end
+  end
+end

data/lib/gollum/frontend/views/editable.rb ADDED

@@ -0,0 +1,13 @@
+module Precious
+  module Editable
+    def formats(selected = @page.format)
+      Gollum::Page::FORMAT_NAMES.map do |key, val|
+        { :name     => val,
+          :id       => key.to_s,
+          :selected => selected == key}
+      end.sort do |a, b|
+        a[:name].downcase <=> b[:name].downcase
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Precious
+  module Views
+    class History < Layout
+      attr_reader :page, :page_num
+      def title
+        "History of #{@page.title}"
+      end
+      def versions
+        i = @versions.size + 1
+        @versions.map do |v|
+          i -= 1
+          { :id       => v.id,
+            :id7      => v.id[0..6],
+            :num      => i,
+            :selected => @page.version.id == v.id,
+            :author   => v.author.name,
+            :message  => v.message,
+            :date     => v.committed_date.strftime("%B %d, %Y"),
+            :gravatar => Digest::MD5.hexdigest(v.author.email) }
+        end
+      end
+      def previous_link
+        label = "&laquo; Previous"
+        if @page_num == 1
+          %(<span class="disabled">#{label}</span>)
+        else
+          %(<a href="/history/#{@page.name}?page=#{@page_num-1}" 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>)
+        else
+          %(<span class="disabled">#{label}</span>)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Precious
+  module Views
+    class Layout < Mustache
+      include Rack::Utils
+      alias_method :h, :escape_html
+      attr_reader :name
+      def title
+        "Home"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Precious
+  module Views
+    class Page < Layout
+      attr_reader :content, :page, :footer
+      def title
+        @page.title
+      end
+      def format
+        @page.format.to_s
+      end
+      def author
+        @page.version.author.name
+      end
+      def date
+        @page.version.authored_date.strftime("%Y-%m-%d %H:%M:%S")
+      end
+      def has_footer
+        @footer ||= @page.footer
+        !@footer.nil?
+      end
+      def footer_content
+        @footer ||= @page.footer
+        @footer.formatted_data
+      end
+      def footer_format
+        @footer ||= @page.footer
+        @footer.format.to_s
+      end
+    end
+  end
+end

data/lib/gollum/markup.rb ADDED

@@ -0,0 +1,331 @@
+require 'digest/sha1'
+module Gollum
+  class Markup
+    # Initialize a new Markup object.
+    #
+    # page - The Gollum::Page.
+    #
+    # Returns a new Gollum::Markup object, ready for rendering.
+    def initialize(page)
+      @wiki    = page.wiki
+      @name    = page.filename
+      @data    = page.raw_data
+      @version = page.version.id
+      @dir     = ::File.dirname(page.path)
+      @tagmap  = {}
+      @codemap = {}
+      @texmap  = {}
+    end
+    # Render the content with Gollum wiki syntax on top of the file's own
+    # markup language.
+    #
+    # Returns the formatted String content.
+    def render
+      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)
+      data = Sanitize.clean(data, SANITIZATION_OPTIONS)
+      data = process_tex(data)
+      data = data.gsub(/<p><\/p>/, '')
+      data
+    end
+    #########################################################################
+    #
+    # TeX
+    #
+    #########################################################################
+    # Extract all TeX into the texmap and replace with placeholders.
+    #
+    # data - The raw String data.
+    #
+    # Returns the placeholder'd String data.
+    def extract_tex(data)
+      data.gsub(/\\\[\s*(.*?)\s*\\\]/m) do
+        id = Digest::SHA1.hexdigest($1)
+        @texmap[id] = [:block, $1]
+        id
+      end.gsub(/\\\(\s*(.*?)\s*\\\)/m) do
+        id = Digest::SHA1.hexdigest($1)
+        @texmap[id] = [:inline, $1]
+        id
+      end
+    end
+    # Process all TeX from the texmap and replace the placeholders with the
+    # final markup.
+    #
+    # data - The String data (with placeholders).
+    #
+    # Returns the marked up String data.
+    def process_tex(data)
+      @texmap.each do |id, spec|
+        type, tex = *spec
+        out =
+        case type
+          when :block
+            %{<script type="math/tex; mode=display">#{tex}</script>}
+          when :inline
+            %{<script type="math/tex">#{tex}</script>}
+        end
+        data.gsub!(id, out)
+      end
+      data
+    end
+    #########################################################################
+    #
+    # Tags
+    #
+    #########################################################################
+    # Extract all tags into the tagmap and replace with placeholders.
+    #
+    # data - The raw String data.
+    #
+    # Returns the placeholder'd String data.
+    def extract_tags(data)
+      data.gsub(/(.?)\[\[(.+?)\]\]([^\[]?)/m) do
+        if $1 == "'" && $3 != "'"
+          "[[#{$2}]]#{$3}"
+        elsif $2.include?('][')
+          $&
+        else
+          id = Digest::SHA1.hexdigest($2)
+          @tagmap[id] = $2
+          "#{$1}#{id}#{$3}"
+        end
+      end
+    end
+    # Process all tags from the tagmap and replace the placeholders with the
+    # final markup.
+    #
+    # data - The String data (with placeholders).
+    #
+    # Returns the marked up String data.
+    def process_tags(data)
+      @tagmap.each do |id, tag|
+        data.gsub!(id, process_tag(tag))
+      end
+      data
+    end
+    # Process a single tag into its final HTML form.
+    #
+    # tag - The String tag contents (the stuff inside the double brackets).
+    #
+    # Returns the String HTML version of the tag.
+    def process_tag(tag)
+      if html = process_image_tag(tag)
+        return html
+      elsif html = process_file_link_tag(tag)
+        return html
+      else
+        return process_page_link_tag(tag)
+      end
+    end
+    # Attempt to process the tag as an image tag.
+    #
+    # tag - The String tag contents (the stuff inside the double brackets).
+    #
+    # Returns the String HTML if the tag is a valid image tag or nil
+    #   if it is not.
+    def process_image_tag(tag)
+      parts = tag.split('|')
+      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)$/
+        name
+      end
+      if path
+        opts = parse_image_tag_options(tag)
+        containered = false
+        classes = [] # applied to whatever the outermost container is
+        attrs   = [] # applied to the image
+        align = opts['align']
+        if opts['float']
+          containered = true
+          align ||= 'left'
+          if %w{left right}.include?(align)
+            classes << "float-#{align}"
+          end
+        elsif %w{top texttop middle absmiddle bottom absbottom baseline}.include?(align)
+          attrs << %{align="#{align}"}
+        elsif align
+          if %w{left center right}.include?(align)
+            containered = true
+            classes << "align-#{align}"
+          end
+        end
+        if width = opts['width']
+          if width =~ /^\d+(\.\d+)?(em|px)$/
+            attrs << %{width="#{width}"}
+          end
+        end
+        if height = opts['height']
+          if height =~ /^\d+(\.\d+)?(em|px)$/
+            attrs << %{height="#{height}"}
+          end
+        end
+        if alt = opts['alt']
+          attrs << %{alt="#{alt}"}
+        end
+        attr_string = attrs.size > 0 ? attrs.join(' ') + ' ' : ''
+        if opts['frame'] || containered
+          classes << 'frame' if opts['frame']
+          %{<span class="#{classes.join(' ')}">} +
+          %{<span>} +
+          %{<img src="/#{file.path}" #{attr_string}/>} +
+          (alt ? %{<span>#{alt}</span>} : '') +
+          %{</span>} +
+          %{</span>}
+        else
+          %{<img src="#{path}" #{attr_string}/>}
+        end
+      end
+    end
+    # Parse any options present on the image tag and extract them into a
+    # Hash of option names and values.
+    #
+    # tag - The String tag contents (the stuff inside the double brackets).
+    #
+    # Returns the options Hash:
+    #   key - The String option name.
+    #   val - The String option value or true if it is a binary option.
+    def parse_image_tag_options(tag)
+      tag.split('|')[1..-1].inject({}) do |memo, attr|
+        parts = attr.split('=').map { |x| x.strip }
+        memo[parts[0]] = (parts.size == 1 ? true : parts[1])
+        memo
+      end
+    end
+    # Attempt to process the tag as a file link tag.
+    #
+    # tag - The String tag contents (the stuff inside the double brackets).
+    #
+    # 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)
+      parts = tag.split('|')
+      name  = parts[0].strip
+      path  = parts[1] && parts[1].strip
+      path  = if path && file = find_file(path)
+        ::File.join @wiki.base_path, file.path
+      elsif path =~ %r{^https?://}
+        path
+      else
+        nil
+      end
+      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
+    end
+    # Attempt to process the tag as a page link tag.
+    #
+    # tag - The String tag contents (the stuff inside the double brackets).
+    #
+    # 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)
+      parts = tag.split('|')
+      name  = parts[0].strip
+      cname = Page.cname((parts[1] || parts[0]).strip)
+      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"
+        end
+        %{<a class="internal #{presence}" href="#{link}">#{name}</a>}
+      end
+    end
+    # Find the given file in the repo.
+    #
+    # name - The String absolute or relative path of the file.
+    #
+    # Returns the Gollum::File or nil if none was found.
+    def find_file(name)
+      if name =~ /^\//
+        @wiki.file(name[1..-1], @version)
+      else
+        path = @dir == '.' ? name : ::File.join(@dir, name)
+        @wiki.file(path, @version)
+      end
+    end
+    #########################################################################
+    #
+    # Code
+    #
+    #########################################################################
+    # Extract all code blocks into the codemap and replace with placeholders.
+    #
+    # data - The raw String data.
+    #
+    # Returns the placeholder'd String data.
+    def extract_code(data)
+      data.gsub(/^``` ?(.+?)\r?\n(.+?)\r?\n```\r?$/m) do
+        id = Digest::SHA1.hexdigest($2)
+        @codemap[id] = { :lang => $1, :code => $2 }
+        id
+      end
+    end
+    # Process all code from the codemap and replace the placeholders with the
+    # final HTML.
+    #
+    # data - The String data (with placeholders).
+    #
+    # Returns the marked up String data.
+    def process_code(data)
+      @codemap.each do |id, spec|
+        lang = spec[:lang]
+        code = spec[:code]
+        if code.all? { |line| line =~ /\A\r?\n\Z/ || line =~ /^(  |\t)/ }
+          code.gsub!(/^(  |\t)/m, '')
+        end
+        data.gsub!(id, Gollum::Albino.new(code, lang).colorize)
+      end
+      data
+    end
+  end
+end