gitlab-gollum-lib 1.0.0

data/lib/gollum-lib/pagination.rb

@@ -0,0 +1,62 @@
+# ~*~ encoding: utf-8 ~*~
+module Gollum
+  module Pagination
+    def self.included(klass)
+      klass.extend ClassMethods
+      class << klass
+        # Default Integer max count of items to return in git commands.
+        attr_accessor :per_page
+      end
+      klass.per_page = 30
+    end
+
+    module ClassMethods
+      # Turns a page number into an offset number for the git skip option.
+      #
+      # page - Integer page number.
+      #
+      # Returns an Integer.
+      def page_to_skip(page)
+        ([1, page.to_i].max - 1) * per_page
+      end
+
+      # Fills in git-specific options for the log command using simple
+      # pagination options.
+      #
+      # options - Hash of options:
+      #           page - Optional Integer page number (default: 1)
+      #           per_page - Optional Integer max count of items to return.
+      #                      Defaults to #per_class class method.
+      #
+      # Returns Hash with :max_count and :skip keys.
+      def log_pagination_options(options = {})
+        skip = page_to_skip(options.delete(:page))
+        options[:max_count] = [options.delete(:per_page).to_i, per_page].max
+        options[:skip]      = skip if skip > 0
+        options
+      end
+    end
+
+    # Turns a page number into an offset number for the git skip option.
+    #
+    # page - Integer page number.
+    #
+    # Returns an Integer.
+    def page_to_skip(page)
+      self.class.page_to_skip(page)
+    end
+
+    # Fills in git-specific options for the log command using simple
+    # pagination options.
+    #
+    # options - Hash of options:
+    #           page - Optional Integer page number (default: 1)
+    #           per_page - Optional Integer max count of items to return.
+    #                      Defaults to #per_class class method.
+    #
+    # Returns Hash with :max_count and :skip keys.
+    def log_pagination_options(options = {})
+      self.class.log_pagination_options(options)
+    end
+  end
+end

data/lib/gollum-lib/remote_code.rb

@@ -0,0 +1,39 @@
+# ~*~ encoding: utf-8 ~*~
+require 'net/http'
+require 'net/https' # ruby 1.8.7 fix, remove at upgrade
+require 'uri'
+require 'open-uri'
+
+module Gollum
+  class RemoteCode
+    def initialize path
+      raise(ArgumentError, 'path is nil or empty') if path.nil? or path.empty?
+      @uri = URI(path)
+    end
+
+    def contents
+      @contents ||= req @uri
+    end
+
+    private
+
+      def req uri, cut = 1
+        return "Too many redirects or retries" if cut >= 10
+        http = Net::HTTP.new uri.host, uri.port
+        http.use_ssl = true
+        resp = http.get uri.path, {
+          'Accept'        => 'text/plain',
+          'Cache-Control' => 'no-cache',
+          'Connection'    => 'keep-alive',
+          'User-Agent'    => 'Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:15.0) Gecko/20100101 Firefox/15.0'
+        }
+        code = resp.code.to_i
+        return resp.body if code == 200
+        return "Not Found" if code == 404
+        return "Unhandled Response Code #{code}" unless code == 304 or not resp.header['location'].nil?
+        loc = URI.parse resp.header['location']
+        uri2 = loc.relative? ? (uri + loc) : loc # overloads (+)
+        req uri2, (cut + 1)
+      end
+  end
+end

data/lib/gollum-lib/sanitization.rb

@@ -0,0 +1,176 @@
+# ~*~ encoding: utf-8 ~*~
+module Gollum
+  # Encapsulate sanitization options.
+  #
+  # This class does not yet support all options of Sanitize library.
+  # See http://github.com/rgrove/sanitize/.
+  class Sanitization
+    # Default whitelisted elements.
+    ELEMENTS = [
+      'a', 'abbr', 'acronym', 'address', 'area', 'b', 'big',
+      'blockquote', 'br', 'button', 'caption', 'center', 'cite',
+      'code', 'col', 'colgroup', 'dd', 'del', 'dfn', 'dir',
+      'div', 'dl', 'dt', 'em', 'fieldset', 'font', 'form', 'h1',
+      'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'input',
+      'ins', 'kbd', 'label', 'legend', 'li', 'map', 'menu',
+      'ol', 'optgroup', 'option', 'p', 'pre', 'q', 's', 'samp',
+      'select', 'small', 'span', 'strike', 'strong', 'sub',
+      'sup', 'table', 'tbody', 'td', 'textarea', 'tfoot', 'th',
+      'thead', 'tr', 'tt', 'u', 'ul', 'var'
+    ].freeze
+
+    # Default whitelisted attributes.
+    ATTRIBUTES = {
+      'a'   => ['href'],
+      'img' => ['src'],
+      :all  => ['abbr', 'accept', 'accept-charset',
+                'accesskey', 'action', 'align', 'alt', 'axis',
+                'border', 'cellpadding', 'cellspacing', 'char',
+                'charoff', 'class', 'charset', 'checked', 'cite',
+                'clear', 'cols', 'colspan', 'color',
+                'compact', 'coords', 'datetime', 'dir',
+                'disabled', 'enctype', 'for', 'frame',
+                'headers', 'height', 'hreflang',
+                'hspace', 'id', 'ismap', 'label', 'lang',
+                'longdesc', 'maxlength', 'media', 'method',
+                'multiple', 'name', 'nohref', 'noshade',
+                'nowrap', 'prompt', 'readonly', 'rel', 'rev',
+                'rows', 'rowspan', 'rules', 'scope',
+                'selected', 'shape', 'size', 'span',
+                'start', 'summary', 'tabindex', 'target',
+                'title', 'type', 'usemap', 'valign', 'value',
+                'vspace', 'width']
+    }.freeze
+
+    # Default whitelisted protocols for URLs.
+    PROTOCOLS = {
+      'a'   => {'href' => ['http', 'https', 'mailto', 'ftp', 'irc', 'apt', :relative]},
+      'img' => {'src'  => ['http', 'https', :relative]},
+      'form' => {'action' => ['http', 'https', :relative]}
+    }.freeze
+
+    ADD_ATTRIBUTES = lambda do |env, node|
+      if add = env[:config][:add_attributes][node.name]
+        add.each do |key, value|
+          node[key] = value
+        end
+      end
+    end
+
+    # Default elements whose contents will be removed in addition
+    # to the elements themselve
+    REMOVE_CONTENTS = [
+      'script',
+      'style'
+      ].freeze
+
+    # Default transformers to force @id attributes with 'wiki-' prefix
+    TRANSFORMERS = [
+      lambda do |env|
+        node = env[:node]
+        return if env[:is_whitelisted] || !node.element?
+        prefix = env[:config][:id_prefix]
+        found_attrs = %w(id name).select do |key|
+          if value = node[key]
+            node[key] = value.gsub(/\A(#{prefix})?/, prefix)
+          end
+        end
+        if found_attrs.size > 0
+          ADD_ATTRIBUTES.call(env, node)
+          {}
+        end
+      end,
+      lambda do |env|
+        node = env[:node]
+        return unless value = node['href']
+        prefix = env[:config][:id_prefix]
+        node['href'] = value.gsub(/\A\#(#{prefix})?/, '#'+prefix)
+        ADD_ATTRIBUTES.call(env, node)
+        {}
+      end
+    ].freeze
+
+    # Gets an Array of whitelisted HTML elements.  Default: ELEMENTS.
+    attr_reader :elements
+
+    # Gets a Hash describing which attributes are allowed in which HTML
+    # elements.  Default: ATTRIBUTES.
+    attr_reader :attributes
+
+    # Gets a Hash describing which URI protocols are allowed in HTML
+    # attributes.  Default: PROTOCOLS
+    attr_reader :protocols
+
+    # Gets a Hash describing which URI protocols are allowed in HTML
+    # attributes.  Default: TRANSFORMERS
+    attr_reader :transformers
+
+    # Gets or sets a String prefix which is added to ID attributes.
+    # Default: ''
+    attr_accessor :id_prefix
+
+    # Gets a Hash describing HTML attributes that Sanitize should add.
+    # Default: {}
+    attr_reader :add_attributes
+
+    # Gets an Array of element names whose contents will be removed in addition
+    # to the elements themselves. Default: REMOVE_CONTENTS
+    attr_reader :remove_contents
+
+    # Sets a boolean determining whether Sanitize allows HTML comments in the
+    # output.  Default: false.
+    attr_writer :allow_comments
+
+    def initialize
+      @elements         = ELEMENTS.dup
+      @attributes       = ATTRIBUTES.dup
+      @protocols        = PROTOCOLS.dup
+      @transformers     = TRANSFORMERS.dup
+      @add_attributes   = {}
+      @remove_contents  = REMOVE_CONTENTS.dup
+      @allow_comments   = false
+      @id_prefix        = ''
+      yield self if block_given?
+    end
+
+    # Determines if Sanitize should allow HTML comments.
+    #
+    # Returns True if comments are allowed, or False.
+    def allow_comments?
+      !!@allow_comments
+    end
+
+    # Modifies the current Sanitization instance to sanitize older revisions
+    # of pages.
+    #
+    # Returns a Sanitization instance.
+    def history_sanitization
+      self.class.new do |sanitize|
+        sanitize.add_attributes['a'] = {'rel' => 'nofollow'}
+      end
+    end
+
+    # Builds a Hash of options suitable for Sanitize.clean.
+    #
+    # Returns a Hash.
+    def to_hash
+      { :elements         => elements,
+        :attributes       => attributes,
+        :protocols        => protocols,
+        :add_attributes   => add_attributes,
+        :remove_contents  => remove_contents,
+        :allow_comments   => allow_comments?,
+        :transformers     => transformers,
+        :id_prefix        => id_prefix
+      }
+    end
+
+    # Builds a Sanitize instance from the current options.
+    #
+    # Returns a Sanitize instance.
+    def to_sanitize
+      Sanitize.new(to_hash)
+    end
+  end
+end
+

data/lib/gollum-lib/web_sequence_diagram.rb

@@ -0,0 +1,44 @@
+# ~*~ encoding: utf-8 ~*~
+require 'net/http'
+require 'uri'
+require 'open-uri'
+
+class Gollum::WebSequenceDiagram
+  WSD_URL = "http://www.websequencediagrams.com/index.php"
+
+  # Initialize a new WebSequenceDiagram object.
+  #
+  # code  - The String containing the sequence diagram markup.
+  # style - The String containing the rendering style.
+  #
+  # Returns a new Gollum::WebSequenceDiagram object
+  def initialize(code, style)
+    @code = code
+    @style = style
+    @tag = ""
+
+    render
+  end
+
+  # Render the sequence diagram on the remote server and store the url to
+  # the rendered image.
+  #
+  # Returns nil.
+  def render
+    response = Net::HTTP.post_form(URI.parse(WSD_URL), 'style' => @style, 'message' => @code)
+    if response.body =~ /img: "(.+)"/
+      url = "http://www.websequencediagrams.com/#{$1}"
+      @tag = "<img src=\"#{url}\" />"
+    else
+      puts response.body
+      @tag ="Sorry, unable to render sequence diagram at this time."
+    end
+  end
+
+  # Gets the HTML IMG tag for the sequence diagram.
+  #
+  # Returns a String containing the IMG tag.
+  def to_tag
+    @tag
+  end
+end

data/lib/gollum-lib/wiki.rb

@@ -0,0 +1,833 @@
+# ~*~ encoding: utf-8 ~*~
+module Gollum
+  class Wiki
+    include Pagination
+
+    class << self
+      # Sets the page class used by all instances of this Wiki.
+      attr_writer :page_class
+
+      # Sets the file class used by all instances of this Wiki.
+      attr_writer :file_class
+
+      # Sets the markup class used by all instances of this Wiki.
+      attr_writer :markup_classes
+
+      # Sets the default ref for the wiki.
+      attr_accessor :default_ref
+
+      # Sets the default name for commits.
+      attr_accessor :default_committer_name
+
+      # Sets the default email for commits.
+      attr_accessor :default_committer_email
+
+      # Array of chars to substitute whitespace for when trying to locate file in git repo.
+      attr_accessor :default_ws_subs
+
+      # Sets sanitization options. Set to false to deactivate
+      # sanitization altogether.
+      attr_writer :sanitization
+
+      # Sets sanitization options. Set to false to deactivate
+      # sanitization altogether.
+      attr_writer :history_sanitization
+
+      # Hash for setting different default wiki options
+      # These defaults can be overridden by options passed directly to initialize()
+      attr_accessor :default_options
+
+      # Gets the page class used by all instances of this Wiki.
+      # Default: Gollum::Page.
+      def page_class
+        @page_class ||
+          if superclass.respond_to?(:page_class)
+            superclass.page_class
+          else
+            ::Gollum::Page
+          end
+      end
+
+      # Gets the file class used by all instances of this Wiki.
+      # Default: Gollum::File.
+      def file_class
+        @file_class ||
+          if superclass.respond_to?(:file_class)
+            superclass.file_class
+          else
+            ::Gollum::File
+          end
+      end
+
+      # Gets the markup class used by all instances of this Wiki.
+      # Default: Gollum::Markup
+      def markup_classes
+        @markup_classes ||=
+          if superclass.respond_to?(:markup_classes)
+            superclass.markup_classes
+          else
+            Hash.new(::Gollum::Markup)
+          end
+      end
+
+      # Gets the default markup class used by all instances of this Wiki.
+      # Kept for backwards compatibility until Gollum v2.x
+      def markup_class(language=:default)
+        markup_classes[language]
+      end
+
+      # Sets the default markup class used by all instances of this Wiki.
+      # Kept for backwards compatibility until Gollum v2.x
+      def markup_class=(default)
+        @markup_classes = Hash.new(default).update(markup_classes)
+        default
+      end
+
+      alias_method :default_markup_class, :markup_class
+      alias_method :default_markup_class=, :markup_class=
+
+      # Gets the default sanitization options for current pages used by
+      # instances of this Wiki.
+      def sanitization
+        if @sanitization.nil?
+          @sanitization = Sanitization.new
+        end
+        @sanitization
+      end
+
+      # Gets the default sanitization options for older page revisions used by
+      # instances of this Wiki.
+      def history_sanitization
+        if @history_sanitization.nil?
+          @history_sanitization = sanitization ?
+            sanitization.history_sanitization  :
+            false
+        end
+        @history_sanitization
+      end
+    end
+
+    self.default_ref = 'master'
+    self.default_committer_name  = 'Anonymous'
+    self.default_committer_email = 'anon@anon.com'
+
+    self.default_ws_subs = ['_','-']
+    self.default_options = {}
+
+    # 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
+    # to "/".
+    attr_reader :base_path
+
+    # Gets the sanitization options for current pages used by this Wiki.
+    attr_reader :sanitization
+
+    # Gets the sanitization options for older page revisions used by this Wiki.
+    attr_reader :history_sanitization
+
+    # Gets the String ref in which all page files reside.
+    attr_reader :ref
+
+    # Gets the String directory in which all page files reside.
+    attr_reader :page_file_dir
+
+    # Gets the Array of chars to sub for ws in filenames.
+    attr_reader :ws_subs
+
+    # Gets the boolean live preview value.
+    attr_reader :live_preview
+
+    # Injects custom css from custom.css in root repo.
+    # Defaults to false
+    attr_reader :css
+
+    # Sets page title to value of first h1
+    # Defaults to false
+    attr_reader :h1_title
+    
+    # Gets the custom index page for / and subdirs (e.g. foo/)
+    attr_reader :index_page
+    
+    # Gets side on which the sidebar should be shown
+    attr_reader :bar_side
+
+    # Public: Initialize a new Gollum Repo.
+    #
+    # path    - The String path to the Git repository that holds the Gollum
+    #           site.
+    # options - Optional Hash:
+    #           :universal_toc - Table of contents on all pages.  Default: false
+    #           :live_preview  - Livepreview editing for markdown files. Default: true
+    #           :base_path     - String base path for all Wiki links.
+    #                            Default: "/"
+    #           :page_class    - The page Class. Default: Gollum::Page
+    #           :file_class    - The file Class. Default: Gollum::File
+    #           :markup_classes - A hash containing the markup Classes for each
+    #                             document type. Default: { Gollum::Markup }
+    #           :sanitization  - An instance of Sanitization.
+    #           :page_file_dir - String the directory in which all page files reside
+    #           :ref - String the repository ref to retrieve pages from
+    #           :ws_subs       - Array of chars to sub for ws in filenames.
+    #           :mathjax       - Set to false to disable mathjax.
+    #           :user_icons    - Enable user icons on the history page. [gravatar, identicon, none].
+    #                            Default: none
+    #           :show_all      - Show all files in file view, not just valid pages.
+    #                            Default: false
+    #           :collapse_tree - Start with collapsed file view. Default: false
+    #           :css           - Include the custom.css file from the repo.
+    #           :h1_title      - Concatenate all h1's on a page to form the
+    #                            page title.
+    #           :index_page    - The default page to retrieve or create if the 
+    #                            a directory is accessed.
+    #           :bar_side      - Where the sidebar should be displayed, may be:
+    #                             - :left
+    #                             - :right
+    #
+    # Returns a fresh Gollum::Repo.
+    def initialize(path, options = {})
+      options = self.class.default_options.merge(options)
+      if path.is_a?(GitAccess)
+        options[:access] = path
+        path             = path.path
+      end
+
+      # Use .fetch instead of ||
+      #
+      # o = { :a => false }
+      # o[:a] || true # => true
+      # o.fetch :a, true # => false
+
+      @path                 = path
+      @repo_is_bare         = options.fetch :repo_is_bare, nil
+      @page_file_dir        = options.fetch :page_file_dir, nil
+      @access               = options.fetch :access, GitAccess.new(path, @page_file_dir, @repo_is_bare)
+      @base_path            = options.fetch :base_path, "/"
+      @page_class           = options.fetch :page_class, self.class.page_class
+      @file_class           = options.fetch :file_class, self.class.file_class
+      @markup_classes       = options.fetch :markup_classes, self.class.markup_classes
+      @repo                 = @access.repo
+      @ref                  = options.fetch :ref, self.class.default_ref
+      @sanitization         = options.fetch :sanitization, self.class.sanitization
+      @ws_subs              = options.fetch :ws_subs, self.class.default_ws_subs
+      @history_sanitization = options.fetch :history_sanitization, self.class.history_sanitization
+      @live_preview         = options.fetch :live_preview, true
+      @universal_toc        = options.fetch :universal_toc, false
+      @mathjax              = options.fetch :mathjax, false
+      @show_all             = options.fetch :show_all, false
+      @collapse_tree        = options.fetch :collapse_tree, false
+      @css                  = options.fetch :css, false
+      @h1_title             = options.fetch :h1_title, false
+      @index_page           = options.fetch :index_page, 'Home'
+      @bar_side             = options.fetch :sidebar, :right
+      @user_icons           = ['gravatar', 'identicon'].include?( options[:user_icons] ) ?
+                              options[:user_icons] : 'none'
+    end
+
+    # Public: check whether the wiki's git repo exists on the filesystem.
+    #
+    # Returns true if the repo exists, and false if it does not.
+    def exist?
+      @access.exist?
+    end
+
+    # Public: Get the formatted page for a given page name, version, and dir.
+    #
+    # name    - The human or canonical String page name of the wiki page.
+    # version - The String version ID to find (default: @ref).
+    # dir     - The directory String relative to the repo.
+    #
+    # Returns a Gollum::Page or nil if no matching page was found.
+    def page(name, version = @ref, dir = nil, exact = false)
+      version = @ref if version.nil?
+      @page_class.new(self).find(name, version, dir, exact)
+    end
+
+    # Public: Convenience method instead of calling page(name, nil, dir).
+    #
+    # name    - The human or canonical String page name of the wiki page.
+    # version - The String version ID to find (default: @ref).
+    # dir     - The directory String relative to the repo.
+    #
+    # Returns a Gollum::Page or nil if no matching page was found.
+    def paged(name, dir = nil, exact = false, version = @ref)
+      page(name, version, dir, exact)
+    end
+
+    # Public: Get the static file for a given name.
+    #
+    # name    - The full String pathname to the file.
+    # version - The String version ID to find (default: @ref).
+    #
+    # Returns a Gollum::File or nil if no matching file was found.
+    def file(name, version = @ref)
+      @file_class.new(self).find(name, version)
+    end
+
+    # Public: Create an in-memory Page with the given data and format. This
+    # is useful for previewing what content will look like before committing
+    # it to the repository.
+    #
+    # name   - The String name of the page.
+    # format - The Symbol format of the page.
+    # data   - The new String contents of the page.
+    #
+    # Returns the in-memory Gollum::Page.
+    def preview_page(name, data, format)
+      page = @page_class.new(self)
+      ext  = @page_class.format_to_ext(format.to_sym)
+      name = @page_class.cname(name) + '.' + ext
+      blob = OpenStruct.new(:name => name, :data => data, :is_symlink => false)
+      page.populate(blob)
+      page.version = @access.commit('master')
+      page
+    end
+
+    # Public: Write a new version of a page to the Gollum repo root.
+    #
+    # name   - The String name of the page.
+    # format - The Symbol format of the page.
+    # data   - The new String contents of the page.
+    # commit - The commit Hash details:
+    #          :message   - The String commit message.
+    #          :name      - The String author full name.
+    #          :email     - The String email address.
+    #          :parent    - Optional Grit::Commit parent to this update.
+    #          :tree      - Optional String SHA of the tree to create the
+    #                       index from.
+    #          :committer - Optional Gollum::Committer instance.  If provided,
+    #                       assume that this operation is part of batch of
+    #                       updates and the commit happens later.
+    # dir    - The String subdirectory of the Gollum::Page without any
+    #          prefix or suffix slashes (e.g. "foo/bar").
+    # Returns the String SHA1 of the newly written version, or the
+    # 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!(' ', '-')
+
+      multi_commit = false
+
+      committer = if obj = commit[:committer]
+        multi_commit = true
+        obj
+      else
+        Committer.new(self, commit)
+      end
+
+      filename = Gollum::Page.cname(name)
+
+      committer.add_to_index(dir, filename, format, data)
+
+      committer.after_commit do |index, sha|
+        @access.refresh
+        index.update_working_dir(dir, filename, format)
+      end
+
+      multi_commit ? committer : committer.commit
+    end
+
+    # Public: Rename an existing page without altering content.
+    #
+    # page   - The Gollum::Page to update.
+    # rename - The String extension-less full path of the page (leading '/' is ignored).
+    # commit - The commit Hash details:
+    #          :message   - The String commit message.
+    #          :name      - The String author full name.
+    #          :email     - The String email address.
+    #          :parent    - Optional Grit::Commit parent to this update.
+    #          :tree      - Optional String SHA of the tree to create the
+    #                       index from.
+    #          :committer - Optional Gollum::Committer instance.  If provided,
+    #                       assume that this operation is part of batch of
+    #                       updates and the commit happens later.
+    #
+    # Returns the String SHA1 of the newly written version, or the
+    # Gollum::Committer instance if this is part of a batch update.
+    # Returns false if the operation is a NOOP.
+    def rename_page(page, rename, commit = {})
+      return false if page.nil?
+      return false if rename.nil? or rename.empty?
+
+      (target_dir, target_name) = ::File.split(rename)
+      (source_dir, source_name) = ::File.split(page.path)
+      source_name = page.filename_stripped
+
+      # File.split gives us relative paths with ".", commiter.add_to_index doesn't like that.
+      target_dir = '' if target_dir == '.'
+      source_dir = '' if source_dir == '.'
+      target_dir = target_dir.gsub(/^\//, '')
+
+      # if the rename is a NOOP, abort
+      if source_dir == target_dir and source_name == target_name
+        return false
+      end
+
+      multi_commit = false
+      committer = if obj = commit[:committer]
+        multi_commit = true
+        obj
+      else
+        Committer.new(self, commit)
+      end
+
+      committer.delete(page.path)
+      committer.add_to_index(target_dir, target_name, page.format, page.raw_data, :allow_same_ext)
+
+      committer.after_commit do |index, sha|
+        @access.refresh
+        index.update_working_dir(source_dir, source_name, page.format)
+        index.update_working_dir(target_dir, target_name, page.format)
+      end
+
+      multi_commit ? committer : committer.commit
+    end
+
+    # Public: Update an existing page with new content. The location of the
+    # page inside the repository will not change. If the given format is
+    # different than the current format of the page, the filename will be
+    # changed to reflect the new format.
+    #
+    # page   - The Gollum::Page to update.
+    # name   - The String extension-less name of the page.
+    # format - The Symbol format of the page.
+    # data   - The new String contents of the page.
+    # commit - The commit Hash details:
+    #          :message   - The String commit message.
+    #          :name      - The String author full name.
+    #          :email     - The String email address.
+    #          :parent    - Optional Grit::Commit parent to this update.
+    #          :tree      - Optional String SHA of the tree to create the
+    #                       index from.
+    #          :committer - Optional Gollum::Committer instance.  If provided,
+    #                       assume that this operation is part of batch of
+    #                       updates and the commit happens later.
+    #
+    # Returns the String SHA1 of the newly written version, or the
+    # Gollum::Committer instance if this is part of a batch update.
+    def update_page(page, name, format, data, commit = {})
+      name   ||= page.name
+      format ||= page.format
+      dir      = ::File.dirname(page.path)
+      dir      = '' if dir == '.'
+      filename = (rename = page.name != name) ?
+        Gollum::Page.cname(name) : page.filename_stripped
+
+      multi_commit = false
+
+      committer = if obj = commit[:committer]
+        multi_commit = true
+        obj
+      else
+        Committer.new(self, commit)
+      end
+
+      if !rename && page.format == format
+        committer.add(page.path, normalize(data))
+      else
+        committer.delete(page.path)
+        committer.add_to_index(dir, filename, format, data, :allow_same_ext)
+      end
+
+      committer.after_commit do |index, sha|
+        @access.refresh
+        index.update_working_dir(dir, page.filename_stripped, page.format)
+        index.update_working_dir(dir, filename, format)
+      end
+
+      multi_commit ? committer : committer.commit
+    end
+
+    # Public: Delete a page.
+    #
+    # page   - The Gollum::Page to delete.
+    # commit - The commit Hash details:
+    #          :message   - The String commit message.
+    #          :name      - The String author full name.
+    #          :email     - The String email address.
+    #          :parent    - Optional Grit::Commit parent to this update.
+    #          :tree      - Optional String SHA of the tree to create the
+    #                       index from.
+    #          :committer - Optional Gollum::Committer instance.  If provided,
+    #                       assume that this operation is part of batch of
+    #                       updates and the commit happens later.
+    #
+    # Returns the String SHA1 of the newly written version, or the
+    # Gollum::Committer instance if this is part of a batch update.
+    def delete_page(page, commit)
+      multi_commit = false
+
+      committer = if obj = commit[:committer]
+        multi_commit = true
+        obj
+      else
+        Committer.new(self, commit)
+      end
+
+      committer.delete(page.path)
+
+      committer.after_commit do |index, sha|
+        dir = ::File.dirname(page.path)
+        dir = '' if dir == '.'
+
+        @access.refresh
+        index.update_working_dir(dir, page.filename_stripped, page.format)
+      end
+
+      multi_commit ? committer : committer.commit
+    end
+
+    # Public: Applies a reverse diff for a given page.  If only 1 SHA is given,
+    # the reverse diff will be taken from its parent (^SHA...SHA).  If two SHAs
+    # are given, the reverse diff is taken from SHA1...SHA2.
+    #
+    # page   - The Gollum::Page to delete.
+    # sha1   - String SHA1 of the earlier parent if two SHAs are given,
+    #          or the child.
+    # sha2   - Optional String SHA1 of the child.
+    # commit - The commit Hash details:
+    #          :message - The String commit message.
+    #          :name    - The String author full name.
+    #          :email   - The String email address.
+    #          :parent  - Optional Grit::Commit parent to this update.
+    #
+    # Returns a String SHA1 of the new commit, or nil if the reverse diff does
+    # not apply.
+    def revert_page(page, sha1, sha2 = nil, commit = {})
+      if sha2.is_a?(Hash)
+        commit = sha2
+        sha2   = nil
+      end
+
+      patch     = full_reverse_diff_for(page, sha1, sha2)
+      committer = Committer.new(self, commit)
+      parent    = committer.parents[0]
+      committer.options[:tree] = @repo.git.apply_patch(parent.sha, patch)
+      return false unless committer.options[:tree]
+      committer.after_commit do |index, sha|
+        @access.refresh
+
+        files = []
+        if page
+          files << [page.path, page.filename_stripped, page.format]
+        else
+          # Grit::Diff can't parse reverse diffs.... yet
+          patch.each_line do |line|
+            if line =~ %r{^diff --git b/.+? a/(.+)$}
+              path = $1
+              ext  = ::File.extname(path)
+              name = ::File.basename(path, ext)
+              if format = ::Gollum::Page.format_for(ext)
+                files << [path, name, format]
+              end
+            end
+          end
+        end
+
+        files.each do |(path, name, format)|
+          dir = ::File.dirname(path)
+          dir = '' if dir == '.'
+          index.update_working_dir(dir, name, format)
+        end
+      end
+
+      committer.commit
+    end
+
+    # Public: Applies a reverse diff to the repo.  If only 1 SHA is given,
+    # the reverse diff will be taken from its parent (^SHA...SHA).  If two SHAs
+    # are given, the reverse diff is taken from SHA1...SHA2.
+    #
+    # sha1   - String SHA1 of the earlier parent if two SHAs are given,
+    #          or the child.
+    # sha2   - Optional String SHA1 of the child.
+    # commit - The commit Hash details:
+    #          :message - The String commit message.
+    #          :name    - The String author full name.
+    #          :email   - The String email address.
+    #
+    # Returns a String SHA1 of the new commit, or nil if the reverse diff does
+    # not apply.
+    def revert_commit(sha1, sha2 = nil, commit = {})
+      revert_page(nil, sha1, sha2, commit)
+    end
+
+    # Public: Lists all pages for this wiki.
+    #
+    # treeish - The String commit ID or ref to find  (default:  @ref)
+    #
+    # Returns an Array of Gollum::Page instances.
+    def pages(treeish = nil)
+      tree_list(treeish || @ref)
+    end
+
+    # Public: Lists all non-page files for this wiki.
+    #
+    # treeish - The String commit ID or ref to find  (default:  @ref)
+    #
+    # Returns an Array of Gollum::File instances.
+    def files(treeish = nil)
+      file_list(treeish || @ref)
+    end
+
+    # Public: Returns the number of pages accessible from a commit
+    #
+    # ref - A String ref that is either a commit SHA or references one.
+    #
+    # Returns a Fixnum
+    def size(ref = nil)
+      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
+      0
+    end
+
+    # Public: Search all pages for this wiki.
+    #
+    # query - The string to search for
+    #
+    # 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
+
+      results = {}
+
+      @repo.git.grep(*args).split("\n").each do |line|
+        result = line.split(':')
+        result_1 = result[1]
+        # 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
+      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|
+        # Remove ext only from known extensions.
+        file_name = Page::valid_page_name?(line) ? line.chomp(::File.extname(line)) :
+                    line
+        # 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;
+      end
+
+      results.map do |key,val|
+        { :count => val, :name => key }
+      end
+    end
+
+    # Public: All of the versions that have touched the Page.
+    #
+    # options - The options Hash:
+    #           :page     - The Integer page number (default: 1).
+    #           :per_page - The Integer max count of items to return.
+    #
+    # Returns an Array of Grit::Commit.
+    def log(options = {})
+      @repo.log(@ref, nil, log_pagination_options(options))
+    end
+
+    # Public: Refreshes just the cached Git reference data.  This should
+    # be called after every Gollum update.
+    #
+    # Returns nothing.
+    def clear_cache
+      @access.refresh
+    end
+
+    # Public: Creates a Sanitize instance using the Wiki's sanitization
+    # options.
+    #
+    # Returns a Sanitize instance.
+    def sanitizer
+      if options = sanitization
+        @sanitizer ||= options.to_sanitize
+      end
+    end
+
+    # Public: Creates a Sanitize instance using the Wiki's history sanitization
+    # options.
+    #
+    # Returns a Sanitize instance.
+    def history_sanitizer
+      if options = history_sanitization
+        @history_sanitizer ||= options.to_sanitize
+      end
+    end
+
+    #########################################################################
+    #
+    # Internal Methods
+    #
+    #########################################################################
+
+    # The Grit::Repo associated with the wiki.
+    #
+    # Returns the Grit::Repo.
+    attr_reader :repo
+
+    # The String path to the Git repository that holds the Gollum site.
+    #
+    # Returns the String path.
+    attr_reader :path
+
+    # Gets the page class used by all instances of this Wiki.
+    attr_reader :page_class
+
+    # Gets the file class used by all instances of this Wiki.
+    attr_reader :file_class
+
+    # Gets the markup class used by all instances of this Wiki.
+    attr_reader :markup_classes
+
+    # Toggles display of universal table of contents
+    attr_reader :universal_toc
+
+    # Toggles mathjax.
+    attr_reader :mathjax
+
+    # Toggles user icons. Default: 'none'
+    attr_reader :user_icons
+
+    # Toggles showing all files in files view. Default is false.
+    # When false, only valid pages in the git repo are displayed.
+    attr_reader :show_all
+
+    # Start with collapsed file view. Default: false
+    attr_reader :collapse_tree
+
+    # Normalize the data.
+    #
+    # data - The String data to be normalized.
+    #
+    # Returns the normalized data String.
+    def normalize(data)
+      data.gsub(/\r/, '')
+    end
+
+    # Assemble a Page's filename from its name and format.
+    #
+    # name   - The String name of the page (should be pre-canonicalized).
+    # format - The Symbol format of the page.
+    #
+    # Returns the String filename.
+    def page_file_name(name, format)
+      name + '.' + @page_class.format_to_ext(format)
+    end
+
+    # Fill an array with a list of pages.
+    #
+    # ref - A String ref that is either a commit SHA or references one.
+    #
+    # Returns a flat Array of Gollum::Page instances.
+    def tree_list(ref)
+      if sha = @access.ref_to_sha(ref)
+        commit = @access.commit(sha)
+        tree_map_for(sha).inject([]) do |list, entry|
+          next list unless @page_class.valid_page_name?(entry.name)
+          list << entry.page(self, commit)
+        end
+      else
+        []
+      end
+    end
+
+    # Fill an array with a list of files.
+    #
+    # ref - A String ref that is either a commit SHA or references one.
+    #
+    # Returns a flat Array of Gollum::File instances.
+    def file_list(ref)
+      if sha = @access.ref_to_sha(ref)
+        commit = @access.commit(sha)
+        tree_map_for(sha).inject([]) do |list, entry|
+          next list if entry.name.start_with?('_')
+          next list if @page_class.valid_page_name?(entry.name)
+          list << entry.file(self, commit)
+        end
+      else
+        []
+      end
+    end
+
+    # Creates a reverse diff for the given SHAs on the given Gollum::Page.
+    #
+    # page   - The Gollum::Page to scope the patch to, or a String Path.
+    # sha1   - String SHA1 of the earlier parent if two SHAs are given,
+    #          or the child.
+    # sha2   - Optional String SHA1 of the child.
+    #
+    # Returns a String of the reverse Diff to apply.
+    def full_reverse_diff_for(page, sha1, sha2 = nil)
+      sha1, sha2 = "#{sha1}^", sha1 if sha2.nil?
+      args = [{:R => true}, sha1, sha2]
+      if page
+        args << '--' << (page.respond_to?(:path) ? page.path : page.to_s)
+      end
+      repo.git.native(:diff, *args)
+    end
+
+    # Creates a reverse diff for the given SHAs.
+    #
+    # sha1   - String SHA1 of the earlier parent if two SHAs are given,
+    #          or the child.
+    # sha2   - Optional String SHA1 of the child.
+    #
+    # Returns a String of the reverse Diff to apply.
+    def full_reverse_diff(sha1, sha2 = nil)
+      full_reverse_diff_for(nil, sha1, sha2)
+    end
+
+    # Gets the default name for commits.
+    #
+    # Returns the String name.
+    def default_committer_name
+      @default_committer_name ||= \
+        @repo.config['user.name'] || self.class.default_committer_name
+    end
+
+    # Gets the default email for commits.
+    #
+    # Returns the String email address.
+    def default_committer_email
+      @default_committer_email ||= \
+        @repo.config['user.email'] || self.class.default_committer_email
+    end
+
+    # Gets the commit object for the given ref or sha.
+    #
+    # ref - A string ref or SHA pointing to a valid commit.
+    #
+    # Returns a Grit::Commit instance.
+    def commit_for(ref)
+      @access.commit(ref)
+    rescue Grit::GitRuby::Repository::NoSuchShaFound
+    end
+
+    # Finds a full listing of files and their blob SHA for a given ref.  Each
+    # listing is cached based on its actual commit SHA.
+    #
+    # ref - A String ref that is either a commit SHA or references one.
+    # ignore_page_file_dir - Boolean, if true, searches all files within the git repo, regardless of dir/subdir
+    #
+    # Returns an Array of BlobEntry instances.
+    def tree_map_for(ref, ignore_page_file_dir=false)
+      if ignore_page_file_dir && !@page_file_dir.nil?
+        @root_access ||= GitAccess.new(path, nil, @repo_is_bare)
+        @root_access.tree(ref)
+      else
+        @access.tree(ref)
+      end
+    rescue Grit::GitRuby::Repository::NoSuchShaFound
+      []
+    end
+
+    def inspect
+      %(#<#{self.class.name}:#{object_id} #{@repo.path}>)
+    end
+  end
+end