smeagol 0.1.0

data/README.md

@@ -0,0 +1,62 @@
+smeagol -- A Read-Only Gollum Server
+=============================================
+
+## DESCRIPTION
+
+Smeagol is a server that can run a read-only version of a
+[Gollum](http://github.com/github/gollum) wiki. This can be useful when you want
+to maintain a standalone copy of a Github wiki but you want to update it through
+the Github interface.
+
+Gollum follows the rules of [Semantic Versioning](http://semver.org/) and uses
+[TomDoc](http://tomdoc.org/) for inline documentation.
+
+
+## INSTALLATION
+
+You can install Smeagol with RubyGems:
+
+	$ [sudo] gem install smeagol
+
+And then, if you want code highlighting, follow the
+[Installation Guide](http://pygments.org/docs/installation) for Pygments.
+
+Ta da. You're ready to go.
+
+
+## RUNNING
+
+To run smeagol, simply change directories to your Gollum repository and run the
+`smeagol` executable from the command line:
+
+	$ cd /path/to/repo
+	$ smeagol
+
+This will run a web server at `http://localhost:4567`. You can change the port
+by setting the `--port` or `-p` option on the command line.
+
+
+## UPDATING
+
+There are two ways to update the repository through Smeagol:
+
+1. Auto Update
+1. Manual Update
+
+To setup Smeagol to automatically update your repository in fixed intervals,
+simply pass the `--autoupdate` option in the command line and Smeagol will
+automatically perform a `git pull origin master` on your repository once per
+day.
+
+To perform a manual update, simply go to the URL,
+`http://localhost:4567/update`, and Smeagol will perform a git pull. Change the
+URL to your appropriate hostname and port.
+
+
+## CONTRIBUTE
+
+Have a great idea for Smeagol? Awesome. Fork the repository and add a feature
+or fix a bug. There are a couple things I ask:
+
+1. You must have tests for all code you check in.
+1. Create an appropriately named topic branch that contains your change.

data/bin/smeagol

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler/setup'
+require 'optparse'
+require 'ostruct'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/smeagol')
+
+# Parse options
+options = OpenStruct.new
+options.port = 4567
+options.auto_update = false
+opts = OptionParser.new do |opts|
+  opts.banner = 'usage: smeagol [OPTIONS] [PATH]\n\n'
+
+  opts.on('--port [PORT]', 'Bind port (default 4567).') do |port|
+    options.port = port.to_i
+  end
+
+  opts.on('--git [GIT]', 'Path to Git binary.') do |path|
+    options.git = path
+  end
+
+  opts.on('--autoupdate', 'Updates the repository on a daily basis.') do |flag|
+    options.auto_update = flag
+  end
+
+  opts.on('-v', '--version', 'Display current version.') do
+    puts "Smeagol #{Smeagol::VERSION}"
+    exit 0
+  end
+end
+
+# Read command line options into `options` hash
+begin
+  opts.parse!
+rescue OptionParser::InvalidOption
+  puts "smeagol: #{$!.message}"
+  puts "smeagol: try 'smeagol --help' for more information"
+  exit
+end
+
+# Attempt to find the git binary
+if options.git.nil?
+  ['/usr/bin', '/usr/sbin', '/usr/local/bin', '/opt/local/bin'].each do |path|
+    file = "#{path}/git"
+    options.git = file if File.executable?(file)
+    break if options.git
+  end
+end
+
+# Alert user that updates are unavailable if git is not found
+if options.git.nil? || !File.executable?(options.git)
+  puts "warning: git executable could not be found."
+else
+  puts "git found: #{options.git}"
+end
+
+# Set the path to the Gollum repository
+gollum_path = ARGV[0] || Dir.pwd
+
+# Run the auto update process
+if options.git && options.auto_update
+  Thread.new do
+    while true do
+      Smeagol::Updater.update(options.git, gollum_path)
+      sleep 5
+    end
+  end
+end
+
+# Run the web server
+Smeagol::App.set(:gollum_path, gollum_path)
+Smeagol::App.set(:git, options.git)
+Smeagol::App.run!(:port => options.port)
+

data/lib/smeagol.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__))
+require 'smeagol/app'
+require 'smeagol/updater'
+require 'smeagol/version'
+require 'rdiscount'
+require 'RedCloth'

data/lib/smeagol/app.rb

@@ -0,0 +1,70 @@
+require 'gollum'
+require 'sinatra'
+require 'mustache'
+
+module Smeagol
+  class App < Sinatra::Base
+    ##############################################################################
+    #
+    # Settings
+    #
+    ##############################################################################
+
+    set :public, File.dirname(__FILE__) + '/public'
+    
+
+    ##############################################################################
+    #
+    # Routes
+    #
+    ##############################################################################
+
+    # Update the gollum repository
+    get '/update' do
+      if Updater.update(settings.git, settings.gollum_path)
+        'ok'
+      else
+        'error'
+      end
+    end
+
+    # All other resources go through Gollum.
+    get '/*' do
+      name = params[:splat].first
+      name = "Home" if name == ""
+      
+      wiki = Gollum::Wiki.new(settings.gollum_path)
+      if page = wiki.page(name)
+        Mustache.render(page_template,
+          :page => page,
+          :title => page.title,
+          :content => page.formatted_data
+        )
+      elsif file = wiki.file(name)
+        content_type file.mime_type
+        file.raw_data
+      end
+    end
+
+
+    ##############################################################################
+    #
+    # Private methods
+    #
+    ##############################################################################
+  
+    private
+    # The Mustache template to use for page rendering.
+    #
+    # Returns the content of the page.mustache file in the root of the Gollum
+    # repository if it exists. Otherwise, it uses the default page.mustache file
+    # packaged with the Smeagol library.
+    def page_template
+      if File.exists?("#{settings.gollum_path}/page.mustache")
+        IO.read("#{settings.gollum_path}/page.mustache")
+      else
+        IO.read(File.join(File.dirname(__FILE__), 'templates/page.mustache'))
+      end
+    end
+  end
+end

data/lib/smeagol/public/smeagol/main.css

@@ -0,0 +1,10 @@
+h1 {
+	padding-bottom: 3px;
+	border-bottom: 3px solid #ccc;
+}
+
+#container {
+	margin-left:  auto;
+	margin-right: auto;
+	width: 650px;
+}

data/lib/smeagol/public/smeagol/pygment.css

@@ -0,0 +1,60 @@
+.highlight{background:#fff;}
+.highlight .c{color:#998;font-style:italic;}
+.highlight .err{color:#a61717;background-color:#e3d2d2;}
+.highlight .k{font-weight:bold;}
+.highlight .o{font-weight:bold;}
+.highlight .cm{color:#998;font-style:italic;}
+.highlight .cp{color:#999;font-weight:bold;}
+.highlight .c1{color:#998;font-style:italic;}
+.highlight .cs{color:#999;font-weight:bold;font-style:italic;}
+.highlight .gd{color:#000;background-color:#fdd;}
+.highlight .gd .x{color:#000;background-color:#faa;}
+.highlight .ge{font-style:italic;}
+.highlight .gr{color:#a00;}
+.highlight .gh{color:#999;}
+.highlight .gi{color:#000;background-color:#dfd;}
+.highlight .gi .x{color:#000;background-color:#afa;}
+.highlight .go{color:#888;}
+.highlight .gp{color:#555;}
+.highlight .gs{font-weight:bold;}
+.highlight .gu{color:#800080;font-weight:bold;}
+.highlight .gt{color:#a00;}
+.highlight .kc{font-weight:bold;}
+.highlight .kd{font-weight:bold;}
+.highlight .kp{font-weight:bold;}
+.highlight .kr{font-weight:bold;}
+.highlight .kt{color:#458;font-weight:bold;}
+.highlight .m{color:#099;}
+.highlight .s{color:#d14;}
+.highlight .na{color:#008080;}
+.highlight .nb{color:#0086B3;}
+.highlight .nc{color:#458;font-weight:bold;}
+.highlight .no{color:#008080;}
+.highlight .ni{color:#800080;}
+.highlight .ne{color:#900;font-weight:bold;}
+.highlight .nf{color:#900;font-weight:bold;}
+.highlight .nn{color:#555;}
+.highlight .nt{color:#000080;}
+.highlight .nv{color:#008080;}
+.highlight .ow{font-weight:bold;}
+.highlight .w{color:#bbb;}
+.highlight .mf{color:#099;}
+.highlight .mh{color:#099;}
+.highlight .mi{color:#099;}
+.highlight .mo{color:#099;}
+.highlight .sb{color:#d14;}
+.highlight .sc{color:#d14;}
+.highlight .sd{color:#d14;}
+.highlight .s2{color:#d14;}
+.highlight .se{color:#d14;}
+.highlight .sh{color:#d14;}
+.highlight .si{color:#d14;}
+.highlight .sx{color:#d14;}
+.highlight .sr{color:#009926;}
+.highlight .s1{color:#d14;}
+.highlight .ss{color:#990073;}
+.highlight .bp{color:#999;}
+.highlight .vc{color:#008080;}
+.highlight .vg{color:#008080;}
+.highlight .vi{color:#008080;}
+.highlight .il{color:#099;}

data/lib/smeagol/templates/page.mustache

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+    <title>{{title}}</title>
+    <link rel="stylesheet" href="/smeagol/main.css" type="text/css"/> 
+    <link rel="stylesheet" href="/smeagol/pygment.css" type="text/css"/> 
+  </head>
+
+  <body>
+    <div id="container">
+	    <h1>{{title}}</h1>
+	    <div>
+{{{content}}}
+	    </div>
+    </div>
+  </body>
+</html>

data/lib/smeagol/updater.rb

@@ -0,0 +1,26 @@
+module Smeagol
+  class Updater
+    # Public: Updates the repository that the server is point at.
+    # 
+    # git  - The path to the git binary.
+    # repo - The path to the git repository to update.
+    #
+    # Returns true if successful. Otherwise returns false.
+    def self.update(git, repo)
+      # If the git executable is available, pull from master and check status.
+      if !git.nil? && !repo.nil?
+        output = `cd #{repo} && #{git} pull origin master 2>/dev/null`
+        
+        # Write update to log if something happened
+        if output.index('Already up-to-date').nil?
+          puts "==Repository updated at #{Time.new()}=="
+        end
+        
+        return $? == 0
+      # Otherwise return false.
+      else
+        return false
+      end
+    end
+  end
+end

data/lib/smeagol/version.rb

@@ -0,0 +1,3 @@
+module Smeagol
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification 
+name: smeagol
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-20 00:00:00 -06:00
+default_executable: smeagol
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
+        version: 1.2.0
+  requirement: *id001
+  type: :runtime
+  name: rack
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  requirement: *id002
+  type: :runtime
+  name: gollum
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  requirement: *id003
+  type: :runtime
+  name: sinatra
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 11
+        - 2
+        version: 0.11.2
+  requirement: *id004
+  type: :runtime
+  name: mustache
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 5
+        - 1
+        version: 0.5.1
+  requirement: *id005
+  type: :runtime
+  name: OptionParser
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+  type: :runtime
+  name: rdiscount
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+  type: :runtime
+  name: RedCloth
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 8
+        - 3
+        version: 0.8.3
+  requirement: *id008
+  type: :development
+  name: rake
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 0
+        - 8
+        - 5
+        version: 0.8.5
+  requirement: *id009
+  type: :development
+  name: cucumber
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  requirement: *id010
+  type: :development
+  name: rspec
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 3
+        - 9
+        version: 0.3.9
+  requirement: *id011
+  type: :development
+  name: capybara
+  prerelease: false
+description: 
+email: 
+- benbjohnson@yahoo.com
+executables: 
+- smeagol
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/smeagol/app.rb
+- lib/smeagol/public/smeagol/main.css
+- lib/smeagol/public/smeagol/pygment.css
+- lib/smeagol/templates/page.mustache
+- lib/smeagol/updater.rb
+- lib/smeagol/version.rb
+- lib/smeagol.rb
+- README.md
+- bin/smeagol
+has_rdoc: true
+homepage: http://smeagolrb.info
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A read-only server for Gollum wikis
+test_files: []
+