drift

Drift is a static blogging engine for Rails.

Installation

Include the gem in your Gemfile:

gem 'drift'

Usage

Creating a blog post:

$ rails g drift:blog_post 'Demo Blog Post'

# creates db/static/blog_posts/2013-06-15_235801_demo-blog-post.md

The default location for blog posts is db/static/blog_posts. The deafult markup language is Markdown.

You can specify another markup language when creating a blog post:

$ rails g drift:blog_post 'Demo Blog Post' textile
# creates db/static/blog_posts/2013-06-15_235801_demo-blog-post.textile

$ rails g drift:blog_post 'Demo Blog Post' rdoc
# creates db/static/blog_posts/2013-06-15_235801_demo-blog-post.rdoc

$ rails g drift:blog_post 'Demo Blog Post' asciidoc
# creates db/static/blog_posts/2013-06-15_235801_demo-blog-post.asciidoc

Overriding default settings:

You can change the default source location and markup language by overriding the blog_post model:

app/models/drift/blog_post.rb

module Drift
  class BlogPost < Drift::BlogPostBase
    self.source = 'public/blog/posts'
    self.markup_ext = 'textile'
  end
end

Extending functionality:

You can also use the blog_post model to extend functionality:

app/models/drift/blog_post.rb

module Drift
  class BlogPost < Drift::BlogPostBase
    belongs_to :author, :class_name => 'User'
  end
end

Blog post format:

title: Demo Blog Post
author: John Smith
version: 3


Blog content starts here. Keep two blank lines between the yaml attributes and the content.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam nisi dolor, aliquam eu 
condimentum quis, fermentum non augue. Donec quis leo volutpat, convallis arcu at, solli
citudin purus. Interdum et malesuada fames ac ante ipsum primis in faucibus. Etiam plac
erat tempus sapien, porttitor ornare augue suscipit in. Sed auctor neque sed mauris ornar
e, sit amet ullamcorper ipsum commodo. Praesent et vehicula nisl. Vivamus egestas dui a t
ortor elementum, et lacinia mauris fringilla. Mauris vestibulum felis in libero elementum,
at fermentum odio ultrices. Vivamus tempor arcu a ligula congue, sit amet venenatis elit 
sodales. Nam eget sem vehicula, scelerisque nisi nec, convallis nulla. Suspendisse pote
nti. Aenean ornare, purus a viverra pharetra, lacus velit placerat metus, vel gravida to
rtor leo eget urna. Nullam scelerisque auctor ante.

Sed pharetra enim tortor, rhoncus egestas eros aliquam et. Pellentesque porta est arcu, 
ac scelerisque tellus sodales ut. Suspendisse ullamcorper, metus a vulputate mollis, 
felis quam hendrerit sapien, porta interdum orci nunc nec ipsum. Nulla pulvinar ac lacu
s at condimentum. Curabitur a diam tristique, rhoncus magna at, adipiscing nibh. Aliqua
m erat volutpat. In tempor euismod metus, ac lobortis quam ullamcorper euismod. Morbi i
n neque facilisis, egestas nibh auctor, pretium risus.

Sed vulputate condimentum lorem, elementum venenatis massa imperdiet ut. Nulla ultricies m
etus in aliquet malesuada. Maecenas nisi quam, cursus sed tellus ut, posuere ultricies mau
ris. Morbi aliquam dignissim nisi ac euismod. Quisque vestibulum neque arcu, ac venenatis 
dolor tincidunt quis. Suspendisse at dolor libero. Cum sociis natoque penatibus et magnis 
dis parturient montes, nascetur ridiculus mus. Nulla posuere non lorem sit amet dignissim.
Nam eget justo eget mi consectetur dapibus vitae vitae mauris. Nulla vitae ullamcorper ma
gna. In in fermentum est. In lacinia venenatis turpis, a rutrum metus laoreet a. Vivamus 
adipiscing vel enim eu scelerisque.

Blog post attributes:

Yaml data set at the top of a blog post is available on the blog post model.

Don't forget to separate yaml data from blog post content with two blank lines!

Yaml data:

title: Demo Blog Post
author: John Smith
version: 3
category: Apples

Blog post attributes:

@blog_post.title # Title
@blog_post.author # Author
@blog_post.version # 1
@blog_post.category # Apples

Rails controller example:

Index url: http://www.example.com/blog_posts

Show url: http://www.example.com/blog_posts/demo-blog-post

class BlogPostsController < ApplicationController
  def index
    @blog_posts = Drift::BlogPost.all
  end

  def show
    @blog_post = Drift::BlogPost.find_by_slug(params['id'])
  end
end