postmarkdown 0.0.1

data/lib/generators/postmarkdown/usage/install.txt

@@ -0,0 +1,10 @@
+Description:
+  This generator will create the directory structure and routes required by Postmarkdown. As an added bonus, it will create an example post for the current date.
+
+Example:
+  $ rails generate postmarkdown:install
+
+  This will:
+    - Create the directory `app/posts/`.
+    - Generate an example post using today's date: `app/posts/{{CURRENT_DATE}}-example-post.markdown`.
+    - Add default routes.

data/lib/generators/postmarkdown/usage/override.txt

@@ -0,0 +1,9 @@
+Description:
+  This generator will override either the Post model, controller or views.
+
+Examples:
+  $ rails generate postmarkdown:override --all        # overrides all of the things
+  $ rails generate postmarkdown:override --controller # overrides file `app/controllers/posts_controller.rb`
+  $ rails generate postmarkdown:override --model      # overrides file `app/models/post.rb`
+  $ rails generate postmarkdown:override --views      # overrides all files in directory `app/views/posts/`
+  $ rails generate postmarkdown:override --theme      # overrides the layout and stylesheet

data/lib/generators/postmarkdown/usage/post.txt

@@ -0,0 +1,14 @@
+Description:
+  This generator will produce a new post by creating a markdown file in the `app/posts/` directory. The filename for the new file will be generated using the slug and publish date specified.
+
+Example 1:
+  $ rails generate postmarkdown:post example-1
+
+  This will:
+    - Generate a new post using the slug specified and today's date: `app/posts/{{CURRENT_DATE}}-example-1.markdown`.
+
+Example 2:
+  $ rails generate postmarkdown:post example-2 --date=2012-04-10
+
+  This will:
+    - Generate a new post using the slug and publish date specified: `app/posts/2012-04-10-example-2.markdown`.

data/lib/postmarkdown.rb

@@ -0,0 +1,5 @@
+require 'postmarkdown/engine'
+require 'postmarkdown/config'
+require 'postmarkdown/routes'
+require 'postmarkdown/railtie'
+require 'postmarkdown/util'

data/lib/postmarkdown/config.rb

@@ -0,0 +1,22 @@
+module Postmarkdown
+  module Config
+    extend self
+
+    @options = {}
+    attr_accessor :options
+  end
+end
+
+Postmarkdown::Config.options[:feed_title] = nil
+
+Postmarkdown::Config.options[:permalink_format] = :day
+
+Postmarkdown::Config.options[:use_theme] = false
+
+Postmarkdown::Config.options[:permalink_regex] = {}
+Postmarkdown::Config.options[:permalink_regex][:day]   = %r[\d{4}/\d{2}/\d{2}/[^/]+]
+Postmarkdown::Config.options[:permalink_regex][:month] = %r[\d{4}/\d{2}/[^/]+]
+Postmarkdown::Config.options[:permalink_regex][:year]  = %r[\d{4}/[^/]+]
+Postmarkdown::Config.options[:permalink_regex][:slug]  = %r[[^/]+]
+
+Postmarkdown::Config.options[:markdown_file_extensions] = %w(md mkd mdown markdown)

data/lib/postmarkdown/engine.rb

@@ -0,0 +1,12 @@
+module Postmarkdown
+  require 'postmarkdown'
+  require 'rails'
+  require 'gravtastic'
+  require 'rdiscount'
+  require 'nokogiri'
+  require 'haml'
+  require 'kaminari'
+
+  class Engine < Rails::Engine
+  end
+end

data/lib/postmarkdown/railtie.rb

@@ -0,0 +1,18 @@
+module Postmarkdown
+  class Railtie < Rails::Railtie
+    initializer :before_initialize do
+      require 'rack'
+      Rails.configuration.middleware.insert_before('Rack::Sendfile', 'Rack::Static',
+        :urls => ['/stylesheets/postmarkdown'],
+        :root => "#{postmarkdown_root}/public"
+      )
+      ActionController::Base.prepend_view_path("#{postmarkdown_root}/app/views")
+    end
+
+    private
+
+    def postmarkdown_root
+      File.expand_path(File.dirname(__FILE__) + '/../..')
+    end
+  end
+end

data/lib/postmarkdown/routes.rb

@@ -0,0 +1,29 @@
+class ActionDispatch::Routing::Mapper
+  require 'postmarkdown/util'
+
+  def postmarkdown(options = {})
+    options.reverse_merge!({ :as => :posts, :permalink_format => :day })
+
+    get "/#{options[:as]}(/:year(/:month(/:day)))" => 'posts#index', :as => :posts, :constraints => { :year => /\d{4}/, :month => /\d{2}/, :day => /\d{2}/}
+    get "/#{options[:as]}/feed" => 'posts#feed', :as => :posts_feed, :format => :xml
+    get "/#{options[:as]}/*id" => 'posts#show', :as => :post, :constraints => { :id => postmarkdown_permalink_regex(options) }
+
+    postmarkdown_feed_title(options[:as])
+  end
+
+  private
+
+  def postmarkdown_permalink_regex(options)
+    Postmarkdown::Config.options[:permalink_format] = options[:permalink_format]
+    Postmarkdown::Config.options[:permalink_regex].try(:[], options[:permalink_format]) or raise_postmarkdown_permalink_error
+  end
+
+  def postmarkdown_feed_title(path)
+    Postmarkdown::Config.options[:feed_title] ||= "#{Postmarkdown::Util.app_name} #{path.to_s.tr('/', '_').humanize.titleize}"
+  end
+
+  def raise_postmarkdown_permalink_error
+    possible_options = Postmarkdown::Config.options[:permalink_regex].map { |k,v| k.inspect }.join(', ')
+    raise "Postmarkdown Routing Error: Invalid :permalink_format option #{Postmarkdown::Config.options[:permalink_format].inspect} - must be one of the following: #{possible_options}"
+  end
+end

data/lib/postmarkdown/util.rb

@@ -0,0 +1,12 @@
+module Postmarkdown
+  module Util
+    def self.app_name
+      Rails.application.class.name.split('::')[0..-2].join.titleize
+    end
+
+    def self.git_config(name)
+      value = `git config --get #{name}`.chomp
+      value if $?.success?
+    end
+  end
+end

data/lib/postmarkdown/version.rb

@@ -0,0 +1,3 @@
+module Postmarkdown
+  VERSION = '0.0.1'
+end

data/postmarkdown.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'postmarkdown/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'postmarkdown'
+  s.version     = Postmarkdown::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Jason Weathered', 'Nathanael Kane',  'Odin Dutton', 'Adrian Smith']
+  s.email       = ['jason.weathered@ennova.com.au', 'nate.kane@ennova.com.au', 'odin.dutton@ennova.com.au', 'adrian.smith@ennova.com.au']
+  s.licenses    = ['MIT']
+
+  s.homepage    = ''
+  s.summary     = %q{A simple Rails blog engine powered by markdown.}
+  s.description = s.summary
+
+  s.rubyforge_project = 'postmarkdown'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib', 'public']
+
+  s.add_dependency 'rails', '~> 3.0'
+  s.add_dependency 'haml', '~> 3.1'
+  s.add_dependency 'gravtastic'
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'rdiscount'
+  s.add_dependency 'kaminari'
+
+  s.add_development_dependency 'rspec-rails', '~> 2.5'
+  s.add_development_dependency 'capybara', '~> 1.0.0.beta'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'delorean', '>= 0.2'
+end

data/public/stylesheets/postmarkdown/postmarkdown.css

@@ -0,0 +1,67 @@
+/* -- Reset ----------------------------------------------------------------- */
+body,div,dl,dt,dd,ul,ol,li,h1,h2,h4,h4,h5,h6,pre,code,form,fieldset,legend,input,button,textarea,p,blockquote,th,td{margin:0;padding:0}
+table{border-collapse:collapse;border-spacing:0}
+fieldset,img{border:0}
+address,caption,cite,code,dfn,em,strong,th,var,optgroup{font-style:inherit;font-weight:inherit}
+del,ins{text-decoration:none}
+li{list-style:none}
+caption,th{text-align:left}
+h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:400}
+q:before,q:after{content:''}
+abbr,acronym{border:0;font-variant:normal}
+legend{color:#000}
+input,button,textarea,select,optgroup,option{font-family:inherit;font-size:inherit;font-style:inherit;font-weight:inherit}
+input,button,textarea,select{font-size:100%}
+sup,sub{vertical-align:baseline}
+header, nav, section, article, footer{display:block;}
+
+/* -- Global ---------------------------------------------------------------- */
+html{background:#F3F3F3;text-shadow:0px 1px 0px #fff;}
+body{width:760px;margin:40px auto;font:14px/140% 'Helvetica Neue', Arial, Helvetica, Sans-Serif;}
+a{color:#222;}
+
+h1, h2, h3, h4, h5, h6{font-weight:bold;}
+h1{font-size:26px;margin-bottom:5px;}
+h1 a{text-decoration:none;}
+h2{font-size:24px;padding-top:10px;margin:30px 0 20px;border-top:2px solid #ccc;}
+h3{font-size:20px;margin-bottom:20px;}
+h4{font-size:18px;margin-bottom:10px;}
+h5, h6{font-size:16px;margin-bottom:5px;}
+
+p{margin-bottom:20px;}
+em{font-style:italic;}
+sup{font-size:12px;vertical-align:super;}
+sub{font-size:12px;vertical-align:sub;}
+del{color:#666;font-style:line-through;}
+abbr{border-bottom:1px dotted #bbb;color:#666;text-transform:uppercase;}
+code{background:#eee;padding:2px 5px;font-family:Monospace;}
+small{color:#999;font-size:12px;}
+strong{font-weight:bold;}
+blockquote{color:#666;font-size:16px;margin-left:20px;font-family:Georgia, Serif;}
+
+/* code */
+pre{background:#eee;margin-bottom:20px;padding:10px;border:1px solid #ccc;border-width:1px 0;}
+
+/* lists */
+ol, ul{margin:0 0 20px 20px;}
+ol li{list-style:decimal inside;}
+ul li{list-style:disc inside;}
+
+/* -- Header ---------------------------------------------------------------- */
+header#header     {margin-bottom:40px;}
+header#header h1  {font-size:42px;margin-bottom:10px;font-family:Georgia, Serif;font-weight:normal;}
+header#header p   {color:#999;}
+
+/* -- Content --------------------------------------------------------------- */
+section#content{}
+
+section#content section article p{margin-bottom:10px;}
+
+section#content article{margin-bottom:40px;}
+section#content article header{overflow:hidden;}
+section#content article header h1{}
+section#content article header img{display:none;}
+section#content article header .meta{color:#999;font-size:12px;}
+
+/* -- Footer ---------------------------------------------------------------- */
+footer{margin-bottom:20px;}

data/readme.md

@@ -0,0 +1,143 @@
+# Postmarkdown
+
+A simple Rails blog engine powered by Markdown.
+
+Postmarkdown is compatible with Rails 3 only and the gem is (soon to be) hosted on [RubyGems.org](http://rubygems.org).
+
+## Features
+
+* Markdown files for blog posts
+* No database
+* RSS Feed
+* Customizable Routes
+* Built-in minimal theme (optional)
+* HTML5
+* Rails engine (so you can override models, views, controllers, etc)
+* Easily customized
+
+## Installation
+
+Simply add Postmarkdown to your Gemfile and bundle it up:
+
+    gem 'postmarkdown'
+
+Then, run the generator to setup Postmarkdown for your application:
+
+    $ rails generate postmarkdown:install
+
+The above command performs the following actions:
+
+* Create the directory `app/posts/`. This directory is where your markdown files will live.
+* Generate an example post using today's date, eg. `app/posts/2011-01-01-example-post.markdown`.
+* Add some routes. By default the routes are setup underneath the path `/posts/*`, to customize these routes check out the Customizing Routes section below.
+
+## Usage
+
+### Generate a new Post
+
+Here's an example of how to generate a new post using a slug and publish date:
+
+    $ rails generate postmarkdown:post test-post --date=2011-01-01
+
+The above command will create the file `app/posts/2011-01-01-test-post.markdown`, which you can edit and add content to.
+
+### View the Post
+
+Open `http://localhost:3000/posts` in your browser and you should be able to navigate to your new post. The URL for your new post is `http://localhost:3000/posts/2011/01/01/test-post`.
+
+## Overriding Files
+
+The easiest way to customize the Postmarkdown functionality or appearance is by using the override generator. This generator can copy files from the Postmarkdown core and place them into your Rails app. For example:
+
+    $ rails generate postmarkdown:override --all        # overrides all of the things
+    $ rails generate postmarkdown:override --controller # overrides `app/controllers/posts_controller.rb`
+    $ rails generate postmarkdown:override --model      # overrides `app/models/post.rb`
+    $ rails generate postmarkdown:override --views      # overrides all files in directory `app/views/posts/`
+    $ rails generate postmarkdown:override --theme      # overrides the layout and stylesheet
+
+## RSS Feed
+
+Postmarkdown comes prepared with a fully functional RSS feed.
+
+You can take advantage of the built-in feed by adding the feed link to your HTML head tag. For example, simply add the following to your default layout:
+
+    <head>
+      <!-- include your stylesheets and javascript here... -->
+      <%= yield :head %>
+    </head>
+
+To customize the feed title, add the following to an initializer (`config/initializers/postmarkdown.rb`):
+
+    Postmarkdown::Config.options[:feed_title] = 'Custom Blog Title Goes Here'
+
+To link to the feed in your app, simply use the route helper: `<%= link_to 'RSS Feed', posts_feed_path %>`
+
+## Built-in Theme
+
+Postmarkdown comes with minimal built-in theme for your convenience. To turn on the theme, add the following to an initializer (`config/initializers/postmarkdown.rb`):
+
+    Postmarkdown::Config.options[:use_theme] = true
+
+## Customizing Routes
+
+By default Postmarkdown will setup all routes to go through the `/posts/*` path. For example:
+
+    http://example.com/posts                      # lists all posts
+    http://example.com/posts/2011                 # lists all posts from 2011
+    http://example.com/posts/2011/01              # lists all posts from January 2011
+    http://example.com/posts/2011/01/01           # lists all posts from the 1st of January 2011
+    http://example.com/posts/2011/01/01/test-post # show the specified post
+
+You can change the default route path by modifying the 'postmarkdown' line in `routes.rb`. For example:
+
+    postmarkdown :as => :blog
+
+This will produce the following routes:
+
+    http://example.com/blog                      # lists all posts
+    http://example.com/blog/2011                 # lists all posts from 2011
+    http://example.com/blog/2011/01              # lists all posts from January 2011
+    http://example.com/blog/2011/01/01           # lists all posts from the 1st of January 2011
+    http://example.com/blog/2011/01/01/test-post # show the specified post
+
+You can also customize the `posts#show` route via the `:permalink_format` option:
+
+    postmarkdown :as => :blog, :permalink_format => :day   # URL: http://example.com/blog/2011/01/01/test-post
+    postmarkdown :as => :blog, :permalink_format => :month # URL: http://example.com/blog/2011/01/test-post
+    postmarkdown :as => :blog, :permalink_format => :year  # URL: http://example.com/blog/2011/test-post
+    postmarkdown :as => :blog, :permalink_format => :slug  # URL: http://example.com/blog/test-post
+
+What about mapping Postmarkdown to root? We got you covered:
+
+    postmarkdown :as => ''
+    root :to => 'posts#index'
+
+## Example Directory Structure
+
+    ├── app
+    │   ├── controllers
+    │   ├── helpers
+    │   ├── mailers
+    │   ├── models
+    │   ├── posts (where your markdown files live)
+    │   │   ├── 2011-04-01-example-1.markdown
+    │   │   ├── 2011-04-02-example-2.markdown
+    │   │   ├── 2011-04-03-example-3.markdown
+    │   │   ├── 2011-04-04-example-4.markdown
+    │   └── views
+    │       └── posts (overridable)
+    │           ├── _feed_link.html.haml
+    │           ├── _post.html.haml
+    │           ├── feed.xml.builder
+    │           ├── index.html.haml
+    │           └── show.html.haml
+
+## TODO
+
+* Syntax highlighting for code blocks
+* Generated routes should show example usage
+* Support more file formats, eg. textile
+
+## License
+
+MIT License. Copyright 2011 Ennova.

data/spec/acceptance/posts_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+
+describe 'Post views', :type => :request do
+  before do
+    time_travel_to '2011-05-01'
+    Post.reset!
+  end
+
+  after { back_to_the_present }
+
+  context 'Posts#index' do
+    before { visit posts_path }
+
+    it 'should show published posts' do
+      # 2011-05-01-full-metadata (published today)
+      page.should have_content('Post with full metadata')                # title
+      page.should have_content('Posted on 1 May 2011')                   # publish date
+      page.should have_content('by John Smith')                          # author
+      page.should have_content('This is another custom & test summary.') # summary
+
+      # 2011-04-28-summary
+      page.should have_content('A Test Post')                      # title
+      page.should have_content('Posted on 28 April 2011')          # publish date
+      page.should have_content('This is a custom & test summary.') # summary
+
+      # 2011-04-28-image
+      page.should have_content('Image')                   # title
+      page.should have_content('Posted on 28 April 2011') # publish date
+      page.should have_content('Image description.')      # summary
+
+      # 2011-04-01-first-post
+      page.should have_content('First Post')                 # title
+      page.should have_content('Posted on 1 April 2011')     # publish date
+      page.should have_content('Lorem ipsum dolor sit amet') # part of summary
+    end
+
+    it 'should not show unpublished posts' do
+      # 2015-02-13-custom-title (not published yet)
+      page.should_not have_content('This is a custom title') # title
+      page.should_not have_content('Content goes here.')     # summary
+    end
+
+    it 'should have the correct number of posts' do
+      all('section#posts article.post').size.should == 4
+    end
+  end
+
+  context 'Posts#index with no posts' do
+    it 'should show a message' do
+      time_travel_to '2010-05-01'
+      visit posts_path
+
+      page.should have_content('No posts found.')
+      page.should_not have_content('First Post')
+    end
+  end
+
+  context 'Posts#index with year' do
+    before { visit posts_path(:year => '2011') }
+
+    it 'should show posts inside the date range' do
+      page.should have_content('Post with full metadata')
+      page.should have_content('A Test Post')
+      page.should have_content('Image')
+      page.should have_content('First Post')
+    end
+  end
+
+  context 'Posts#index with year and month' do
+    before { visit posts_path(:year => '2011', :month => '04') }
+
+    it 'should show posts inside the date range' do
+      page.should have_content('A Test Post')
+      page.should have_content('Image')
+      page.should have_content('First Post')
+    end
+
+    it 'should not show posts outside the date range' do
+      page.should_not have_content('Post with full metadata')
+    end
+  end
+
+  context 'Posts#index with year, month and day' do
+    before { visit posts_path(:year => '2011', :month => '04', :day => '01') }
+
+    it 'should show posts inside the date range' do
+      page.should have_content('First Post')
+    end
+
+    it 'should not show posts outside the date range' do
+      page.should_not have_content('A Test Post')
+      page.should_not have_content('Image')
+      page.should_not have_content('Post with full metadata')
+    end
+  end
+
+  context 'Posts#show' do
+    before { visit post_path('2011/05/01/full-metadata') }
+
+    it 'should have content' do
+      page.should have_content('Post with full metadata') # title
+      page.should have_content('Posted on 1 May 2011')    # publish date
+      page.should have_content('by John Smith')           # author
+
+      # body
+      page.should have_content('First paragraph of content.')
+      page.should have_content('Second paragraph of content.')
+    end
+
+    it 'should not show the summary' do
+      page.should_not have_content('This is another custom & test summary.')
+    end
+
+    it 'should preserve whitespace on code blocks' do
+      page.source.should match '<pre><code>First line of code.&#x000A;  Second line of code.&#x000A;</code></pre>'
+    end
+  end
+
+  context 'Posts#feed' do
+    before { visit posts_feed_path }
+
+    it 'should be xml format type' do
+      page.response_headers['Content-Type'].should == 'application/atom+xml; charset=utf-8'
+    end
+
+    it 'should be valid xml' do
+      lambda do
+        Nokogiri::XML::Reader(page.source)
+      end.should_not raise_error
+    end
+
+    it 'should contain the correct number of entries' do
+       Nokogiri::XML(page.source).search('entry').size.should == 4
+    end
+
+    it 'should contain an entry that is properly constructed' do
+      entry = Nokogiri::XML(page.source).search('entry').first
+
+      entry.search('title').text.should == 'Post with full metadata'
+      entry.search('author').first.search('name').text.should == 'John Smith'
+      entry.search('author').first.search('email').text.should == 'john.smith@example.com'
+      entry.search('published').text.should == '2011-05-01T00:00:00Z'
+      entry.search('content').text == "\n      <p>First paragraph of content.</p>\n\n<p>Second paragraph of content.</p>\n\n    "
+    end
+  end
+
+  context 'Posts#show with invalid slug' do
+    it 'should raise an not found exception' do
+      lambda do
+        visit post_path('2011/05/01/invalid')
+      end.should raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
+  context 'theme' do
+    it 'should not use the built-in layout by default' do
+      visit posts_path
+      page.should_not have_content('A postmarkdown blog')
+    end
+
+    it 'should use the built-in layout when the global option is set' do
+      Postmarkdown::Config.options[:use_theme] = true
+      visit posts_path
+      page.should have_content('A postmarkdown blog')
+    end
+  end
+end