pith 0.3.4 → 0.4.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mike Williams <mdub@dogbiscuit.org>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -1,4 +1,4 @@
-Pith
+Pith [![Build Status](https://secure.travis-ci.org/mdub/pith.png?branch=master)](http://travis-ci.org/mdub/pith)
 ====
 
 Pith is a static website generator, written in Ruby.
@@ -159,7 +159,7 @@ Any path beginning with a slash ("/") is resolved relative to the root of the si
 There's also a "`link`" function, for even easier hyper-linking:
 
     link("other.html", "Other page")
-    
+
 Configuring Pith
 ----------------
 
@@ -214,6 +214,8 @@ For even quicker prototyping, Pith includes a simple HTTP server.  Start it by u
 
 Pith will incrementally re-build the site as you browse -- that is, if you alter any input files, Pith will regenerate the affected outputs.
 
+Add the "`--live`" option to "`serve`" to enable [Live.js][livejs]), for live-reloading of HTML, CSS and Javascript.
+
 Plugins
 -------
 
@@ -221,7 +223,7 @@ Pith includes a couple of optional "plugins".  Actually, "plugin" is a bit stron
 
 ### Publication plugin
 
-The 'publication' plugin makes it easier to build a weblog using Pith.  
+The 'publication' plugin makes it easier to build a weblog using Pith.
 
 Enable it by requiring it in your "`config.rb`", like so:
 
@@ -229,12 +231,12 @@ Enable it by requiring it in your "`config.rb`", like so:
 
 Now you can specify a "published" date/time in the metadata of any pages you consider to be "articles", e.g.
 
-    --- 
+    ---
     title: Introducing ShamRack
     published: 3-July-2009, 15:50
     ...
 
-This exposes "`page.published_at`" for use in your templates.  
+This exposes "`page.published_at`" for use in your templates.
 
 In addition, "`project.published_inputs`" lists all the pages that have such a timestamp, in order of publication, making it easy to build index pages and XML feeds.  Here's a example, used to build the article index for [dogbiscuit.org](http://dogbiscuit.org/mdub/weblog):
 
@@ -255,11 +257,11 @@ The Compass plugin gives you the full power of [Compass][compass] in your Sass s
     require "pith/plugins/compass"
 
 Note that if you're using Bundler, you'll also need to include the Compass gem in your `Gemfile`.
-    
+
     gem "compass"
 
 [tilt]: http://github.com/rtomayko/tilt/
 [haml]: http://haml-lang.com
 [sass]: http://sass-lang.com
 [compass]: http://compass-style.org
-
+[livejs]: http://livejs.com

data/bin/pith

@@ -47,9 +47,13 @@ class PithCommand < Clamp::Command
   end
 
   subcommand "serve", "Serve the generated website" do
+
+    option ["-L", "--live"], :flag, "automatically reload changes"
+
     def execute
-      serve
+      serve(:auto_reload => live?)
     end
+
   end
 
   protected
@@ -83,9 +87,11 @@ class PithCommand < Clamp::Command
     Pith::Watcher.new(project, :interval => interval).call
   end
 
-  def serve
+  def serve(options = {})
     require "pith/server"
-    server = Pith::Server.new(project)
+    project.sync
+    project.listen_for_changes
+    server = Pith::Server.new(project, options)
     puts %{>>> Now taking the Pith at "http://localhost:#{port}"}
     Rack::Handler.get("thin").run(server, :Port => port)
   end

data/features/cleanup.feature

@@ -5,10 +5,18 @@ Feature: automatic cleanup
 
 Scenario: output without matching input
 
+  Given output file "blah.txt" exists
+
+  When I build the site
+
+  Then output file "blah.txt" should not exist
+
+Scenario: input removed
+
   Given input file "blah.txt" exists
-  
+
   When I build the site
   And I remove input file "blah.txt"
   And I rebuild the site
-  
+
   Then output file "blah.txt" should not exist

data/features/incremental_rebuild.feature

@@ -70,3 +70,34 @@ Scenario: delete a dependency
     <p>banana</p>
     """
 
+Scenario: alter meta-data
+
+  Given input file "index.html.haml" contains
+    """
+    - project.inputs.select do |input|
+      - output.record_dependency_on(input)
+      - if input.meta["flavour"]
+        %p= input.meta["flavour"]
+    """
+
+  And input file "page.html.haml" contains
+    """
+    ---
+    flavour: Chocolate
+    ---
+    """
+
+  When I build the site
+  Then output file "index.html" should contain "<p>Chocolate</p>"
+
+  When I change input file "page.html.haml" to contain
+    """
+    ---
+    flavour: Strawberry
+    ---
+    """
+
+  And I rebuild the site
+
+  Then output file "index.html" should be re-generated
+  Then output file "index.html" should contain "<p>Strawberry</p>"

data/features/link_attributes.feature

@@ -0,0 +1,37 @@
+Feature: link method with attributes
+
+  I want to be able to pass arguments to the link method
+  So that additional attributes are generated
+
+Scenario: link with class attribute
+
+  Given input file "index.html.haml" contains
+    """
+    = link("page.html", "Page", :class => 'active')
+    """
+  And input file "page.html" exists
+
+  When I build the site
+  Then output file "index.html" should contain /<a [class="active", href="page.html"]/
+
+Scenario: link with title attribute
+
+  Given input file "index.html.haml" contains
+    """
+    = link("page.html", "Page", :title => 'click me')
+    """
+  And input file "page.html" exists
+
+  When I build the site
+  Then output file "index.html" should contain /<a [title="click me", href="page.html"]/
+
+Scenario: link with title and class attributes
+
+  Given input file "index.html.haml" contains
+    """
+    = link("page.html", "Page", :title => 'click me', :class => 'active')
+    """
+  And input file "page.html" exists
+
+  When I build the site
+  Then output file "index.html" should contain /<a [title="click me", class="active", href="page.html"]/

data/features/relative_linking.feature

@@ -31,6 +31,32 @@ Scenario: link from a sub-directory to a root-level page
     <a href="../help.html">Help</a>
     """
 
+Scenario: link to an absolute url
+
+  Given input file "index.html.haml" contains
+    """
+    = link("http://example.com", "Go to example.com")
+    """
+
+  When I build the site
+  Then output file "index.html" should contain
+    """
+    <a href="http://example.com">Go to example.com</a>
+    """
+
+Scenario: link to a (secure) absolute url
+
+  Given input file "index.html.haml" contains
+    """
+    = link("https://example.com", "Securely go to example.com")
+    """
+
+  When I build the site
+  Then output file "index.html" should contain
+    """
+    <a href="https://example.com">Securely go to example.com</a>
+    """
+
 Scenario: link to an image
 
   Given input file "subdir/page.html.haml" contains

data/features/step_definitions/build_steps.rb

@@ -10,6 +10,10 @@ Given /^input file "([^\"]*)" exists$/ do |path|
   step %{input file "#{path}" contains "something"}
 end
 
+Given /^output file "([^\"]*)" exists$/ do |path|
+  @outputs.write(path, "something", :mtime => (Time.now - 4))
+end
+
 Given "the site is up-to-date" do
   step "I build the site"
 end

data/lib/pith/config.rb

@@ -16,8 +16,8 @@ module Pith
 
     attr_reader :ignore_patterns
 
-    def ignore(pattern)
-      ignore_patterns << pattern
+    def ignore(*pattern)
+      pattern.flatten.each {|p| ignore_patterns << p }
     end
 
     attr_reader :helper_module

data/lib/pith/input.rb

@@ -188,7 +188,7 @@ module Pith
       end
     end
 
-    YamlParseError = defined?(Psych) ? Psych::SyntaxError : ArgumentError
+    YamlParseError = defined?(Psych::SyntaxError) ? Psych::SyntaxError : ArgumentError
 
     def read_meta(io)
       header = io.gets
@@ -212,6 +212,7 @@ module Pith
     def unload
       logger.debug "unloading #{path}"
       @load_time = nil
+      @meta = nil
     end
 
     def logger

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

@@ -12,17 +12,19 @@ module Pith
         end
 
         def published_at
-          parse_date(meta["published"])
+          parse_timestamp(meta["published"])
         end
 
         def updated_at
-          parse_date(meta["updated"]) || published_at
+          parse_timestamp(meta["updated"]) || published_at
         end
 
         private
 
-        def parse_date(date_string)
-          Time.parse(date_string) if date_string
+        def parse_timestamp(arg)
+          return unless arg
+          return arg.to_time if arg.respond_to?(:to_time)
+          Time.parse(arg.to_s)
         end
 
       end

data/lib/pith/project.rb

@@ -1,3 +1,4 @@
+require "listen"
 require "logger"
 require "pith/config_provider"
 require "pith/input"
@@ -5,6 +6,7 @@ require "pith/pathname_ext"
 require "pith/reference_error"
 require "set"
 require "tilt"
+require "thread"
 
 module Pith
 
@@ -13,12 +15,15 @@ module Pith
     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 = {}
+      @logger = Logger.new(nil)
       attributes.each do |k,v|
         send("#{k}=", v)
       end
-      FileUtils.rm_rf(output_dir.to_s)
+      @input_map = {}
+      @output_map = {}
+      @mtimes ||= {}
+      @config_provider ||= Pith::ConfigProvider.new(self)
+      @mutex = Mutex.new
     end
 
     attr_reader :input_dir
@@ -74,16 +79,18 @@ module Pith
     # Public: re-sync with the file-system.
     #
     def sync
-      config_provider.sync
-      sync_input_files
+      @mutex.synchronize do
+        config_provider.sync
+        sync_input_files
+        cleanup_output_files
+      end
     end
 
-    def sync_every(period)
-      @next_sync ||= 0
-      now = Time.now.to_i
-      if now >= @next_sync
+    # Public: start a Thread to automatically sync when inputs change.
+    #
+    def listen_for_changes
+      Listen.to(input_dir.to_s) do
         sync
-        @next_sync = now + period
       end
     end
 
@@ -98,13 +105,8 @@ module Pith
       output_dir.mtime
     end
 
-    def logger
-      @logger ||= Logger.new(nil)
-    end
-
-    def config_provider
-      @config_provider ||= Pith::ConfigProvider.new(self)
-    end
+    attr_reader :logger
+    attr_reader :config_provider
 
     def config
       config_provider.config
@@ -115,7 +117,6 @@ module Pith
     attr_writer :logger
 
     def sync_input_files
-      @mtimes ||= {}
       removed_paths = @mtimes.keys
       Pathname.glob(input_dir + "**/*", File::FNM_DOTMATCH) do |file|
         next unless file.file?
@@ -138,6 +139,17 @@ module Pith
       end
     end
 
+    def cleanup_output_files
+      Pathname.glob(output_dir + "**/*", File::FNM_DOTMATCH) do |file|
+        next unless file.file?
+        path = file.relative_path_from(output_dir)
+        unless output(path)
+          logger.info "XXX #{path}"
+          FileUtils.rm_f(file)
+        end
+      end
+    end
+
     def file_added(path)
       i = Input.new(self, path)
       i.when_added

data/lib/pith/render_context.rb

@@ -32,9 +32,9 @@ module Pith
 
     def render(input, locals = {}, &block)
       with_input(input) do
-        result = input.render(self, locals, &block)
+        result     = input.render(self, locals, &block)
         layout_ref = input.meta["layout"]
-        result = render_ref(layout_ref) { result } if layout_ref
+        result     = render_ref(layout_ref) { result } if layout_ref
         result
       end
     end
@@ -65,21 +65,36 @@ module Pith
       relative_url_to(resolve_reference(target_ref))
     end
 
-    def link(target_ref, label = nil)
-      target_path = resolve_reference(target_ref)
-      label ||= begin
-        target_input = input(target_path)
-        output.record_dependency_on(target_input)
-        target_input.title
-      rescue ReferenceError
-        "???"
+    def link(target_ref, label = nil, attrs={})
+      if absolute_url?(target_ref)
+        attrs['href'] = target_ref
+      else
+        target_path = resolve_reference(target_ref)
+        attrs['href'] = relative_url_to(target_path)
+        label ||= begin
+          target_input = input(target_path)
+          output.record_dependency_on(target_input)
+          target_input.title
+        rescue ReferenceError
+          "???"
+        end
       end
-      url = relative_url_to(target_path)
-      %{<a href="#{url}">#{label}</a>}
+
+      # Loop through attrs hash, flatten the key, value
+      # pairs for appending to the dom element/link
+      attrs_flatten = attrs.each_pair.collect do |key, value|
+                        %Q{#{key}="#{value}"}
+                      end.join(' ')
+
+      "<a #{attrs_flatten}>#{label}</a>"
     end
 
     private
 
+    def absolute_url?(ref)
+      ref.respond_to?(:to_str) && ref.to_str =~ %r{^\w+:/}
+    end
+
     def resolve_reference(ref)
       if ref.kind_of?(Pith::Input)
         raise(ReferenceError, %{No output for "#{ref.path}"}) if ref.output.nil?

data/lib/pith/server.rb

@@ -1,16 +1,16 @@
-require "rack"
 require "pathname"
-require "thread"
+require "rack"
+require "rack/livejs"
 
 module Pith
 
   module Server
 
-    def new(project)
+    def new(project, options = {})
       Rack::Builder.new do
-        use Rack::CommonLogger
         use Rack::ShowExceptions
         use Rack::Lint
+        use Rack::Livejs if options[:auto_reload]
         use Pith::Server::OutputFinder, project
         run Rack::Directory.new(project.output_dir)
       end
@@ -27,8 +27,6 @@ module Pith
 
       def call(env)
 
-        @project.sync_every(1)
-
         path_info = ::Rack::Utils.unescape(env["PATH_INFO"])
         ends_with_slash = (path_info[-1] == '/')
 

data/lib/pith/version.rb

@@ -1,3 +1,3 @@
 module Pith
-  VERSION = "0.3.4".freeze
+  VERSION = "0.4.0".freeze
 end

data/spec/pith/config_spec.rb

@@ -23,7 +23,19 @@ describe Pith::Config do
 
     it "adds to ignore_patterns" do
       config.ignore("foo")
-      config.ignore_patterns
+      config.ignore_patterns.should be_member('foo')
+    end
+
+    it "adds multiple patterns to ignore_patterns (when passed multiple arguments)" do
+      config.ignore("foo", "bar")
+      config.ignore_patterns.should be_member('foo')
+      config.ignore_patterns.should be_member('bar')
+    end
+
+    it "adds multiple patterns to ignore_patterns (when passed an array)" do
+      config.ignore(["foo", "bar"])
+      config.ignore_patterns.should be_member('foo')
+      config.ignore_patterns.should be_member('bar')
     end
 
   end

data/spec/pith/plugins/publication_spec.rb

@@ -19,6 +19,16 @@ describe Pith::Plugins::Publication::TemplateMethods do
       @template.published_at.should == Time.local(1999, 12, 25, 22, 30)
     end
 
+    it "honours any parsing (of Time) that yaml may do on the 'published' meta-field" do
+      @template.meta["published"] = Time.local(1999, 12, 25, 22, 30)
+      @template.published_at.should == Time.local(1999, 12, 25, 22, 30)
+    end
+
+    it "honours any parsing (to Date) of time that yaml may do on the 'published' meta-field" do
+      @template.meta["published"] = Date.new(1999, 12, 25)
+      @template.published_at.should == Time.local(1999, 12, 25)
+    end
+
   end
 
   describe "#updated_at" do
@@ -30,9 +40,14 @@ describe Pith::Plugins::Publication::TemplateMethods do
     
     it "can be overridden with an 'updated' meta-field" do
       @template.meta["published"] = "25 Dec 1999 22:30"
-      @template.meta["published"] = "1 Jan 2000 03:00"
+      @template.meta["updated"] = "1 Jan 2000 03:00"
       @template.updated_at.should == Time.local(2000, 1, 1, 3, 0)
     end
+    
+    it "honours any parsing of time that yaml may do on the 'updated' meta-field" do
+      @template.meta["updated"] = Date.new(2000, 1, 1)
+      @template.updated_at.should == Time.local(2000, 1, 1)
+    end
 
   end
   

data/spec/pith/server_spec.rb

@@ -8,7 +8,7 @@ describe Pith::Server::OutputFinder do
   let(:output) { stub(:path => Pathname(output_path), :build => true) }
 
   let(:project) do
-    stub(:outputs => [output], :sync_every => nil)
+    stub(:outputs => [output])
   end
 
   let(:app) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pith
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-18 00:00:00.000000000 Z
+date: 2014-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
@@ -75,6 +75,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rack-livejs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 description: ! 'Pith builds static websites, using markup/template languages including
   Haml, Sass, ERb, Liquid, Markdown and Textile.
 
@@ -123,6 +155,7 @@ files:
 - sample/index.html.haml
 - sample/stylesheets/app.css.sass
 - README.markdown
+- LICENSE
 - Rakefile
 - spec/pith/config_spec.rb
 - spec/pith/input_spec.rb
@@ -148,6 +181,7 @@ files:
 - features/incremental_rebuild.feature~
 - features/layouts.feature
 - features/layouts.feature~
+- features/link_attributes.feature
 - features/linking.feature~
 - features/markdown.feature
 - features/metadata.feature
@@ -168,7 +202,8 @@ files:
 - cucumber.yml
 - bin/pith
 homepage: http://github.com/mdub/pith
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -181,7 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -677330549993554291
+      hash: -2482242163062205897
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -190,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -677330549993554291
+      hash: -2482242163062205897
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -223,6 +258,7 @@ test_files:
 - features/incremental_rebuild.feature~
 - features/layouts.feature
 - features/layouts.feature~
+- features/link_attributes.feature
 - features/linking.feature~
 - features/markdown.feature
 - features/metadata.feature