pith 0.2.0 → 0.2.1

data/bin/pith

@@ -16,11 +16,11 @@ class PithCommand < Clamp::Command
   option ["-i", "--input"], "INPUT_DIR", "Input directory", :attribute_name => :input_dir, :default => "." do |dir|
     Pathname(dir)
   end
-  
+
   option ["-o", "--output"], "OUTPUT_DIR", "Output directory", :attribute_name => :output_dir, :default => "INPUT_DIR/_out" do |dir|
     Pathname(dir)
   end
-  
+
   option ["-n", "--interval"], "INTERVAL", "Rebuild interval", :default => 2 do |n|
     Integer(n)
   end
@@ -45,7 +45,7 @@ class PithCommand < Clamp::Command
       watch
     end
   end
-  
+
   subcommand "serve", "Serve the generated website" do
     def execute
       build
@@ -63,7 +63,7 @@ class PithCommand < Clamp::Command
   def default_output_dir
     input_dir + "_out"
   end
-  
+
   def project
     unless @project
       pith_dir = input_dir + "_pith"
@@ -79,6 +79,7 @@ class PithCommand < Clamp::Command
 
   def build
     project.build
+    exit(1) if project.has_errors?
   end
 
   def watch
@@ -92,7 +93,7 @@ class PithCommand < Clamp::Command
     puts %{>>> Now taking the Pith at "http://localhost:#{port}"}
     Rack::Handler.get("thin").run(server, :Port => port)
   end
-  
+
 end
 
 PithCommand.run

data/features/error_handling.feature

@@ -1,16 +1,17 @@
 Feature: error handling
 
   I want to be told when something goes wrong
-  
+
 Scenario: bad haml
 
   Given input file "index.html.haml" contains
     """
     %h2{class="this is not valid ruby"} Heading
-    
+
     %p Content
     """
-    
+
   When I build the site
-  
+
   Then output file "index.html" should contain /syntax error/
+  And the project should have errors

data/features/step_definitions/build_steps.rb

@@ -72,3 +72,7 @@ end
 Then /^output file "([^\"]*)" should contain an error$/ do |path|
   @outputs[path].clean.should == "foo"
 end
+
+Then /^the project should have errors$/ do
+  @project.should have_errors
+end

data/lib/pith/input.rb

@@ -1,22 +1,226 @@
-require "pith/input/template"
-require "pith/input/resource"
+require "fileutils"
+require "pathname"
+require "pith/render_context"
+require "tilt"
+require "yaml"
 
 module Pith
-  module Input
+  class Input
 
-    class << self
+    def initialize(project, path)
+      @project = project
+      @path = path
+      @meta = {}
+      determine_pipeline
+      load unless resource?
+    end
+
+    attr_reader :project, :path
+
+    attr_reader :output_path
+    attr_reader :dependencies
+    attr_reader :pipeline
+    attr_reader :error
+
+    # Public: Get the file-system location of this input.
+    #
+    # Returns a fully-qualified Pathname.
+    #
+    def file
+      project.input_dir + path
+    end
+
+    # Public: Get the file-system location of the corresponding output file.
+    #
+    # Returns a fully-qualified Pathname.
+    #
+    def output_file
+      project.output_dir + output_path
+    end
+
+    # Public: Generate an output file.
+    #
+    def build
+      return false if ignorable? || uptodate?
+      logger.info("--> #{output_path}")
+      generate_output
+    end
+
+    # Consider whether this input can be ignored.
+    #
+    # Returns true if it can.
+    #
+    def ignorable?
+      path.each_filename do |path_component|
+        project.ignore_patterns.each do |pattern|
+          return true if File.fnmatch(pattern, path_component)
+        end
+      end
+    end
 
-      # Construct an object representing a project input file.
-      #
-      def new(project, path)
-        if Template.can_handle?(path)
-          Template.new(project, path)
+    # Check whether output is up-to-date.
+    #
+    # Return true unless output needs to be re-generated.
+    #
+    def uptodate?
+      dependencies && FileUtils.uptodate?(output_file, dependencies)
+    end
+
+    # Generate output for this template
+    #
+    def generate_output
+      output_file.parent.mkpath
+      return FileUtils.copy(file, output_file) if resource?
+      render_context = RenderContext.new(project)
+      output_file.open("w") do |out|
+        begin
+          @error = nil
+          out.puts(render_context.render(self))
+        rescue StandardError, SyntaxError => e
+          @error = e
+          logger.warn exception_summary(e, :max_backtrace => 5)
+          out.puts "<pre>"
+          out.puts exception_summary(e)
+        end
+      end
+      @dependencies = render_context.dependencies
+    end
+
+    # Render this input using Tilt
+    #
+    def render(context, locals = {}, &block)
+      return file.read if resource?
+      @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.
+    #
+    # Examples
+    #
+    #   Given input starting with:
+    #
+    #     ---
+    #     published: 2008-09-15
+    #     ...
+    #     OTHER STUFF
+    #
+    #   input.meta
+    #   #=> { "published" => "2008-09-15" }
+    #
+    # Returns a Hash.
+    #
+    def meta
+      @meta
+    end
+
+    # Public: Get page title.
+    #
+    # The default title is based on the input file-name, sans-extension, capitalised,
+    # but can be overridden by providing a "title" in the metadata block.
+    #
+    # Examples
+    #
+    #  input.path.to_s
+    #  #=> "some_page.html.haml"
+    #  input.title
+    #  #=> "Some page"
+    #
+    def title
+      meta["title"] || default_title
+    end
+
+    # Public: Resolve a reference relative to this input.
+    #
+    # ref - a String referencing another asset
+    #
+    # A ref starting with "/" is resolved relative to the project root;
+    # anything else is resolved relative to this input.
+    #
+    # Returns a fully-qualified Pathname of the asset.
+    #
+    def resolve_path(ref)
+      ref = ref.to_s
+      if ref[0,1] == "/"
+        Pathname(ref[1..-1])
+      else
+        path.parent + ref
+      end
+    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
-          Resource.new(project, path)
+          break
+        end
+      end
+      @output_path = Pathname(remaining_path)
+      if resource?
+        @dependencies = [file]
+      end
+    end
+
+    def resource?
+      pipeline.empty?
+    end
+
+    # Read input file, extracting YAML meta-data header, and template content.
+    #
+    def load
+      file.open do |input|
+        load_meta(input)
+        load_template(input)
+      end
+    end
+
+    def load_meta(input)
+      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
+      else
+        input.rewind
       end
+    end
+
+    def load_template(input)
+      @template_start_line = input.lineno + 1
+      @template_text = input.read
+    end
 
+    def exception_summary(e, options = {})
+      max_backtrace = options[:max_backtrace] || 999
+      trimmed_backtrace = e.backtrace[0, max_backtrace]
+      (["#{e.class}: #{e.message}"] + trimmed_backtrace).join("\n    ") + "\n"
+    end
+
+    def logger
+      project.logger
     end
 
   end
-end
+
+end

data/lib/pith/plugins/publication/input.rb

@@ -32,19 +32,7 @@ module Pith
 end
 
 module Pith
-  module Input
-
-    class Abstract
-
-      def published?
-        false
-      end
-
-    end
-
-    class Template
-      include Pith::Plugins::Publication::TemplateMethods
-    end
-    
+  class Input
+    include Pith::Plugins::Publication::TemplateMethods
   end
 end

data/lib/pith/project.rb

@@ -5,21 +5,21 @@ require "pith/reference_error"
 require "tilt"
 
 module Pith
-  
+
   class Project
-    
+
     DEFAULT_IGNORE_PATTERNS = ["_*", ".git", ".svn"].freeze
-    
+
     def initialize(attributes = {})
       @ignore_patterns = DEFAULT_IGNORE_PATTERNS.dup
       attributes.each do |k,v|
         send("#{k}=", v)
       end
     end
-    
+
     attr_reader :input_dir
     attr_reader :ignore_patterns
-    
+
     def input_dir=(dir)
       @input_dir = Pathname(dir)
     end
@@ -32,12 +32,12 @@ module Pith
 
     attr_accessor :assume_content_negotiation
     attr_accessor :assume_directory_index
-    
+
     # Public: get inputs
     #
     # Returns Pith::Input objects representing the files in the input_dir.
     #
-    # The list of inputs is cached after first load; 
+    # The list of inputs is cached after first load;
     #   call #refresh to discard the cached data.
     #
     def inputs
@@ -71,7 +71,7 @@ module Pith
       generate_outputs
       output_dir.touch
     end
-    
+
     # Public: discard cached data that is out-of-sync with the file-system.
     #
     def refresh
@@ -79,32 +79,39 @@ module Pith
       @config_files = nil
     end
 
+    # Public: check for errors.
+    #
+    # Returns true if any errors were encountered during the last build.
+    def has_errors?
+      @inputs.any?(&:error)
+    end
+
     def last_built_at
       output_dir.mtime
     end
-    
+
     def logger
       @logger ||= Logger.new(nil)
     end
-    
+
     attr_writer :logger
 
     def helpers(&block)
       helper_module.module_eval(&block)
     end
-    
+
     def helper_module
       @helper_module ||= Module.new
     end
 
     def config_files
-      @config_files ||= begin 
+      @config_files ||= begin
         input_dir.all_files("_pith/**")
       end.to_set
     end
-    
+
     private
-    
+
     def load_config
       config_file = input_dir + "_pith/config.rb"
       project = self
@@ -112,7 +119,7 @@ module Pith
         eval(config_file.read, binding, config_file.to_s, 1)
       end
     end
-    
+
     def remove_old_outputs
       valid_output_paths = inputs.map { |i| i.output_path }
       output_dir.all_files.each do |output_file|
@@ -123,9 +130,9 @@ module Pith
         end
       end
     end
-    
+
     def generate_outputs
-      inputs.each do |input| 
+      inputs.each do |input|
         input.build
       end
     end
@@ -141,7 +148,7 @@ module Pith
       cache_key = [path, file.mtime]
       input_cache[cache_key]
     end
-    
+
   end
-  
+
 end