zzot-semi-static 0.0.2 → 0.0.3

data/README.rdoc

@@ -0,0 +1,63 @@
+= Semi Static
+
+Semi Static is yet another static site generator.  I've been playing around
+with similar systems off and on for years, but it's
+Jekyll[http://github.com/mojombo/jekyll] that finally convinced me to build
+(and finish) one for myself.  The main idea that I take from Jekyll is using
+Git[http://git-scm.com/] as the database.  The idea from Jekyll that I'm not
+adopting is avoiding Ruby[http://ruby-lang.org/] code evaluation at all
+costs -- I'm not letting other people feed documents into it (as
+GitHub[http://github.com/] Pages[http://pages.github.com] does), so I don't
+need to protect myself from them.
+
+At some point Semi Static had a sister project, Semi Live, that would generate
+the site dynamically (probably via Rails[http://rubyonrails.org/]).  I stopped
+working on it not long after I first started, so don't expect to see it on my
+projects[http://github.com/zzot] page.
+
+== Features
+
+* Layouts can be Haml[http://haml.hamptoncatlin.com/] or
+  ERB[http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/] -- but not
+  Liquid[http://www.liquidmarkup.org/].
+* Stylesheets can be Sass[http://haml.hamptoncatlin.com/] or raw CSS.
+* Pages and posts can be Maruku[http://maruku.rubyforge.org/] or raw HTML.
+* Code highlighting by Pygments[http://pygments.org/].
+
+== Installation
+
+The easiest way to install Semi-Static is via RubyGems[http://www.rubygems.org/]:
+
+    $ 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.

data/VERSION.yml

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

data/lib/semi-static.rb

@@ -1,6 +1,7 @@
 # Core requirements
 require 'erb'
 require 'tempfile'
+require 'time'
 require 'yaml'
 
 # Gem requirements
@@ -25,6 +26,72 @@ require 'semi-static/post'
 require 'semi-static/snippet'
 require 'semi-static/posts'
 require 'semi-static/index'
-require 'semi-static/categories'
+require 'semi-static/tags'
 require 'semi-static/statistics'
 require 'semi-static/site'
+
+##
+# Semi Static is yet another static site generator.  I've been playing around
+# with similar systems off and on for years, but it's
+# Jekyll[http://github.com/mojombo/jekyll] that finally convinced me to build
+# (and finish) one for myself.  The main idea that I take from Jekyll is using
+# Git[http://git-scm.com/] as the database.  The idea from Jekyll that I'm not
+# adopting is avoiding Ruby[http://ruby-lang.org/] code evaluation at all
+# costs -- I'm not letting other people feed documents into it (as
+# GitHub[http://github.com/] Pages[http://pages.github.com] does), so I don't
+# need to protect myself from them.
+# 
+# At some point Semi Static had a sister project, Semi Live, that would generate
+# the site dynamically (probably via Rails[http://rubyonrails.org/]).  I stopped
+# working on it not long after I first started, so don't expect to see it on my
+# projects[http://github.com/zzot] page.
+# 
+# == Features
+# 
+# * Layouts can be Haml[http://haml.hamptoncatlin.com/] or
+#   ERB[http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/] -- but not
+#   Liquid[http://www.liquidmarkup.org/].
+# * Stylesheets can be Sass[http://haml.hamptoncatlin.com/] or raw CSS.
+# * Pages and posts can be Maruku[http://maruku.rubyforge.org/] or raw HTML.
+# * Code highlighting by Pygments[http://pygments.org/].
+# 
+# == Installation
+# 
+# The easiest way to install Semi-Static is via RubyGems[http://www.rubygems.org/]:
+# 
+#     $ 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.
+
+module SemiStatic
+end

data/lib/semi-static/base.rb

@@ -1,8 +1,7 @@
 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.
+    # Base is a single source file and its associated metadata.  Base loads
+    # itself from the source file and strips off and parses the metadata in
+    # the file's header.
     class Base
         ##
         # The associated Site object

data/lib/semi-static/convertable.rb

@@ -1,8 +1,10 @@
 module SemiStatic
+    ##
+    # Support conversion of the source file into another format.
     module Convertable
         include ERB::Util
         
-        def load
+        def load #:nodoc:
             @content = nil
             if layout
                 layout.load
@@ -10,6 +12,8 @@ module SemiStatic
             super
         end
         
+        ##
+        # Format the source file.
         def content(options={})
             return @content unless @content.nil?
             
@@ -25,7 +29,9 @@ module SemiStatic
                 when '.haml'
                     Haml::Engine.new(self.source_content, :filename => source_path).render(binding)
                 when '.erb'
-                    ERB.new(self.source_content, nil, '-').result(binding)
+                    erb = ERB.new self.source_content, nil, '-'
+                    erb.filename = source_path
+                    erb.result(binding)
                 when '.html'
                     self.source_content
                 else
@@ -34,13 +40,13 @@ module SemiStatic
             end
         end
         
-        def layout_name
+        def layout_name #:nodoc:
             unless source_metadata.nil? || !source_metadata.include?(:layout)
                 source_metadata[:layout].to_sym
             end
         end
         
-        def layout
+        def layout #:nodoc:
             if layout_name.nil?
                 return nil
             else
@@ -48,6 +54,9 @@ module SemiStatic
             end
         end
         
+        ##
+        # Add the layout used (if any) to the list of files used to determine
+        # the objects modification time.
         def source_mtime
             mtime = super
             if layout && layout.source_mtime > mtime
@@ -56,6 +65,8 @@ module SemiStatic
             return mtime
         end
         
+        ##
+        # Wrap the formatted source file in the Layout (if any).
         def render(options={})
             content = self.content(options)
             if layout
@@ -65,6 +76,8 @@ module SemiStatic
             return content
         end
         
+        ##
+        # Helper method used to insert a Snippet into the formatted output.
         def snippet(name)
             name = name.to_s
             site.snippets[name].render :page => self
@@ -73,7 +86,7 @@ module SemiStatic
         # 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)
+        def object_ref(object) #:nodoc:
             return '' if object.nil?
             name = underscore(object.class)
             id = "#{name}_#{object.id || 'new'}"
@@ -83,7 +96,7 @@ module SemiStatic
         # 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)
+        def underscore(camel_cased_word) #:nodoc:
             camel_cased_word.to_s.gsub(/::/, '_').
             gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
             gsub(/([a-z\d])([A-Z])/,'\1_\2').

data/lib/semi-static/index.rb

@@ -1,9 +1,27 @@
 module SemiStatic
+    ##
+    # Index is used to generate several site index pages that don't have a
+    # fixed path (i.e., the yearly index pages) from a single source file.
+    # It can have a Layout and use any number of Snippets.  Index's modification
+    # time is the most recent of itself, its layout, and any Snippets used.
+    # Indices are also considered out-of-date if any posts in the index's range
+    # are changed.
     class Index < Base
         include Convertable
         
-        attr_accessor :posts, :context
+        ##
+        # Posts in range for the Index's current path.
+        attr_accessor :posts
         
+        ##
+        # The Index's current context (usually a Date).
+        attr_accessor :context
+        
+        ##
+        # Initializes a new Index
+        #
+        # +site+:: The Site object we belong to
+        # +path+:: The relative path to the source file
         def initialize(site, path)
             super
             @metadata = [ :layout ]

data/lib/semi-static/layout.rb

@@ -1,9 +1,18 @@
 module SemiStatic
+    ##
+    # Layout embeds the formatted output of a Convertable within a large document.
     class Layout < Base
         include Convertable
         
+        ##
+        # The Layout's name
         attr_reader :name
         
+        ##
+        # Initialize a new Layout
+        #
+        # +site+: The Site we belong to.
+        # +path+: The path to the source file.
         def initialize(site, path)
             super
             @metadata = [ :layout ]

data/lib/semi-static/post.rb

@@ -10,10 +10,6 @@ module SemiStatic
         # The Post's name
         attr_reader :name
         
-        ##
-        # The Post's Category
-        attr_reader :category
-        
         ##
         # The Post's Tags
         attr_reader :tags
@@ -57,9 +53,6 @@ module SemiStatic
             
             @name = File.basename(source_path, source_ext)
             
-            @category = site.categories[source_metadata[:category]]
-            @category << self
-            
             @tags = []
             unless source_metadata[:tags].nil?
                 for tag in source_metadata[:tags]
@@ -92,20 +85,6 @@ module SemiStatic
             return "#{uri}"
         end
         
-        # def comments_link
-        #     "#{uri}#comments"
-        # end
-        # 
-        # def comment_count
-        #     0
-        # end
-        
-        ##
-        # Formatted date the Post was published (i.e., "March 15, 2009")
-        def date
-            created.strftime '%B %e, %Y'
-        end
-        
         ##
         # Year the Post was published as a String (i.e., "2009")
         def year

data/lib/semi-static/posts.rb

@@ -1,7 +1,27 @@
 module SemiStatic
+    ##
+    # Collection of Posts for the current site.
     class Posts
-        attr_reader :site, :posts, :names, :indices
+        ##
+        # The Site object we belong to.
+        attr_reader :site
         
+        ##
+        # The raw list of posts.
+        attr_reader :posts
+        
+        ##
+        # Posts indexed by name.
+        attr_reader :names
+        
+        ##
+        # Indices that correspond to the Posts.
+        attr_reader :indices
+        
+        ##
+        # Initializes a new Posts
+        #
+        # +site+: The Site we belong to.
         def initialize(site)
             @site = site
             @posts = []
@@ -9,8 +29,14 @@ module SemiStatic
             @indices = Set.new
         end
         
+        ##
+        # The format of the Date portion of a post's filename.
         NAME_RE = /^([0-9]{4})-([0-9]{2})-([0-9]{2})-(.*)/
         
+        ##
+        # Parse the given file as a Post and add it to the list.
+        #
+        # +source_path+: Path to the source file
         def <<(source_path)
             unless File.file?(source_path)
                 $stderr.puts "[#{source_path}]"
@@ -28,6 +54,10 @@ module SemiStatic
             end
         end
         
+        ##
+        # Truncate the list of Posts to the given number (to speed up testing).
+        #
+        # +count+: The number of posts to keep.
         def chop!(count)
             raise ArgumentError unless count > 0
             posts = self.posts.first(count)
@@ -43,10 +73,16 @@ module SemiStatic
             end
         end
         
+        ##
+        # Number of posts.
         def length
             self.posts.length
         end
         
+        ##
+        # Fetch the least recent posts.
+        #
+        # +n+: Number of Posts to return.
         def first(n=nil)
             if n.nil?
                 self.posts.first
@@ -55,6 +91,10 @@ module SemiStatic
             end
         end
         
+        ##
+        # Fetch the most recent posts.
+        #
+        # +n+: Number of Posts to return.
         def last(n=nil)
             if n.nil?
                 self.posts.last
@@ -63,6 +103,8 @@ module SemiStatic
             end
         end
         
+        ##
+        # Fetch the Posts for the given Date range.
         def from(year, month=nil, day=nil)
             if year.is_a?(String) && month.nil? && day.nil?
                 date = year.split('/', 3)
@@ -95,15 +137,21 @@ module SemiStatic
             return result
         end
         
+        ##
+        # Get the post with the given name.
         def [](name)
             return self.names[name]
         end
         
-        def each(&block)
+        ##
+        # Iterate over all posts.
+        def each(&block) # :yields: Post
             self.posts.each(&block)
         end
         
-        def each_index(&block)
+        ##
+        # Iterate over all indices.
+        def each_index(&block) # :yields: String
             indices.each(&block)
         end
     end