gollum-lib 6.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fc3748e914bc6c30b3cce54c3def2c766cc8355be4d86772981c4163702008a
-  data.tar.gz: 7d54d5a438fc8dfa85ce9a34ebc73e46506bef54889ec7d619da20fc84b4ba4b
+  metadata.gz: fe628f4e51c08652919a35f540f680f7c552c5ad8bab2bef986d2bf70dd828e7
+  data.tar.gz: 236d3fe12527b806ee2131de0339c99ea7df55f01399895d469034e1dae7d655
 SHA512:
-  metadata.gz: 895a2ec2ae2b8c7f060ac00ae2ecc7c86d1d03833c82719651f433a635c5e8a306dc7d911fa476ffdd3a2a3a16b2d51bc059504a7b5581c60868775f0b8383e7
-  data.tar.gz: e67199ea268d88960c34cde440080c5e339fd75bc98863b62d8f3c25d392f7eb186df0d922c59de958abe4587e26cb554ae3f688584dad4fc42c25aab234c79f
+  metadata.gz: 63c2dbdccde9211a4123e8954689f390140e5054a34175771da8e34ecbf358a7cf7fad8984fa69619db5b9c00d91af1019f1350b8b82a78b594b6c00c9ecbccd
+  data.tar.gz: 91d14006c4a1a923156ba49177d10fb954f0f8e74761704e513fdd74bfe5726373a43078fd4e21604897356d01a6b79f117d76870d4a7b38e441719d025c391c

data/HISTORY.md

@@ -1,3 +1,17 @@
+# 6.0 / 2023-08-01
+
+* 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)
@@ -50,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,13 +1,15 @@
-# 6.0
+# 6.1.0
 
-* 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)
+This is largely a bugfix release.
 
-### Bugfixes
+New features:
 
-* Fix the use of boolean arguments in Macros. #441. (@dometto)
-* Fix broken relative links: these were previously not rendered as relative. #443. (@dometto)
+- 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

@@ -49,7 +49,7 @@ def specification(version, default_adapter, platform = nil)
     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
@@ -67,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

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/plantuml.rb

@@ -36,8 +36,9 @@ require 'zlib'
 # at: http://plantuml.sourceforge.net/
 #
 class Gollum::Filter::PlantUML < Gollum::Filter
-
-  DEFAULT_URL = "http://localhost:8080/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/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

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/version.rb

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

data/lib/gollum-lib/wiki.rb

@@ -32,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

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: '6.0'
+  version: 6.1.0
 platform: ruby
 authors:
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-01 00:00:00.000000000 Z
+date: 2025-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gollum-rugged_adapter
@@ -398,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
@@ -457,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