webgen 1.0.0.beta2 → 1.0.0.beta3

data/lib/webgen/path_handler/copy.rb

@@ -14,33 +14,8 @@ module Webgen
 
       # Create the node for +path+.
       #
-      # The following order is used for finding the (optional) content processor pipeline:
-      #
-      # * If the pipeline meta info key is specified, it is used.
-      #
-      # * If the +path+ has the names of content processors as parts in the file extension, all
-      #   extension parts until the first non-content processor part will be used for the pipeline
-      #   and removed from the extension.
-      #
-      #   If the last extension part is a file extension registered with a content processor (using
-      #   the :ext_map facility), the corresponding content processor is appended to the pipeline
-      #   and the post-process file extension name is used.
-      #
-      # Here are some examples:
-      #
-      # * pipeline = ['erb'] → only erb is used, extension is not modified
-      #
-      # * path = 'test.erb.kramdown.html', no pipeline → pipeline is set to ['erb', 'kramdown'] and
-      #   path extension is changed to '.html', ie. path = 'test.html'
-      #
-      # * path = 'test.erb.kramdown.unknown.html', no pipeline → pipeline is set ['erb', 'kramdown']
-      #   and path extension is changed to 'unknown.html', ie. path = 'test.unknown.html'
-      #
-      # * path = 'test.erb.sass', no pipeline → pipeline is set to ['erb', 'sass'] and path
-      #   extension is changed to '.css', ie. path = 'test.css'
-      #
-      # * path = 'test.sass', no pipeline → pipeline is set to ['sass'] and path extension is
-      #   changed to '.css', ie. path = 'test.css'
+      # See the user documentation for detailed information about how the content processor pipeline
+      # can be specified.
       def create_nodes(path)
         if !path.meta_info.has_key?('pipeline')
           pipeline = []

data/lib/webgen/path_handler/feed.rb

@@ -58,17 +58,18 @@ module Webgen
       def create_nodes(path, blocks)
         if MANDATORY_INFOS.any? {|t| path.meta_info[t].nil?}
           raise Webgen::NodeCreationError.new("At least one of #{MANDATORY_INFOS.join('/')} is missing",
-                                              self.class.name, path)
+                                              "path_handler.feed", path)
         end
         if !['atom', 'rss'].include?(path['version'])
           raise Webgen::NodeCreationError.new("Invalid version '#{path['version']}' for feed path specified, only atom and rss allowed",
-                                              self.class.name, path)
+                                              "path_handler.feed", path)
         end
 
         path.ext = path['version']
         path['dest_path'] = '<parent><basename>(.<lang>)<ext>'
         path['cn'] = '<basename><ext>'
-        create_node(path, Node) do |node|
+        path['node_class'] = Node.to_s
+        create_node(path) do |node|
           set_blocks(node, blocks)
           node.meta_info['link'] ||= node.parent.alcn
           @website.ext.item_tracker.add(node, :nodes, :node_finder_option_set,

data/lib/webgen/path_handler/meta_info.rb

@@ -50,7 +50,7 @@ module Webgen
         end
         entries
       rescue Exception => e
-        raise Webgen::NodeCreationError.new("Could not parse block '#{block_name}': #{e.message}", self.class.name)
+        raise Webgen::NodeCreationError.new("Could not parse block '#{block_name}': #{e.message}", "path_handler.meta_info")
       end
 
       # Update already existing nodes with meta information from the given meta info node.

data/lib/webgen/path_handler/page_utils.rb

@@ -35,7 +35,7 @@ module Webgen
           end
 
           content_processor = context.website.ext.content_processor
-          context.website.ext.item_tracker.add(context.dest_node, :node_content, alcn)
+          context.website.ext.item_tracker.add(context.dest_node, :node_content, self)
 
           context.content = blocks[name].dup
           context[:block_name] = name
@@ -123,7 +123,8 @@ module Webgen
       end
 
 
-      def create_node(path, node_klass = Node) #:nodoc:
+      def create_node(path) #:nodoc:
+        path['node_class'] ||= Node.to_s
         super
       end
 
@@ -139,7 +140,7 @@ module Webgen
         begin
           page = Webgen::Page.from_data(path.data)
         rescue Webgen::Page::FormatError => e
-          raise Webgen::Error.new("Error reading source path: #{e.message}", self.class.name, path)
+          raise Webgen::Error.new("Error reading source path: #{e.message}", nil, path)
         end
         blocks = page.meta_info.delete('blocks') || {}
         path.meta_info.merge!(page.meta_info)

data/lib/webgen/path_handler/sitemap.rb

@@ -34,11 +34,12 @@ module Webgen
       def create_nodes(path, blocks)
         if MANDATORY_INFOS.any? {|t| path.meta_info[t].nil?}
           raise Webgen::NodeCreationError.new("At least one of #{MANDATORY_INFOS.join('/')} is missing",
-                                              self.class.name, path)
+                                              "path_handler.sitemap", path)
         end
 
         path.ext = 'xml'
-        create_node(path, Node) do |node|
+        path['node_class'] = Node.to_s
+        create_node(path) do |node|
           set_blocks(node, blocks)
           node.node_info[:entries] = {:flatten => true, :and => node['entries']}
           @website.ext.item_tracker.add(node, :nodes, :node_finder_option_set,

data/lib/webgen/path_handler/virtual.rb

@@ -32,8 +32,13 @@ module Webgen
             parent_path = create_directories(File.dirname(key), 'modified_at' => meta_info['modified_at'])
 
             dest_path = meta_info.delete('dest_path') || key
-            dest_path = (URI::parse(dest_path).absolute? || dest_path =~ /^\// ?
-                         dest_path : File.join(parent_path, dest_path))
+            dest_path = if URI::parse(dest_path).absolute?
+                          dest_path
+                        elsif dest_path =~ /^\//
+                          "webgen:#{dest_path}"
+                        else
+                          "webgen:#{File.join(parent_path, dest_path)}"
+                        end
             meta_info['dest_path'] = dest_path
             entry_path = Webgen::Path.new(key, meta_info)
 

data/lib/webgen/tag.rb

@@ -160,16 +160,16 @@ module Webgen
         result, process_output = tdata.object.call(tag, body, context)
         result = context.website.ext.content_processor.call('tags', context.clone(:content => result)).content if process_output
       else
-        raise Webgen::RenderError.new("No tag processor for '#{tag}' found", self.class.name,
+        raise Webgen::RenderError.new("No tag processor for '#{tag}' found", 'tag',
                                       context.dest_node, context.ref_node)
       end
       result
     rescue Webgen::Error => e
       e.path = context.dest_node if e.path.to_s.empty?
+      e.location = "tag.#{tag}" unless e.location
       raise
     rescue Exception => e
-      raise Webgen::RenderError.new(e, (tdata && tdata.object.respond_to?(:name) ? tdata.object.name : "tag '#{tag}'"),
-                                    context.dest_node, context.ref_node)
+      raise Webgen::RenderError.new(e, "tag.#{tag}", context.dest_node, context.ref_node)
     end
 
     # See Webgen::Utils::TagParser#replace_tags.
@@ -190,11 +190,11 @@ module Webgen
                when NilClass then {}
                else
                  raise Webgen::RenderError.new("Invalid parameter type (#{params.class})",
-                                               self.class.name, context.dest_node, context.ref_node)
+                                               "tag", context.dest_node, context.ref_node)
                end
 
       if !tdata.mandatory.all? {|k| values.has_key?(k)}
-        raise Webgen::RenderError.new("Not all mandatory parameters set", self.class.name, context.dest_node, context.ref_node)
+        raise Webgen::RenderError.new("Not all mandatory parameters set", "tag", context.dest_node, context.ref_node)
       end
       config = context.website.config.dup
       config.set_values(values)

data/lib/webgen/tag/execute_command.rb

@@ -19,7 +19,7 @@ module Webgen
         output = `#{command} 2> #{BIT_BUCKET}`
         if $?.exitstatus != 0
           raise Webgen::RenderError.new("Command '#{command}' has return value != 0: #{output}",
-                                        self.name, context.dest_node, context.ref_node)
+                                        "tag.#{tag}", context.dest_node, context.ref_node)
         end
         output = CGI::escapeHTML(output) if context[:config]['tag.execute_command.escape_html']
         [output, context[:config]['tag.execute_command.process_output']]

data/lib/webgen/tag/include_file.rb

@@ -16,7 +16,7 @@ module Webgen
         filename = File.join(context.website.directory, filename) unless filename =~ /^(\/|\w:)/
         if !File.exists?(filename)
           raise Webgen::RenderError.new("File '#{filename}' cannot be included because it does not exist",
-                                        self.name, context.dest_node, context.ref_node)
+                                        "tag.#{tag}", context.dest_node, context.ref_node)
         end
 
         content = File.read(filename)

data/lib/webgen/tag/link.rb

@@ -10,14 +10,14 @@ module Webgen
       def self.call(tag, body, context)
         path = context[:config]['tag.link.path'].to_s
         if (dest_node = context.ref_node.resolve(path, context.dest_node.lang, true))
-          context.website.ext.item_tracker.add(context.dest_node, :node_meta_info, dest_node.alcn)
+          context.website.ext.item_tracker.add(context.dest_node, :node_meta_info, dest_node)
           context.dest_node.link_to(dest_node, context.content_node.lang, context[:config]['tag.link.attr'])
         else
           ''
         end
       rescue URI::InvalidURIError => e
         raise Webgen::RenderError.new("Error while parsing path '#{path}': #{e.message}",
-                                      self.name, context.dest_node, context.ref_node)
+                                      "tag.#{tag}", context.dest_node, context.ref_node)
       end
 
     end

data/lib/webgen/tag/menu.rb

@@ -30,7 +30,7 @@ module Webgen
       def self.menu_item_details(dest_node, node, lang, level, has_submenu)
         styles = ['webgen-menu-level' + level.to_s]
         styles << 'webgen-menu-submenu' if has_submenu
-        styles << 'webgen-menu-submenu-inhierarchy' if has_submenu && node.is_ancestor_of?(dest_node)
+        styles << 'webgen-menu-submenu-inhierarchy' if node.is_ancestor_of?(dest_node)
         styles << 'webgen-menu-item-selected' if node == dest_node
         style = "class=\"#{styles.join(' ')}\"" if styles.length > 0
 

data/lib/webgen/tag/meta_info.rb

@@ -9,6 +9,7 @@ module Webgen
 
       # Treat +tag+ as a meta information key and return its value from the content node.
       def self.call(tag, body, context)
+        tag = context[:config]['tag.meta_info.mi'] if tag == 'meta_info'
         output = ''
         if tag == 'lang'
           output = context.content_node.lang

data/lib/webgen/tag/relocatable.rb

@@ -46,7 +46,7 @@ module Webgen
         end
 
         if dest_node
-          context.website.ext.item_tracker.add(context.dest_node, :node_meta_info, dest_node.alcn)
+          context.website.ext.item_tracker.add(context.dest_node, :node_meta_info, dest_node)
           context.dest_node.route_to(dest_node) + fragment
         else
           ''

data/lib/webgen/tag/tikz.rb

@@ -15,7 +15,6 @@ module Webgen
         path = Webgen::Path.new(path)
 
         add_tikz_options!(path, context)
-
         node = context.website.ext.path_handler.create_secondary_nodes(path, body, context.ref_node.alcn).first
 
         attrs = {'alt' => ''}.merge(context[:config]['tag.tikz.img_attr']).collect do |name, value|
@@ -27,7 +26,8 @@ module Webgen
       # Add all needed options for Webgen::ContentProcessor::Tikz to the given path.
       def self.add_tikz_options!(path, context)
         %w[content_processor.tikz.resolution content_processor.tikz.transparent
-           content_processor.tikz.libraries content_processor.tikz.opts].each do |opt|
+           content_processor.tikz.libraries content_processor.tikz.opts
+           content_processor.tikz.template].each do |opt|
           path.meta_info[opt] = context[:config][opt]
         end
         path.meta_info['pipeline'] = 'tikz'

data/lib/webgen/task/create_website.rb

@@ -67,7 +67,7 @@ module Webgen
             ws = Webgen::Website.new(tmpdir) do |ws|
               ws.config['sources'] = [['/', :file_system, File.join(Webgen::Utils.data_dir, 'basic_website_template')]]
               if template
-                ws.config['sources'] = [(['/', :file_system, website.ext.task.data(:create_website)[:templates][template]])]
+                ws.config['sources'].unshift(['/', :file_system, website.ext.task.data(:create_website)[:templates][template]])
               end
               ws.config['destination'] = [:file_system, File.expand_path(website.directory)]
               ws.ext.path_handler.registered_extensions.each do |name, data|

data/lib/webgen/test_helper.rb

@@ -4,6 +4,7 @@ require 'minitest/autorun'
 require 'ostruct'
 require 'tmpdir'
 require 'stringio'
+require 'fileutils'
 require 'webgen/logger'
 
 require 'webgen/blackboard'
@@ -66,7 +67,7 @@ module Webgen
       @logio.string = ''
     end
 
-    # Creates a basic mock website that is accessible via @website with the following methods:
+    # Creates a basic stub website that is accessible via @website with the following methods:
     #
     # [@website.config]
     #   The given config object or {} if none specified
@@ -90,19 +91,22 @@ module Webgen
     # [@website.tree]
     #   Webgen::Tree instance
     def setup_website(config = {})
-      @website = MiniTest::Mock.new
-      @website.expect(:config, config)
-      directory = Dir::Tmpname.create("test-webgen-website") {|path| raise Errno::EEXIST if File.directory?(path)}
-      @website.expect(:directory, directory)
-      def (@website).tmpdir(path=''); File.join(self.directory, 'tmp', path); end
-      @website.expect(:ext, OpenStruct.new)
-      @website.expect(:blackboard, Webgen::Blackboard.new)
-      @website.expect(:cache, Webgen::Cache.new)
+      @website = OpenStruct.new
+      @website.config = config
+      @website.directory = Dir::Tmpname.create("test-webgen-website") {|path| raise Errno::EEXIST if File.directory?(path)}
+      @website.define_singleton_method(:tmpdir) do |path='', create=false|
+        tmp = File.join(self.directory, 'tmp')
+        FileUtils.mkdir_p(tmp) if create
+        File.join(tmp, path)
+      end
+      @website.ext = OpenStruct.new
+      @website.blackboard = Webgen::Blackboard.new
+      @website.cache = Webgen::Cache.new
       @logio = StringIO.new
-      @website.expect(:logger, Webgen::Logger.new(@logio))
-      @website.expect(:tree, Webgen::Tree.new(@website))
+      @website.logger = Webgen::Logger.new(@logio)
+      @website.tree = Webgen::Tree.new(@website)
       @website.ext.item_tracker = Object.new
-      def (@website.ext.item_tracker).add(*args); end
+      @website.ext.item_tracker.define_singleton_method(:add) {|*args|}
     end
 
     # Adds the following nodes (showing alcn=dest_path, title, other meta info) to the tree which
@@ -111,7 +115,7 @@ module Webgen
     #   /
     #   /file.en.html            'file en' sort_info=3
     #   /file.en.html#frag       'frag'
-    #   /file.en.html#nested     'fragnested'
+    #   /file.en.html#nested     'fragnested' routing_path="/routed.html"
     #   /file.de.html            'file de' sort_info=5
     #   /file.de.html#frag       'frag'
     #   /other.html              'other'
@@ -130,7 +134,7 @@ module Webgen
 
       file_en = Webgen::Node.new(root, 'file.html', '/file.en.html', {'lang' => 'en', 'title' => 'file en', 'sort_info' => 3})
       frag_en = Webgen::Node.new(file_en, '#frag', '/file.en.html#frag', {'title' => 'frag'})
-      Webgen::Node.new(frag_en, '#nested', '/file.en.html#nested', {'title' => 'fragnested'})
+      Webgen::Node.new(frag_en, '#nested', '/file.en.html#nested', {'title' => 'fragnested', 'routing_path' => '/routed.html'})
       file_de = Webgen::Node.new(root, 'file.html', '/file.de.html', {'lang' => 'de', 'title' => 'file de', 'sort_info' => 5})
       Webgen::Node.new(file_de, '#frag', '/file.de.html#frag', {'title' => 'frag'})
 
@@ -158,8 +162,8 @@ module Webgen
     # node that responds to :alcn with '/test'.
     def setup_context
       setup_website
-      node = MiniTest::Mock.new
-      node.expect(:alcn, '/test')
+      node = Object.new
+      node.define_singleton_method(:alcn) { '/test' }
       @context = Webgen::Context.new(@website, :chain => [node], :doit => 'hallo')
     end
 

data/lib/webgen/tree.rb

@@ -35,6 +35,11 @@ module Webgen
       @dummy_root.children.first
     end
 
+    # Access a node via its +:alcn+.
+    def [](path)
+      @node_access[:alcn][path]
+    end
+
     # Access a node via a +path+ of a specific +type+.
     #
     # If type is +:alcn+ (default) then +path+ has to be an absolute localized canonical name, if
@@ -51,7 +56,6 @@ module Webgen
         raise ArgumentError, "Unknown type '#{type}' for resolving path <#{path}>"
       end
     end
-    alias_method :[], :node
 
     # Return the node representing the given +path+ which can be an alcn/acn/destination path (name
     # resolution is done in the specified order). The path has to be absolute, i.e. starting with a

data/lib/webgen/version.rb

@@ -3,6 +3,6 @@
 module Webgen
 
   # The version of webgen.
-  VERSION = '1.0.0.beta2'
+  VERSION = '1.0.0.beta3'
 
 end

data/lib/webgen/website.rb

@@ -181,24 +181,24 @@ module Webgen
       return if config['website.dry_run']
       cache_data = [@cache.dump, Webgen::VERSION]
       if config['website.cache'].first == :file
-        File.open(cache_file, 'wb') {|f| Marshal.dump(cache_data, f)}
+        File.open(cache_file(true), 'wb') {|f| Marshal.dump(cache_data, f)}
       else
         config['website.cache'][1] = Marshal.dump(cache_data)
       end
     end
 
     # The full path of the cache filename.
-    def cache_file
-      tmpdir(config['website.cache'].last)
+    def cache_file(create_dir = false)
+      tmpdir(config['website.cache'].last, create_dir)
     end
     private :cache_file
 
     # Append the path to the website's temporary directory and return the full path to it.
-    def tmpdir(path = '')
-      unless defined?(@_tmpdir)
-        @_tmpdir = File.absolute_path(config['website.tmpdir'], @directory)
-        FileUtils.mkdir_p(@_tmpdir)
-      end
+    #
+    # Note that the temporary directory is only created if the +create+ parameter is set to true.
+    def tmpdir(path = '', create = false)
+      @_tmpdir = File.absolute_path(config['website.tmpdir'], @directory) unless defined?(@_tmpdir)
+      FileUtils.mkdir_p(@_tmpdir) if create
       File.join(@_tmpdir, path)
     end
 

data/test/webgen/content_processor/test_kramdown.rb

@@ -16,14 +16,18 @@ class TestContentProcessorKramdown < MiniTest::Unit::TestCase
     @website.config['content_processor.kramdown.handle_links'] = true
     @website.config['content_processor.kramdown.ignore_unknown_fragments'] = false
 
-    @website.ext.tag = MiniTest::Mock.new
-    @website.ext.tag.expect(:call, 'hello.en.html', ['relocatable', {'path' => 'hello.html',
-                                                       'ignore_unknown_fragment' => false}, '', @context])
+    @website.ext.link_definitions = {'hallo' => ['/hello.html', 'Hello you']}
+    @website.ext.tag = Object.new
+    @website.ext.tag.define_singleton_method(:call) {|*args| 'hello.en.html'}
 
     # test normal invocation
     @context.content = '# header'
     assert_equal("<h1 id=\"header\">header</h1>\n", cp.call(@context).content)
 
+    # test usage of link definitions
+    @context.content = 'Link [hallo]'
+    assert_equal("<p>Link <a href=\"hello.en.html\" title=\"Hello you\">hallo</a></p>\n", cp.call(@context).content)
+
     # test automatic handling of links
     @website.config['content_processor.kramdown.handle_links'] = true
     @context.content = 'Link [test](hello.html)'
@@ -42,8 +46,6 @@ class TestContentProcessorKramdown < MiniTest::Unit::TestCase
     cp.call(@context)
     assert_equal("<p>{::comment}</p>\n", @context.content)
     assert_log_match(/No stop tag for extension 'comment' found/)
-
-    @website.ext.tag.verify
   end
 
 end

data/test/webgen/content_processor/test_sass.rb

@@ -41,4 +41,8 @@ class TestSass < MiniTest::Unit::TestCase
     assert_equal("#{result}\n#{result}\n#{result}", cp.call(@context).content)
   end
 
+  def teardown
+    FileUtils.rm_rf(@website.directory)
+  end
+
 end

data/test/webgen/content_processor/test_scss.rb

@@ -20,4 +20,8 @@ class TestScss < MiniTest::Unit::TestCase
     assert_error_on_line(Webgen::RenderError, 2) { cp.call(@context) }
   end
 
+  def teardown
+    FileUtils.rm_rf(@website.directory)
+  end
+
 end