shinmun 0.9.2 → 1.0

data/README.md

@@ -1,26 +1,24 @@
-Shinmun - a git-based blog engine
+Shinmun - a file based blog engine
 =================================
 
-Shinmun is a small git-based blog engine. Write posts in your favorite
-editor, git-push it and serve your blog straight from a repository.
+Shinmun is a small file based blog engine. Write posts in your favorite
+editor, track them with git and deploy to Heroku. Small, fast and simple.
 
 ### Features
 
 * Posts are text files formatted with [Markdown][8], [Textile][9] or [HTML][10]
-* Runs on [Rack][6], [Kontrol][3] and [GitStore][7]
 * Deploy via [git-push][11]
+* Easy and fast deploying on Heroku
 * Index, category and archive listings
 * RSS feeds
 * Syntax highlighting provided by [CodeRay][4]
-* Markdown comments
 
 
 ### Quickstart
 
 Install the gems:
 
-    $ gem sources -a http://gems.github.com
-    $ gem install rack BlueCloth rubypants coderay georgi-git_store georgi-kontrol georgi-shinmun
+    $ gem install shinmun
 
 Create a sample blog:
 
@@ -47,14 +45,13 @@ folder:
     shinmun post '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` and open it with $EDITOR.
+in `posts/2008/9/the-title-of-the-post.md`.
 
 
 ### Post Format
 
 Each blog post is just a text file with a YAML header and a body. The
-YAML header is surrounded with 2 lines of 3 dashes. This format is
-compatible with [Jekyll][13] and [Github Pages][14].
+YAML header is surrounded with 2 lines of 3 dashes.
 
 The YAML header has following attributes:
 
@@ -97,9 +94,6 @@ in lower case:
 
 ### Directory layout
 
-    + assets
-      + print.css
-      + styles.css
     + config.ru
     + pages
       + about.md
@@ -108,16 +102,14 @@ in lower case:
       + 2008
         + 9
           + my-article.md
+    + public
+      + styles.css
     + templates
       + 404.rhtml
       + archive.rhtml
       + category.rhtml
-      + category.rxml
-      + _comments.rhtml
-      + _comment_form.rhtml
       + index.rhtml
       + index.rxml
-      + index.rhtml
       + layout.rhtml
       + page.rhtml
       + post.rhtml  
@@ -168,67 +160,38 @@ The attributes of a post are accessible via the @post variable:
     </div>
 
 
-### Commenting System
-
-Comments are stored as flat files and encoded as YAML objects. Each
-post has a corresponding comment file located at `comments/<path to
-post>`. So administration of comments is possible by editing the YAML
-file, which can be done on your local machine, as you can just pull
-the comments from your live server.
-
-
-### Deployment
-
-Shinmun can server the blog straight from the git repository. So on
-your webserver initialize a new git repo like:
-
-    $ cd /var/www
-    $ mkdir myblog
-    $ cd myblog
-    $ git init
-
-Now on your local machine, you add a new remote repository and push
-your blog to your server:
-
-    $ cd ~/myblog
-    $ git remote add live ssh://myserver.com/var/www/myblog
-    $ git push live
-
+### Deployment on Heroku
 
-On your production server, you just need the rackup file `config.ru`
-to run the blog:
+Install the Heroku gem:
 
-    $ git checkout config.ru
+    $ gem install heroku
 
-Now you can run just a pure ruby server or something like Phusion
-Passenger. Anytime you want to publish a post on your blog, you
-just write, commit and finally push a post by:
+Installing your public key:
 
-    $ git commit -a -m 'new post'
-    $ git push live
+    $ heroku keys:add
 
+    Enter your Heroku credentials.
+    Email: joe@example.com
+    Password: 
+    Uploading ssh public key /Users/joe/.ssh/id_rsa.pub
 
-### Phusion Passenger
+Create an app on Heroku.
 
-Shinmun is compatible with [Phusion Passenger][5]. Install Phusion
-Passenger as described in my [blog post][2].
+    $ heroku create myblog
+    Created http://myblog.heroku.com/ | git@heroku.com:mybblog.git
+    Git remote heroku added
 
-Assuming that you are on a Debian or Ubuntu system, you can create a
-file named `/etc/apache2/sites-available/blog`:
+Now on your local machine, you create a new remote repository and push
+your blog to Heroku:
 
-    <VirtualHost *:80>
-        ServerName myblog.com
-        DocumentRoot /var/www/blog/public
-    </VirtualHost>
-
-Enable the new virtual host:
-
-    $ a2ensite myapp
+    $ cd ~/myblog
+    $ git init
+    $ git add .
+    $ git commit -m 'initial commit'
+    $ git push heroku
 
-After restarting Apache your blog should run on Apache on your desired
-domain:
+That's it. Your blog is deployed.
 
-    $ /etc/init.d/apache2 restart
 
 
 ### GitHub Project

data/lib/shinmun.rb

@@ -1,3 +1,5 @@
+$:.unshift '../../kontrol/lib'
+
 require 'rubygems'
 require 'fileutils'
 require 'bluecloth'

data/lib/shinmun/blog.rb

@@ -30,7 +30,6 @@ module Shinmun
       FileUtils.cp_r "#{ROOT}/public", path
       FileUtils.cp_r "#{ROOT}/templates", path
       FileUtils.cp "#{ROOT}/config.ru", path
-      FileUtils.cp "#{ROOT}/.gems", path
 
       Dir.mkdir("#{path}/posts")
       Dir.mkdir("#{path}/pages")

data/lib/shinmun/post.rb

@@ -88,6 +88,7 @@ module Shinmun
     end
 
     def save
+      FileUtils.mkpath(File.dirname(path))
       File.open(path, 'w') do |io|
         io << dump
       end

data/public/{stylesheets/styles.css → styles.css}

@@ -69,23 +69,3 @@ hr {
     color: #69c;
     text-decoration: none;
 }
-
-.comments {
-    margin-bottom: 2em;
-}
-
-.comments .comment, .preview .comment {
-    margin-top: 2em;
-    border: 1px solid #ccc;
-}
-
-.comments .comment .top, .preview .comment .top  {
-    background: #F0F0F0;
-    color: #333;
-    padding: 3px 5px;
-}
-
-.comments .comment .body, .preview .comment .body {
-    background: #F8F8F8;
-    padding: 3px 5px;
-}

data/templates/index.rxml

@@ -12,7 +12,7 @@
         <title><%= post.title %></title>
         <category><%= post.category %></category>
         <description><%= strip_tags post.summary %></description>
-        <author><%= @blog.author %></author>
+        <author><%= @author || @blog.author %></author>
         <link><%= @blog.url %><%= post_path post %></link>
         <pubDate><%= rfc822 post.date %></pubDate>
       </item>

data/templates/layout.rhtml

@@ -5,8 +5,7 @@
     <meta http-equiv="Content-Language" content="English" />
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
     <link rel="alternate" type="application/rss+xml" title="RSS" href="/index.rss" />
-    <link rel="stylesheet" media="screen" type="text/css" href="/assets/styles.css" />
-    <link rel="stylesheet" media="print" type="text/css" href="/assets/print.css" />
+    <link rel="stylesheet" media="screen" type="text/css" href="/styles.css" />
   </head>
   <body>
     <div class="container">
@@ -23,20 +22,20 @@
       <hr/>
 
       <p>
-	<h4>Categories</h4>
-	<ul>
-	  <li><%= link_to 'Ruby', '/categories/ruby' %></li>
-	  <li><%= link_to 'Javascript', '/categories/javascript' %></li>
-	</ul>
+        <h4>Categories</h4>
+        <ul>
+          <li><%= link_to 'Ruby', '/categories/ruby' %></li>
+          <li><%= link_to 'Javascript', '/categories/javascript' %></li>
+        </ul>
       </p>
 
       <p>
-	<h4>Archive</h4>
-	<ul>
+        <h4>Archive</h4>
+        <ul>
           <% for year, month in @blog.archives %>
             <li><%= archive_link year, month %></li>
           <% end %>
-	</ul>
+        </ul>
       </p>
 
     </div>

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: shinmun
 version: !ruby/object:Gem::Version 
-  version: 0.9.2
+  hash: 15
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
 platform: ruby
 authors: 
 - Matthias Georgi
@@ -9,60 +14,85 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-08 00:00:00 +01:00
+date: 2011-06-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: BlueCloth
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rubypants
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rack
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
         version: "1.0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: coderay
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
         version: 0.9.1
-    version: 
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: kontrol
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.3.3
-    version: 
-description: git-based blog engine.
+        hash: 17
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  type: :runtime
+  version_requirements: *id005
+description: file based blog engine.
 email: matti.georgi@gmail.com
 executables: 
 - shinmun
@@ -71,12 +101,10 @@ extensions: []
 extra_rdoc_files: 
 - README.md
 files: 
-- .gems
 - README.md
 - LICENSE
 - Rakefile
-- public/stylesheets/print.css
-- public/stylesheets/styles.css
+- public/styles.css
 - bin/shinmun
 - config.ru
 - lib/shinmun.rb
@@ -106,23 +134,29 @@ 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"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: git-based blog engine
+summary: file based blog engine
 test_files: []
 

data/.gems

@@ -1 +0,0 @@
-shinmun --version 0.9.2

data/public/stylesheets/print.css

@@ -1,76 +0,0 @@
-body {
-    line-height:1.5;
-    font-family:"Helvetica Neue", "Lucida Grande", Arial, Verdana, sans-serif;
-    color:#000;
-    background:none;
-    font-size:10pt;
-}
-
-.container {
-    background:none;
-}
-
-h1,h2,h3,h4,h5,h6 {
-    font-family:"Helvetica Neue", Arial, "Lucida Grande", sans-serif;
-}
-
-code {
-    font:.9em "Courier New", Monaco, Courier, monospace;
-}
-
-img {
-    float:left;
-    margin:1.5em 1.5em 1.5em 0;
-}
-
-a img {
-    border:none;
-}
-
-p img.top {
-    margin-top:0;
-}
-
-hr {
-    background:#ccc;
-    color:#ccc;
-    width:100%;
-    height:2px;
-    border:none;
-    margin:2em 0;
-    padding:0;
-}
-
-blockquote {
-    font-style:italic;
-    font-size:.9em;
-    margin:1.5em;
-    padding:1em;
-}
-
-.small {
-    font-size:.9em;
-}
-
-.large {
-    font-size:1.1em;
-}
-
-.quiet {
-    color:#999;
-}
-
-.hide {
-    display:none;
-}
-
-a:link,a:visited {
-    background:transparent;
-    font-weight:700;
-    text-decoration:underline;
-}
-
-a:link:after,a:visited:after {
-    content:" (" attr(href) ") ";
-    font-size:90%;
-}