RubyGems - rtfmd - Versions diffs - 0.10301.17 - Mend

rtfmd 0.10301.17

Files changed (40) hide show

data/HISTORY.md +93 -0
data/LICENSE +21 -0
data/README.md +393 -0
data/bin/rtfm +0 -0
data/bin/rtfmd +4 -0
data/config/rtfmd.ru +33 -0
data/docs/sanitization.md +32 -0
data/lib/gollum.rb +39 -0
data/lib/gollum/blob_entry.rb +78 -0
data/lib/gollum/committer.rb +217 -0
data/lib/gollum/file.rb +64 -0
data/lib/gollum/frontend/app.rb +96 -0
data/lib/gollum/frontend/indexapp.rb +17 -0
data/lib/gollum/frontend/public/css/gollum.css +660 -0
data/lib/gollum/frontend/public/css/ie7.css +69 -0
data/lib/gollum/frontend/public/css/ronn.css +40 -0
data/lib/gollum/frontend/public/css/template.css +381 -0
data/lib/gollum/frontend/public/images/icon-sprite.png +0 -0
data/lib/gollum/frontend/public/javascript/gollum.js +137 -0
data/lib/gollum/frontend/public/javascript/gollum.placeholder.js +54 -0
data/lib/gollum/frontend/public/javascript/jquery.color.js +123 -0
data/lib/gollum/frontend/public/javascript/jquery.js +7179 -0
data/lib/gollum/frontend/templates/error.mustache +8 -0
data/lib/gollum/frontend/templates/index.mustache +25 -0
data/lib/gollum/frontend/templates/layout.mustache +28 -0
data/lib/gollum/frontend/templates/page.mustache +34 -0
data/lib/gollum/frontend/templates/pages.mustache +31 -0
data/lib/gollum/frontend/views/error.rb +7 -0
data/lib/gollum/frontend/views/index.rb +21 -0
data/lib/gollum/frontend/views/layout.rb +28 -0
data/lib/gollum/frontend/views/page.rb +53 -0
data/lib/gollum/frontend/views/pages.rb +19 -0
data/lib/gollum/git_access.rb +248 -0
data/lib/gollum/markup.rb +389 -0
data/lib/gollum/page.rb +374 -0
data/lib/gollum/pagination.rb +61 -0
data/lib/gollum/sanitization.rb +161 -0
data/lib/gollum/wiki.rb +378 -0
data/rtfmd.gemspec +47 -0
metadata +291 -0

data/lib/gollum/frontend/templates/error.mustache ADDED Viewed

@@ -0,0 +1,8 @@
+<div id="wiki-wrapper" class="error">
+  <div id="error">
+    <h1>Error</h1>
+    <p>
+      {{message}}
+    </p>
+  </div>
+</div>

data/lib/gollum/frontend/templates/index.mustache ADDED Viewed

@@ -0,0 +1,25 @@
+<div id="wiki-wrapper" class="results">
+<div id="head">
+  <h1>{{title}}</h1>
+</div>
+<div id="results">
+{{#has_roots}}
+  <ul>
+    {{#roots}}
+    <li>
+      <a href="{{root}}">{{wiki}}</a>
+    </li>
+    {{/roots}}
+  </ul>
+{{/has_roots}}
+{{#no_roots}}
+  <p id="no-results">
+    There are no wikis.
+  </p>
+{{/no_roots}}
+</div>
+</div>

data/lib/gollum/frontend/templates/layout.mustache ADDED Viewed

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="Content-type" content="text/html;charset=utf-8">
+  <link rel="stylesheet" type="text/css" href="{{base_path}}css/gollum.css" media="all">
+  <link rel="stylesheet" type="text/css" href="{{base_path}}css/template.css" media="all">
+  <link rel="stylesheet" type="text/css" href="{{base_path}}css/ronn.css" media="all">
+  <!--[if IE 7]>
+  <link rel="stylesheet" type="text/css" href="{{base_path}}css/ie7.css" media="all">
+  <![endif]-->
+  <script type="text/javascript" src="{{base_path}}javascript/jquery.js"></script>
+  <script type="text/javascript" src="{{base_path}}javascript/gollum.js"></script>
+  <script type="text/javascript" src="{{base_path}}javascript/gollum.placeholder.js"></script>
+</head>
+<body id='manpage'>
+  <div class='mp' id='man'>
+  <div class='man-navigation' style='display:none'>
+  </div>
+{{{yield}}}
+  </div>
+</body>
+</html>

data/lib/gollum/frontend/templates/page.mustache ADDED Viewed

@@ -0,0 +1,34 @@
+<div id="wiki-wrapper" class="page">
+<div id="head">
+  <ul class="actions">
+    <li class="minibutton"><a href="{{base_path}}"
+      class="action-home-page">Home</a></li>
+    <li class="minibutton"><a href="{{base_path}}pages"
+      class="action-all-pages">All Pages</a></li>
+    <li class="minibutton"><a href="{{rtfm_root}}"
+      class="action-all-projects">All Projects</a></li>
+  </ul>
+</div>
+<div id="wiki-content">
+<div class="wrap {{#has_footer}} has-footer {{/has_footer}} {{#has_sidebar}}  has-rightbar{{/has_sidebar}}">
+  <div id="wiki-body" class="gollum-{{format}}-content">
+    <div id="template">
+      {{{content}}}
+    </div>
+  </div>
+  {{#has_sidebar}}
+  <div id="wiki-rightbar" class="gollum-{{sidebar_format}}-content">
+    {{{sidebar_content}}}
+  </div>
+  {{/has_sidebar}}
+  {{#has_footer}}
+  <div id="wiki-footer" class="gollum-{{footer_format}}-content">
+    <div id="footer-content">
+      {{{footer_content}}}
+    </div>
+  </div>
+  {{/has_footer}}
+  </div>
+</div>
+</div>

data/lib/gollum/frontend/templates/pages.mustache ADDED Viewed

@@ -0,0 +1,31 @@
+<div id="wiki-wrapper" class="results">
+<div id="head">
+  <h1>{{title}}</h1>
+  <ul class="actions">
+    <li class="minibutton"><a href="{{base_path}}"
+       class="action-home-page">Home</a></li>
+  </ul>
+</div>
+<div id="results">
+{{#has_results}}
+  <ul>
+    {{#results}}
+    <li>
+      <a href="{{base_path}}{{name}}">{{name}}</a>
+    </li>
+    {{/results}}
+  </ul>
+{{/has_results}}
+{{#no_results}}
+  <p id="no-results">
+    There are no pages in <strong>{{ref}}</strong>.
+  </p>
+{{/no_results}}
+</div>
+<div id="footer">
+</div>
+</div>

data/lib/gollum/frontend/views/error.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module Precious
+  module Views
+    class Error < Layout
+      attr_reader :message
+    end
+  end
+end

data/lib/gollum/frontend/views/index.rb ADDED Viewed

@@ -0,0 +1,21 @@
+require 'cgi'
+module Precious
+  module Views
+    class Index < Layout
+      attr_reader :roots
+      def title
+        "Index"
+      end
+      def has_roots
+        !@roots.empty?
+      end
+      def no_roots
+        @roots.empty?
+      end
+    end
+  end
+end

data/lib/gollum/frontend/views/layout.rb ADDED Viewed

@@ -0,0 +1,28 @@
+require 'cgi'
+module Precious
+  module Views
+    class Layout < Mustache
+      include Rack::Utils
+      alias_method :h, :escape_html
+      attr_reader :name
+      def escaped_name
+        CGI.escape(@name)
+      end
+      def title
+        "Home"
+      end
+      def base_path
+        @base_path
+      end
+      def rtfm_root
+        @rtfm_root
+      end
+    end
+  end
+end

data/lib/gollum/frontend/views/page.rb ADDED Viewed

@@ -0,0 +1,53 @@
+module Precious
+  module Views
+    class Page < Layout
+      attr_reader :content, :page, :footer
+      DATE_FORMAT = "%Y-%m-%d %H:%M:%S"
+      DEFAULT_AUTHOR = 'you'
+      def title
+        @page.title
+      end
+      def format
+        @page.format.to_s
+      end
+      def author
+        return DEFAULT_AUTHOR unless @page.version
+        @page.version.author.name
+      end
+      def date
+        return Time.now.strftime(DATE_FORMAT) unless @page.version
+        @page.version.authored_date.strftime(DATE_FORMAT)
+      end
+      def has_footer
+        @footer = (@page.footer || false) if @footer.nil?
+        !!@footer
+      end
+      def footer_content
+        has_footer && @footer.formatted_data
+      end
+      def footer_format
+        has_footer && @footer.format.to_s
+      end
+      def has_sidebar
+        @sidebar = (@page.sidebar || false) if @sidebar.nil?
+        !!@sidebar
+      end
+      def sidebar_content
+        has_sidebar && @sidebar.formatted_data
+      end
+      def sidebar_format
+        has_sidebar && @sidebar.format.to_s
+      end
+    end
+  end
+end

data/lib/gollum/frontend/views/pages.rb ADDED Viewed

@@ -0,0 +1,19 @@
+module Precious
+  module Views
+    class Pages < Layout
+      attr_reader :results, :ref
+      def title
+        "All pages in #{@ref}"
+      end
+      def has_results
+        !@results.empty?
+      end
+      def no_results
+        @results.empty?
+      end
+    end
+  end
+end

data/lib/gollum/git_access.rb ADDED Viewed

@@ -0,0 +1,248 @@
+module Gollum
+  # Controls all access to the Git objects from Gollum.  Extend this class to
+  # add custom caching for special cases.
+  class GitAccess
+    # Initializes the GitAccess instance.
+    #
+    # path          - The String path to the Git repository that holds the
+    #                 Gollum site.
+    # page_file_dir - String the directory in which all page files reside
+    #
+    # Returns this instance.
+    def initialize(path, page_file_dir = nil)
+      @page_file_dir = page_file_dir
+      @path = path
+      @repo = Grit::Repo.new(path)
+      clear
+    end
+    # Public: Determines whether the Git repository exists on disk.
+    #
+    # Returns true if it exists, or false.
+    def exist?
+      @repo.git.exist?
+    end
+    # Public: Converts a given Git reference to a SHA, using the cache if
+    # available.
+    #
+    # ref - a String Git reference (ex: "master")
+    #
+    # Returns a String, or nil if the ref isn't found.
+    def ref_to_sha(ref)
+      ref = ref.to_s
+      return if ref.empty?
+      sha =
+        if sha?(ref)
+          ref
+        else
+          get_cache(:ref, ref) { ref_to_sha!(ref) }
+        end.to_s
+      sha.empty? ? nil : sha
+    end
+    # Public: Gets a recursive list of Git blobs for the whole tree at the
+    # given commit.
+    #
+    # ref - A String Git reference or Git SHA to a commit.
+    #
+    # Returns an Array of BlobEntry instances.
+    def tree(ref)
+      if sha = ref_to_sha(ref)
+        get_cache(:tree, sha) { tree!(sha) }
+      else
+        []
+      end
+    end
+    # Public: Fetches the contents of the Git blob at the given SHA.
+    #
+    # sha - A String Git SHA.
+    #
+    # Returns the String content of the blob.
+    def blob(sha)
+      cat_file!(sha)
+    end
+    # Public: Looks up the Git commit using the given Git SHA or ref.
+    #
+    # ref - A String Git SHA or ref.
+    #
+    # Returns a Grit::Commit.
+    def commit(ref)
+      if sha?(ref)
+        get_cache(:commit, ref) { commit!(ref) }
+      else
+        if sha = get_cache(:ref, ref)
+          commit(sha)
+        else
+          if cm = commit!(ref)
+            set_cache(:ref,    ref,   cm.id)
+            set_cache(:commit, cm.id, cm)
+          end
+        end
+      end
+    end
+    # Public: Clears all of the cached data that this GitAccess is tracking.
+    #
+    # Returns nothing.
+    def clear
+      @ref_map    = {}
+      @tree_map   = {}
+      @commit_map = {}
+    end
+    # Public: Refreshes just the cached Git reference data.  This should
+    # be called after every Gollum update.
+    #
+    # Returns nothing.
+    def refresh
+      @ref_map.clear
+    end
+    #########################################################################
+    #
+    # Internal Methods
+    #
+    #########################################################################
+    # Gets the String path to the Git repository.
+    attr_reader :path
+    # Gets the Grit::Repo instance for the Git repository.
+    attr_reader :repo
+    # Gets a Hash cache of refs to commit SHAs.
+    #
+    #   {"master" => "abc123", ...}
+    #
+    attr_reader :ref_map
+    # Gets a Hash cache of commit SHAs to a recursive tree of blobs.
+    #
+    #   {"abc123" => [<BlobEntry>, <BlobEntry>]}
+    #
+    attr_reader :tree_map
+    # Gets a Hash cache of commit SHAs to the Grit::Commit instance.
+    #
+    #     {"abcd123" => <Grit::Commit>}
+    #
+    attr_reader :commit_map
+    # Checks to see if the given String is a 40 character hex SHA.
+    #
+    # str - Possible String SHA.
+    #
+    # Returns true if the String is a SHA, or false.
+    def sha?(str)
+      !!(str =~ /^[0-9a-f]{40}$/)
+    end
+    # Looks up the Git SHA for the given Git ref.
+    #
+    # ref - String Git ref.
+    #
+    # Returns a String SHA.
+    def ref_to_sha!(ref)
+      @repo.git.rev_list({:max_count=>1}, ref)
+    rescue Grit::GitRuby::Repository::NoSuchShaFound
+    end
+    # Looks up the Git blobs for a given commit.
+    #
+    # sha - String commit SHA.
+    #
+    # Returns an Array of BlobEntry instances.
+    def tree!(sha)
+      tree  = @repo.git.native(:ls_tree,
+        {:r => true, :l => true, :z => true}, sha)
+      if tree.respond_to?(:force_encoding)
+        tree.force_encoding("UTF-8")
+      end
+      items = tree.split("\0").inject([]) do |memo, line|
+        memo << parse_tree_line(line)
+      end
+      if dir = @page_file_dir
+        regex = /^#{dir}\//
+        items.select { |i| i.path =~ regex }
+      else
+        items
+      end
+    end
+    # Reads the content from the Git db at the given SHA.
+    #
+    # sha - The String SHA.
+    #
+    # Returns the String content of the Git object.
+    def cat_file!(sha)
+      @repo.git.cat_file({:p => true}, sha)
+    end
+    # Reads a Git commit.
+    #
+    # sha - The string SHA of the Git commit.
+    #
+    # Returns a Grit::Commit.
+    def commit!(sha)
+      @repo.commit(sha)
+    end
+    # Attempts to get the given data from a cache.  If it doesn't exist, it'll
+    # pass the results of the yielded block to the cache for future accesses.
+    #
+    # name - The cache prefix used in building the full cache key.
+    # key  - The unique cache key suffix, usually a String Git SHA.
+    #
+    # Yields a block to pass to the cache.
+    # Returns the cached result.
+    def get_cache(name, key)
+      cache = instance_variable_get("@#{name}_map")
+      value = cache[key]
+      if value.nil? && block_given?
+        set_cache(name, key, value = yield)
+      end
+      value == :_nil ? nil : value
+    end
+    # Writes some data to the internal cache.
+    #
+    # name  - The cache prefix used in building the full cache key.
+    # key   - The unique cache key suffix, usually a String Git SHA.
+    # value - The value to write to the cache.
+    #
+    # Returns nothing.
+    def set_cache(name, key, value)
+      cache      = instance_variable_get("@#{name}_map")
+      cache[key] = value || :_nil
+    end
+    # Parses a line of output from the `ls-tree` command.
+    #
+    # line - A String line of output:
+    #          "100644 blob 839c2291b30495b9a882c17d08254d3c90d8fb53  Home.md"
+    #
+    # Returns an Array of BlobEntry instances.
+    def parse_tree_line(line)
+      mode, type, sha, size, *name = line.split(/\s+/)
+      BlobEntry.new(sha, name.join(' '), size.to_i)
+    end
+    # Decode octal sequences (\NNN) in tree path names.
+    #
+    # path - String path name.
+    #
+    # Returns a decoded String.
+    def decode_git_path(path)
+      if path[0] == ?" && path[-1] == ?"
+        path = path[1...-1]
+        path.gsub!(/\\\d{3}/)   { |m| m[1..-1].to_i(8).chr }
+      end
+      path.gsub!(/\\[rn"\\]/) { |m| eval(%("#{m.to_s}")) }
+      path
+    end
+  end
+end