gollum-lib 4.0.3 → 4.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjljZjMxYzNlY2MyMzg5NzYyZTk1ZGI2YjgwYzBhMDMzYmQ1MTRjZQ==
+    MTM0YjhkYTk1OTA4NDBhYzQ5NWJiZjNlZmU4YmVjMWYwMjMxOTFlZg==
   data.tar.gz: !binary |-
-    ODIyNzMyNmU1ODlhZjRmMzU3MjRjMDU3YWIwZjI3YjhkZTZiZDdmZQ==
+    YjY4ZTA4ZmI3YTQxYTBkNDk3Mzg2OGRjYTI2ODU1OTZhNmRlNjgzMQ==
 SHA512:
   metadata.gz: !binary |-
-    ZDc2NDRmNDk5OTcwZjY5OGI1Yzk1OTdiNDQyNWE0MTZhMmY2OTExOTVjMmE3
-    NDlkMWRmOGYyN2JhZTcwNTZmMGFhZDViZjA1OTMxMjkzZjQ4NjM1OGVhZjRk
-    MjMyNzM4OWU4YTQ5YWY3YzE4NzUxNjAxNTUwNmM1YjBlMDExYWU=
+    ZTcyYjlmZmZjN2NhNmJlMmI1OGNiNTY5YTkwZDc2YzBhNDNlMmEwMTQ1Mzcy
+    MDIwNjI5MWQyZmYzYWEyYjY0NTJiY2M0MzY5M2M5NTc1NjIxYWE3NjEwNWNj
+    ZWIwOWQ2YjBmMDlhMjAxODI1NmM4Y2MxMGJjOWZlMDE3ODQxNmE=
   data.tar.gz: !binary |-
-    MGRmNDc4OTVlYjIzMTU2ZGQ3YWQzZGVkMmIzZGVhNGVlMDNiMDA1MTM3Mjg4
-    NjJiMmY1MTBhOWIwZWY0ZTc5ZWY0MzUyYzk3MTVhMDVhYmFhNzJlYzU5MjQ4
-    N2UyYmEzNmZlYTM4YjAxYzE3MjljZWE5NjQ2NzAwZDliNDExODc=
+    NTU0MDMzMjEzYWJiMzA3ZmExZTgzYmUxY2E5M2M5ZmFlYzdjZDhlNTJmNDQ1
+    ODM4YjY5Mzk5NzVmM2IzMDE5ZmEwYTdmMGFjZDc3OTYyZTVmMmI3ODEzZTcx
+    ZGRiNDYzMDMwOGM3Y2U3OTEwOThhZDIwNWI1MmE0MGM5NWZjYjQ=

data/README.md

@@ -22,7 +22,7 @@ Gollum-lib follows the rules of [Semantic Versioning](http://semver.org/) and us
 - Python 2.5+ (2.7.3 recommended)
 - Ruby 1.9.3+ (1.9.3 recommended)
 - Unix like operating system (OS X, Ubuntu, Debian, and more)
-- Will not work on Windows (because of [grit](https://github.com/github/grit))
+- Will not work on Windows with the default [grit](https://github.com/github/grit) adapter, but might work via JRuby (please let us know!)
 
 ## INSTALLATION
 

data/Rakefile

@@ -9,7 +9,7 @@ require 'date'
 #############################################################################
 
 def name
-  @name ||= Dir['*.gemspec'].first.split('.').first
+  "gollum-lib"
 end
 
 def version
@@ -149,7 +149,7 @@ 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_header(head, :name)
@@ -167,7 +167,7 @@ task :gemspec => :validate do
     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}"

data/gemspec.rb

@@ -8,7 +8,7 @@ def specification(version, default_adapter, platform = nil)
     s.name              = 'gollum-lib'
     s.version           = version
     s.platform          = platform if platform
-    s.date              = '2015-04-10'
+    s.date              = '2015-08-09'
     s.rubyforge_project = 'gollum-lib'
     s.license           = 'MIT'
 
@@ -19,13 +19,13 @@ def specification(version, default_adapter, platform = nil)
     s.email    = 'tom@github.com'
     s.homepage = 'http://github.com/gollum/gollum-lib'
 
-    s.require_paths = %w[lib]
+    s.require_paths = %w(lib)
 
     s.rdoc_options = ['--charset=UTF-8']
-    s.extra_rdoc_files = %w[README.md LICENSE]
+    s.extra_rdoc_files = %w(README.md LICENSE)
 
     s.add_dependency *default_adapter
-    s.add_dependency 'rouge', '~> 1.7.4'
+    s.add_dependency 'rouge', '~> 1.9'
     s.add_dependency 'nokogiri', '~> 1.6.4'
     s.add_dependency 'stringex', '~> 2.5.1'
     s.add_dependency 'sanitize', '~> 2.1.0'
@@ -52,7 +52,7 @@ def specification(version, default_adapter, platform = nil)
     s.add_development_dependency 'rb-fchange', '~> 0.0.6'
     s.add_development_dependency 'twitter_cldr', '~> 3.1.0'
     # = MANIFEST =
-  s.files = %w[
+  s.files = %w(
     Gemfile
     HISTORY.md
     LICENSE
@@ -72,6 +72,7 @@ def specification(version, default_adapter, platform = nil)
     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
@@ -84,6 +85,8 @@ def specification(version, default_adapter, platform = nil)
     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
@@ -92,7 +95,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/blob_entry.rb

@@ -87,6 +87,7 @@ module Gollum
       return '' if dir =~ /^.:\/$/
       if dir
         dir = ::File.expand_path(dir, '/')
+        dir = dir[2..-1] if dir =~ /^[a-zA-Z]:\// # expand_path may add d:/ on windows
         dir = '' if dir == '/'
       end
       dir

data/lib/gollum-lib/committer.rb

@@ -39,9 +39,9 @@ module Gollum
     def index
       @index ||= begin
         idx = @wiki.repo.index
-        if tree = options[:tree]
+        if (tree = options[:tree])
           idx.read_tree(tree)
-        elsif parent = parents.first
+        elsif (parent = parents.first)
           idx.read_tree(parent.tree.id)
         end
         idx
@@ -97,7 +97,7 @@ module Gollum
       fullpath = ::File.join(*[@wiki.page_file_dir, dir, path].compact)
       fullpath = fullpath[1..-1] if fullpath =~ /^\//
 
-      if index.current_tree && tree = index.current_tree / (@wiki.page_file_dir || '/')
+      if index.current_tree && (tree = index.current_tree / (@wiki.page_file_dir || '/'))
         tree = tree / dir unless tree.nil?
       end
 
@@ -202,7 +202,7 @@ module Gollum
         deletions.any? { |d| d.downcase.sub(/\.\w+$/, '') == downfile }
       else
         part = parts.shift
-        if rest = map[part]
+        if (rest = map[part])
           page_path_scheduled_for_deletion?(rest, parts.join('/'))
         else
           false
@@ -226,7 +226,7 @@ module Gollum
         deletions.any? { |d| d == parts.first }
       else
         part = parts.shift
-        if rest = map[part]
+        if (rest = map[part])
           file_path_scheduled_for_deletion?(rest, parts.join('/'))
         else
           false

data/lib/gollum-lib/file.rb

@@ -63,14 +63,14 @@ module Gollum
     #
     # Returns true if this is a pointer to an on-disk file
     def on_disk?
-      return @on_disk
+      @on_disk
     end
 
     # Public: The path to this file on disk
     #
     # Returns nil if on_disk? is false.
     def on_disk_path
-      return @on_disk_path
+      @on_disk_path
     end
 
     # Public: The Gollum::Git::Commit version of the file.
@@ -90,7 +90,7 @@ module Gollum
     # path - The String directory path of the file.
     #
     # Returns the populated Gollum::File.
-    def populate(blob, path=nil)
+    def populate(blob, path = nil)
       @blob         = blob
       @path         = "#{path}/#{blob.name}"[1..-1]
       @on_disk      = false
@@ -123,7 +123,7 @@ module Gollum
       else
         @on_disk_path = pathname.to_path
       end
-      return true
+      true
     end
 
     # Find a file in the given Gollum repo.
@@ -136,19 +136,19 @@ module Gollum
     # 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 find(name, version, try_on_disk=false)
+    def find(name, version, try_on_disk = false)
       checked = name.downcase
       map     = @wiki.tree_map_for(version)
       commit  = version.is_a?(Gollum::Git::Commit) ? version : @wiki.commit_for(version)
 
-      if entry = map.detect { |entry| entry.path.downcase == checked }
+      if (result = map.detect { |entry| entry.path.downcase == checked })
         @path    = name
         @version = commit
 
         if try_on_disk && get_disk_reference(name, commit)
           @on_disk = true
         else
-          @blob = entry.blob(@wiki.repo)
+          @blob = result.blob(@wiki.repo)
         end
 
         self

data/lib/gollum-lib/file_view.rb

@@ -1,35 +1,34 @@
 # ~*~ encoding: utf-8 ~*~
 module Gollum
-=begin
-  FileView requires that:
-    - All files in root dir are processed first
-    - Then all the folders are sorted and processed
-=end
+  # 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 = {}
+    def initialize(pages, options = {})
       @pages    = pages
       @show_all = options[:show_all] || false
       @checked  = options[:collapse_tree] ? '' : "checked"
     end
 
-    def enclose_tree string
+    def enclose_tree(string)
       %Q(<ol class="tree">\n) + string + %Q(</ol>)
     end
 
-    def new_page page
+    def new_page(page)
       name = page.name
       url  = url_for_page page
       %Q(  <li class="file"><a href="#{url}"><span class="icon"></span>#{name}</a></li>)
     end
 
-    def new_folder folder_path
+    def new_folder(folder_path)
       new_sub_folder folder_path
     end
 
-    def new_sub_folder path
+    def new_sub_folder(path)
       <<-HTML
       <li>
         <label>#{path}</label> <input type="checkbox" #{@checked} />
@@ -41,7 +40,7 @@ module Gollum
       "</ol></li>\n"
     end
 
-    def url_for_page page
+    def url_for_page(page)
       url = ''
       if @show_all
         # Remove ext for valid pages.
@@ -121,8 +120,8 @@ module Gollum
       changed   = false
 
       # process rest of folders
-      (0...sorted_folders.size).each do |index|
-        page   = @pages[sorted_folders[index][1]]
+      (0...sorted_folders.size).each do |i|
+        page   = @pages[sorted_folders[i][1]]
         path   = page.path
         folder = ::File.dirname path
 
@@ -143,9 +142,9 @@ module Gollum
           end
         end
 
-        html      += new_page page
+        html += new_page page
         cwd_array = tmp_array
-        changed   = false
+        changed = false
       end
 
       # return the completed html

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

@@ -6,28 +6,28 @@
 class Gollum::Filter::Code < Gollum::Filter
   def extract(data)
     case @markup.format
-      when :txt
-        return data
-      when :asciidoc
-        data.gsub!(/^(\[source,([^\r\n]*)\]\n)?----\n(.+?)\n----$/m) do
-          cache_codeblock($2, $3)
-        end
-      when :org
-        org_headers = %r{([ \t]*#\+HEADER[S]?:[^\r\n]*\n)*}
-        org_name = %r{([ \t]*#\+NAME:[^\r\n]*\n)?}
-        org_lang = %r{[ ]*([^\n \r]*)[ ]*[^\r\n]*}
-        org_begin = %r{[ \t]*#\+BEGIN_SRC#{org_lang}\n}
-        org_end = %r{\n[ \t]*#\+END_SRC[ \t]*}
-        data.gsub!(/^#{org_headers}#{org_name}#{org_begin}(.+?)#{org_end}$/mi) do
-          cache_codeblock($3, $4)
-        end
+    when :txt
+      return data
+    when :asciidoc
+      data.gsub!(/^(\[source,([^\r\n]*)\]\n)?----\n(.+?)\n----$/m) do
+        cache_codeblock(Regexp.last_match[2], Regexp.last_match[3])
+      end
+    when :org
+      org_headers = %r{([ \t]*#\+HEADER[S]?:[^\r\n]*\n)*}
+      org_name = %r{([ \t]*#\+NAME:[^\r\n]*\n)?}
+      org_lang = %r{[ ]*([^\n \r]*)[ ]*[^\r\n]*}
+      org_begin = %r{[ \t]*#\+BEGIN_SRC#{org_lang}\n}
+      org_end = %r{\n[ \t]*#\+END_SRC[ \t]*}
+      data.gsub!(/^#{org_headers}#{org_name}#{org_begin}(.+?)#{org_end}$/mi) do
+        cache_codeblock(Regexp.last_match[3], Regexp.last_match[4])
+      end
     end
     data.gsub!(/^([ \t]*)(~~~+) ?([^\r\n]+)?\r?\n(.+?)\r?\n\1(~~~+)[ \t\r]*$/m) do
-      m_indent = $1
-      m_start  = $2 # ~~~
-      m_lang   = $3
-      m_code   = $4
-      m_end    = $5 # ~~~
+      m_indent = Regexp.last_match[1]
+      m_start  = Regexp.last_match[2] # ~~~
+      m_lang   = Regexp.last_match[3]
+      m_code   = Regexp.last_match[4]
+      m_end    = Regexp.last_match[5] # ~~~
       # start and finish tilde fence must be the same length
       next '' if m_start.length != m_end.length
       lang = m_lang ? m_lang.strip : nil
@@ -39,7 +39,7 @@ class Gollum::Filter::Code < Gollum::Filter
     end
 
     data.gsub!(/^([ \t]*)``` ?([^\r\n]+)?\r?\n(.+?)\r?\n\1```[ \t]*\r?$/m) do
-      "#{$1}#{cache_codeblock($2.to_s.strip, $3, $1)}" # print the SHA1 ID with the proper indentation
+      "#{Regexp.last_match[1]}#{cache_codeblock(Regexp.last_match[2].to_s.strip, Regexp.last_match[3], Regexp.last_match[1])}" # print the SHA1 ID with the proper indentation
     end
     data
   end
@@ -56,7 +56,7 @@ class Gollum::Filter::Code < Gollum::Filter
 
     blocks = []
 
-    @map.each do |id, spec|
+    @map.each do |_id, spec|
       next if spec[:output] # cached
 
       code = spec[:code]
@@ -76,8 +76,11 @@ class Gollum::Filter::Code < Gollum::Filter
         if !lang || lang.downcase == 'bash'
           hl_code = "<pre>#{code}</pre>"
         else
+          # Set the default lexer to 'text' to prevent #153
+          lexer = Pygments::Lexer[(lang)] || Pygments::Lexer['text']
+
           # 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 })
+          hl_code = lexer.highlight(code, :options => { :encoding => encoding.to_s, :startinline => true })
         end
       else # Rouge
         begin
@@ -110,9 +113,7 @@ class Gollum::Filter::Code < Gollum::Filter
         end
       end
       # Removes paragraph tags surrounding <pre> blocks, see issue https://github.com/gollum/gollum-lib/issues/97
-      data.gsub!(/(<p>#{id}<\/p>|#{id})/) do
-        body
-      end
+      data.gsub!(/(<p>#{id}<\/p>|#{id})/) { body }
     end
 
     data
@@ -127,9 +128,7 @@ class Gollum::Filter::Code < Gollum::Filter
   # regex     - A regex to match whitespace
   def remove_leading_space(code, regex)
     if code.lines.all? { |line| line =~ /\A\r?\n\Z/ || line =~ regex }
-      code.gsub!(regex) do
-        ''
-      end
+      code.gsub!(regex) { '' }
     end
   end
 

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

@@ -11,27 +11,27 @@ class Gollum::Filter::Macro < Gollum::Filter
     arg_list = %r{(\s*|#{arg}(?:\s*,\s*#{arg})*)}
 
     data.gsub(/('?)\<\<\s*([A-Z][A-Za-z0-9]*)\s*\(#{arg_list}\)\s*\>\>/) do
-      next CGI.escape_html($&[1..-1]) unless $1.empty?
-      id = Digest::SHA1.hexdigest($2 + $3)
-      macro = $2
-      argstr = $3
+      next CGI.escape_html($&[1..-1]) unless Regexp.last_match[1].empty?
+      id = Digest::SHA1.hexdigest(Regexp.last_match[2] + Regexp.last_match[3])
+      macro = Regexp.last_match[2]
+      argstr = Regexp.last_match[3]
       args = []
       opts = {}
       
-      argstr.scan /,?\s*(#{arg})\s*/ do |arg|
+      argstr.scan(/,?\s*(#{arg})\s*/) do |arguments|
       	# Stabstabstab
-      	arg = arg.first
+      	argument = arguments.first
       	
-      	if arg =~ /^([a-z0-9_]+)="(.*?)"/
-      		opts[$1] = $2
-			elsif arg =~ /^"(.*)"$/
-      		args << $1
-			else
-				args << arg
-			end
-		end
-		
-		args << opts unless opts.empty?
+        if argument =~ /^([a-z0-9_]+)="(.*?)"/
+      		opts[Regexp.last_match[1]] = Regexp.last_match[2]
+			  elsif argument =~ /^"(.*)"$/
+      		args << Regexp.last_match[1]
+			  else
+				  args << argument
+        end
+      end
+		  
+		  args << opts unless opts.empty?
       
       @map[id] = { :macro => macro, :args => args }
       id

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

@@ -14,7 +14,7 @@ class Gollum::Filter::Metadata < Gollum::Filter
       @markup.metadata ||= {}
       # Split untrusted input on newlines, then remove bits that look like
       # HTML elements before parsing each line.
-      $1.split("\n").each do |line|
+      Regexp.last_match[1].split("\n").each do |line|
         line.gsub!(/<[^>]*>/, '')
         k, v                      = line.split(':', 2)
         @markup.metadata[k.strip] = (v ? v.strip : '') if k
@@ -23,7 +23,7 @@ class Gollum::Filter::Metadata < Gollum::Filter
     end
   end
 
-  def process(d)
-    d
+  def process(data)
+    data
   end
 end