gollum-lib 3.0.0 → 4.0.0

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

@@ -1,61 +1,112 @@
 # Inserts header anchors and creates TOC
 class Gollum::Filter::TOC < Gollum::Filter
-  def extract(d)
-    d
+  def extract(data)
+    data
   end
 
   def process(data)
-    doc          = Nokogiri::HTML::DocumentFragment.parse(data)
-    toc          = nil
-    anchor_names = {}
-
-    doc.css('h1,h2,h3,h4,h5,h6').each do |h|
-      # must escape "
-      h_name               = h.content.gsub(' ', '-').gsub('"', '%22')
-
-      # Ensure repeat anchors have a unique prefix or the
-      # toc will break
-      anchor_names[h_name] = 0 if anchor_names[h_name].nil?
-      anchor_names[h_name] += 1
-
-      anchor_prefix_number = anchor_names[h_name]
-      if anchor_prefix_number > 1
-        h_name = anchor_prefix_number.to_s + '-' + h_name
-      end
-
-      level = h.name.gsub(/[hH]/, '').to_i
 
-      # Add anchors
-      anchor_element = %Q(<a class="anchor" id="#{h_name}" href="##{h_name}"><i class="fa fa-link"></i></a>)
-      # Add anchor element as the first child (before h.content)
-      h.children.before anchor_element
+    @doc               = Nokogiri::HTML::DocumentFragment.parse(data)
+    @toc               = nil
+    @anchor_names      = {}
+    @current_ancestors = ""
 
-      # Build TOC
-      toc        ||= Nokogiri::XML::DocumentFragment.parse('<div class="toc"><div class="toc-title">Table of Contents</div></div>')
-      tail       ||= toc.child
-      tail_level ||= 0
+    if @markup.sub_page && @markup.parent_page
+      @toc = @markup.parent_page.toc_data
+    else
+      @doc.css('h1,h2,h3,h4,h5,h6').each_with_index do |header, i|
+        next if header.content.empty?
+        # omit the first H1 (the page title) from the TOC if so configured
+        next if (i == 0 && header.name =~ /[Hh]1/) && @markup.wiki && @markup.wiki.h1_title
 
-      while tail_level < level
-        node       = Nokogiri::XML::Node.new('ul', doc)
-        tail       = tail.add_child(node)
-        tail_level += 1
-      end
-      while tail_level > level
-        tail       = tail.parent
-        tail_level -= 1
+        anchor_name = generate_anchor_name(header)
+        
+        add_anchor_to_header header, anchor_name
+        add_entry_to_toc     header, anchor_name
       end
-      node = Nokogiri::XML::Node.new('li', doc)
-      # % -> %25 so anchors work on Firefox. See issue #475
-      node.add_child(%Q{<a href="##{h_name}">#{h.content}</a>})
-      tail.add_child(node)
+
+      @toc  = @toc.to_xml(@markup.to_xml_opts) if @toc != nil
+      data  = @doc.to_xml(@markup.to_xml_opts)
+      
+    end
+ 
+    @markup.toc = @toc
+    data.gsub("[[_TOC_]]") do
+      @toc.nil? ? '' : @toc
     end
+  end
 
-    toc  = toc.to_xml(@markup.to_xml_opts) if toc != nil
-    data = doc.to_xml(@markup.to_xml_opts)
+  private
 
-    @markup.toc = toc
-    data.gsub("[[_TOC_]]") do
-      toc.nil? ? '' : toc
+  # Generates the anchor name from the given header element 
+  # removing all non alphanumeric characters, replacing them
+  # with single dashes.  
+  #
+  # Generates heading ancestry prefixing the headings
+  # ancestor names to the generated name.
+  #
+  # Prefixes duplicate anchors with an index
+  def generate_anchor_name(header)
+    name = header.content
+    level = header.name.gsub(/[hH]/, '').to_i
+
+    # normalize the header name
+    name.gsub!(/[^\d\w\u00C0-\u1FFF\u2C00-\uD7FF]/, "-")
+    name.gsub!(/-+/, "-")
+    name.gsub!(/^-/, "")
+    name.gsub!(/-$/, "")
+    name.downcase!
+
+    anchor_name = name
+
+    # Set and/or add the ancestors to the name
+    @current_ancestors = name if level == 1
+    anchor_name = (level == 1) ? name : "#{@current_ancestors}_#{name}"
+    @current_ancestors+= "_#{name}" if level > 1
+
+    # Ensure duplicate anchors have a unique prefix or the toc will break
+    index = increment_anchor_index(anchor_name)
+    anchor_name = "#{index}-#{anchor_name}" unless index.zero? # if the index is zero this name is unique
+
+    anchor_name
+  end
+
+  # Creates an anchor element with the given name and adds it before
+  # the given header element.
+  def add_anchor_to_header(header, name)
+    anchor_element = %Q(<a class="anchor" id="#{name}" href="##{name}"><i class="fa fa-link"></i></a>)
+    header.children.before anchor_element # Add anchor element before the header
+  end
+
+  # Adds an entry to the TOC for the given header.  The generated entry
+  # is a link to the given anchor name
+  def add_entry_to_toc(header, name)
+    @toc        ||= Nokogiri::XML::DocumentFragment.parse('<div class="toc"><div class="toc-title">Table of Contents</div></div>')
+    tail        ||= @toc.child
+    tail_level  ||= 0
+
+    level = header.name.gsub(/[hH]/, '').to_i
+
+    while tail_level < level
+      node       = Nokogiri::XML::Node.new('ul', @doc)
+      tail       = tail.add_child(node)
+      tail_level += 1
     end
+    
+    while tail_level > level
+      tail       = tail.parent
+      tail_level -= 1
+     end
+    node = Nokogiri::XML::Node.new('li', @doc)
+    # % -> %25 so anchors work on Firefox. See issue #475
+    node.add_child(%Q{<a href="##{name}">#{header.content}</a>})
+    tail.add_child(node)
+  end
+
+  # Increments the number of anchors with the given name
+  # and returns the current index
+  def increment_anchor_index(name)
+    @anchor_names = {} if @anchor_names.nil?
+    @anchor_names[name].nil? ? @anchor_names[name] = 0 : @anchor_names[name] += 1
   end
-end
+end

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

@@ -44,7 +44,7 @@ class Gollum::Filter::WSD < Gollum::Filter
   def render_wsd(code, style)
     response = Net::HTTP.post_form(URI.parse(WSD_URL), 'style' => style, 'message' => code)
     if response.body =~ /img: "(.+)"/
-      url = "http://www.websequencediagrams.com/#{$1}"
+      url = "//www.websequencediagrams.com/#{$1}"
       "<img src=\"#{url}\" />"
     else
       puts response.body

data/lib/gollum-lib/git_access.rb

@@ -13,13 +13,7 @@ module Gollum
     def initialize(path, page_file_dir = nil, bare = false)
       @page_file_dir = page_file_dir
       @path          = path
-      begin
-        @repo = Grit::Repo.new(path, { :is_bare => bare })
-      rescue Grit::InvalidGitRepositoryError
-        raise Gollum::InvalidGitRepositoryError
-      rescue Grit::NoSuchPathError
-        raise Gollum::NoSuchPathError
-      end
+      @repo = Gollum::Git::Repo.new(path, { :is_bare => bare })
       clear
     end
 
@@ -75,7 +69,7 @@ module Gollum
     #
     # ref - A String Git SHA or ref.
     #
-    # Returns a Grit::Commit.
+    # Returns a Gollum::Git::Commit.
     def commit(ref)
       if sha?(ref)
         get_cache(:commit, ref) { commit!(ref) }
@@ -117,7 +111,7 @@ module Gollum
     # Gets the String path to the Git repository.
     attr_reader :path
 
-    # Gets the Grit::Repo instance for the Git repository.
+    # Gets the Gollum::Git::Repo instance for the Git repository.
     attr_reader :repo
 
     # Gets a Hash cache of refs to commit SHAs.
@@ -132,9 +126,9 @@ module Gollum
     #
     attr_reader :tree_map
 
-    # Gets a Hash cache of commit SHAs to the Grit::Commit instance.
+    # Gets a Hash cache of commit SHAs to the Gollum::Git::Commit instance.
     #
-    #     {"abcd123" => <Grit::Commit>}
+    #     {"abcd123" => <Gollum::Git::Commit>}
     #
     attr_reader :commit_map
 
@@ -191,7 +185,7 @@ module Gollum
     #
     # sha - The string SHA of the Git commit.
     #
-    # Returns a Grit::Commit.
+    # Returns a Gollum::Git::Commit.
     def commit!(sha)
       @repo.commit(sha)
     end

data/lib/gollum-lib/macro.rb

@@ -0,0 +1,43 @@
+module Gollum
+  class Macro
+    # Find the macro named, create an instance of that, and return it
+    def self.instance(macro_name, wiki, page)
+      begin
+        self.const_get(macro_name).new(wiki, page)
+      rescue NameError
+        Unknown_Macro.new(macro_name)
+      end
+    end
+
+    def initialize(wiki, page)
+      @wiki = wiki
+      @page = page
+    end
+
+    def render(*_args)
+      raise ArgumentError,
+            "#{self.class} does not implement #render.  "+
+            "This is a bug in #{self.class}."
+    end
+    
+    protected
+    def html_error(s)
+      "<p class=\"gollum-error\">#{s}</p>"
+    end
+
+    # The special class we reserve for only the finest of screwups.  The
+    # underscore is to make sure nobody can define a real, callable macro
+    # with the same name, because that would be... exciting.
+    class Unknown_Macro < Macro
+      def initialize(macro_name)
+        @macro_name = macro_name
+      end
+
+      def render(*_args)
+        "!!!Unknown macro: #{@macro_name}!!!"
+      end
+    end
+  end
+end
+
+Dir[File.expand_path('../macro/*.rb', __FILE__)].each { |f| require f }

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

@@ -0,0 +1,11 @@
+module Gollum
+  class Macro
+    class AllPages < Gollum::Macro
+      def render
+        if @wiki.pages.size > 0
+          '<ul id="pages">' + @wiki.pages.map { |p| "<li>#{p.name}</li>" }.join + '</ul>'
+        end
+      end
+    end
+  end
+end

data/lib/gollum-lib/markup.rb

@@ -53,6 +53,9 @@ module Gollum
     attr_reader :sanitize
     attr_reader :format
     attr_reader :wiki
+    attr_reader :page
+    attr_reader :parent_page
+    attr_reader :sub_page
     attr_reader :name
     attr_reader :include_levels
     attr_reader :to_xml_opts
@@ -72,6 +75,7 @@ module Gollum
         @format      = page.format
         @sub_page    = page.sub_page
         @parent_page = page.parent_page
+        @page        = page
         @dir         = ::File.dirname(page.path)
       end
       @metadata    = nil
@@ -105,7 +109,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)
       # First we extract the data through the chain...
       filter_chain.each do |filter|
         data = filter.extract(data)

data/lib/gollum-lib/page.rb

@@ -84,10 +84,11 @@ module Gollum
     #
     # Returns a newly initialized Gollum::Page.
     def initialize(wiki)
-      @wiki        = wiki
-      @blob        = @header = @footer = @sidebar = nil
-      @doc         = nil
-      @parent_page = nil
+      @wiki           = wiki
+      @blob           = @header = @footer = @sidebar = nil
+      @formatted_data = nil
+      @doc            = nil
+      @parent_page    = nil
     end
 
     # Public: The on-disk filename of the page including extension.
@@ -216,10 +217,18 @@ module Gollum
     #
     # Returns the String data.
     def formatted_data(encoding = nil, include_levels = 10, &block)
-      @blob && markup_class.render(historical?, encoding, include_levels) do |doc|
-        @doc = doc
-        yield doc if block_given?
+      return nil unless @blob
+
+      if @formatted_data && @doc then
+        yield @doc if block_given?
+      else
+        @formatted_data = markup_class.render(historical?, encoding, include_levels) do |doc|
+          @doc = doc
+          yield doc if block_given?
+        end
       end
+
+      @formatted_data
     end
 
     # Public: The table of contents of the page.
@@ -257,7 +266,7 @@ module Gollum
 
     # Public: The current version of the page.
     #
-    # Returns the Grit::Commit.
+    # Returns the Gollum::Git::Commit.
     attr_reader :version
 
     # Public: All of the versions that have touched the Page.
@@ -265,20 +274,11 @@ module Gollum
     # options - The options Hash:
     #           :page     - The Integer page number (default: 1).
     #           :per_page - The Integer max count of items to return.
-    #           :follow   - Follow's a file across renames, but falls back
-    #                       to a slower Grit native call (implicit in repo.git.log).  (default: false)
+    #           :follow   - Follow's a file across renames, slower.  (default: false)
     #
-    # Returns an Array of Grit::Commit.
+    # Returns an Array of Gollum::Git::Commit.
     def versions(options = {})
-      if options[:follow]
-        options[:pretty] = 'raw'
-        options.delete :max_count
-        options.delete :skip
-        log = @wiki.repo.git.log(options, @wiki.ref, "--", @path)
-        Grit::Commit.list_from_string(@wiki.repo, log)
-      else
-        @wiki.repo.log(@wiki.ref, @path, log_pagination_options(options))
-      end
+      @wiki.repo.git.versions_for_path(@path, @wiki.ref, log_pagination_options(options))
     end
 
     # Public: The first 7 characters of the current version.
@@ -365,7 +365,7 @@ module Gollum
     # Returns the Gollum::Wiki containing the page.
     attr_reader :wiki
 
-    # Set the Grit::Commit version of the page.
+    # Set the Gollum::Git::Commit version of the page.
     #
     # Returns nothing.
     attr_writer :version
@@ -379,12 +379,12 @@ module Gollum
     def find(name, version, dir = nil, exact = false)
       map = @wiki.tree_map_for(version.to_s)
       if page = find_page_in_tree(map, name, dir, exact)
-        page.version    = version.is_a?(Grit::Commit) ?
+        page.version    = version.is_a?(Gollum::Git::Commit) ?
             version : @wiki.commit_for(version)
         page.historical = page.version.to_s == version.to_s
         page
       end
-    rescue Grit::GitRuby::Repository::NoSuchShaFound
+    rescue Gollum::Git::NoSuchShaFound
     end
 
     # Find a page in a given tree.
@@ -414,7 +414,7 @@ module Gollum
 
     # Populate the Page 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 page file.
     #
     # Returns the populated Gollum::Page.
@@ -427,7 +427,7 @@ module Gollum
     # The full directory path for the given tree.
     #
     # treemap - The Hash treemap containing parentage information.
-    # tree    - The Grit::Tree for which to compute the path.
+    # tree    - The Gollum::Git::Tree for which to compute the path.
     #
     # Returns the String path.
     def tree_path(treemap, tree)

data/lib/gollum-lib/wiki.rb

@@ -14,16 +14,16 @@ module Gollum
       attr_writer :markup_classes
 
       # Sets the default ref for the wiki.
-      attr_accessor :default_ref
+      attr_writer :default_ref
 
       # Sets the default name for commits.
-      attr_accessor :default_committer_name
+      attr_writer :default_committer_name
 
       # Sets the default email for commits.
-      attr_accessor :default_committer_email
+      attr_writer :default_committer_email
 
       # Array of chars to substitute whitespace for when trying to locate file in git repo.
-      attr_accessor :default_ws_subs
+      attr_writer :default_ws_subs
 
       # Sets sanitization options. Set to false to deactivate
       # sanitization altogether.
@@ -35,7 +35,7 @@ module Gollum
 
       # Hash for setting different default wiki options
       # These defaults can be overridden by options passed directly to initialize()
-      attr_accessor :default_options
+      attr_writer :default_options
 
       # Gets the page class used by all instances of this Wiki.
       # Default: Gollum::Page.
@@ -105,14 +105,27 @@ module Gollum
         end
         @history_sanitization
       end
-    end
 
-    self.default_ref             = 'master'
-    self.default_committer_name  = 'Anonymous'
-    self.default_committer_email = 'anon@anon.com'
+      def default_ref
+        @default_ref || 'master'
+      end
 
-    self.default_ws_subs = ['_', '-']
-    self.default_options = {}
+      def default_committer_name
+        @default_committer_name || 'Anonymous'
+      end
+
+      def default_committer_email
+        @default_committer_email || 'anon@anon.com'
+      end
+
+      def default_ws_subs
+        @default_ws_subs || ['_', '-']
+      end
+
+      def default_options
+        @default_options || {}
+      end
+    end
 
     # The String base path to prefix to internal links. For example, when set
     # to "/wiki", the page "Hobbit" will be linked as "/wiki/Hobbit". Defaults
@@ -235,7 +248,7 @@ module Gollum
       @allow_uploads        = options.fetch :allow_uploads, false
       @per_page_uploads     = options.fetch :per_page_uploads, false
       @filter_chain         = options.fetch :filter_chain,
-                                            [:Metadata, :PlainText, :TOC, :RemoteCode, :Code, :Sanitize, :WSD, :Tags, :Render]
+                                            [:Metadata, :PlainText, :TOC, :RemoteCode, :Code, :Macro, :Sanitize, :WSD, :Tags, :Render]
     end
 
     # Public: check whether the wiki's git repo exists on the filesystem.
@@ -310,7 +323,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,
@@ -322,19 +335,19 @@ module Gollum
     # Gollum::Committer instance if this is part of a batch update.
     def write_page(name, format, data, commit = {}, dir = '')
       # spaces must be dashes
-      name.gsub!(' ', '-')
-      dir.gsub!(' ', '-')
+      sanitized_name = name.gsub(' ', '-')
+      sanitized_dir  = dir.gsub(' ', '-')
 
       multi_commit = !!commit[:committer]
       committer    = multi_commit ? commit[:committer] : Committer.new(self, commit)
 
-      filename = Gollum::Page.cname(name)
+      filename = Gollum::Page.cname(sanitized_name)
 
-      committer.add_to_index(dir, filename, format, data)
+      committer.add_to_index(sanitized_dir, filename, format, data)
 
       committer.after_commit do |index, sha|
         @access.refresh
-        index.update_working_dir(dir, filename, format)
+        index.update_working_dir(sanitized_dir, filename, format)
       end
 
       multi_commit ? committer : committer.commit
@@ -348,7 +361,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,
@@ -404,7 +417,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,
@@ -447,7 +460,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,
@@ -486,7 +499,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.
     #
     # Returns a String SHA1 of the new commit, or nil if the reverse diff does
     # not apply.
@@ -576,7 +589,7 @@ module Gollum
       tree_map_for(ref || @ref).inject(0) do |num, entry|
         num + (@page_class.valid_page_name?(entry.name) ? 1 : 0)
       end
-    rescue Grit::GitRuby::Repository::NoSuchShaFound
+    rescue Gollum::Git::NoSuchShaFound
       0
     end
 
@@ -586,27 +599,22 @@ module Gollum
     #
     # Returns an Array with Objects of page name and count of matches
     def search(query)
-      args = [{}, '-i', '-c', query, @ref, '--']
-      args << '--' << @page_file_dir if @page_file_dir
-
+      options = {:path => page_file_dir, :ref => ref}
       results = {}
-
-      @repo.git.grep(*args).split("\n").each do |line|
-        result             = line.split(':')
-        result_1           = result[1]
+      @repo.git.grep(query, options).each do |hit|
+        name = hit[:name]
+        count = hit[:count]
         # Remove ext only from known extensions.
         # test.pdf => test.pdf, test.md => test
-        file_name          = Page::valid_page_name?(result_1) ? result_1.chomp(::File.extname(result_1)) :
-            result_1
-        results[file_name] = result[2].to_i
+        file_name = Page::valid_page_name?(name) ? name.chomp(::File.extname(name)) : name
+        results[file_name] = count
       end
 
       # Use git ls-files '*query*' to search for file names. Grep only searches file content.
       # Spaces are converted to dashes when saving pages to disk.
-      @repo.git.ls_files({}, "*#{ query.gsub(' ', '-') }*").split("\n").each do |line|
+      @repo.git.ls_files(query.gsub(' ','-'), options).each do |path|
         # Remove ext only from known extensions.
-        file_name          = Page::valid_page_name?(line) ? line.chomp(::File.extname(line)) :
-            line
+        file_name          = Page::valid_page_name?(path) ? path.chomp(::File.extname(path)) : path
         # If there's not already a result for file_name then
         # the value is nil and nil.to_i is 0.
         results[file_name] = results[file_name].to_i + 1;
@@ -623,11 +631,22 @@ module Gollum
     #           :page     - The Integer page number (default: 1).
     #           :per_page - The Integer max count of items to return.
     #
-    # Returns an Array of Grit::Commit.
+    # Returns an Array of Gollum::Git::Commit.
     def log(options = {})
       @repo.log(@ref, nil, log_pagination_options(options))
     end
 
+    # Returns the latest changes in the wiki (globally)
+    #
+    # options - The options Hash:
+    #           :max_count  - The Integer number of items to return.
+    #
+    # Returns an Array of Gollum::Git::Commit.
+    def latest_changes(options={})
+      max_count = options.fetch(:max_count, 10)      
+      @repo.log(@ref, nil, options)
+    end
+    
     # Public: Refreshes just the cached Git reference data.  This should
     # be called after every Gollum update.
     #
@@ -730,9 +749,9 @@ module Gollum
     #
     #########################################################################
 
-    # The Grit::Repo associated with the wiki.
+    # The Gollum::Git::Repo associated with the wiki.
     #
-    # Returns the Grit::Repo.
+    # Returns the Gollum::Git::Repo.
     attr_reader :repo
 
     # The String path to the Git repository that holds the Gollum site.
@@ -874,10 +893,10 @@ module Gollum
     #
     # ref - A string ref or SHA pointing to a valid commit.
     #
-    # Returns a Grit::Commit instance.
+    # Returns a Gollum::Git::Commit instance.
     def commit_for(ref)
       @access.commit(ref)
-    rescue Grit::GitRuby::Repository::NoSuchShaFound
+    rescue Gollum::Git::NoSuchShaFound
     end
 
     # Finds a full listing of files and their blob SHA for a given ref.  Each
@@ -894,7 +913,7 @@ module Gollum
       else
         @access.tree(ref)
       end
-    rescue Grit::GitRuby::Repository::NoSuchShaFound
+    rescue Gollum::Git::NoSuchShaFound
       []
     end