henshin 0.2.1 → 0.2.2

data/lib/henshin/site.rb

@@ -26,11 +26,9 @@ module Henshin
     
     ##
     # Read, process, render and write everything
-    #
-    # @todo Make it take an array as an arg so that only specific files are updated
-    def build( paths=[] )
+    def build
       self.reset
-      self.read( paths )
+      self.read
       self.process
       self.render
       self.write
@@ -39,27 +37,10 @@ module Henshin
     
     ##
     # Reads all necessary files and puts them into the necessary arrays
-    def read( paths=[] )
-      if paths == []
-        self.read_layouts
-        self.read_posts
-        self.read_others
-      else
-        paths.each do |path|
-          case determine_type( path )
-            when 'post'
-              @posts << Post.new(path, self)
-            when 'layout'
-              path =~ /([a-zA-Z0-9 _-]+)\.([a-zA-Z0-9-]+)/
-              @layouts[$1] = path
-            when 'gen'
-              @gens << Gen.new(path, self)
-            when 'static'
-              @statics << Static.new(path, self)
-          end
-        end
-
-      end
+    def read
+      self.read_layouts
+      self.read_posts
+      self.read_others
     end
     
     # Adds all items in 'layouts' to the layouts array
@@ -88,58 +69,24 @@ module Henshin
         items = items.select {|i| !i.include?( File.join(config[:root], r) )}
       end
       
-      ignored = ['/options.yaml'] + config[:exclude]
-      ignored.each do |r|
-        items -= [File.join(config[:root], r)]
-        items -= items.select {|i| i.include?( File.join(config[:root], r) )}
-      end
-      
-      items -= @posts.collect {|i| i.path}
-      items -= @layouts.collect {|k, v| v}
-      
-      gens = items.select {|i| config[:extensions].include?(i.extension) }
-      gens += items.select {|i| File.open(i, "r").read(3) == "---" }
-      
+      gens = items.select {|i| i.gen?(self.config)}
       gens.each do |g|
         @gens << Gen.new(g, self)
       end
       
-      
-      static = items - @gens.collect {|i| i.path}
+      static = items.select {|i| i.static?(self.config)}
       static.each do |s|
         @statics << Static.new(s, self)
       end
+
     end
-    
-    # Determines whether the file at the path is a post, layout, gen or static
-    #
-    # @param [Array]
-    # @return [String]
-    def determine_type( path )
-      ignored = ['/options.yaml'] + config[:exclude]
-      ignored.collect! {|i| File.join(config[:root], i)}
-      if ignored.include? path
-        return "ignored"
-      end
-      
-      if path.include? File.join(config[:root], 'layouts')
-        return "layout"
-      elsif path.include? File.join(config[:root], 'posts')
-        return "post"
-      elsif config[:extensions].include? path.extension
-        return "gen"
-      elsif File.open(path, "r").read(3) == "---"
-        return "gen"
-      else
-        return "static"
-      end
-    end
-    
+
     
     ## 
     # Processes all of the necessary files
     def process
       @posts.each_parallel {|p| p.process}
+      @posts.sort!
       @gens.each_parallel {|g| g.process}
       
       self.build_tags

data/lib/henshin.rb

@@ -47,17 +47,32 @@ module Henshin
     rescue => e
       $stderr.puts "\nCould not read configuration, falling back to defaults..."
       $stderr.puts "-> #{e.to_s}"
-      settings = Defaults
+      settings = Defaults.merge(override)
     end
     
+    
+    
+    # find the options for plugins, if any
     settings.each do |k, v|
       if settings[:plugins].include? k.to_s
         settings[:plugin_options][k] = v.to_options
       end
     end
     
-    settings[:plugins] = Henshin.load_plugins( settings[:plugins], settings[:root], settings[:plugin_options] )
-    settings[:extensions] = Henshin.extensions( settings[:plugins] )
+    loaded_plugins = Henshin.load_plugins( settings[:plugins], settings[:root], settings[:plugin_options] )
+    
+    settings[:plugins] = {:generators => {}, :layout_parsers => []}
+    loaded_plugins.each do |plugin|
+      if plugin.is_a? Generator
+        plugin.extensions[:input].each do |ext|
+          settings[:plugins][:generators][ext] = plugin
+        end
+      end
+      if plugin.is_a? LayoutParser
+        settings[:plugins][:layout_parsers] << plugin
+      end
+    end
+    
     settings
   end
   
@@ -66,7 +81,7 @@ module Henshin
   #
   # @param [Array] plugins list of plugins to load
   # @return [Array] list of loaded plugin instances
-  def self.load_plugins( to_load, root, options )
+  def self.load_plugins( to_load, root, opts={} )  
     plugins = []
     to_load.each do |l|
       begin
@@ -75,6 +90,13 @@ module Henshin
         require File.join(root, 'plugins/', l)
       end
     end
+    
+    # pass options to the plugins
+    @registered_plugins.each do |plugin|
+      if plugin.respond_to? :configure
+        plugin.configure( opts[plugin.opts_name] )
+      end
+    end
     @registered_plugins
   end
   
@@ -84,21 +106,6 @@ module Henshin
     @registered_plugins << plug.new
   end
   
-  
-  # Lists the file extensions the currently loaded plugins use
-  #
-  # @param [Array] plugins array of loaded plugin instances
-  # @return [Array] a list of file extensions
-  def self.extensions( plugins )
-    extensions = []
-    plugins.each do |i|
-      if i.extensions[:input] != []
-        extensions << i.extensions[:input]
-      end
-    end
-    extensions.flatten!
-  end
-  
 
   # @return [String] current version
   def self.version

data/test/helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
+require 'rr'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -8,6 +9,8 @@ require 'henshin'
 
 class Test::Unit::TestCase
 
+  include RR::Adapters::TestUnit
+  
   def root_dir
     File.join(File.dirname(__FILE__), 'site')
   end
@@ -21,7 +24,7 @@ class Test::Unit::TestCase
   end
   
   def new_site
-    override = {:root => File.join(File.dirname(__FILE__), 'site'),:target => '_site'}
+    override = {:root => File.join(File.dirname(__FILE__), 'site'), :target => '_site'}
     config = Henshin.configure(override)
     Henshin::Site.new(config)
   end

data/test/site/_site/2010/10/20-testing-stuff/index.html

@@ -15,13 +15,13 @@
       
         <li>test</li>
       
-        <li>nolorem</li>
+        <li>markdown</li>
       
     </ul>
     
   </header>
   
-  <p>So Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
+  <p>So Lorem ipsum dolor <em>sit amet</em>, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim <strong>ad minim</strong> veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
   
   <span>Copyright &copy; Joshua Hawxwell</span>
   </body>  

data/test/site/_site/css/print.css

@@ -1,33 +1,19 @@
-body, div, dl, dt, dd, ul, ol, li, h1, h2, h3, h4, h5, h6, pre, form, fieldset, input, textarea, p, blockquote, th, td {
-  margin: 0;
-  padding: 0; }
+body, div, dl, dt, dd, ul, ol, li, h1, h2, h3, h4, h5, h6, pre, form, fieldset, input, textarea, p, blockquote, th, td { margin: 0; padding: 0; }
 
-table {
-  border-collapse: collapse;
-  border-spacing: 0; }
+table { border-collapse: collapse; border-spacing: 0; }
 
-fieldset, img {
-  border: 0; }
+fieldset, img { border: 0; }
 
-address, caption, cite, code, dfn, em, strong, th, var {
-  font-style: normal;
-  font-weight: normal; }
+address, caption, cite, code, dfn, em, strong, th, var { font-style: normal; font-weight: normal; }
 
-ol, ul {
-  list-style: none; }
+ol, ul { list-style: none; }
 
-caption, th {
-  text-align: left; }
+caption, th { text-align: left; }
 
-h1, h2, h3, h4, h5, h6 {
-  font-size: 100%;
-  font-weight: normal; }
+h1, h2, h3, h4, h5, h6 { font-size: 100%; font-weight: normal; }
 
-q:before, q:after {
-  content: ”; }
+q:before, q:after { content: ”; }
 
-abbr, acronym {
-  border: 0; }
+abbr, acronym { border: 0; }
 
-h1 {
-  font-size: 2em; }
+h1 { font-size: 2em; }

data/test/site/_site/index.html

@@ -8,7 +8,7 @@
   <body>
   
     <header>
-	<h1>Joshua Hawxwell</h1>
+	<h1>Home Page</h1>
 </header>
 
 <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
@@ -21,11 +21,15 @@
     <h2>A List of Posts</h2>
     <ul>
       
-        <li><a href="/2010/5/27-test/index.html">Test</a> - 2010-05-27 18:54:02 +0100</li>
+        <li><a href="/2010/10/20-testing-stuff/">Testing Stuff</a> - 2010-10-20 17:33:23 +0100</li>
       
-        <li><a href="/2010/5/15-lorem-ipsum/index.html">Lorem Ipsum</a> - 2010-05-15 13:23:47 +0100</li>
+        <li><a href="/2010/5/15-lorem-ipsum/">Lorem Ipsum</a> - 2010-05-15 13:23:47 +0100</li>
       
-        <li><a href="/2010/10/20-testing-stuff/index.html">Testing Stuff</a> - 2010-10-20 17:33:23 +0100</li>
+        <li><a href="/2010/5/15-same-date-as-lorem-ipsum/">Same Date as "Lorem Ipsum"</a> - 2010-05-15 13:23:47 +0100</li>
+      
+        <li><a href="/2009/11/9-textile-test/">Textile Test</a> - 2009-11-09 13:23:47 +0000</li>
+      
+        <li><a href="/2009/2/27-test/">Test</a> - 2009-02-27 18:54:02 +0000</li>
       
     </ul>
     
@@ -36,8 +40,21 @@
           test
           <ul>
           
+            <li>Testing Stuff - 2010-10-20 17:33:23 +0100</li>
+          
             <li>Lorem Ipsum - 2010-05-15 13:23:47 +0100</li>
           
+            <li>Same Date as "Lorem Ipsum" - 2010-05-15 13:23:47 +0100</li>
+          
+            <li>Textile Test - 2009-11-09 13:23:47 +0000</li>
+          
+          </ul>
+        </li>
+      
+        <li>
+          markdown
+          <ul>
+          
             <li>Testing Stuff - 2010-10-20 17:33:23 +0100</li>
           
           </ul>
@@ -49,14 +66,16 @@
           
             <li>Lorem Ipsum - 2010-05-15 13:23:47 +0100</li>
           
+            <li>Same Date as "Lorem Ipsum" - 2010-05-15 13:23:47 +0100</li>
+          
           </ul>
         </li>
       
         <li>
-          nolorem
+          plugin
           <ul>
           
-            <li>Testing Stuff - 2010-10-20 17:33:23 +0100</li>
+            <li>Textile Test - 2009-11-09 13:23:47 +0000</li>
           
           </ul>
         </li>
@@ -66,17 +85,17 @@
     <h2>A List of Categories</h2>
     <ul>
       
-        <li>cat</li>
+        <li>test</li>
         <ul>
         
-          <li>Test - 2010-05-27 18:54:02 +0100</li>
+          <li>Testing Stuff - 2010-10-20 17:33:23 +0100</li>
         
         </ul>
       
-        <li>test</li>
+        <li>cat</li>
         <ul>
         
-          <li>Testing Stuff - 2010-10-20 17:33:23 +0100</li>
+          <li>Test - 2009-02-27 18:54:02 +0000</li>
         
         </ul>
       

data/test/site/index.html

@@ -1,12 +1,11 @@
 ---
 layout: main
-title: Joshua Hawxwell
-date: 2009-10-07T17:17:45+00:00
+title: Home Page
 ---
 
 
 <header>
-	<h1>Joshua Hawxwell</h1>
+	<h1>Home Page</h1>
 </header>
 
 <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>

data/test/site/options.yaml

@@ -5,10 +5,10 @@ author: Joshua Hawxwell
 
 layout: post
 
-exclude: [/css]
+exclude: []
 post_name: '{title-with-dashes}.{extension}'
 permalink: '/{year}/{month}/{date}-{title}/index.html'
-plugins: [maruku, sass, pygments, liquid, test]
+plugins: [maruku, sass, pygments, liquid, test, textile]
 
 sass: 
   style: :compact

data/test/site/posts/Testing-Stuff.markdown

@@ -1,8 +1,8 @@
 ---
 title: Testing Stuff
 date: 2010-10-20 at 17:33:23
-tags: test, nolorem
+tags: test, markdown
 category: test
 ---
 
-So Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.  
+So Lorem ipsum dolor *sit amet*, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim __ad minim__ veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.  

data/test/site/posts/Textile-Test.textile

@@ -0,0 +1,7 @@
+---
+title: Textile Test
+date: 2009-11-09 at 13:23:47
+tags: test, plugin
+---
+
+So Lorem ipsum dolor sit _amet, consectetur_ adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris *nisi ut aliquip* ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.  

data/test/site/posts/cat/test.markdown

@@ -1,6 +1,6 @@
 ---
 title: Test
-date: 2010-05-27 at 18:54:02
+date: 2009-02-27 at 18:54:02
 ---
 
 This should be put into the correct category, in this case 'cat'. But maybe it won't. That would be interesting.

data/test/site/posts/same-date.markdown

@@ -0,0 +1,7 @@
+---
+title: Same Date as "Lorem Ipsum"
+date: 2010-05-15 at 13:23:47
+tags: test, lorem
+---
+
+So Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.  

data/test/test_gens.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__) ,'helper')
+
+class TestGens < Test::Unit::TestCase
+  context "A gen" do
+    
+    setup do
+      @site = new_site
+      @gen = Henshin::Gen.new( "#{root_dir}/index.html", @site )
+      remove_site
+    end
+    
+    should "read frontmatter" do
+      @site.read_layouts
+      @gen.read_yaml
+      assert_equal @gen.title, 'Home Page'
+      assert_equal @gen.layout, "#{root_dir}/layouts/main.html"
+    end
+    
+    should "have the correct permalink" do
+      @gen.read_yaml
+      assert_equal @gen.permalink, '/index.html'
+      assert_equal @gen.url, '/'
+    end
+    
+    should "allow a hash to be added to the payload" do
+      payload = { :name => 'people', :payload => {'fname' => 'John', 'sname' => 'Doe'} }
+      gen = Henshin::Gen.new( "#{root_dir}/index.html", @site, payload )
+      gen.read_yaml
+      assert_equal gen.payload['people'], payload[:payload]
+    end
+    
+  end
+end

data/test/test_henshin.rb

@@ -1,28 +1,5 @@
 require File.join(File.dirname(__FILE__) ,'helper')
 
-class TestHenshin < Test::Unit::TestCase
-  context "Building sites" do
-  
-    setup do
-      @site = new_site
-    end
-    
-    should "reset all data before anything else" do
-      remove_site
-      @site.reset
-      
-      assert_equal @site.posts.length, 0
-      assert_equal @site.gens.length, 0
-      assert_equal @site.statics.length, 0
-      assert_equal @site.archive.length, 0
-      assert_equal @site.tags.length, 0
-      assert_equal @site.categories.length, 0
-      assert_equal @site.layouts.length, 0
-    end
-
-  end
-end
-
-
 test_files = Dir.glob( File.join(File.dirname(__FILE__), "test_*.rb") )
+test_files -= [File.join(File.dirname(__FILE__), 'test_henshin.rb')] # don't include self!
 test_files.each {|f| require f }

data/test/test_layouts.rb

@@ -8,11 +8,7 @@ class TestLayouts < Test::Unit::TestCase
       remove_site
     end
     
-    should "read layouts" do
-      @site.read_layouts
-      l = Dir.glob( File.join(root_dir, 'layouts', '*.*') )
-      assert_equal l.size, @site.layouts.size
-    end
+    
   
   end
 end

data/test/test_options.rb

@@ -1,27 +1,56 @@
 require File.join(File.dirname(__FILE__) ,'helper')
 
+# Need to remember to remove loaded plugins from the returned
+# config when comparing against Defaults!
 class TestOptions < Test::Unit::TestCase
   context "Loading and setting options" do
     
     setup do
-      @opts = File.join(root_dir, 'options.yaml')
+      @opts = './options.yaml'
     end
     
     should "warn of invalid options.yaml" do
-    
+      mock(YAML).load_file(@opts) {"boo"}
+      mock($stderr).puts("\nCould not read configuration, falling back to defaults...")
+      mock($stderr).puts("-> undefined method `to_options' for \"boo\":String")
+      
+      configured = Henshin.configure
+      configured[:plugins] = ["maruku", "liquid"]
+      assert_equal Henshin::Defaults, configured
     end
     
     should "warn of no options.yaml" do
-    
+      mock(YAML).load_file(@opts) { raise "No such file or directory - #{@opts}" }
+      mock($stderr).puts("\nCould not read configuration, falling back to defaults...")
+      mock($stderr).puts("-> No such file or directory - #{@opts}")
+      
+      configured = Henshin.configure
+      configured[:plugins] = ["maruku", "liquid"]
+      assert_equal Henshin::Defaults, configured
     end
-    
+
     should "use defaults if no options.yaml" do
-      assert_equal Henshin::Defaults, Henshin.configure
+      mock($stderr).puts("\nCould not read configuration, falling back to defaults...")
+      mock($stderr).puts("-> No such file or directory - #{@opts}")
+    
+      configured = Henshin.configure
+      configured[:plugins] = ["maruku", "liquid"]
+      assert_equal Henshin::Defaults, configured
     end
     
-    should "load options and merge with defaults" do
+    should "merge override with defaults" do
+      mock($stderr).puts("\nCould not read configuration, falling back to defaults...")
+      mock($stderr).puts("-> No such file or directory - #{@opts}")
+    
+      override = {:time_zone => '+01:00'}
+      configured = Henshin.configure(override)
+      assert_equal configured[:time_zone], '+01:00'
+    end
     
+    should "load plugins" do    
+      loaded = Henshin.load_plugins( ['maruku'], '.', {} )
+      assert loaded[0].is_a? MarukuPlugin
     end
-  
+
   end
 end

data/test/test_posts.rb

@@ -8,10 +8,31 @@ class TestPosts < Test::Unit::TestCase
       remove_site
     end
     
-    should "read posts" do
-      @site.read_posts
-      p = Dir.glob( File.join(root_dir, 'posts', '**', '*.*') )
-      assert_equal p.size, @site.posts.size
+    should "get data from the filename" do
+      post_file = "#{root_dir}/posts/2010-08-10-lorem-ipsum.markdown"
+      site = @site
+      site.config[:file_name] = "{date}-{title-with-dashes}.{extension}"
+      post = Henshin::Post.new( post_file, site )
+      post.read_name
+      assert_equal post.title, 'lorem ipsum'
+      assert_equal post.date, Time.parse('2010-08-10')
+      assert_equal post.extension, 'markdown'
+    end
+    
+    should "read frontmatter" do
+      post_file = "#{root_dir}/posts/lorem-ipsum.markdown"
+      post = Henshin::Post.new( post_file, @site )
+      post.read_yaml
+      assert_equal post.title, 'Lorem Ipsum'
+      assert_equal post.date, Time.parse('2010-05-15 at 13:23:47')
+      assert_equal post.tags, ['test', 'lorem']
+    end
+    
+    should "have the correct permalink" do
+      post_file = "#{root_dir}/posts/lorem-ipsum.markdown"
+      post = Henshin::Post.new( post_file, @site )
+      post.process
+      assert_equal post.permalink, "/2010/5/15-lorem-ipsum/index.html"
     end
     
   end

data/test/test_site.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__) ,'helper')
+
+class TestSite < Test::Unit::TestCase
+  context "Building sites" do
+  
+    setup do
+      @site = new_site
+    end
+    
+    should "reset all data before anything else" do
+      remove_site
+      @site.reset
+      
+      assert_equal @site.posts.length, 0
+      assert_equal @site.gens.length, 0
+      assert_equal @site.statics.length, 0
+      assert_equal @site.archive.length, 0
+      assert_equal @site.tags.length, 0
+      assert_equal @site.categories.length, 0
+      assert_equal @site.layouts.length, 0
+    end
+    
+    should "read posts" do
+      @site.read_posts
+      p = Dir.glob( File.join(root_dir, 'posts', '**', '*.*') )
+      assert_equal p.size, @site.posts.size
+    end
+    
+    should "read layouts" do
+      @site.read_layouts
+      l = Dir.glob( File.join(root_dir, 'layouts', '*.*') )
+      assert_equal l.size, @site.layouts.size
+    end
+
+  end
+end