RTFMd 0.10301.1

data/lib/gollum/pagination.rb

@@ -0,0 +1,61 @@
+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/sanitization.rb

@@ -0,0 +1,161 @@
+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', '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', :relative]},
+      'img' => {'src'  => ['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 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: 'wiki-'
+    attr_accessor :id_prefix
+
+    # Gets a Hash describing HTML attributes that Sanitize should add.
+    # Default: {}
+    attr_reader :add_attributes
+
+    # Sets a boolean determining whether Sanitize allows HTML comments in the
+    # output.  Default: false.
+    attr_writer :allow_comments
+
+    def initialize
+      @elements       = ELEMENTS
+      @attributes     = ATTRIBUTES
+      @protocols      = PROTOCOLS
+      @transformers   = TRANSFORMERS
+      @add_attributes = {}
+      @allow_comments = false
+      @id_prefix      = 'wiki-'
+      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,
+        :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/wiki.rb

@@ -0,0 +1,378 @@
+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
+
+      # 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
+
+      # 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'
+
+    # 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
+
+    # Public: Initialize a new Gollum Repo.
+    #
+    # path    - The String path to the Git repository that holds the Gollum
+    #           site.
+    # options - Optional Hash:
+    #           :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
+    #
+    # Returns a fresh Gollum::Repo.
+    def initialize(path, options = {})
+      if path.is_a?(GitAccess)
+        options[:access] = path
+        path             = path.path
+      end
+      @path          = path
+      @page_file_dir = options[:page_file_dir]
+      @access        = options[:access]       || GitAccess.new(path, @page_file_dir)
+      @base_path     = options[:base_path]    || "/"
+      @page_class    = options[:page_class]   || self.class.page_class
+      @file_class    = options[:file_class]   || self.class.file_class
+      @markup_classes = options[:markup_classes] || self.class.markup_classes
+      @repo          = @access.repo
+      @ref           = options[:ref] || self.class.default_ref
+      @sanitization  = options[:sanitization] || self.class.sanitization
+      @history_sanitization = options[:history_sanitization] ||
+        self.class.history_sanitization
+    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.
+    #
+    # name    - The human or canonical String page name of the wiki page.
+    # version - The String version ID to find (default: @ref).
+    #
+    # Returns a Gollum::Page or nil if no matching page was found.
+    def page(name, version = @ref)
+      @page_class.new(self).find(name, version)
+    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: 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: 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: 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
+
+    # 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 (may be in human format).
+    # format - The Symbol format of the page.
+    #
+    # Returns the String filename.
+    def page_file_name(name, format)
+      ext = @page_class.format_to_ext(format)
+      @page_class.cname(name) + '.' + ext
+    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
+
+    # 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.
+    #
+    # Returns an Array of BlobEntry instances.
+    def tree_map_for(ref)
+      @access.tree(ref)
+    rescue Grit::GitRuby::Repository::NoSuchShaFound
+      []
+    end
+    
+    def inspect
+      %(#<#{self.class.name}:#{object_id} #{@repo.path}>)
+    end
+  end
+end