zzot-zzot-semi-static 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+===
+* Major Enhancements
+  * Switch from Hoe to Jeweler
+
+=== 0.0.0 / 2009-01-12
+* New project

data/Manifest.txt

@@ -0,0 +1,30 @@
+History.txt
+Manifest.txt
+README.markdown
+Rakefile
+bin/semi-static
+lib/semi-static.rb
+lib/semi-static/base.rb
+lib/semi-static/categories.rb
+lib/semi-static/convertable.rb
+lib/semi-static/core_ext/hash.rb
+lib/semi-static/layout.rb
+lib/semi-static/page.rb
+lib/semi-static/post.rb
+lib/semi-static/site.rb
+test/helper.rb
+test/ref/test_layout/default_layout.html
+test/ref/test_layout/post_layout.html
+test/ref/test_page/about.html
+test/ref/test_page/colophon.html
+test/ref/test_post/lighting-up.html
+test/source/_layouts/default.haml
+test/source/_layouts/post.haml
+test/source/_posts/2008-11-24-lighting-up.markdown
+test/source/_posts/2008-11-26-impressions.md
+test/source/_posts/2008-12-04-the-working-mans-typeface.html
+test/source/about.md
+test/source/colophon.md
+test/test_layout.rb
+test/test_page.rb
+test/test_post.rb

data/README.markdown

@@ -0,0 +1,84 @@
+Semi-Static
+===========
+
+Semi-Static is yet another static site generator.  I've been playing around
+with similar systems off and on for years, but its [Jekyll][] that finally
+convinced me to build (and finish) one.  The main idea that I take from
+Jekyll is using [Git][] as the “database”.  The idea from Jekyll that I'm
+ignoring completely is avoiding [Ruby][] code evaluation at all costs — I'm
+not running the thing on a server like [GitHub][] [Pages][], and it
+eliminates a few libraries that I want to use.
+
+At some point Semi-Static had a sister project, Semi-Live, that would serve
+up data from the data source dynamically, probably via [Rails][].  I stopped
+working on it not long after I first started, so don't expect to see it
+following its sister off to my [projects][] page.
+
+Features
+--------
+
+* Layouts can be [Haml][] or [ERB][] — but not [Liquid][].
+* Stylesheets can be [Sass][] or raw CSS.
+* Pages and posts can be [Maruku][] or raw HTML.
+* Code highlighting by [Pygments][].
+
+Installation
+------------
+
+The easiest way to install Semi-Static is via [RubyGems][]:
+
+    $ sudo gem install zzot-semi-static -s http://gems.github.com/
+
+Semi-Static requires the \`Haml\` and \`Maruku\` gems and the \`Pygments\`
+library to be installed.
+
+Usage
+-----
+
+    $ semi source-path \[output-path\]
+
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2009 Josh Dady
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+[*CMS]:         Content Management System
+[*CSS]:         Cascading Style Sheets
+[*HTML]:        HyperText Markup Language
+
+[semi-static]:  http://github.com/zzot/semi-static
+[jekyll]:       http://github.com/mojombo/jekyll
+[git]:          http://git-scm.com/
+[github]:       http://github.com/
+[pages]:        http://pages.github.com
+[rails]:        http://rubyonrails.org/
+[projects]:     http://github.com/zzot
+[haml]:         http://haml.hamptoncatlin.com/
+[sass]:         http://haml.hamptoncatlin.com/
+[erb]:          http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/
+[liquid]:       http://www.liquidmarkup.org/
+[maruku]:       http://maruku.rubyforge.org/
+[pygments]:     http://pygments.org/
+[rubygems]:     http://www.rubygems.org/
+[ruby]:         http://ruby-lang.org/

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 1
+:major: 0

data/bin/semi

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'semi-static')
+require 'semi-static/cli'
+
+SemiStatic::CLI.run

data/lib/semi-static.rb

@@ -0,0 +1,30 @@
+# Core requirements
+require 'erb'
+require 'tempfile'
+require 'yaml'
+
+# Gem requirements
+require 'rubygems'
+require 'haml'
+require 'sass'
+require 'maruku'
+
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+# Core extensions
+require 'semi-static/core_ext/hash'
+
+# My classes and modules
+require 'semi-static/base'
+require 'semi-static/pygmentize'
+require 'semi-static/convertable'
+require 'semi-static/layout'
+require 'semi-static/stylesheet'
+require 'semi-static/page'
+require 'semi-static/post'
+require 'semi-static/snippet'
+require 'semi-static/posts'
+require 'semi-static/index'
+require 'semi-static/categories'
+require 'semi-static/statistics'
+require 'semi-static/site'

data/lib/semi-static/base.rb

@@ -0,0 +1,74 @@
+module SemiStatic
+    # Base represents a single source file and its associated metadata.
+    # Base loads the source file, and strips and parses any metadata set
+    # in the file's header.  It stores an absolute path to the file so we
+    # can refer to it later.
+    class Base
+        ##
+        # The associated Site object
+        attr_reader :site
+        
+        ##
+        # The relative path to the source file
+        attr_reader :source_path
+        
+        ##
+        # The source file's extension
+        attr_reader :source_ext
+        
+        ##
+        # The source file's contents
+        attr_reader :source_content
+        
+        ##
+        # The metadata found in the file's header
+        attr_reader :source_metadata
+        
+        ##
+        # The absolute path to the source file
+        attr_reader :full_source_path
+        
+        ##
+        # Initializes a new Base
+        #
+        # +site+:: The Site object we belong to
+        # +path+:: The relative path to the source file
+        def initialize(site, path)
+            @site = site
+            @source_path = path
+            @source_ext = File.extname(source_path)
+            @full_source_path = File.expand_path(source_path)
+            @metadata = []
+            
+            load
+        end
+        
+        ##
+        # Get the modification time of the source file.
+        def source_mtime
+            File.mtime(@full_source_path)
+        end
+        
+      protected
+        ##
+        # Read the source file and parse any metadata in the file header.
+        def load
+            contents = File.read File.join(full_source_path)
+            if contents =~ /^(---\s*\n.*?)\n---\s*\n/m
+                @source_content, @source_metadata = contents[($1.size + 5) .. -1], YAML.load($1)
+            else
+                @source_content, @source_metadata = contents, {}
+            end
+            @source_metadata.symbolize_keys
+        end
+        
+        def method_missing(method, *args) #:nodoc:
+            name = method.to_sym
+            if @metadata.include?(name)
+                return source_metadata[name]
+            else
+                super
+            end
+        end
+    end
+end

data/lib/semi-static/categories.rb

@@ -0,0 +1,74 @@
+module SemiStatic
+    class Categories < Hash
+        def self.slugize(name)
+            name.to_s.gsub(/ /, '-').downcase.to_sym
+        end
+        
+        class Category < Array
+            attr_reader :slug, :name
+            
+            def initialize(name, slug)
+                @name, @slug = name, slug
+            end
+        end
+        
+        # def initialize
+        #     super { |hash,key| hash[key] = Category.new(key) }
+        # end
+        
+        def [](name)
+            slug = Categories.slugize name
+            category = super(slug)
+            if category.nil?
+                category = Category.new name.to_s, slug
+                self[slug] = category
+            end
+            return category
+        end
+        
+        def slugs
+            keys.sort { |l,r| l.to_s <=> r.to_s }
+        end
+        
+        def names
+            values.collect { |c| c.name }.sort { |l,r| l.to_s <=> r.to_s }
+        end
+        
+        def nested_values
+            result = Hash.new { |hash,key| hash[key] = Hash.new }
+            values.each do |item|
+                parent, child = item.slug.to_s.split '/'
+                if child.nil?
+                    result[parent.to_sym][nil] = item
+                else
+                    result[parent.to_sym][child.to_sym] = item
+                end
+            end
+            
+            result.collect do |parent_slug,items|
+                parent = items.delete(nil)
+                children = items.values.sort { |l,r| l.name.casecmp r.name }
+                
+                class << parent
+                    attr_accessor :slug, :children
+                end
+                parent.children = children
+                parent
+            end.sort { |l,r| l.name.casecmp r.name }
+        end
+        
+        def each(options={}, &block)
+            list = case options[:order]
+            when :name, nil
+                values.sort { |l,r| l.name.casecmp r.name }
+            when :count
+                values.sort { |l,r| r.count <=> l.count }
+            when :tree
+                nested_values
+            else
+                raise ArgumentError, "Unknown order: #{options[:order]}"
+            end
+            list.each(&block)
+        end
+    end
+end

data/lib/semi-static/cli.rb

@@ -0,0 +1,126 @@
+require 'optparse'
+require 'webrick'
+require 'directory_watcher'
+
+module SemiStatic
+    class CLI
+        include WEBrick
+        
+        attr_accessor :source_dir, :output_dir
+        attr_accessor :clean_first
+        attr_accessor :start_server, :server_port
+        attr_accessor :show_statistics
+        attr_accessor :use_pygments
+        attr_accessor :quick_mode
+        attr_accessor :check_mtime
+        attr_accessor :start_updater
+        
+        def initialize
+            self.clean_first     = false
+            self.start_server    = false
+            self.show_statistics = false
+            self.use_pygments    = true
+            self.quick_mode      = false
+            self.check_mtime     = true
+            self.start_updater   = false
+        end
+        
+        def self.run
+            cli = CLI.new
+            opts = OptionParser.new do |opts|
+                opts.banner = 'Usage: semi [<options>] [[<source path>] <output path>]'
+                opts.separator ''
+                opts.separator 'Options:'
+                
+                opts.on('-s', '--server [PORT]', Integer,
+                        'Start a web server (on port PORT)') do |port|
+                    cli.start_server = true
+                    cli.server_port = port || 4000
+                end
+                
+                opts.on('-a', '--[no-]auto-update', 'Automatically update generated files') do |a|
+                    cli.start_updater = a
+                end
+                
+                opts.on('-c', '--[no-]clean', 'Clean the output dir first') do |d|
+                    cli.clean_first = d
+                end
+                
+                opts.on('-t', '--[no-]stats', 'Display conversion statistics') do |t|
+                    cli.show_statistics = t
+                end
+                
+                opts.on('-p', '--[no-]pygments', 'Use Pygments for code highlighting') do |p|
+                    cli.use_pygments = p
+                end
+                
+                opts.on('-q', '--[no-]quick-mode', 'Only convert a few posts (for testing)') do |q|
+                    cli.quick_mode = q
+                end
+                
+                opts.on('-m', '--[no-]mtime', 'Skip files that appear to be up-to-date') do |m|
+                    cli.check_mtime = m
+                end
+                
+                opts.on_tail('-h', '--help', 'Show this message') do
+                    puts opts
+                    exit
+                end
+                
+                opts.on_tail('-V', '--version', 'Show version number') do
+                    path = File.join File.dirname(__FILE__), '..', '..', 'VERSION.yml'
+                    version = File.open(path) { |io| YAML.load io }
+                    puts "#{version[:major]}.#{version[:minor]}.#{version[:patch]}"
+                end
+            end
+            opts.parse!
+            
+            case ARGV.size
+            when 0
+                cli.source_dir = '.'
+                cli.output_dir = 'site'
+            when 1
+                cli.source_dir = '.'
+                cli.output_dir = ARGV[0]
+            when 2
+                cli.source_dir = ARGV[0]
+                cli.output_dir = ARGV[1]
+            else
+                puts 'Invalid options.  Run `semi --help` for assistance.'
+                exit 1
+            end
+            
+            cli.run
+        end
+        
+        def run
+            Pygmentize.enabled = use_pygments
+            SemiStatic::Site.open(source_dir) do |site|
+                site.clean_first     = clean_first
+                site.show_statistics = show_statistics
+                site.quick_mode      = quick_mode
+                site.check_mtime     = check_mtime
+                
+                site.output output_dir
+                if start_updater
+                    updater = DirectoryWatcher.new(source_dir)
+                    updater.interval = 1
+                    updater.glob = '{indices,layouts,pages,posts,snippets,stylesheets}/**/*'
+                    updater.add_observer do |*args|
+                        puts "[#{Time.now}] #{args.length} files changed."
+                        site.output output_dir
+                    end
+                    updater.start
+                    sleep 0 unless start_server
+                end
+                if start_server
+                    server = HTTPServer.new :DocumentRoot => output_dir,
+                                            :Port => server_port
+                    thread = Thread.new { server.start }
+                    trap('INT') { server.shutdown }
+                    thread.join
+                end
+            end
+        end
+    end
+end

data/lib/semi-static/convertable.rb

@@ -0,0 +1,94 @@
+module SemiStatic
+    module Convertable
+        include ERB::Util
+        
+        def load
+            @content = nil
+            if layout
+                layout.load
+            end
+            super
+        end
+        
+        def content(options={})
+            return @content unless @content.nil?
+            
+            options = { :page => self }.merge(options)
+            for name, value in options
+                eval "#{name.to_s} = options[name]"
+            end
+
+            site.stats.record(self.class.name.split('::').last, source_path) do
+                case self.source_ext
+                when '.md', '.markdown'
+                    @content = Maruku.new(self.source_content).to_html
+                when '.haml'
+                    Haml::Engine.new(self.source_content, :filename => source_path).render(binding)
+                when '.erb'
+                    ERB.new(self.source_content, nil, '-').result(binding)
+                when '.html'
+                    self.source_content
+                else
+                    raise ArgumentError, "Unsupported format: #{self.source_path}"
+                end
+            end
+        end
+        
+        def layout_name
+            unless source_metadata.nil? || !source_metadata.include?(:layout)
+                source_metadata[:layout].to_sym
+            end
+        end
+        
+        def layout
+            if layout_name.nil?
+                return nil
+            else
+                return site.layouts[layout_name.to_sym]
+            end
+        end
+        
+        def source_mtime
+            mtime = super
+            if layout && layout.source_mtime > mtime
+                mtime = layout.source_mtime
+            end
+            return mtime
+        end
+        
+        def render(options={})
+            content = self.content(options)
+            if layout
+                options = { :page => self }.merge options
+                content = layout.render(options.merge( :content => content ))
+            end
+            return content
+        end
+        
+        def snippet(name)
+            name = name.to_s
+            site.snippets[name].render :page => self
+        end
+        
+        # This method is adapted from Haml::Buffer#parse_object_ref -- it's
+        # used to make it easier for Haml and ERB layouts to generate the
+        # same output so I can use the same test output for both.
+        def object_ref(object)
+            return '' if object.nil?
+            name = underscore(object.class)
+            id = "#{name}_#{object.id || 'new'}"
+            return "class='#{name}' id='#{id}'"
+        end
+        
+        # Changes a word from camel case to underscores.  Based on the method
+        # of the same name in Rails' Inflector, but copied here so it'll run
+        # properly without Rails.
+        def underscore(camel_cased_word)
+            camel_cased_word.to_s.gsub(/::/, '_').
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            tr("-", "_").
+            downcase
+        end
+    end
+end