howl 0.1.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2009 Clinton R. Nixon <crnixon@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/README.markdown

@@ -0,0 +1,31 @@
+# Howl
+
+Howl is a tiny static site generator.
+
+## File structure
+
+    /pages
+      index.html
+      about.html
+    /posts
+      first-post.html
+      my-cat-died.html
+    /templates
+      default.html
+      alternate.html
+    /site
+      <generated files go here>
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Clinton R. Nixon. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "howl"
+    gem.summary = %Q{A tiny static website/blog generator.}
+    gem.description = %Q{Howl is a tiny static website/blog generator.}
+    gem.email = "crnixon@gmail.com"
+    gem.homepage = "http://github.com/crnixon/howl"
+    gem.authors = ["Clinton R. Nixon"]
+    gem.add_development_dependency "riot", ">= 0.11"
+    gem.add_runtime_dependency 'rdiscount'
+    gem.add_runtime_dependency 'mustache'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "howl #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/howl.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{howl}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Clinton R. Nixon"]
+  s.date = %q{2010-10-15}
+  s.description = %q{Howl is a tiny static website/blog generator.}
+  s.email = %q{crnixon@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "Gemfile",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "howl.gemspec",
+     "lib/howl.rb",
+     "test/fixtures/pages/has_template.html",
+     "test/fixtures/pages/no_yaml.html",
+     "test/fixtures/pages/simple.html",
+     "test/fixtures/site/has_template.html",
+     "test/fixtures/site/no_yaml.html",
+     "test/fixtures/site/simple.html",
+     "test/fixtures/templates/alt.html",
+     "test/fixtures/templates/default.html",
+     "test/fixtures/templates/site.html",
+     "test/howl_test.rb",
+     "test/teststrap.rb"
+  ]
+  s.homepage = %q{http://github.com/crnixon/howl}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A tiny static website/blog generator.}
+  s.test_files = [
+    "test/howl_test.rb",
+     "test/teststrap.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<riot>, [">= 0.11"])
+      s.add_runtime_dependency(%q<rdiscount>, [">= 0"])
+      s.add_runtime_dependency(%q<mustache>, [">= 0"])
+    else
+      s.add_dependency(%q<riot>, [">= 0.11"])
+      s.add_dependency(%q<rdiscount>, [">= 0"])
+      s.add_dependency(%q<mustache>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<riot>, [">= 0.11"])
+    s.add_dependency(%q<rdiscount>, [">= 0"])
+    s.add_dependency(%q<mustache>, [">= 0"])
+  end
+end
+

data/lib/howl.rb

@@ -0,0 +1,102 @@
+require 'yaml'
+require 'rdiscount'
+require 'mustache'
+require 'pathname'
+require 'fileutils'
+
+$:.unshift File.dirname(__FILE__)
+
+module Howl
+  class Site
+    attr_accessor :root
+
+    def initialize(root)
+      @root = Pathname.new(root)
+    end
+
+    def path(path)
+      root + path
+    end
+
+    def pages
+      @pages ||= Dir[path "pages/*"].map { |path| Page.new(path, self) }
+    end
+
+    def templates
+      @templates ||= Hash[Dir[root + "templates/*"].map { |path| 
+        [Pathname.new(path).relative_path_from(path "templates").to_s, 
+         Template.new(path, self)] 
+      }]
+    end
+
+    def write_to_disk
+      FileUtils.rm_r(path "site") if File.exist?(path "site")
+      FileUtils.makedirs(path "site")
+      pages.each do |page|
+        page.output_path.open("w") do |fh|
+          fh.write page.render
+        end
+      end
+    end
+  end
+
+  class Template
+    attr_accessor :data, :content, :site
+
+    def initialize(path, site)
+      @site = site
+      @path = Pathname.new(path)
+      @extension = @path.extname
+      load_file
+    end
+
+    def ==(other)
+      self.path == other.path && self.class == other.class
+    end
+
+    def render(render_data = {})
+      render_data.merge!(@data)
+      rendered = Mustache.render(@content, render_data)
+      template = render_data.delete("template")
+      if template
+        rendered = @site.templates[template + @extension].render(render_data.merge("content" => rendered))
+      end
+
+      rendered
+    end
+    private
+
+    def load_file
+      content = @path.read
+      data, content = content.split("\n\n", 2)
+
+      if test_for_yaml(data)
+        @data = YAML.load(data)
+        @content = content
+      else
+        @data = {}
+        @content = "#{data}\n\n#{content}".strip
+      end
+    end
+
+    def test_for_yaml(data)
+      begin
+        data = YAML.load(data)
+        data.is_a?(Hash)
+      rescue ArgumentError
+        false
+      end
+    end
+  end
+
+  class Page < Template
+    attr_accessor :path
+
+    def output_path
+      site.path("site") + path.relative_path_from(site.path "pages")
+    end
+  end
+
+  class Post < Template
+  end
+end

data/test/fixtures/pages/has_template.html

@@ -0,0 +1,4 @@
+template: default
+title: This page has a template
+
+Hello world!

data/test/fixtures/pages/no_yaml.html

@@ -0,0 +1 @@
+This page has no YAML front-matter.

data/test/fixtures/pages/simple.html

@@ -0,0 +1,3 @@
+title: This is a simple page
+
+<h1>{{title}}</h1>

data/test/fixtures/site/has_template.html

@@ -0,0 +1,9 @@
+<html>
+<head><title>This page has a template</title></head>
+<h1>This page has a template</h1>
+<div>
+  Hello world!
+
+</div>
+
+</html>

data/test/fixtures/site/no_yaml.html

@@ -0,0 +1 @@
+This page has no YAML front-matter.

data/test/fixtures/site/simple.html

@@ -0,0 +1 @@
+<h1>This is a simple page</h1>

data/test/fixtures/templates/alt.html

@@ -0,0 +1 @@
+alternate

data/test/fixtures/templates/default.html

@@ -0,0 +1,6 @@
+template: site
+
+<h1>{{title}}</h1>
+<div>
+  {{content}}
+</div>

data/test/fixtures/templates/site.html

@@ -0,0 +1,4 @@
+<html>
+<head><title>{{title}}</title></head>
+{{& content}}
+</html>

data/test/howl_test.rb

@@ -0,0 +1,55 @@
+require 'teststrap'
+include Howl
+
+context "Site" do
+  setup { Site.new(fixture_path) }
+  
+  should("find all pages") {
+    topic.pages == Dir[fixture_path("pages/*")].map { |path| Page.new(path, topic) }
+  }
+
+  should("write out all pages") {
+    topic.write_to_disk
+    topic.pages.map { |page|
+      File.exist?(page.output_path)
+    }.all?
+  }
+end
+
+context "Page" do
+  setup { @site = Site.new(fixture_path) }
+
+  context "simple.html" do
+    setup { Page.new(fixture_path("pages/simple.html"), @site) }
+
+    asserts(:data).equals({"title" => "This is a simple page"})
+    asserts("#content") { topic.content.strip }.equals "<h1>{{title}}</h1>"
+    asserts("#rendered") { topic.render.strip }.equals "<h1>This is a simple page</h1>"
+
+    should("be able to find its output path") {
+      topic.output_path == (topic.site.path "site/simple.html")
+    }
+  end
+
+  context "no_yaml.html" do
+    setup { Page.new(fixture_path("pages/no_yaml.html"), @site) }
+
+    asserts(:data).equals({})
+    asserts("#content") { topic.content.strip }.equals "This page has no YAML front-matter."
+    asserts("#rendered") { topic.render.strip }.equals "This page has no YAML front-matter."
+  end
+
+  context "has_template.html" do
+    setup { Page.new(fixture_path("pages/has_template.html"), @site) }
+
+    asserts("#rendered") { topic.render.clean }.equals %Q[
+<html>
+<head><title>This page has a template</title></head>
+<h1>This page has a template</h1>
+<div>
+  Hello world!
+</div>
+</html>
+    ].clean
+  end
+end

data/test/teststrap.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'riot'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'howl'
+
+def fixture_path(path = ".")
+  Pathname.new(File.dirname(__FILE__)) + 'fixtures' + path
+end
+
+class String
+  def clean
+    self.strip.gsub(/\n+/, "\n")
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: howl
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Clinton R. Nixon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 11
+        version: "0.11"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mustache
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Howl is a tiny static website/blog generator.
+email: crnixon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- howl.gemspec
+- lib/howl.rb
+- test/fixtures/pages/has_template.html
+- test/fixtures/pages/no_yaml.html
+- test/fixtures/pages/simple.html
+- test/fixtures/site/has_template.html
+- test/fixtures/site/no_yaml.html
+- test/fixtures/site/simple.html
+- test/fixtures/templates/alt.html
+- test/fixtures/templates/default.html
+- test/fixtures/templates/site.html
+- test/howl_test.rb
+- test/teststrap.rb
+has_rdoc: true
+homepage: http://github.com/crnixon/howl
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A tiny static website/blog generator.
+test_files: 
+- test/howl_test.rb
+- test/teststrap.rb