gollum-lib 4.0.3 → 4.1.0

data/lib/gollum-lib/gitcode.rb

@@ -6,7 +6,7 @@ require 'open-uri'
 
 module Gollum
   class Gitcode
-    def initialize path
+    def initialize(path)
       raise(ArgumentError, 'path is nil or empty') if path.nil? or path.empty?
 
       @uri = URI::HTTP.build({
@@ -20,12 +20,12 @@ module Gollum
       @contents ||= self.req @uri
     end
 
-    def unchomp p
+    def unchomp(p)
       return p if p.nil?
       p[0] == '/' ? p : ('/' + p)
     end
 
-    def req uri, cut = 1
+    def req(uri, cut = 1)
       return "Too many redirects or retries" if cut >= 10
       http         = Net::HTTP.new uri.host, uri.port
       http.use_ssl = true

data/lib/gollum-lib/helpers.rb

@@ -2,7 +2,7 @@
 module Gollum
   module Helpers
 
-    def trim_leading_slash url
+    def trim_leading_slash(url)
       return url if url.nil?
       url.gsub!('%2F', '/')
       return '/' + url.gsub(/^\/+/, '') if url[0, 1] == '/'

data/lib/gollum-lib/macro/global_toc.rb

@@ -0,0 +1,12 @@
+module Gollum
+  class Macro
+    class GlobalTOC < Gollum::Macro
+      def render(title = "Global Table of Contents")
+        if @wiki.pages.size > 0
+          result = '<ul>' + @wiki.pages.map { |p| "<li><a href=\"#{p.url_path}\">#{p.url_path_display}</a></li>" }.join + '</ul>'
+        end
+        "<div class=\"toc\"><div class=\"toc-title\">#{title}</div>#{result}</div>"
+      end
+    end
+  end
+end

data/lib/gollum-lib/macro/series.rb

@@ -0,0 +1,48 @@
+module Gollum
+  class Macro
+
+    class Series < Gollum::Macro
+      def render(series_prefix = "")
+      	raise "This page's name does not match the prefix '#{series_prefix}'" unless @page.name =~ /^#{series_prefix}/
+      	render_links(*find_series(series_prefix))
+      end
+
+      def render_links(previous_page, next_page)
+      	result = "Previous: <a href=\"#{::File.join(@wiki.base_path,previous_page.escaped_url_path)}\">#{previous_page.name}</a>" if previous_page
+      	result = "#{result}#{result ? ' | ' : ''}Next: <a href=\"#{::File.join(@wiki.base_path,next_page.escaped_url_path)}\">#{next_page.name}</a>" if next_page
+      	wrap_result(result)
+      end
+
+      def wrap_result(result)
+      	result.nil? ? "" : "<div class=\"series\">#{result}</div>"
+      end
+
+      def find_series(series_prefix = "")
+      	dir = @wiki.pages.select {|page| ::File.dirname(page.path) == ::File.dirname(@page.path)}
+      	dir.select! {|page| page.name =~ /\A#{series_prefix}/ } unless series_prefix.empty?
+      	dir.sort_by! {|page| page.name}
+      	self_index = dir.find_index {|page| page.name == @page.name}
+      	if self_index > 0
+          return dir[self_index-1], dir[self_index+1]
+      	else
+          return nil, dir[self_index+1]
+      	end
+      end
+    end
+
+    class SeriesStart < Gollum::Macro::Series
+      def render_links(previous_page, next_page)
+        result = "Next: <a href=\"#{::File.join(@wiki.base_path,next_page.escaped_url_path)}\">#{next_page.name}</a>" if next_page
+        wrap_result(result)
+      end
+    end
+
+    class SeriesEnd < Gollum::Macro::Series
+      def render_links(previous_page, next_page)
+        result = "Previous: <a href=\"#{::File.join(@wiki.base_path,previous_page.escaped_url_path)}\">#{previous_page.name}</a>" if previous_page
+        wrap_result(result)
+      end
+    end
+
+  end
+end

data/lib/gollum-lib/markup.rb

@@ -42,8 +42,9 @@ module Gollum
       # If given a block, that block will be registered with GitHub::Markup to
       # render any matching pages
       def register(ext, name, options = {}, &block)
-        regexp        = options[:regexp] || Regexp.new(ext.to_s)
-        @formats[ext] = { :name => name, :regexp => regexp }
+        @formats[ext] = { :name => name,
+          :regexp => options.fetch(:regexp, Regexp.new(ext.to_s)),
+          :reverse_links => options.fetch(:reverse_links, false) }
       end
     end
 
@@ -82,6 +83,10 @@ module Gollum
       @to_xml_opts = { :save_with => Nokogiri::XML::Node::SaveOptions::DEFAULT_XHTML ^ 1, :indent => 0, :encoding => 'UTF-8' }
     end
 
+    def reverse_links?
+      self.class.formats[@format][:reverse_links]
+    end
+
     # Render data using default chain in the target format.
     #
     # data - the data to render
@@ -89,7 +94,7 @@ module Gollum
     # name - name using the extension of the format
     #
     # Returns the processed data
-    def render_default data, format=:markdown, name='render_default.md'
+    def render_default(data, format=:markdown, name='render_default.md')
       # set instance vars so we're able to render data without a wiki or page.
       @format = format
       @name   = name

data/lib/gollum-lib/markups.rb

@@ -10,10 +10,10 @@ module Gollum
     register(:textile,   "Textile")
     register(:rdoc,      "RDoc")
     register(:org,       "Org-mode")
-    register(:creole,    "Creole")
+    register(:creole,    "Creole", :reverse_links => true)
     register(:rest,      "reStructuredText", :regexp => /re?st(\.txt)?/)
     register(:asciidoc,  "AsciiDoc")
-    register(:mediawiki, "MediaWiki", :regexp => /(media)?wiki/)
+    register(:mediawiki, "MediaWiki", :regexp => /(media)?wiki/, :reverse_links => true)
     register(:pod,       "Pod")
     register(:txt,       "Plain Text")
   end

data/lib/gollum-lib/page.rb

@@ -23,7 +23,7 @@ module Gollum
     # Returns e.g. ["Home", :markdown], or [] if the extension is unregistered
     def self.parse_filename(filename)
       return [] unless filename =~ /^(.+)\.([a-zA-Z]\w*)$/i
-      pref, ext = $1, $2
+      pref, ext = Regexp.last_match[1], Regexp.last_match[2]
 
       Gollum::Markup.formats.each_pair do |name, format|
         return [pref, name] if ext =~ format[:regexp]
@@ -236,7 +236,7 @@ module Gollum
     # formatted_data - page already marked up in html.
     #
     # Returns the String data.
-    def toc_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
@@ -245,7 +245,7 @@ module Gollum
     # Public: Embedded metadata.
     #
     # Returns Hash of metadata.
-    def metadata()
+    def metadata
       formatted_data if markup_class.metadata == nil
       markup_class.metadata
     end
@@ -341,7 +341,7 @@ module Gollum
     # Returns the String canonical name.
     def self.cname(name, char_white_sub = '-', char_other_sub = '-')
       name.respond_to?(:gsub) ?
-          name.gsub(%r{\s}, char_white_sub).gsub(%r{[<>+]}, char_other_sub) :
+          name.gsub(%r(\s), char_white_sub).gsub(%r([<>+]), char_other_sub) :
           ''
     end
 
@@ -378,7 +378,7 @@ module Gollum
     # Returns a Gollum::Page or nil if the page could not be found.
     def find(name, version, dir = nil, exact = false)
       map = @wiki.tree_map_for(version.to_s)
-      if page = find_page_in_tree(map, name, dir, exact)
+      if (page = find_page_in_tree(map, name, dir, exact))
         page.version    = version.is_a?(Gollum::Git::Commit) ?
             version : @wiki.commit_for(version)
         page.historical = page.version.to_s == version.to_s
@@ -431,7 +431,7 @@ module Gollum
     #
     # Returns the String path.
     def tree_path(treemap, tree)
-      if ptree = treemap[tree]
+      if (ptree = treemap[tree])
         tree_path(treemap, ptree) + '/' + tree.name
       else
         ''
@@ -445,7 +445,7 @@ module Gollum
     #
     # Returns a Boolean.
     def page_match(name, path)
-      if match = self.class.valid_filename?(path)
+      if (match = self.class.valid_filename?(path))
         @wiki.ws_subs.each do |sub|
           return true if Page.cname(name).downcase == Page.cname(match, sub).downcase
         end
@@ -471,14 +471,14 @@ module Gollum
       dirs.pop
       map = @wiki.tree_map_for(@wiki.ref, true)
       while !dirs.empty?
-        if page = find_page_in_tree(map, name, dirs.join('/'))
+        if (page = find_page_in_tree(map, name, dirs.join('/')))
           page.parent_page = self
           return page
         end
         dirs.pop
       end
 
-      if page = find_page_in_tree(map, name, '')
+      if (page = find_page_in_tree(map, name, ''))
         page.parent_page = self
       end
       page

data/lib/gollum-lib/sanitization.rb

@@ -50,7 +50,7 @@ module Gollum
     }.freeze
 
     ADD_ATTRIBUTES  = lambda do |env, node|
-      if add = env[:config][:add_attributes][node.name]
+      if (add = env[:config][:add_attributes][node.name])
         add.each do |key, value|
           node[key] = value
         end
@@ -71,7 +71,7 @@ module Gollum
           return if env[:is_whitelisted] || !node.element?
           prefix      = env[:config][:id_prefix]
           found_attrs = %w(id name).select do |key|
-            if value = node[key]
+            if (value = node[key])
               node[key] = value.gsub(/\A(#{prefix})?/, prefix)
             end
           end
@@ -82,7 +82,7 @@ module Gollum
         end,
         lambda do |env|
           node = env[:node]
-          return unless value = node['href']
+          return unless (value = node['href'])
           prefix       = env[:config][:id_prefix]
           node['href'] = value.gsub(/\A\#(#{prefix})?/, '#'+prefix)
           ADD_ATTRIBUTES.call(env, node)

data/lib/gollum-lib/version.rb

@@ -1,5 +1,5 @@
 module Gollum
   module Lib
-    VERSION = '4.0.3'
+    VERSION = '4.1.0'
   end
 end

data/lib/gollum-lib/wiki.rb

@@ -248,7 +248,7 @@ module Gollum
       @allow_uploads        = options.fetch :allow_uploads, false
       @per_page_uploads     = options.fetch :per_page_uploads, false
       @filter_chain         = options.fetch :filter_chain,
-                                            [:Metadata, :PlainText, :TOC, :RemoteCode, :Code, :Macro, :Sanitize, :WSD, :Tags, :Render]
+                                            [:Metadata, :PlainText, :TOC, :RemoteCode, :Code, :Macro, :Sanitize, :WSD, :PlantUML, :Tags, :Render]
     end
 
     # Public: check whether the wiki's git repo exists on the filesystem.
@@ -345,7 +345,7 @@ module Gollum
 
       committer.add_to_index(sanitized_dir, filename, format, data)
 
-      committer.after_commit do |index, sha|
+      committer.after_commit do |index, _sha|
         @access.refresh
         index.update_working_dir(sanitized_dir, filename, format)
       end
@@ -395,7 +395,7 @@ module Gollum
       committer.delete(page.path)
       committer.add_to_index(target_dir, target_name, page.format, page.raw_data)
 
-      committer.after_commit do |index, sha|
+      committer.after_commit do |index, _sha|
         @access.refresh
         index.update_working_dir(source_dir, source_name, page.format)
         index.update_working_dir(target_dir, target_name, page.format)
@@ -444,7 +444,7 @@ module Gollum
         committer.add_to_index(dir, filename, format, data)
       end
 
-      committer.after_commit do |index, sha|
+      committer.after_commit do |index, _sha|
         @access.refresh
         index.update_working_dir(dir, page.filename_stripped, page.format)
         index.update_working_dir(dir, filename, format)
@@ -476,7 +476,7 @@ module Gollum
 
       committer.delete(page.path)
 
-      committer.after_commit do |index, sha|
+      committer.after_commit do |index, _sha|
         dir = ::File.dirname(page.path)
         dir = '' if dir == '.'
 
@@ -509,12 +509,12 @@ module Gollum
         sha2   = nil
       end
 
-      patch                    = full_reverse_diff_for(page, sha1, sha2)
-      committer                = Committer.new(self, commit)
-      parent                   = committer.parents[0]
+      patch     = full_reverse_diff_for(page, sha1, sha2)
+      committer = Committer.new(self, commit)
+      parent    = committer.parents[0]
       committer.options[:tree] = @repo.git.apply_patch(parent.sha, patch)
       return false unless committer.options[:tree]
-      committer.after_commit do |index, sha|
+      committer.after_commit do |index, _sha|
         @access.refresh
 
         files = []
@@ -523,11 +523,11 @@ module Gollum
         else
           # Grit::Diff can't parse reverse diffs.... yet
           patch.each_line do |line|
-            if line =~ %r{^diff --git b/.+? a/(.+)$}
-              path = $1
+            if line =~ %r(^diff --git b/.+? a/(.+)$)
+              path = Regexp.last_match[1]
               ext  = ::File.extname(path)
               name = ::File.basename(path, ext)
-              if format = ::Gollum::Page.format_for(ext)
+              if (format = ::Gollum::Page.format_for(ext))
                 files << [path, name, format]
               end
             end
@@ -643,7 +643,7 @@ module Gollum
     #
     # Returns an Array of Gollum::Git::Commit.
     def latest_changes(options={})
-      max_count = options.fetch(:max_count, 10)      
+      options[:max_count] = 10 unless options[:max_count]
       @repo.log(@ref, nil, options)
     end
     
@@ -660,7 +660,7 @@ module Gollum
     #
     # Returns a Sanitize instance.
     def sanitizer
-      if options = sanitization
+      if (options = sanitization)
         @sanitizer ||= options.to_sanitize
       end
     end
@@ -670,7 +670,7 @@ module Gollum
     #
     # Returns a Sanitize instance.
     def history_sanitizer
-      if options = history_sanitization
+      if (options = history_sanitization)
         @history_sanitizer ||= options.to_sanitize
       end
     end
@@ -816,7 +816,7 @@ module Gollum
     #
     # Returns a flat Array of Gollum::Page instances.
     def tree_list(ref)
-      if sha = @access.ref_to_sha(ref)
+      if (sha = @access.ref_to_sha(ref))
         commit = @access.commit(sha)
         tree_map_for(sha).inject([]) do |list, entry|
           next list unless @page_class.valid_page_name?(entry.name)
@@ -833,7 +833,7 @@ module Gollum
     #
     # Returns a flat Array of Gollum::File instances.
     def file_list(ref)
-      if sha = @access.ref_to_sha(ref)
+      if (sha = @access.ref_to_sha(ref))
         commit = @access.commit(sha)
         tree_map_for(sha).inject([]) do |list, entry|
           next list if entry.name.start_with?('_')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gollum-lib
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.1.0
 platform: ruby
 authors:
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-10 00:00:00.000000000 Z
+date: 2015-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gollum-grit_adapter
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.4
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.4
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -360,6 +360,7 @@ files:
 - lib/gollum-lib/filter/macro.rb
 - lib/gollum-lib/filter/metadata.rb
 - lib/gollum-lib/filter/plain_text.rb
+- lib/gollum-lib/filter/plantuml.rb
 - lib/gollum-lib/filter/remote_code.rb
 - lib/gollum-lib/filter/render.rb
 - lib/gollum-lib/filter/sanitize.rb
@@ -372,6 +373,8 @@ files:
 - lib/gollum-lib/hook.rb
 - lib/gollum-lib/macro.rb
 - lib/gollum-lib/macro/all_pages.rb
+- lib/gollum-lib/macro/global_toc.rb
+- lib/gollum-lib/macro/series.rb
 - lib/gollum-lib/markup.rb
 - lib/gollum-lib/markups.rb
 - lib/gollum-lib/page.rb