howl 0.2.0 → 0.3.0

data/.gitignore

@@ -17,5 +17,8 @@ tmtags
 coverage
 rdoc
 pkg
+.bundle
+.sass-cache
 
 ## PROJECT::SPECIFIC
+test/fixtures/site

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    howl (0.3.0)
+      haml
+      hashie
+      mustache
+      rdiscount
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    haml (3.0.17)
+    hashie (0.4.0)
+    mustache (0.11.2)
+    nokogiri (1.4.3.1)
+    rdiscount (1.6.5)
+    riot (0.11.4)
+      rr
+      term-ansicolor
+    rr (1.0.0)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  haml
+  hashie
+  howl!
+  mustache
+  nokogiri
+  rdiscount
+  riot (>= 0.11)

data/Rakefile

@@ -11,9 +11,11 @@ begin
     gem.homepage = "http://github.com/crnixon/howl"
     gem.authors = ["Clinton R. Nixon"]
     gem.add_development_dependency "riot", ">= 0.11"
+    gem.add_development_dependency "nokogiri"
     gem.add_runtime_dependency 'rdiscount'
     gem.add_runtime_dependency 'mustache'
     gem.add_runtime_dependency 'hashie'
+    gem.add_runtime_dependency 'haml'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/howl.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{howl}
-  s.version = "0.2.0"
+  s.version = "0.3.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-16}
+  s.date = %q{2010-10-17}
   s.description = %q{Howl is a tiny static website/blog generator.}
   s.email = %q{crnixon@gmail.com}
   s.extra_rdoc_files = [
@@ -19,22 +19,32 @@ Gem::Specification.new do |s|
   s.files = [
     ".gitignore",
      "Gemfile",
+     "Gemfile.lock",
      "LICENSE",
      "README.markdown",
      "Rakefile",
      "VERSION",
      "howl.gemspec",
      "lib/howl.rb",
+     "lib/howl/converter.rb",
+     "lib/howl/converters/markdown.rb",
+     "lib/howl/converters/sass.rb",
+     "lib/howl/core_ext.rb",
+     "lib/howl/page.rb",
+     "lib/howl/plugin.rb",
+     "lib/howl/post.rb",
+     "lib/howl/site.rb",
+     "lib/howl/template.rb",
+     "lib/howl/view.rb",
+     "test/fixtures/pages/css/modules/colors.scss",
+     "test/fixtures/pages/css/screen.scss",
      "test/fixtures/pages/has_template.html",
+     "test/fixtures/pages/index.html",
      "test/fixtures/pages/no_yaml.html",
      "test/fixtures/pages/simple.html",
      "test/fixtures/posts/first_post.html",
+     "test/fixtures/posts/markdown_post.md",
      "test/fixtures/posts/no_date.html",
-     "test/fixtures/site/has_template.html",
-     "test/fixtures/site/no_yaml.html",
-     "test/fixtures/site/posts/2010/09/04/first_post.html",
-     "test/fixtures/site/posts/2010/10/16/no_date.html",
-     "test/fixtures/site/simple.html",
      "test/fixtures/templates/alt.html",
      "test/fixtures/templates/default.html",
      "test/fixtures/templates/post.html",
@@ -58,20 +68,26 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<riot>, [">= 0.11"])
+      s.add_development_dependency(%q<nokogiri>, [">= 0"])
       s.add_runtime_dependency(%q<rdiscount>, [">= 0"])
       s.add_runtime_dependency(%q<mustache>, [">= 0"])
       s.add_runtime_dependency(%q<hashie>, [">= 0"])
+      s.add_runtime_dependency(%q<haml>, [">= 0"])
     else
       s.add_dependency(%q<riot>, [">= 0.11"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
       s.add_dependency(%q<rdiscount>, [">= 0"])
       s.add_dependency(%q<mustache>, [">= 0"])
       s.add_dependency(%q<hashie>, [">= 0"])
+      s.add_dependency(%q<haml>, [">= 0"])
     end
   else
     s.add_dependency(%q<riot>, [">= 0.11"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
     s.add_dependency(%q<rdiscount>, [">= 0"])
     s.add_dependency(%q<mustache>, [">= 0"])
     s.add_dependency(%q<hashie>, [">= 0"])
+    s.add_dependency(%q<haml>, [">= 0"])
   end
 end
 

data/lib/howl/converter.rb

@@ -0,0 +1,33 @@
+module Howl
+  class Converter < Plugin
+    def self.converts(hash = nil)
+      @converts ||= {}
+      if hash
+        @converts.merge!(hash)
+      else
+        @converts
+      end
+    end
+
+    def self.matches?(ext)
+      @converts.keys.any? do |matcher|
+        matcher.match(ext)
+      end
+    end
+
+    attr_accessor :extension
+
+    def initialize(template)
+      @template = template
+      ext_regexp = self.class.converts.find { |conversion| conversion[0].match(@template.extension) }
+      @extension = @template.extension.gsub(ext_regexp[0], ext_regexp[1])
+    end
+
+    def convert(text)
+      text
+    end
+
+    priority :lowest
+    converts /\..+$/ => '\0'
+  end
+end

data/lib/howl/converters/markdown.rb

@@ -0,0 +1,14 @@
+require 'rdiscount'
+
+module Howl
+  class MarkdownConverter < Converter
+    converts ".md" => ".html"
+    converts ".mdown" => ".html"
+    converts ".markdown" => ".html"
+    priority :highest
+
+    def convert(text)
+      RDiscount.new(text).to_html
+    end
+  end
+end

data/lib/howl/converters/sass.rb

@@ -0,0 +1,13 @@
+require 'sass'
+
+module Howl
+  class SassConverter < Converter
+    converts /\.s[ac]ss/ => '.css'
+
+    def convert(text)
+      sass_args = { :syntax => @template.extension.drop(1).to_sym, 
+                    :load_paths => [@template.path.dirname] }
+      Sass::Engine.new(text, sass_args).render 
+    end
+  end
+end

data/lib/howl/core_ext.rb

@@ -0,0 +1,13 @@
+class String
+  def drop(num)
+    self.dup.split(//).drop(num).join
+  end
+
+  def slugify
+    string = self.dup
+    string.gsub!(/[^\x00-\x7F]+/, '')     # Remove anything non-ASCII entirely (e.g. diacritics).
+    string.gsub!(/[^a-z0-9\-_]+/i, '-')
+    string.downcase
+  end
+end
+

data/lib/howl/page.rb

@@ -0,0 +1,7 @@
+module Howl
+  class Page < Template
+    def output_path
+      site.path("site") + path.relative_path_from(site.path "pages").dirname + output_filename
+    end
+  end
+end

data/lib/howl/plugin.rb

@@ -0,0 +1,49 @@
+# Adapted from Jekyll's Plugin class.
+
+module Howl
+  class Plugin
+    PRIORITIES = { :lowest => -100,
+                   :low => -10,
+                   :normal => 0,
+                   :high => 10,
+                   :highest => 100 }
+
+    # Install a hook so that subclasses are recorded. This method is only
+    # ever called by Ruby itself.
+    #
+    # base - The Class subclass.
+    #
+    # Returns nothing.
+    def self.inherited(base)
+      subclasses << base
+      subclasses.sort!
+    end
+
+    # The list of Classes that have been subclassed.
+    #
+    # Returns an Array of Class objects.
+    def self.subclasses
+      @subclasses ||= []
+    end
+
+    # Get or set the priority of this plugin. When called without an
+    # argument it returns the priority. When an argument is given, it will
+    # set the priority.
+    #
+    # priority - The Symbol priority (default: nil). Valid options are:
+    #            :lowest, :low, :normal, :high, :highest
+    #
+    # Returns the Symbol priority.
+    def self.priority(priority = nil)
+      if priority && PRIORITIES.has_key?(priority)
+        @priority = priority
+      end
+      @priority || :normal
+    end
+
+    def self.<=>(other)
+      PRIORITIES[other.priority] <=> PRIORITIES[self.priority]
+    end
+  end
+
+end

data/lib/howl/post.rb

@@ -0,0 +1,25 @@
+module Howl
+  class Post < Template
+    include Comparable
+
+    def date
+      view.date? ? Time.parse(view.date) : File.mtime(path)
+    end
+
+    def <=>(other)
+      self.date <=> other.date
+    end
+
+    def output_path
+      site.path("site/posts") + date.strftime("%Y/%m/%d") + output_filename
+    end
+
+    def title
+      view.title || path.basename(extension).to_s
+    end
+
+    def dom_id
+      title.slugify
+    end
+  end
+end

data/lib/howl/site.rb

@@ -0,0 +1,39 @@
+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 posts
+      @posts ||= Dir[path "posts/**/*.*"].map { |path| Post.new(path, self) }.sort
+    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")
+      #raise (pages + posts).map(&:class).inspect
+      (pages + posts).each do |page|
+        FileUtils.makedirs(page.output_path.dirname)
+        page.output_path.open("w") do |fh|
+          fh.write page.render
+        end
+      end
+    end
+  end
+end

data/lib/howl/template.rb

@@ -0,0 +1,77 @@
+module Howl
+  class Template
+    attr_accessor :view, :content, :site, :path, :extension
+
+    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 output_filename
+      path.basename.sub(/#{extension}$/, converter.extension)
+    end
+
+    def converter
+      unless @converter
+        converter_class = Converter.subclasses.find do |converter|
+          converter.matches? @extension
+        end
+        converter_class ||= Converter
+
+        @converter = converter_class.new(self)
+      end
+
+      @converter
+    end
+
+    def render(render_view = View.new)
+      render_view.merge!(@view)
+      rendered = converter.convert(Mustache.render(@content, render_view))
+      template = render_view.delete("template")
+
+      if template
+        if @site.templates[template + @extension]
+          rendered = @site.templates[template + @extension].render(
+              render_view.merge("content" => rendered))
+        else
+          puts "Warning: Template #{template + @extension} does not exist in file #{path}"
+          rendered
+        end
+      end
+
+      rendered
+    end
+
+    private
+
+    def load_file
+      content = @path.read
+      view, content = content.split("\n\n", 2)
+
+      if test_for_yaml(view)
+        @content = content
+        view = YAML.load(view)
+      else
+        @content = "#{view}\n\n#{content}".strip
+        view = {}
+      end
+
+      @view = View.new(view.merge(:site => site))
+    end
+
+    def test_for_yaml(view)
+      begin
+        view = YAML.load(view)
+        view.is_a?(Hash)
+      rescue ArgumentError
+        false
+      end
+    end
+  end
+end

data/lib/howl/view.rb

@@ -0,0 +1,19 @@
+require 'hashie'
+
+module Howl
+  class View < Hashie::Mash
+    def has_key?(key)
+      key?(key) || respond_to?(key)
+    end
+
+    def [](key)
+      super || (respond_to?(key) && send(key))
+    end
+
+    def posts
+      if site? && site.respond_to?(:posts)
+        site.posts
+      end
+    end
+  end
+end

data/lib/howl.rb

@@ -1,131 +1,19 @@
 require 'yaml'
-require 'rdiscount'
 require 'mustache'
-require 'hashie'
 require 'pathname'
 require 'fileutils'
 require 'time'
 
 $:.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 posts
-      @posts ||= Dir[path "posts/*"].map { |path| Post.new(path, self) }.sort
-    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")
-      #raise (pages + posts).map(&:class).inspect
-      (pages + posts).each do |page|
-        FileUtils.makedirs(page.output_path.dirname)
-        page.output_path.open("w") do |fh|
-          fh.write page.render
-        end
-      end
-    end
-  end
-
-  class View < Hashie::Mash
+def require_all(path)
+  Dir[File.join(File.dirname(__FILE__), path, '*.rb')].each do |f|
+    require f
   end
+end
 
-  class Template
-    attr_accessor :view, :content, :site, :path
-
-    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_view = {})
-      render_view.merge!(@view)
-      rendered = Mustache.render(@content, render_view)
-      template = render_view.delete("template")
-      if template
-        begin
-          rendered = @site.templates[template + @extension].render(render_view.merge("content" => rendered))
-        rescue NoMethodError => ex
-          puts "Warning: Template #{template + @extension} does not exist in file #{path}"
-          rendered
-        end
-      end
-
-      rendered
-    end
-
-    private
-
-    def load_file
-      content = @path.read
-      view, content = content.split("\n\n", 2)
-
-      if test_for_yaml(view)
-        @content = content
-        view = YAML.load(view)
-      else
-        @content = "#{view}\n\n#{content}".strip
-        view = {}
-      end
-
-      @view = View.new(view.merge(:site => site))
-    end
-
-    def test_for_yaml(view)
-      begin
-        view = YAML.load(view)
-        view.is_a?(Hash)
-      rescue ArgumentError
-        false
-      end
-    end
-  end
-
-  class Page < Template
-    def output_path
-      site.path("site") + path.relative_path_from(site.path "pages")
-    end
-  end
-
-  class Post < Template
-    include Comparable
-
-    def date
-      view.date? ? Time.parse(view.date) : File.mtime(path)
-    end
-
-    def output_path
-      site.path("site/posts") + date.strftime("%Y/%m/%d") + path.basename
-    end
-
-    def <=>(other)
-      self.date <=> other.date
-    end
-  end
+%w(core_ext plugin converter site template page post view).each do |file|
+  require "howl/#{file}"
 end
+
+require_all "howl/converters"

data/test/fixtures/pages/css/modules/colors.scss

@@ -0,0 +1,3 @@
+h1 {
+  color: red;
+}

data/test/fixtures/pages/css/screen.scss

@@ -0,0 +1,7 @@
+@import "modules/colors.scss";
+
+html {
+  .post {
+    border: 1px solid black;
+  }
+}

data/test/fixtures/pages/index.html

@@ -0,0 +1,10 @@
+template: site
+title: Home Page
+
+<div id="posts">
+{{#posts}}
+  <div class="post" id="{{dom_id}}">
+    <h2>{{title}}</h2>
+  </div>
+{{/posts}}
+</div>

data/test/fixtures/posts/markdown_post.md

@@ -0,0 +1,5 @@
+title: Hey, it's Markdown!
+
+This post is written in Markdown.
+
+_Hopefully_, it will convert to HTML ok.

data/test/howl_test.rb

@@ -5,7 +5,7 @@ context "Site" do
   setup { @site = Site.new(fixture_path) }
   
   should("find all pages") {
-    topic.pages == Dir[fixture_path("pages/*")].map { |path| Page.new(path, topic) }
+    topic.pages == Dir[fixture_path("pages/**/*.*")].map { |path| Page.new(path, topic) }
   }
 
   should("write out all pages") {
@@ -18,7 +18,9 @@ context "Site" do
   should("write out all posts") {
     topic.write_to_disk
     topic.posts.map { |post|
-      Dir[topic.path("site/posts") + "**/*"].map { |path| File.basename(path) }.include?(post.path.basename.to_s)
+      Dir[topic.path("site/posts") + "**/*.*"].map { |path|
+        File.basename(path, File.extname(path)) 
+      }.include?(post.path.basename(post.extension).to_s)
     }.all?
   }
 
@@ -60,6 +62,17 @@ context "Site" do
 </html>
       ].clean
     end
+
+    context "index.html" do
+      setup { Page.new(fixture_path("pages/index.html"), @site) }
+
+      should "show all posts" do
+        doc = Nokogiri.parse(topic.render)
+        @site.posts.map { |post|
+          doc.search("div##{post.dom_id}").empty?
+        }.none?
+      end
+    end
   end
 
   context "Post" do
@@ -79,5 +92,13 @@ context "Site" do
       asserts("date is equal to file's mtime") { topic.date == File.mtime(topic.path) }
     end
   end
+
+  context "A Post in Markdown" do
+    setup { Post.new(fixture_path("posts/markdown_post.md"), @site) }
+
+    should "convert to HTML" do
+      topic.render == RDiscount.new(topic.content).to_html
+    end
+  end
 end
 

data/test/teststrap.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'riot'
+require 'nokogiri'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -14,3 +15,9 @@ class String
     self.strip.gsub(/\n+/, "\n")
   end
 end
+
+class Mustache
+  def self.raise_on_context_miss? 
+    true
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Clinton R. Nixon
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-16 00:00:00 -04:00
+date: 2010-10-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rdiscount
+  name: nokogiri
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -42,10 +42,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: mustache
+  name: rdiscount
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -58,7 +58,7 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: hashie
+  name: mustache
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -70,6 +70,32 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
 description: Howl is a tiny static website/blog generator.
 email: crnixon@gmail.com
 executables: []
@@ -82,22 +108,32 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.markdown
 - Rakefile
 - VERSION
 - howl.gemspec
 - lib/howl.rb
+- lib/howl/converter.rb
+- lib/howl/converters/markdown.rb
+- lib/howl/converters/sass.rb
+- lib/howl/core_ext.rb
+- lib/howl/page.rb
+- lib/howl/plugin.rb
+- lib/howl/post.rb
+- lib/howl/site.rb
+- lib/howl/template.rb
+- lib/howl/view.rb
+- test/fixtures/pages/css/modules/colors.scss
+- test/fixtures/pages/css/screen.scss
 - test/fixtures/pages/has_template.html
+- test/fixtures/pages/index.html
 - test/fixtures/pages/no_yaml.html
 - test/fixtures/pages/simple.html
 - test/fixtures/posts/first_post.html
+- test/fixtures/posts/markdown_post.md
 - test/fixtures/posts/no_date.html
-- test/fixtures/site/has_template.html
-- test/fixtures/site/no_yaml.html
-- test/fixtures/site/posts/2010/09/04/first_post.html
-- test/fixtures/site/posts/2010/10/16/no_date.html
-- test/fixtures/site/simple.html
 - test/fixtures/templates/alt.html
 - test/fixtures/templates/default.html
 - test/fixtures/templates/post.html

data/test/fixtures/site/has_template.html

@@ -1,9 +0,0 @@
-<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

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

data/test/fixtures/site/posts/2010/09/04/first_post.html

@@ -1,11 +0,0 @@
-<html>
-<head><title>First Post!</title></head>
-<div class="post">
-  <h2>First Post!</h2>
-  <div class="post-content">
-    DANG
-
-  </div.
-</div>
-
-</html>

data/test/fixtures/site/posts/2010/10/16/no_date.html

@@ -1 +0,0 @@
-This post has no date in its YAML front-matter.

data/test/fixtures/site/simple.html

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