RubyGems - henshin - Versions diffs - 0.2.1 → 0.2.2 - Mend

henshin 0.2.1 → 0.2.2

Files changed (30) hide show

data/VERSION +1 -1
data/bin/henshin +149 -73
data/henshin.gemspec +8 -3
data/lib/henshin/ext.rb +42 -0
data/lib/henshin/gen.rb +64 -44
data/lib/henshin/plugin.rb +4 -0
data/lib/henshin/plugins/maruku.rb +1 -1
data/lib/henshin/plugins/sass.rb +9 -8
data/lib/henshin/plugins/textile.rb +21 -0
data/lib/henshin/post.rb +8 -6
data/lib/henshin/site.rb +11 -64
data/lib/henshin.rb +26 -19
data/test/helper.rb +4 -1
data/test/site/_site/2010/10/20-testing-stuff/index.html +2 -2
data/test/site/_site/css/print.css +10 -24
data/test/site/_site/index.html +29 -10
data/test/site/{sass → css}/print.sass +0 -0
data/test/site/index.html +2 -3
data/test/site/options.yaml +2 -2
data/test/site/posts/Testing-Stuff.markdown +2 -2
data/test/site/posts/Textile-Test.textile +7 -0
data/test/site/posts/cat/test.markdown +1 -1
data/test/site/posts/same-date.markdown +7 -0
data/test/test_gens.rb +33 -0
data/test/test_henshin.rb +1 -24
data/test/test_layouts.rb +1 -5
data/test/test_options.rb +36 -7
data/test/test_posts.rb +25 -4
data/test/test_site.rb +36 -0
metadata +9 -4

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.2.1
1	+ 0.2.2

data/bin/henshin CHANGED Viewed

@@ -2,98 +2,174 @@
 require File.dirname(__FILE__) + '/../lib/henshin'
 require 'optparse'
+require 'fileutils'
 banner = <<EOS
-Usage: henshin
-       henshin [path to source]
-       henshin [path to source]:[path to write]
+Usage: henshin
+       henshin [source]
+       henshin [source]:[destination]
+       henshin create
+       henshin create [path for site]
 EOS
+opt_content = <<EOS
+title: Test Site
+author: John Doe
+layout: main
+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
+index_content = <<EOS
+---
+title: The Home Page
+---
+Well you might want to change this!
+EOS
+layout_content = <<EOS
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title>{{ site.title }}</title>
+  </head>
+  <body>
-end
-opts.parse!
+    {{ yield }}
+    <h4>A List of Posts</h4>
+    <ul>
+      {% for post in site.posts %}
+        <li><a href="{{ post.url }}">{{ post.title }}</a> - {{ post.date }}</li>
+      {% endfor %}
+    </ul>
+    <span>Copyright &copy; {{ site.author }}</span>
+  </body>
+</html>
+EOS
-if ARGV[0]
-  override[:root] = ARGV[0].split(':')[0]
-  override[:target] = ARGV[0].split(':')[1] if ARGV[0].split(':')[1]
-end
+post_content = <<EOS
+---
+title: Hello World
+date: #{Time.now.strftime("%Y-%m-%d at %H:%M:%S")}
+tags: test, hello
+---
+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.
+EOS
-config = Henshin.configure(override)
-site = Henshin::Site.new(config)
+if ARGV[0] == "create"
+  if ARGV[1]
+    # create the directory
+    FileUtils.mkdir_p ARGV[1]
+    # and cd to it
+    Dir.chdir ARGV[1]
+  end
+  # create directories
+  dirs = ['layouts', 'posts']
+  dirs.each {|d| FileUtils.mkdir_p d}
-# build normally
-puts "Building site..."
-site.build
-puts "Site created in #{config[:target]}"
+  # write files
+  files = {'options.yaml' => opt_content,
+           'index.html' => index_content,
+           'layouts/main.html' => layout_content,
+           'posts/hello-world.markdown' => post_content}
+  files.each do |f, c|
+    file = File.new( f, "w" )
+    file.puts c
+  end
+else
-# 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) )}
+  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
-  gl.collect! {|x| "#{x}/**/*"}
-  gl += ['*']
+  opts.parse!
-  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
+  if ARGV[0]
+    override[:root] = ARGV[0].split(':')[0]
+    override[:target] = ARGV[0].split(':')[1] if ARGV[0].split(':')[1]
   end
-  dw.start
-  unless build[:server]
-    loop {sleep 1000}
-  end
-end
-# start a server
-if build[:server]
-  require 'webrick'
+  config = Henshin.configure(override)
+  site = Henshin::Site.new(config)
-  server = WEBrick::HTTPServer.new(
-    :Port => '3000',
-    :DocumentRoot => File.join(config[:root], config[:target]),
-    :MimeTypes => WEBrick::HTTPUtils::DefaultMimeTypes
-  )
+  start = Time.now
+  # build normally
+  puts "Building site..."
+  site.build
+  puts "Site created in #{config[:target]} (#{Time.now - start}s)"
-  thread = Thread.new { server.start }
-  trap("INT") { server.shutdown }
-  thread.join()
-end
+  # 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
+end

data/henshin.gemspec CHANGED Viewed

@@ -5,11 +5,11 @@
 Gem::Specification.new do |s|
   s.name = %q{henshin}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["hawx"]
-  s.date = %q{2010-05-31}
+  s.date = %q{2010-06-06}
   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}
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
      "lib/henshin/plugins/maruku.rb",
      "lib/henshin/plugins/pygments.rb",
      "lib/henshin/plugins/sass.rb",
+     "lib/henshin/plugins/textile.rb",
      "lib/henshin/post.rb",
      "lib/henshin/site.rb",
      "lib/henshin/static.rb",
@@ -45,6 +46,7 @@ Gem::Specification.new do |s|
      "test/site/_site/css/print.css",
      "test/site/_site/index.html",
      "test/site/_site/static.html",
+     "test/site/css/print.sass",
      "test/site/css/screen.css",
      "test/site/index.html",
      "test/site/layouts/category_index.html",
@@ -56,10 +58,12 @@ Gem::Specification.new do |s|
      "test/site/options.yaml",
      "test/site/plugins/test.rb",
      "test/site/posts/Testing-Stuff.markdown",
+     "test/site/posts/Textile-Test.textile",
      "test/site/posts/cat/test.markdown",
      "test/site/posts/lorem-ipsum.markdown",
-     "test/site/sass/print.sass",
+     "test/site/posts/same-date.markdown",
      "test/site/static.html",
+     "test/test_gens.rb",
      "test/test_henshin.rb",
      "test/test_layouts.rb",
      "test/test_options.rb",
@@ -74,6 +78,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
      "test/site/plugins/test.rb",
+     "test/test_gens.rb",
      "test/test_henshin.rb",
      "test/test_layouts.rb",
      "test/test_options.rb",

data/lib/henshin/ext.rb CHANGED Viewed

@@ -84,4 +84,46 @@ class String
     self.dup.gsub(/([a-zA-Z0-9_-]+\/)/, '')
   end
+  # Methods to determine whether the file at the path is a post, layout, gen or static
+  # @param [Hash] config
+  # @return [Bool]
+  # @todo see #ignored?
+  def static?( config )
+    !( self.layout? || self.post? || self.gen?(config) || self.ignored?(config) )
+  end
+  # @return [Bool]
+  def layout?
+    self.include? 'layouts/'
+  end
+  # @return [Bool]
+  def post?
+    self.include? 'posts/'
+  end
+  # @param [Hash] config
+  # @return [Bool]
+  # @todo see #ignored?
+  def gen?( config )
+    return true if config[:plugins][:generators].has_key? self.extension
+    return true if File.open(self, "r").read(3) == "---"
+    false
+  end
+  # @param [Hash] config
+  # @return [Bool]
+  # @todo Find a way around having to pass the config in
+  def ignored?( config )
+    ignored = ['/options.yaml'] + config[:exclude]
+    ignored.collect! {|i| File.join(config[:root], i)}
+    ignored.each do |i|
+      return true if self.include? i
+    end
+    false
+  end
 end

data/lib/henshin/gen.rb CHANGED Viewed

@@ -4,9 +4,9 @@ module Henshin
   class Gen
     attr_accessor :path, :extension, :content, :layout, :date, :title
-    attr_accessor :site, :config, :renderer, :data
+    attr_accessor :site, :config, :renderer, :data, :output
-    def initialize( path, site, data={} )
+    def initialize( path, site, data=nil )
       @path = path
       @site = site
       @config = site.config
@@ -38,78 +38,98 @@ module Henshin
     #
     # @param [Hash] override data to override settings with
     def override( override )
-      @layout ||= @site.layouts[ override[:layout] ]
-      @date ||= Time.parse( override[:date].to_s )
+      @title  = override[:title]                    if override[:title]
+      @layout = @site.layouts[ override[:layout] ]  if override[:layout]
+      @date   = Time.parse( override[:date].to_s )  if override[:date]
     end
     ##
     # Renders the files content
     def render
-      # render the posts content
-      config[:plugins].each do |plugin|
-        if plugin.extensions[:input].include?( @extension ) && plugin.is_a?( Generator )
-          @content = plugin.generate( @content )
-          @renderer = plugin
-        end
-      end
-      @renderer ||= StandardPlugin.new
+      ignore_layout = false
+      if config[:plugins][:generators].has_key? @extension
+        plugin = config[:plugins][:generators][@extension]
+        @content = plugin.generate( @content )
+        @output = plugin.extensions[:output]
+        ignore_layout = true if plugin.config[:ignore_layouts]
+      end
       @layout ||= site.layouts[ site.config[:layout] ]
-      unless @renderer.config[:ignore_layouts]
-        # do the layout
-        config[:plugins].each do |plugin|
-          if plugin.is_a?( LayoutParser )
-            @content = plugin.generate( @layout, self.payload )
-          end
+      unless ignore_layout || @layout.nil?
+        config[:plugins][:layout_parsers].each do |plugin|
+          @content = plugin.generate( @layout, self.payload )
         end
       end
     end
-    # Creates the data to be sent to the layout engine. Uses optional data if available
+    # Creates the data to be sent to the layout engine. Adds optional data if available
     #
     # @return [Hash] the payload for the layout engine
     def payload
-      if @data == {}
-        {
-          'yield' => @content,
-          'site' => @site.payload['site']
-        }
-      else
-        {
-          'yield' => @content,
-          'site' => @site.payload['site'],
-          @data[:name] => @data[:payload]
-        }
-      end
+      hash = {
+        'yield' => @content,
+        'gen'   => self.to_hash,
+        'site'  => @site.payload['site'],
+      }
+      hash[ @data[:name] ] = @data[:payload] if @data
+      hash
+    end
+    # Turns all of the post data into a hash
+    #
+    # @return [Hash]
+    def to_hash
+      {
+        'title'      => @title,
+        'permalink'  => self.permalink,
+        'url'        => self.url,
+        'date'       => @date,
+        'content'    => @content
+      }
     end
     ##
     # Writes the file to the correct place
     def write
       write_path = File.join( config[:root], config[:target], @path[config[:root].size..-1] )
-      render_target = @renderer.config[:target] if @renderer
-      if render_target
-        # files should be put in a different folder
-        write_path.gsub!("/#{@renderer.config[:root]}", "/#{@renderer.config[:target]}")
-      end
-      render_type = @renderer.extensions[:output] if @renderer
-      if render_type != ''
-        # files should have different extension
-        write_path.gsub!(".#{@extension}", ".#{render_type}")
-      end
+      # change extension if necessary
+      write_path.gsub!(".#{@extension}", ".#{@output}") if @output
       FileUtils.mkdir_p File.join( write_path.directory )
       file = File.new( File.join( write_path ), "w" )
       file.puts( @content )
+    end
+    # Returns the permalink for the gen
+    def permalink
+      @path[config[:root].size..-1]
+    end
+    # Returns the (pretty) url for the gen
+    def url
+      if config[:permalink].include? "/index.html"
+        self.permalink[0..-11]
+      else
+        self.permalink
+      end
     end
+    # Needed to sort the posts by date, newest first
+    def <=>( val )
+      s = self.date <=> val.date
+      if s == 0
+        return self.permalink <=> val.permalink
+      else
+        return -1 * s
+      end
+    end
     def inspect
       "#<Gen:#{@path}>"

data/lib/henshin/plugin.rb CHANGED Viewed

@@ -16,6 +16,10 @@ module Henshin
       @config = {}
     end
+    # def configure( override )
+      # setup the plugin
+    # end
     # Uncomment to have the plugin loaded
     # Henshin.register! self
   end

data/lib/henshin/plugins/maruku.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 require 'henshin/plugin'
 require 'maruku'
-class MarukuPlug < Henshin::Generator
+class MarukuPlugin < Henshin::Generator
   attr_accessor :extensions, :config

data/lib/henshin/plugins/sass.rb CHANGED Viewed

@@ -1,20 +1,21 @@
 require 'henshin/plugin'
-require 'haml'
-require 'sass/engine'
+require 'sass'
 class SassPlugin < Henshin::Generator
-  attr_accessor :extensions, :config
+  attr_accessor :extensions, :config, :opts_name
-  Defaults = {:target => 'css',
-              :root => 'sass',
-              :ignore_layouts => true,
+  Defaults = {:ignore_layouts => true,
               :style => :nested}
-  def initialize( override={} )
+  def initialize
     @extensions = {:input => ['sass', 'scss'],
                    :output => 'css'}
-    @config = Defaults.merge(override)
+    @opts_name = :sass
+  end
+  def configure( override )
+    override ? @config = Defaults.merge(override) : @config = Defaults
   end
   def generate( content )

data/lib/henshin/plugins/textile.rb ADDED Viewed

@@ -0,0 +1,21 @@
+require 'henshin/plugin'
+require 'redcloth'
+class TextilePlugin < Henshin::Generator
+  attr_accessor :extensions, :config
+  Defaults = {}
+  def initialize( override={} )
+    @extensions = {:input => ['textile'],
+                   :output => 'html'}
+    @config = Defaults.merge(override)
+  end
+  def generate( content )
+    RedCloth.new(content).to_html
+  end
+  Henshin.register! self
+end

data/lib/henshin/post.rb CHANGED Viewed

@@ -25,17 +25,18 @@ module Henshin
     # Reads the filename and extracts information from it
     def read_name
       parser = {'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' => "(#{ site.config[:extensions].join('|') })"}
+                'extension' => "([a-zA-Z0-9_-]+)"}
       file_parser = config[:file_name]
       data_order = []
       # put together regex
       m = file_parser.gsub(/\{([a-z-]+)\}/) do
         data_order << $1
@@ -53,7 +54,7 @@ module Henshin
       matcher = Regexp.new(m)
       override = {}
-      name = path[ (config[:root]+'/posts/').size..-1 ]
+      name = @path[ (config[:root]+'/posts/').size..-1 ]
       file_data = name.match( matcher ).captures
       file_data.each_with_index do |data, i|
@@ -113,8 +114,8 @@ module Henshin
     def payload
       {
         'yield' => @content,
-        'site' => @site.payload['site'],
-        'post' => self.to_hash
+        'site'  => @site.payload['site'],
+        'post'  => self.to_hash
       }
     end
@@ -125,7 +126,8 @@ module Henshin
       {
         'title'      => @title,
         'author'     => @author,
-        'url'        => self.permalink,
+        'permalink'  => self.permalink,
+        'url'        => self.url,
         'date'       => @date,
         'category'   => @category,
         'tags'       => @tags,