smeagol 0.5.9 → 0.6.0

data/.ruby

@@ -0,0 +1,80 @@
+---
+source:
+- meta
+authors:
+- name: Ben Johnson
+  email: benbjohnson@yahoo.com
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+copyrights:
+- holder: Ben Johnson
+  year: '2010'
+- holder: Rubyworks
+  year: '2011'
+  license: BSD-2-Clause
+requirements:
+- name: rack
+  version: 1.2~
+- name: gollum
+  version: 1.3+
+- name: sinatra
+  version: 1.0~
+- name: rubypython
+  version: 0.5+
+- name: citron
+  groups:
+  - development
+  - test
+  development: true
+- name: ae
+  groups:
+  - develpoment
+  - test
+  development: true
+- name: rack-test
+  groups:
+  - development
+  - test
+  development: true
+- name: rdiscount
+  groups:
+  - development
+  - doc
+  development: true
+dependencies: []
+alternatives: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/smeagol.git
+  scm: git
+  name: upstream
+resources:
+- uri: http://rubyworks.github.com/smeagol
+  label: Website
+  type: home
+- uri: http://github.com/rubyworks/smeagol
+  label: Source Code
+  type: code
+- uri: http://rubydoc.info/gems/smeagol/frames
+  label: Documentation
+  type: docs
+- uri: http://groups.google.com/groups/rubyworks-mailinglist
+  label: Mailing List
+  type: mail
+categories: []
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2010-08-16'
+summary: Wiki Cum Website
+title: Semagol
+version: 0.6.0
+name: smeagol
+description: ! 'Smeagol is a customizable read-only Gollum wiki server.
+
+  Smeagol makes it possible to maintain a standalone website,
+
+  but update it through the Gollum wiki interface, e.g. via GitHub.'
+organization: rubyworks
+date: '2012-07-30'

data/.yardopts

@@ -0,0 +1,9 @@
+--title "Smeagol"
+--readme README.md
+--protected
+--private
+--plugin tomdoc
+lib
+-
+[A-Z]*.*
+

data/HISTORY.md

@@ -0,0 +1,147 @@
+# RELEASE HISTORY
+
+## v0.6.0 / 2012-07-30
+
+Version 0.6 is a major refactoring of the code base. While most previous
+functionality remains, new features have been added and certain configuration
+settings have been adjusted. One of the more note-worthy changes is that
+the static generation feature has been spun-off to a new gem called Shelob.
+Another important change is the use of an initial underscore to denote special
+files. Users of the previous version should consult the updated documentation
+and adjust their sites accordingly.
+
+This release is dedicated to Ben Johnson, the original author of Smeagol.
+Thanks for all your hard work and putting the project in the care of the
+Rubyworks Foundation.
+
+Changes:
+
+* Use _layouts directory to store templates.
+* Use _settings.yml instead of settings.yml.
+* Spin-off static builds to Shelob project.
+* Add init command for setting up wiki for Smeagol.
+
+
+## v0.5.9 / 2011-09-26
+
+Bug fix release for static site generation.
+
+Changes:
+
+* Static site generator bug fixes. (kylef)
+
+
+## v0.5.8 / 2011-09-23
+
+This release adds ability to generate a static site.
+
+Changes:
+
+* Added static site generator. (kylef)
+
+
+## v0.5.7 / 2011-04-13
+
+Simple CSS style fix release. 
+
+Changes:
+
+* Fix frame in CSS.
+
+
+## v0.5.3 / 2011-02-04
+
+This release simple updates the version of Gollum dependency.
+
+Changes:
+
+* Upgrade to Gollum 1.1.1
+
+
+## v0.5.2 / 2010-11-21
+
+New release adds Google Analytics support. Just
+add a `tracking_id` to setting.yml.
+
+Changes:
+
+* Added Google Analytics support
+
+
+## v0.5.1 / 2010-10-13
+
+Release fixes bug in menu generation.
+
+Changes:
+
+* Fixed menu bug.
+
+
+## v0.5.0 / 2010-10-12
+
+This release adds support for site versions. The old
+versions of pages can be viewed by providing the commit
+id or tag name in the URL.
+
+Changes:
+
+* Added versioning using git tags.
+
+
+## v0.4.2 / 2010-10-11
+
+This release improves CSS styling, including the addition
+of a CSS reset.
+
+Changes:
+
+* Added CSS styles.
+* Added CSS reset.
+
+
+## v0.4.1 / 2010-10-04
+
+Bug release fixes missing require issue.
+
+Changes:
+
+* Missing require bug fixed.
+
+
+## v0.4.0 / 2010-10-03
+
+This release adds a number of new features, such as
+GitHub "fork me" ribbon support. It also makes a few 
+API adjustments.
+
+Changes:
+
+* Added secret update key.
+* Added GitHub ribbon support.
+* Added footer to home page.
+* Changed `is_not_home?` to `not_home?` on Mustache page view.
+* Renamed `--autoupdate` CLI option to `--auto-update`.
+* Moved update functionality into Smeagol::Wiki.
+* CSS Fixes: code & H3
+
+
+## v0.3.0 / 2010-10-01
+
+First public release of Smeagol!
+
+Changes:
+
+* Added multiple repository support.
+* Added `smeagold` process daemon.
+* Removed Bundler dependency.
+* Added HTML5 shiv for IE support.
+
+
+## v0.1.0 / 2010-09-20
+
+First private release of Smeagol.
+
+Changes:
+
+* Smeagol was born!
+

data/LICENSE.txt

@@ -0,0 +1,30 @@
+Smeagol - Read-only Gollum Server 
+(http://rubyworks.github.com/smeagol)
+
+Copyright (c) 2012 Rubyworks
+Copyright (c) 2009 Ben Johnson
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY Thomas Sawyer ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
+NO EVENT SHALL Thomas Sawyer OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+(SPDX) BSD-2-Clause License
+
+

data/README.md

@@ -1,56 +1,151 @@
-smeagol -- A Read-Only Gollum Server
-=============================================
+Smeagol - A Read-Only Gollum Server
+===================================
+
+[Website](http://rubyworks.github.com/smeagol) /
+[Documentation](http://rubydoc.info/rubyworks/smeagol) /
+[Source Code](http://github.com/rubyworks/smeagol) /
+[Report Issue](http://github.com/rubyworks/smeagol/issues)
+
 
 ## 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](http://github.com/github/gollum) wiki.
+This can be useful when you want to maintain a standalone website,
+but you want to update it through the Gollum wiki interface,
+e.g. via GitHub.
+
+Smeagol also includes a static site generator that can convert
+a Gollum wiki into a static website to be served by any hosting
+service. 
 
 Smeagol follows the rules of [Semantic Versioning](http://semver.org/) and uses
 [TomDoc](http://tomdoc.org/) for inline documentation.
 
 
+## STATUS
+
+[![Build Status](https://secure.travis-ci.org/rubyworks/smeagol.png)](http://travis-ci.org/rubyworks/smeagol)
+
+As of v0.6.0 Smeagol is in fairly good shape. It has a number of tests and they
+are all green. However the tests are far from comprehensive. So there is a some
+QA waterfalling going on here too. Probably it is best to consider the v0.6.x
+series an advanced beta set. So if you run into any issues, or see any clear ways
+to improve the project, let us know via the issues tracker to help us move
+toward a rock-solid 0.7. 
+
+
 ## INSTALLATION
 
 You can install Smeagol with RubyGems:
 
-	$ [sudo] gem install smeagol
+    $ [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.
+Ta da! You're ready to go.
+
+Of course, the first thing you need to do is clone your Gollum wiki repo.
+
+    $ git clone git@github.com:user/user.github.com.git
 
 
-## RUNNING
+## PREVIEWING
 
-To run smeagol, simply change directories to your Gollum repository and run the
-`smeagol` executable from the command line:
+To preview your site via smeagol, simply change directories to your Gollum repository
+and run `smeagol preview` from the command line:
 
-	$ cd /path/to/repo
-	$ smeagol
+    $ cd /path/to/repo
+    $ smeagol preview
 
 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
+## CUSTOMIZING
+
+Of course, you want to customize your site to suit your style. To do this you
+need to add some Smeagol support files. Use the `init` command to have Smeagol
+put the default files in place.
+
+    $ cd path/to/wiki
+    $ smeagol init
+
+In your wiki this will add a few files. One of these is `_settings.yml` which you
+use to configure smeagol for your site. See SETTINGS below.
+
+There will also be a file called `_layouts/page.mustache`. Using Mustache templating
+use this file to create a custom page layout for your site. To learn more
+about the variables available for use in this template see
+the [Smeagol Wiki](http://github.com/rubyworks/smeagol/wiki).
+
+Be sure to add these files to your repo and commit them. (You can just check
+these files in and push to the server. It will not effect you Gollum
+wiki in any way.)
+
+
+## SETTINGS
 
-There are two ways to update the repository through Smeagol:
+The `_settings.yml` file allows you to configure certain behaviors of Smeagol.
+An example `_settings.yml` file:
 
-1. Auto Update
-1. Manual Update
+    ---
+    static: public
+    url: http://trans.github.com
+    source_url: http://github.com/trans
+    title: 7R4N5.C0D3
+    author: trans
+    description:
+      Trans Programming Blog
+
+    menu:
+    - title: Homepage
+      href: "/"
+    - title: RSS Feed
+      href: "/rss.xml"
+    - title: Projects
+      href: "http://github.com/trans"
+
+See the API documentation for more details about each field.
+
+
+## SERVING 
+
+Smeagol can serve multiple Gollum repos simulataneously. To do this
+create a configuration file at `~/.smeagol/config.yml`. An example file
+looks like this:
+
+    ---
+    port: 3000
+    auto_update: true
+    cache_enabled: true
+    repositories:
+      - path: ~/websites/acme/wiki
+        cname: acme.org
+        origin: 'git@github.com:acme/acme.wiki.git'
+        ref: master
+        bare: false
+        secret: X123
+
+Then to serve the listed repositories use:
+
+    $ smeagol serve
+
+
+## UPDATING
+
+There are two ways to handle updates of the repository through Smeagol: 
+*automatic updating* and *manual updating*.
 
 To setup Smeagol to automatically update your repository in fixed intervals,
-simply pass the `--auto-update` option in the command line and Smeagol will
-automatically perform a `git pull origin master` on your repository once per
-day.
+simply pass the `--auto-update` option in the `smeagol-serve` command 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.
+To perform a manual update, simply go to the `update` route, e.g. `http://localhost:4567/update`,
+and Smeagol will perform a git pull. Of course, change the URL appropriately
+for your hostname and port.
 
 
 ## CONTRIBUTE
@@ -58,9 +153,20 @@ URL to your appropriate hostname and port.
 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.
+* Create an appropriately named topic branch that contains your change.
+* Please try to provide tests for all code you check in.
+
+Note that Smeagol uses Citron and AE for testing. And admittedly the project
+is water-falling too much at present. So if you would like to contribute, but
+don't have any specific request, writing a few tests would be a great help.
+
+
+## COPYRIGHTS
+
+Smeagol is distributed under the terms of the **BSD-2-Clause** license.
+
+* Copyright 2012 Trans, Rubyworks
+* Copyright 2009 Ben Johnson
 
-Also, to run the Cucumber tests in Smeagol, you must first install `rdiscount`:
+Please see LICENSE.txt file for details.
 
-	$ gem install rdiscount