gollum-lib 5.2.4 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89665fc53e8dac8e1787645fde43c827410639049a789503b7e2859ce5fadb5f
-  data.tar.gz: cc9aac74db4af15d4943663ec1b3ab02dd451c77a728db20dcd87b4580736d39
+  metadata.gz: fe628f4e51c08652919a35f540f680f7c552c5ad8bab2bef986d2bf70dd828e7
+  data.tar.gz: 236d3fe12527b806ee2131de0339c99ea7df55f01399895d469034e1dae7d655
 SHA512:
-  metadata.gz: 4a19c6ecd939a79ec62de95e06508e97ef962abdcf945a73da5b5aeed97149cee79b6fce2532aa8ca21e701f9b4251746aa69b2456a5f5276e40b0541814bd22
-  data.tar.gz: '029d5f5f42f759e8827871cc80ccb4d3308f794dd3d7bffe5c0c7286d1acd3fc40f6c644c57ca975c49c63d7085bfb14a5bef0887599db5bafc78978434ea622'
+  metadata.gz: 63c2dbdccde9211a4123e8954689f390140e5054a34175771da8e34ecbf358a7cf7fad8984fa69619db5b9c00d91af1019f1350b8b82a78b594b6c00c9ecbccd
+  data.tar.gz: 91d14006c4a1a923156ba49177d10fb954f0f8e74761704e513fdd74bfe5726373a43078fd4e21604897356d01a6b79f117d76870d4a7b38e441719d025c391c

data/Gemfile

@@ -1,3 +1,9 @@
 source 'https://rubygems.org'
-
 gemspec :name => 'gollum-lib'
+gem 'irb'
+
+if RUBY_PLATFORM == 'java' then
+  group :development do
+    gem 'activesupport', '~> 6.0'
+  end
+end

data/HISTORY.md

@@ -1,8 +1,24 @@
-# 5.2.3 / 2023-03-13
+# 6.0 / 2023-08-01
 
-* Bugfix release: update adapter dependencies for Ruby 3.2 support.
+* Default to local PlantUML server for security. #412. (@manofstick)
+* Allow use of default branch name `main` or `master. Resolves https://github.com/gollum/gollum/issues/1813. (@dometto)
+* Feature: [support for custom rendering of languages in codeblocks](https://github.com/gollum/gollum/wiki/Custom-language-handlers). #433. (@dometto)
+* Support use of commit notes in Gollum::Committer. #435. (@dometto, @bartkamphorst)
+* Remove octicons from gollum-lib. Icon macros must now be styled independently. #441. (@bartkamphorst)
+* Huge performance increase for large wikis! :rocket: #437. (@dometto)
+
+## Bugfixes
+
+* Fix the use of boolean arguments in Macros. #441. (@dometto)
+* Fix broken relative links: these were previously not rendered as relative. #443. (@dometto)
 
+# 5.2.4 / 2023-03-22
 
+* Bugfix release: address XSS vulnerability ( @6661620a, @dometto)
+
+# 5.2.3 / 2023-03-13
+
+* Bugfix release: update adapter dependencies for Ruby 3.2 support.
 
 # 5.2.2 / 2023-01-18
 
@@ -48,7 +64,7 @@ For a detailed overview of changes in 5.0 and a guide to migrating your wiki, se
   ** Dependency updates
   ** Bugfixes
   ** New Macro for listing contents of (sub)directories: `Navigation()`
-  ** Table of Contents now supports setting max heading level 
+  ** Table of Contents now supports setting max heading level
 
 # v4.0.2 / 2015-01-19
 

data/LATEST_CHANGES.md

@@ -1,3 +1,15 @@
-# 5.2.4 / 2023-03-22
+# 6.1.0
 
-* Bugfix release: address XSS vulnerability ( @6661620a, @dometto)
+This is largely a bugfix release.
+
+New features:
+
+- Added support for GitLab style PlantUML blocks and additional diagram types. #461 (@dometto)
+
+Bugfixes:
+
+- Ensured "copy to clipboard" button appears normally when Pygments is enabled. #460 (@x789034)
+- Don't use real `anon.com` domain in anonymous git committer emails. #458 (@jmtd)
+- Removed dead code, `Gollum::FileView`. #455 (@benjaminwil)
+- HTML escape YAML after parsing to prevent invalidating YAML string #454 (@dometto)
+- Ensured `[[include:<path>]]` helper works with absolute paths. Note that this was meant to be included in the 6.0 release but was not. Sorry for any confusion. #452 (@dometto)

data/Rakefile

@@ -194,10 +194,10 @@ task :changelog do
       exit!
     end
   end
-  
+
   latest_changes = File.open(latest_changes_file)
   version_pattern = "# #{version}"
-  
+
   if !`grep "#{version_pattern}" #{history_file}`.empty?
     puts "#{version} is already described in #{history_file}"
     exit!
@@ -212,13 +212,13 @@ task :changelog do
     puts "#{latest_changes_file} is empty!"
     exit!
   end
-  
+
   body = latest_changes.read
   body.scan(/\s*#\s+\d\.\d.*/) do |match|
     puts "#{latest_changes_file} may not contain multiple markdown headers!"
     exit!
   end
-  
+
   temp = Tempfile.new
   temp.puts("#{version_pattern} / #{date}\n#{body}\n\n")
   temp.close

data/gemspec.rb

@@ -26,14 +26,13 @@ def specification(version, default_adapter, platform = nil)
     s.add_dependency 'loofah', '~> 2.3'
     s.add_dependency 'github-markup', '~> 4.0'
     s.add_dependency 'gemojione', '~> 4.1'
-    s.add_dependency 'octicons', '~> 12.0'
     s.add_dependency 'twitter-text', '1.14.7'
 
     s.add_development_dependency 'org-ruby', '~> 0.9.9'
     s.add_development_dependency 'kramdown', '~> 2.3'
     s.add_development_dependency 'kramdown-parser-gfm', '~> 1.1.0'
     s.add_development_dependency 'RedCloth', '~> 4.2.9'
-    s.add_development_dependency 'mocha', '~> 1.11'
+    s.add_development_dependency 'mocha', '~> 2.0'
     s.add_development_dependency 'shoulda', '~> 4.0'
     s.add_development_dependency 'wikicloth', '~> 0.8.3'
     s.add_development_dependency 'bibtex-ruby', '~> 6.0'
@@ -45,12 +44,12 @@ def specification(version, default_adapter, platform = nil)
     s.add_development_dependency 'rb-readline', '~> 0.5.1'
     # updating minitest-reporters requires a new minitest which fails with gollum's tests.
     s.add_development_dependency 'test-unit', '~> 3.3'
-    s.add_development_dependency 'minitest-reporters', '~> 1.4'
+    s.add_development_dependency 'minitest-reporters', '~> 1.5'
     s.add_development_dependency 'nokogiri-diff', '~> 0.2.0'
     s.add_development_dependency 'guard', '~> 2.16'
     s.add_development_dependency 'guard-minitest', '~> 2.4'
     s.add_development_dependency 'twitter_cldr', '~> 6.4'
-    
+
     # = MANIFEST =
   s.files = %w[
     Gemfile
@@ -68,7 +67,6 @@ def specification(version, default_adapter, platform = nil)
     lib/gollum-lib/blob_entry.rb
     lib/gollum-lib/committer.rb
     lib/gollum-lib/file.rb
-    lib/gollum-lib/file_view.rb
     lib/gollum-lib/filter.rb
     lib/gollum-lib/filter/bibtex.rb
     lib/gollum-lib/filter/code.rb
@@ -90,10 +88,11 @@ def specification(version, default_adapter, platform = nil)
     lib/gollum-lib/macro.rb
     lib/gollum-lib/macro/all_pages.rb
     lib/gollum-lib/macro/audio.rb
+    lib/gollum-lib/macro/flash.rb
     lib/gollum-lib/macro/global_toc.rb
+    lib/gollum-lib/macro/icon.rb
     lib/gollum-lib/macro/navigation.rb
     lib/gollum-lib/macro/note.rb
-    lib/gollum-lib/macro/octicon.rb
     lib/gollum-lib/macro/series.rb
     lib/gollum-lib/macro/video.rb
     lib/gollum-lib/macro/warn.rb

data/gollum-lib.gemspec

@@ -3,8 +3,8 @@ require File.join(File.dirname(__FILE__), 'lib', 'gollum-lib', 'version.rb')
 # This file needs to conditionally define the default adapter for MRI and Java, because this is the file that is included from the Gemfile.
 # In addition, the default Java adapter needs to be defined in gollum-lib_java.gemspec beause that file is used to *build* the Java gem.
 if RUBY_PLATFORM == 'java' then
-  default_adapter = ['gollum-rjgit_adapter', '~> 1.0']
+  default_adapter = ['gollum-rjgit_adapter', '~> 2.0']
 else
-  default_adapter = ['gollum-rugged_adapter', '~> 2.0']
+  default_adapter = ['gollum-rugged_adapter', '~> 3.0']
 end
 Gem::Specification.new &specification(Gollum::Lib::VERSION, default_adapter)

data/gollum-lib_java.gemspec

@@ -1,4 +1,4 @@
 require File.join(File.dirname(__FILE__), 'gemspec.rb')
 require File.join(File.dirname(__FILE__), 'lib', 'gollum-lib', 'version.rb')
-default_adapter = ['gollum-rjgit_adapter', '~> 0.6']
+default_adapter = ['gollum-rjgit_adapter', '~> 2.0']
 Gem::Specification.new &specification(Gollum::Lib::VERSION, default_adapter, "java") 

data/lib/gollum-lib/committer.rb

@@ -18,6 +18,7 @@ module Gollum
     #           :message   - The String commit message.
     #           :name      - The String author full name.
     #           :email     - The String email address.
+    #           :note      - Optional String containing info about the commit. Not used, but can be accessed from inside the :post_commit Hook.
     #           :parent    - Optional Gollum::Git::Commit parent to this update.
     #           :tree      - Optional String SHA of the tree to create the
     #                        index from.
@@ -128,6 +129,7 @@ module Gollum
       @callbacks.each do |cb|
         cb.call(self, sha1)
       end
+      @wiki.repo.commit(sha1).note=@options[:note] if @options[:note]
       Hook.execute(:post_commit, self, sha1)
       sha1
     end

data/lib/gollum-lib/file.rb

@@ -8,18 +8,21 @@ module Gollum
 
     class << self
 
-      # For use with self.find: returns true if the given query corresponds to the in-repo path of the BlobEntry.
-      #
-      # query     - The String path to match.
-      # entry     - The BlobEntry to check against.
-      # global_match - (Not implemented for File, see Page.path_match)
-      # hyphened_tags  - If true, replace spaces in match_path with hyphens.
-      # case_insensitive - If true, compare query and match_path case-insensitively
-      def path_match(query, entry, global_match = false, hyphened_tags = false, case_insensitive = false)
-        path_compare(query, ::File.join('/', entry.path), hyphened_tags, case_insensitive)
-      end
+    # Get a canonical path to a file.
+    # Ensures that the result is always under page_file_dir (prevents path traversal), if set.
+    # Removes leading slashes.
+    #
+    # path           - One or more String path elements to join together. `nil` values are ignored.
+    # page_file_dir  - kwarg String, default: nil
+    def canonical_path(*path, page_file_dir: nil)
+      prefix = Pathname.new('/') + page_file_dir.to_s
+      rest = Pathname.new('/').join(*path.compact).cleanpath.to_s[1..-1]
+      result = (prefix + rest).cleanpath.to_s[1..-1]
+      result.sub!(/^\/+/, '') if Gem.win_platform? # On Windows, Pathname#cleanpath will leave double slashes at the start of a path, so replace all (not just the first) leading slashes
+      result
+    end
       
-      # For use with self.path_match: returns true if 'query' and 'match_path' match, strictly or taking account of the following parameters:
+      # For use with self.find: returns true if 'query' and 'match_path' match, strictly or taking account of the following parameters:
       # hyphened_tags  - If true, replace spaces in match_path with hyphens.
       # case_insensitive - If true, compare query and match_path case-insensitively
       def path_compare(query, match_path, hyphened_tags, case_insensitive)
@@ -41,24 +44,31 @@ module Gollum
     # version - The String version ID to find.
     # try_on_disk - If true, try to return just a reference to a file
     #               that exists on the disk.
-    # global_match - If true, find a File matching path's filename, but not it's directory (so anywhere in the repo)
+    # global_match - If true, find a File matching path's filename, but not its directory (so anywhere in the repo)
     #
     # Returns a Gollum::File or nil if the file could not be found. Note
     # that if you specify try_on_disk=true, you may or may not get a file
     # for which on_disk? is actually true.
     def self.find(wiki, path, version, try_on_disk = false, global_match = false)
-      map = wiki.tree_map_for(version.to_s)
-
-      query_path = Pathname.new(::File.join(['/', wiki.page_file_dir, path].compact)).cleanpath.to_s
-      query_path.sub!(/^\/\//, '/') if Gem.win_platform? # On Windows, Pathname#cleanpath will leave double slashes at the start of a path intact, so sub them out.
+      query_path =  self.canonical_path(path, page_file_dir: wiki.page_file_dir)
+      dir, filename = Pathname.new(query_path).split
+      dir = dir.to_s
 
-      begin
-        entry = map.detect do |entry|
-          path_match(query_path, entry, global_match, wiki.hyphened_tag_lookup, wiki.case_insensitive_tag_lookup)
+      if global_match && self.respond_to?(:global_find) # Only implemented for Gollum::Page
+        return self.global_find(wiki, version, query_path, try_on_disk) 
+      else
+        begin
+          root = wiki.commit_for(version)
+          return nil unless root
+          tree = dir == '.' ? root.tree : root.tree / dir
+          return nil unless tree
+          entry = tree.find_blob do |blob_name|
+            path_compare(filename.to_s, blob_name, wiki.hyphened_tag_lookup, wiki.case_insensitive_tag_lookup)
+          end
+          entry ? self.new(wiki, entry, dir, version, try_on_disk) : nil
+        rescue Gollum::Git::NoSuchShaFound
+          nil
         end
-        entry ? self.new(wiki, entry.blob(wiki.repo), entry.dir, version, try_on_disk) : nil
-      rescue Gollum::Git::NoSuchShaFound
-        nil
       end
     end
 
@@ -74,7 +84,7 @@ module Gollum
     def initialize(wiki, blob, path, version, try_on_disk = false)
       @wiki         = wiki
       @blob         = blob
-      @path         = "#{path}/#{blob.name}"[1..-1]
+      @path         = self.class.canonical_path(path, blob.name)
       @version      = version.is_a?(Gollum::Git::Commit) ? version : @wiki.commit_for(version)
       get_disk_reference if try_on_disk
     end

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

@@ -92,7 +92,7 @@ class Gollum::Filter::Code < Gollum::Filter
         lexer = Pygments::Lexer[(lang)] || Pygments::Lexer['text']
 
         # must set startinline to true for php to be highlighted without <?
-        hl_code = lexer.highlight(code, :options => { :encoding => encoding.to_s, :startinline => true })
+        hl_code = lexer.highlight(code, :options => { :encoding => encoding.to_s, :wrapcode => true, :startinline => true })
       else # Rouge
         begin
           # if `lang` was not defined then assume plaintext

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

@@ -1,5 +1,5 @@
 # ~*~ encoding: utf-8 ~*~
-require 'octicons'
+
 
 # Replace specified tokens with dynamically generated content.
 class Gollum::Filter::Macro < Gollum::Filter
@@ -22,13 +22,18 @@ class Gollum::Filter::Macro < Gollum::Filter
       argstr.scan(/,?\s*(#{arg})\s*/) do |arguments|
       	# Stabstabstab
       	argument = arguments.first
-      	
-        if argument =~ /^([a-z0-9_]+)="(.*?)"/
-      		opts[Regexp.last_match[1]] = Regexp.last_match[2]
-			  elsif argument =~ /^"(.*)"$/
-				  args << Regexp.last_match[1].gsub("\\\"", "\"")
-			  else
-				  args << argument
+
+        case argument
+        in /^([a-z0-9_]+)="(.*?)"/
+          opts[Regexp.last_match[1]] = Regexp.last_match[2]
+        in /^"(.*)"$/
+          args << Regexp.last_match[1].gsub("\\\"", "\"")
+        in /\s*false\s*/
+          args << false
+        in /\s*true\s*/
+          args << true
+        else
+          args << argument
         end
       end
 		  
@@ -48,13 +53,11 @@ class Gollum::Filter::Macro < Gollum::Filter
         begin
           Gollum::Macro.instance(macro, @markup.wiki, @markup.page).render(*args)
         rescue StandardError => e
-          icon = Octicons::Octicon.new('zap', {width: 24, height: 24})
-          icon.options[:class] << ' mr-2'
-          "<div class='flash flash-error'>#{icon.to_svg}Macro Error for #{macro}: #{e.message}</div>"
+          %Q(<div class="flash flash-error gollum-macro-error my-2">Macro Error for #{macro}: #{e.message}</div>)
         end
       end
     end
 
-    sanitize(data)
+    data
   end
 end

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

@@ -36,8 +36,9 @@ require 'zlib'
 # at: http://plantuml.sourceforge.net/
 #
 class Gollum::Filter::PlantUML < Gollum::Filter
-
-  DEFAULT_URL = "http://www.plantuml.com/plantuml/png"
+  UML_KINDS = ['uml', 'json', 'yaml', 'ebnf', 'regex', 'salt', 'ditaa', 'gantt', 'chronology', 'mindmap', 'wbs', 'math', 'latex', 'chen']
+  UML_REGEX = /\s*(@start(#{Regexp.union(UML_KINDS)})([ \t\f\v]+[^\r\n]+|[ \t\r\f\v]*)\n.+?\r?\n@end\2\r?$)/m
+  DEFAULT_URL = 'http://localhost:8080/plantuml/png'
 
   # Configuration class used to change the behaviour of the PlatnUML filter.
   #
@@ -69,7 +70,7 @@ class Gollum::Filter::PlantUML < Gollum::Filter
   # Extract all sequence diagram blocks into the map and replace with
   # placeholders.
   def extract(data)
-    data.gsub(/(@start(uml|json|yaml|salt|mindmap|wbs|math|latex)\r?\n.+?\r?\n@end\2\r?$)/m) do
+    data.gsub(UML_REGEX) do
       id       = "#{open_pattern}#{Digest::SHA1.hexdigest($1)}#{close_pattern}"
       @map[id] = { :code => $1 }
       id
@@ -81,12 +82,21 @@ class Gollum::Filter::PlantUML < Gollum::Filter
   def process(data)
     @map.each do |id, spec|
       data.gsub!(id) do
-        render_plantuml(id, spec[:code])
+        render_plantuml(spec[:code])
       end
     end
     data
   end
 
+  def render_plantuml(code)
+    if check_server
+      plantuml_url = gen_url(code)
+      "<img src=\"#{gen_url(code)}\" />"
+    else
+      html_error("Sorry, unable to render PlantUML diagram at this time")
+    end
+  end
+
   private
 
   def server_url
@@ -101,15 +111,6 @@ class Gollum::Filter::PlantUML < Gollum::Filter
     PlantUML::configuration.verify_ssl
   end
 
-  def render_plantuml(id, code)
-    if check_server
-      plantuml_url = gen_url(code)
-      "<img src=\"#{gen_url(code)}\" />"
-    else
-      html_error("Sorry, unable to render PlantUML diagram at this time")
-    end
-  end
-
   # Compression code used to generate PlantUML URLs. Taken directly from the
   # Transcoder class in the PlantUML java code.
   def gen_url(text)
@@ -153,9 +154,9 @@ class Gollum::Filter::PlantUML < Gollum::Filter
     c3 = ((b2 & 0xF) << 2) | (b3 >> 6)
     c4 = b3 & 0x3F
     return encode6bit(c1 & 0x3F).chr +
-           encode6bit(c2 & 0x3F).chr +
-           encode6bit(c3 & 0x3F).chr +
-           encode6bit(c4 & 0x3F).chr
+            encode6bit(c2 & 0x3F).chr +
+            encode6bit(c3 & 0x3F).chr +
+            encode6bit(c4 & 0x3F).chr
   end
 
   # Make a call to the PlantUML server with the simplest diagram possible to
@@ -173,3 +174,7 @@ class Gollum::Filter::PlantUML < Gollum::Filter
     return false
   end
 end
+
+Gollum::Filter::Code.language_handlers[/plantuml/] = Proc.new {
+  |lang, code| Gollum::Filter::PlantUML.new(code).render_plantuml("@startuml\n#{code}\n@enduml\n")
+}

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

@@ -6,7 +6,11 @@ class Gollum::Filter::Render < Gollum::Filter
       working_dir = Pathname.new(@markup.wiki.path).join(@markup.dir)
       working_dir = working_dir.exist? ? working_dir.to_s : '.'
       Dir.chdir(working_dir) do
-        data = GitHub::Markup.render_s(@markup.format, data)
+        if block = @markup.custom_renderer
+          data = block.call(data)
+        else
+          data = GitHub::Markup.render_s(@markup.format, data)
+        end
       end
       if data.nil?
         raise "There was an error converting #{@markup.name} to HTML."

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

@@ -120,8 +120,9 @@ class Gollum::Filter::Tags < Gollum::Filter
   def process_include_tag(tag)
     len = INCLUDE_TAG.length
     return html_error('Cannot process include directive: no page name given') if tag.length <= len
-    page_name          = tag[len..-1]
-    resolved_page_name = ::File.join(@markup.dir, page_name)
+    page_path = Pathname.new(tag[len..-1])
+    resolved_page = page_path.relative? ? (Pathname.new(@markup.dir) + page_path) : page_path
+    resolved_page_name = resolved_page.cleanpath.to_s
     if @markup.include_levels > 0
       page = find_page_or_file_from_path(resolved_page_name)
       if page
@@ -231,7 +232,13 @@ class Gollum::Filter::Tags < Gollum::Filter
       name = page ? path_to_link_text(link) : link
     end
 
-    link = page ? page.escaped_url_path : ERB::Util.url_encode(link).force_encoding('utf-8')
+    if page
+      link = page.escaped_url_path
+    else
+      link = Pathname.new(link).relative? ? "#{@markup.dir.to_s}/#{link}" : link
+      link = ERB::Util.url_encode(link).force_encoding('utf-8')
+    end
+
     generate_link(link, name, extra, presence)
   end
 

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

@@ -10,7 +10,7 @@ class Gollum::Filter::YAML < Gollum::Filter
     data.gsub!(YAML_FRONT_MATTER_REGEXP) do
       @markup.metadata ||= {}
       begin
-        frontmatter = ::YAML.safe_load(sanitize(Regexp.last_match[1]))
+        frontmatter = sanitize_frontmatter(::YAML.safe_load(Regexp.last_match[1]))
         @markup.metadata.merge!(frontmatter) if frontmatter.respond_to?(:keys) && frontmatter.respond_to?(:values)
       rescue ::Psych::SyntaxError, ::Psych::DisallowedClass, ::Psych::BadAlias => error
         @markup.metadata['errors'] ||= []
@@ -24,4 +24,23 @@ class Gollum::Filter::YAML < Gollum::Filter
   def process(data)
     data
   end
+
+  private
+
+  def sanitize_frontmatter(obj)
+    case obj
+    when Hash
+      obj.map do |k, v|
+        [sanitize(k.to_s), sanitize_frontmatter(v)]
+      end.to_h
+    when Array
+      obj.map! do |v|
+        sanitize_frontmatter(v)
+      end
+    when String
+      sanitize(obj)
+    else
+      obj
+    end
+  end
 end

data/lib/gollum-lib/git_access.rb

@@ -161,15 +161,11 @@ module Gollum
       items = []
       tree.each do |entry|
         if entry[:type] == 'blob'
-          items << BlobEntry.new(entry[:sha], entry[:path], entry[:size], entry[:mode].to_i(8))
+          next if @page_file_dir && !entry[:path].start_with?("#{@page_file_dir}/")
+          items << BlobEntry.new(entry[:sha], entry[:path], entry[:size], entry[:mode])
         end
       end
-      if (dir = @page_file_dir)
-        regex = /^#{dir}\//
-        items.select { |i| i.path =~ regex }
-      else
-        items
-      end
+      items
     end
 
     # Reads the content from the Git db at the given SHA.

data/lib/gollum-lib/helpers.rb

@@ -3,12 +3,12 @@
 module Gollum
   module Helpers
     
-    # If url starts with a leading slash, trim down its number of leading slashes to 1. Else, return url unchanged.
+    # Replace url-encoded slashes ('%2F') with slashes
+    # Clean up double slashes
     def trim_leading_slashes(url)
       return nil if url.nil?
       url.gsub!('%2F', '/')
-      return '/' + url.gsub(/^\/+/, '') if url[0, 1] == '/'
-      url
+      Pathname.new(url).cleanpath.to_s
     end
     
     # Take a link path and turn it into a string for display as link text.

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

@@ -0,0 +1,11 @@
+module Gollum
+  class Macro
+    class Flash < Gollum::Macro
+      def render(message, icon='', type='')
+        flash_type = ['warn', 'error', 'success'].include?(type) ? "flash-#{type}" : '' 
+        flash_icon = icon.empty? ? '' : %Q(data-gollum-icon="#{icon}")
+        %Q(<div class="flash #{flash_type} my-2" #{flash_icon}>#{message}</div>)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Gollum
+  class Macro
+    class Icon < Gollum::Macro
+      def render(icon)
+        %Q(<div class="gollum-icon" data-gollum-icon="#{icon}"></div>)
+      end
+    end
+  end
+end

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

@@ -1,18 +1,8 @@
 module Gollum
   class Macro
     class Note < Gollum::Macro
-      def render(notice, octicon = 'info')
-        icon = ""
-        unless octicon.empty?
-          begin
-            icon = Octicons::Octicon.new(octicon, {width: 24, height: 24})
-          rescue RuntimeError
-            icon = Octicons::Octicon.new('info', {width: 24, height: 24})
-          end
-          icon.options[:class] << ' mr-2'
-          icon = icon.to_svg
-        end
-        "<div class='flash'>#{icon}#{notice}</div>"
+      def render(notice)
+        %Q(<div class="flash gollum-note my-2">#{notice}</div>)
       end
     end
   end

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

@@ -2,9 +2,7 @@ module Gollum
   class Macro
     class Warn < Gollum::Macro
       def render(warning)
-        icon = Octicons::Octicon.new('alert', {width: 24, height: 24})
-        icon.options[:class] << ' mr-2'
-        "<div class='flash flash-warn'>#{icon.to_svg}#{warning}</div>"
+        %Q(<div class="flash flash-warn gollum-warning my-2">#{warning}</div>)
       end
     end
   end

data/lib/gollum-lib/macro.rb

@@ -38,7 +38,7 @@ module Gollum
       end
 
       def render(*_args)
-        "!!!Unknown macro: #{@macro_name}!!!"
+        html_error("Unknown macro: #{@macro_name}")
       end
     end
   end

data/lib/gollum-lib/markup.rb

@@ -61,7 +61,9 @@ module Gollum
           :extensions => new_extension,
           :reverse_links => options.fetch(:reverse_links, false),
           :skip_filters => options.fetch(:skip_filters, nil),
-          :enabled => options.fetch(:enabled, true) }
+          :enabled => options.fetch(:enabled, true),
+          :render => options.fetch(:render, nil)
+        }
         @extensions.concat(new_extension)
       end
     end
@@ -102,6 +104,10 @@ module Gollum
       self.class.formats[@format][:reverse_links]
     end
 
+    def custom_renderer
+      self.class.formats[@format].fetch(:render, nil)
+    end
+
     # Whether or not a particular filter should be skipped for this format.
     def skip_filter?(filter)
       if self.class.formats[@format][:skip_filters].respond_to?(:include?)
@@ -119,7 +125,7 @@ module Gollum
     # filter_chain - the chain to process
     #
     # Returns the formatted data
-    def process_chain(data, filter_chain)
+    def process_chain(data, filter_chain, &block)
       # First we extract the data through the chain...
       filter_chain.each do |filter|
         data = filter.extract(data)

data/lib/gollum-lib/page.rb

@@ -6,22 +6,39 @@ module Gollum
     SUBPAGENAMES = [:header, :footer, :sidebar]
 
     class << self
-      # For use with self.find: returns true if the given query corresponds to the in-repo path of the BlobEntry. 
+      # For use with self.global_find: returns true if the given query corresponds to the in-repo path of the BlobEntry. 
       #
       # query     - The String path to match.
       # entry     - The BlobEntry to check against.
-      # global_match - If true, find a File matching path's filename, but not its directory (so anywhere in the repo)
-      def path_match(query, entry, global_match = false, hyphened_tags = false, case_insensitive = false)
+      def global_path_match(query, entry, hyphened_tags = false, case_insensitive = false)
         return false if "#{entry.name}".empty?
         return false unless valid_extension?(entry.name)
-        entry_name = valid_extension?(query) ? entry.name : strip_filename(entry.name)     
-        match_path = ::File.join([
-          '/',
-          global_match ? nil : entry.dir,
-        entry_name
-        ].compact)
+        match_path = Pathname.new('/').join(*[
+          entry.dir,
+          entry.name
+          ].compact
+        ).to_s
         path_compare(query, match_path, hyphened_tags, case_insensitive)
       end
+
+      def global_find(wiki, version, query, try_on_disk)
+        map = wiki.tree_map_for(version.to_s)
+        begin
+          entry = map.detect do |entry|
+            global_path_match(query, entry, wiki.hyphened_tag_lookup, wiki.case_insensitive_tag_lookup)
+          end
+          entry ? self.new(wiki, entry.blob(wiki.repo), entry.dir, version, try_on_disk) : nil
+        rescue Gollum::Git::NoSuchShaFound
+          nil
+        end
+      end
+
+      def path_compare(query, match_path, hyphened_tags, case_insensitive)
+        return false unless valid_extension?(match_path)
+        cmp = valid_extension?(query) ? match_path : strip_filename(match_path)
+        super(query, cmp, hyphened_tags, case_insensitive)
+      end
+
     end
 
     # Checks if a filename has a valid, registered extension

data/lib/gollum-lib/version.rb

@@ -1,5 +1,5 @@
 module Gollum
   module Lib
-    VERSION = '5.2.4'
+    VERSION = '6.1.0'
   end
 end

data/lib/gollum-lib/wiki.rb

@@ -7,7 +7,7 @@ module Gollum
 
     class << self
       # Sets the default ref for the wiki.
-      attr_writer :default_ref
+      attr_writer :default_refs
 
       # Sets the default name for commits.
       attr_writer :default_committer_name
@@ -19,8 +19,12 @@ module Gollum
       # These defaults can be overridden by options passed directly to initialize()
       attr_writer :default_options
 
-      def default_ref
-        @default_ref || 'master'
+      def find_default_ref(repo)
+        repo.find_branch(self.default_refs) || Gollum::Git.global_default_branch || self.default_refs.first
+      end
+
+      def default_refs
+        @default_refs || ['master', 'main']
       end
 
       def default_committer_name
@@ -28,7 +32,7 @@ module Gollum
       end
 
       def default_committer_email
-        @default_committer_email || 'anon@anon.com'
+        @default_committer_email || 'anon@anonymous.invalid'
       end
 
       def default_options
@@ -132,7 +136,7 @@ module Gollum
       @access               = options.fetch :access, GitAccess.new(path, @page_file_dir, @repo_is_bare)
       @base_path            = options.fetch :base_path, "/"
       @repo                 = @access.repo
-      @ref                  = options.fetch :ref, self.class.default_ref
+      @ref                  = options.fetch :ref, self.class.find_default_ref(@repo)
       @universal_toc        = options.fetch :universal_toc, false
       @mathjax              = options.fetch :mathjax, false
       @global_tag_lookup    = options.fetch :global_tag_lookup, false

data/lib/gollum-lib.rb

@@ -28,7 +28,6 @@ require File.expand_path('../gollum-lib/redirects', __FILE__)
 require File.expand_path('../gollum-lib/file', __FILE__)
 require File.expand_path('../gollum-lib/page', __FILE__)
 require File.expand_path('../gollum-lib/macro', __FILE__)
-require File.expand_path('../gollum-lib/file_view', __FILE__)
 require File.expand_path('../gollum-lib/markup', __FILE__)
 require File.expand_path('../gollum-lib/markups', __FILE__)
 require File.expand_path('../gollum-lib/sanitization', __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gollum-lib
 version: !ruby/object:Gem::Version
-  version: 5.2.4
+  version: 6.1.0
 platform: ruby
 authors:
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2025-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gollum-rugged_adapter
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
@@ -95,20 +95,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: octicons
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: twitter-text
   requirement: !ruby/object:Gem::Requirement
@@ -185,14 +171,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
@@ -325,14 +311,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: nokogiri-diff
   requirement: !ruby/object:Gem::Requirement
@@ -412,7 +398,6 @@ files:
 - lib/gollum-lib/blob_entry.rb
 - lib/gollum-lib/committer.rb
 - lib/gollum-lib/file.rb
-- lib/gollum-lib/file_view.rb
 - lib/gollum-lib/filter.rb
 - lib/gollum-lib/filter/bibtex.rb
 - lib/gollum-lib/filter/code.rb
@@ -434,10 +419,11 @@ files:
 - lib/gollum-lib/macro.rb
 - lib/gollum-lib/macro/all_pages.rb
 - lib/gollum-lib/macro/audio.rb
+- lib/gollum-lib/macro/flash.rb
 - lib/gollum-lib/macro/global_toc.rb
+- lib/gollum-lib/macro/icon.rb
 - lib/gollum-lib/macro/navigation.rb
 - lib/gollum-lib/macro/note.rb
-- lib/gollum-lib/macro/octicon.rb
 - lib/gollum-lib/macro/series.rb
 - lib/gollum-lib/macro/video.rb
 - lib/gollum-lib/macro/warn.rb
@@ -470,7 +456,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A simple, Git-powered wiki.

data/lib/gollum-lib/file_view.rb

@@ -1,164 +0,0 @@
-# ~*~ encoding: utf-8 ~*~
-module Gollum
-  # FileView requires that:
-  #  - All files in root dir are processed first
-  #  - Then all the folders are sorted and processed
-
-  class FileView
-    # common use cases:
-    # set pages to wiki.pages and show_all to false
-    # set pages to wiki.pages + wiki.files and show_all to true
-    def initialize(pages, options = {})
-      @pages    = pages
-      @wiki     = @pages.first ? @pages.first.wiki : nil
-      @show_all = options[:show_all] || false
-      @checked  = options[:collapse_tree] ? '' : "checked"
-    end
-
-    def enclose_tree(string)
-      sanitize_html(%Q(<ol class="tree">\n) + string + %Q(</ol>))
-    end
-
-    def new_page(page)
-      name = page.name
-      url, valid_page  = url_for_page page
-      %Q(  <li class="file"><a href="#{url}"><span class="icon"></span>#{name}</a>#{valid_page ? "" : delete_file(url, valid_page)}</li>)
-    end
-
-    def delete_file(url, valid_page)
-      %Q(<form method="POST" action="/deleteFile/#{url}" onsubmit="return confirm('Do you really want to delete the file #{url}?');"><button type="submit" name="delete" value="true"></button></form>)
-    end
-
-    def new_folder(folder_path)
-      new_sub_folder folder_path
-    end
-
-    def new_sub_folder(path)
-      <<-HTML
-      <li>
-        <label>#{path}</label> <input type="checkbox" #{@checked} />
-        <ol>
-      HTML
-    end
-
-    def end_folder
-      "</ol></li>\n"
-    end
-
-    def url_for_page(page)
-      url = ''
-      valid_page_name = false
-      if @show_all
-        # Remove ext for valid pages.
-        filename = page.filename
-        valid_page_name =  Page::valid_page_name?(filename)
-        filename = valid_page_name ? filename.chomp(::File.extname(filename)) : filename
-
-        url = ::File.join(::File.dirname(page.path), filename)
-      else
-        url = ::File.join(::File.dirname(page.path), page.filename_stripped)
-      end
-      url = url[2..-1] if url[0, 2] == './'
-      return url, valid_page_name
-    end
-
-    def render_files
-      html         = ''
-      count        = @pages.size
-      folder_start = -1
-
-      # Process all pages until folders start
-      count.times do |index|
-        page = @pages[index]
-        path = page.path
-
-        unless path.include? '/'
-          # Page processed (not contained in a folder)
-          html += new_page page
-        else
-          # Folders start at the next index
-          folder_start = index
-          break # Pages finished, move on to folders
-        end
-      end
-
-      # If there are no folders, then we're done.
-      return enclose_tree(html) if folder_start <= -1
-
-      # Handle special case of only one folder.
-      if (count - folder_start == 1)
-        page = @pages[folder_start]
-        html += <<-HTML
-        <li>
-          <label>#{::File.dirname(page.path)}</label> <input type="checkbox" #{@checked} />
-          <ol>
-          #{new_page page}
-         </ol>
-        </li>
-        HTML
-
-        return enclose_tree(html)
-      end
-
-      sorted_folders = []
-      (folder_start).upto count - 1 do |index|
-        sorted_folders += [[@pages[index].path, index]]
-      end
-
-      # http://stackoverflow.com/questions/3482814/sorting-list-of-string-paths-in-vb-net
-      sorted_folders.sort! do |first, second|
-        a           = first[0]
-        b           = second[0]
-
-        # use :: operator because gollum defines its own conflicting File class
-        dir_compare = ::File.dirname(a) <=> ::File.dirname(b)
-
-        # Sort based on directory name unless they're equal (0) in
-        # which case sort based on file name.
-        if dir_compare == 0
-          ::File.basename(a) <=> ::File.basename(b)
-        else
-          dir_compare
-        end
-      end
-
-      # keep track of folder depth, 0 = at root.
-      cwd_array = []
-      changed   = false
-
-      # process rest of folders
-      (0...sorted_folders.size).each do |i|
-        page   = @pages[sorted_folders[i][1]]
-        path   = page.path
-        folder = ::File.dirname path
-
-        tmp_array = folder.split '/'
-
-        (0...tmp_array.size).each do |index|
-          if cwd_array[index].nil? || changed
-            html += new_sub_folder tmp_array[index]
-            next
-          end
-
-          if cwd_array[index] != tmp_array[index]
-            changed = true
-            (cwd_array.size - index).times do
-              html += end_folder
-            end
-            html += new_sub_folder tmp_array[index]
-          end
-        end
-
-        html += new_page page
-        cwd_array = tmp_array
-        changed = false
-      end
-
-      enclose_tree(html)
-    end # end render_files
-
-    def sanitize_html(data)
-      @wiki ? @wiki.sanitizer.clean(data) : data
-    end
-  end # end FileView class
-end # end Gollum module

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

@@ -1,12 +0,0 @@
-module Gollum
-  class Macro
-    class Octicon < Gollum::Macro
-      def render(symbol, height = nil, width = nil)
-        parameters = {}
-        parameters[:height] = height if height
-        parameters[:width]  = width if width
-        "<div>#{Octicons::Octicon.new(symbol, parameters).to_svg}</div>"
-      end
-    end
-  end
-end