pith 0.1.1 → 0.2.0

data/README.markdown

@@ -140,10 +140,48 @@ There's also a "`link`" function, for even easier hyper-linking:
 
     link("other.html", "Other page")
     
+Configuring Pith
+----------------
+
+The behaviour of Pith can be customised somewhat, by dropping a "`config.rb`" file into the "`_pith`" directory.
+
+There are a couple of flags that can be set to modify generation of links using "`href`" and "`link`":
+
+    project.assume_content_negotiation = true
+    project.assume_directory_index = true
+
+Both flags default to false.  When `assume_content_negotiation` is enabled, Pith omits the ".html" suffix from links.  When `assume_directory_index` is enabled, Pith abbreviates links to "index.html" files.  Both of these assumptions work nicely when the generated files are served using a web-server such as Apache httpd, but aren't appropriate if you wish to navigate them as static files on the filesystem.
+
+It's also possible to mix behaviour into Pith, using the config file, e.g.
+
+    project.helpers do
+
+      def handy_method
+        # ...
+      end
+
+    end
+
+Any methods defined in a `project.helpers` block are available for use in templates.
+
+For a more extensive example of a config file, look [over here](https://github.com/mdub/dogbiscuit.org/blob/master/src/_pith/config.rb).
+
+Incremental rebuild
+-------------------
+
+For quick prototyping, use the "`watch`" command, rather than "`build`".  After building your site, Pith will stay running, and regenerate output files (as necessary) as you edit the inputs.  We keep track of which input files are involved in the production of each output, so only the affected outputs are re-generated.
+
+    $ pith -i SITE watch
+    Generating to "SITE/_out"
+    --(copy)-->   images/logo.png
+    --(haml)-->   index.html
+    # ... edit "index.html.haml" ...
+    --(haml)-->   index.html
+
 Built-in web-server
 -------------------
 
-For quick prototyping, pith includes a simple HTTP server.  Start it by using the "`serve`" command, rather than "`build`"
+For even quicker prototyping, Pith includes a simple HTTP server.  Start it by using the "`serve`" command, rather than "`build`"
 
     $ pith -i SITE serve
     Generating to "SITE/_out"

data/features/pipeline.feature

@@ -0,0 +1,24 @@
+Feature: apply multiple template processors
+
+  I want to apply multiple template processors
+  So that I can take advantage of the best features of each
+
+Scenario: Markdown page with embedded ERB
+
+  Given input file "article.html.md.erb" contains
+    """
+    <% %w(one two three).each do |n| %>
+    - <%= n %>
+    <% end %>
+    """
+
+  When I build the site
+
+  Then output file "article.html" should contain
+    """
+    <ul>
+    <li>one</li>
+    <li>two</li>
+    <li>three</li>
+    </ul>
+    """

data/lib/pith/input/abstract.rb

@@ -32,8 +32,8 @@ module Pith
       #
       def build
         return false if ignorable? || uptodate?
-        logger.info("%-16s%s" % ["--(#{type})-->", output_path])
-        generate_output 
+        logger.info("--> #{output_path}")
+        generate_output
       end
 
       # Public: Resolve a reference relative to this input.

data/lib/pith/input/resource.rb

@@ -11,15 +11,11 @@ module Pith
       def output_path
         path
       end
-      
-      def type
-        "copy"
-      end
-      
+
       def uptodate?
         FileUtils.uptodate?(output_file, [file])
       end
-      
+
       # Copy this input verbatim into the output directory
       #
       def generate_output
@@ -36,7 +32,7 @@ module Pith
       def meta
         {}
       end
-      
+
     end
 
   end

data/lib/pith/input/template.rb

@@ -14,18 +14,17 @@ module Pith
     class Template < Abstract
 
       def self.can_handle?(path)
-        path.to_s =~ /\.([^.]+)$/ && Tilt.registered?($1)
+        !!Tilt[path.to_s]
       end
-      
+
       def initialize(project, path)
         raise(ArgumentError, "#{path} is not a template") unless Template.can_handle?(path)
         super(project, path)
-        path.to_s =~ /^(.+)\.(.+)$/ || raise("huh?")
-        @output_path = Pathname($1)
-        @type = $2
+        determine_pipeline
+        load
       end
 
-      attr_reader :output_path, :type
+      attr_reader :output_path
 
       # Check whether output is up-to-date.
       #
@@ -43,7 +42,7 @@ module Pith
         output_file.open("w") do |out|
           begin
             out.puts(render_context.render(self))
-          rescue Exception => e
+          rescue StandardError, SyntaxError => e
             logger.warn e.summary(:max_backtrace => 5)
             out.puts "<pre>"
             out.puts e.summary
@@ -55,12 +54,14 @@ module Pith
       # Render this input using Tilt
       #
       def render(context, locals = {}, &block)
-        load
-        @tilt_template.render(context, locals, &block)
+        @pipeline.inject(@template_text) do |text, processor|
+          template = processor.new(file.to_s, @template_start_line) { text }
+          template.render(context, locals, &block)
+        end
       end
-      
+
       # Public: Get YAML metadata declared in the header of of a template.
-      # 
+      #
       # If the first line of the template starts with "---" it is considered to be
       # the start of a YAML 'document', which is loaded and returned.
       #
@@ -75,11 +76,10 @@ module Pith
       #
       #   input.meta
       #   #=> { "published" => "2008-09-15" }
-      #  
+      #
       # Returns a Hash.
       #
       def meta
-        load
         @meta
       end
 
@@ -94,41 +94,63 @@ module Pith
       #  #=> "some_page.html.haml"
       #  input.title
       #  #=> "Some page"
-      # 
+      #
       def title
         meta["title"] || default_title
       end
 
       private
-        
+
       def default_title
         path.basename.to_s.sub(/\..*/, '').tr('_-', ' ').capitalize
       end
 
+      def determine_pipeline
+        @pipeline = []
+        remaining_path = path.to_s
+        while remaining_path =~ /^(.+)\.(.+)$/
+          if Tilt[$2]
+            remaining_path = $1
+            @pipeline << Tilt[$2]
+          else
+            break
+          end
+        end
+        @output_path = Pathname(remaining_path)
+      end
+
       # Read input file, extracting YAML meta-data header, and template content.
       #
       def load
-        return false if @tilt_template
-        @meta = {}
         file.open do |input|
-          header = input.gets
-          if header =~ /^---/
-            while line = input.gets
-              break if line =~ /^(---|\.\.\.)/
-              header << line
-            end
-            begin
-              @meta = YAML.load(header)
-            rescue
-              logger.warn "#{file}:1: badly-formed YAML header"
-            end
-          else
-            input.rewind
+          load_meta(input)
+          load_template(input)
+        end
+      end
+
+      def load_meta(input)
+        @meta = {}
+        header = input.gets
+        if header =~ /^---/
+          while line = input.gets
+            break if line =~ /^(---|\.\.\.)/
+            header << line
+          end
+          begin
+            @meta = YAML.load(header)
+          rescue ArgumentError, SyntaxError
+            logger.warn "#{file}:1: badly-formed YAML header"
           end
-          @tilt_template = Tilt.new(file.to_s, input.lineno + 1) { input.read }
+        else
+          input.rewind
         end
       end
-      
+
+      def load_template(input)
+        @template_start_line = input.lineno + 1
+        @template_text = input.read
+      end
+
       attr_accessor :dependencies
 
     end

data/lib/pith/version.rb

@@ -1,3 +1,3 @@
 module Pith
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/pith/watcher.rb

@@ -1,9 +1,9 @@
 module Pith
-  
+
   class Watcher
 
     DEFAULT_INTERVAL = 2
-    
+
     def initialize(project, options = {})
       @project = project
       @interval = DEFAULT_INTERVAL
@@ -11,7 +11,7 @@ module Pith
         send("#{k}=", v)
       end
     end
-    
+
     attr_accessor :project
     attr_accessor :interval
 
@@ -19,11 +19,13 @@ module Pith
       loop do
         begin
           project.build
+          sleep(interval)
+        rescue Interrupt
+          break
         end
-        sleep(interval)
       end
     end
 
   end
-  
+
 end

metadata

@@ -1,149 +1,147 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pith
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-08 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: tilt
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70100992669820 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.1"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: adsf
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70100992669820
+- !ruby/object:Gem::Dependency
+  name: adsf
+  requirement: &70100992665860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rack
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70100992665860
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70100992659140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.2.1
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: thin
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70100992659140
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: &70100992656080 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.2.7
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: clamp
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70100992656080
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: &70100992634020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.1.7
   type: :runtime
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *70100992634020
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70100992621940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: *70100992621940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70100992611420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.2.9
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: cucumber
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  version_requirements: *70100992611420
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70100992606220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.8.3
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: haml
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *70100992606220
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &70100992599740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id009
-- !ruby/object:Gem::Dependency 
-  name: RedCloth
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: *70100992599740
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: &70100992582600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id010
-- !ruby/object:Gem::Dependency 
-  name: rdiscount
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  version_requirements: *70100992582600
+- !ruby/object:Gem::Dependency
+  name: rdiscount
+  requirement: &70100992575120 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id011
-description: |
-  Pith builds static websites, using markup/template languages including Haml, Sass, ERb, Liquid, Markdown and Textile.
+  prerelease: false
+  version_requirements: *70100992575120
+description: ! 'Pith builds static websites, using markup/template languages including
+  Haml, Sass, ERb, Liquid, Markdown and Textile.
 
+'
 email: mdub@dogbiscuit.org
-executables: 
+executables:
 - pith
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/pith/console_logger.rb
 - lib/pith/console_logger.rb~
 - lib/pith/exception_ext.rb
@@ -217,6 +215,7 @@ files:
 - features/markdown.feature
 - features/metadata.feature
 - features/metadata.feature~
+- features/pipeline.feature
 - features/relative_linking.feature
 - features/relative_linking.feature~
 - features/resources.feature
@@ -233,32 +232,35 @@ files:
 - bin/pith
 homepage: http://github.com/mdub/pith
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2050158771651431666
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2050158771651431666
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A static website generator
-test_files: 
+test_files:
 - Rakefile
 - spec/pith/input/abstract_spec.rb~
 - spec/pith/input/template_spec.rb
@@ -290,6 +292,7 @@ test_files:
 - features/markdown.feature
 - features/metadata.feature
 - features/metadata.feature~
+- features/pipeline.feature
 - features/relative_linking.feature
 - features/relative_linking.feature~
 - features/resources.feature
@@ -303,4 +306,3 @@ test_files:
 - features/textile.feature~
 - features/verbatim.feature~
 - cucumber.yml
-has_rdoc: