hobix 0.6

data/lib/hobix.rb

@@ -0,0 +1,230 @@
+#
+# = hobix.rb
+#
+# Hobix command-line weblog system.
+#
+# Copyright (c) 2003-2004 why the lucky stiff
+#
+# Written & maintained by why the lucky stiff <why@ruby-lang.org>
+#
+# This program is free software, released under a BSD license.
+# See COPYING for details.
+#
+#--
+# $Id$
+#++
+require 'hobix/config'
+require 'hobix/weblog'
+require 'rbconfig'
+
+# = Hobix
+#
+# Hobix is a complete blogging system, designed to be managed
+# on the file system and accessed through a command-line application.
+# 
+# The command-line application is powered by this Ruby library
+# which is designed to be fully scriptable and extensible.  
+#
+# = Module Map
+#
+# Here is a map of the core modules which are loaded when you
+# require 'hobix' in your script.
+#
+# Hobix::Weblog::       Generally, this module is the starting point.
+#                       Load a weblog's configuration into a Hobix::Weblog
+#                       object, which can be used to query entries, 
+#                       generate pages, and edit any part of the site.
+#                       (from 'hobix/weblog')
+#
+# Hobix::Page::         Whenever a template is generated into output,
+#                       a Page object is passed in, describing the
+#                       links to neighboring pages and update time.
+#                       (from 'hobix/weblog')
+#
+# Hobix::Entry::        Using an entry's id (or shortName), you can
+#                       load Entry objects, which contain all the
+#                       content and rendering details for an entry.
+#                       (from 'hobix/entry')
+#
+# Hobix::EntryEnum::    When Hobix supplies a template with a list of
+#                       entry classes, this module is mixed in.
+#                       (from 'hobix/entry')
+#
+# Hobix::LinkList::     An Entry subclass, used for storing links.
+#                       (from 'hobix/linklist')
+#
+# Hobix::BasePlugin::   All Hobix plugins inherit from this class.
+#                       The class uses Ruby's +inherited+ hook to
+#                       identify plugins.
+#                       (from 'hobix/base')
+#
+# Hobix::BaseStorage::  All storage plugins inherit from this class.
+#                       Storage plugins exclusively store the weblog entries.
+#                       (from 'hobix/base')
+#
+# Hobix::BaseOutput::   All output plugins inherit from this class.
+#                       Output plugins are attached to specific template
+#                       types and they feed entries into the template.
+#                       (from 'hobix/base')
+#
+# Hobix::BasePublish::  All publisher plugins inherit from this class.
+#                       Publisher plugins are notified when certain
+#                       pages are updated.  For example, the +ping+
+#                       plugin will ping blog directories if the `index'
+#                       pages are updated.
+#                       (from 'hobix/base')
+#
+# Hobix::Config::       Users individually store their personal settings
+#                       and weblog paths in .hobixrc.  This class
+#                       is used to load and manipulate the settings file.
+#                       (from 'hobix/config')
+#
+# Hobix comes with a few plugins, for which documentation is also
+# available.
+#
+# Hobix::Storage::Filesys::  This plugin stores entries in separate YAML
+#                            files.  Directories can be used to categorize
+#                            and organize entries.
+#                            (from 'hobix/storage/filesys')
+#
+# Hobix::Out::ERB::          This output plugin handles .erb templates.
+#                            Page and entry data are passed in as variables.
+#                            ERuby markup is used in the document to script
+#                            against those variables.
+#                            (from 'hobix/out/erb')
+#
+# Hobix::Out::RedRum::       This output plugin handles .redrum templates.
+#                            These templates contain ERuby as well.  The output
+#                            generated by the page is passed through RedCloth,
+#                            a Textile processor.  This way, you can write
+#                            your templates in Textile with ERuby scripting.
+#                            (from 'hobix/out/redrum')
+#
+# Hobix::Out::RSS::          This output plugin handles .rss templates.
+#                            These templates are empty and simply signify to
+#                            the plugin that an RSS 2.0 feed should be generated
+#                            for the entry data.
+#                            (from 'hobix/out/rss')
+#
+# Hobix::Out::Atom::         This output plugin handles .atom templates.
+#                            Just like the RSS plugin, but generates an Atom feed.
+#                            (from 'hobix/out/atom')
+#
+# Hobix::Out::OkayNews::     This output plugin handles .okaynews templates.
+#                            Just like the Atom and RSS plugins, but generates
+#                            !okay/news, a YAML syndication feed.
+#                            (from 'hobix/out/okaynews')
+#
+# Hobix::Publish::Ping::     This publisher plugin pings blog directories when the
+#                            'index' pages are published on a regen or upgen.
+#
+# = Examples
+#
+# Here are a few short examples to give you a feel for how Hobix can be
+# scripted.  Refer to individual module's documentation for more.
+#
+# == Example 1: Regenerating a weblog
+# 
+# The first step is to load the Weblog object.
+#
+#   require 'hobix'
+#   weblog = Hobix::Weblog.load( '/my/blahhg/hobix.yaml' )
+#
+# With the weblog loaded, we'll now want to load a template.
+# Templates are stored in the weblog's +skel_path+ accessor.
+#
+#   tpl_path = File.join( weblog.skel_path, 'index.html.erb' )
+#
+# We give the path to the editor.  When we are done editing,
+# the editor saves to the original path.  We can then trigger
+# a rebuild.
+#
+#   weblog.regenerate :update
+#
+# The :update indicates that not every file will be regenerated,
+# only those affected by the change.
+#
+# == Example 2: E-mail notify on publish
+#
+# Publisher plugins are used to perform actions when the site
+# has an upgen or regen.  Hobix plugins are absolutely the simplest
+# Ruby coding ever.  Watch.
+#
+#   require 'net/smtp'
+#
+#   module Hobix::Publish
+#   class Email < Hobix::BasePublish
+#     def initialize( weblog, emails ); end
+#     def watch; ['entry']; end
+#     def publish( page_name ); end
+#   end
+#   end
+#
+# This plugin doesn't do anything yet.  But it won't throw any errors.
+# This is our skeleton for a plugin that will e-mail us when there are
+# updates to the site.
+#
+# The +watch+ method monitors certain page prefixes.  The `entry' prefix
+# indicates that this publish plugin looks for changes to any entry on
+# the site.
+#
+# The +initialize+ method is important as well.  It receives the
+# +Hobix::Weblog+ object the publishing took place on.  The _emails_
+# parameter is supplied a list of e-mail address from the weblog's
+# hobix.yaml configuration.
+#
+# When a plugin is initialized it is given the weblog object and
+# any data which is supplied in the weblog configuration.  Here is
+# what the hobix.yaml looks like:
+#
+#   requires:
+#     - hobix/storage/filesys
+#     - hobix/out/erb
+#     - hobix/publish/ping: [http://ping.blo.gs:80/]
+#
+# In the above configuration, an Array is passed to the Ping plugin.
+# So that's what we'll receive here.
+#
+# To get our e-mail sending, let's fill in the +initialize+ and
+# +publish+ methods.
+#
+#   def initialize( weblog, emails )
+#     @weblog = weblog
+#     @emails = emails
+#   end
+#   def publish( page_name )
+#     Net::SMTP.start( 'localhost', 25 ) do |smtp|
+#       @emails.each do |email|
+#         smtp.send_message <<MSG, 'your@site.com', email
+#   From: your@site.com
+#   To: #{ email }
+#
+#   The site has been updated.
+#   MSG
+#       end
+#     end    
+#   end
+#
+
+module Hobix
+    ## Version used to compare installations
+    VERSION = '0.5'
+    ## CVS information
+    CVS_ID = "$Id$"
+    CVS_REV = "$Revision$"[11..-3]
+    ## Share directory contains external data files
+    share_path = File.expand_path('../../share', __FILE__)
+    if File.exists? share_path
+        SHARE_PATH = share_path
+    else
+        SHARE_PATH = "#{ ::Config::CONFIG['datadir'] }/hobix/"
+    end 
+
+    ## Get a top-level constant from a string
+    def self.const_find( tclass )
+        obj_class = Object
+        tclass.split( "::" ).each { |c| obj_class = obj_class.const_get( c ) }
+        obj_class
+    end
+end
+

data/share/default-blog/hobix.yaml

@@ -0,0 +1,16 @@
+--- !hobix.com,2004/weblog 
+title: a bokononist asks
+link: http://bokononist.hobix.com/
+tagline: "nice, nice, very nice"
+period: 00:60:00
+authors: {}
+linklist:  
+- hobix: http://hobix.com/
+- del.icio.us: http://del.icio.us/
+requires: 
+- hobix/storage/filesys
+- hobix/out/quick
+- hobix/out/erb
+- hobix/out/rss
+- hobix/out/okaynews
+- hobix/out/atom

data/share/default-blog/htdocs/site.css

@@ -0,0 +1,174 @@
+body {
+    font-family: georgia, serif;
+    margin: 20px 60px 60px 60px;
+    background: #F1F8FF;
+}
+
+A 			{ color: #003366; text-decoration: underline; }
+A:link		{ color: #003366; text-decoration: underline; }
+A:visited	{ color: #003366; text-decoration: underline; }
+A:active	{ color: #999999;  }
+A:hover		{ color: #999999;  }
+
+h1, h2, h3 {
+    margin: 0px;
+    padding: 0px;
+}
+
+#page {
+    width: 680px;
+    background: #F8F1FF;
+    border: solid 2px #333;
+    margin: 0 auto;
+}
+
+#page:after {
+    content: "."; 
+    display: block; 
+    height: 0; 
+    clear: both; 
+    visibility: hidden;
+}
+
+#banner h1 {
+    font-size: 32pt;
+    text-align: center;
+}
+
+#banner a,
+    #banner a:link,
+    #banner a:visited,
+    #banner a:active,
+    #banner a:hover {
+    color: #333;
+    text-decoration: none;
+}
+
+#sidebar {	
+    float:right;
+    font-family: arial, sans-serif;
+    font-size: 10pt;
+    padding:5px 5px 20px 5px;
+    width:90px;
+}
+    
+#blog {
+    border-right: dotted 1px black;
+    width:560px;
+    padding:20px 5px 20px 10px;
+}
+
+.tagline {
+    border-top: dotted 1px black;
+    border-bottom: dotted 1px black;
+    font-size: 11pt;
+    padding:3px;
+    text-align: center;
+}
+
+.dayHeader {
+    border: dotted 1px #888;
+    background: #FFFFF1;
+    color: #333;
+    float: left;
+    width: 70px;
+    font-size: 8pt;
+    font-family: arial, sans-serif;
+    margin-top: 4px;
+    padding:5px;
+    text-align: center;
+}
+
+.entry {
+    float: right;
+    width: 460px;
+    padding:0px 8px;
+}
+
+.entryTitle	{
+    font-size: 16pt;
+    line-height:120%;
+    color: #345;
+}			
+
+.entryTagline {
+    font-size: 9pt;
+    line-height:200%;
+    color: #345;
+}
+
+.entryContent {
+    font-family:arial, sans-serif;
+    color:#333;
+    font-size: 10pt;
+    font-weight:normal;
+    line-height:200%;
+    padding: 10px 0px;
+}
+
+.entryContent p {
+    padding: 0px;
+    margin: 0px;
+}
+
+.entryContent a,
+.entryContent a:link,
+.entryContent a:visited,
+.entryContent a:active,
+.entryContent a:hover {
+    font-weight: normal;
+    text-decoration: underline;
+}
+
+.entryFooter { 
+    margin-left:100px;
+    width:430px;
+    color:#334455;
+    font-family:arial, sans-serif;
+    font-size:8pt; 
+    text-align:right;
+    padding:3px;
+    padding:20px;
+}
+    
+.entryFooter a,
+.entryFooter a:link,
+.entryFooter a:visited,
+.entryFooter a:active,
+.entryFooter a:hover {
+    font-weight: normal;
+    text-decoration: underline;
+}
+
+.sidebarTitle {
+    color: #534;
+    font-size: 10pt;
+    padding:5px 0px;
+}
+
+.sidebarBox {
+    font-size: 8pt;
+    padding-top: 6px;
+}
+
+.sidebarBox ul, #archives ul {
+    margin:0px;
+    padding:0px;
+}
+
+.sidebarBox li, #archives li {
+    display: block;
+    list-style-image: none;
+    list-style-type: none;
+    padding-bottom: 3px;
+}
+
+#archives .entryTitle {
+    font-weight: normal;
+    padding: 0px 10px 10px 10px;
+}
+
+.sidebarBox p {
+    margin:0px;
+    padding:0px;
+}

data/share/default-blog-modes.yaml

@@ -0,0 +1,7 @@
+apache1-ssi: [apache-ssi]
+apache2-ssi: [apache-ssi, apache2-ssi]
+apache-comments: [cgi, apache-cgi, prototype, comments]
+# apache-wiki: [cgi, apache-cgi, wiki]
+# apache-publisher: [cgi, apache-cgi, prototype, publisher]
+apache1-all: [apache-ssi, cgi, apache-cgi, prototype, comments]
+apache2-all: [apache-ssi, apache2-ssi, cgi, apache-cgi, prototype, comments]

data/share/default-blog.apache-cgi.patch

@@ -0,0 +1,8 @@
+--- !hobix.com,2004/patches/^list
+htdocs/control/.htaccess: !^file-ensure |
+  AddHandler cgi-script .cgi
+  Options +FollowSymLinks +ExecCGI
+  
+  RewriteEngine   On
+  RewriteCond %{REQUEST_FILENAME} !-f
+  RewriteRule     ^(.*)$              /control/hobix.cgi

data/share/default-blog.apache-ssi.patch

@@ -0,0 +1,38 @@
+--- !hobix.com,2004/patches/^list
+hobix.yaml: !^yaml-merge
+  requires:
+  - local
+
+lib/local.rb: !^file-create |
+  module Hobix
+  class Weblog
+      def skel_sidebar( path_storage, section_path )
+          months = path_storage.get_months( storage.find )
+          page = Page.new( 'sidebar' )
+          page.updated = Time.now
+          yield :page => page, :months => months
+      end
+  end
+  class Out::Quick
+      def sidebar_erb
+          %{<!--#include virtual="<%= weblog.expand_path( 'sidebar.html' ) %>"-->}
+      end
+  end
+  end
+
+skel/sidebar.html.quick: !^file-create |
+  page: <+ sidebar +>
+  sidebar: |
+    <div id="sidebar">
+    <+ sidebar_list +>
+    </div>
+  
+  sidebar_archive: |
+    <div class="sidebarBox">
+    <h2 class="sidebarTitle">Archive</h2>
+    <ul>
+    <% months.reverse.each do |month_start, month_end, month_id| %>
+        <li><a href="<%= weblog.expand_path month_id %>"><%= month_start.strftime( "%B %Y" ) %></a></li>
+    <% end %>
+    </ul>
+    </div>

data/share/default-blog.apache2-ssi.patch

@@ -0,0 +1,3 @@
+--- !hobix.com,2004/patches/^list
+htdocs/.htaccess: !^file-ensure |
+  AddOutputFilter INCLUDES .html

data/share/default-blog.cgi.patch

@@ -0,0 +1,8 @@
+--- !hobix.com,2004/patches/^list
+htdocs/control/hobix.cgi: !^file-create |
+  #!/usr/bin/env ruby
+  require 'hobix/webapp'
+  require 'hobix/weblog'
+  Hobix::WebApp() do |web|
+    Hobix::Weblog.load( "../../hobix.yaml" ).facet_for( web )
+  end

data/share/default-blog.comments.patch

@@ -0,0 +1,5 @@
+--- !hobix.com,2004/patches/^list
+hobix.yaml: !^yaml-merge
+  requires:
+  - hobix/out/quick
+  - hobix/comments