gollum-lib 5.1.2 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccf06509c7be7d9ce30fec5185caf8160752806c978c4a9442a8a1761d6d9a86
-  data.tar.gz: e6caac594ae4a468637d2b7655cff942241315abbac3adfac1fc3992abb329d2
+  metadata.gz: 6398b9ab2c4d261d508568987b550e098b7414d5ece46e43d29c7ff5216b8416
+  data.tar.gz: a401118da3e76e09a28d436059d1ee9ed81fe145c74af6130c4a41c9fbad26d8
 SHA512:
-  metadata.gz: eb43a84550c6be9cd60716ea97cf3f67f5c18b3e0f4ca59bda95dc639bef80285fc9d6eb5c376aedcdf7592a4c4c5a12df6a1345e9c4f2290960fefb9fffa3d0
-  data.tar.gz: 2dc8f219900b705c78dffa7226fd713d15fd4a8778c2eaa4145ea3a087e21365b878b3b933e4845b038aeafd52f3ba5b79b445907d68b7be1fdf746d3ff95f7d
+  metadata.gz: 2bf473deb11ddc079aa07dcb3a33d986315a9d7661fe80cf91637e597a352dc874918928f583c5281ec8ee974bef3fb220ca9f6ff1817d7333b521811b34df96
+  data.tar.gz: 1e6792a5b81d68cf434994e631fe97d5926f606d72fcab789103b5d87e6a931bb1ac9948ef305c6549fe6cd5fddd76f2f1a87c3fc8807dfaec684f27b964a408

data/Guardfile

@@ -0,0 +1,7 @@
+# ~*~ encoding: utf-8 ~*~
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)\/?test_(.*)\.rb|)
+  watch(%r|^lib/(.*/)?([^/]+)\.rb|)     { |m| "test/test_#{m[2]}.rb" }
+  watch(%r|^test/helper\.rb|)    { "test" }
+end

data/HISTORY.md

@@ -1,3 +1,10 @@
+# 5.2 / 2022-05-28
+
+* Conditionally render "editable" heading classes. Resolves https://github.com/gollum/gollum/issues/1785 (@benjaminwil)
+* Improvement: Allow escaping quotations in quoted macro arguments. #406. (@srbaker)
+* Improvement: [Allow for extended PlantUML types](https://github.com/gollum/gollum/wiki#plantuml-diagrams). #413. (@manofstick)
+* API Addition: allow defining handlers for specific languages in codeblocks. #410. (@dometto)
+
 # v5.1.2
 
 * SECURITY UPDATE: sanitize HTML generated by Macros.
@@ -27,11 +34,11 @@ For a detailed overview of changes in 5.0 and a guide to migrating your wiki, se
   ** New Macro for listing contents of (sub)directories: `Navigation()`
   ** Table of Contents now supports setting max heading level 
 
-# v4.0.2 /2015-0119
+# v4.0.2 / 2015-01-19
 
 * Bugfixes
 
-# v4.0.1 /2014-12-04
+# v4.0.1 / 2014-12-04
 
 * Security fix for [remote code execution issue](https://github.com/gollum/gollum/issues/913). Please update!
 

data/README.md

@@ -2,7 +2,7 @@ gollum lib -- A wiki built on top of Git
 ========================================
 
 [![Gem Version](https://badge.fury.io/rb/gollum-lib.svg)](http://badge.fury.io/rb/gollum-lib)
-[![Build Status](https://travis-ci.org/gollum/gollum-lib.svg?branch=master)](https://travis-ci.org/gollum/gollum-lib)
+[![Ruby Build](https://github.com/gollum/gollum-lib/actions/workflows/test.yaml/badge.svg)](https://github.com/gollum/gollum-lib/actions/workflows/test.yaml)
 [![Cutting Edge Dependency Status](https://dometto-cuttingedge.herokuapp.com/github/gollum/gollum-lib/svg 'Cutting Edge Dependency Status')](https://dometto-cuttingedge.herokuapp.com/github/gollum/gollum-lib/info)
 
 ## DESCRIPTION

data/Rakefile

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'rake'
 require 'date'
+require 'tempfile'
 
 #############################################################################
 #
@@ -12,11 +13,23 @@ def name
   "gollum-lib"
 end
 
+def date
+  Time.now.strftime("%Y-%m-%d")
+end
+
 def version
   line = File.read("lib/gollum-lib/version.rb")[/^\s*VERSION\s*=\s*.*/]
   line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
 end
 
+def latest_changes_file
+  'LATEST_CHANGES.md'
+end
+
+def history_file
+  'HISTORY.md'
+end
+
 # assumes x.y.z all digit version
 def next_version
   # x.y.z
@@ -38,24 +51,16 @@ def bump_version
   new_version
 end
 
-def date
-  Date.today.to_s
-end
-
-def rubyforge_project
-  name
-end
-
 def gemspec_file
   "gemspec.rb"
 end
 
 def gemspecs
-   ["#{name}.gemspec", "#{name}_java.gemspec"]
+  ["#{name}.gemspec", "#{name}_java.gemspec"]
 end
 
 def gem_files
- ["#{name}-#{version}.gem", "#{name}-#{version}-java.gem"]
+  ["#{name}-#{version}.gem", "#{name}-#{version}-java.gem"]
 end
 
 def replace_header(head, header_name)
@@ -106,23 +111,19 @@ task :bump do
   Rake::Task[:validate].execute
 end
 
-desc "Build and install"
-task :install => :build do
-  sh "gem install --local --no-document pkg/#{name}-#{version}.gem"
-end
-
 #############################################################################
 #
 # Packaging tasks
 #
 #############################################################################
 
-desc 'Create a release build'
+desc 'Create a release build and push to rubygems'
 task :release => :build do
   unless `git branch` =~ /master/
     puts "You must be on the master branch to release!"
     exit!
   end
+  Rake::Task[:changelog].execute
   sh "git commit --allow-empty -a -m 'Release #{version}'"
   sh "git pull --rebase origin master"
   sh "git tag v#{version}"
@@ -150,25 +151,23 @@ desc 'Update gemspec'
 task :gemspec => :validate do
   # read spec file and split out manifest section
   spec = File.read(gemspec_file)
-  head, _manifest, tail = spec.split("  # = MANIFEST =\n")
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
 
-  # replace name version and date
+  # replace name and version
   replace_header(head, :name)
-  replace_header(head, :date)
-  #comment this out if your rubyforge_project has a different name
-  replace_header(head, :rubyforge_project)
+  replace_header(head, :version)
 
   # determine file list from git ls-files
   files = `git ls-files`.
     split("\n").
     sort.
     reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg|test|Home\.md|\.gitattributes|Guardfile)/ }.
+    reject { |file| file =~ /^(rdoc|pkg|test|Home\.md|\.gitattributes)/ }.
     map { |file| "    #{file}" }.
     join("\n")
 
   # piece file back together and write
-  manifest = "  s.files = %w(\n#{files}\n  )\n"
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
   spec = [head, manifest, tail].join("  # = MANIFEST =\n")
   File.open(gemspec_file, 'w') { |io| io.write(spec) }
   puts "Updated #{gemspec_file}"
@@ -186,3 +185,43 @@ task :validate do
     exit!
   end
 end
+
+desc 'Build changlog'
+task :changelog do
+  [latest_changes_file, history_file].each do |f|
+    unless File.exists?(f)
+      puts "#{f} does not exist but is required to build a new release."
+      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!
+  end
+
+  begin
+    unless latest_changes.readline.chomp! =~ %r{#{version_pattern}}
+      puts "#{latest_changes_file} should begin with '#{version_pattern}'"
+      exit!
+    end
+  rescue EOFError
+    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
+  `cat #{history_file} >> #{temp.path}`
+  `cat #{temp.path} > #{history_file}`
+end

data/gemspec.rb

@@ -1,16 +1,11 @@
 def specification(version, default_adapter, platform = nil)
   Proc.new do |s|
-    s.specification_version = 2 if s.respond_to? :specification_version=
     s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
-    s.rubygems_version = '0.0.1'
     s.required_ruby_version = '>= 2.4'
 
     s.name              = 'gollum-lib'
     s.version           = version
     s.platform          = platform if platform
-    s.date              = '2021-07-10'
-    s.date              = '2017-04-13'
-    s.rubyforge_project = 'gollum-lib'
     s.license           = 'MIT'
 
     s.summary     = 'A simple, Git-powered wiki.'
@@ -35,14 +30,14 @@ def specification(version, default_adapter, platform = nil)
     s.add_dependency 'twitter-text', '1.14.7'
 
     s.add_development_dependency 'org-ruby', '~> 0.9.9'
-    s.add_development_dependency 'kramdown', '~> 2.3.0'
+    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 'shoulda', '~> 4.0'
     s.add_development_dependency 'wikicloth', '~> 0.8.3'
     s.add_development_dependency 'bibtex-ruby', '~> 6.0'
-    s.add_development_dependency 'citeproc-ruby', '~> 1.1'
+    s.add_development_dependency 'citeproc-ruby', '~> 2.0'
     s.add_development_dependency 'unicode_utils', '~> 1.4.0' # required by citeproc-ruby on ruby < 2.4
     s.add_development_dependency 'rake', '~> 13.0'
     s.add_development_dependency 'pry', '~> 0.13'
@@ -57,8 +52,9 @@ def specification(version, default_adapter, platform = nil)
     s.add_development_dependency 'twitter_cldr', '~> 6.4'
     
     # = MANIFEST =
-  s.files = %w(
+  s.files = %w[
     Gemfile
+    Guardfile
     HISTORY.md
     LICENSE
     README.md
@@ -109,7 +105,7 @@ def specification(version, default_adapter, platform = nil)
     lib/gollum-lib/version.rb
     lib/gollum-lib/wiki.rb
     licenses/licenses.txt
-  )
+  ]
   # = MANIFEST =
 
     s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }

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

@@ -2,8 +2,21 @@
 
 # Code
 #
-# Render a block of code using the Rouge syntax-highlighter.
+# Handle code blocks:
+# - in the extractstep, extract them so they don't get rendered by the Render filter
+# - in the process step, apply highlighting and wrapping and reinsert them into the document
+
 class Gollum::Filter::Code < Gollum::Filter
+  
+  # The @language_handlers Hash can be filled with Regep keys and corresponding Proc values. The Procs will be executed to handle a codeblock whose language definition matches the key.
+  # See the Code Filter tests for an example
+  # Use the Gollum::Filter::Code.language_handlers method to access and modify this class instance variable
+  @language_handlers = {}
+    
+  class << self
+    attr_accessor :language_handlers
+  end
+  
   def extract(data)
     case @markup.format
     when :asciidoc
@@ -63,8 +76,14 @@ class Gollum::Filter::Code < Gollum::Filter
       blocks << [spec[:lang], code]
     end
 
-    highlighted = []
+    wrapped_blocks = []
     blocks.each do |lang, code|
+      
+      if (_pattern, proc = self.class.language_handlers.find { |pattern, _v| lang =~ pattern }) then
+        wrapped_blocks << proc.call(CGI.escape_html(lang), CGI.escape_html(code))
+        next
+      end
+      
       encoding = @markup.encoding || 'utf-8'
 
       if defined? Pygments
@@ -95,12 +114,12 @@ class Gollum::Filter::Code < Gollum::Filter
         end
       end
 
-      highlighted << hl_code
+      wrapped_blocks << hl_code
     end
 
     @map.each do |id, spec|
       body = spec[:output] || begin
-        if (body = highlighted.shift.to_s).size > 0
+        if (body = wrapped_blocks.shift.to_s).size > 0
           @markup.update_cache(:code, id, body)
           body
         else

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

@@ -4,7 +4,7 @@ require 'octicons'
 # Replace specified tokens with dynamically generated content.
 class Gollum::Filter::Macro < Gollum::Filter
   def extract(data)
-    quoted_arg   = %r{".*?"}
+    quoted_arg   = %r{".*?(?<!\\)"} # use a negative lookbehind to not terminate on a " preceeded by \
     unquoted_arg = %r{[^,)]+}
     named_arg    = %r{[a-z0-9_]+=".*?"}
     
@@ -26,7 +26,7 @@ class Gollum::Filter::Macro < Gollum::Filter
         if argument =~ /^([a-z0-9_]+)="(.*?)"/
       		opts[Regexp.last_match[1]] = Regexp.last_match[2]
 			  elsif argument =~ /^"(.*)"$/
-      		args << Regexp.last_match[1]
+				  args << Regexp.last_match[1].gsub("\\\"", "\"")
 			  else
 				  args << argument
         end

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

@@ -69,7 +69,7 @@ class Gollum::Filter::PlantUML < Gollum::Filter
   # Extract all sequence diagram blocks into the map and replace with
   # placeholders.
   def extract(data)
-    data.gsub(/(@startuml\r?\n.+?\r?\n@enduml\r?$)/m) do
+    data.gsub(/(@start(uml|json|yaml|salt|mindmap|wbs|math|latex)\r?\n.+?\r?\n@end\2\r?$)/m) do
       id       = "#{open_pattern}#{Digest::SHA1.hexdigest($1)}#{close_pattern}"
       @map[id] = { :code => $1 }
       id

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

@@ -19,8 +19,11 @@ class Gollum::Filter::Render < Gollum::Filter
   end
 
   def process(data)
-    data = add_editable_header_class(data)
-    data
+    if @markup.wiki.allow_editing
+      add_editable_header_class(data)
+    else
+      data
+    end
   end
 
   private

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

@@ -125,7 +125,7 @@ class Gollum::Filter::TOC < Gollum::Filter
   # Creates an anchor element with the given name and adds it before
   # the given header element.
   def add_anchor_to_header(header, name)
-    a = Nokogiri::XML::Node.new('a', @doc)
+    a = Nokogiri::XML::Node.new('a', @doc.document)
     a['class'] = 'anchor'
     a['id'] = name
     a['href'] = "##{name}"
@@ -143,9 +143,9 @@ class Gollum::Filter::TOC < Gollum::Filter
 
     if @tail_level < level
       while @tail_level < level
-        list = Nokogiri::XML::Node.new('ul', @doc)
+        list = Nokogiri::XML::Node.new('ul', @doc.document)
         @tail.add_child(list)
-        @tail = list.add_child(Nokogiri::XML::Node.new('li', @doc))
+        @tail = list.add_child(Nokogiri::XML::Node.new('li', @doc.document))
         @tail_level += 1
       end
     else
@@ -153,7 +153,7 @@ class Gollum::Filter::TOC < Gollum::Filter
         @tail = @tail.parent.parent
         @tail_level -= 1
       end
-      @tail = @tail.parent.add_child(Nokogiri::XML::Node.new('li', @doc))
+      @tail = @tail.parent.add_child(Nokogiri::XML::Node.new('li', @doc.document))
     end
 
     # % -> %25 so anchors work on Firefox. See issue #475

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

@@ -6,7 +6,7 @@ module Gollum
           prepath = @wiki.base_path.sub(/\/$/, '')
           result  = '<ul>' + @wiki.pages.map { |p| "<li><a href=\"#{CGI::escapeHTML(prepath + "/" + p.escaped_url_path)}\">#{CGI::escapeHTML(p.url_path)}</a></li>" }.join + '</ul>'
         end
-        "<div class=\"toc\"><div class=\"toc-title\">#{CGI::escapeHTML(title)}</div>#{result}</div>"
+        "<div class=\"toc\"><div class=\"toc-title\">#{title}</div>#{result}</div>"
       end
     end
   end

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

@@ -14,7 +14,7 @@ module Gollum
           end
           result = "<ul>#{list_items.join}</ul>"
         end
-        "<div class=\"toc\"><div class=\"toc-title\">#{CGI::escapeHTML(title)}</div>#{result}</div>"
+        "<div class=\"toc\"><div class=\"toc-title\">#{title}</div>#{result}</div>"
       end
 
     end

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

@@ -12,7 +12,7 @@ module Gollum
           icon.options[:class] << ' mr-2'
           icon = icon.to_svg
         end
-        "<div class='flash'>#{icon}#{CGI::escapeHTML(notice)}</div>"
+        "<div class='flash'>#{icon}#{notice}</div>"
       end
     end
   end

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

@@ -4,7 +4,7 @@ module Gollum
       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}#{CGI::escapeHTML(warning)}</div>"
+        "<div class='flash flash-warn'>#{icon.to_svg}#{warning}</div>"
       end
     end
   end

data/lib/gollum-lib/markups.rb

@@ -81,7 +81,7 @@ module Gollum
              :enabled => MarkupRegisterUtils::gem_exists?("creole"),
              :reverse_links => true)
     register(:rst, "reStructuredText",
-             :enabled => MarkupRegisterUtils::executable_exists?("python2"),
+             :enabled => MarkupRegisterUtils::executable_exists?("python3"),
              :extensions => ['rest', 'rst'])
     register(:asciidoc, "AsciiDoc",
              :skip_filters => [:Tags],

data/lib/gollum-lib/version.rb

@@ -1,5 +1,5 @@
 module Gollum
   module Lib
-    VERSION = '5.1.2'
+    VERSION = '5.2.1'
   end
 end

data/lib/gollum-lib/wiki.rb

@@ -57,6 +57,10 @@ module Gollum
     # Defaults to false
     attr_reader :css
 
+    # Whether or not content is editable.
+    # Defaults to true
+    attr_reader :allow_editing
+
     # Sets page title to value of first h1
     # Defaults to false
     attr_reader :h1_title
@@ -106,6 +110,7 @@ module Gollum
     #           :bar_side      - Where the sidebar should be displayed, may be:
     #                             - :left
     #                             - :right
+    #           :allow_editing - Set whether wiki content can be edited. Default: true
     #           :allow_uploads - Set to true to allow file uploads.
     #           :per_page_uploads - Whether uploads should be stored in a central
     #                            'uploads' directory, or in a directory named for
@@ -142,6 +147,7 @@ module Gollum
       @bar_side             = options.fetch :sidebar, :right
       @user_icons           = ['gravatar', 'identicon'].include?(options[:user_icons]) ?
           options[:user_icons] : 'none'
+      @allow_editing        = options.fetch :allow_editing, true
       @allow_uploads        = options.fetch :allow_uploads, false
       @per_page_uploads     = options.fetch :per_page_uploads, false
       @metadata             = options.fetch :metadata, {}
@@ -594,10 +600,10 @@ module Gollum
 
     # Enable 4.x compatibility behavior for links
     attr_reader :global_tag_lookup
-    
+
     # Enable 4.x compatibility for case-case_insensitive links
     attr_reader :case_insensitive_tag_lookup
-    
+
     # Spaces in tag paths are treated as dashes (-)
     attr_reader :hyphened_tag_lookup
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gollum-lib
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 5.2.1
 platform: ruby
 authors:
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-04-13 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gollum-rugged_adapter
@@ -143,14 +143,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: kramdown-parser-gfm
   requirement: !ruby/object:Gem::Requirement
@@ -241,14 +241,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: unicode_utils
   requirement: !ruby/object:Gem::Requirement
@@ -398,6 +398,7 @@ extra_rdoc_files:
 - LICENSE
 files:
 - Gemfile
+- Guardfile
 - HISTORY.md
 - LICENSE
 - README.md
@@ -468,8 +469,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key:
-specification_version: 2
+specification_version: 4
 summary: A simple, Git-powered wiki.
 test_files: []