webgen 0.3.4 → 0.3.5

data/lib/webgen/plugins/tags/langbar.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: langbar.rb 274 2005-05-11 12:52:27Z thomas $
+# $Id: langbar.rb 293 2005-06-11 08:37:51Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -25,12 +25,14 @@ require 'webgen/plugins/tags/tags'
 module Tags
 
   # Generates a list with all the languages for a page.
-  class LanguageBarTag < DefaultTag
+  class LangbarTag < DefaultTag
 
     summary 'Provides links to translations of the page'
     add_param 'separator', ' | ', 'Separates the languages from each other.'
-    add_param 'showSingleLang', true, 'True if the language link should be shown '\
-    'although the page is only available in one language.'
+    add_param 'showSingleLang', true, 'Should the link be shown '\
+    'although the page is only available in one language?'
+    add_param 'showOwnLang', true, 'Should the link to the currently displayed '\
+    'language page be shown? '
     depends_on 'Tags'
 
     def initialize
@@ -39,7 +41,9 @@ module Tags
     end
 
     def process_tag( tag, node, refNode )
-      output = node.parent.find_all {|a| a['int:pagename'] == node['int:pagename']}.sort {|a, b| a['lang'] <=> b['lang']}.collect do |n|
+      output = node.parent.find_all do |a|
+        a['int:pagename'] == node['int:pagename'] && (node['lang'] != a['lang'] || get_param( 'showOwnLang' ))
+      end.sort {|a, b| a['lang'] <=> b['lang']}.collect do |n|
         n['processor'].get_html_link( n, n, n['lang'] )
       end.join( get_param( 'separator' ) )
       return ( get_param( 'showSingleLang' ) || node.parent.children.length > 1 ? output : "" )

data/lib/webgen/plugins/tags/menu.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: menu.rb 275 2005-05-11 17:30:20Z thomas $
+# $Id: menu.rb 293 2005-06-11 08:37:51Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -31,11 +31,6 @@ module Tags
   #
   # The order in which the menu items are listed can be controlled via the meta information
   # +orderInfo+. By default the menu items are sorted by the file names.
-  #
-  # Tag parameters:
-  # [<b>level</b>]
-  #   The depth of the menu. A level of one only displays the top level menu files. A level of two
-  #   also displays the menu files in the direct subdirectories and so on.
   class MenuTag < DefaultTag
 
     class ::Node
@@ -98,19 +93,8 @@ module Tags
     summary 'Builds a menu'
     depends_on 'Tags'
 
-    add_param 'menuTag', 'ul', 'The tag used for submenus.'
-    add_param 'itemTag', 'li', 'The tag used for menu items.'
-    add_param 'submenuClass', 'webgen-submenu', 'Specifies the class of a submenu'
-    add_param 'selectedMenuitemClass', 'webgen-menuitem-selected', 'Specifies the class of the selected menu item'
-    add_param 'level', 1, \
-    'Specifies how many levels the menu should have by default, ie. how deep it is. ' \
-    'For example, if level = 3, then three levels are always shown at least.'
-    add_param 'subtreeLevel', 3, \
-    'Specifies how many levels should be shown for subtrees. The number specifies ' \
-    'the maximum depth the menu will have.'
-    add_param 'showCurrentSubtreeOnly', true, \
-    'True if only the current subtree should be shown in the menu. If set to false, ' \
-    'each subtree will be shown.'
+    add_param 'menuStyle', 'vertical', 'Specifies the style of the menu.'
+    add_param 'options', {}, 'Optional options that are passed on to the plugin which is layouts the menu.'
 
     used_meta_info 'orderInfo', 'inMenu'
 
@@ -128,7 +112,7 @@ module Tags
           Webgen::Plugin['TreeWalker'].execute( @menuTree, Webgen::Plugin['DebugTreePrinter'] )
         end
       end
-      build_menu( node, @menuTree, 1 )
+      Webgen::Plugin['DefaultMenuStyle'].get_menu_style( get_param( 'menuStyle' ) ).build_menu( node, @menuTree, get_param( 'options' ) )
     end
 
 
@@ -136,52 +120,6 @@ module Tags
     private
     #######
 
-
-    def build_menu( srcNode, node, level )
-      if node.nil? \
-        || level > get_param( 'subtreeLevel' ) \
-        || ( level > get_param( 'level' ) \
-             && ( node['node'].level > srcNode.level \
-                  || ( get_param( 'showCurrentSubtreeOnly' ) && !srcNode.in_subtree?( node['node'] ) )
-                  )
-             )
-        return ''
-      end
-
-      out = "<#{get_param( 'menuTag' )}>"
-      node.each do |child|
-        menu = child['node']['int:directory?'] ? build_menu( srcNode, child, level + 1 ) : ''
-        before, after = menu_entry( srcNode, child['node'] )
-
-        out << before
-        out << menu
-        out << after
-      end
-      out << "</#{get_param( 'menuTag' )}>"
-
-      return out
-    end
-
-
-    def menu_entry( srcNode, node )
-      langNode = node['processor'].get_node_for_lang( node, srcNode['lang'] )
-      isDir = node['int:directory?']
-
-      styles = []
-      styles << get_param( 'submenuClass' ) if isDir
-      styles << get_param( 'selectedMenuitemClass' ) if langNode.recursive_value( 'dest' ) == srcNode.recursive_value( 'dest' )
-
-      style = " class=\"#{styles.join(' ')}\"" if styles.length > 0
-      link = node['processor'].get_html_link( node, srcNode )
-
-      before = "<#{get_param( 'itemTag' )}#{style}>#{link}"
-      after = "</#{get_param( 'itemTag' )}>"
-
-      self.logger.debug { [before, after] }
-      return before, after
-    end
-
-
     def create_menu_tree( node, parent )
       menuNode = MenuNode.new( parent, node )
 

data/lib/webgen/plugins/treewalker.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: treewalker.rb 218 2005-03-11 15:41:39Z thomas $
+# $Id: treewalker.rb 287 2005-05-26 09:33:38Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -38,10 +38,10 @@ module TreeWalkers
 
     # Uses either all registered walkers or the specified +walker+. Walks the +tree+ for each walker
     # separately.
-    def execute( tree, walker = nil )
+    def execute( tree, walker = nil, direction = :forward )
       walkers = ( walker.nil? ? @walkers : [walker] )
       walkers.each do |walker|
-        walk_tree( tree, walker, 0 )
+        walk_tree( tree, walker, 0, direction )
       end
     end
 
@@ -50,11 +50,12 @@ module TreeWalkers
     #######
 
     # Walks the tree and calls the plugin +walker+ for each and every node.
-    def walk_tree( node, walker, level )
-      walker.handle_node( node, level )
+    def walk_tree( node, walker, level, direction = :forward )
+      walker.handle_node( node, level ) if direction == :forward
       node.each do |child|
-        walk_tree( child, walker, level + 1 )
+        walk_tree( child, walker, level + 1, direction )
       end
+      walker.handle_node( node, level ) if direction == :backward
     end
 
   end

data/lib/webgen/webgen.rb

@@ -1,7 +1,7 @@
 #
 #--
 #
-# $Id: webgen.rb 259 2005-04-21 10:37:47Z thomas $
+# $Id: webgen.rb 293 2005-06-11 08:37:51Z thomas $
 #
 # webgen: template based static website generator
 # Copyright (C) 2004 Thomas Leitner
@@ -22,6 +22,7 @@
 
 require 'optparse'
 require 'rbconfig'
+require 'fileutils'
 require 'cmdparse'
 require 'webgen/plugin'
 
@@ -143,175 +144,90 @@ module Webgen
       if args.length == 0
         raise OptionParser::MissingArgument.new( 'DIR' )
       else
-        create_dir( args[0] )
-        create_dir( File.join( args[0], 'src' ) )
-        create_dir( File.join( args[0], 'output' ) )
-        create_dir( File.join( args[0], 'log' ) )
-        create_dir( File.join( args[0], 'plugin' ) )
-        create_file( File.join( args[0], 'config.yaml' ), content_config_yaml )
-        create_file( File.join( args[0], 'src', 'default.template' ), content_default_template )
-        create_file( File.join( args[0], 'src', 'default.css' ), content_default_css )
-        create_file( File.join( args[0], 'src', 'index.page' ), content_index_page )
+        FileUtils.cp_r( File.join( Webgen::Configuration.data_dir, 'example' ), args[0] )
       end
     end
 
-    def create_dir( dir )
-      Dir.mkdir( dir ) unless File.exists?( dir )
-    end
+  end
 
-    def create_file( file, content )
-      File.open( file, 'w') do |f|
-        f.puts( content )
-      end unless File.exists?( file )
-    end
 
-    def content_config_yaml
-      "# Configuration file for webgen\n# Used to set the parameters of the plugins"
+  class CleanCommand < CommandParser::Command
+
+    module ::FileUtils
+
+      def fu_output_message( msg )
+        logger.info { msg }
+      end
+
+      def ask_before_delete( ask, func, list, options = {} )
+        newlist = [*list].collect {|e| "'" + e + "'"}.join(', ')
+        if ask
+          print "Really delete #{newlist}? "
+          return unless /y|Y/ =~ gets.strip
+        end
+        self.send( func, list, options.merge( :verbose => true ) )
+      end
+
     end
 
-    def content_default_template
-      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
-<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\" \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">
-<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"{lang:}\">
-  <head>
-    <title>{title: }</title>
-    <link href=\"{relocatable: default.css}\" rel=\"stylesheet\" />
-    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />
-  </head>
-  <body>
-    <div id=\"header\">
-      <h1>{title: }</h1>
-    </div>
-
-    <div id=\"headerbar\" class=\"bar\">
-      <span class=\"left\">Navbar: {navbar: }</span>
-      <span class=\"right\">Language: {langbar: }</span>
-      <div style=\"clear:both\"></div>
-    </div>
-
-    <div id=\"menu\">
-      {menu: {subtreeLevel: 4}}
-    </div>
-
-    <div id=\"body\">
-      {content: }
-    </div>
-
-    <div id=\"footer\" class=\"bar\">
-      generated with <a href=\"http://webgen.rubyforge.org\"><em><b>webgen</b></em></a> on <b>{date: }</b>
-    </div>
-  </body>
-</html>
-"
+    class CleanWalker < Webgen::Plugin
+
+      summary "Deletes the output file for each node."
+      depends_on 'TreeWalker'
+
+      attr_writer :ask
+
+      def handle_node( node, level )
+        file = node.recursive_value( 'dest' )
+        return if !File.exists?( file ) || node['int:virtualNode']
+        if File.directory?( file )
+          begin
+            FileUtils.ask_before_delete( @ask, :rmdir, file )
+          rescue Errno::ENOTEMPTY => e
+            logger.info "Cannot delete directory #{file}, as it is not empty!"
+          end
+        else
+          FileUtils.ask_before_delete( @ask, :rm, file, :force => true )
+        end
+      end
+
     end
 
-    def content_default_css
-      "
-  #all { background-color: #CCCCCC; }
-
-  #header {
-    border-bottom: 1px solid black;
-    padding: 1ex;
-    background-color: #888888;
-  }
-  #header h1 {
-    margin: 0ex;
-	font-size: 300%;
-	font-style: italic;
-	font-weight: normal;
-  }
-
-, #headerbar { border-bottom: 1px solid black; }
-  #footer { border-top: 1px solid black; }
-
-  #body {
-    margin-left: 250px;
-    margin-right: 20px;
-    padding: 10px;
-  }
-
-  #menu {
-	float: left;
-	width: 230px;
-    padding: 20px 0px 0px 2px;
-  }
-
-  .bar {
-	clear: both;
-	padding: 3px;
-	text-align: center;
-	font-size: 90%;
-    background-color: #AAAAAA;
-  }
-
-  .left, .right {
-    padding: 0px 1em;
-  }
-
-  .left {
-	float: left;
-	text-align: left;
-  }
-
-  .right {
-	float: right;
-	text-align: right;
-  }
-
-  /* styling the menu */
-
-  #menu a {
-	text-decoration: none;
-	font-weight: bold;
-	font-size: 130%;
-  }
-
-  #menu a:hover {
-	text-decoration: underline;
-  }
-
-  #menu .webgen-menuitem-selected {
-	border-left: 3px solid black;
-  }
-
-  #menu ul {
-	list-style-type: none;
-	padding: 0px;
-	margin-left: 10px;
-  }
-
-  #menu li > ul {
-	font-size: 95%;
-  }
-
-  #menu li {
-    margin: 0.0em 0px;
-    padding: 2px 0px;
-    padding-left: 5px;
-    border-left: 3px solid #CCCCCC;
-  }
-"
+    def initialize;
+      super( 'clean' )
+      @all = false
+      @ask = false
+      options.separator( "Options" )
+      options.on( '--all', '-a', "Removes ALL files from the output directory" ) { @all = true }
+      options.on( '--interactive', '-i', "Ask for each file" ) { @ask = true }
     end
 
-    def content_index_page
-      "---
-title: Empty index page
-inMenu: true
-directoryName: New Website
----
-h2. Empty index file
+    def description; "Removes the generated or all files from the output directory"; end
+
+    def usage; "Usage: #{@options.program_name} [global options] clean [options]"; end
 
-Fill this file with your own data!!!
-"
+    def execute( commandParser, args )
+      if @all
+        logger.info( "Deleting all files from output directory..." )
+        outDir = Plugin['Configuration']['outDirectory']
+        FileUtils.ask_before_delete( @ask, :rm_rf, outDir ) if File.exists?( outDir )
+      else
+        tree = Plugin['FileHandler'].build_tree
+        logger.info( "Deleting generated files from output directory..." )
+        Plugin['CleanWalker'].ask = @ask
+        Plugin['TreeWalker'].execute( tree, Plugin['CleanWalker'], :backward )
+      end
+      logger.info( "Webgen finished 'clean' command" )
     end
 
-  end
+    private
 
+  end
 
   class WebgenCommandParser < CommandParser
 
     def initialize
-      super
+      super( true )
       self.options do |opts|
         opts.program_name = "webgen"
         opts.version = Webgen::VERSION
@@ -332,6 +248,7 @@ Fill this file with your own data!!!
       self.add_command( RunWebgenCommand.new, true )
       self.add_command( ShowCommand.new )
       self.add_command( CreateCommand.new )
+      self.add_command( CleanCommand.new )
       self.add_command( CommandParser::HelpCommand.new )
       self.add_command( CommandParser::VersionCommand.new )
     end
@@ -343,16 +260,10 @@ Fill this file with your own data!!!
 
     def main( cmdOptions )
       Color.colorify if $stdout.isatty && !Config::CONFIG['arch'].include?( 'mswin32' )
-      begin
-        wcp = WebgenCommandParser.new
-        wcp.parse!( ARGV, false )
-        Plugin['Configuration'].init_all
-        wcp.execute
-      rescue CommandParser::InvalidCommandError => e
-        puts "Error: invalid command given"
-        puts
-        wcp.commands['help'].execute( wcp, {} )
-      end
+      wcp = WebgenCommandParser.new
+      wcp.parse!( ARGV, false )
+      Plugin['Configuration'].init_all
+      wcp.execute
     end
 
   end