shinmun 0.1

data/.gitignore

@@ -0,0 +1 @@
+*~

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2008 Matthias Georgi <http://www.matthias-georgi.de>
+ 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+ 
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,249 @@
+Shinmun, a small and beautiful blog engine
+==========================================
+
+### Intro
+
+Shinmun is a **minimalist blog engine**. You just write posts as text files,
+render them to static files and push your blog to your server.
+
+This allows you to write posts in your favorite editor like Emacs or
+VI and use a VCS like git.
+
+Your layout can be customized by set of *ERB templates*. These
+templates have access to `Post` objects and *helper methods* so that
+anybody who knows *Rails* should feel comfortable with it.
+
+Shinmun has some common features of blog engines like:
+
+* Index summary page
+* Category summary page
+* Archive pages for each month
+* RSS feeds for index and category pages
+* AJAX comment system with PHP JSON file storage
+* Integration of the WMD-Markdown Editor for comments
+
+### Quickstart
+
+Install the gem by typing:
+    gem install shinmun
+
+Issue the following commands and the output will go to the public
+folder:
+
+    cd example
+    ../bin/shinmun
+
+### Writing Posts
+
+Posts can be created by using the `shinmun` command inside your blog folder:
+
+    shinmun new 'The title of the post'
+
+Shinmun will then create a post file in the right place, for example
+in `posts/2008/9/the-title-of-the-post.md`. After creating you will
+probably open the file, set the category and start writing your new
+article.
+
+After finishing your post, you may just run `shinmun` without arguments
+and the output will be rendered to the *public* folder.
+
+
+### Post Format
+
+Each blog post is just a text file with an optional header section and
+a markup body, which are separated by a newline. 
+
+The **first line** of the header should start with 3 dashes as usual
+for a YAML document.
+
+The **first and the second line** of the body becomes the title of the
+post.
+
+The header may have following attributes:
+
+* `date`: post will show up in blog page and archive pages
+* `category`: post will show up in the defined category page
+* `guid`: will be set automatically by Shinmun
+
+Posts without a date are by definition static pages.
+
+Example post:
+
+<pre>
+
+    --- 
+    category: Ruby
+    date: 2008-09-05
+    guid: 7ad04f10-5dd6-012b-b53c-001a92975b89
+     
+    BlueCloth, a Markdown library
+    =============================
+
+    This is the summary, which is by definition the first paragraph of the
+    article. The summary shows up in category listings or the index listing.
+
+</pre>
+
+The guid should never change, as it will be you used for identifying
+posts for comments.
+
+
+### Directory layout
+
+* All your **posts** reside in the `posts` folder sorted by year/month.
+
+* All the **output** will be rendered to the `public` folder.
+
+* **Template** files are in the `templates` folder.
+
+* The **properties of your blog** defined in `posts/blog.yml`
+
+* **Static files** should be put into the directories `public/images`,
+  `public/stylesheets`, `public/javascripts`.
+
+* Archive pages will be rendered to files like `public/2008/9/index.html`.
+
+* Category pages will be rendered to files like `public/categories/ruby.html`.
+
+* The *home page* of your blog will go to `public/index.html`.
+
+An example tree:
+
+    + posts
+      + blog.yml
+      + about.md
+      + 2007
+      + 2008
+        + 9
+          + my-article.md
+
+    + public
+      + index.html
+      + about.html
+      + categories
+        + emacs.html
+        + ruby.html
+      + 2007   
+      + 2008
+        + 9
+          + my-article.html
+      + images
+      + stylesheets
+      + javascripts
+
+    + templates
+      + feed.rxml
+      + layout.rhtml
+      + page.rhtml  
+      + post.rhtml  
+      + posts.rhtml
+ 
+
+### Layout
+
+Layout and templates are rendered by *ERB*.  The layout is defined in
+`layout.rhtml`. The content will be provided in the variable
+`@content`. A minimal example:
+
+    <html>
+      <head>
+        <title><%= @blog_title %></title>
+        <%= stylesheet_link_tag 'style' %>
+      </head>
+      <body>
+         <%= @content %>
+      </body>
+     </html>
+
+
+### Helpers
+
+There are also helper methods, which work the same way like the *Rails*
+helpers. The most important ones are these:
+    
+* `stylesheet_link_tag(*names)` links a stylesheet with a timestamp
+
+* `javascript_tag(*names)` includes a javascript with a timestamp
+
+* `image_tag(src, options = {})` renders an image tag
+
+* `link_to(text, path, options = {})` renders a link
+
+Stylesheets, javascripts and images should be included by using theses
+helpers. The helper methods will include a timestamp of the
+modification time as `querystring`, so that the browser will fetch the
+new resource if it has been changed.
+
+
+### Post Template
+
+The attributes of a post are accessible as instance variables in a template:
+
+    <div class="article">    
+
+      <div class="date">
+        <%= date @date %>
+      </div>
+     
+      <h2><%= @title %></h2>  
+     
+      <%= @body %>
+     
+      <h3>Comments</h3>
+
+      <!-- Here you may put my commenting system -->
+    </div>
+
+
+
+### RSS Feeds
+
+Feeds will be rendered by one *ERB template*. Some of the variables
+have been read from the `blog.yml`, like `@blog_title`, other variables
+have been determined by the engine like `@posts` and `@category`.
+
+    <?xml version="1.0" encoding="utf-8"?>
+    <rss version="2.0"> 
+      <channel>
+        <title><%= @category ? @blog_title + ' - ' + @category : @blog_title %></title>
+        <link><%= @blog_url %></link>
+        <description><%= @category ? 'Category ' + @category : @blog_description %></description>
+        <language><%= @blog_language %></language>
+        <copyright><%= @blog_author %></copyright>
+        <pubDate><%= rfc822 Time.now %></pubDate>
+        <% for post in @posts %>
+          <item>
+            <title><%= post.title %></title>
+            <description><%= post.text_summary %></description>
+            <link><%= post.link %></link>
+            <author><%= @blog_author %></author>
+            <guid><%= post.guid %></guid>
+            <pubDate><%= rfc822 post.date %></pubDate>
+          </item>
+        <% end %>
+      </channel> 
+    </rss>
+
+### Commenting System
+
+As I am not willing to build up a whole Rails stack for a single blog,
+I was looking for a simple storage for comments. I really like the
+JSON format. It works seamlessly with Javascript libraries and can be
+serialized and deserialized from almost any language.
+
+Read about my [lightweight commenting system][2].
+
+
+### Download
+
+Simply install the gem:
+
+    gem install shinmun
+
+
+Download or fork the package at my [github repository][1]
+
+
+
+[1]: http://github.com/georgi/shinmun/tree/master
+[2]: commenting-system-with-lightweight-json-store.html

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+
+require 'rake'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'fileutils'
+
+spec = Gem::Specification.new do |s|
+  s.name = "shinmun"
+  s.version = `git describe`.strip.sub(/-.*/, '')
+  s.platform = Gem::Platform::RUBY
+  s.summary = "a small blog engine"
+  
+  s.description = <<-EOF
+Shinmun is a blog engine, which renders text files using a markup
+language like Markdown and a set of templates into static web
+pages. It supports Categories, Archives and RSS Feeds. Commenting can
+be done with some Javascript, PHP and a flat file JSON store.
+EOF
+  
+  s.files = `git ls-files`.split("\n")
+  s.bindir = 'bin'
+  s.executables << 'shinmun'
+  s.require_path = 'lib'
+  s.add_dependency 'uuid', '>=2.0.0'
+  s.add_dependency 'BlueCloth', '>=1.0.0'
+  s.add_dependency 'rubypants', '>=0.2.0'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.md']
+  
+  s.author = 'Matthias Georgi'
+  s.email = 'matti.georgi@gmail.com'
+  s.homepage = 'http://shinmun.rubyforge.org'
+  s.rubyforge_project = 'shinmun'
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = false
+  p.need_zip = false
+end
+
+ 
+desc "Generate RDoc documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--main' << 'README' <<
+    '--title' << 'Shinmun Documentation' <<
+    '--charset' << 'utf-8'
+  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_files.include 'README.md'
+  rdoc.rdoc_files.include('lib/shinmun.rb')
+end
+
+
+task :push => [:rdoc] do
+  sh "rsync -avz doc/ mgeorgi@rack.rubyforge.org:/var/www/gforge-projects/shinmun"
+end

data/bin/shinmun

@@ -0,0 +1,12 @@
+#! /usr/bin/env ruby
+
+require 'shinmun'
+
+blog = Shinmun::Blog.new
+
+case ARGV[0]
+when 'new'
+  blog.create_post(ARGV[1])
+else
+  blog.write_all
+end

data/example/posts/2008/9/example.md

@@ -0,0 +1,19 @@
+--- 
+category: Ruby
+guid: 72ece880-5e32-012b-362f-001a92975b89
+date: 2008-09-01
+
+Example post
+============
+
+This is the first paragraph. Below is a code example:
+
+    # Return the first paragraph of rendered html.
+    def summary
+      body.split("\n\n")[0]
+    end
+
+    # Return the first paragraph of source text.
+    def text_summary
+      src.split("\n\n")[1]
+    end

data/example/posts/blog.yml

@@ -0,0 +1,10 @@
+blog_title: The title of the blog
+blog_description: Blog description
+blog_language: en
+blog_author: The author
+blog_url: http://www.example.com
+categories:
+  - Ruby
+  - Emacs
+
+

data/example/posts/uuid.state

@@ -0,0 +1,3 @@
+mac_addr: "00:1a:92:97:5b:89"
+sequence: "0x3630"
+last_clock: "0x2b5e3272ece3d8"

data/example/public/controllers/comments.php

@@ -0,0 +1,56 @@
+<?php
+
+$guid_pattern = "/^(\{{0,1}([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}\}{0,1})$/";
+$req = $_REQUEST;
+$guid = $req['guid'];
+
+preg_match($guid_pattern, $guid) or die("invalid guid");
+
+$file = 'comments/' . $guid;
+
+if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+
+  // create a comment record
+  $record = array(date('Y-m-d H:i:s'), 
+		  strip_tags(stripslashes($req['name'])),
+		  strip_tags(stripslashes($req['website'])),
+		  strip_tags(stripslashes($req['text'])));
+
+  // encode as json string
+  $json = json_encode($record) . "\n";
+
+  // open the comment file for appending
+  $fp = fopen($file, "a");
+
+  // acquire a write lock
+  flock($fp, LOCK_EX);
+
+  // append the json line
+  fwrite($fp, $json);
+
+  // release lock
+  flock($fp, LOCK_UN);
+
+  // close file and release lock
+  fclose($fp);
+}
+
+if (file_exists($file)) {
+
+  // open the comment file for reading
+  $fp = fopen($file, "r");
+
+  // acquire a read lock
+  flock($fp, LOCK_SH);
+
+  // read whole file and print it out
+  echo fread($fp, filesize($file));
+
+  // release lock
+  flock($fp, LOCK_UN);
+
+  // close file
+  fclose($fp);
+}
+
+?>

data/example/public/javascripts/comments.js

@@ -0,0 +1,60 @@
+$('.comment-form form').ajaxForm({
+    url: Blog.root + 'controllers/comments.php',
+    type: 'POST',
+    resetForm: true,
+    beforeSubmit: function(values) {
+	if (values[1].value && values[3].value) {
+            $('.comment-form-loading').show();
+	    return true;
+	}
+	else {
+	    alert('Please enter name and text!');
+	    return false;
+	}
+    },
+    success: function(data) {
+        $('.comment-form-loading').hide();
+	renderComments(data);
+    }
+});
+
+function renderComments(data) {
+    var converter = new Showdown.converter();
+    var lines = data.split("\n");
+    var comments = [];
+    for (var i = 0; i < lines.length; i++) {
+	var row = eval(lines[i]);
+	if (row) {
+	    comments.push({
+		time: row[0],
+		name: row[1],
+		website: row[2],
+		text: converter.makeHtml(row[3])
+	    });
+	}
+    }
+    $('.comments-loading').hide();
+    $('.comments').expand(Template.comments, { comment: comments });
+    $('.comments a').prettyDate();
+}
+
+function loadComments() {
+    $('.comments-loading').show();
+    $.ajax({
+	type: "GET",
+	url: Blog.root + 'controllers/comments.php',
+	data: {
+	    guid: Blog.guid
+	},
+	complete: function(response) {
+	    renderComments(response.responseText);
+	}
+    });
+}
+
+$(function() {
+    if ($('.comments').length > 0) {
+	Template.comments = new Template('comments-template');
+	loadComments();
+    }
+});