webgen 0.5.5 → 0.5.6

data/lib/webgen/sourcehandler/virtual.rb

@@ -1,7 +1,5 @@
 require 'uri'
 require 'yaml'
-require 'webgen/sourcehandler/base'
-require 'webgen/websiteaccess'
 
 module Webgen::SourceHandler
 
@@ -18,22 +16,25 @@ module Webgen::SourceHandler
     def create_node(parent, path)
       page = page_from_path(path)
       nodes = []
-      YAML::load(page.blocks['content'].content).each do |key, value|
+      YAML::load(page.blocks['content'].content).each do |key, meta_info|
         key = (key =~ /^\// ? key : File.join(parent.absolute_lcn, key))
         temp_parent = create_directories(parent.tree.root, File.dirname(key), path)
 
-        temp_path = Webgen::Path.new(key)
-        temp_path.meta_info.update(value || {})
-        temp_path.meta_info['modified_at'] = path.meta_info['modified_at']
-        temp_path.meta_info['no_output'] = true
-        output_path = temp_path.meta_info.delete('url') || key
+        meta_info ||= {}
+        meta_info['modified_at'] = path.meta_info['modified_at']
+        meta_info['no_output'] = true
+        output_path = meta_info.delete('url') || key
         output_path = (URI::parse(output_path).absolute? || output_path =~ /^\// ?
                        output_path : File.join(temp_parent.absolute_lcn, output_path))
 
         if key =~ /\/$/
-          nodes << create_directory(temp_parent, key, path, temp_path.meta_info)
+          nodes << create_directory(temp_parent, key, path, meta_info)
         else
-          nodes << super(temp_parent, temp_path, output_path) {|n| n.node_info[:src] = path.path}
+          nodes += website.blackboard.invoke(:create_nodes, parent.tree, temp_parent.absolute_lcn,
+                                             Webgen::Path.new(key, path.source_path), self) do |cn_parent, cn_path|
+            cn_path.meta_info.update(meta_info)
+            super(cn_parent, cn_path, output_path)
+          end
         end
       end if page.blocks.has_key?('content')
       nodes.compact
@@ -55,17 +56,16 @@ module Webgen::SourceHandler
     def create_directory(parent, dir, path, meta_info = nil)
       dir_handler = website.cache.instance('Webgen::SourceHandler::Directory')
       website.blackboard.invoke(:create_nodes, parent.tree, parent.absolute_lcn,
-                                Webgen::Path.new(File.join(dir, '/')),
+                                Webgen::Path.new(File.join(dir, '/'), path.source_path),
                                 dir_handler) do |par, temp_path|
-        node = nil
-        if (node = dir_handler.node_exists?(par, temp_path)) && (!meta_info || node.node_info[:src] != path.path)
-          parent, node = node, nil
-        else
+        parent = dir_handler.node_exists?(par, temp_path)
+        if (parent && (parent.node_info[:src] == path.source_path) && !meta_info.nil?) ||
+            !parent
           temp_path.meta_info.update(meta_info) if meta_info
-          parent = node = dir_handler.create_node(par, temp_path)
-          parent.node_info[:src] = path.path
+          parent.flag(:reinit) if parent
+          parent = dir_handler.create_node(par, temp_path)
         end
-        node
+        parent
       end
       parent
     end

data/lib/webgen/tag.rb

@@ -17,6 +17,8 @@ module Webgen
     autoload :Coderay, 'webgen/tag/coderay'
     autoload :Date, 'webgen/tag/date'
     autoload :Sitemap, 'webgen/tag/sitemap'
+    autoload :TikZ, 'webgen/tag/tikz'
+    autoload :Link, 'webgen/tag/link'
 
   end
 

data/lib/webgen/tag/breadcrumbtrail.rb

@@ -1,6 +1,3 @@
-require 'webgen/websiteaccess'
-require 'webgen/tag'
-
 module Webgen::Tag
 
   # Generates a breadcrumb trail for the page. This is especially useful when pages are in deep
@@ -60,7 +57,7 @@ module Webgen::Tag
 
         if (list.map {|n| n.absolute_lcn} != cached_list) ||
             list.any? {|n| (r = n.routing_node(cn.lang)) && r != node && r.meta_info_changed?}
-          node.dirty = true
+          node.flag(:dirty)
           break
         end
       end

data/lib/webgen/tag/coderay.rb

@@ -1,6 +1,3 @@
-require 'webgen/websiteaccess'
-require 'webgen/tag'
-
 module Webgen::Tag
 
   # Provides syntax highlighting via the +coderay+ library.

data/lib/webgen/tag/date.rb

@@ -1,5 +1,3 @@
-require 'webgen/tag'
-
 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,6 +1,5 @@
-require 'webgen/tag'
 require 'cgi'
-require "tempfile"
+require 'tempfile'
 require 'rbconfig'
 
 module Webgen::Tag

data/lib/webgen/tag/includefile.rb

@@ -1,5 +1,3 @@
-require 'webgen/websiteaccess'
-require 'webgen/tag'
 require 'cgi'
 
 module Webgen::Tag
@@ -33,7 +31,7 @@ module Webgen::Tag
 
     def node_changed?(node)
       if filenames = node.node_info[:tag_includefile_filenames]
-        node.dirty = true if filenames.any? {|f, mtime| File.mtime(f) > mtime}
+        node.flag(:dirty) if filenames.any? {|f, mtime| File.mtime(f) > mtime}
       end
     end
 

data/lib/webgen/tag/langbar.rb

@@ -1,6 +1,3 @@
-require 'webgen/tag'
-require 'webgen/websiteaccess'
-
 module Webgen::Tag
 
   # Generates a list with all the languages of the page.
@@ -20,7 +17,7 @@ module Webgen::Tag
       result = lang_nodes.
         reject {|n| (context.content_node.lang == n.lang && !param('tag.langbar.show_own_lang'))}.
         sort {|a, b| a.lang <=> b.lang}.
-        collect {|n| context.dest_node.link_to(n, :link_text => n.lang, :lang => n.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 : "")
     end
@@ -41,7 +38,7 @@ module Webgen::Tag
         lang_nodes = all_lang_nodes(node.tree[acn, :acn]) rescue nil
         if !lang_nodes || lang_nodes.length != clang_nodes.length ||
             lang_nodes.any? {|n| n.meta_info_changed?}
-          node.dirty = true
+          node.flag(:dirty)
           break
         end
       end

data/lib/webgen/tag/link.rb

@@ -0,0 +1,23 @@
+module Webgen::Tag
+
+  # Create a link to a given (A)LCN.
+  class Link
+
+    include Webgen::Tag::Base
+
+    # Return a HTML link to the given (A)LCN.
+    def call(tag, body, context)
+      if (dest_node = context.ref_node.resolve(param('tag.link.path'), context.dest_node.lang))
+        context.dest_node.link_to(dest_node, param('tag.link.attr').merge(:lang => context.content_node.lang))
+      else
+        raise ArgumentError, 'Resolving of path failed'
+      end
+    rescue ArgumentError, URI::InvalidURIError => e
+      log(:error) { "Could not link to path '#{param('tag.link.path')}' in <#{context.ref_node.absolute_lcn}>: #{e.message}" }
+      context.dest_node.flag(:dirty)
+      ''
+    end
+
+  end
+
+end

data/lib/webgen/tag/menu.rb

@@ -1,6 +1,3 @@
-require 'webgen/websiteaccess'
-require 'webgen/tag'
-
 module Webgen::Tag
 
   # Generates a menu that can be configured extensively.
@@ -90,7 +87,7 @@ module Webgen::Tag
             (tree_list && tree_list.flatten.any? do |alcn|
                (n = node.tree[alcn]) && (r = n.routing_node(cn.lang)) && r != node && r.meta_info_changed?
              end)
-          node.dirty = true
+          node.flag(:dirty)
           break
         end
       end

data/lib/webgen/tag/metainfo.rb

@@ -1,5 +1,3 @@
-require 'webgen/tag'
-
 module Webgen::Tag
 
   # Provides easy access to the meta information of a node.

data/lib/webgen/tag/relocatable.rb

@@ -1,4 +1,3 @@
-require 'webgen/tag'
 require 'uri'
 
 module Webgen::Tag
@@ -27,11 +26,11 @@ module Webgen::Tag
           end
           if result.empty?
             log(:error) { "Could not resolve path '#{uri_string}' in <#{context.ref_node.absolute_lcn}>" }
-            context.dest_node.dirty = true
+            context.dest_node.flag(:dirty)
           end
         rescue URI::InvalidURIError => e
           log(:error) { "Error while parsing path for tag relocatable in <#{context.ref_node.absolute_lcn}>: #{e.message}" }
-          context.dest_node.dirty = true
+          context.dest_node.flag(:dirty)
         end
       end
       result

data/lib/webgen/tag/sitemap.rb

@@ -1,6 +1,3 @@
-require 'webgen/websiteaccess'
-require 'webgen/tag'
-
 module Webgen::Tag
 
   # Generates a sitemap. The sitemap contains the hierarchy of all pages on the web site.

data/lib/webgen/tag/tikz.rb

@@ -0,0 +1,117 @@
+require 'erb'
+require 'tempfile'
+require 'fileutils'
+
+module Webgen::Tag
+
+  # This tag allows the creation and inclusion of complex graphics using the PGF/TikZ library of
+  # LaTeX. You will need a current LaTeX distribution and the +convert+ utility from ImageMagick.
+  class TikZ
+
+    include Webgen::Tag::Base
+    include Webgen::WebsiteAccess
+
+    LATEX_TEMPLATE = <<EOF
+\\nonstopmode \\documentclass{article} \\usepackage{tikz} \\pagestyle{empty}
+<% if param('tag.tikz.libraries') %>
+\\usetikzlibrary{<%= param('tag.tikz.libraries').join(',') %>}
+<% end %>
+\\begin{document}
+<% if param('tag.tikz.opts') %>
+\\begin{tikzpicture}[<%= param('tag.tikz.opts') %>]
+<% else %>
+\\begin{tikzpicture}
+<% end %>
+<%= body %>
+\\end{tikzpicture}
+\\end{document}
+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
+
+      mem_handler = website.cache.instance('Webgen::SourceHandler::Memory')
+      src_path = context.ref_node.node_info[:src]
+      parent = website.blackboard.invoke(:create_directories, context.ref_node.tree.root, File.dirname(path), src_path)
+      params = @params
+
+      node = website.blackboard.invoke(:create_nodes, parent.tree, parent.absolute_lcn,
+                                       Webgen::Path.new(path, src_path), mem_handler) do |node_parent, node_path|
+        mem_handler.create_node(node_parent, node_path, context.ref_node.absolute_lcn) do |pic_node|
+          set_params(params)
+          document = ERB.new(LATEX_TEMPLATE).result(binding)
+          pic_path = compile(document, File.extname(path), context)
+          set_params(nil)
+          if pic_path
+            io = Webgen::Path::SourceIO.new { File.open(pic_path, 'rb') }
+          else
+            pic_node.flag(:dirty)
+            nil
+          end
+        end
+      end.first
+      attrs = param('tag.tikz.img_attr').collect {|name,value| "#{name.to_s}=\"#{value}\"" }.sort.unshift('').join(' ')
+      "<img src=\"#{context.dest_node.route_to(node)}\"#{attrs} />"
+    end
+
+    #######
+    private
+    #######
+
+    # Compile the LaTeX +document+ and convert the resulting PDF to the correct output image format
+    # specified by +ext+ (the extension needs to include the dot).
+    def compile(document, ext, context)
+      file = Tempfile.new('webgen-tikz')
+      file.write(document)
+      file.close
+
+      FileUtils.mv(file.path, file.path + '.tex')
+      cmd_prefix = "cd #{File.dirname(file.path)}; "
+      output = `#{cmd_prefix} pdflatex --shell-escape -interaction=batchmode #{File.basename(file.path)}.tex`
+      if $?.exitstatus != 0
+        errors = output.scan(/^!(.*\n.*)/).join("\n")
+        log(:error) { "There was an error creating a TikZ picture in <#{context.ref_node.absolute_lcn}>: #{errors}"}
+        context.dest_node.flag(:dirty)
+        nil
+      else
+        cmd = cmd_prefix + "pdfcrop #{File.basename(file.path)}.pdf #{File.basename(file.path)}.pdf; "
+        return unless run_command(cmd, context)
+
+        render_res, output_res = param('tag.tikz.resolution').split(' ')
+        if param('tag.tikz.transparent') && ext =~ /\.png/i
+          cmd = cmd_prefix +
+            "gs -dSAFER -dBATCH -dNOPAUSE -r#{render_res} -sDEVICE=pngalpha -dGraphicsAlphaBits=4 -dTextAlphaBits=4 " +
+            "-sOutputFile=#{File.basename(file.path)}#{ext} #{File.basename(file.path)}.pdf"
+        else
+          cmd = cmd_prefix + "convert -density #{render_res} #{File.basename(file.path)}.pdf #{File.basename(file.path)}#{ext}"
+        end
+        return unless run_command(cmd, context)
+
+        if render_res != output_res
+          cmd = cmd_prefix + "identify #{File.basename(file.path)}#{ext}"
+          return unless (output = run_command(cmd, context))
+          width, height = output.scan(/\s\d+x\d+\s/).first.strip.split('x').collect {|s| s.to_f * output_res.to_f / render_res.to_f }
+          cmd = cmd_prefix + "convert -resize #{width}x#{height} #{File.basename(file.path)}#{ext} #{File.basename(file.path)}#{ext}"
+          return unless run_command(cmd, context)
+        end
+        file.path + ext
+      end
+    end
+
+    # Runs the command +cmd+ and returns it's output if successful or +nil+ otherwise.
+    def run_command(cmd, context)
+      output = `#{cmd}`
+      if $?.exitstatus != 0
+        log(:error) { "There was an error running a command for a TikZ picture in <#{context.ref_node.absolute_lcn}>: #{output}"}
+        context.dest_node.flag(:dirty)
+        nil
+      else
+        output
+      end
+    end
+
+  end
+
+end

data/lib/webgen/tree.rb

@@ -51,20 +51,25 @@ module Webgen
         @node_access[:alcn][node.absolute_lcn] = node
       end
       (@node_access[:acn][node.absolute_cn] ||= []) << node
+      register_path(node)
+    end
+
+    # A utility method called by Node#reinit. This method should not be used directly!
+    def register_path(node)
+      return if node['no_output']
       if @node_access[:path].has_key?(node.path)
-        raise "Can't have two nodes with same output path: #{node.path}" unless node['no_output']
+        raise "Can't have two nodes with same output path: #{node.path}"
       else
         @node_access[:path][node.path] = node
       end
     end
 
-    # Delete the node identified by +node_or_alcn+ and all of its children from the
-    # tree. Directories are only deleted if +delete_dir+ is +true+.
-    def delete_node(node_or_alcn, delete_dir = false)
+    # Delete the node identified by +node_or_alcn+ and all of its children 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 || (n.is_directory? && !delete_dir)
+      return if n.nil? || n == @dummy_root
 
-      n.children.dup.each {|child| delete_node(child, delete_dir)}
+      n.children.dup.each {|child| delete_node(child)}
 
       website.blackboard.dispatch_msg(:before_node_deleted, n)
       n.parent.children.delete(n)

data/lib/webgen/version.rb

@@ -1,6 +1,6 @@
 module Webgen
 
   # The version of webgen.
-  VERSION = '0.5.5'
+  VERSION = '0.5.6'
 
 end

data/lib/webgen/website.rb

@@ -2,6 +2,7 @@
 require 'logger'
 require 'set'
 require 'fileutils'
+require 'facets/symbol/to_proc'
 
 # Requirements for Website
 require 'webgen/coreext'
@@ -197,7 +198,7 @@ module Webgen
           raise 'Structure of config file is not valid, has to be a Hash' if !config.kind_of?(Hash)
           config.each do |key, value|
             case key
-            when *Webgen::Configuration::Helpers.public_instance_methods(false) then @config.send(key, value)
+            when *Webgen::Configuration::Helpers.public_instance_methods(false).map(&:to_s) then @config.send(key, value)
             else @config[key] = value
             end
           end

data/test/test_cli.rb

@@ -0,0 +1,14 @@
+require 'test/unit'
+require 'webgen/cli'
+
+class TestCLICommandParser < Test::Unit::TestCase
+
+  def test_initialize
+    cli = Webgen::CLI::CommandParser.new
+    assert_equal('render', cli.main_command.default_command)
+    assert_equal(:normal, cli.verbosity)
+    assert_equal(Logger::WARN, cli.log_level)
+    assert_equal(Dir.pwd, cli.directory)
+  end
+
+end

data/test/test_common_sitemap.rb

@@ -44,13 +44,13 @@ class TestCommonSitemap < Test::Unit::TestCase
     do_assert(@nodes[:file1_de], 'de', false, true, ['page'],
               [:dir1, :file11_en, :file1_de, :index_en])
 
-    @nodes[:file11_en].dirty = false
+    @nodes[:file11_en].unflag(:dirty)
     @website.blackboard.dispatch_msg(:node_changed?, @nodes[:file11_en])
-    assert(!@nodes[:file11_en].dirty)
+    assert(!@nodes[:file11_en].flagged(:dirty))
 
-    @nodes[:file11_en].dirty_meta_info = true
+    @nodes[:file11_en].flag(:dirty_meta_info)
     @website.blackboard.dispatch_msg(:node_changed?, @nodes[:file11_en])
-    assert(@nodes[:file11_en].dirty)
+    assert(@nodes[:file11_en].flagged(:dirty))
   end
 
 end

data/test/test_contentprocessor_context.rb

@@ -1,6 +1,6 @@
 require 'test/unit'
 require 'helper'
-require 'webgen/contentprocessor/context'
+require 'webgen/contentprocessor'
 
 class TestContentProcessorContext < Test::Unit::TestCase