henshin 0.3.0 → 0.4.0

data/.gitignore

@@ -20,4 +20,8 @@ pkg
 .yardoc
 
 ## PROJECT::SPECIFIC
-_site/
+_site/
+.sass-cache/
+docs-github/
+hmm/
+doc/

data/README.markdown

@@ -1,60 +1,22 @@
 # Henshin
 
-Henshin is a new static site generator, yeah another one. I wasn't going to release it yet but then I saw [awestruct](http://awestruct.org/) and thought I may as well now. Oh and this was totally inspired by the amazing [jekyll](http://github.com/mojombo/jekyll) (in case you hadn't guessed).
-
-
-## Main Features
-
-- Generates posts, etc.
-- More control with settings (see below)
-- A plugin system (not great at the moment, still working on how best to implement it)
-
-## Future Goals
-
-- Easy tag, category and archive pages
-- Default templates so you can just type `henshin` with any folder of text files and create a quick site
+Henshin is a static site generator. It takes in posts, or just pages, runs them through plugins and layouts and gives you a folder to put on a webserver. It makes it easy to write archive pages, tags and categories.
 
 
 ## How To
 
-Install by typing `(sudo) gem install henshin`
+Install with
 
-Then create a folder for your site, in this you'll probably want to create two folders `layouts` and `posts`, to put in your layouts and posts.
+    (sudo) gem install henshin
 
-Next create an `index.html` file and your kind of done, unless of course you want some content.
+Then create a new site
 
-Build the site by running `henshin` from the command line. Help available with `henshin -h`
+    cd [some directory]
+    henshin create
 
-### YAML Frontmatter & Options.yaml
+And build your new site with
 
-You can create an optional `options.yaml` file at the root of your site, here are the options so far:
-
-    title: [title of your site]
-    description: [description for your site]
-    author: [your name]
-    
-    layout: [the default layout to use]
-    
-    post_name: [the way the post name is parsed]
-      eg. '{title-with-dashes}.{extension}
-      
-        you can use:
-          {title}
-          {title-with-dashes}
-          {date}
-          {date-time}
-          {extension}
-          
-    permalink: [the way you want the permalink to look]
-      eg. '/{year}/{month}/{date}-{title}/index.html
-        these are the only options at the moment for permalink
-      
-    plugins: [array of plugins to 
-    
-
-### Plugins
-
-The only plugins at the moment are the ones included (liquid, maruku, sass and pygments) of which only liquid and maruku work at the moment. In the future you will be able to add your own plugins, probably in a plugins folder. If you want to make your own just look at the others, it's pretty simple to work out!
+    henshin
 
 
 ## Note on Patches/Pull Requests
@@ -67,6 +29,7 @@ The only plugins at the moment are the ones included (liquid, maruku, sass and p
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 - Send me a pull request. Bonus points for topic branches.
 
+
 ## License
 
 Copyright (c) 2010 Joshua Hawxwell. See LICENSE for details.

data/Rakefile

@@ -14,6 +14,7 @@ begin
     gem.add_dependency "directory_watcher", ">= 1.3.1"
     gem.add_dependency "maruku", ">= 0.6.0"
     gem.add_dependency "liquid", ">= 2.0.0"
+    gem.add_dependency "parsey", ">= 0.1.3"
     gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     gem.add_development_dependency "yard", ">= 0"
   end
@@ -24,7 +25,7 @@ end
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
+  test.libs << 'test'
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

data/bin/henshin

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../lib/henshin'
-require File.dirname(__FILE__) + '/files.rb'
+require 'henshin'
+require 'henshin/exec/files'
+
 require 'optparse'
 require 'fileutils'
 
@@ -62,19 +63,18 @@ else
   opts.parse!
   
   if ARGV[0]
-    override[:root] = ARGV[0].split(':')[0]
-    override[:target] = ARGV[0].split(':')[1] if ARGV[0].split(':')[1]
+    override['root'] = ARGV[0].split(':')[0]
+    override['target'] = ARGV[0].split(':')[1] if ARGV[0].split(':')[1]
   end
   
   
-  config = Henshin.configure(override)
-  site = Henshin::Site.new(config)
+  site = Henshin::Site.new(override)
   unless build[:auto]
     start = Time.now
     # build normally
     puts "Building site..."
     site.build
-    puts "Site created in #{config[:target]} (#{Time.now - start}s)"
+    puts "Site created in #{site.config['target']} (#{Time.now - start}s)"
   end
   
   threads = []
@@ -116,14 +116,14 @@ else
     puts "", "Auto-build initiated..."
     
     # build the glob pattern
-    gl = Dir[ File.join(config[:root], '*')].select { |x| File.directory?(x) }
+    gl = Dir[ File.join(site.config['root'], '*')].select { |x| File.directory?(x) }
     ['/_site', '/plugins'].each do |r|
-      gl = gl.select {|i| !i.include?( File.join(config[:root], r) )}
+      gl = gl.select {|i| !i.include?( File.join(site.config['root'], r) )}
     end
-    gl.collect! {|x| "#{x}/**/*"[config[:root].size+1..-1]}
+    gl.collect! {|x| "#{x}/**/*"[site.config['root'].size+1..-1]}
     gl += ['*']
 
-    dw = DirectoryWatcher.new config[:root], :glob => gl
+    dw = DirectoryWatcher.new(site.config['root'], :glob => gl)
     dw.interval = 1
     dw.add_observer do |*args| 
       if args.size > 1
@@ -132,7 +132,6 @@ else
         puts "rebuilding -> #{args[0].path}"
       end
       site.build
-      puts "rebuilt..."
     end
     
     threads << Thread.new { dw.start }

data/henshin.gemspec

@@ -5,14 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{henshin}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["hawx"]
-  s.date = %q{2010-06-22}
+  s.date = %q{2010-07-17}
+  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}
-  s.executables = ["files.rb", "henshin"]
+  s.executables = ["henshin"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.markdown"
@@ -23,14 +24,14 @@ Gem::Specification.new do |s|
      "README.markdown",
      "Rakefile",
      "VERSION",
-     "bin/files.rb",
      "bin/henshin",
      "henshin.gemspec",
      "lib/henshin.rb",
      "lib/henshin/archive.rb",
-     "lib/henshin/categories.rb",
+     "lib/henshin/exec/files.rb",
      "lib/henshin/ext.rb",
      "lib/henshin/gen.rb",
+     "lib/henshin/labels.rb",
      "lib/henshin/plugin.rb",
      "lib/henshin/plugins/highlight.rb",
      "lib/henshin/plugins/liquid.rb",
@@ -40,9 +41,8 @@ Gem::Specification.new do |s|
      "lib/henshin/post.rb",
      "lib/henshin/site.rb",
      "lib/henshin/static.rb",
-     "lib/henshin/tags.rb",
      "test/helper.rb",
-     "test/site/css/includes/reset.sass",
+     "test/site/css/_reset.sass",
      "test/site/css/print.css",
      "test/site/css/screen.sass",
      "test/site/includes/head.html",
@@ -64,48 +64,39 @@ Gem::Specification.new do |s|
      "test/site/posts/lorem-ipsum.markdown",
      "test/site/posts/same-date.markdown",
      "test/site/static.html",
-     "test/test_archives.rb",
-     "test/test_categories.rb",
-     "test/test_gens.rb",
-     "test/test_henshin.rb",
-     "test/test_layouts.rb",
+     "test/suite.rb",
+     "test/test_gen.rb",
      "test/test_options.rb",
-     "test/test_posts.rb",
+     "test/test_post.rb",
      "test/test_site.rb",
-     "test/test_statics.rb",
-     "test/test_tags.rb",
-     "test/text_exts.rb"
+     "test/test_static.rb"
   ]
   s.homepage = %q{http://github.com/hawx/henshin}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Henshin is a static site generator}
   s.test_files = [
     "test/helper.rb",
      "test/site/plugins/test.rb",
-     "test/test_archives.rb",
-     "test/test_categories.rb",
-     "test/test_gens.rb",
-     "test/test_henshin.rb",
-     "test/test_layouts.rb",
+     "test/suite.rb",
+     "test/test_gen.rb",
      "test/test_options.rb",
-     "test/test_posts.rb",
+     "test/test_post.rb",
      "test/test_site.rb",
-     "test/test_statics.rb",
-     "test/test_tags.rb",
-     "test/text_exts.rb"
+     "test/test_static.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<titlecase>, [">= 0.1.0"])
       s.add_runtime_dependency(%q<directory_watcher>, [">= 1.3.1"])
       s.add_runtime_dependency(%q<maruku>, [">= 0.6.0"])
       s.add_runtime_dependency(%q<liquid>, [">= 2.0.0"])
+      s.add_runtime_dependency(%q<parsey>, [">= 0.1.3"])
       s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
@@ -113,6 +104,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<directory_watcher>, [">= 1.3.1"])
       s.add_dependency(%q<maruku>, [">= 0.6.0"])
       s.add_dependency(%q<liquid>, [">= 2.0.0"])
+      s.add_dependency(%q<parsey>, [">= 0.1.3"])
       s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
     end
@@ -121,6 +113,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<directory_watcher>, [">= 1.3.1"])
     s.add_dependency(%q<maruku>, [">= 0.6.0"])
     s.add_dependency(%q<liquid>, [">= 2.0.0"])
+    s.add_dependency(%q<parsey>, [">= 0.1.3"])
     s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
   end

data/lib/henshin.rb

@@ -1,20 +1,21 @@
 $:.unshift File.dirname(__FILE__)
 
-# standard ruby
 require 'time'
 require 'yaml'
 require 'pp'
+require 'pathname'
 
-# 3rd party
 require 'titlecase'
+require 'parsey'
 
-# library
 require 'henshin/site'
+require 'henshin/plugin'
 
 require 'henshin/gen'
 require 'henshin/post'
 require 'henshin/static'
 
+require 'henshin/labels'
 require 'henshin/tags'
 require 'henshin/categories'
 require 'henshin/archive'
@@ -24,103 +25,25 @@ require 'henshin/ext'
 module Henshin
   
   # Default options for configuration
-  Defaults = {:title => 'A site',
-              :description => 'No description',
-              :time_zone => 'GMT',
-              :author => '',
-              :layout => '',
-              :file_name => '<{category}/>{title-with-dashes}.{extension}',
-              :permalink => '/{year}/{month}/{date}/{title}.html',
-              :plugins => ['maruku', 'liquid'],
-              :root => '.',
-              :target => '_site',
-              :plugin_options => {},
-              :exclude => [] }
+  Defaults = {'title' => 'A site',
+              'file_name' => '<{category}/>{title-with-dashes}.{extension}',
+              'permalink' => '/{year}/{month}/{date}/{title}.html',
+              'plugins' => ['maruku', 'liquid'],
+              'root' => './',
+              'target' => '_site',
+              'exclude' => []}.freeze
+              
+  # Partial regexs for use in parsing file names
+  Partials = {'title' => '([a-zA-Z0-9_ -]+)',
+              'title-with-dashes' => '([a-zA-Z0-9-]+)',
+              'date' => '(\d{4}-\d{2}-\d{2})',
+              'date-time' => '(\d{4}-\d{2}-\d{2} at \d{2}:\d{2})',
+              'xml-date-time' => '(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}(:\d{2})?((\+|-)\d{2}:\d{2})?)',
+              'category' => '([a-zA-Z0-9_ -]+)',
+              'extension' => "([a-zA-Z0-9_-]+)"}.freeze
   
-  
-  # Creates the configuration hash by merging defaults, supplied options and options 
-  # read from the 'options.yaml' file. Then loads the plugins and sorts them
-  #
-  # @param [Hash] override to override other set options
-  # @return [Hash] the merged configuration hash
-  def self.configure( override={} )  
-    config_file = File.join((override[:root] || Defaults[:root]), '/options.yaml')
-    
-    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.merge(override)
-    end
-    
-    settings[:exclude] << '/_site' << '/plugins'
-    settings[:plugins] = Henshin.sort_plugins( Henshin.load_plugins(settings) )
-    settings
-  end
-  
-  # Organises the plugins into generators and layout parses,
-  # then turns the generators into a hash with a key for each extension.
-  #
-  # @param [Array] plugins
-  # @return [Hash] 
-  def self.sort_plugins(plugins)
-    r = {:generators => {}, :layout_parsers => []}
-    plugins.each do |plugin|
-      if plugin.is_a? Generator
-        plugin.extensions[:input].each do |ext|
-          r[:generators][ext] = plugin
-        end
-      elsif plugin.is_a? LayoutParser
-        r[:layout_parsers] << plugin
-      end
-    end
-    r
-  end
-  
-  # Loads the plugins, each plugin then calls Henshin.register!, and then we loop through
-  # the options and pass the options for the plugin to it.
+  # Reads the current version from VERSION
   #
-  # @param [Hash] settings of loaded so far
-  # @return [Array] list of loaded plugin instances
-  def self.load_plugins(opts)  
-    plugins = []
-    opts[:plugins].each do |l|
-      begin
-        require 'henshin/plugins/' + l
-      rescue LoadError
-        require File.join(opts[:root], 'plugins/', l)
-      end
-    end
-    
-    @registered_plugins.each do |plugin|
-      if plugin[:opts] && opts[plugin[:opts]]
-        opts[plugin[:opts]].each do |k, v|
-          if k.to_s.include? 'dir'
-            opts[plugin[:opts]][k] = File.join(opts[:root], v)
-          end
-        end
-        plugin[:plugin].configure opts[plugin[:opts]]
-      end
-      plugins << plugin[:plugin]
-    end
-    
-    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.
-  #
-  # @param [Class] plugin to load
-  # @param [Symbol] options symbol to look up in settings hash
-  # @return [Array] plugins and options symbol in hashes
-  def self.register!( plug, opts=nil )
-    @registered_plugins ||= []
-    @registered_plugins << {:plugin => plug.new, :opts => opts}
-  end
-  
-
   # @return [String] current version
   def self.version
     File.read( File.join(File.dirname(__FILE__), '..', 'VERSION') )

data/lib/henshin/archive.rb

@@ -1,137 +1,100 @@
 module Henshin
   
-  class Archive
+  # This should really be a hash which just holds post objects, when #to_hash is
+  # called, each post object held is turned has Post#to_hash called and this is
+  # returned. It also controls writing of the archive pages.
+  #   
+  class Archive < Hash
     
-    attr_accessor :config
+    attr_accessor :site
     
-    def initialize( site )
-      @archive = Hash.new {|h, k| h[k] = Hash.new {|h, k| h[k] = Hash.new {|h, k| h[k] = []} }}
+    # Create a new instance of Archive
+    def initialize(site)
       @site = site
-      @config = site.config
-    end
-  
-    def add_post( post )
-      date = post.date
-      @archive[date.year.to_s][date.month.to_s][date.day.to_s] << post.to_hash
-    end
-    
-    # Turns the whole archive into a hash. Probably the least efficient thing in the world, but it works
-    def to_hash
-      if @hashed
-        @hashed
-      else
-        @hashed = Hash.new do |h, k| 
-          h[k] = Hash.new do |h, k| # years
-            if k == 'posts'
-              h[k] = []
-            else
-              h[k] = Hash.new do |h, k| # months
-                if k == 'posts'
-                  h[k] = []
-                else
-                  h[k] = Hash.new do |h, k| # days
-                    if k == 'posts'
-                      h[k] = []
-                    else
-                      h[k] = {}
-                    end
-                  end # /days
-                end
-              end # /months
-            end
-          end # /years
-        end 
-        @archive.each do |y, month|
-          month.each do |m, date|
-            date.each do |d, p|            
-              @hashed[y]['posts'] << p
-              @hashed[y][m]['posts'] << p
-              @hashed[y][m][d]['posts'] << p
-              
-              @hashed[y]['posts'].flatten!
-              @hashed[y][m]['posts'].flatten!
-              @hashed[y][m][d]['posts'].flatten!
-            end
-          end
-        end
-        
-      end
-    end
-    
-    # Creates a hash with posts separated by year, month then date
-    def to_date_hash
-      r = Hash.new {|h, k| h[k] = Hash.new {|h, k| h[k] = Hash.new {|h, k| h[k] = []} }}
-      @archive.each do |year, m|
-        m.each do |month, d|
-          d.each do |date, p|
-            r[year][month][date] << p
-            r[year][month][date].flatten!
-          end
-        end
-      end
-      r
     end
     
-    # Creates a hash with posts separated by year then month
-    def to_month_hash
-      r = Hash.new {|h, k| h[k] = Hash.new {|h, k| h[k] = []} }
-      @archive.each do |year, m|
-        m.each do |month, d|
-          d.each do |date, p|
-            r[year][month] << p
-            r[year][month].flatten!
-          end
-        end
-      end
-      r
+    # Adds the post to the correct year array, month array and day array within the archive
+    #
+    # @param [Post] post to be added to the archive
+    def <<(post)
+      return nil unless post.data['date']
+      date = post.data['date']
+      year, month, day = date.year, date.month, date.day
+      
+      self[year] ||= {}
+      self[year][month] ||= {}
+      self[year][month][day] ||= []
+      self[year][month][day] << post
     end
     
-    # Creates a hash with posts separated by year
-    def to_year_hash
-      r = Hash.new {|h, k| h[k] = []}
-      @archive.each do |year, m|
-        m.each do |month, d|
-          d.each do |date, p|
-            r[year] << p
-            r[year].flatten!
-          end
+    # Converts the archive to a hash suitable for putting in a layout by 
+    # calling #to_hash for all of the posts it contains
+    #
+    # @return [Hash]
+    def to_hash
+      r = {}
+      self.each do |y, i|
+        r[y] = {}
+        i.each do |m, i|
+          r[y][m] = {}
+         i.each do |d, i|
+           r[y][m][d] = []
+           i.each do |j|
+             r[y][m][d] << j.to_hash
+           end
+         end
         end
       end
+      
       r
     end
     
-    ##
-    # Writes the archive pages
+    # Writes the archives if the correct layouts are present
     def write
       self.write_years if @site.layouts['archive_year']
       self.write_months if @site.layouts['archive_month']
       self.write_dates if @site.layouts['archive_date']
     end
     
+    # This writes all the archives for years
     def write_years
-      years = self.to_year_hash
-      years.each do |year, posts|
-        write_path = File.join( @config[:root], year, 'index.html' )
-        # date should give the full date, as a Time object!! and the others
-        t = Time.parse("#{year}/01/01")
-        payload = {:name => 'archive', :payload => {'date' => t, 'posts' => years[year]} }
-        page = Gen.new( write_path, @site, payload )
-        page.layout = @site.layouts['archive_year']
+      self.to_hash.each do |year, v|
+        # need to fake the file loc so that gen automatically creates permalink
+        t = @site.root + year.to_s + 'index.html'
+
+        payload = {
+          :name => 'archive', 
+          :payload => {
+            'posts' => self.to_hash,
+            'year' => year
+          }
+        }
+        page = Gen.new(t, @site, payload)
+        page.read
+        page.data['layout'] = @site.layouts['archive_year']
         
         page.render
         page.write
       end
     end
     
+    # Writes all of the archives for the months
     def write_months
-      months = self.to_month_hash
-      months.each do |year, posts|
-        posts.each do |month, posts|
-          write_path = File.join( @config[:root], year, month, 'index.html' )
-          t = Time.parse("#{year}/#{month}/01")
-          payload = {:name => 'archive', :payload => {'date' => t, 'posts' => months[year][month]} }
-          page = Gen.new( write_path, @site, payload )
-          page.layout = @site.layouts['archive_month']
+      self.to_hash.each do |year, v|
+        v.each do |month, v|          
+          t = @site.root + year.to_s + month.to_s + 'index.html'
+
+          payload = {
+            :name => 'archive', 
+            :payload => {
+              'posts' => self.to_hash,
+              'year' => year,
+              'month' => month
+            }
+          }
+          page = Gen.new(t, @site, payload)
+          page.read
+          page.data['layout'] = @site.layouts['archive_month']
           
           page.render
           page.write
@@ -139,16 +102,25 @@ module Henshin
       end
     end
     
+    # Writes all of the archives for the days
     def write_dates
-      dates = self.to_date_hash
-      dates.each do |year, posts|
-        posts.each do |month, posts|
-          posts.each do |date, posts|
-            write_path = File.join( @config[:root], year, month, date, 'index.html' )
-            t = Time.parse("#{year}/#{month}/#{date}")
-            payload = {:name => 'archive', :payload => {'date' => t, 'posts' => dates[year][month][date]} }
-            page = Gen.new( write_path, @site, payload )
-            page.layout = @site.layouts['archive_date']
+      self.to_hash.each do |year, v|
+        v.each do |month, v|
+          v.each do |date, v|
+            t = @site.root + year.to_s + month.to_s + date.to_s + 'index.html'
+            
+            payload = {
+              :name => 'archive', 
+              :payload => {
+                'posts' => self.to_hash,
+                'year' => year,
+                'month' => month,
+                'day' => date
+              }
+            }
+            page = Gen.new(t, @site, payload)
+            page.read 
+            page.data['layout'] = @site.layouts['archive_date']
             
             page.render
             page.write