pith 0.3.0 → 0.3.1

data/bin/pith

@@ -69,10 +69,7 @@ class PithCommand < Clamp::Command
         signal_usage_error %(No "#{pith_dir}" directory ... this doesn't look right!)
       end
       puts %{Generating to "#{output_dir}"}
-      @project = Pith::Project.new(
-        :input_dir => input_dir, :output_dir => output_dir,
-        :logger => Pith::ConsoleLogger.new
-      )
+      @project = Pith::Project.new(input_dir, output_dir, :logger => Pith::ConsoleLogger.new)
     end
   end
 

data/features/incremental_rebuild.feature

@@ -22,3 +22,51 @@ Scenario: don't alter an input, and the output is untouched
   When I rebuild the site
 
   Then output file "page.html" should not be re-generated
+
+Scenario: alter a dependency
+
+  Given input file "page.html.haml" contains "= include('_partials/foo.haml')"
+  And input file "_partials/foo.haml" contains "bananas"
+  And the site is up-to-date
+
+  When I change input file "_partials/foo.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: delete a dependency
+
+  Given input file "fruits.html.haml" contains
+    """
+    - project.inputs.map(&:path).map(&:to_s).grep(/^_fruit/).sort.each do |input_name|
+      %p= include(input_name)
+    """
+
+  And input file "_fruit/a.html.haml" contains
+    """
+    apple
+    """
+
+  And input file "_fruit/b.html.haml" contains
+    """
+    banana
+    """
+
+  And the site is up-to-date
+
+  Then output file "fruits.html" should contain
+    """
+    <p>apple</p>
+    <p>banana</p>
+    """
+
+  When I remove input file "_fruit/a.html.haml"
+  And I rebuild the site
+
+  Then output file "fruits.html" should be re-generated
+  And output file "fruits.html" should contain
+    """
+    <p>banana</p>
+    """
+

data/features/relative_linking.feature

@@ -3,11 +3,6 @@ Feature: linking between files
   I want to be able to generate relative reference to other pages
   So that the generated site is re-locateable
 
-Background:
-
-  Given the "assume_content_negotiation" flag is disabled
-  And   the "assume_directory_index" flag is disabled
-
 Scenario: link from one top-level page to another
 
   Given input file "index.html.haml" contains
@@ -148,7 +143,11 @@ Scenario: link to a missing resource
 
 Scenario: assume content negotiation
 
-  Given the "assume_content_negotiation" flag is enabled
+  Given the config file contains
+    """
+    project.assume_content_negotiation = true
+    """
+
   And input file "index.html.haml" contains
     """
     = link("page.html", "Page")
@@ -162,7 +161,10 @@ Scenario: assume content negotiation
 
 Scenario: link to an index page
 
-  Given the "assume_directory_index" flag is enabled
+  Given the config file contains
+    """
+    project.assume_directory_index = true
+    """
 
   And input file "page.html.haml" contains
     """
@@ -177,7 +179,10 @@ Scenario: link to an index page
 
 Scenario: link to an index page in the same directory
 
-  Given the "assume_directory_index" flag is enabled
+  Given the config file contains
+    """
+    project.assume_directory_index = true
+    """
 
   And input file "page.html.haml" contains
     """

data/features/step_definitions/build_steps.rb

@@ -14,12 +14,8 @@ Given "the site is up-to-date" do
   When "I build the site"
 end
 
-Given /^the "([^\"]*)" flag is enabled$/ do |flag|
-  @project.send("#{flag}=", true)
-end
-
-Given /^the "([^\"]*)" flag is disabled$/ do |flag|
-  @project.send("#{flag}=", false)
+Given /^the config file contains$/ do |content|
+  @inputs.write("_pith/config.rb", content, :mtime => (Time.now - 5))
 end
 
 When /^I change input file "([^\"]*)" to contain "([^\"]*)"$/ do |path, content|

data/features/support/env.rb

@@ -1,7 +1,7 @@
 require "pathname"
 
 class DirHash
-  
+
   def initialize(dir)
     @dir = Pathname(dir)
   end
@@ -34,7 +34,7 @@ class DirHash
       file_path.utime(timestamp, timestamp)
     end
   end
-  
+
 end
 
 class InternalLogger
@@ -42,13 +42,13 @@ class InternalLogger
   def initialize
     @messages = []
   end
-  
+
   attr_reader :messages
-  
+
   def clear
     @messages.clear
   end
-  
+
   def info(message, &block)
     message ||= block.call
     write(message)
@@ -56,11 +56,11 @@ class InternalLogger
 
   alias :warn :info
   alias :debug :info
-  
+
   def write(message)
     @messages << message
   end
-    
+
 end
 
 $project_dir = Pathname(__FILE__).expand_path.parent.parent.parent
@@ -79,8 +79,7 @@ Before do
     dir.rmtree if dir.exist?
     dir.mkpath
   end
-  @project = Pith::Project.new(:input_dir => $input_dir, :output_dir => $output_dir)
-  @project.logger = InternalLogger.new
+  @project = Pith::Project.new($input_dir, $output_dir, :logger => InternalLogger.new)
   @inputs = DirHash.new($input_dir)
   @outputs = DirHash.new($output_dir)
 end

data/lib/pith/config.rb

@@ -0,0 +1,42 @@
+module Pith
+
+  class Config
+
+    DEFAULT_IGNORE_PATTERNS = ["_*", ".git", ".gitignore", ".svn", ".sass-cache", "*~", "*.sw[op]"].to_set.freeze
+
+    def initialize
+      @ignore_patterns = DEFAULT_IGNORE_PATTERNS.dup
+      @helper_module = Module.new
+    end
+
+    attr_accessor :assume_content_negotiation
+    attr_accessor :assume_directory_index
+
+    attr_reader :ignore_patterns
+
+    def ignore(pattern)
+      ignore_patterns << pattern
+    end
+
+    attr_reader :helper_module
+
+    def helpers(&block)
+      helper_module.module_eval(&block)
+    end
+
+    class << self
+
+      def load(config_file)
+        config = self.new
+        if config_file.exist?
+          project = config # for backward compatibility
+          eval(config_file.read, binding, config_file.to_s, 1)
+        end
+        config
+      end
+
+    end
+
+  end
+
+end

data/lib/pith/config_provider.rb

@@ -0,0 +1,36 @@
+require "pith/config"
+require "pith/observable"
+
+module Pith
+
+  class ConfigProvider
+
+    include Pith::Observable
+
+    def initialize(project)
+      @project = project
+      @last_load_mtime = :never
+      sync
+    end
+
+    attr_reader :config
+
+    def sync
+      config_mtime = config_file.mtime rescue nil
+      unless config_mtime == @last_load_mtime
+        @last_load_mtime = config_mtime
+        @project.logger.debug "loading config"
+        @config = Pith::Config.load(config_file)
+        notify_observers
+      end
+    end
+
+    private
+
+    def config_file
+      @project.input_dir + "_pith/config.rb"
+    end
+
+  end
+
+end

data/lib/pith/input.rb

@@ -1,6 +1,6 @@
 require "fileutils"
 require "pathname"
-require "observer"
+require "pith/observable"
 require "pith/output"
 require "tilt"
 require "yaml"
@@ -9,13 +9,12 @@ module Pith
 
   class Input
 
-    include Observable
+    include Pith::Observable
 
     def initialize(project, path)
       @project = project
       @path = path
       determine_pipeline
-      when_created
     end
 
     attr_reader :project, :path
@@ -37,7 +36,7 @@ module Pith
     #
     def ignorable?
       @ignorable ||= path.each_filename do |path_component|
-        project.ignore_patterns.each do |pattern|
+        project.config.ignore_patterns.each do |pattern|
           return true if File.fnmatch(pattern, path_component)
         end
       end
@@ -126,37 +125,20 @@ module Pith
       end
     end
 
-    # Synchronise the state of the Input with the filesystem
-    #
-    # Returns true if the file still exists.
-    #
-    def sync
-      mtime = file.mtime
-      if mtime.to_i > @last_mtime.to_i
-        @last_mtime = mtime
-        when_changed
-      end
-      true
-    rescue Errno::ENOENT => e
-      when_deleted
-      nil
-    end
-
-    def when_created
+    def when_added
       log_lifecycle "+"
-      @last_mtime = file.mtime
     end
 
-    def when_changed
+    def when_modified
       log_lifecycle "~"
       unload if loaded?
-      changed(true)
       notify_observers
     end
 
-    def when_deleted
+    def when_removed
       log_lifecycle "X"
       output.delete if output
+      notify_observers
     end
 
     private

data/lib/pith/observable.rb

@@ -0,0 +1,27 @@
+module Pith
+
+  module Observable
+
+    def add_observer(observer, signal = :update)
+      observer_map[observer] = signal
+    end
+
+    def remove_observer(observer)
+      observer_map.delete(observer)
+    end
+
+    def notify_observers
+      observer_map.each do |observer, signal|
+        observer.send(signal)
+      end
+    end
+
+    private
+
+    def observer_map
+      @observer_map ||= {}
+    end
+
+  end
+
+end

data/lib/pith/output.rb

@@ -45,32 +45,30 @@ module Pith
     def record_dependency_on(*inputs)
       inputs.each do |input|
         @dependencies << input
-        input.add_observer(self)
+        input.add_observer(self, :invalidate)
       end
     end
 
     def delete
       invalidate
-      logger.info("--X #{path}")
-      FileUtils.rm_f(file)
-    end
-
-    def update # called by dependencies that change
-      invalidate
+      if file.exist?
+        logger.info("--X #{path}")
+        FileUtils.rm_f(file)
+      end
     end
 
-    private
-
     def invalidate
       if @generated
         @dependencies.each do |d|
-          d.delete_observer(self)
+          d.remove_observer(self)
         end
         @dependencies = nil
         @generated = nil
       end
     end
 
+    private
+
     def copy_resource
       FileUtils.copy(input.file, file)
       record_dependency_on(input)
@@ -89,7 +87,7 @@ module Pith
           out.puts exception_summary(e)
         end
       end
-      record_dependency_on(*project.config_inputs)
+      record_dependency_on(project.config_provider)
     end
 
     def logger

data/lib/pith/pathname_ext.rb

@@ -7,12 +7,6 @@ class Pathname
     utime(mtime, mtime) if mtime
   end
 
-  def all_files(pattern = "**/*")
-    Pathname.glob(self + pattern, File::FNM_DOTMATCH).select do |path|
-      path.file?
-    end
-  end
-
   def in?(dir)
     prefix = "#{dir}/"
     self.to_s[0,prefix.length] == prefix

data/lib/pith/project.rb

@@ -1,4 +1,5 @@
 require "logger"
+require "pith/config_provider"
 require "pith/input"
 require "pith/pathname_ext"
 require "pith/reference_error"
@@ -9,37 +10,20 @@ module Pith
 
   class Project
 
-    DEFAULT_IGNORE_PATTERNS = ["_*", ".git", ".gitignore", ".svn", ".sass-cache", "*~", "*.sw[op]"].to_set.freeze
-
-    def initialize(attributes = {})
-      @ignore_patterns = DEFAULT_IGNORE_PATTERNS.dup
+    def initialize(input_dir, output_dir = nil, attributes = {})
+      @input_dir = Pathname(input_dir)
+      @output_dir = output_dir ? Pathname(output_dir) : (@input_dir + "_out")
+      @input_map = {}
+      @output_map = {}
       attributes.each do |k,v|
         send("#{k}=", v)
       end
+      FileUtils.rm_rf(output_dir.to_s)
     end
 
     attr_reader :input_dir
-    attr_reader :ignore_patterns
-
-    def input_dir=(dir)
-      @input_dir = Pathname(dir)
-    end
-
     attr_reader :output_dir
 
-    def output_dir=(dir)
-      @output_dir = Pathname(dir)
-      FileUtils.rm_rf(@output_dir)
-      @output_dir.mkpath
-    end
-
-    attr_accessor :assume_content_negotiation
-    attr_accessor :assume_directory_index
-
-    def ignore(pattern)
-      ignore_patterns << pattern
-    end
-
     # Public: get inputs
     #
     # Returns Pith::Input objects representing the files in the input_dir.
@@ -90,12 +74,8 @@ module Pith
     # Public: re-sync with the file-system.
     #
     def sync
-      @input_map ||= {}
-      @output_map ||= {}
-      @config_inputs = nil
-      load_config
-      validate_known_inputs
-      find_new_inputs
+      config_provider.sync
+      sync_input_files
     end
 
     def sync_every(period)
@@ -111,7 +91,7 @@ module Pith
     #
     # Returns true if any errors were encountered during the last build.
     def has_errors?
-      inputs.map(&:output).compact.any?(&:error)
+      outputs.any?(&:error)
     end
 
     def last_built_at
@@ -122,56 +102,59 @@ module Pith
       @logger ||= Logger.new(nil)
     end
 
-    attr_writer :logger
-
-    def helpers(&block)
-      helper_module.module_eval(&block)
+    def config_provider
+      @config_provider ||= Pith::ConfigProvider.new(self)
     end
 
-    def helper_module
-      @helper_module ||= Module.new
-    end
-
-    def config_inputs
-      @config_inputs ||= inputs.select do |input|
-        input.path.to_s[0,6] == "_pith/"
-      end
+    def config
+      config_provider.config
     end
 
     private
 
-    def load_config
-      config_file = input_dir + "_pith/config.rb"
-      project = self
-      if config_file.exist?
-        eval(config_file.read, binding, config_file.to_s, 1)
+    attr_writer :logger
+
+    def sync_input_files
+      @mtimes ||= {}
+      removed_file_paths = @mtimes.keys
+      Pathname.glob(input_dir + "**/*", File::FNM_DOTMATCH) do |file|
+        next unless file.file?
+        next if file.in?(output_dir)
+        mtime = file.mtime
+        path = file.relative_path_from(input_dir)
+        if @mtimes.has_key?(path)
+          if @mtimes[path] < mtime
+            when_file_modified(path)
+          end
+        else
+          when_file_added(path)
+        end
+        @mtimes[path] = mtime
+        removed_file_paths.delete(path)
+      end
+      removed_file_paths.each do |path|
+        when_file_removed(path)
       end
     end
 
-    def load_input(path)
+    def when_file_added(path)
       i = Input.new(self, path)
+      i.when_added
       @input_map[path] = i
       if o = i.output
         @output_map[o.path] = o
       end
-      i
     end
 
-    def validate_known_inputs
-      invalid_inputs = inputs.select { |i| !i.sync }
-      invalid_inputs.each do |i|
-        @input_map.delete(i.path)
-        if o = i.output
-          @output_map.delete(o.path)
-        end
-      end
+    def when_file_modified(path)
+      @input_map[path].when_modified
     end
 
-    def find_new_inputs
-      input_dir.all_files.map do |input_file|
-        next if input_file.in?(output_dir)
-        path = input_file.relative_path_from(input_dir)
-        input(path) || load_input(path)
+    def when_file_removed(path)
+      i = @input_map.delete(path)
+      i.when_removed
+      if o = i.output
+        @output_map.delete(o.path)
       end
     end
 

data/lib/pith/render_context.rb

@@ -15,7 +15,7 @@ module Pith
       @page = @output.input
       @project = @page.project
       @input_stack = []
-      self.extend(project.helper_module)
+      self.extend(project.config.helper_module)
     end
 
     attr_reader :output
@@ -55,8 +55,8 @@ module Pith
 
     def relative_url_to(target_path)
       url = target_path.relative_path_from(page.path.parent).to_s
-      url = url.sub(/index\.html$/, "") if project.assume_directory_index
-      url = url.sub(/\.html$/, "") if project.assume_content_negotiation
+      url = url.sub(/index\.html$/, "") if project.config.assume_directory_index
+      url = url.sub(/\.html$/, "") if project.config.assume_content_negotiation
       url = "./" if url.empty?
       Pathname(url)
     end

data/lib/pith/version.rb

@@ -1,3 +1,3 @@
 module Pith
-  VERSION = "0.3.0".freeze
+  VERSION = "0.3.1".freeze
 end

data/spec/pith/config_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'pith/config'
+
+describe Pith::Config do
+
+  let(:config) { Pith::Config.new }
+
+  describe "#ignore_patterns" do
+
+    it "is a set" do
+      config.ignore_patterns.should be_kind_of(Set)
+    end
+
+    it "includes some sensible defaults" do
+      config.ignore_patterns.should include("_*")
+      config.ignore_patterns.should include(".git")
+      config.ignore_patterns.should include(".svn")
+    end
+
+  end
+
+  describe "#ignore" do
+
+    it "adds to ignore_patterns" do
+      config.ignore("foo")
+      config.ignore_patterns
+    end
+
+  end
+
+end

data/spec/pith/input_spec.rb

@@ -5,7 +5,7 @@ require "pith/project"
 describe Pith::Input do
 
   before do
-    @project = Pith::Project.new(:input_dir => $input_dir)
+    @project = Pith::Project.new($input_dir)
   end
 
   def make_input(path)

data/spec/pith/project_spec.rb

@@ -4,7 +4,7 @@ require 'pith/project'
 describe Pith::Project do
 
   before do
-    @project = Pith::Project.new(:input_dir => $input_dir, :output_dir => $output_dir)
+    @project = Pith::Project.new($input_dir, $output_dir)
   end
 
   describe "#build" do
@@ -110,27 +110,4 @@ describe Pith::Project do
 
   end
 
-  describe "#ignore_patterns" do
-
-    it "is a set" do
-      @project.ignore_patterns.should be_kind_of(Set)
-    end
-
-    it "includes some sensible defaults" do
-      @project.ignore_patterns.should include("_*")
-      @project.ignore_patterns.should include(".git")
-      @project.ignore_patterns.should include(".svn")
-    end
-
-  end
-
-  describe "#ignore" do
-
-    it "adds to ignore_patterns" do
-      @project.ignore("foo")
-      @project.ignore_patterns
-    end
-
-  end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pith
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-29 00:00:00.000000000 Z
+date: 2012-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -85,11 +85,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/pith/config.rb
+- lib/pith/config_provider.rb
 - lib/pith/console_logger.rb
 - lib/pith/console_logger.rb~
 - lib/pith/input.rb
 - lib/pith/input.rb~
 - lib/pith/metadata.rb~
+- lib/pith/observable.rb
 - lib/pith/output.rb
 - lib/pith/pathname_ext.rb
 - lib/pith/pathname_ext.rb~
@@ -120,6 +123,7 @@ files:
 - sample/stylesheets/app.css.sass
 - README.markdown
 - Rakefile
+- spec/pith/config_spec.rb
 - spec/pith/input_spec.rb
 - spec/pith/pathname_ext_spec.rb
 - spec/pith/plugins/publication_spec.rb
@@ -176,7 +180,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -22568693852038165
+      hash: 1629984080237938528
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -185,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -22568693852038165
+      hash: 1629984080237938528
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.21
@@ -194,6 +198,7 @@ specification_version: 3
 summary: A static website generator
 test_files:
 - Rakefile
+- spec/pith/config_spec.rb
 - spec/pith/input_spec.rb
 - spec/pith/pathname_ext_spec.rb
 - spec/pith/plugins/publication_spec.rb