gollum-lib 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4dcf391053842849c400121f0f21c035094742f
-  data.tar.gz: 58367a8f8ded27b4ef7457e48fae7f6019a3141e
+  metadata.gz: 1c4e3d8ea8a629bdd6bc0a8b13dc901366811de7
+  data.tar.gz: b894bed5617bedddbfaed91003cf82f50b9785c5
 SHA512:
-  metadata.gz: 42e1d2261b367bb8b65b1ced6497ad11597f4d07c8a7a69cf33856da53663e1ef984c632bc645bf4543f7e1a84819bb83a283e70eb2ca028344fd00673a9b4c7
-  data.tar.gz: 67c364841f195db1e110fa453ee35e5b2f22029204d10090638fed88560edd353de91fde9bc7fad8993342104ca31a53ea0009c3cfe72d6b834188fff555ff8b
+  metadata.gz: 4ca45f261d3d0a22ea9686b682b380c3cb14cb878cd86dec20fb780ed600cedce4ac9352ab58439a5c19af21a07f90246bcc9330d4f8315b2c630b1bb5efc8c5
+  data.tar.gz: 56b810b3f1384448377ea7c109e1f708269f072827ac19d139638141be8fd01d8a9f3a54aae52e3a6eae295a8aacae52ebaf0115887dba9358e47c3e03d2d771

data/Gemfile

@@ -1,3 +1,3 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec

data/README.md

@@ -1,9 +1,9 @@
 gollum lib -- A wiki built on top of Git
 ========================================
 
-[![Gem Version](https://badge.fury.io/rb/gollum-lib.png)](http://rubygems.org/gems/gollum-lib)
-[![Build Status](https://travis-ci.org/gollum/gollum-lib.png)](https://travis-ci.org/gollum/gollum-lib)
-[![Dependency Status](https://gemnasium.com/gollum/gollum-lib.png)](https://gemnasium.com/gollum/gollum-lib)
+[![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)
+[![Dependency Status](https://gemnasium.com/gollum/gollum-lib.svg)](https://gemnasium.com/gollum/gollum-lib)
 
 ## DESCRIPTION
 
@@ -43,7 +43,7 @@ In order to use the various formats that Gollum supports, you will need to
 separately install the necessary dependencies for each format. You only need
 to install the dependencies for the formats that you plan to use.
 
-* [ASCIIDoc](http://www.methods.co.nz/asciidoc/) -- `brew install asciidoc` on mac or `apt-get install -y asciidoc` on Ubuntu
+* [AsciiDoc](http://www.methods.co.nz/asciidoc/) -- `gem install asciidoctor`
 * [Creole](http://wikicreole.org/) -- `gem install creole`
 * [Markdown](http://daringfireball.net/projects/markdown/) -- `gem install redcarpet`
 * [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown) -- `gem install github-markdown`
@@ -105,7 +105,7 @@ page.format
 # => :markdown
 
 vsn = page.version
-# => <Grit::Commit>
+# => <Gollum::Git::Commit>
 
 vsn.id
 # => '3ca43e12377ea1e32ea5c9ce5992ec8bf266e3e5'
@@ -129,7 +129,7 @@ Get a list of versions for a given page:
 
 ```ruby
 vsns = wiki.page('page-name').versions
-# => [<Grit::Commit, <Grit::Commit, <Grit::Commit>]
+# => [<Gollum::Git::Commit, <Gollum::Git::Commit, <Gollum::Git::Commit>]
 
 vsns.first.id
 # => '3ca43e12377ea1e32ea5c9ce5992ec8bf266e3e5'
@@ -154,7 +154,7 @@ file.raw_data
 # => "alert('hello');"
 
 file.version
-# => <Grit::Commit>
+# => <Gollum::Git::Commit>
 ```
 
 Get a specific version of a given static file:

data/gollum-lib.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9'
 
   s.name              = 'gollum-lib'
-  s.version           = '3.0.0'
-  s.date              = '2014-04-05'
+  s.version           = '4.0.0'
+  s.date              = '2014-11-26'
   s.rubyforge_project = 'gollum-lib'
   s.license           = 'MIT'
 
@@ -22,33 +22,33 @@ Gem::Specification.new do |s|
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = %w[README.md LICENSE]
 
-  s.add_dependency 'gitlab-grit', '~> 2.6.5'
-  s.add_dependency 'rouge', '~> 1.3.3'
-  s.add_dependency 'nokogiri', '~> 1.6.1'
+  s.add_dependency 'gollum-grit_adapter', '~> 0.1.0'
+  s.add_dependency 'rouge', '~> 1.7.4'
+  s.add_dependency 'nokogiri', '~> 1.6.4'
   s.add_dependency 'stringex', '~> 2.5.1'
   s.add_dependency 'sanitize', '~> 2.1.0'
-  s.add_dependency 'github-markup', '~> 1.1.0'
+  s.add_dependency 'github-markup', '~> 1.3.1'
 
-  s.add_development_dependency 'org-ruby', '~> 0.9.3'
-  s.add_development_dependency 'github-markdown', '~> 0.6.5'
+  s.add_development_dependency 'org-ruby', '~> 0.9.9'
+  s.add_development_dependency 'github-markdown', '~> 0.6.7'
   s.add_development_dependency 'RedCloth', '~> 4.2.9'
-  s.add_development_dependency 'mocha', '~> 1.0.0'
+  s.add_development_dependency 'mocha', '~> 1.1.0'
   s.add_development_dependency 'shoulda', '~> 3.5.0'
   s.add_development_dependency 'wikicloth', '~> 0.8.1'
-  s.add_development_dependency 'rake', '~> 10.2.2'
-  s.add_development_dependency 'pry', '~> 0.9.12'
+  s.add_development_dependency 'rake', '~> 10.4.0'
+  s.add_development_dependency 'pry', '~> 0.10.1'
   # required by pry
   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 'minitest-reporters', '~> 0.14.16'
   s.add_development_dependency 'nokogiri-diff', '~> 0.2.0'
   # required by guard
-  s.add_development_dependency 'guard', '~> 2.6.0'
-  s.add_development_dependency 'guard-minitest', '~> 2.2.0'
+  s.add_development_dependency 'guard', '~> 2.8.2'
+  s.add_development_dependency 'guard-minitest', '~> 2.3.2'
   s.add_development_dependency 'rb-inotify', '~> 0.9.3'
   s.add_development_dependency 'rb-fsevent', '~> 0.9.4'
   s.add_development_dependency 'rb-fchange', '~> 0.0.6'
-  s.add_development_dependency 'twitter_cldr', '~> 2.4.2'
+  s.add_development_dependency 'twitter_cldr', '~> 3.1.0'
   # = MANIFEST =
   s.files = %w[
     Gemfile
@@ -65,6 +65,7 @@ Gem::Specification.new do |s|
     lib/gollum-lib/file_view.rb
     lib/gollum-lib/filter.rb
     lib/gollum-lib/filter/code.rb
+    lib/gollum-lib/filter/macro.rb
     lib/gollum-lib/filter/metadata.rb
     lib/gollum-lib/filter/plain_text.rb
     lib/gollum-lib/filter/remote_code.rb
@@ -75,9 +76,10 @@ Gem::Specification.new do |s|
     lib/gollum-lib/filter/wsd.rb
     lib/gollum-lib/git_access.rb
     lib/gollum-lib/gitcode.rb
-    lib/gollum-lib/grit_ext.rb
     lib/gollum-lib/helpers.rb
     lib/gollum-lib/hook.rb
+    lib/gollum-lib/macro.rb
+    lib/gollum-lib/macro/all_pages.rb
     lib/gollum-lib/markup.rb
     lib/gollum-lib/markups.rb
     lib/gollum-lib/page.rb

data/lib/gollum-lib.rb

@@ -4,9 +4,15 @@ require 'digest/md5'
 require 'digest/sha1'
 require 'ostruct'
 
+DEFAULT_ADAPTER = 'grit_adapter'
+
+if defined?(Gollum::GIT_ADAPTER)
+  require "#{Gollum::GIT_ADAPTER.downcase}_adapter"
+else
+  require DEFAULT_ADAPTER
+end
+
 # external
-require 'grit'
-require File.expand_path('../gollum-lib/grit_ext', __FILE__)
 require 'github/markup'
 require 'sanitize'
 
@@ -18,6 +24,7 @@ require File.expand_path('../gollum-lib/pagination', __FILE__)
 require File.expand_path('../gollum-lib/blob_entry', __FILE__)
 require File.expand_path('../gollum-lib/wiki', __FILE__)
 require File.expand_path('../gollum-lib/page', __FILE__)
+require File.expand_path('../gollum-lib/macro', __FILE__)
 require File.expand_path('../gollum-lib/file', __FILE__)
 require File.expand_path('../gollum-lib/file_view', __FILE__)
 require File.expand_path('../gollum-lib/markup', __FILE__)
@@ -31,21 +38,13 @@ $KCODE = 'U' if RUBY_VERSION[0, 3] == '1.8'
 
 module Gollum
   module Lib
-    VERSION = '3.0.0'
+    VERSION = '4.0.0'
   end
 
   def self.assets_path
     ::File.expand_path('gollum/frontend/public', ::File.dirname(__FILE__))
   end
 
-  def self.set_git_timeout(time)
-    Grit::Git.git_timeout = time
-  end
-
-  def self.set_git_max_filesize(size)
-    Grit::Git.git_max_size = size
-  end
-
   class Error < StandardError; end
 
   class DuplicatePageError < Error

data/lib/gollum-lib/blob_entry.rb

@@ -31,13 +31,13 @@ module Gollum
       @name ||= ::File.basename(@path)
     end
 
-    # Gets a Grit::Blob instance for this blob.
+    # Gets a Gollum::Git::Blob instance for this blob.
     #
-    # repo - Grit::Repo instance for the Grit::Blob.
+    # repo - Gollum::Git::Repo instance for the Gollum::Git::Blob.
     #
-    # Returns an unbaked Grit::Blob instance.
+    # Returns an unbaked Gollum::Git::Blob instance.
     def blob(repo)
-      @blob ||= Grit::Blob.create(repo,
+      @blob ||= Gollum::Git::Blob.create(repo,
                                   :id => @sha, :name => name, :size => @size, :mode => @mode)
     end
 

data/lib/gollum-lib/committer.rb

@@ -18,7 +18,7 @@ module Gollum
     #           :message   - The String commit message.
     #           :name      - The String author full name.
     #           :email     - The String email address.
-    #           :parent    - Optional Grit::Commit parent to this update.
+    #           :parent    - Optional Gollum::Git::Commit parent to this update.
     #           :tree      - Optional String SHA of the tree to create the
     #                        index from.
     #           :committer - Optional Gollum::Committer instance.  If provided,
@@ -35,7 +35,7 @@ module Gollum
 
     # Public: References the Git index for this commit.
     #
-    # Returns a Grit::Index.
+    # Returns a Gollum::Git::Index.
     def index
       @index ||= begin
         idx = @wiki.repo.index
@@ -50,18 +50,18 @@ module Gollum
 
     # Public: The committer for this commit.
     #
-    # Returns a Grit::Actor.
+    # Returns a Gollum::Git::Actor.
     def actor
       @actor ||= begin
         @options[:name]  = @wiki.default_committer_name if @options[:name].to_s.empty?
         @options[:email] = @wiki.default_committer_email if @options[:email].to_s.empty?
-        Grit::Actor.new(@options[:name], @options[:email])
+        Gollum::Git::Actor.new(@options[:name], @options[:email])
       end
     end
 
     # Public: The parent commits to this pending commit.
     #
-    # Returns an array of Grit::Commit instances.
+    # Returns an array of Gollum::Git::Commit instances.
     def parents
       @parents ||= begin
         arr = [@options[:parent] || @wiki.repo.commit(@wiki.ref)]
@@ -155,9 +155,9 @@ module Gollum
 
         Dir.chdir(::File.join(@wiki.repo.path, '..')) do
           if file_path_scheduled_for_deletion?(index.tree, path)
-            @wiki.repo.git.rm({ 'f' => true }, '--', path)
+            @wiki.repo.git.rm(path, :force => true)
           else
-            @wiki.repo.git.checkout({}, 'HEAD', '--', path)
+            @wiki.repo.git.checkout(path, 'HEAD')
           end
         end
       end

data/lib/gollum-lib/file.rb

@@ -73,7 +73,7 @@ module Gollum
       return @on_disk_path
     end
 
-    # Public: The Grit::Commit version of the file.
+    # Public: The Gollum::Git::Commit version of the file.
     attr_accessor :version
 
     # Public: The String path of the file.
@@ -86,7 +86,7 @@ module Gollum
 
     # Populate the File with information from the Blob.
     #
-    # blob - The Grit::Blob that contains the info.
+    # blob - The Gollum::Git::Blob that contains the info.
     # path - The String directory path of the file.
     #
     # Returns the populated Gollum::File.
@@ -139,7 +139,7 @@ module Gollum
     def find(name, version, try_on_disk=false)
       checked = name.downcase
       map     = @wiki.tree_map_for(version)
-      commit  = version.is_a?(Grit::Commit) ? version : @wiki.commit_for(version)
+      commit  = version.is_a?(Gollum::Git::Commit) ? version : @wiki.commit_for(version)
 
       if entry = map.detect { |entry| entry.path.downcase == checked }
         @path    = name

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

@@ -85,6 +85,9 @@ class Gollum::Filter::Code < Gollum::Filter
         end
       else # Rouge
         begin
+          # if `lang` was not defined then assume plaintext
+          # if `lang` is defined but cannot be found then wrap it and escape it
+          lang ||= 'plaintext'
           if Rouge::Lexer.find(lang).nil?
             lexer     = Rouge::Lexers::PlainText.new
             formatter = Rouge::Formatters::HTML.new(:wrap => false)
@@ -110,7 +113,8 @@ class Gollum::Filter::Code < Gollum::Filter
           "<pre><code>#{CGI.escapeHTML(spec[:code])}</code></pre>"
         end
       end
-      data.gsub!(id) do
+      # 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
     end

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

@@ -0,0 +1,56 @@
+# ~*~ encoding: utf-8 ~*~
+
+# Replace specified tokens with dynamically generated content.
+class Gollum::Filter::Macro < Gollum::Filter
+  def extract(data)
+    quoted_arg   = %r{".*?"}
+    unquoted_arg = %r{[^,)]+}
+    named_arg    = %r{[a-z0-9_]+=".*?"}
+    
+    arg = %r{(?:#{quoted_arg}|#{unquoted_arg}|#{named_arg})}
+    arg_list = %r{(\s*|#{arg}(?:\s*,\s*#{arg})*)}
+
+    data.gsub(/\<\<\s*([A-Z][A-Za-z0-9]*)\s*\(#{arg_list}\)\s*\>\>/) do
+      id = Digest::SHA1.hexdigest($1 + $2)
+      macro = $1
+      argstr = $2
+      args = []
+      opts = {}
+      
+      argstr.scan /,?\s*(#{arg})\s*/ do |arg|
+      	# Stabstabstab
+      	arg = arg.first
+      	
+      	if arg =~ /^([a-z0-9_]+)="(.*?)"/
+      		opts[$1] = $2
+			elsif arg =~ /^"(.*)"$/
+      		args << $1
+			else
+				args << arg
+			end
+		end
+		
+		args << opts unless opts.empty?
+      
+      @map[id] = { :macro => macro, :args => args }
+      id
+    end
+  end
+
+  def process(data)
+    @map.each do |id, spec|
+      macro = spec[:macro]
+      args  = spec[:args]
+
+      data.gsub!(id) do
+        begin
+          Gollum::Macro.instance(macro, @markup.wiki, @markup.page).render(*args)
+        rescue StandardError => e
+          "!!!Macro Error: #{e.message}!!!"
+        end
+      end
+    end
+
+    data
+  end
+end

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

@@ -15,51 +15,53 @@ class Gollum::Filter::Tags < Gollum::Filter
           parts          = $2.split('][')
           parts[0][0..4] = ""
           link           = "#{parts[1]}|#{parts[0].sub(/\.org/, '')}"
-          id             = Digest::SHA1.hexdigest(link)
-          @map[id]       = link
+          id             = register_tag(link)
           "#{pre}#{id}#{post}"
         else
           $&
         end
       else
-        id       = Digest::SHA1.hexdigest($2)
-        @map[id] = $2
+        id = register_tag($2)
         "#{$1}#{id}#{$3}"
       end
     end
     data
   end
 
-  # Process all tags from the tagmap and replace the placeholders with the
+  def register_tag(tag)
+    id       = "TAG#{Digest::SHA1.hexdigest(tag)}TAG"
+    @map[id] = tag
+    id
+  end
+
+  # Process all text nodes from the doc and replace the placeholders with the
   # final markup.
-  def process(data)
-    @map.each do |id, tag|
-      # If it's preformatted, just put the tag back
-      if is_preformatted?(data, id)
-        data.gsub!(id) do
-          "[[#{tag}]]"
-        end
-      else
-        data.gsub!(id) do
-          process_tag(tag).gsub('%2F', '/')
+  def process(rendered_data)
+    doc  = Nokogiri::HTML::DocumentFragment.parse(rendered_data)
+    doc.traverse do |node|
+      if node.text? then
+        content = node.content
+        content.gsub!(/TAG[a-f0-9]+TAG/) do |id|
+          if tag = @map[id] then
+            if is_preformatted?(node) then
+              "[[#{tag}]]"
+            else
+              process_tag(tag).gsub('%2f', '/')
+            end
+          end
         end
+        node.replace(content) if content != node.content
       end
     end
 
-    data
+    doc.to_html
   end
 
   private
-  # Find `id` within `data` and determine if it's within
-  # preformatted tags.
-  #
-  # data      - The String data (with placeholders).
-  # id        - The String SHA1 hash.
+
   PREFORMATTED_TAGS = %w(code tt)
 
-  def is_preformatted?(data, id)
-    doc  = Nokogiri::HTML::DocumentFragment.parse(data)
-    node = doc.search("[text()*='#{id}']").first
+  def is_preformatted?(node)
     node && (PREFORMATTED_TAGS.include?(node.name) ||
         node.ancestors.any? { |a| PREFORMATTED_TAGS.include?(a.name) })
   end
@@ -79,6 +81,8 @@ class Gollum::Filter::Tags < Gollum::Filter
       html
     elsif html = process_image_tag(tag)
       html
+    elsif html = process_external_link_tag(tag)
+      html
     elsif html = process_file_link_tag(tag)
       html
     else
@@ -199,6 +203,35 @@ class Gollum::Filter::Tags < Gollum::Filter
     end
   end
 
+  # Return the String HTML if the tag is a valid external link tag or
+  # nil if it is not.
+  def process_external_link_tag(tag)
+    parts = tag.split('|')
+    return if parts.size.zero?
+    if parts.size == 1
+      url = parts[0].strip
+    else
+      name, url = *parts.compact.map(&:strip)      
+    end
+    accepted_protocols = @markup.wiki.sanitization.protocols['a']['href'].dup
+    if accepted_protocols.include?(:relative)
+      accepted_protocols.select!{|protocol| protocol != :relative}
+      regexp = %r{^((#{accepted_protocols.join("|")}):)?(//)}
+    else
+      regexp = %r{^((#{accepted_protocols.join("|")}):)}
+    end
+    if url =~ regexp
+      if name.nil?
+        %{<a href="#{url}">#{url}</a>}
+      else
+        %{<a href="#{url}">#{name}</a>}
+      end
+    else
+      nil
+    end
+    
+  end
+
   # Attempt to process the tag as a file link tag.
   #
   # tag       - The String tag contents (the stuff inside the double
@@ -214,8 +247,6 @@ class Gollum::Filter::Tags < Gollum::Filter
     path = parts[1] && parts[1].strip
     path = if path && file = @markup.find_file(path)
              ::File.join @markup.wiki.base_path, file.path
-           elsif path =~ %r{^https?://}
-             path
            else
              nil
            end
@@ -243,25 +274,21 @@ class Gollum::Filter::Tags < Gollum::Filter
     name, page_name = *parts.compact.map(&:strip)
     cname           = @markup.wiki.page_class.cname(page_name || name)
 
-    if name =~ %r{^https?://} && page_name.nil?
-      %{<a href="#{name}">#{name}</a>}
-    else
-      presence    = "absent"
-      link_name   = cname
-      page, extra = find_page_from_name(cname)
-      if page
-        link_name = @markup.wiki.page_class.cname(page.name)
-        presence  = "present"
-      end
-      link = ::File.join(@markup.wiki.base_path, page ? page.escaped_url_path : CGI.escape(link_name))
+    presence    = "absent"
+    link_name   = cname
+    page, extra = find_page_from_name(cname)
+    if page
+      link_name = @markup.wiki.page_class.cname(page.name)
+      presence  = "present"
+    end
+    link = ::File.join(@markup.wiki.base_path, page ? page.escaped_url_path : CGI.escape(link_name))
 
-      # //page is invalid
-      # strip all duplicate forward slashes using helpers.rb trim_leading_slash
-      # //page => /page
-      link = trim_leading_slash link
+    # //page is invalid
+    # strip all duplicate forward slashes using helpers.rb trim_leading_slash
+    # //page => /page
+    link = trim_leading_slash link
 
-      %{<a class="internal #{presence}" href="#{link}#{extra}">#{name}</a>}
-    end
+    %{<a class="internal #{presence}" href="#{link}#{extra}">#{name}</a>}
   end
 
   # Find a page from a given cname.  If the page has an anchor (#) and has