webgen 0.5.1 → 0.5.2

data/data/webgen/webgui/view/error.xhtml

@@ -0,0 +1,64 @@
+<link rel="stylesheet" href="/css/ramaze_error.css" />
+<script type="text/javascript" src="/js/jquery.js"></script>
+
+<p>The backtrace gives filenames and line numbers for all parts of the call stack.<br />
+Click on any of them to view the surrounding source code.</p>
+
+<h3>#@title</h3>
+
+<table class="main">
+  <tr class="head">
+    <td>File</td><td>Line</td><td>Method</td>
+  </tr>
+  <?r @backtrace.each do |lines, hash, file, lineno, meth| ?>
+    <tr class="line" id="#{hash}">
+      <td>#{file}</td><td class="lineno">#{lineno}</td><td><pre>#{meth}</pre></td>
+    </tr>
+    <tr id="source_#{hash}" style="display:none;">
+      <td colspan="3">
+        <div class="source">
+          <table style="width:100%;">
+            <tr>
+              <td class="editor" colspan="2">
+                #{@editor} #{file} +#{lineno}
+                <div style="float: right">
+                  <a href="txmt://open?url=file://#{file}&line=#{lineno}">open in textmate</a>
+                </div>
+              </td>
+            </tr>
+            <?r lines.each do |llineno, lcode, lcurrent| ?>
+              <tr class="source" #{'style="background:#faa;"' if lcurrent}>
+                <td class="lineno">#{llineno}</td>
+                <td class="code"><pre>#{lcode.to_s.rstrip}</pre></td>
+              </tr>
+            <?r end ?>
+          </table>
+        </div>
+      </td>
+    </tr>
+  <?r end ?>
+</table>
+
+<?r
+  { 'Session'   => Thread.current[:session],
+    'Request'   => Thread.current[:request],
+    'Response'  => Thread.current[:response],
+    'Global'    => Global,
+  }.each do |title, content|
+    hash = [title, content].object_id.abs
+  ?>
+  <div class="additional">
+    <h3 id="#{hash}">#{title}</h3>
+    <pre style="display:none" id="is_#{hash}">#{CGI.escapeHTML(content.pretty_inspect)}</pre>
+  </div>
+<?r end ?>
+
+<script type="text/javascript">
+  $("tr.line").click(function(){
+    $("tr#source_"+this.id).toggle()
+  });
+
+  $("div.additional > h3").click(function(){
+    $("pre#is_"+this.id).toggle()
+  });
+</script>

data/data/webgen/webgui/view/index.xhtml

@@ -0,0 +1,22 @@
+<h2>Welcome to the webgen webgui!</h2>
+
+<p>
+  This web application lets you create and manage webgen website. Just set the directory of an
+  existing or a to-be-created website in the top right corner and click the button!
+</p>
+
+<ul>
+  <li>
+    If you select an existing directory, the webgui assumes that it is a webgen website directory and
+    presents you with page for managing a webgen website.
+  </li>
+  <li>
+    If you select a non-existing directory, the webgui shows you a page for creating a webgen website.
+  </li>
+</ul>
+
+<p>
+  The text input field uses auto-completion to show you the available directories on your
+  computer. You can either start typing an absolute path name or relative one which will be resolved
+  from the directory in which you started the webgui.
+</p>

data/data/webgen/webgui/view/manage_website.xhtml

@@ -0,0 +1,18 @@
+<form method='post' action='#{R :manage_website}'>
+  <p>
+    <label for='verbosity'>Verbosity:
+    <select id='verbosity' name='verbosity'>
+      <option #{@verbosity == 'normal' ? selected='selected' : ''}>normal</option>
+      <option #{@verbosity == 'verbose' ? selected='selected' : ''}>verbose</option>
+      <option #{@verbosity == 'quiet' ? selected='selected' : ''}>quiet</option>
+    </select>
+    <input type='submit' id='render_site' name='render_site' value='Render website' />
+    <!-- <input type='submit' id='auto_render_site' name='auto_render_site' value='#{session['auto_render'] ? 'Stop auto-rendering' : 'Start auto-rendering'}' /> -->
+  </p>
+</form>
+
+<div id='website_log'>
+  <pre>#{CGI::escapeHTML(@log.to_s)}</pre>
+</div>
+
+<object id='website_preview' type='text/html' data='#{R :preview_website, "/index.html"}' width='100%' height='600px' style='border: 1px solid black' />

data/data/webgen/webgui/view/page.xhtml

@@ -0,0 +1,40 @@
+<?xml version="1.0" ?>
+<!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">
+  <head>
+    <title>#{@title}</title>
+    <meta http-equiv="Content-Script-Type" content="text/javascript" />
+    <meta http-equiv="Content-Style-Type" content="text/css" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
+    <link href="#{R '/css/style.css'}" rel="stylesheet" type="text/css" />
+    <link href="#{R '/css/jquery.autocomplete.css'}" rel="stylesheet" type="text/css" />
+
+    <script type='text/javascript' src="#{R '/js/jquery.js'}"></script>
+    <script type='text/javascript' src="#{R '/js/jquery.autocomplete.js'}"></script>
+    <script type='text/javascript'>
+      $(document).ready(function() {
+      $("#website_dir").autocomplete('#{R MainController, :path_autocomplete}');
+      });
+    </script>
+  </head>
+  <body>
+    <div id="header">
+      <img src="#{R '/img/webgen_logo.png'}" alt='logo' />
+      <h2><a href="#{R '/'}">webgen <span>webgui</span></a></h2>
+
+      <div id='site-select-form'>
+        <form method='post' action='#{R MainController, :site_ops}'>
+          <p>
+            <input type='text' id='website_dir' name='website_dir' value='#{session["website_dir"]}' size="70" />
+            <input type='submit' id='set_site' name='set_site' value='Set website directory' />
+          </p>
+        </form>
+      </div>
+
+    </div>
+    <div id="content">
+      #@content
+    </div>
+  </body>
+</html>

data/doc/extensions.page

@@ -1,6 +1,5 @@
 ---
 title: Extensions
-in_menu: true
 ---
 # webgen Extensions
 
@@ -19,4 +18,4 @@ next if n.is_fragment?
 * <%= dest_node.link_to(n) %>
 <%
 end
-%>
+%>

data/doc/getting_started.page

@@ -46,9 +46,13 @@ possibilities:
   example `webgen -d sample_site`.
 
 Easy! webgen has used all files in the `src` directory and created the HTML output in the directory
-`out`. Since webgen automatically creates relative links, you can just open the `index.html` file
-and you will have a fully functional website - no web server needed! However, as we did not write
-any content yet, there is not much to see (only the default pages). So let's do that now!
+`out`. Now you just need to open the `out/index.html` file to view your website! However, as we did
+not write any content yet, there is not much to see (only the default pages). So let's do that now!
+
+> Since webgen automatically creates relative links, you will have a fully functional website
+> without needing a web server! This also implies that you can deploy your website to any directory
+> on your web server and it will just work!
+{.information}
 
 
 ### Adding Content

data/doc/manual.page

@@ -42,9 +42,84 @@ Following is a short overview of the available commands:
 
     Displays the version of webgen.
 
+*   `webgui`
+
+    Starts the webgen webgui, a browser based graphical user interface for managing webgen
+    websites. First the webgui web application is started and then the webgui is opened in the
+    default browser.
+
 [cmdparse]: http://cmdparse.rubyforge.org
 
 
+
+# A webgen Website {#website}
+
+webgen needs a special directory structure so that it works out of the box. This directory structure
+is automatically created by the `webgen create` command.
+
+The root directory of webgen website is called the website directory. You can have the following
+files and directories under this directory:
+
+* `src`: The source directory in which all the source files for the website are. If this directory
+  is not called `src` or you want to include additional source directories, you need to change the
+  `sources` configuration option.
+
+* `out`: This directory is created, if it does not exist, when webgen generates the HTML files. All
+  the output files are put into this directory. This directory can be changed by setting the
+  `output` configuration option.
+
+* `ext`: The extension directory (optional). You can put self-written extensions into this directory
+  so that they are used by webgen.
+
+* `config.yaml`: This file can be used to set configuration options for the website. See the
+  [Configuration File]({relocatable: '#website-configfile'}) section for more information.
+
+* `Rakefile`: This file is provided for your convenience to execute tasks via `rake` and provides
+  some useful tasks out of the box. See the [Rakefile]({relocatable: '#website-rakefile'}) section
+  for more information.
+
+
+## Configuration File {#website-configfile}
+
+Many user will want to change some configuration options, for example, the default language of the
+website since not all people will want to write websites in English. This is primarily done via the
+configuration file.
+
+The configuration file is called `config.yaml` and has to be placed directly under the website
+directory. It uses [YAML](http://www.yaml.org) as file format. You can find a list of all available
+configuration options that can be set in the [Configuration Options Reference]({relocatable:
+reference_configuration.html}).
+
+Each configuration option can be set in the configuration file by specifing the configuration option
+name and the new value as a key/value pair. A sample configuration file looks like this:
+
+    website.lang: de
+    website.link_to_current_page: true
+
+There is one special key called `default_meta_info` which behaves a little different. It does not
+map to any configuration option but is used to update the meta information hashes of the
+configuration option `sourcehandler.default_meta_info`. For example, the following configuration
+file updates the default meta information for all source handlers by setting a new value for
+`output_path_style` and setting `in_menu` to `true`:
+
+    default_meta_info:
+      :all:
+        output_path_style: [:parent, :cnbase, :ext, [., :lang]]
+        in_menu: true
+
+
+## Rakefile {#website-rakefile}
+
+The Rakefile that is automatically created upon website creation provides a place to specify
+recurring task for your website, for example, for deploying the website to a server. It contains
+some useful tasks out of the box:
+
+* `webgen`: Renders the webgen website once.
+* `auto_webgen`: Automatically renders the website when a source file has changed.
+* `clobber_webgen`: Removes all webgen generated products (the output files and the cache file).
+
+
+
 # All About Paths and Sources   {#source}
 
 A source provides paths that identity files or directories. webgen can use paths from many sources.
@@ -312,35 +387,6 @@ There is clearly defined order in which meta information is applied to a node fo
 
 
 
-# The Configuration File
-
-Many user will want to change some configuration options, for example, the default language of the
-website since not all people will want to write websites in English. This is primarily done via the
-configuration file.
-
-The configuration file is called `config.yaml` and has to be placed directly under the website
-directory. It uses [YAML](http://www.yaml.org) as file format. You can find a list of all available
-configuration options that can be set in the [Configuration Options Reference]({relocatable:
-reference_configuration.html}).
-
-Each configuration option can be set in the configuration file by specifing the configuration option
-name and the new value as a key/value pair. A sample configuration file looks like this:
-
-    website.lang: de
-    website.link_to_current_page: true
-
-There is one special key called `default_meta_info` which behaves a little different. It does not
-map to any configuration option but is used to update the meta information hashes of the
-configuration option `sourcehandler.default_meta_info`. For example, the following configuration
-file updates the default meta information for all source handlers by setting a new value for
-`output_path_style` and setting `in_menu` to `true`:
-
-    default_meta_info:
-      :all:
-        output_path_style: [:parent, :cnbase, :ext, [., :lang]]
-        in_menu: true
-
-
 # Extending webgen
 
 If you know the programming language Ruby a little bit, you can easily extend webgen and add new

data/lib/webgen/cache.rb

@@ -14,11 +14,25 @@ module Webgen
   # standard:: The standard cache saves data between webgen runs and returns the cached data (not
   #            the newly set data) if it is available. This is useful, for example, to store file
   #            modifcation times and check if a file has been changed between runs.
+  #
+  # The standard cache should be accessed through the <tt>[]</tt> method which returns the correct
+  # value and the <tt>[]=</tt> method should be used for setting the new value. However, if you
+  # really need to access a particular value of the old or new standard cache, you can use the
+  # accessors +old_data+ and +new_data+.
   class Cache
 
     # The permanent cache hash.
     attr_reader :permanent
 
+    # The volatile cache hash.
+    attr_reader :volatile
+
+    # The cache data stored in the previous webgen run.
+    attr_reader :old_data
+
+    # The cache data stored in the current webgen run.
+    attr_reader :new_data
+
     # Create a new cache object.
     def initialize()
       @old_data = {}
@@ -53,15 +67,9 @@ module Webgen
       [@old_data.merge(@new_data), @permanent]
     end
 
-    # Return the volatile cache hash. If volatile caching has not been enabled, a new hash is
-    # returned on every invocation!
-    def volatile
-      (@volatile[:enabled] ? @volatile : {})
-    end
-
-    # Enable the volatile cache.
-    def enable_volatile_cache
-      @volatile[:enabled] = true
+    # Reset the volatile cache.
+    def reset_volatile_cache
+      @volatile = {:classes => @volatile[:classes]}
     end
 
     # Return the unique instance of the class +name+. This method should be used when it is

data/lib/webgen/cli.rb

@@ -58,6 +58,7 @@ module Webgen
 
     autoload :RunCommand, 'webgen/cli/run_command'
     autoload :CreateCommand, 'webgen/cli/create_command'
+    autoload :WebguiCommand, 'webgen/cli/webgui_command'
 
     autoload :Utils, 'webgen/cli/utils'
 
@@ -81,6 +82,7 @@ module Webgen
         @directory = Dir.pwd
         @verbosity = :normal
         @log_level = ::Logger::WARN
+        @log_filter = nil
 
         self.program_name = "webgen"
         self.program_version = Webgen::VERSION
@@ -89,7 +91,7 @@ module Webgen
           opts.on("--directory DIR", "-d", String, "The website directory (default: the current directory)") {|@directory|}
           opts.on("--verbose", "-v", "Print more output") { @verbosity = :verbose }
           opts.on("--quiet", "-q", "No output") { @verbosity = :quiet }
-          opts.on("--log-level", "-l", [0, 1, 2, 3], "The logging level (0..debug, 3..error)") {|@log_level|}
+          opts.on("--log-level LEVEL", "-l", Integer, "The logging level (0..debug, 3..error)") {|@log_level|}
           opts.on("--log-filter", "-f", Regexp, 'Filter for logging events') {|@log_filter|}
         end
         self.add_command(CmdParse::HelpCommand.new)

data/lib/webgen/cli/utils.rb

@@ -10,7 +10,11 @@ module Webgen::CLI
   class Utils
 
     USE_ANSI_COLORS = !Config::CONFIG['arch'].include?('mswin32')
-    DEFAULT_WIDTH = ((size = %x{stty size 2>/dev/null}).length > 0 ? x.split.last.to_i : 72) rescue 72
+    DEFAULT_WIDTH = if Config::CONFIG['arch'].include?('mswin32')
+                      72
+                    else
+                      ((size = %x{stty size 2>/dev/null}).length > 0 ? size.split.last.to_i : 72) rescue 72
+                    end
 
     # Used for dynamically formatting the text (setting color, bold face, ...).
     def self.method_missing(id, text = nil)

data/lib/webgen/cli/webgui_command.rb

@@ -0,0 +1,48 @@
+require 'webgen/cli'
+
+module Webgen::CLI
+
+  # The CLI command for starting the webgen webgui.
+  class WebguiCommand < CmdParse::Command
+
+    def initialize # :nodoc:
+      super('webgui', false)
+      self.short_desc = 'Starts the webgen webgui'
+    end
+
+    # Render the website.
+    def execute(args)
+      # some fixes for ramaze-2008.06
+      # - fix for Windows bug when win32console is not installed
+      # - fix for message displayed on shutdown
+      $:.unshift File.join(Webgen.data_dir, 'webgui', 'overrides')
+      require 'win32console'
+      $:.shift
+      require 'ramaze'
+      Ramaze::Log.loggers = []
+      def Ramaze.shutdown; end
+
+      acquire Webgen.data_dir/:webgui/:controller/'*'
+      Ramaze::Global.setup do |g|
+        g.root = Webgen.data_dir/:webgui
+        g.public_root = Webgen.data_dir/:webgui/:public
+        g.view_root = Webgen.data_dir/:webgui/:view
+        g.adapter = :webrick
+        g.port = 7000
+      end
+
+      puts 'Starting webgui on http://localhost:7000, press Control-C to stop'
+      Thread.new do
+        sleep 2
+        puts 'Launching web browser'
+        require 'launchy'
+        Launchy.open('http://localhost:7000')
+      end
+
+      Ramaze.start
+      puts 'webgui finished'
+    end
+
+  end
+
+end

data/lib/webgen/node.rb

@@ -50,6 +50,10 @@ module Webgen
     # not be set to +false+ once it is +true+!
     attr_accessor :dirty
 
+    # Set by other objects to +true+ if the meta information of the node has changed since the last
+    # run. Must not be set to +false+ once it is +true+!
+    attr_accessor :dirty_meta_info
+
     # Has the node been created or has it been read from the cache?
     attr_accessor :created
 
@@ -120,6 +124,15 @@ module Webgen
       @dirty
     end
 
+    # Return +true+ if the meta information of the node has changed.
+    def meta_info_changed?
+      @dirty_meta_info = node_info[:used_meta_info_nodes].any? do |n|
+         n != @absolute_lcn && (!tree[n] || tree[n].meta_info_changed?)
+      end unless @dirty_meta_info
+      website.blackboard.dispatch_msg(:node_meta_info_changed?, self) unless @dirty_meta_info
+      @dirty_meta_info
+    end
+
     # Return an informative representation of the node.
     def inspect
       "<##{self.class.name}: alcn=#{@absolute_lcn}>"
@@ -133,7 +146,7 @@ module Webgen
     # Sort nodes by using the meta info +sort_info+ (or +title+ if +sort_info+ is not set) of both
     # involved nodes.
     def <=>(other)
-      self_so = (self['sort_info'] && self['sort_info'].to_s) || self['title'] || ''
+      self_so = (@meta_info['sort_info'] && @meta_info['sort_info'].to_s) || @meta_info['title'] || ''
       other_so = (other['sort_info'] && other['sort_info'].to_s) || other['title'] || ''
       if self_so !~ /\D/ && other_so !~ /\D/
         self_so = self_so.to_i
@@ -295,6 +308,7 @@ module Webgen
       @parent.children << self unless @parent == @tree
 
       self.node_info[:used_nodes] = Set.new
+      self.node_info[:used_meta_info_nodes] = Set.new
     end
 
     # Delegate missing methods to a processor. The current node is placed into the argument array as