webgen 0.5.6 → 0.5.7

data/lib/webgen/sourcehandler.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'webgen/loggable'
 require 'benchmark'
 
@@ -50,12 +52,18 @@ module Webgen
           end
           puts "...done in " + ('%2.4f' % time.real) + ' seconds'
 
+          if !tree.root
+            puts 'No source files found - maybe not a webgen website?'
+            return nil
+          end
+
           puts "Writing changed nodes..."
           time = Benchmark.measure do
             write_tree(tree)
           end
           puts "...done in " + ('%2.4f' % time.real) + ' seconds'
         end while tree.node_access[:alcn].any? {|name,node| node.flagged(:created) || node.flagged(:reinit)}
+        :success
       end
 
       #######

data/lib/webgen/sourcehandler/base.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'facets/symbol/to_proc'
 require 'webgen/websiteaccess'
 require 'webgen/loggable'

data/lib/webgen/sourcehandler/copy.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::SourceHandler
 
   # Simple source handler for copying files from the source tree, either verbatim or by applying a

data/lib/webgen/sourcehandler/directory.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::SourceHandler
 
   # Handles directory source paths.

data/lib/webgen/sourcehandler/feed.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::SourceHandler
 
   # Source handler for creating atom and/or rss feeds.
@@ -53,7 +55,7 @@ module Webgen::SourceHandler
     # Helper method for returning the entries for the feed node +node+.
     def feed_entries(node)
       nr_items = (node['number_of_entries'].to_i == 0 ? 10 : node['number_of_entries'].to_i)
-      patterns = [node['entries']].flatten.map {|pat| Pathname.new(pat =~ /^\// ? pat : File.join(node.parent.absolute_lcn, pat)).cleanpath.to_s}
+      patterns = [node['entries']].flatten.map {|pat| Webgen::Common.absolute_path(pat, node.parent.absolute_lcn)}
 
       node.tree.node_access[:alcn].values.
         select {|node| patterns.any? {|pat| node =~ pat} && node.node_info[:page]}.

data/lib/webgen/sourcehandler/fragment.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::SourceHandler
 
   # Handles page fragment nodes and provides utility methods for parsing HTML headers and generating

data/lib/webgen/sourcehandler/memory.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::SourceHandler
 
   # This source handler should be used for handling nodes that are created during the write

data/lib/webgen/sourcehandler/metainfo.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'pathname'
 require 'yaml'
 
@@ -27,7 +29,7 @@ module Webgen::SourceHandler
         [[:mi_paths, 'paths'], [:mi_alcn, 'alcn']].each do |mi_key, block_name|
           node.node_info[mi_key] = {}
           YAML::load(page.blocks[block_name].content).each do |key, value|
-            key = Pathname.new(key =~ /^\// ? key : File.join(parent.absolute_lcn, key)).cleanpath.to_s
+            key = Webgen::Common.absolute_path(key, parent.absolute_lcn)
             node.node_info[mi_key][key] = value
           end if page.blocks.has_key?(block_name)
         end

data/lib/webgen/sourcehandler/page.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::SourceHandler
 
   # Source handler for handling content files in Webgen Page Format.

data/lib/webgen/sourcehandler/sitemap.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'uri'
 require 'time'
 

data/lib/webgen/sourcehandler/template.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::SourceHandler
 
   # Source handler for handling template files in Webgen Page Format.

data/lib/webgen/sourcehandler/virtual.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'uri'
 require 'yaml'
 
@@ -17,7 +19,7 @@ module Webgen::SourceHandler
       page = page_from_path(path)
       nodes = []
       YAML::load(page.blocks['content'].content).each do |key, meta_info|
-        key = (key =~ /^\// ? key : File.join(parent.absolute_lcn, key))
+        key = Webgen::Common.absolute_path(key, parent.absolute_lcn) + (key =~ /\/$/ ? '/' : '')
         temp_parent = create_directories(parent.tree.root, File.dirname(key), path)
 
         meta_info ||= {}

data/lib/webgen/tag.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen
 
   # Namespace for all classes that are useable by Webgen::ContentProcessor::Tag.

data/lib/webgen/tag/base.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'yaml'
 require 'webgen/loggable'
 require 'webgen/websiteaccess'

data/lib/webgen/tag/breadcrumbtrail.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::Tag
 
   # Generates a breadcrumb trail for the page. This is especially useful when pages are in deep

data/lib/webgen/tag/coderay.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::Tag
 
   # Provides syntax highlighting via the +coderay+ library.

data/lib/webgen/tag/date.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::Tag
 
   # Prints out the date using a format string which will be passed to Time#strftime. Therefore you

data/lib/webgen/tag/executecommand.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'cgi'
 require 'tempfile'
 require 'rbconfig'

data/lib/webgen/tag/includefile.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'cgi'
 
 module Webgen::Tag

data/lib/webgen/tag/langbar.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::Tag
 
   # Generates a list with all the languages of the page.
@@ -19,7 +21,8 @@ module Webgen::Tag
         sort {|a, b| a.lang <=> b.lang}.
         collect {|n| context.dest_node.link_to(n, :link_text => (param('tag.langbar.lang_names')[n.lang] || n.lang), :lang => n.lang)}.
         join(param('tag.langbar.separator'))
-      (param('tag.langbar.show_single_lang') || lang_nodes.length > 1 ? result : "")
+
+      [(param('tag.langbar.show_single_lang') || lang_nodes.length > 1 ? result : ""), param('tag.langbar.process_output')]
     end
 
     #######

data/lib/webgen/tag/link.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::Tag
 
   # Create a link to a given (A)LCN.

data/lib/webgen/tag/menu.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::Tag
 
   # Generates a menu that can be configured extensively.

data/lib/webgen/tag/metainfo.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::Tag
 
   # Provides easy access to the meta information of a node.

data/lib/webgen/tag/relocatable.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'uri'
 
 module Webgen::Tag

data/lib/webgen/tag/sitemap.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen::Tag
 
   # Generates a sitemap. The sitemap contains the hierarchy of all pages on the web site.

data/lib/webgen/tag/tikz.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'erb'
 require 'tempfile'
 require 'fileutils'
@@ -30,7 +32,7 @@ EOF
     # Create a graphic from the commands in the body of the tag.
     def call(tag, body, context)
       path = param('tag.tikz.path')
-      path = Pathname.new(path =~ /^\// ? path : File.join(context.ref_node.parent.absolute_lcn, path)).cleanpath.to_s
+      path = Webgen::Common.absolute_path(path, context.ref_node.parent.absolute_lcn)
 
       mem_handler = website.cache.instance('Webgen::SourceHandler::Memory')
       src_path = context.ref_node.node_info[:src]

data/lib/webgen/tree.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'webgen/websiteaccess'
 require 'webgen/node'
 
@@ -65,6 +67,9 @@ module Webgen
     end
 
     # Delete the node identified by +node_or_alcn+ and all of its children from the tree.
+    #
+    # The message <tt>:before_node_deleted</tt> is sent with the to-be-deleted node before this node
+    # is actually deleted from the tree.
     def delete_node(node_or_alcn)
       n = node_or_alcn.kind_of?(Node) ? node_or_alcn : @node_access[:alcn][node_or_alcn]
       return if n.nil? || n == @dummy_root

data/lib/webgen/version.rb

@@ -1,6 +1,8 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen
 
   # The version of webgen.
-  VERSION = '0.5.6'
+  VERSION = '0.5.7'
 
 end

data/lib/webgen/webgentask.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 # -*- ruby -*-
 #
 #--

data/lib/webgen/website.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 # Standard lib requires
 require 'logger'
 require 'set'
@@ -28,6 +30,102 @@ require 'webgen/page'
 
 
 # The Webgen namespace houses all classes/modules used by webgen.
+#
+# = webgen
+#
+# webgen is a command line application for generating a web site from templates and content
+# files. Despite this fact, the implementation also provides adequate support for using webgen as a
+# library and *full* *support* for extending it.
+#
+# = Extending webgen
+#
+# webgen can be extended very easily. Any file called <tt>init.rb</tt> put into the <tt>ext/</tt>
+# directory of the website or into one of its sub-directories is automatically loaded on
+# Website#init.
+#
+# You can extend webgen in several ways. However, no magic or special knowledge is needed since
+# webgen relies on the power of Ruby itself. So, for example, an extension is just a normal Ruby
+# class. Most extension types provide a Base module for mixing into an extension which provides
+# default implementations for needed methods.
+#
+# Following are links to detailed descriptions on how to develop specific types of extensions:
+#
+# [Webgen::Source] Information on how to implement a class that provides source paths for
+#                  webgen. For example, one could implement a source class that uses a database as
+#                  backend.
+#
+# [Webgen::Output] Information on how to implement a class that writes content to an output
+#                  location. The default output class just writes to the file system. One could, for
+#                  example, implement an output class that writes the generated files to multiple
+#                  locations or to a remote server.
+#
+# [Webgen::ContentProcessor] Information on how to develop an extension that processes the
+#                            content. For example, markup-to-HTML converters are implemented as
+#                            content processors in webgen.
+#
+# [Webgen::SourceHandler::Base] Information on how to implement a class that handles objects of type
+#                               source Path and creates Node instances. For example,
+#                               Webgen::SourceHandler::Page handles the conversion of <tt>.page</tt>
+#                               files to <tt>.html</tt> files.
+#
+# [Webgen::Tag::Base] Information on how to implement a webgen tag. webgen tags are used to provide
+#                     an easy way for users to include dynamic content such as automatically
+#                     generated menus.
+#
+# = Blackboard services
+#
+# The Blackboard class provides an easy communication facility between objects. It implements the
+# Observer pattern on the one side and allows the definition of services on the other side. One
+# advantage of a service over the direct use of an object instance method is that the caller does
+# not need to how to find the object that provides the service. It justs uses the Website#blackboard
+# instance. An other advantage is that one can easily exchange the place where the service was
+# defined without breaking extensions that rely on it.
+#
+# Following is a list of all services available in the stock webgen distribution by the name and the
+# method that implements it (which is useful for looking up the parameters of service).
+#
+# <tt>:create_fragment_nodes</tt>:: SourceHandler::Fragment#create_fragment_nodes
+# <tt>:templates_for_node</tt>:: SourceHandler::Template#templates_for_node
+# <tt>:parse_html_headers</tt>:: SourceHandler::Fragment#parse_html_headers
+# <tt>:output_instance</tt>:: Output.instance
+# <tt>:content_processor_names</tt>:: ContentProcessor.list
+# <tt>:content_processor</tt>:: ContentProcessor.for_name
+# <tt>:create_sitemap</tt>:: Common::Sitemap#create_sitemap
+# <tt>:create_directories</tt>:: SourceHandler::Directory#create_directories
+# <tt>:create_nodes</tt>:: SourceHandler::Main#create_nodes
+# <tt>:source_paths</tt>:: SourceHandler::Main#source_paths
+#
+# Following is the list of all messages that can be listened to:
+#
+# <tt>:node_flagged</tt>::
+#   See Node#flag
+#
+# <tt>:node_unflagged</tt>::
+#   See Node#unflag
+#
+# <tt>:node_changed?</tt>::
+#   See Node#changed?
+# <tt>:node_meta_info_changed?</tt>::
+#   See Node#meta_info_changed?
+#
+# <tt>:before_node_created</tt>::
+#   Sent by the <tt>:create_nodes</tt> service before a node is created (handled by a source handler)
+#   with the +parent+ and the +path+ as arguments.
+#
+# <tt>:after_node_created</tt>::
+#   Sent by the <tt>:create_nodes</tt> service after a node has been created with the created node
+#   as argument.
+#
+# <tt>:before_node_deleted</tt>::
+#   See Tree#delete_node
+#
+# = Other places to look at
+#
+# Here is a list of modules/classes that are primarily used throughout webgen or provide useful
+# methods for developing extensions:
+#
+# Common, Tree, Node, Path, Cache, Page
+
 module Webgen
 
   # Returns the data directory for webgen.
@@ -108,15 +206,17 @@ module Webgen
       self
     end
 
-    # Render the website (after calling #init if the website is not already initialized).
+    # Render the website (after calling #init if the website is not already initialized) and return
+    # a status code not equal to +nil+ if rendering was successful.
     def render
+      result = nil
       execute_in_env do
         init unless @config
 
         puts "Starting webgen..."
         shm = SourceHandler::Main.new
-        shm.render(@tree)
-        save_tree_and_cache
+        result = shm.render(@tree)
+        save_tree_and_cache if result
         puts "Finished"
 
         if @logger && @logger.log_output.length > 0
@@ -124,6 +224,7 @@ module Webgen
           puts @logger.log_output
         end
       end
+      result
     end
 
     # Clean the website directory from all generated output files (including the cache file). If

data/lib/webgen/websiteaccess.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 module Webgen
 
   # Mixed into modules/classes that need access to the current website object.

data/lib/webgen/websitemanager.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'ostruct'
 require 'fileutils'
 require 'webgen/website'

data/man/man1/webgen.1

@@ -55,6 +55,12 @@ Shows the version of the program and exit.
 .TP
 \fBwebgui\fR
 Starts the webgen webgui, a browser based graphical user interface for manging webgen websites.
+.SH ENVIRONMENT VARIABLES
+webgen's behaviour is affected by the following environment variables:
+.TP
+\fBWEBGEN_WEBSITE\fR
+If no website is specified via the \-d option and this variable is set, webgen assumes that its
+content is the webgen website directory that should be used.
 .SH SEE ALSO
 The webgen website, http://webgen.rubyforge.org/ for more information.
 .SH AUTHOR