henshin 0.1.3 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/bin/henshin

@@ -11,8 +11,23 @@ EOS
 
 
 override = {}
+build = {:server => false, :auto => false}
 opts = OptionParser.new do |opts|
   opts.banner = banner
+  
+  opts.on("--server", "-s", "Start server") do
+    build[:server] = true
+  end
+  
+  opts.on("--auto", "-a", "Auto regenerate files") do
+    build[:auto] = true
+  end
+  
+  opts.on("--version", "Display current version of Henshin") do
+    puts "Henshin #{Henshin.version}"
+    exit 0
+  end
+  
 end
 opts.parse!
 
@@ -25,13 +40,60 @@ end
 config = Henshin.configure(override)
 site = Henshin::Site.new(config)
 
-puts "Reading files..."
-site.read
 
-site.process
-site.render
+# build normally
+puts "Building site..."
+site.build
+puts "Site created in #{config[:target]}"
+
+
+# regenerate files when changed
+if build[:auto]
+  require 'directory_watcher'
+  
+  puts "", "Auto-build initiated..."
+  
+  # build the glob pattern
+  gl = Dir[ File.join(config[:root], '*')].select { |x| File.directory?(x) }
+  ['/_site', '/plugins'].each do |r|
+    gl = gl.select {|i| !i.include?( File.join(config[:root], r) )}
+  end
+  gl.collect! {|x| "#{x}/**/*"}
+  gl += ['*']
+  
+  dw = DirectoryWatcher.new config[:root], :glob => gl
+  dw.interval = 2.0
+  dw.add_observer do |*args| 
+    if args.size > 1
+      puts "rebuilding -> #{args.size} files"
+    else
+      puts "rebuilding -> #{args[0].path}"
+    end
+    site.build
+  end
+  
+  dw.start
+  
+  unless build[:server]
+    loop {sleep 1000}
+  end
+end  
+
+
+# start a server
+if build[:server]
+  require 'webrick'
+  
+  server = WEBrick::HTTPServer.new(
+    :Port => '3000',
+    :DocumentRoot => File.join(config[:root], config[:target]),
+    :MimeTypes => WEBrick::HTTPUtils::DefaultMimeTypes
+  )
+  
+  thread = Thread.new { server.start }
+  trap("INT") { server.shutdown }
+  
+  thread.join()
+end
 
-puts "Writing files..."
-site.write
 
-puts "Site created in #{config[:target]}"

data/henshin.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{henshin}
-  s.version = "0.1.3"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["hawx"]
-  s.date = %q{2010-05-27}
+  s.date = %q{2010-05-30}
   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}
@@ -47,8 +47,12 @@ Gem::Specification.new do |s|
      "test/site/_site/static.html",
      "test/site/css/screen.css",
      "test/site/index.html",
+     "test/site/layouts/category_index.html",
+     "test/site/layouts/category_page.html",
      "test/site/layouts/main.html",
      "test/site/layouts/post.html",
+     "test/site/layouts/tag_index.html",
+     "test/site/layouts/tag_page.html",
      "test/site/options.yaml",
      "test/site/plugins/test.rb",
      "test/site/posts/Testing-Stuff.markdown",

data/lib/henshin.rb

@@ -81,10 +81,19 @@ module Henshin
   # @return [Array] a list of file extensions
   def self.extensions( plugins )
     extensions = []
-    plugins.each do |i| 
-      extensions << i.extensions
+    plugins.each do |i|
+      if i.extensions[:input] != []
+        extensions << i.extensions[:input]
+      end
     end
     extensions.flatten!
   end
+  
+  
+  
+  
+  def self.version
+    File.read( File.join(File.dirname(__FILE__), *%w[.. VERSION]) )
+  end
 
 end

data/lib/henshin/gen.rb

@@ -4,13 +4,14 @@ module Henshin
   class Gen
     
     attr_accessor :path, :extension, :content, :layout, :date, :title
-    attr_accessor :site, :config, :renderer
+    attr_accessor :site, :config, :renderer, :data
     
-    def initialize( path, site )
+    def initialize( path, site, data={} )
       @path = path
       @site = site
       @config = site.config
       @extension = path.extension
+      @data = data
     end
     
     
@@ -47,7 +48,7 @@ module Henshin
     def render
       # render the posts content
       config[:plugins].each do |plugin|
-        if plugin.extensions.include?( @extension ) && !plugin.is_a?( LayoutParser )
+        if plugin.extensions[:input].include?( @extension ) && plugin.is_a?( Generator )
           @content = plugin.generate( @content )
           @renderer = plugin
         end
@@ -65,14 +66,22 @@ module Henshin
       end
     end
     
-    # Creates the data to be sent to the layout engine
+    # Creates the data to be sent to the layout engine. Uses optional data if available
     #
     # @return [Hash] the payload for the layout engine
     def payload
-      { 
-        'yield' => @content,
-        'site' => @site.payload['site']
-      }
+      if @data == {}
+        { 
+          'yield' => @content,
+          'site' => @site.payload['site']
+        }
+      else
+        {
+          'yield' => @content,
+          'site' => @site.payload['site'],
+          @data[:name] => @data[:payload]
+        }
+      end
     end
     
     
@@ -88,8 +97,8 @@ module Henshin
         write_path.gsub!("/#{@renderer.config[:root]}", "/#{@renderer.config[:target]}")
       end
       
-      render_type = @renderer.config[:file_type] if @renderer
-      if render_type
+      render_type = @renderer.extensions[:output] if @renderer
+      if render_type != ''
         # files should have different extension
         write_path.gsub!(".#{@extension}", ".#{render_type}")
       end

data/lib/henshin/plugin.rb

@@ -5,47 +5,34 @@ module Henshin
     #   class MyPlugin < NoName::StandardPlugin
     #
     # or it can inherit a subclass from below
-    
+    #
     # This is quite useful if a dummy plugin is needed
     
     attr_accessor :extensions, :config
     
     def initialize
-      @extensions = []
+      # inputs are the file types it will take
+      # output should be the type it creates
+      @extensions = {:input => [],
+                     :output => ''}
       @config = {}
     end
   end
   
-  class HTMLGenerator < StandardPlugin
-    # a plugin which returns html
-    
-    def generate( content )
-      #return html
-    end
-  end
-  
-  class CSSGenerator < StandardPlugin
-    # a plugin which returns css
-    
-    def generate( content )
-      #return css
-    end
-  end
-  
-  class JSGenerator < StandardPlugin
-    # a plugin which returns javascript
+  class Generator < StandardPlugin
+    # a plugin which returns anything*
     
     def generate( content )
-      #return javascript
+      # return stuff
     end
   end
   
   class LayoutParser < StandardPlugin
-    # a plugin which returns html
+    # a plugin which returns anything*
     # given a layout and data to insert
     
     def generate( layout, data )
-      #return html
+      # return stuff
     end
   end
   

data/lib/henshin/plugins/liquid.rb

@@ -6,7 +6,8 @@ class LiquidPlugin < Henshin::LayoutParser
   attr_accessor :extensions
   
   def initialize
-    @extensions = []
+    @extensions = {:input => [],
+                   :output => ''}
   end
   
   def generate( layout, data )

data/lib/henshin/plugins/maruku.rb

@@ -1,14 +1,15 @@
 require 'henshin/plugin'
 require 'maruku'
 
-class MarukuPlugin < Henshin::HTMLGenerator
+class MarukuPlugin < Henshin::Generator
   
   attr_accessor :extensions, :config
   
   Defaults = {}
   
   def initialize( override={} )
-    @extensions = ['markdown', 'mkdwn', 'md']
+    @extensions = {:input => ['markdown', 'mkdwn', 'md'],
+                   :output => 'html'}
     @config = Defaults.merge(override)
   end
   

data/lib/henshin/plugins/pygments.rb

@@ -1,11 +1,12 @@
 require 'henshin/plugin'
 
-class PygmentsPlugin < Henshin::HTMLGenerator
+class PygmentsPlugin < Henshin::Generator
   
   attr_accessor :extensions
   
   def initialize
-    @extensions = ['hmm']
+    @extensions = {:input => [],
+                   :output => ''}
   end
   
   def generate( content )

data/lib/henshin/plugins/sass.rb

@@ -2,18 +2,18 @@ require 'henshin/plugin'
 require 'haml'
 require 'sass/engine'
 
-class SassPlugin < Henshin::CSSGenerator
+class SassPlugin < Henshin::Generator
   
   attr_accessor :extensions, :config
   
   Defaults = {:target => 'css',
               :root => 'sass',
-              :file_type => 'css',
               :ignore_layouts => true,
               :style => :nested}
   
   def initialize( override={} )
-    @extensions = ['sass', 'scss']
+    @extensions = {:input => ['sass', 'scss'],
+                   :output => 'css'}
     @config = Defaults.merge(override)
   end
   

data/lib/henshin/post.rb

@@ -84,7 +84,7 @@ module Henshin
         @content = file[$1.size..-1]
       else
         @content = file
-      end  
+      end
     end
     
     # Uses the loaded data to override settings
@@ -102,7 +102,7 @@ module Henshin
       
       if override[:tags]
         @tags << override[:tags].split(', ')
-        @tags.flatten!
+        @tags.flatten!.uniq!
       end
     end
     

data/lib/henshin/site.rb

@@ -2,7 +2,7 @@ module Henshin
 
   class Site
   
-    attr_accessor :posts, :gens, :statics, :archive, :tags, :categories, :plugins
+    attr_accessor :posts, :gens, :statics, :archive, :tags, :categories
     attr_accessor :layouts, :config
     
     def initialize( config )
@@ -15,13 +15,28 @@ module Henshin
       @posts = []
       @gens = []
       @statics = []
+      
       @archive = {}
       @tags = Hash.new { |h, k| h[k] = Tag.new(k) }
       @categories = Hash.new { |h, k| h[k] = Category.new(k) }
+      
       @layouts = {}
     end
     
     
+    ##
+    # Read, process, render and write everything
+    #
+    # @todo Make it take an array as an arg so that only specific files are updated
+    def build
+      self.reset
+      self.read
+      self.process
+      self.render
+      self.write
+    end
+    
+    
     ##
     # Reads all necessary files and puts them into the necessary arrays
     #
@@ -151,6 +166,60 @@ module Henshin
       @posts.each_parallel {|p| p.write}
       @gens.each_parallel {|g| g.write}
       @statics.each_parallel {|s| s.write}
+      
+      self.write_tags
+      self.write_categories
+    end
+    
+    
+    def write_tags
+      if @layouts['tag_index']
+        write_path = File.join( config[:root], 'tags', 'index.html' )
+      
+        tag_index = Gen.new(write_path, self)
+        tag_index.layout = @layouts['tag_index']
+        
+        tag_index.render
+        tag_index.write
+      end
+      
+      if @layouts['tag_page']
+        @tags.each do |n, tag|
+          write_path = File.join( config[:root], 'tags', tag.name, 'index.html' )
+          
+          payload = {:name => 'tag', :payload => tag.to_hash}
+          tag_page = Gen.new(write_path, self, payload)
+          tag_page.layout = @layouts['tag_page']
+          
+          tag_page.render
+          tag_page.write
+        end
+      end
+    end
+    
+    def write_categories
+      if @layouts['category_index']
+        write_path = File.join( config[:root], 'categories', 'index.html' )
+        
+        category_index = Gen.new(write_path, self)
+        category_index.layout = @layouts['category_index']
+        
+        category_index.render
+        category_index.write
+      end
+      
+      if @layouts['category_page']
+        @categories.each do |n, category|
+          write_path = File.join( config[:root], 'categories', category.name, 'index.html' )
+          
+          payload = {:name => 'category', :payload => category.to_hash}
+          category_page = Gen.new(write_path, self, payload)
+          category_page.layout = @layouts['category_page']
+          
+          category_page.render
+          category_page.write
+        end
+      end
     end
   
   end

data/test/site/index.html

@@ -11,4 +11,5 @@ date: 2009-10-07T17:17:45+00:00
 
 <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>
 
+<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/layouts/category_index.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>  
+<html lang="en">  
+  <head>  
+    <meta charset="utf-8" />  
+    <title>{{ site.title }}</title>
+    <link rel="stylesheet" href="screen.css" type="text/css" />  
+  </head>  
+  <body>
+
+    <h2>A List of Categories</h2>
+    <ul>
+      {% for category in site.categories %}
+        <li>
+          {{ category.name }}
+          <ul>
+          {% for post in category.posts %}
+            <li>{{ post.title }} - {{ post.date }}</li>
+          {% endfor %}
+          </ul>
+        </li>
+      {% endfor %}
+    </ul>
+    
+    <span>Copyright &copy; {{ site.author }}</span>
+  </body>  
+</html> 

data/test/site/layouts/category_page.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html>  
+<html lang="en">  
+  <head>  
+    <meta charset="utf-8" />  
+    <title>{{ site.title }}</title>
+    <link rel="stylesheet" href="screen.css" type="text/css" />  
+  </head>  
+  <body>
+
+    <h2>{{ category.name }}</h2>
+    
+      <ul>
+      {% for post in category.posts %}
+        <li>{{ post.title }} - {{ post.date }}</li>
+      {% endfor %}
+      </ul>
+    
+    <span>Copyright &copy; {{ site.author }}</span>
+  </body>  
+</html> 

data/test/site/layouts/tag_index.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>  
+<html lang="en">  
+  <head>  
+    <meta charset="utf-8" />  
+    <title>{{ site.title }}</title>
+    <link rel="stylesheet" href="screen.css" type="text/css" />  
+  </head>  
+  <body>
+
+    <h2>A List of Tags</h2>
+    <ul>
+      {% for tag in site.tags %}
+        <li>
+          {{ tag.name }}
+          <ul>
+          {% for post in tag.posts %}
+            <li>{{ post.title }} - {{ post.date }}</li>
+          {% endfor %}
+          </ul>
+        </li>
+      {% endfor %}
+    </ul>
+    
+    <span>Copyright &copy; {{ site.author }}</span>
+  </body>  
+</html> 

data/test/site/layouts/tag_page.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html>  
+<html lang="en">  
+  <head>  
+    <meta charset="utf-8" />  
+    <title>{{ site.title }}</title>
+    <link rel="stylesheet" href="screen.css" type="text/css" />  
+  </head>  
+  <body>
+
+    <h2>{{ tag.name }}</h2>
+    
+      <ul>
+      {% for post in tag.posts %}
+        <li>{{ post.title }} - {{ post.date }}</li>
+      {% endfor %}
+      </ul>
+    
+    <span>Copyright &copy; {{ site.author }}</span>
+  </body>  
+</html> 

data/test/site/plugins/test.rb

@@ -2,10 +2,4 @@ require 'henshin/plugin'
 
 class TestPlugin < Henshin::StandardPlugin
 
-  def initialize
-    # p 'Test plugin loaded'
-    @extensions = []
-    @config = {}
-  end
-
 end

data/test/site/static.html

@@ -14,6 +14,6 @@
     
     <p>I should be in the root folder! No templates or anything</p>
 
-
+    <p>init</p>
   </body>  
 </html> 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - hawx
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-27 00:00:00 +01:00
+date: 2010-05-30 00:00:00 +01:00
 default_executable: henshin
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,8 +79,12 @@ files:
 - test/site/_site/static.html
 - test/site/css/screen.css
 - test/site/index.html
+- test/site/layouts/category_index.html
+- test/site/layouts/category_page.html
 - test/site/layouts/main.html
 - test/site/layouts/post.html
+- test/site/layouts/tag_index.html
+- test/site/layouts/tag_page.html
 - test/site/options.yaml
 - test/site/plugins/test.rb
 - test/site/posts/Testing-Stuff.markdown