gollum-site 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in gollum-site.gemspec
+gemspec

data/README.md

@@ -0,0 +1,56 @@
+gollum-site -- A static site generator for Gollum
+=================================================
+
+## Description
+
+Generates a static site from a Gollum Wiki.
+
+## Installation
+
+TODO
+
+## Usage
+
+Static sites can be generated using the executable provided:
+
+       $ gollum-site generate
+
+Once a site has been generated (output to "_site" by default) you can use the
+gollum-site executable to start a web server for the site:
+
+       $ gollum-site serve
+
+The executable provides a few options which are described in the help menu:
+
+       $ gollum-site --help
+
+## Static Site Templates
+
+The static site generator uses the
+[Liquid templating system](http://github.com/tobi/liquid/wiki) to render wiki
+pages. The generator looks for `_Layout.html` files to use as templates. Layouts
+affect all pages in their directory and any subdirectories that do not have a
+layout file of their own.
+
+A layout is a Liquid template applied to a wiki page during static site
+generation with the following data made available to it:
+
+* `wiki.base_path`       The base path of the Wiki to which the page belongs
+* `page.content`         The formatted content of the page
+* `page.title`           The title of the page
+* `page.format`          The format of the page (textile, org, etc.)
+* `page.author`          The author of the last edit
+* `page.date`            The date of the last edit
+
+## Example
+
+To see gollum-site in action, let's use it to generate a static site from a
+Gollum Wiki. For this example I will use the Radiant wiki:
+
+       $ git clone git://github.com/radiant/radiant.wiki.git
+       $ cd radiant.wiki
+       $ gollum-site generate
+       $ gollum-site serve
+
+Now you can browse to http://localhost:8000 and view the Radiant wiki as a
+static site.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test' << '.'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/bin/gollum-site

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'optparse'
+require 'rubygems'
+require 'gollum-site'
+
+help = <<HELP
+Gollum Site is a static site generator for Gollum Wikis
+
+Basic Command Line Usage:
+  gollum-site [OPTIONS] [COMMAND]
+
+        Available commands:
+
+        generate      Generate a static site
+        serve         Start a web server to view generated site
+
+Options:
+HELP
+
+options = {
+  'ref' => ( head = Grit::Repo.new('.').head ) ? head.name : 'master', # current branch
+  'base_path' => '/',
+  'output_path' => '_site',
+  'port' => 8000,
+  'include_default_layout' => true
+}
+opts = OptionParser.new do |opts|
+  opts.banner = help
+
+  opts.on("--ref [REF]", "Branch or commit to generate") do |ref|
+    options['ref'] = ref
+  end
+
+  opts.on("--base_path [BASE_PATH]", "Prefix to apply to internal links") do |base_path|
+    options['base_path'] = base_path
+  end
+
+  opts.on("--output_path [OUTPUT_PATH]", "Path to write generated site") do |output_path|
+    options['output_path'] = output_path
+  end
+
+  opts.on("--port [PORT]", "Port to use when serving site (default 8000)") do |port|
+    options['port'] = port
+  end
+
+  opts.on("--include_default_layout", "Include a default layout if one is not present") do |include_default_layout|
+    options['include_default_layout'] = include_default_layout
+  end
+
+  opts.on_tail("--help", "Show this information") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("--version", "Display current version.") do
+    require 'gollum-site/version'
+    puts "Gollum Site " + Gollum::Site::VERSION
+    exit 0
+  end
+end
+
+opts.parse!
+
+cmd = ARGV[0]
+
+case cmd
+when 'generate'
+  wiki = Gollum::Wiki.new('.', {:base_path => options['base_path']})
+  site = Gollum::Site.new(wiki, {
+                            :output_path => options['output_path'],
+                            :include_default_layout => options['include_default_layout']})
+  site.generate(options['ref'])
+when 'serve'
+  require 'webrick'
+  include WEBrick
+
+  mime_types = WEBrick::HTTPUtils::DefaultMimeTypes
+  mime_types.store 'js', 'application/javascript'
+
+  s = HTTPServer.new(
+                     :Port            => options['port'],
+                     :DocumentRoot    => options['output_path'],
+                     :MimeTypes       => mime_types,
+                     :DirectoryIndex  => 'Home.html'
+                     )
+
+  t = Thread.new {
+    s.start
+  }
+
+  trap("INT") { s.shutdown }
+  t.join()
+else
+  puts opts
+  exit
+end

data/gollum-site.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "gollum-site/version"
+
+Gem::Specification.new do |s|
+  s.name        = "gollum-site"
+  s.version     = Gollum::Site::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Daniel Reverri"]
+  s.email       = ["dan@basho.com"]
+  s.homepage    = "http://rubygems.org/gems/gollum-site"
+  s.summary     = %q{Static site generator for Gollum Wikis}
+  s.description = %q{Generate a static site for Gollum Wikis}
+
+  s.rubyforge_project = "gollum-site"
+
+  s.add_dependency('gollum')
+  s.add_dependency('liquid')
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/gollum-site/blob_entry.rb

@@ -0,0 +1,71 @@
+module Gollum
+  class BlobEntry
+    # Gets the String SHA for this blob.
+    attr_reader :sha
+
+    # Gets the String full path for this blob.
+    attr_reader :path
+
+    def initialize(sha, path)
+      @sha  = sha
+      @path = path
+      @dir = @name = @blob = nil
+    end
+
+    # Gets the normalized directory path for this blob.
+    def dir
+      @dir ||= self.class.normalize_dir(::File.dirname(@path))
+    end
+
+    # Gets the String file base name for this blob.
+    def name
+      @name ||= ::File.basename(@path)
+    end
+
+    # Gets a Grit::Blob instance for this blob.
+    #
+    # repo - Grit::Repo instance for the Grit::Blob.
+    #
+    # Returns an unbaked Grit::Blob instance.
+    def blob(repo)
+      @blob ||= Grit::Blob.create(repo, :id => @sha, :name => @name)
+    end
+
+    # Gets a Page instance for this blob.
+    #
+    # wiki - Gollum::Wiki instance for the Gollum::Page
+    #
+    # Returns a Gollum::Page instance.
+    def page(wiki, commit)
+      blob = self.blob(wiki.repo)
+      page = wiki.page_class.new(wiki).populate(blob, self.dir)
+      page.version = commit
+      page
+    end
+
+    def inspect
+      %(#<Gollum::BlobEntry #{@sha} #{@path}>)
+    end
+
+    # Normalizes a given directory name for searching through tree paths.
+    # Ensures that a directory begins with a slash, or 
+    #
+    #   normalize_dir("")      # => ""
+    #   normalize_dir(".")     # => ""
+    #   normalize_dir("foo")   # => "/foo"
+    #   normalize_dir("/foo/") # => "/foo"
+    #   normalize_dir("/")     # => ""
+    #
+    # dir - String directory name.
+    #
+    # Returns a normalized String directory name, or nil if no directory 
+    # is given.
+    def self.normalize_dir(dir)
+      if dir
+        dir = ::File.expand_path(dir, '/')
+        dir = '' if dir == '/'
+      end
+      dir
+    end
+  end
+end

data/lib/gollum-site/layout/_Layout.html

@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+    <title>{{ page.title }}</title>
+    <link rel="stylesheet" href="{{ wiki.base_path }}css/screen.css" type="text/css" charset="utf-8" />
+    <link rel="stylesheet" href="{{ wiki.base_path }}css/gollum.css" type="text/css" charset="utf-8" />
+    <link rel="stylesheet" href="{{ wiki.base_path }}css/syntax.css" type="text/css" charset="utf-8" />
+    <script src="{{ wiki.base_path }}javascript/jquery-1.4.2.min.js" type="text/javascript"></script>
+    <script src="{{ wiki.base_path }}javascript/jquery.text_selection-1.0.0.min.js" type="text/javascript"></script>
+    <script src="{{ wiki.base_path }}javascript/jquery.previewable_comment_form.js" type="text/javascript"></script>
+    <script src="{{ wiki.base_path }}javascript/jquery.tabs.js" type="text/javascript"></script>
+    <script src="{{ wiki.base_path }}javascript/gollum.js" type="text/javascript"></script>
+    <script src="{{ wiki.base_path }}javascript/MathJax/MathJax.js" type="text/javascript">
+      MathJax.OutputJax.fontDir = "http://github-assets.s3.amazonaws.com/javascripts/MathJax/fonts"
+      MathJax.Hub.Config({
+      jax: ["input/TeX", "output/HTML-CSS"]
+      })
+    </script>
+  </head>
+
+  <body>
+    <div id="main">
+      <div class="site">
+        <div id="guides">
+          <div class="guide">
+            <div class="main">
+              <div class="actions">
+                <div>
+                  <a href="{{ wiki.base_path }}Home.html">Home</a>
+                </div>
+              </div>
+              <h1>{{ page.title }}</h1>
+              <div class="content wikistyle gollum {{ page.format }}">
+                {{ page.content }}
+              </div>
+            </div>
+          </div>
+          <div class="admin">
+            <div style="float: left;">
+              <small>Last edited by <b>{{ page.author }}</b>, {{ page.date }}</small>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/lib/gollum-site/layout/css/editbar.css

@@ -0,0 +1,194 @@
+#editbar {
+  border-left: 1px solid #888;
+  border-top: 1px solid #888;
+  border-right:  1px solid #888;
+  overflow: hidden;
+  font-family: sans-serif;
+  font-size: 13px;
+}
+
+  #editbar .inner {
+    width: 100%;
+    padding: 0;
+    margin: 0;
+    border: none;
+  }
+
+  #editbar .current {
+    display: block !important;
+  }
+
+  #editbar .menu {
+    overflow: hidden;
+    background: white;
+    background: -webkit-gradient(linear, left top, left bottom, from(#fff), to(#EBF1FF));
+    background: -moz-linear-gradient(top,  #fff,  #EBF1FF);
+  }
+
+  #editbar .group {
+    float: left;
+    height: 26px;
+    margin: 3px;
+    padding-right: 6px;
+  }
+
+  #editbar .group-right {
+    float: right;
+  }
+
+    #editbar .group-right .tab.format {
+      margin-top: 4px;
+    }
+
+  #editbar .group-separator {
+    border-right: 1px solid #ddd;
+  }
+
+    #editbar .button {
+      width: 22px;
+      height: 22px;
+      background: #e7ecfb url(/images/editbar-buttons.png);
+      border: 1px solid #ddd;
+      text-indent: -100px;
+      cursor: pointer;
+      overflow: hidden;
+      padding: 1px;
+      display: block;
+      float: left;
+      margin: 0 2px;
+      -moz-border-radius: 2px;
+      -webkit-border-radius: 2px;
+      -khtml-border-radius: 2px;
+      border-radius: 2px;
+      background-repeat: no-repeat;
+    }
+
+    #editbar .button:hover {
+      background-color: #d9dde7;
+      border-color: #aaa;
+    }
+
+    #editbar .bold {
+      background-position: -97px 4px;
+    }
+
+    #editbar .italic {
+      background-position: -147px 4px;
+    }
+
+    #editbar .link {
+      background-position: -197px 4px;
+    }
+
+    #editbar .image {
+      background-position: -247px 4px;
+    }
+
+    #editbar .ul {
+      background-position: 3px 4px;
+    }
+
+    #editbar .ol {
+      background-position: -47px 4px;
+    }
+
+  #editbar .tab {
+    float: left;
+    display: block;
+  }
+
+    #editbar .tab a {
+      cursor: pointer;
+      display: inline-block;
+      float: left;
+      height: 26px;
+      padding-left: 18px;
+      padding-right: 12px;
+      line-height: 26px;
+      text-decoration: none;
+      background-image: url(/images/twiddle-right.png);
+      background-position: 0 50%;
+      background-repeat: no-repeat;
+      color: blue;
+    }
+
+    #editbar .tab a.open {
+      background-image: url(/images/twiddle-down.png);
+      color: #333;
+    }
+
+    #editbar .tab a.open:hover {
+      text-decoration: none;
+    }
+
+    #editbar .tab a:hover {
+      text-decoration: underline;
+    }
+
+  #editbar .sections {
+    clear: both;
+    float: left;
+    width: 100%;
+    overflow: visible;
+    border-top: 1px solid #888;
+    height: 185px;
+    background-color: #E0EEF7;
+    display: none;
+  }
+
+    #editbar .sections .toc {
+      float: left;
+      width: 20%;
+      overflow: auto;
+    }
+
+      #editbar .sections .toc div {
+        cursor: pointer;
+        padding: 4px 4px 4px 6px;
+        background-color: #E0EEF7;
+        color: blue;
+      }
+
+      #editbar .sections .toc div.current {
+        cursor: default;
+        background-color: white;
+        color: #333;
+      }
+
+    #editbar .sections .pages {
+      overflow: auto;
+      background-color: white;
+      float: right;
+      width: 80%;
+      height: 185px;
+    }
+
+      #editbar .sections .page {
+        display: none;
+      }
+
+      #editbar .sections .pages th {
+        color: #999;
+        font-weight: bold;
+        padding: 5px;
+        text-align: left;
+      }
+
+      #editbar .sections .pages td {
+        color: black;
+        padding: 5px;
+        border-top: 1px solid #eee;
+      }
+
+      #editbar .sections .pages span.invisible {
+        color: #bbb;
+        padding-left: 1px;
+      }
+
+      #editbar .sections .pages .shortcodes th {
+        text-align: center;
+      }
+
+      #editbar .sections .pages .shortcodes ul {
+        list-style-type: none;
+      }

data/lib/gollum-site/layout/css/gollum.css

@@ -0,0 +1,55 @@
+a.absent {
+  color: #a00;
+}
+
+/* Images */
+
+.frame {
+  margin: 0;
+  display: inline-block;
+}
+
+.frame img {
+  display: block;
+}
+
+.frame > span {
+  display: block;
+  border: 1px solid #aaa;
+  padding: 4px;
+}
+
+.frame span span {
+  display: block;
+  font-size: 10pt;
+  margin: 0;
+  padding: 4px 0 2px 0;
+  text-align: center;
+  line-height: 10pt;
+  font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
+}
+
+.float-left {
+  float: left;
+  padding: .5em 1em .25em 0;
+}
+
+.float-right {
+  float: right;
+  padding: .5em 0 .25em 1em;
+}
+
+.align-left {
+  display: block;
+  text-align: left;
+}
+
+.align-center {
+  display: block;
+  text-align: center;
+}
+
+.align-right {
+  display: block;
+  text-align: right;
+}