mook 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mook.gemspec
+gemspec

data/README.md

@@ -0,0 +1,98 @@
+# Mook
+
+Mook is a simple static site generator.
+
+## Getting Started
+
+    gem install mook
+
+And you're off.
+
+
+## Site Layout
+
+```
++ my-site
+  + pages
+    - index.md
+    - about.md
+    - contact.md
+  + static
+    + css
+      - mypage.css
+  + templates
+    - _toolbar.erb
+    - default.html.erb
+```
+
+Pages go in a directory called `pages`, static content goes in a directory called `static`, templates go in `templates`.
+
+
+## Pages
+
+[blah](#bloo)
+
+A page is a Markdown document with some leading metadata:
+
+    Title: About Me
+    Template: default.html.erb
+    Order: 2
+    * * *
+    
+    I'm just a simple country [hyperchicken](#more).
+    
+    Here's some Ruby code:
+    
+    ``` ruby
+    Poop.new(:yay => "whee")
+    ```
+    
+    ## Perhaps Some More Stuff. #more
+    
+    Also, some other stuff.
+
+A few things of note:
+
+* `Title` and `Template` are mandatory, `Order` is optional.
+* Fenced (i.e., ` ``` `-surrounded) code blocks are OK, and if you add the 
+  language name, Mook will syntax highlight the code for you.
+* Adding a name to a header (i.e., `#more`) created a named anchor above that
+  header with that name so's you can link to it.
+* Strike-through (`~struckthrough~`) is supported.
+* Superscript (`2^128` or `this is the 2^(nd) time`) is supported.
+* URLs are automatically linkified.
+* Smart quotes, dashes, ellipses, etc. are all supported.
+
+
+## Templates
+
+Templates are ERB templates. They've got all the usual features, plus the
+following stuff in scope:
+
+* `site`, which wraps the idea of the site you're generating. Has a `#pages`
+  method, which returns an array of all the pages in the site.
+* `page`, which wraps the idea of the current page being rendered. Has the
+  following methods:
+  * `#name`: the page's name, as defined by the filename
+  * `#title`: the page's title
+  * `#content`: the page's Markdown content, rendered as HTML
+  * `#toc`: a nested `<ul>` list of all the page's headers, with links
+
+
+## Running
+
+Run this:
+
+    mook
+
+Then look in the `target` directory for an awesome surprise.
+
+
+## But this doesn't do what I want
+
+Sorry.
+
+## Licensing
+
+Copyright 2011 Coda Hale. Licensed to you under the MIT license. Don't screw
+this up for anyone.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler'
+include Rake::DSL
+Bundler::GemHelper.install_tasks

data/bin/mook

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require "fileutils"
+require "rubygems"
+require "mook"
+
+puts "> Loading"
+site = Mook::Site.load(FileUtils.pwd)
+puts "> Rendering"
+site.render!
+puts "> Staging"
+site.stage!
+puts "> Done"

data/lib/mook.rb

@@ -0,0 +1,15 @@
+require "redcarpet"
+require "pygments.rb"
+require "fileutils"
+require "yaml"
+require "erb"
+
+module Mook
+  MARKDOWN_EXTENSIONS = %w{ .md .mdown .markdown }
+end
+
+require "mook/site"
+require "mook/page"
+require "mook/html"
+require "mook/renderer"
+require "mook/model"

data/lib/mook/html.rb

@@ -0,0 +1,62 @@
+module Mook
+  # Renders Markdown as HTML, Pygmentizing any named code blocks and generating
+  # TOC blocks.
+  class HtmlRenderer < Redcarpet::Render::HTML
+    include Redcarpet::Render::SmartyPants
+    
+    def initialize(opts)
+      super(opts)
+      @toc = ""
+      @toc_id = 0
+      @toc_last_level = 0
+      @toc_closed = false
+    end
+
+    def block_code(code, language)
+      if language
+        Pygments.highlight(code, :lexer => language, :options => {:encoding => 'utf-8'})
+      else
+        "<pre>#{code}</pre>"
+      end
+    end
+
+    def header(text, header_level)
+      tag = if text =~ / #(.+)$/ then
+        text = text.gsub(/ #(.+)$/, "")
+        $1
+      else
+        nil
+      end
+
+      @toc_id += 1
+
+      id = if tag then tag else "toc_#{@toc_id}" end
+
+      link = "<a href=\"##{id}\">#{text}</a>"
+
+      if @toc_last_level <= 0
+        @toc << "<li>#{link}"
+      else
+        if @toc_last_level == header_level
+          @toc << "</li><li>#{link}"
+        elsif @toc_last_level < header_level
+          @toc << "<ul><li>#{link}"
+        else
+          @toc << "</ul><li>#{link}"
+        end
+      end
+
+      @toc_last_level = header_level
+
+      "<a name=\"#{id}\"></a><h#{header_level}>#{text}</h#{header_level}>"
+    end
+
+    def toc
+      unless @toc_closed
+        @toc = "<ul>#{@toc}</li></ul>"
+        @toc_closed = true
+      end
+      @toc
+    end
+  end
+end

data/lib/mook/model.rb

@@ -0,0 +1,21 @@
+module Mook
+  class Model
+    def initialize(site, page)
+      @site = site
+      @page = page
+    end
+
+    def binding
+      super
+    end
+
+  protected
+
+    attr_reader :site, :page
+    
+    def partial(name)
+      partial = ERB.new(File.read(File.join("templates", "_#{name}.erb")))
+      partial.result(self.binding)
+    end
+  end
+end

data/lib/mook/page.rb

@@ -0,0 +1,33 @@
+class Page
+  METADATA = %w{ title template order }
+  
+  def self.load(filename)
+    lines = File.read(filename)
+    m, markdown = lines.split("* * *\n", 2)
+    metadata = Hash[*m.split("\n").map { |s| s.split(": ", 2) }.map { |k, v| [k.downcase, v] }.flatten]
+    
+    raise "#{filename} has no title" unless metadata["title"]
+    raise "#{filename} has no template" unless metadata["template"]
+    
+    order = (metadata["order"] || 1000).to_i
+    
+    Page.new(File.basename(filename), metadata["title"],
+             metadata["template"], order,
+             markdown.strip)
+  end
+  
+  attr_reader :name, :title, :template, :order, :markdown
+  attr_accessor :content, :output, :toc
+  
+  def initialize(name, title, template, order, markdown)
+    @name = name.gsub(/\.[^\.]+$/, "")
+    @title = title
+    @template = template
+    @order = order
+    @markdown = markdown
+  end
+  
+  def url
+    "#{@name}.html"
+  end
+end

data/lib/mook/renderer.rb

@@ -0,0 +1,30 @@
+module Mook
+  class Renderer
+    MARKDOWN_OPTIONS = {
+      :strikethrough => true,
+      :fenced_code_blocks => true,
+      :space_after_headers => true,
+      :superscript => true,
+      :autolink => true
+    }
+    HTML_OPTIONS = {
+
+    }
+
+    def initialize(site)
+      @site = site
+    end
+
+    def render!(page)
+      renderer = HtmlRenderer.new(HTML_OPTIONS)
+      md = Redcarpet::Markdown.new(renderer, MARKDOWN_OPTIONS)
+
+      page.content = md.render(page.markdown)
+      page.toc = renderer.toc
+
+      template = ERB.new(File.read(File.join("templates", page.template)))
+      model = Model.new(@site, page)
+      page.output = renderer.postprocess(template.result(model.binding))
+    end
+  end
+end

data/lib/mook/site.rb

@@ -0,0 +1,38 @@
+module Mook
+  class Site
+    def self.load(dir)
+      pages = []
+      for page_file in Dir.glob(File.join(dir, "pages", "*"))
+        if MARKDOWN_EXTENSIONS.member?(File.extname(page_file).downcase)
+          pages << Page.load(page_file)
+        end
+      end
+      
+      Site.new(pages.sort_by { |p| p.order })
+    end
+    
+    attr_reader :pages
+
+    def initialize(pages)
+      @pages = pages
+    end
+
+    def render!
+      renderer = Renderer.new(self)
+      for page in @pages
+        renderer.render!(page)
+      end
+    end
+
+    def stage!
+      FileUtils.mkdir_p("target")
+      FileUtils.rm_rf(File.join("target", "*"))
+      FileUtils.cp_r(Dir.glob(File.join("static", "*")), "target")
+      for page in @pages
+        File.open(File.join("target", "#{page.name}.html"), "w+") do |f|
+          f << page.output
+        end
+      end
+    end
+  end
+end

data/lib/mook/version.rb

@@ -0,0 +1,3 @@
+module Mook
+  VERSION = "0.0.1"
+end

data/mook.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mook/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mook"
+  s.version     = Mook::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Coda Hale"]
+  s.email       = ["coda.hale@gmail.com"]
+  s.homepage    = "https://github.com/codahale/mook"
+  s.summary     = %q{Yet another damn site generator thing.}
+  s.description = %q{Generates static HTML files from Markdown. But, like, well.}
+  s.add_dependency('redcarpet', '>= 2.1.0')
+  s.add_dependency('pygments.rb', '>= 0.2.4')
+
+  s.rubyforge_project = "mook"
+
+  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"]
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: mook
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Coda Hale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redcarpet
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pygments.rb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 2
+        - 4
+        version: 0.2.4
+  type: :runtime
+  version_requirements: *id002
+description: Generates static HTML files from Markdown. But, like, well.
+email: 
+- coda.hale@gmail.com
+executables: 
+- mook
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/mook
+- lib/mook.rb
+- lib/mook/html.rb
+- lib/mook/model.rb
+- lib/mook/page.rb
+- lib/mook/renderer.rb
+- lib/mook/site.rb
+- lib/mook/version.rb
+- mook.gemspec
+has_rdoc: true
+homepage: https://github.com/codahale/mook
+licenses: []
+
+post_install_message: 
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: mook
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Yet another damn site generator thing.
+test_files: []
+