gollum-lib 2.0.0 → 3.0.0

data/lib/gollum-lib/filter/code.rb

@@ -28,20 +28,20 @@ class Gollum::Filter::Code < Gollum::Filter
         lang = lang[1] unless lang.nil?
       end
 
-      @map[id] = cached   ?
-      { :output => cached } :
-      { :lang => lang, :code => m_code, :indent => m_indent }
+      @map[id] = cached ?
+          { :output => cached } :
+          { :lang => lang, :code => m_code, :indent => m_indent }
 
       "#{m_indent}#{id}" # print the SHA1 ID with the proper indentation
     end
 
     data.gsub!(/^([ \t]*)``` ?([^\r\n]+)?\r?\n(.+?)\r?\n\1```[ \t]*\r?$/m) do
-      lang   = $2 ? $2.strip : nil
-      id     = Digest::SHA1.hexdigest("#{lang}.#{$3}")
-      cached = @markup.check_cache(:code, id)
-      @map[id] = cached   ?
-        { :output => cached } :
-        { :lang => lang, :code => $3, :indent => $1 }
+      lang     = $2 ? $2.strip : nil
+      id       = Digest::SHA1.hexdigest("#{lang}.#{$3}")
+      cached   = @markup.check_cache(:code, id)
+      @map[id] = cached ?
+          { :output => cached } :
+          { :lang => lang, :code => $3, :indent => $1 }
       "#{$1}#{id}" # print the SHA1 ID with the proper indentation
     end
 
@@ -74,18 +74,30 @@ class Gollum::Filter::Code < Gollum::Filter
     highlighted = []
     blocks.each do |lang, code|
       encoding = @markup.encoding || 'utf-8'
-      begin
-        if Rouge::Lexer.find(lang).nil?
-          lexer = Rouge::Lexers::PlainText.new
-          formatter = Rouge::Formatters::HTML.new(:wrap => false)
-          hl_code = formatter.format(lexer.lex(code))
-          hl_code = "<pre class='highlight'><span class='err'>#{CGI.escapeHTML(hl_code)}</span></pre>"
+
+      if defined? Pygments
+        # treat unknown and bash as standard pre tags
+        if !lang || lang.downcase == 'bash'
+          hl_code = "<pre>#{code}</pre>"
         else
-          hl_code = Rouge.highlight(code, lang, 'html')  
+          # must set startinline to true for php to be highlighted without <?
+          hl_code = Pygments.highlight(code, :lexer => lang, :options => { :encoding => encoding.to_s, :startinline => true })
+        end
+      else # Rouge
+        begin
+          if Rouge::Lexer.find(lang).nil?
+            lexer     = Rouge::Lexers::PlainText.new
+            formatter = Rouge::Formatters::HTML.new(:wrap => false)
+            hl_code   = formatter.format(lexer.lex(code))
+            hl_code   = "<pre class='highlight'><span class='err'>#{CGI.escapeHTML(hl_code)}</span></pre>"
+          else
+            hl_code = Rouge.highlight(code, lang, 'html')
+          end
+        rescue
+          hl_code = code
         end
-      rescue
-        hl_code = code
       end
+
       highlighted << hl_code
     end
 

data/lib/gollum-lib/filter/metadata.rb

@@ -16,12 +16,14 @@ class Gollum::Filter::Metadata < Gollum::Filter
       # HTML elements before parsing each line.
       $1.split("\n").each do |line|
         line.gsub!(/<[^>]*>/, '')
-        k, v = line.split(':', 2)
+        k, v                      = line.split(':', 2)
         @markup.metadata[k.strip] = (v ? v.strip : '') if k
       end
       ''
     end
   end
-  
-  def process(d) d; end
+
+  def process(d)
+    d
+  end
 end

data/lib/gollum-lib/filter/plain_text.rb

@@ -10,6 +10,7 @@ class Gollum::Filter::PlainText < Gollum::Filter
     @markup.format == :txt ? "<pre>#{CGI.escapeHTML(data)}</pre>" : data
   end
 
-  def process(data); data ; end
-
-end
+  def process(data)
+    data
+  end
+end

data/lib/gollum-lib/filter/remote_code.rb

@@ -16,7 +16,7 @@ class Gollum::Filter::RemoteCode < Gollum::Filter
     return data if @markup.format == :txt
     data.gsub /^[ \t]*``` ?([^:\n\r]+):((http)?[^`\n\r]+)```/ do
       language = $1
-      uri = $2
+      uri      = $2
       protocol = $3
 
       # Detect local file
@@ -34,28 +34,30 @@ class Gollum::Filter::RemoteCode < Gollum::Filter
       "```#{language}\n#{contents}\n```\n"
     end
   end
-  
-  def process(d) d; end
+
+  def process(d)
+    d
+  end
 
   private
 
-    def req uri, cut = 1
-      uri = URI(uri)
-      return "Too many redirects or retries" if cut >= 10
-      http = Net::HTTP.new uri.host, uri.port
-      http.use_ssl = true
-      resp = http.get uri.path, {
+  def req uri, cut = 1
+    uri = URI(uri)
+    return "Too many redirects or retries" if cut >= 10
+    http         = Net::HTTP.new uri.host, uri.port
+    http.use_ssl = true
+    resp         = http.get uri.path, {
         'Accept'        => 'text/plain',
         'Cache-Control' => 'no-cache',
         'Connection'    => 'keep-alive',
         'User-Agent'    => 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:15.0) Gecko/20100101 Firefox/15.0'
-      }
-      code = resp.code.to_i
-      return resp.body if code == 200
-      return "Not Found" if code == 404
-      return "Unhandled Response Code #{code}" unless code == 304 or not resp.header['location'].nil?
-      loc = URI.parse resp.header['location']
-      uri2 = loc.relative? ? (uri + loc) : loc # overloads (+)
-      req uri2, (cut + 1)
-    end
+    }
+    code         = resp.code.to_i
+    return resp.body if code == 200
+    return "Not Found" if code == 404
+    return "Unhandled Response Code #{code}" unless code == 304 or not resp.header['location'].nil?
+    loc  = URI.parse resp.header['location']
+    uri2 = loc.relative? ? (uri + loc) : loc # overloads (+)
+    req uri2, (cut + 1)
+  end
 end

data/lib/gollum-lib/filter/render.rb

@@ -14,5 +14,7 @@ class Gollum::Filter::Render < Gollum::Filter
     data
   end
 
-  def process(d) d; end
-end
+  def process(d)
+    d
+  end
+end

data/lib/gollum-lib/filter/sanitize.rb

@@ -1,8 +1,10 @@
 # ~*~ encoding: utf-8 ~*~
 
 class Gollum::Filter::Sanitize < Gollum::Filter
-  def extract(d) d; end
-  
+  def extract(d)
+    d
+  end
+
   def process(data)
     if @markup.sanitize
       doc = Nokogiri::HTML::DocumentFragment.parse(data)

data/lib/gollum-lib/filter/tags.rb

@@ -10,19 +10,19 @@ class Gollum::Filter::Tags < Gollum::Filter
         "[[#{$2}]]#{$3}"
       elsif $2.include?('][')
         if $2[0..4] == 'file:'
-          pre = $1
-          post = $3
-          parts = $2.split('][')
+          pre            = $1
+          post           = $3
+          parts          = $2.split('][')
           parts[0][0..4] = ""
-          link = "#{parts[1]}|#{parts[0].sub(/\.org/,'')}"
-          id = Digest::SHA1.hexdigest(link)
-          @map[id] = link
+          link           = "#{parts[1]}|#{parts[0].sub(/\.org/, '')}"
+          id             = Digest::SHA1.hexdigest(link)
+          @map[id]       = link
           "#{pre}#{id}#{post}"
         else
           $&
         end
       else
-        id = Digest::SHA1.hexdigest($2)
+        id       = Digest::SHA1.hexdigest($2)
         @map[id] = $2
         "#{$1}#{id}#{$3}"
       end
@@ -56,11 +56,12 @@ class Gollum::Filter::Tags < Gollum::Filter
   # 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)
+    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) })
+        node.ancestors.any? { |a| PREFORMATTED_TAGS.include?(a.name) })
   end
 
   # Process a single tag into its final HTML form.
@@ -84,7 +85,7 @@ class Gollum::Filter::Tags < Gollum::Filter
       process_page_link_tag(tag)
     end
   end
-  
+
   # Attempt to process the tag as an include tag
   #
   # tag - The String tag contents (the  stuff inside the double brackets).
@@ -94,8 +95,8 @@ class Gollum::Filter::Tags < Gollum::Filter
   #
   def process_include_tag(tag)
     return unless /^include:/.match(tag)
-    page_name = tag[8..-1]
-    resolved_page_name =  ::File.expand_path(page_name, "/"+@markup.dir)
+    page_name          = tag[8..-1]
+    resolved_page_name = ::File.expand_path(page_name, "/"+@markup.dir)
 
     if @markup.include_levels > 0
       page = find_page_from_name(resolved_page_name)
@@ -119,12 +120,12 @@ class Gollum::Filter::Tags < Gollum::Filter
     parts = tag.split('|')
     return if parts.size.zero?
 
-    name  = parts[0].strip
-    path  = if file = @markup.find_file(name)
-      ::File.join @markup.wiki.base_path, file.path
-    elsif name =~ /^https?:\/\/.+(jpg|png|gif|svg|bmp)$/i
-      name
-    end
+    name = parts[0].strip
+    path = if file = @markup.find_file(name)
+             ::File.join @markup.wiki.base_path, file.path
+           elsif name =~ /^https?:\/\/.+(jpg|png|gif|svg|bmp)$/i
+             name
+           end
 
     if path
       opts = parse_image_tag_options(tag)
@@ -137,7 +138,7 @@ class Gollum::Filter::Tags < Gollum::Filter
       align = opts['align']
       if opts['float']
         containered = true
-        align ||= 'left'
+        align       ||= 'left'
         if %w{left right}.include?(align)
           classes << "float-#{align}"
         end
@@ -171,11 +172,11 @@ class Gollum::Filter::Tags < Gollum::Filter
       if opts['frame'] || containered
         classes << 'frame' if opts['frame']
         %{<span class="#{classes.join(' ')}">} +
-        %{<span>} +
-        %{<img src="#{path}" #{attr_string}/>} +
-        (alt ? %{<span>#{alt}</span>} : '') +
-        %{</span>} +
-        %{</span>}
+            %{<span>} +
+            %{<img src="#{path}" #{attr_string}/>} +
+            (alt ? %{<span>#{alt}</span>} : '') +
+            %{</span>} +
+            %{</span>}
       else
         %{<img src="#{path}" #{attr_string}/>}
       end
@@ -192,7 +193,7 @@ class Gollum::Filter::Tags < Gollum::Filter
   #   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 }
+      parts          = attr.split('=').map { |x| x.strip }
       memo[parts[0]] = (parts.size == 1 ? true : parts[1])
       memo
     end
@@ -209,15 +210,15 @@ class Gollum::Filter::Tags < Gollum::Filter
     parts = tag.split('|')
     return if parts.size.zero?
 
-    name  = parts[0].strip
-    path  = parts[1] && parts[1].strip
-    path  = if path && file = @markup.find_file(path)
-      ::File.join @markup.wiki.base_path, file.path
-    elsif path =~ %r{^https?://}
-      path
-    else
-      nil
-    end
+    name = parts[0].strip
+    path = parts[1] && parts[1].strip
+    path = if path && file = @markup.find_file(path)
+             ::File.join @markup.wiki.base_path, file.path
+           elsif path =~ %r{^https?://}
+             path
+           else
+             nil
+           end
 
     if name && path && file
       %{<a href="#{::File.join @markup.wiki.base_path, file.path}">#{name}</a>}
@@ -240,7 +241,7 @@ class Gollum::Filter::Tags < Gollum::Filter
     parts.reverse! if @markup.format == :mediawiki
 
     name, page_name = *parts.compact.map(&:strip)
-    cname = @markup.wiki.page_class.cname(page_name || name)
+    cname           = @markup.wiki.page_class.cname(page_name || name)
 
     if name =~ %r{^https?://} && page_name.nil?
       %{<a href="#{name}">#{name}</a>}

data/lib/gollum-lib/filter/toc.rb

@@ -1,31 +1,47 @@
 # Inserts header anchors and creates TOC
 class Gollum::Filter::TOC < Gollum::Filter
-  def extract(d) d; end
-  
+  def extract(d)
+    d
+  end
+
   def process(data)
-    doc = Nokogiri::HTML::DocumentFragment.parse(data)
-    toc = nil
+    doc          = Nokogiri::HTML::DocumentFragment.parse(data)
+    toc          = nil
+    anchor_names = {}
+
     doc.css('h1,h2,h3,h4,h5,h6').each do |h|
       # must escape "
-      h_name = h.content.gsub(' ','-').gsub('"','%22')
+      h_name               = h.content.gsub(' ', '-').gsub('"', '%22')
+
+      # Ensure repeat anchors have a unique prefix or the
+      # toc will break
+      anchor_names[h_name] = 0 if anchor_names[h_name].nil?
+      anchor_names[h_name] += 1
+
+      anchor_prefix_number = anchor_names[h_name]
+      if anchor_prefix_number > 1
+        h_name = anchor_prefix_number.to_s + '-' + h_name
+      end
 
-      level = h.name.gsub(/[hH]/,'').to_i
+      level = h.name.gsub(/[hH]/, '').to_i
 
       # Add anchors
-      h.add_child(%Q{<a class="anchor" id="#{h_name}" href="##{h_name}"></a>})
+      anchor_element = %Q(<a class="anchor" id="#{h_name}" href="##{h_name}"><i class="fa fa-link"></i></a>)
+      # Add anchor element as the first child (before h.content)
+      h.children.before anchor_element
 
       # Build TOC
-      toc ||= Nokogiri::XML::DocumentFragment.parse('<div class="toc"><div class="toc-title">Table of Contents</div></div>')
-      tail ||= toc.child
+      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)
+        node       = Nokogiri::XML::Node.new('ul', doc)
+        tail       = tail.add_child(node)
         tail_level += 1
       end
       while tail_level > level
-        tail = tail.parent
+        tail       = tail.parent
         tail_level -= 1
       end
       node = Nokogiri::XML::Node.new('li', doc)
@@ -42,4 +58,4 @@ class Gollum::Filter::TOC < Gollum::Filter
       toc.nil? ? '' : toc
     end
   end
-end
+end

data/lib/gollum-lib/filter/wsd.rb

@@ -16,7 +16,7 @@ class Gollum::Filter::WSD < Gollum::Filter
   def extract(data)
     return data if @markup.format == :txt
     data.gsub(/^\{\{\{\{\{\{ ?(.+?)\r?\n(.+?)\r?\n\}\}\}\}\}\}\r?$/m) do
-      id = Digest::SHA1.hexdigest($2)
+      id       = Digest::SHA1.hexdigest($2)
       @map[id] = { :style => $1, :code => $2 }
       id
     end

data/lib/gollum-lib/git_access.rb

@@ -12,7 +12,7 @@ module Gollum
     # Returns this instance.
     def initialize(path, page_file_dir = nil, bare = false)
       @page_file_dir = page_file_dir
-      @path = path
+      @path          = path
       begin
         @repo = Grit::Repo.new(path, { :is_bare => bare })
       rescue Grit::InvalidGitRepositoryError
@@ -40,11 +40,11 @@ module Gollum
       ref = ref.to_s
       return if ref.empty?
       sha =
-        if sha?(ref)
-          ref
-        else
-          get_cache(:ref, ref) { ref_to_sha!(ref) }
-        end.to_s
+          if sha?(ref)
+            ref
+          else
+            get_cache(:ref, ref) { ref_to_sha!(ref) }
+          end.to_s
       sha.empty? ? nil : sha
     end
 
@@ -84,7 +84,7 @@ module Gollum
           commit(sha)
         else
           if cm = commit!(ref)
-            set_cache(:ref,    ref,   cm.id)
+            set_cache(:ref, ref, cm.id)
             set_cache(:commit, cm.id, cm)
           end
         end
@@ -163,11 +163,11 @@ module Gollum
     #
     # Returns an Array of BlobEntry instances.
     def tree!(sha)
-      tree = @repo.lstree(sha, {:recursive => true})
+      tree  = @repo.lstree(sha, { :recursive => true })
       items = []
       tree.each do |entry|
         if entry[:type] == 'blob'
-          items << BlobEntry.new(entry[:sha], entry[:path], entry[:size], entry[:mode].to_i(8)) 
+          items << BlobEntry.new(entry[:sha], entry[:path], entry[:size], entry[:mode].to_i(8))
         end
       end
       if dir = @page_file_dir
@@ -184,7 +184,7 @@ module Gollum
     #
     # Returns the String content of the Git object.
     def cat_file!(sha)
-      @repo.git.cat_file({:p => true}, sha)
+      @repo.git.cat_file({ :p => true }, sha)
     end
 
     # Reads a Git commit.
@@ -244,7 +244,7 @@ module Gollum
     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 }
+        path.gsub!(/\\\d{3}/) { |m| m[1..-1].to_i(8).chr }
       end
       path.gsub!(/\\[rn"\\]/) { |m| eval(%("#{m.to_s}")) }
       path