pith 0.0.2

data/README.markdown

@@ -0,0 +1,29 @@
+Pith
+====
+
+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.
+
+* __Encapsulate common markup__ in "partial" templates.
+
+* __Separate content and layout__ using "layout" templates.
+
+* __Easily link pages and resources__ using relative links.
+
+* __Quickly test changes__ using the built-in web-server.
+
+* __Define custom helper-methods__ to increase expressiveness.
+
+Install it
+----------
+
+Pith is packaged as a Ruby gem.  Assuming you have Ruby, install it thusly:
+
+    gem install pith
+
+[tilt]: http://github.com/rtomayko/tilt/
+[haml]: http://haml-lang.com
+[sass]: http://sass-lang.com

data/Rakefile

@@ -0,0 +1,16 @@
+task :default => :spec
+
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts << ["--color"]
+end
+
+task :default => :cucumber
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.fork = true
+  t.profile = 'default'
+end

data/bin/pith

@@ -0,0 +1,60 @@
+#! /usr/bin/env ruby
+
+require "rubygems"
+require "optparse"
+require "pathname"
+
+$input_dir = Pathname(".")
+
+BANNER = <<EOF
+usage: pith [OPTIONS] [COMMAND]
+
+  Commands: (default: "build")
+
+    build       Generate the website into OUTPUT_DIR.
+
+    serve       Serve the website via HTTP, re-generating as required.
+
+EOF
+
+OptionParser.new do |opts|
+  opts.banner = BANNER
+  opts.separator "  Options:"
+  opts.on("-i", "--input INPUT_DIR", 'Input directory', '  (default: ".")') do |dir|
+    $input_dir = Pathname(dir)
+  end
+  opts.on("-o", "--output OUTPUT_DIR", 'Output directory', '  (default: "INPUT_DIR/_out")') do |dir|
+    $output_dir = Pathname(dir)
+  end
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+unless $output_dir
+  $output_dir = $input_dir + "_out"
+  puts %{Generating to "#{$output_dir}"}
+end
+
+$: << File.expand_path("../../lib", __FILE__)
+
+require "pith/project"
+require "pith/console_logger"
+
+@project = Pith::Project.new(:input_dir => $input_dir, :output_dir => $output_dir)
+@project.logger = Pith::ConsoleLogger.new
+
+def build
+  @project.build
+end
+
+def serve
+  require "pith/server"
+  port = 4321
+  puts %{Taking the Pith at "http://localhost:#{port}"}
+  Pith::Server.run(@project, :Port => port)
+end
+
+action = ARGV.shift || "build"
+self.send(action)

data/cucumber.yml

@@ -0,0 +1,7 @@
+<%
+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 %>
+wip: --tags @wip:3 --wip features

data/features/content_for.feature

@@ -0,0 +1,29 @@
+Feature: templates can be used as layouts
+
+  I want to encapsulate a chunk of content
+  So that I can use it inside a layout
+
+Scenario: Haml template with a layout
+
+  Given input file "index.html.haml" contains
+    """
+    = include "_layout.haml" do
+      - content_for[:sidebar] = capture_haml do
+        %p SIDEBAR
+      %p MAIN
+    """
+  And input file "_layout.haml" contains 
+    """
+    #sidebar
+      = content_for[:sidebar]
+    = yield
+    """
+   
+  When I build the site
+  Then output file "index.html" should contain 
+    """
+    <div id='sidebar'>
+      <p>SIDEBAR</p>
+    </div>
+    <p>MAIN</p>
+    """

data/features/content_for.feature~

@@ -0,0 +1,29 @@
+Feature: templates can be used as layouts
+
+  I want to encapsulate a chunk of content
+  So that I can use it inside a layout
+
+Scenario: Haml template with a layout
+
+  Given input file "index.html.haml" contains
+    """
+    = include "_layout.haml" do
+      - content_for[:sidebar] = capture_haml do
+        %p SIDEBAR
+      %p MAIN
+    """
+  And input file "_layout.haml" contains 
+    """
+    #sidebar
+      = content_for[:sidebar]
+    = yield
+    """
+   
+  When I build the site
+  Then output file "index.html" should contain 
+    """
+    <div id='sidebar'>
+      <p>SIDEBAR</p>
+    </div>
+    <p>MAIN</p>
+    """

data/features/haml.feature

@@ -0,0 +1,24 @@
+Feature: support for Haml
+
+  I want to build pages using Haml
+  So that I can express markup succintly
+  
+Scenario: simple Haml page
+
+  Given input file "index.html.haml" contains
+    """
+    %h1 Header
+    
+    %p
+      Some text
+    """
+    
+  When I build the site
+  
+  Then output file "index.html" should contain
+    """
+    <h1>Header</h1>
+    <p>
+      Some text
+    </p>
+    """

data/features/haml.feature~

@@ -0,0 +1,24 @@
+Feature: support for Haml
+
+  I want to build pages using Haml
+  So that I can express markup succintly
+  
+Scenario: simple Haml page
+
+  Given input file "index.html.haml" contains
+    """
+    %h1 Header
+    
+    %p
+      Some text
+    """
+    
+  When I build the site
+  
+  Then output file "index.html" should contain
+    """
+    <h1>Header</h1>
+    <p>
+      Some text
+    </p>
+    """

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

@@ -0,0 +1,26 @@
+Feature: ignorable files are ignored
+
+  I want any file (or directory) beginning with "_" to be ignored
+  So that I can place supporting files anywhere within the input directory
+  
+Scenario: a layout template at the input root
+
+  Given input file "_layout.haml" contains
+    """
+    Blah de blah
+    """
+    
+  When I build the site
+  
+  Then output file "_layout" should not exist
+
+Scenario: a 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~

@@ -0,0 +1,26 @@
+Feature: ignorable files are ignored
+
+  I want any file (or directory) beginning with "_" to be ignored
+  So that I can place supporting files anywhere within the input directory
+  
+Scenario: a layout template at the input root
+
+  Given input file "_layout.haml" contains
+    """
+    Blah de blah
+    """
+    
+  When I build the site
+  
+  Then output file "_layout" should not exist
+
+Scenario: a 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/include.feature

@@ -0,0 +1,84 @@
+Feature: templates can include other templates
+
+  I want to be able to include partials
+  So that I can reuse template fragments
+
+Scenario: include a partial
+
+  Given input file "index.html.haml" contains "= include('_fragment.haml')"
+  And input file "_fragment.haml" contains "%p blah blah"
+  When I build the site
+  Then output file "index.html" should contain "<p>blah blah</p>"
+
+Scenario: include a partial in the same sub-directory
+
+  Given input file "subdir/page.html.haml" contains "= include('_fragment.haml')"
+  And input file "subdir/_fragment.haml" contains "%p blah blah"
+  When I build the site
+  Then output file "subdir/page.html" should contain "<p>blah blah</p>"
+
+Scenario: nested includes, differing directories
+
+  Given input file "page.html.haml" contains "= include('_partials/foo.haml')"
+  And input file "_partials/foo.haml" contains "= include('bar.haml')"
+  And input file "_partials/bar.haml" contains "bananas"
+  When I build the site
+  Then output file "page.html" should contain "bananas"
+
+Scenario: include a partial located relative to site root
+
+  Given input file "subdir/page.html.haml" contains "= include('/_partials/fragment.haml')"
+  And input file "_partials/fragment.haml" contains "%p blah blah"
+  When I build the site
+  Then output file "subdir/page.html" should contain "<p>blah blah</p>"
+
+Scenario: pass local variable to a partial
+
+  Given input file "index.html.haml" contains
+    """
+    = include("_list.haml", :items => [1,2,3])
+    """
+
+  And input file "_list.haml" contains
+    """
+    %ul
+      - items.each do |i|
+        %li= i
+    """
+   
+  When I build the site
+  
+  Then output file "index.html" should contain
+    """
+    <ul>
+      <li>1</li>
+      <li>2</li>
+      <li>3</li>
+    </ul>
+    """
+
+Scenario: use instance variable in a partial
+
+  Given input file "index.html.haml" contains
+    """
+    - @items = [1,2,3]
+    = include("_list.haml")
+    """
+
+  And input file "_list.haml" contains
+    """
+    %ul
+      - @items.each do |i|
+        %li= i
+    """
+   
+  When I build the site
+  
+  Then output file "index.html" should contain
+    """
+    <ul>
+      <li>1</li>
+      <li>2</li>
+      <li>3</li>
+    </ul>
+    """

data/features/include.feature~

@@ -0,0 +1,84 @@
+Feature: templates can include other templates
+
+  I want to be able to include partials
+  So that I can reuse template fragments
+
+Scenario: include a partial
+
+  Given input file "index.html.haml" contains "= include('_fragment.haml')"
+  And input file "_fragment.haml" contains "%p blah blah"
+  When I build the site
+  Then output file "index.html" should contain "<p>blah blah</p>"
+
+Scenario: include a partial in the same sub-directory
+
+  Given input file "subdir/page.html.haml" contains "= include('_fragment.haml')"
+  And input file "subdir/_fragment.haml" contains "%p blah blah"
+  When I build the site
+  Then output file "subdir/page.html" should contain "<p>blah blah</p>"
+
+Scenario: nested includes, differing directories
+
+  Given input file "page.html.haml" contains "= include('_partials/foo.haml')"
+  And input file "_partials/foo.haml" contains "= include('bar.haml')"
+  And input file "_partials/bar.haml" contains "bananas"
+  When I build the site
+  Then output file "page.html" should contain "bananas"
+
+Scenario: include a partial located relative to site root
+
+  Given input file "subdir/page.html.haml" contains "= include('/_partials/fragment.haml')"
+  And input file "_partials/fragment.haml" contains "%p blah blah"
+  When I build the site
+  Then output file "subdir/page.html" should contain "<p>blah blah</p>"
+
+Scenario: pass local variable to a partial
+
+  Given input file "index.html.haml" contains
+    """
+    = include("_list.haml", :items => [1,2,3])
+    """
+
+  And input file "_list.haml" contains
+    """
+    %ul
+      - items.each do |i|
+        %li= i
+    """
+   
+  When I build the site
+  
+  Then output file "index.html" should contain
+    """
+    <ul>
+      <li>1</li>
+      <li>2</li>
+      <li>3</li>
+    </ul>
+    """
+
+Scenario: use instance variable in a partial
+
+  Given input file "index.html.haml" contains
+    """
+    - @items = [1,2,3]
+    = include("_list.haml")
+    """
+
+  And input file "_list.haml" contains
+    """
+    %ul
+      - @items.each do |i|
+        %li= i
+    """
+   
+  When I build the site
+  
+  Then output file "index.html" should contain
+    """
+    <ul>
+      <li>1</li>
+      <li>2</li>
+      <li>3</li>
+    </ul>
+    """