pith 0.0.2 → 0.0.3

data/lib/pith/input/abstract.rb

@@ -0,0 +1,120 @@
+require "pathname"
+require "pith/metadata"
+
+module Pith
+  module Input
+
+    class Abstract
+
+      def initialize(project, path)
+        @project = project
+        @path = path
+      end
+
+      attr_reader :project, :path
+
+      # Public: Get the file-system location of this input.
+      #
+      # Returns a fully-qualified Pathname.
+      #
+      def file
+        project.input_dir + path
+      end
+
+      def output_file
+        project.output_dir + output_path
+      end
+
+      # Public: Get YAML metadata declared in the header of of a template.
+      # 
+      # The first line of the template must end with "---".  Any preceding characters
+      # are considered to be a comment prefix, and are stripped from the following
+      # lines.  The metadata block ends when the comment block ends, or a line ending
+      # with "..." is encountered.
+      #
+      # Examples
+      #
+      #   Given input starting with:
+      #
+      #     -# ---
+      #     -# published: 2008-09-15
+      #     -# ...
+      #
+      #   input.meta
+      #   #=> { "published" => "2008-09-15" }
+      #  
+      # Returns a Hash.
+      #
+      def meta
+        if @metadata.nil?
+          file.open do |io|
+            @metadata = Pith::Metadata.extract_from(io).freeze
+          end
+        end
+        @metadata
+      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: Generate a corresponding output file.
+      #
+      def build
+        return false if ignorable? || uptodate?
+        logger.info("%-36s%-14s%s" % [path, "--(#{type})-->", output_path])
+        generate_output 
+      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_str
+        if ref[0,1] == "/"
+          Pathname(ref[1..-1])
+        else
+          path.parent + ref
+        end
+      end
+
+      # Consider whether this input can be ignored.
+      #
+      # Returns true if it can.
+      #
+      def ignorable?
+        path.to_s.split("/").any? { |component| component.to_s[0,1] == "_" }
+      end
+
+      protected
+        
+      def default_title
+        path.to_s.sub(/\..*/, '').tr('_-', ' ').capitalize
+      end
+
+      def logger
+        project.logger
+      end
+
+    end
+
+  end
+end

data/lib/pith/input/abstract.rb~

@@ -0,0 +1,120 @@
+require "pathname"
+require "pith/metadata"
+
+module Pith
+  module Input
+
+    class Abstract
+
+      def initialize(project, path)
+        @project = project
+        @path = path
+      end
+
+      attr_reader :project, :path
+
+      # Public: Get the file-system location of this input.
+      #
+      # Returns a fully-qualified Pathname.
+      #
+      def file
+        project.input_dir + path
+      end
+
+      def output_file
+        project.output_dir + output_path
+      end
+
+      # Public: Get YAML metadata declared in the header of of a template.
+      # 
+      # The first line of the template must end with "---".  Any preceding characters
+      # are considered to be a comment prefix, and are stripped from the following
+      # lines.  The metadata block ends when the comment block ends, or a line ending
+      # with "..." is encountered.
+      #
+      # Examples
+      #
+      #   Given input starting with:
+      #
+      #     -# ---
+      #     -# published: 2008-09-15
+      #     -# ...
+      #
+      #   input.meta
+      #   #=> { "published" => "2008-09-15" }
+      #  
+      # Returns a Hash.
+      #
+      def meta
+        if @metadata.nil?
+          file.open do |io|
+            @metadata = Pith::Metadata.extract_from(io).freeze
+          end
+        end
+        @metadata
+      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: Generate a corresponding output file.
+      #
+      def build
+        return false if ignorable? || uptodate?
+        logger.info("%-36s%-14s%s" % [path, "--(#{type})-->", output_path])
+        generate_output 
+      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_str
+        if ref[0,1] == "/"
+          Pathname(ref[1..-1])
+        else
+          path.parent + ref
+        end
+      end
+
+      # Consider whether this input can be ignored.
+      #
+      # Returns true if it can.
+      #
+      def ignorable?
+        path.to_s.split("/").any? { |component| component.to_s[0,1] == "_" }
+      end
+
+      protected
+        
+      def default_title
+        path.to_s.sub(/\..*/, '').tr('_-', ' ').capitalize
+      end
+
+      def logger
+        project.logger
+      end
+
+    end
+
+  end
+end

data/lib/pith/input/template.rb

@@ -0,0 +1,56 @@
+require "fileutils"
+require "pathname"
+require "pith/input/abstract"
+require "pith/render_context"
+require "tilt"
+
+module Pith
+  module Input
+
+    class Template < Abstract
+
+      class UnrecognisedType < StandardError; end
+      
+      def initialize(project, path)
+        super(project, path)
+        path.to_s =~ /^(.*)\.(.*)$/
+        @output_path = Pathname($1)
+        @type = $2
+        raise(UnrecognisedType, @type) unless Tilt.registered?(@type)
+      end
+
+      attr_reader :output_path, :type
+
+      def uptodate?
+        all_input_files && FileUtils.uptodate?(output_file, all_input_files)
+      end
+
+      # Generate output for this template
+      #
+      def generate_output
+        output_file.parent.mkpath
+        render_context = RenderContext.new(project)
+        output_file.open("w") do |out|
+          out.puts(render_context.render(self))
+        end
+        remember_dependencies(render_context.rendered_inputs)
+      end
+
+      # Render this input using Tilt
+      #
+      def render(context, locals = {}, &block)
+        Tilt.new(file).render(context, locals, &block)
+      end
+
+      private
+
+      def remember_dependencies(rendered_inputs)
+        @all_input_files = rendered_inputs.map { |input| input.file }
+      end
+
+      attr_accessor :all_input_files
+
+    end
+
+  end
+end

data/lib/pith/input/template.rb~

@@ -0,0 +1,46 @@
+require "fileutils"
+require "pathname"
+require "pith/input/abstract"
+require "pith/render_context"
+
+module Pith
+  module Input
+
+    class Template < Abstract
+
+      def initialize(project, path)
+        super(project, path)
+        path.to_s =~ /^(.*)\.(.*)$/
+        @output_path = Pathname($1)
+        @type = $2
+      end
+
+      attr_reader :output_path, :type
+
+      def uptodate?
+        all_input_files && FileUtils.uptodate?(output_file, all_input_files)
+      end
+
+      # Render this input using Tilt
+      #
+      def generate_output
+        output_file.parent.mkpath
+        render_context = RenderContext.new(project)
+        output_file.open("w") do |out|
+          out.puts(render_context.render_input(self))
+        end
+        remember_dependencies(render_context.rendered_inputs)
+      end
+
+      private
+
+      def remember_dependencies(rendered_inputs)
+        @all_input_files = rendered_inputs.map { |input| input.file }
+      end
+
+      attr_accessor :all_input_files
+
+    end
+
+  end
+end

data/lib/pith/input/verbatim.rb

@@ -0,0 +1,31 @@
+require "fileutils"
+require "pith/input/abstract"
+
+module Pith
+  module Input
+
+    class Verbatim < Abstract
+
+      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
+        output_file.parent.mkpath
+        FileUtils.copy(file, output_file)
+      end
+      
+    end
+
+  end
+end

data/lib/pith/input/verbatim.rb~

@@ -0,0 +1,31 @@
+require "fileutils"
+require "pith/input/abstract"
+
+module Pith
+  module Input
+
+    class Verbatim < Abstract
+
+      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
+        output_file.parent.mkpath
+        FileUtils.copy(file, output_file)
+      end
+      
+    end
+
+  end
+end

data/lib/pith/input.rb

@@ -1,6 +1,5 @@
-require "pith/render_context"
-require "pith/metadata"
-require "fileutils"
+require "pith/input/template"
+require "pith/input/verbatim"
 
 module Pith
   module Input
@@ -8,182 +7,12 @@ module Pith
     class << self
 
       def new(project, path)
-        if path.to_s =~ /^(.*)\.(.*)$/ && RenderContext.can_render?($2)
-          Template.new(project, path)
-        else
-          Verbatim.new(project, path)
-        end
+        Template.new(project, path)
+      rescue Template::UnrecognisedType
+        Verbatim.new(project, path)
       end
 
     end
 
-    class Abstract
-
-      def initialize(project, path)
-        @project = project
-        @path = path
-      end
-
-      attr_reader :project, :path
-
-      # Public: Get the file-system location of this input.
-      #
-      # Returns a fully-qualified Pathname.
-      #
-      def full_path
-        project.input_dir + path
-      end
-
-      # Public: Get YAML metadata declared in the header of of a template.
-      # 
-      # The first line of the template must end with "---".  Any preceding characters
-      # are considered to be a comment prefix, and are stripped from the following
-      # lines.  The metadata block ends when the comment block ends, or a line ending
-      # with "..." is encountered.
-      #
-      # Examples
-      #
-      #   Given input starting with:
-      #
-      #     -# ---
-      #     -# published: 2008-09-15
-      #     -# ...
-      #
-      #   input.meta
-      #   #=> { "published" => "2008-09-15" }
-      #  
-      # Returns a Hash.
-      #
-      def meta
-        if @metadata.nil?
-          full_path.open do |io|
-            @metadata = Pith::Metadata.extract_from(io).freeze
-          end
-        end
-        @metadata
-      end
-
-      # Public: Generate a corresponding output file.
-      #
-      # Returns the output Pathname.
-      # Returns nil if no output was generated.
-      #
-      def build
-        generate_output unless ignorable? || uptodate?
-      end
-
-      # Public: Resolve a reference relative to this input.
-      #
-      # href - a String referencing another asset
-      #
-      # An href 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 relative_path(href)
-        href = href.to_str
-        if href[0,1] == "/"
-          Pathname(href[1..-1])
-        else
-          path.parent + href
-        end
-      end
-
-      # Resolve a reference relative to this input.
-      #
-      # href - a String referencing another asset
-      #
-      # Returns the referenced Input.
-      #
-      def relative_input(href)
-        project.input(relative_path(href))
-      end
-
-      # Consider whether this input can be ignored.
-      #
-      # Returns true if it can.
-      #
-      def ignorable?
-        path.to_s.split("/").any? { |component| component.to_s[0,1] == "_" }
-      end
-
-      protected
-
-      def logger
-        project.logger
-      end
-
-      def trace(strategy, output_path = nil)
-        output_path ||= "X"
-        logger.info("%-36s%-14s%s" % [path, "--(#{strategy})-->", output_path])
-      end
-
-    end
-
-    class Template < Abstract
-      
-      def initialize(project, path)
-        super(project, path)
-        path.to_s =~ /^(.*)\.(.*)$/
-        @output_path = $1
-        @type = $2
-      end
-
-      attr_reader :output_path, :type
-      
-      def full_output_path
-        project.output_dir + output_path
-      end
-      
-      def uptodate?
-        return false if all_input_paths.nil?
-        FileUtils.uptodate?(full_output_path, all_input_paths)
-      end
-      
-      # Render this input using Tilt
-      #
-      def generate_output
-        trace(type, output_path)
-        full_output_path.parent.mkpath
-        render_context = RenderContext.new(project)
-        full_output_path.open("w") do |out|
-          out.puts(render_context.render(self))
-        end
-        remember_dependencies(render_context.rendered_inputs)
-      end
-
-      private
-
-      def remember_dependencies(rendered_inputs)
-        @all_input_paths = rendered_inputs.map { |input| input.full_path }
-      end
-
-      def all_input_paths
-        @all_input_paths
-      end
-      
-    end
-
-    class Verbatim < Abstract
-
-      def full_output_path
-        project.output_dir + path
-      end
-      
-      def uptodate?
-        FileUtils.uptodate?(full_output_path, [full_path])
-      end
-      
-      # Copy this input verbatim into the output directory
-      #
-      def generate_output
-        trace("copy", path)
-        full_output_path.parent.mkpath
-        FileUtils.copy(full_path, full_output_path)
-      end
-      
-    end
-    
   end
 end

data/lib/pith/input.rb~

@@ -1,95 +1,20 @@
-require "tilt"
-require "pith/output_context"
-require "pith/metadata"
+require "pith/input/template"
+require "pith/input/verbatim"
 
 module Pith
-  
-  class Input
-    
-    def initialize(project, path)
-      @project = project
-      @path = path
-    end
-
-    attr_reader :project, :path
-    
-    def build
-      ignore || evaluate_as_tilt_template || copy_verbatim
-    end
-
-    def relative_input(name)
-      resolved_path = relative_path(name)
-      input = project.inputs.find do |input|
-        input.path == resolved_path
-      end
-      raise %{can't locate "#{resolved_path}"} if input.nil?
-      input
-    end
-    
-    def relative_path(name)
-      name = name.to_str
-      if name[0,1] == "/"
-        Pathname(name[1..-1])
-      else
-        path.parent + name
-      end
-    end
-    
-    def render(context, locals = {}, &block)
-      Tilt.new(full_path).render(context, locals, &block)
-    end
+  module Input
 
-    def meta
-      if @metadata.nil?
-        full_path.open do |io|
-          @metadata = Pith::Metadata.extract_from(io).freeze
-        end
-      end
-      @metadata
-    end
-    
-    private
-
-    def logger
-      project.logger
-    end
+    class << self
 
-    def trace(strategy, output_path = nil)
-      output_path ||= "X"
-      logger.info("%-36s%-14s%s" % [path, "--(#{strategy})-->", output_path])
-    end
-    
-    def full_path
-      project.input_dir + path
-    end
-    
-    def ignore
-      path.to_s.split("/").any? { |component| component.to_s[0,1] == "_" }
-    end
-    alias :ignorable? :ignore
-    
-    def evaluate_as_tilt_template
-      if path.to_s =~ /^(.*)\.(.*)$/ && Tilt.registered?($2)
-        output_path = Pathname($1); ext = $2
-        trace(ext, output_path)
-        output_file = project.output_dir + output_path
-        output_file.parent.mkpath
-        output_file.open("w") do |out|
-          output = render(RenderContext.new(self))
-          out.puts(output)
+      def new(project, path)
+        if path.to_s =~ /^(.*)\.(.*)$/ && RenderContext.can_render?($2)
+          Template.new(project, path)
+        else
+          Verbatim.new(project, path)
         end
-        output_file
       end
-    end
 
-    def copy_verbatim
-      trace("copy", path)
-      output_path = project.output_dir + path
-      output_path.parent.mkpath
-      FileUtils.copy(full_path, output_path)
-      output_path
     end
 
   end
-  
-end
+end