henshin 0.2.0 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/henshin.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{henshin}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["hawx"]
-  s.date = %q{2010-05-30}
+  s.date = %q{2010-05-31}
   s.default_executable = %q{henshin}
   s.description = %q{Henshin is a static site generator, with a plugin system and more}
   s.email = %q{m@hawx.me}
@@ -60,7 +60,11 @@ Gem::Specification.new do |s|
      "test/site/posts/lorem-ipsum.markdown",
      "test/site/sass/print.sass",
      "test/site/static.html",
-     "test/test_henshin.rb"
+     "test/test_henshin.rb",
+     "test/test_layouts.rb",
+     "test/test_options.rb",
+     "test/test_posts.rb",
+     "test/test_site.rb"
   ]
   s.homepage = %q{http://github.com/hawx/henshin}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -70,7 +74,11 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
      "test/site/plugins/test.rb",
-     "test/test_henshin.rb"
+     "test/test_henshin.rb",
+     "test/test_layouts.rb",
+     "test/test_options.rb",
+     "test/test_posts.rb",
+     "test/test_site.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/henshin.rb

@@ -27,7 +27,7 @@ module Henshin
               :layout => '',
               :file_name => '<{category}/>{title-with-dashes}.{extension}',
               :permalink => '/{year}/{month}/{date}/{title}.html',
-              :plugins => ['maraku', 'liquid'],
+              :plugins => ['maruku', 'liquid'],
               :root => '.',
               :target => '_site',
               :plugin_options => {},
@@ -40,9 +40,15 @@ module Henshin
   # @return [Hash] the merged configuration hash
   def self.configure( override={} )  
     config_file = (override[:root] || Defaults[:root]) + '/options.yaml'
-    config = YAML.load_file( config_file ).to_options
     
-    settings = Defaults.merge(config).merge(override)
+    begin
+      config = YAML.load_file( config_file ).to_options
+      settings = Defaults.merge(config).merge(override)
+    rescue => e
+      $stderr.puts "\nCould not read configuration, falling back to defaults..."
+      $stderr.puts "-> #{e.to_s}"
+      settings = Defaults
+    end
     
     settings.each do |k, v|
       if settings[:plugins].include? k.to_s
@@ -63,15 +69,19 @@ module Henshin
   def self.load_plugins( to_load, root, options )
     plugins = []
     to_load.each do |l|
-      p 
       begin
         require 'henshin/plugins/' + l
       rescue LoadError
         require File.join(root, 'plugins/', l)
       end
-      plugins << eval("#{l.capitalize}Plugin.new( #{options[l.to_sym]} )")
     end
-    plugins
+    @registered_plugins
+  end
+  
+  # Each plugin will call this method when loaded from #load_plugins, these plugins then populate @registered_plugins, which is returned from #load_plugins. Complicated? Maybe, but it works!
+  def self.register!( plug )
+    @registered_plugins ||= []
+    @registered_plugins << plug.new
   end
   
   
@@ -89,9 +99,8 @@ module Henshin
     extensions.flatten!
   end
   
-  
-  
-  
+
+  # @return [String] current version
   def self.version
     File.read( File.join(File.dirname(__FILE__), *%w[.. VERSION]) )
   end

data/lib/henshin/categories.rb

@@ -14,6 +14,11 @@ module Henshin
         'posts' => @posts.collect {|i| i.to_hash}
       }
     end
-  
+    
+    
+    def inspect
+      "#<Category:#{@name}>"
+    end
+    
   end
 end

data/lib/henshin/gen.rb

@@ -109,5 +109,10 @@ module Henshin
       
     end
     
+    
+    
+    def inspect
+      "#<Gen:#{@path}>"
+    end
   end
 end

data/lib/henshin/plugin.rb

@@ -4,9 +4,7 @@ module Henshin
     #
     #   class MyPlugin < NoName::StandardPlugin
     #
-    # or it can inherit a subclass from below
-    #
-    # This is quite useful if a dummy plugin is needed
+    # or it can (and should) inherit a subclass from below
     
     attr_accessor :extensions, :config
     
@@ -17,23 +15,32 @@ module Henshin
                      :output => ''}
       @config = {}
     end
+    
+    # Uncomment to have the plugin loaded
+    # Henshin.register! self
   end
   
   class Generator < StandardPlugin
     # a plugin which returns anything*
     
     def generate( content )
-      # return stuff
+      # return string
     end
+    
+    # Uncomment to have the plugin loaded
+    # Henshin.register! self
   end
   
   class LayoutParser < StandardPlugin
     # a plugin which returns anything*
-    # given a layout and data to insert
     
+    # given a layout and data to insert
     def generate( layout, data )
-      # return stuff
+      # return string
     end
+    
+    # Uncomment to have the plugin loaded
+    # Henshin.register! self
   end
   
 end

data/lib/henshin/plugins/liquid.rb

@@ -24,5 +24,6 @@ class LiquidPlugin < Henshin::LayoutParser
     end
     r
   end
-
+  
+  Henshin.register! self
 end

data/lib/henshin/plugins/maruku.rb

@@ -1,7 +1,7 @@
 require 'henshin/plugin'
 require 'maruku'
 
-class MarukuPlugin < Henshin::Generator
+class MarukuPlug < Henshin::Generator
   
   attr_accessor :extensions, :config
   
@@ -17,4 +17,5 @@ class MarukuPlugin < Henshin::Generator
     Maruku.new(content).to_html
   end
   
+  Henshin.register! self
 end

data/lib/henshin/plugins/pygments.rb

@@ -12,5 +12,6 @@ class PygmentsPlugin < Henshin::Generator
   def generate( content )
   
   end
-  
+
+  Henshin.register! self
 end

data/lib/henshin/plugins/sass.rb

@@ -22,4 +22,5 @@ class SassPlugin < Henshin::Generator
     output = engine.render
   end
   
+  Henshin.register! self
 end

data/lib/henshin/site.rb

@@ -28,9 +28,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
+    def build( paths=[] )
       self.reset
-      self.read
+      self.read( paths )
       self.process
       self.render
       self.write
@@ -39,11 +39,27 @@ module Henshin
     
     ##
     # Reads all necessary files and puts them into the necessary arrays
-    #
-    def read
-      self.read_layouts
-      self.read_posts
-      self.read_others
+    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
     end
     
     # Adds all items in 'layouts' to the layouts array
@@ -95,6 +111,30 @@ module Henshin
       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
@@ -171,7 +211,7 @@ module Henshin
       self.write_categories
     end
     
-    
+    # Writes the necessary pages for tags, but only if the correct layouts are present
     def write_tags
       if @layouts['tag_index']
         write_path = File.join( config[:root], 'tags', 'index.html' )
@@ -197,6 +237,7 @@ module Henshin
       end
     end
     
+    # Writes the necessary pages for categories, but only if the correct layouts are present
     def write_categories
       if @layouts['category_index']
         write_path = File.join( config[:root], 'categories', 'index.html' )
@@ -223,5 +264,4 @@ module Henshin
     end
   
   end
-
 end

data/lib/henshin/static.rb

@@ -21,6 +21,11 @@ module Henshin
       file.puts( @content )
     end
     
+    
+    def inspect
+      "#<Static:#{@path}>"
+    end
+    
   end
   
 end

data/lib/henshin/tags.rb

@@ -14,6 +14,11 @@ module Henshin
         'posts' => @posts.collect {|i| i.to_hash}
       }
     end
-  
+    
+    
+    def inspect
+      "#<Tag:#{@name}>"
+    end
+    
   end
 end

data/test/helper.rb

@@ -7,4 +7,23 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'henshin'
 
 class Test::Unit::TestCase
+
+  def root_dir
+    File.join(File.dirname(__FILE__), 'site')
+  end
+  
+  def target_dir
+    "_site"
+  end
+
+  def remove_site
+    FileUtils.rm_rf(File.join(root_dir, target_dir))
+  end
+  
+  def new_site
+    override = {:root => File.join(File.dirname(__FILE__), 'site'),:target => '_site'}
+    config = Henshin.configure(override)
+    Henshin::Site.new(config)
+  end
+  
 end

data/test/test_henshin.rb

@@ -1,7 +1,28 @@
-require 'helper'
+require File.join(File.dirname(__FILE__) ,'helper')
 
 class TestHenshin < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  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.each {|f| require f }

data/test/test_layouts.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__) ,'helper')
+
+class TestLayouts < Test::Unit::TestCase
+  context "A layout" do
+  
+    setup do
+      @site = new_site
+      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

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__) ,'helper')
+
+class TestOptions < Test::Unit::TestCase
+  context "Loading and setting options" do
+    
+    setup do
+      @opts = File.join(root_dir, 'options.yaml')
+    end
+    
+    should "warn of invalid options.yaml" do
+    
+    end
+    
+    should "warn of no options.yaml" do
+    
+    end
+    
+    should "use defaults if no options.yaml" do
+      assert_equal Henshin::Defaults, Henshin.configure
+    end
+    
+    should "load options and merge with defaults" do
+    
+    end
+  
+  end
+end

data/test/test_posts.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__) ,'helper')
+
+class TestPosts < Test::Unit::TestCase
+  context "A post" do
+  
+    setup do
+      @site = new_site
+      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
+    end
+    
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - hawx
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-30 00:00:00 +01:00
+date: 2010-05-31 00:00:00 +01:00
 default_executable: henshin
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -93,6 +93,10 @@ files:
 - test/site/sass/print.sass
 - test/site/static.html
 - test/test_henshin.rb
+- test/test_layouts.rb
+- test/test_options.rb
+- test/test_posts.rb
+- test/test_site.rb
 has_rdoc: true
 homepage: http://github.com/hawx/henshin
 licenses: []
@@ -127,3 +131,7 @@ test_files:
 - test/helper.rb
 - test/site/plugins/test.rb
 - test/test_henshin.rb
+- test/test_layouts.rb
+- test/test_options.rb
+- test/test_posts.rb
+- test/test_site.rb