pith 0.0.2 → 0.0.3

data/README.markdown

@@ -5,11 +5,13 @@ Pith is a static web-site generator, written in Ruby.
 
 Using Pith, you can:
 
-* __Express yourself succintly__ using [Haml][haml], [Sass][sass], ERb, Markdown and Textile.
+* __Express yourself succintly__ using Markdown or Textile.
 
-* __Encapsulate common markup__ in "partial" templates.
+* __Layout your pages__ written in ERb, [Haml][haml], or Liquid.
 
-* __Separate content and layout__ using "layout" templates.
+* __Style things up using__ [Sass][sass].
+
+* __Encapsulate common markup__ in "layout" and "partial" templates.
 
 * __Easily link pages and resources__ using relative links.
 
@@ -17,6 +19,11 @@ Using Pith, you can:
 
 * __Define custom helper-methods__ to increase expressiveness.
 
+Why Pith?
+---------
+
+Why another static web-site generator, when there are other good options out there?  Pith's main differentiating factor is that structure of the output slavishly mirrors the structure of the input; there are no magic input directories for layouts, or dynamic content, or anything else.
+
 Install it
 ----------
 

data/Rakefile

@@ -10,7 +10,17 @@ task :default => :cucumber
 
 require 'cucumber/rake/task'
 
-Cucumber::Rake::Task.new(:cucumber) do |t|
-  t.fork = true
-  t.profile = 'default'
+namespace :cucumber do
+  
+  [:wip, :default].each do |profile|
+
+    Cucumber::Rake::Task.new(profile) do |t|
+      t.fork = true
+      t.profile = profile
+    end
+
+  end
+
 end
+
+task :cucumber => ["cucumber:wip", "cucumber:default"]

data/cucumber.yml

@@ -1,7 +1,2 @@
-<%
-rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
-rerun_opts = rerun.to_s.strip.empty? ? "--format progress features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
-std_opts = "#{rerun_opts} --format rerun --out rerun.txt --strict --tags ~@wip --require features/support --require features/step_definitions"
-%>
-default: <%= std_opts %>
+default: --tags ~@wip features
 wip: --tags @wip:3 --wip features

data/features/helpers.feature~

@@ -0,0 +1,23 @@
+Feature: helper methods
+
+  I want to extend Pith with helper methods
+  So that I can use them in templates
+
+Scenario: call a helper from a template
+
+  Given input file "_pith/config.rb" contains
+    """
+    project.helpers do
+      
+      def greet(subject = "mate")
+        "Hello, #{subject}"
+      end
+      
+    end
+    """
+
+  And input file "index.html.haml" contains "= greet('World')"
+   
+  When I build the site
+  
+  Then output file "index.html" should contain "Hello, World"

data/features/ignorance.feature

@@ -14,7 +14,7 @@ Scenario: a layout template at the input root
   
   Then output file "_layout" should not exist
 
-Scenario: a partial in a subdirectory
+Scenario: a partial in an ignored subdirectory
 
   Given input file "_partials/foo.html.haml" contains
     """
@@ -24,3 +24,14 @@ Scenario: a partial in a subdirectory
   When I build the site
   
   Then output file "_partials/foo.html" should not exist
+
+Scenario: an ignored partial in a subdirectory
+
+  Given input file "partials/_foo.html.haml" contains
+    """
+    Blah de blah
+    """
+    
+  When I build the site
+  
+  Then output file "partials/_foo.html" should not exist

data/features/ignorance.feature~

@@ -14,7 +14,7 @@ Scenario: a layout template at the input root
   
   Then output file "_layout" should not exist
 
-Scenario: a partial in a subdirectory
+Scenario: a partial in an ignored subdirectory
 
   Given input file "_partials/foo.html.haml" contains
     """
@@ -24,3 +24,14 @@ Scenario: a partial in a subdirectory
   When I build the site
   
   Then output file "_partials/foo.html" should not exist
+
+Scenario: an ignored partial in a subdirectory
+
+  Given input file "partials/_foo.html.haml" contains
+    """
+    Blah de blah
+    """
+    
+  When I build the site
+  
+  Then output file "partials/_foo.html" should not exist

data/features/incremental_rebuild.feature~

@@ -0,0 +1,24 @@
+Feature: incremental rebuilding
+
+  I want to rebuild just the outputs whose inputs have changed
+  So that that I can bring the project up-to-date efficiently
+  
+Scenario: alter an input, and the output changes
+
+  Given input file "page.html.haml" contains "Old content"
+  And the site is up-to-date
+
+  When I change input file "page.html.haml" to contain "New content"
+  And I rebuild the site
+  
+  Then output file "page.html" should be re-generated
+  And output file "page.html" should contain "New content"
+
+Scenario: don't alter an input, and the output is untouched
+
+  Given input file "page.html.haml" contains "Content"
+  And the site is up-to-date
+
+  When I rebuild the site
+
+  Then output file "page.html" should not be re-generated

data/features/layouts.feature

@@ -7,7 +7,7 @@ Scenario: Haml template with a layout
 
   Given input file "index.html.haml" contains
     """
-    = include "layouts/_simple.haml" do
+    = inside "layouts/_simple.haml" do
       blah blah
     """
   And input file "layouts/_simple.haml" contains 
@@ -25,7 +25,7 @@ Scenario: instance variable assigned within the layed-out block
 
   Given input file "index.html.haml" contains
     """
-    = include "layouts/_with_header.haml" do
+    = inside "layouts/_with_header.haml" do
       - @title = "XXX"
       %p blah blah
     """
@@ -41,3 +41,23 @@ Scenario: instance variable assigned within the layed-out block
     <h1>XXX</h1>
     <p>blah blah</p>
     """
+
+Scenario: Layout specified in meta-data
+
+  Given input file "index.html.haml" contains
+    """
+    -# ---
+    -# layout: layouts/_simple.haml
+    -#...
+    blah blah
+    """
+  And input file "layouts/_simple.haml" contains 
+    """
+    %p= yield
+    """
+   
+  When I build the site
+  Then output file "index.html" should contain 
+    """
+    <p>blah blah</p>
+    """

data/features/layouts.feature~

@@ -41,3 +41,23 @@ Scenario: instance variable assigned within the layed-out block
     <h1>XXX</h1>
     <p>blah blah</p>
     """
+
+Scenario: Layout specified in meta-data
+
+  Given input file "index.html.haml" contains
+    """
+    -# ---
+    -# layout: layouts/_simple.haml
+    -#...
+    blah blah
+    """
+  And input file "layouts/_simple.haml" contains 
+    """
+    %p= yield
+    """
+   
+  When I build the site
+  Then output file "index.html" should contain 
+    """
+    <p>blah blah</p>
+    """

data/features/metadata.feature

@@ -3,7 +3,7 @@ Feature: metadata
   I want extract metadata from page source
   So that I can use it elsewhere
   
-Scenario: link from one top-level page to another
+Scenario: use meta-data from YAML comment
 
   Given input file "page.html.haml" contains
     """

data/features/{linking.feature → relative_linking.feature}

@@ -1,6 +1,7 @@
 Feature: linking between files
 
-  I want to be able to link pages easily
+  I want to be able to generate relative reference to other pages
+  So that the generated site is re-locateable
 
 Scenario: link from one top-level page to another
 
@@ -8,7 +9,8 @@ Scenario: link from one top-level page to another
     """
     = link("page.html", "Page")
     """
-
+  And input file "page.html" exists
+   
   When I build the site
   Then output file "index.html" should contain
     """
@@ -21,6 +23,7 @@ Scenario: link from a sub-directory to a root-level page
     """
     = link("/help.html", "Help")
     """
+  And input file "help.html" exists
 
   When I build the site
   Then output file "subdir/page.html" should contain
@@ -34,6 +37,7 @@ Scenario: link to an image
     """
     %img{:src => href("/logo.png")}
     """
+  And input file "logo.png" exists
 
   When I build the site
   Then output file "subdir/page.html" should contain
@@ -54,6 +58,8 @@ Scenario: links within a layout block
     = yield
     """
 
+  And input file "subdir/other.html" exists
+
   When I build the site
   Then output file "subdir/page.html" should contain
     """
@@ -72,8 +78,32 @@ Scenario: links included from a partial
     %link{ :href=>href("/stylesheets/app.css"), :rel=>"stylesheet", :type=>"text/css" }
     """
 
+  And input file "stylesheets/app.css" exists
+
   When I build the site
   Then output file "subdir/page.html" should contain
     """
     <link href='../stylesheets/app.css' rel='stylesheet' type='text/css' />
     """
+
+Scenario: use "title" meta-data attribute in link
+
+  Given input file "index.html.haml" contains 
+    """
+    = link("page.html")
+    """
+
+  And input file "page.html.haml" contains
+    """
+    -# ---
+    -# title: "Title from meta-data"
+    -# ...
+    Target content
+    """
+
+  When I build the site
+
+  Then output file "index.html" should contain
+    """
+    <a href="page.html">Title from meta-data</a>
+    """

data/features/relative_linking.feature~

@@ -0,0 +1,109 @@
+Feature: linking between files
+
+  I want to be able to generate relative reference to other pages
+  So that the generated site is re-locateable
+
+Scenario: link from one top-level page to another
+
+  Given input file "index.html.haml" contains 
+    """
+    = link("page.html", "Page")
+    """
+  And input file "page.html" exists
+   
+  When I build the site
+  Then output file "index.html" should contain
+    """
+    <a href="page.html">Page</a>
+    """
+
+Scenario: link from a sub-directory to a root-level page
+
+  Given input file "subdir/page.html.haml" contains
+    """
+    = link("/help.html", "Help")
+    """
+  And input file "help.html" exists
+
+  When I build the site
+  Then output file "subdir/page.html" should contain
+    """
+    <a href="../help.html">Help</a>
+    """
+
+Scenario: link to an image
+
+  Given input file "subdir/page.html.haml" contains
+    """
+    %img{:src => href("/logo.png")}
+    """
+  And input file "logo.png" exists
+
+  When I build the site
+  Then output file "subdir/page.html" should contain
+    """
+    <img src='../logo.png' />
+    """
+
+Scenario: links within a layout block
+
+  Given input file "subdir/page.html.haml" contains
+    """
+    = include "/common/_layout.haml" do
+      = link "other.html", "Other page"
+    """
+
+  And input file "common/_layout.haml" contains
+    """
+    = yield
+    """
+
+  And input file "subdir/other.html" exists
+
+  When I build the site
+  Then output file "subdir/page.html" should contain
+    """
+    <a href="other.html">Other page</a>
+    """
+
+Scenario: links included from a partial
+
+  Given input file "subdir/page.html.haml" contains
+    """
+    = include "/common/_partial.haml"
+    """
+
+  And input file "common/_partial.haml" contains
+    """
+    %link{ :href=>href("/stylesheets/app.css"), :rel=>"stylesheet", :type=>"text/css" }
+    """
+
+  And input file "stylesheets/app.css" exists
+
+  When I build the site
+  Then output file "subdir/page.html" should contain
+    """
+    <link href='../stylesheets/app.css' rel='stylesheet' type='text/css' />
+    """
+
+Scenario: use "title" meta-data attribute in link
+
+  Given input file "index.html.haml" contains 
+    """
+    = link("page.html")
+    """
+
+  And input file "page.html.haml" contains
+    """
+    -# ---
+    -# title: "Title from meta-data"
+    -# ...
+    Target content
+    """
+
+  When I build the site
+
+  Then output file "index.html" should contain
+    """
+    <a href="page.html">Title from meta-data</a>
+    """

data/features/step_definitions/build_steps.rb

@@ -1,17 +1,21 @@
-Given /^input file "([^\"]*)" contains "([^\"]*)"$/ do |file_name, content|
-  @inputs.write(file_name, content, :mtime => (Time.now - 5))
+Given /^input file "([^\"]*)" contains "([^\"]*)"$/ do |path, content|
+  @inputs.write(path, content, :mtime => (Time.now - 5))
 end
 
-Given /^input file "([^\"]*)" contains$/ do |file_name, content|
-  @inputs.write(file_name, content, :mtime => (Time.now - 5))
+Given /^input file "([^\"]*)" contains$/ do |path, content|
+  @inputs.write(path, content, :mtime => (Time.now - 5))
+end
+
+Given /^input file "([^\"]*)" exists$/ do |path|
+  Given %{input file "#{path}" contains "something"}
 end
 
 Given "the site is up-to-date" do
   When "I build the site"
 end
 
-When /^I change input file "([^\"]*)" to contain "([^\"]*)"$/ do |file_name, content|
-  @inputs[file_name] = content
+When /^I change input file "([^\"]*)" to contain "([^\"]*)"$/ do |path, content|
+  @inputs[path] = content
 end
 
 When /^I (?:re)?build the site$/ do
@@ -25,22 +29,22 @@ class String
   end
 end
 
-Then /^output file "([^\"]*)" should contain "([^\"]*)"$/ do |file_name, content|
-  @outputs[file_name].clean.should == content.clean
+Then /^output file "([^\"]*)" should contain "([^\"]*)"$/ do |path, content|
+  @outputs[path].clean.should == content.clean
 end
 
-Then /^output file "([^\"]*)" should contain$/ do |file_name, content|
-  @outputs[file_name].clean.should == content.clean
+Then /^output file "([^\"]*)" should contain$/ do |path, content|
+  @outputs[path].clean.should == content.clean
 end
 
-Then /^output file "([^\"]*)" should not exist$/ do |file_name|
-  @outputs[file_name].should == nil
+Then /^output file "([^\"]*)" should not exist$/ do |path|
+  @outputs[path].should == nil
 end
 
-Then /^output file "([^"]*)" should be re\-generated$/ do |file_name|
-  @project.logger.messages.should contain(/--> +#{file_name}/)
+Then /^output file "([^"]*)" should be re\-generated$/ do |path|
+  @project.logger.messages.should contain(/--> +#{path}/)
 end
 
-Then /^output file "([^"]*)" should not be re\-generated$/ do |file_name|
-  @project.logger.messages.should_not contain(/--> +#{file_name}/)
+Then /^output file "([^"]*)" should not be re\-generated$/ do |path|
+  @project.logger.messages.should_not contain(/--> +#{path}/)
 end

data/features/step_definitions/build_steps.rb~

@@ -1,12 +1,25 @@
-Given /^input file "([^\"]*)" contains "([^\"]*)"$/ do |file_name, content|
-  @inputs[file_name] = content
+Given /^input file "([^\"]*)" contains "([^\"]*)"$/ do |path, content|
+  @inputs.write(path, content, :mtime => (Time.now - 5))
 end
 
-Given /^input file "([^\"]*)" contains$/ do |file_name, content|
-  @inputs[file_name] = content
+Given /^input file "([^\"]*)" contains$/ do |path, content|
+  @inputs.write(path, content, :mtime => (Time.now - 5))
 end
 
-When /^I build the site$/ do
+Given /^input file "([^\"]*)" exists$/ do |path|
+  Given %{input file "#{path}" contains "something"}
+end
+
+Given "the site is up-to-date" do
+  When "I build the site"
+end
+
+When /^I change input file "([^\"]*)" to contain "([^\"]*)"$/ do |path, content|
+  @inputs[path] = content
+end
+
+When /^I (?:re)?build the site$/ do
+  @project.logger.clear
   @project.build
 end
 
@@ -16,14 +29,22 @@ class String
   end
 end
 
-Then /^output file "([^\"]*)" should contain "([^\"]*)"$/ do |file_name, content|
-  @outputs[file_name].clean.should == content.clean
+Then /^output file "([^\"]*)" should contain "([^\"]*)"$/ do |path, content|
+  @outputs[path].clean.should == content.clean
+end
+
+Then /^output file "([^\"]*)" should contain$/ do |path, content|
+  @outputs[path].clean.should == content.clean
+end
+
+Then /^output file "([^\"]*)" should not exist$/ do |path|
+  @outputs[path].should == nil
 end
 
-Then /^output file "([^\"]*)" should contain$/ do |file_name, content|
-  @outputs[file_name].clean.should == content.clean
+Then /^output file "([^"]*)" should be re\-generated$/ do |path|
+  @project.logger.messages.should contain(/--> +#{path}/)
 end
 
-Then /^output file "([^\"]*)" should not exist$/ do |file_name|
-  @outputs[file_name].should == nil
+Then /^output file "([^"]*)" should not be re\-generated$/ do |path|
+  @project.logger.messages.should_not contain(/--> +#{path}/)
 end

data/features/support/env.rb

@@ -6,17 +6,17 @@ class DirHash
     @dir = Pathname(dir)
   end
 
-  def [](file_name)
-    file_path = @dir + file_name
+  def [](file)
+    file_path = @dir + file
     file_path.read if file_path.exist?
   end
 
-  def []=(file_name, content)
-    write(file_name, content)
+  def []=(file, content)
+    write(file, content)
   end
 
-  def write(file_name, content, options = {})
-    file_path = @dir + file_name
+  def write(file, content, options = {})
+    file_path = @dir + file
     file_path.parent.mkpath
     file_path.open("w") do |io|
       io << content

data/features/support/env.rb~

@@ -6,19 +6,50 @@ class DirHash
     @dir = Pathname(dir)
   end
 
-  def [](file_name)
-    file_path = @dir + file_name
+  def [](file)
+    file_path = @dir + file
     file_path.read if file_path.exist?
   end
 
-  def []=(file_name, content)
-    file_path = @dir + file_name
+  def []=(file, content)
+    write(file, content)
+  end
+
+  def write(file, content, options = {})
+    file_path = @dir + file
     file_path.parent.mkpath
     file_path.open("w") do |io|
       io << content
     end
+    if options[:mtime]
+      timestamp = options[:mtime]
+      file_path.utime(timestamp, timestamp)
+    end
+  end
+  
+end
+
+class InternalLogger
+
+  def initialize
+    @messages = []
+  end
+  
+  attr_reader :messages
+  
+  def clear
+    @messages.clear
   end
   
+  def info(message, &block)
+    message ||= block.call
+    write(message)
+  end
+
+  def write(message)
+    @messages << message
+  end
+    
 end
 
 $project_dir = Pathname(__FILE__).expand_path.parent.parent.parent
@@ -38,6 +69,7 @@ Before do
     dir.mkpath
   end
   @project = Pith::Project.new(:input_dir => $input_dir, :output_dir => $output_dir)
+  @project.logger = InternalLogger.new
   @inputs = DirHash.new($input_dir)
   @outputs = DirHash.new($output_dir)
 end

data/features/support/rspec_matchers.rb~

@@ -0,0 +1,5 @@
+Spec::Matchers.define :contain do |expected|
+  match do |actual|
+    actual.any? { |x| expected === x }
+  end
+end