hobix 0.4

data/lib/hobix/out/quick.rb

@@ -0,0 +1,312 @@
+#
+# = hobix/out/quick.rb
+#
+# Quick YAML + ERb templates which makes templating
+# thirty times easier!!
+#
+# 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/base'
+require 'erb'
+
+module Hobix
+module Out
+class QuickError < StandardError; end
+
+class Quick < Hobix::BaseOutput
+    APPEND_TPL_RE = /^(.+)\s*(<<|>>)$/
+    # Class method for appending to a method template
+    def self.append_def( method, str )
+        newstr = "#{ self.allocate.method( method ).call }#{ str }"
+        define_method( method ) { newstr }
+    end
+    # Class method for prepending to a method template
+    def self.prepend_def( method, str )
+        newstr = "#{ str }#{ self.allocate.method( method ).call }"
+        define_method( method ) { newstr }
+    end
+
+    def initialize( weblog, defaults = {} )
+        @hobix_path = weblog.path
+        @path = weblog.skel_path
+        defaults.each do |k, v|
+            k = k.gsub( /\W/, '_' )
+            k.untaint
+            v = v.inspect
+            v.untaint
+            if k =~ APPEND_TPL_RE
+                k = $1.strip
+                v = if $2 == ">>"
+                        "#{ v } + #{ k }_erb_orig"
+                    else
+                        "#{ k }_erb_orig + #{ v }"
+                    end
+                instance_eval %{
+                    alias #{ k }_erb_orig #{ k }_erb
+                    def #{ k }_erb
+                        #{ v }
+                    end
+                }
+            else
+                instance_eval %{
+                    def #{ k }_erb
+                        #{ v }
+                    end
+                }
+            end
+        end
+    end
+    def setup
+        quick_conf = File.join( @hobix_path, 'hobix.out.quick' )
+        unless File.exists? quick_conf
+            quicksand = {}
+            methods.each do |m|
+                if m =~ /^(.+)_erb$/
+                    key = $1
+                    qtmpl = method( m ).call
+                    if qtmpl.respond_to? :strip
+                        qtmpl = "\n#{ qtmpl.strip.gsub( /^ {8}/, '' ) }\n"
+                        def qtmpl.to_yaml_fold; '|'; end
+                    end
+                    quicksand[key] = qtmpl
+                end
+            end
+            File.open( quick_conf, 'w' ) do |f|
+                YAML.dump( quicksand, f )
+            end
+        end
+    end
+    def extension
+        "quick"
+    end
+    def load( file_name, vars )
+        @bind = binding
+        @relpath = File.dirname( file_name )
+        vars.each do |k, v|
+            k.untaint
+            k_inspect = k.inspect.untaint
+            eval( "#{ k } = vars[#{ k_inspect }]", @bind )
+        end
+        quick_file = File.read( file_name )
+        quick_data = if quick_file.strip.empty?
+                         {}
+                     else
+                         YAML::load( quick_file )
+                     end
+        quick_data.each do |k, v|
+            if k =~ APPEND_TPL_RE
+                k = $1.strip
+                quick_data[k] = if $2 == ">>"
+                                    v + method( "#{ k }_erb" ).call
+                                else
+                                    method( "#{ k }_erb" ).call + v
+                                end
+            end
+        end
+        erb_src = make( 'page', quick_data, vars.has_key?( :entries ) )
+        erb_src.untaint
+        erb = ::ERB.new( erb_src )
+        begin
+            erb.result( @bind )
+        rescue Exception => e
+            puts "--- erb source ---"
+            puts erb_src
+            puts "--- erb source ---"
+            puts e.backtrace
+            raise QuickError, "Error `#{ e.message }' in erb #{ file_name }."
+        end
+    end
+    def expand( fname )
+        if fname =~ /^\//
+            File.join( @path, fname )
+        else
+            File.join( @relpath, fname )
+        end
+    end
+    def make( part, quick_data, has_entries = true )
+        if part == 'entries' and not has_entries
+            part = 'entry'
+        end
+        erb = quick_data[part] || method( "#{ part.gsub( /\W+/, '_' ) }_erb" ).call
+        if erb.respond_to? :gsub
+            erb.gsub( /<\+\s*(\w+)\s*\+>/ ) do
+                make( $1, quick_data, has_entries )
+            end.gsub( /<\+\s*([\w\.\/\\\-]+)\s*\+>/ ) do
+                File.read( expand( $1 ) )
+            end
+        elsif erb.respond_to? :collect
+            erb.collect do |inc|
+                make( inc, quick_data, has_entries )
+            end.join "\n"
+        end
+    end
+
+    #
+    # Default quick templates
+    #
+    def title_erb; '<%= weblog.title %>'; end
+    def banner_erb
+     %{ <div id="banner">
+        <h1 class="title"><a href="<%= weblog.link %>"><%= weblog.title %></a></h1>
+        <div class="tagline"><%= weblog.tagline %></div>
+        </div> }
+    end
+    def footer_erb; end
+    def sidebar_erb
+     %{ <div id="sidebar">
+        <+ sidebar_list +>
+        </div> }
+    end
+    def sidebar_list_erb
+        ['sidebar_archive', 'sidebar_links', 'sidebar_syndicate', 'sidebar_hobix']
+    end
+    def sidebar_archive_erb
+     %{ <div class="sidebarBox">
+        <h2 class="sidebarTitle">Archive</h2>
+        <ul>
+        <% months = weblog.storage.get_months( weblog.storage.find ) %>
+        <% 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> }
+    end
+    def sidebar_links_erb
+     %{ <div class="sidebarBox">
+        <h2 class="sidebarTitle">Links</h2>
+        <%= weblog.linklist.content.to_html %>
+        </div> }
+    end
+    def sidebar_syndicate_erb
+     %{ <div class="sidebarBox">
+        <h2 class="sidebarTitle">Syndicate</h2>
+        <ul>
+            <li><a href="<%= weblog.link %>/index.xml">RSS 2.0</a></li>
+        </ul>
+        </div> }
+    end
+    def sidebar_hobix_erb
+     %{ <div class="sidebarBox">
+        <p>Built upon <a href="http://hobix.com">Hobix</a></p>
+        </div> }
+    end
+    def blog_erb
+     %{ <div id="blog">
+        <+ entries +>
+        </div> }
+    end
+    def entries_erb
+     %{ <% entries.each_day do |day, day_entries| %>
+            <a name="<%= day.strftime( "%Y%m%d" ) %>"></a>
+            <+ day_header +>
+            <% day_entries.each do |entry| %>
+                <+ entry +>
+            <% end %>
+        <% end %> }
+    end
+    def day_header_erb; %{ <h2 class="dayHeader"><%= day.strftime( "%A, %B %d, %Y" ) %></h2> }; end
+    def entry_erb
+     %{ <div class="entry">
+            <+ entry_title +>
+            <+ entry_content +>
+        </div>
+        <div class="entryFooter"><+ entry_footer +></div> }
+    end
+    def entry_title_erb
+     %{ <h3 class="entryTitle"><%= entry.title %></h3>
+        <% if entry.respond_to? :tagline and entry.tagline %><div class="entryTagline"><%= entry.tagline %></div><% end %> }
+    end
+    def entry_content_erb
+        %{ <div class="entryContent"><%= entry.content.to_html %></div> }
+    end
+    def entry_footer_erb
+     %{ posted by <%= weblog.authors[entry.author]['name'] %> | <a href="<%= entry.link %>"><%= entry.created.strftime( "%I:%M %p" ) %></a> }
+    end
+    def head_tags_erb; end
+    def css_erb; %{ @import "<%= weblog.expand_path "site.css" %>"; }; end
+    def doctype_erb
+     %{<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">}
+    end
+    def page_erb
+     %{<+ doctype +>
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title><+ title +></title>
+<+ head_tags +>
+<style type="text/css">
+<+ css +>
+</style>
+</head>
+<body>
+
+<div id="page">
+
+<+ banner +>
+
+<div id="content">
+<+ sidebar +>
+
+<+ blog +>
+
+</div>
+
+<+ footer +>
+
+</div>
+
+</body>
+</html>}
+    end
+end
+
+class QuickSummary < Quick
+    def extension
+        "quick-summary"
+    end
+    def entry_content_erb
+     %{ <div class="entryContent">
+        <% if entry.respond_to? :summary and entry.summary %>
+        <%= entry.summary.to_html %>
+        <p><a href="<%= entry.link %>">Continue to full post.</a></p>
+        <% else %>
+        <%= entry.content.to_html %>
+        <% end %>
+        </div> }
+    end
+end
+
+class QuickArchive < Quick
+    def extension
+        "quick-archive"
+    end
+    def entry_erb
+     %{ <h3 class="entryTitle"><a href="<%= entry.link %>"><%= entry.title %></a></h3> }
+    end
+    def entries_erb
+     %{ <div id="archives">
+        <ul>
+        <% entries.each_day do |day, day_entries| %>
+            <li><+ day_header +>
+            <ul>
+            <% day_entries.each do |entry| %>
+                <li><+ entry +></li>
+            <% end %>
+            </ul>
+            </li>
+        <% end %>
+        </ul>
+        </div> }
+    end
+end
+
+end
+end

data/lib/hobix/out/rdf.rb

@@ -0,0 +1,97 @@
+#
+# = hobix/out/rdf.rb
+#
+# RSS (RDF Site Summary) 1.0 output for Hobix.
+#
+# Copyright (c) 2004 Giulio Piancastelli
+#
+# Written & maintained by Giulio Piancastelli <gpian@softhome.net>
+#
+# This program is free software. You can re-distribute and/or
+# modify this program under the same terms of ruby itself ---
+# Ruby Distribution License or GNU General Public License.
+#
+require 'hobix/base'
+require 'rexml/document'
+
+module Hobix
+module Out
+class RDF < Hobix::BaseOutput
+    def initialize(weblog)
+        @path = weblog.skel_path
+    end
+    def extension
+        "rdf"
+    end
+    def load(file_name, vars)
+        rdfdoc = REXML::Document.new(<<EOXML)
+<rdf:RDF
+  xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+  xmlns:dc="http://purl.org/dc/elements/1.1/"
+  xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
+  xmlns:admin="http://webns.net/mvcb/"
+  xmlns:cc="http://web.resource.org/cc/"
+  xmlns="http://purl.org/rss/1.0/">
+    <channel>
+    <title></title>
+    <link></link>
+    <description></description>
+    <dc:language>en-us</dc:language>
+    <!--<dc:creator></dc:creator>-->
+    <dc:date></dc:date>
+    <admin:generatorAgent rdf:resource="http://hobix.com/?v=#{ Hobix::VERSION }" />
+    <sy:updatePeriod>hourly</sy:updatePeriod>
+    <sy:updateFrequency>1</sy:updateFrequency>
+    <sy:updateBase>2000-01-01T12:00+00:00</sy:updateBase>
+    
+    <items>
+        <rdf:Seq></rdf:Seq>
+    </items>
+    
+    </channel>
+</rdf:RDF>
+EOXML
+        rdfdoc << REXML::XMLDecl.new
+        rdfdoc.elements['/rdf:RDF/channel/'].attributes['rdf:about'] = vars[:weblog].link
+        rdfdoc.elements['/rdf:RDF/channel/title'].text = vars[:weblog].title
+        rdfdoc.elements['/rdf:RDF/channel/link'].text = vars[:weblog].link
+        rdfdoc.elements['/rdf:RDF/channel/description'].text = vars[:weblog].tagline
+        rdfdoc.elements['/rdf:RDF/channel/dc:date'].text = Time.now.utc.strftime( "%Y-%m-%dT%H:%M:%S+00:00" )
+        (vars[:entries] || [vars[:entry]]).each do |e|
+            ele = REXML::Element.new 'item'
+            ele.attributes['rdf:about'] = "#{e.link}"
+            if e.title
+              ele_title = REXML::Element.new 'title'
+              ele_title.text = e.title
+              ele << ele_title
+            end
+            ele_link = REXML::Element.new 'link'
+            ele_link.text = "#{e.link}"
+            ele << ele_link
+            ele_subject = REXML::Element.new 'dc:subject'
+            ele_subject.text = e.section_id
+            ele << ele_subject
+            ele_creator = REXML::Element.new 'dc:creator'
+            ele_creator.text = vars[:weblog].authors[e.author]['name']
+            ele << ele_creator
+            ele_pubDate = REXML::Element.new 'dc:date'
+            ele_pubDate.text = e.created.dup.utc.strftime( "%Y-%m-%dT%H:%M:%S+00:00" )
+            ele << ele_pubDate
+            ele_desc = REXML::Element.new 'description'
+            if !e.summary
+              ele_desc.text = e.content.to_html.gsub(/img src="\//, "img src=\"#{vars[:weblog].link}")
+            else
+              ele_desc.text = e.summary
+            end
+            ele << ele_desc
+            rdfdoc.elements['/rdf:RDF'].add ele
+            # also add an element to the <rdf:Seq> sequence in <items>
+            li = REXML::Element.new 'rdf:li'
+            li.attributes['rdf:resource'] = "#{e.link}"
+            rdfdoc.elements['/rdf:RDF/channel/items/rdf:Seq'] << li
+        end
+        rdfdoc.to_s
+    end
+end
+end
+end

data/lib/hobix/out/redrum.rb

@@ -0,0 +1,26 @@
+#
+# = hobix/out/redrum.rb
+#
+# Hobix processing of ERB + Textile templates.
+#
+# 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/out/erb'
+
+module Hobix::Out
+class RedRum < ERB
+    def extension; "redrum"; end
+    alias erb_load load
+    def load( file_name, vars )
+        RedCloth.new( erb_load( file_name, vars ) ).to_html
+    end
+end
+end

data/lib/hobix/out/rss.rb

@@ -0,0 +1,115 @@
+#
+# = hobix/out/rss.rb
+#
+# RSS 2.0 output for Hobix.
+#
+# 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/base'
+require 'rexml/document'
+
+module Hobix
+module Out
+class RSS < Hobix::BaseOutput
+    def initialize( weblog, params = {} )
+        @path = weblog.skel_path
+        @extra_ns = params["namespaces"]
+        @extra_els = params["elements"]
+        @summaries = params["summary-only"]
+        @more_link = params["more-link"]
+        @comment_aname = params["comment-location"]
+    end
+    def extension
+        "rss"
+    end
+    def load( file_name, vars )
+        rssdoc = REXML::Document.new( <<EOXML )
+<rss version="2.0" 
+  xmlns:dc="http://purl.org/dc/elements/1.1/"
+  xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
+  xmlns:admin="http://webns.net/mvcb/"
+  xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+    <channel>
+    <title></title>
+    <link></link>
+    <description></description>
+    <dc:language>en-us</dc:language>
+    <dc:creator></dc:creator>
+    <dc:date></dc:date>
+    <admin:generatorAgent rdf:resource="http://hobix.com/?v=#{ Hobix::VERSION }" />
+    <sy:updatePeriod>hourly</sy:updatePeriod>
+    <sy:updateFrequency>1</sy:updateFrequency>
+    <sy:updateBase>2000-01-01T12:00+00:00</sy:updateBase>
+    </channel>
+</rss>
+EOXML
+        rssdoc << REXML::XMLDecl.new
+        rssdoc.elements['/rss/channel/title'].text = vars[:weblog].title
+        rssdoc.elements['/rss/channel/link'].text = vars[:weblog].link.to_s
+        rssdoc.elements['/rss/channel/description'].text = vars[:weblog].tagline
+        rssdoc.elements['/rss/channel/dc:date'].text = Time.now.utc.strftime( "%Y-%m-%dT%H:%M:%S+00:00" )
+
+        @extra_ns.each do |k, v|
+            rssdoc.elements['/rss'].attributes["xmlns:" + k.to_s] = v.to_s
+        end if @extra_ns
+        @extra_els.each do |k, v|
+            extra = REXML::Element.new k.to_s
+            extra.text = v.to_s
+            rssdoc.elements['/rss/channel'].add extra
+        end if @extra_els
+
+        ( vars[:entries] || [vars[:entry]] ).each do |e|
+            ele = REXML::Element.new 'item'
+            ele_title = REXML::Element.new 'title'
+            ele_title.text = e.title
+            ele << ele_title
+            ele_link = REXML::Element.new 'link'
+            link = e.link.gsub(/'/,"%27")
+            ele_link.text = "#{ link }"
+            ele << ele_link
+            if @comment_aname
+              ele_comments = REXML::Element.new 'comments'
+              ele_comments.text = "#{ link }##@comment_aname"
+              ele << ele_comments
+            end
+            ele_guid = REXML::Element.new 'guid'
+            ele_guid.attributes['isPermaLink'] = 'false'
+            ele_guid.text = "#{ e.id }@#{ vars[:weblog].link }"
+            ele << ele_guid
+            ele_subject = REXML::Element.new 'dc:subject'
+            ele_subject.text = e.section_id
+            ele << ele_subject
+            e.tags.each do |t|
+                ele_subject = REXML::Element.new 'dc:subject'
+                ele_subject.text = t
+                ele << ele_subject
+            end
+            ele_creator = REXML::Element.new 'dc:creator'
+            ele_creator.text = vars[:weblog].authors[e.author]['name']
+            ele << ele_creator
+            ele_pubDate = REXML::Element.new 'dc:date'
+            ele_pubDate.text = ( e.modified || e.created ).dup.utc.strftime( "%Y-%m-%dT%H:%M:%S+00:00" )
+            ele << ele_pubDate
+            ele_desc = REXML::Element.new 'description'
+            ele_desc.text = 
+                if @summaries && e.summary
+                  e.summary.to_html + (@more_link ? %{<p><a href="#{e.link}">#@more_link</a></p>} : "")
+                else
+                  e.content.to_html
+                end.gsub( /(src|href)="\//, "\\1=\"#{ vars[:weblog].link.rooturi }/" )
+            ele << ele_desc
+            rssdoc.elements['/rss/channel'].add ele
+        end
+        rssdoc.to_s
+    end
+end
+end
+end

data/lib/hobix/plugin/bloglines.rb

@@ -0,0 +1,73 @@
+## bloglines.rb -- Hobix Bloglines plugin
+##
+## Displays your Bloglines subscriptions on the sidebar. If you use
+## Bloglines, this is a nice way to automatically build a blogroll.
+## This is based on the instructions at
+## http://www.bloglines.com/help/share.
+##
+## Bloglines does all the work here. This plugin just generates a
+## Javascript URL.
+##
+## USAGE:
+##
+## 1) In hobix.yaml (e.g. by running 'hobix edit <blogname>'), in the
+##    'required' block, append as follows:
+##
+## required:
+##   - hobix/plugin/bloglines:
+##       userid: <your bloglines userid>
+##
+##    You can also specify any of the following arguments:
+##
+## required:
+##   - hobix/plugin/bloglines:
+##       userid: <your bloglines userid>
+##       folder: <bloglines folder to export (default all)>
+##       title: <title (default "Blogroll"), or nil for none>
+##       in-sidebarBox-div: <true or false (default true)>
+##
+## NOTES:
+##
+## 1) If you redefine 'sidebar_list' in hobix.yaml, you'll need to
+##    explicitly add a 'sidebar_bloglines' item.
+
+module Hobix
+
+## we just keep parameters from hobix.yaml here
+class BloglinesPlugin < BasePlugin
+  def initialize(weblog, params = {})
+    raise %{the bloglines plugin needs a "userid" parameter. see hobix/plugin/bloglines.rb for details} unless params.member? "userid"
+    @@userid = params["userid"]
+    @@folder = params["folder"]
+    @@title = params["title"] || "Blogroll"
+    @@in_sidebarBox_div = lambda { |x| (x.nil? ? true : x) }[params["in-sidebarBox-div"]]
+  end
+
+  def self.userid; @@userid; end
+  def self.folder; @@folder; end
+  def self.title; @@title; end
+  def self.in_sidebarBox_div?; @@in_sidebarBox_div; end
+end
+
+class Out::Quick
+  alias bloglines_old_sidebar_list_erb sidebar_list_erb
+  def sidebar_list_erb
+    l = bloglines_old_sidebar_list_erb
+    if l.last == "sidebar_hobix"
+      l[0 ... (l.length - 1)] + ['sidebar_bloglines', 'sidebar_hobix']
+    else
+      l + ['sidebar_bloglines']
+    end
+  end
+
+  def sidebar_bloglines_erb
+    (BloglinesPlugin.in_sidebarBox_div? ? %{<div class="sidebarBox">} : "") +
+      (BloglinesPlugin.title ? %{<h2 class="sidebarTitle">#{BloglinesPlugin.title}</h2>} : "") +
+      %{<script language="javascript" type="text/javascript" src="http://rpc.bloglines.com/blogroll?id=#{BloglinesPlugin.userid}} +
+      (BloglinesPlugin.folder ? "&folder=#{BloglinesPlugin.folder}" : "") +
+      %{"></script>} +
+      (BloglinesPlugin.in_sidebarBox_div? ? "</div>" : "")
+  end
+end
+
+end