gettalong-webgen 0.5.8.20090507 → 0.5.9.20090620

data/lib/webgen/contentprocessor/builder.rb

@@ -19,11 +19,11 @@ module Webgen::ContentProcessor
       dest_node = deprecate('dest_node', 'context.dest_node', context.dest_node)
 
       xml = ::Builder::XmlMarkup.new(:indent => 2)
-      eval(context.content, binding, context.ref_node.absolute_lcn)
+      eval(context.content, binding, context.ref_node.alcn)
       context.content = xml.target!
       context
     rescue Exception => e
-      raise RuntimeError, "Error using Builder in <#{context.ref_node.absolute_lcn}> to generate XML: #{e.message}", e.backtrace
+      raise RuntimeError, "Error using Builder in <#{context.ref_node.alcn}> to generate XML: #{e.message}", e.backtrace
     end
 
   end

data/lib/webgen/contentprocessor/erb.rb

@@ -10,6 +10,7 @@ module Webgen::ContentProcessor
     # Process the Ruby statements embedded in the content of +context+.
     def call(context)
       require 'erb'
+      extend(ERB::Util)
 
       website = deprecate('website', 'context.website', context.website)
       node = deprecate('node', 'context.node', context.content_node)
@@ -17,11 +18,11 @@ module Webgen::ContentProcessor
       dest_node = deprecate('dest_node', 'context.dest_node', context.dest_node)
 
       erb = ERB.new(context.content)
-      erb.filename = context.ref_node.absolute_lcn
+      erb.filename = context.ref_node.alcn
       context.content = erb.result(binding)
       context
     rescue Exception => e
-      raise RuntimeError, "Erb processing failed in <#{context.ref_node.absolute_lcn}>: #{e.message}", e.backtrace
+      raise RuntimeError, "Erb processing failed in <#{context.ref_node.alcn}>: #{e.message}", e.backtrace
     end
 
   end

data/lib/webgen/contentprocessor/erubis.rb

@@ -29,11 +29,11 @@ module Webgen::ContentProcessor
                   else
                     ::Erubis::Eruby.new(context.content, options)
                   end
-      erubis.filename = context.ref_node.absolute_lcn
+      erubis.filename = context.ref_node.alcn
       context.content = erubis.result(binding)
       context
     rescue Exception => e
-      raise RuntimeError, "Erubis processing failed in <#{context.ref_node.absolute_lcn}>: #{e.message}", e.backtrace
+      raise RuntimeError, "Erubis processing failed in <#{context.ref_node.alcn}>: #{e.message}", e.backtrace
     end
 
   end

data/lib/webgen/contentprocessor/haml.rb

@@ -18,11 +18,11 @@ module Webgen::ContentProcessor
         :ref_node => deprecate('ref_node', 'context.ref_node', context.ref_node),
         :dest_node => deprecate('dest_node', 'context.dest_node', context.dest_node)
       }
-      context.content = ::Haml::Engine.new(context.content, :filename => context.ref_node.absolute_lcn).
+      context.content = ::Haml::Engine.new(context.content, :filename => context.ref_node.alcn).
         render(Object.new, locals)
       context
     rescue Exception => e
-      raise RuntimeError, "Error converting Haml markup to HTML in <#{context.ref_node.absolute_lcn}>: #{e.message}", e.backtrace
+      raise RuntimeError, "Error converting Haml markup to HTML in <#{context.ref_node.alcn}>: #{e.message}", e.backtrace
     end
 
   end

data/lib/webgen/contentprocessor/maruku.rb

@@ -12,7 +12,7 @@ module Webgen::ContentProcessor
       context.content = ::Maruku.new(context.content, :on_error => :raise).to_html
       context
     rescue Exception => e
-      raise RuntimeError, "Maruku to HTML conversion failed for <#{context.ref_node.absolute_lcn}>: #{e.message}", e.backtrace
+      raise RuntimeError, "Maruku to HTML conversion failed for <#{context.ref_node.alcn}>: #{e.message}", e.backtrace
     end
 
   end

data/lib/webgen/contentprocessor/sass.rb

@@ -9,10 +9,10 @@ module Webgen::ContentProcessor
     def call(context)
       require 'sass'
 
-      context.content = ::Sass::Engine.new(context.content, :filename => context.ref_node.absolute_lcn).render
+      context.content = ::Sass::Engine.new(context.content, :filename => context.ref_node.alcn).render
       context
     rescue Exception => e
-      raise RuntimeError, "Error converting Sass markup to CSS in <#{context.ref_node.absolute_lcn}>: #{e.message}", e.backtrace
+      raise RuntimeError, "Error converting Sass markup to CSS in <#{context.ref_node.alcn}>: #{e.message}", e.backtrace
     end
 
   end

data/lib/webgen/contentprocessor/tags.rb

@@ -23,23 +23,37 @@ module Webgen::ContentProcessor
     # Replace all webgen tags in the content of +context+ with the rendered content.
     def call(context)
       replace_tags(context.content, context.ref_node) do |tag, param_string, body|
-        log(:debug) { "Replacing tag #{tag} with data '#{param_string}' and body '#{body}' in <#{context.ref_node.absolute_lcn}>" }
+        log(:debug) { "Replacing tag #{tag} with data '#{param_string}' and body '#{body}' in <#{context.ref_node.alcn}>" }
+        process_tag(tag, param_string, body, context)
+      end
+      context
+    end
 
-        result = ''
-        processor = processor_for_tag(tag)
-        if !processor.nil?
-          processor.set_params(processor.create_tag_params(param_string, context.ref_node))
+    # Process the +tag+ and return the result. The parameter +params+ needs to be a Hash holding all
+    # needed and optional parameters for the tag or a parameter String in YAML format and +body+ is
+    # the optional body for the tag. +context+ needs to be a valid Webgen::Context object.
+    def process_tag(tag, params, body, context)
+      result = ''
+      processor = processor_for_tag(tag)
+      if !processor.nil?
+        params, mandatory_missing = if params.kind_of?(String)
+                                      processor.create_tag_params(params, context.ref_node)
+                                    else
+                                      processor.create_params_hash(params, context.ref_node)
+                                    end
+        if mandatory_missing
+          context.dest_node.flag(:dirty)
+        else
+          processor.set_params(params)
           result, process_output = processor.call(tag, body, context)
           processor.set_params(nil)
-
           result = call(context.clone(:content => result)).content if process_output
         end
-
-        result
       end
-      context
+      result
     end
 
+
     #######
     private
     #######
@@ -72,7 +86,7 @@ module Webgen::ContentProcessor
         when :in_start_tag
           data.brackets += (scanner[1] == '{' ? 1 : -1) while data.brackets != 0 && scanner.skip_until(BRACKETS_RE)
           if data.brackets != 0
-            log(:error) { "Unbalanced curly brackets in <#{node.absolute_lcn}>!" }
+            log(:error) { "Unbalanced curly brackets in <#{node.alcn}>!" }
             data.state = :done
           else
             data.params_end_pos = data.body_end_pos = data.end_pos = scanner.pos - 1
@@ -106,7 +120,7 @@ module Webgen::ContentProcessor
             data.end_pos = scanner.pos - 1
             data.body_end_pos = scanner.pos - scanner.matched.length + scanner[1].length / 2
           else
-            log(:error) { "Invalid body part in <#{node.absolute_lcn}>!" }
+            log(:error) { "Invalid body part in <#{node.alcn}>!" }
             data.state = :done
           end
 

data/lib/webgen/context.rb

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
 require 'webgen/context/nodes'
+require 'webgen/context/tags'
+require 'webgen/context/render'
 
 module Webgen
 
@@ -13,7 +15,8 @@ module Webgen
   #   The content string that should be processed.
   #
   # [<tt>:processors</tt>]
-  #   Normally an AccessHash object providing access to all available content processors.
+  #   Normally an ContentProcessor::AccessHash object providing access to all available content
+  #   processors.
   #
   # [<tt>:chain</tt>]
   #   The chain of nodes that is processed. There are some utiltity methods for getting

data/lib/webgen/context/render.rb

@@ -0,0 +1,32 @@
+module Webgen
+
+  class Context
+
+    # Render the named block and return the result.
+    #
+    # call-seq:
+    #   context.render_block(block_name)<br />
+    #   context.render_block(:name => block_name, :option => value, ...)
+    #
+    # This method uses the functionality of the content processor +blocks+ for doing the actual
+    # work, so you may also want to look at Webgen::ContentProcessor::Blocks#render_block. You can
+    # call this method in two ways:
+    #
+    # [<tt>#render_block(block_name)</tt>]
+    #   Renders the block named +block_name+ of the next node in the current node chain. This is the
+    #   version that most want to use since it is equivalent to the use of <tt><webgen:block
+    #   name="block_name" /></tt>. It is equivalent to <tt>#render_block(:name =>
+    #   block_name)</tt>.
+    #
+    # [<tt>#render_block(opts_hash)</tt>]
+    #   This version allows the same level of control over the output as the blocks content
+    #   processor. For a list of valid options have a look at the documentation of the
+    #   Webgen::ContentProcessor::Blocks#render_block method!
+    def render_block(name_or_hash)
+      name_or_hash = {:name => name_or_hash} if name_or_hash.kind_of?(String)
+      website.cache.instance('Webgen::ContentProcessor::Blocks').render_block(self, name_or_hash)
+    end
+
+  end
+
+end

data/lib/webgen/context/tags.rb

@@ -0,0 +1,20 @@
+module Webgen
+
+  class Context
+
+    # Returns the result of evaluating the webgen tag +name+ with the tag parameters +params+ and
+    # the +body+ in the current context.
+    #
+    # Have a look at Webgen::Tag::Base for more information about webgen tags!
+    #
+    # This method is useful when you want to have the functionality of webgen tags available but you
+    # don't want to use the content processor for them. Or, for example, if the used markup language
+    # uses a similar markup as webgen tags do and therefore you can't use the normal webgen tags
+    # content processor.
+    def tag(name, params = {}, body = '')
+      website.cache.instance('Webgen::ContentProcessor::Tags').process_tag(name, params, body, self)
+    end
+
+  end
+
+end

data/lib/webgen/default_config.rb

@@ -43,6 +43,7 @@ end
 
 # All things regarding sources
 config.sources [['/', "Webgen::Source::FileSystem", 'src']], :doc => 'One or more sources from which files are read, relative to website directory'
+config.passive_sources([['/', "Webgen::Source::Resource", "webgen-passive-sources"]], :doc => 'One or more sources for delayed node creation on node resolution')
 
 # All things regarding source handler
 config.sourcehandler.patterns({
@@ -70,7 +71,7 @@ config.sourcehandler.default_lang_in_output_path(false, :doc => 'Specifies wheth
 config.sourcehandler.default_meta_info({
                                          :all => {
                                            'output_path' => 'standard',
-                                           'output_path_style' => [:parent, :cnbase, ['.', :lang], :ext]
+                                           'output_path_style' => [:parent, :basename, ['.', :lang], :ext]
                                          },
                                          'Webgen::SourceHandler::Copy' => {
                                            'kind' => 'asset'
@@ -114,6 +115,8 @@ website.autoload_service(:parse_html_headers, 'Webgen::SourceHandler::Fragment')
 
 # All things regarding output
 config.output ["Webgen::Output::FileSystem", 'out'], :doc => 'The class which is used to output the generated paths.'
+config.output.do_deletion(false, :doc => 'Specifies whether the generated output paths should be deleted once the sources are deleted')
+
 
 Webgen::WebsiteAccess.website.blackboard.add_service(:output_instance, Webgen::Output.method(:instance))
 

data/lib/webgen/deprecated.rb

@@ -3,18 +3,42 @@ module Webgen
   class Node
 
     def flagged(key)
-      warn("Deprecation warning: this method will be removed in one of the next releases - use Node#flagged? instead!")
+      warn("Deprecation warning (~ #{caller.first}): this method will be removed in one of the next releases - use Node#flagged? instead!")
       flagged?(key)
     end
 
+    def absolute_cn
+      warn("Deprecation warning (~ #{caller.first}): this method will be removed in one of the next releases - use Node#acn instead!")
+      acn
+    end
+
+    def absolute_lcn
+      warn("Deprecation warning (~ #{caller.first}): this method will be removed in one of the next releases - use Node#alcn instead!")
+      alcn
+    end
+
+  end
+
+  class Path
+
+    def cnbase
+      warn("Deprecation warning (~ #{caller.first}): this method will be removed in one of the next releases - use Path#basename instead!")
+      @basename
+    end
+
+    def cnbase=(value)
+      warn("Deprecation warning (~ #{caller.first}): this method will be removed in one of the next releases - use Path#basename= instead!")
+      basename = value
+    end
+
   end
 
   def self.const_missing(const)
     if const.to_s == 'Block'
-      warn("Deprecation warning: Webgen::Block name will be removed in one of the next releases - use Webgen::Page::Block instead!")
+      warn("Deprecation warning (~ #{caller.first}): Webgen::Block name will be removed in one of the next releases - use Webgen::Page::Block instead!")
       Webgen::Page::Block
     elsif const.to_s == "WebgenPageFormatError"
-      warn("Deprecation warning: Webgen::WebgenPageFormatError name will be removed in one of the next releases - use Webgen::Page::FormatError instead!")
+      warn("Deprecation warning (~ #{caller.first}): Webgen::WebgenPageFormatError name will be removed in one of the next releases - use Webgen::Page::FormatError instead!")
       Webgen::Page::FormatError
     else
       super
@@ -25,7 +49,7 @@ module Webgen
 
     def self.const_missing(const)
       if const.to_s == 'Context'
-        warn("Deprecation warning: Webgen::ContentProcessor::Context is now named Webgen::Context! This alias will be removed in one of the next releases.")
+        warn("Deprecation warning (~ #{caller.first}): Webgen::ContentProcessor::Context is now named Webgen::Context! This alias will be removed in one of the next releases.")
         Webgen::Context
       else
         super
@@ -50,4 +74,13 @@ module Webgen
 
   end
 
+  module Common
+
+    def self.absolute_path(path, base)
+      warn("Deprecation warning (~ #{caller.first}): this method will be removed in one of the next releases - use Webgen::Path.make_absolute(base, path) instead!")
+      Path.make_absolute(base, path)
+    end
+
+  end
+
 end

data/lib/webgen/node.rb

@@ -22,10 +22,11 @@ module Webgen
     include WebsiteAccess
     include Loggable
 
-    # The parent node.
+    # The parent node. This is in all but one case a Node object. The one exception is that the
+    # parent of the Tree#dummy_node is a Tree object.
     attr_reader :parent
 
-    # The children of this node.
+    # The child nodes of this node.
     attr_reader :children
 
     # The full output path of this node.
@@ -38,13 +39,13 @@ module Webgen
     attr_reader :cn
 
     # The absolute canonical name of this node.
-    attr_reader :absolute_cn
+    attr_reader :acn
 
     # The localized canonical name of this node.
     attr_reader :lcn
 
     # The absolute localized canonical name of this node.
-    attr_reader :absolute_lcn
+    attr_reader :alcn
 
     # The level of the node. The level specifies how deep the node is in the hierarchy.
     attr_reader :level
@@ -76,7 +77,7 @@ module Webgen
     # found, the node is language neutral.
     def initialize(parent, path, cn, meta_info = {})
       @parent = parent
-      @cn = cn.chomp('/').freeze
+      @cn = cn.freeze
       @children = []
       reinit(path, meta_info)
       init_rest
@@ -111,7 +112,7 @@ module Webgen
 
     # Return the node information hash which contains information for processing the node.
     def node_info
-      tree.node_info[@absolute_lcn] ||= {}
+      tree.node_info[@alcn] ||= {}
     end
 
     # Check if the node is a directory.
@@ -161,8 +162,8 @@ module Webgen
     def changed?
       if_not_checked(:node) do
         flag(:dirty) if meta_info_changed? ||
-          node_info[:used_nodes].any? {|n| n != @absolute_lcn && (!tree[n] || tree[n].changed?)} ||
-          node_info[:used_meta_info_nodes].any? {|n| n != @absolute_lcn && (!tree[n] || tree[n].meta_info_changed?)}
+          node_info[:used_nodes].any? {|n| n != @alcn && (!tree[n] || tree[n].changed?)} ||
+          node_info[:used_meta_info_nodes].any? {|n| n != @alcn && (!tree[n] || tree[n].meta_info_changed?)}
         website.blackboard.dispatch_msg(:node_changed?, self) unless flagged?(:dirty)
       end
       flagged?(:dirty)
@@ -183,12 +184,12 @@ module Webgen
 
     # Return an informative representation of the node.
     def inspect
-      "<##{self.class.name}: alcn=#{@absolute_lcn}>"
+      "<##{self.class.name}: alcn=#{@alcn}>"
     end
 
     # Return +true+ if the alcn matches the pattern. See File.fnmatch for useable patterns.
     def =~(pattern)
-      File.fnmatch(pattern, @absolute_lcn, File::FNM_DOTMATCH|File::FNM_CASEFOLD|File::FNM_PATHNAME)
+      File.fnmatch(pattern, @alcn, File::FNM_DOTMATCH|File::FNM_CASEFOLD|File::FNM_PATHNAME)
     end
 
     # Sort nodes by using the meta info +sort_info+ (or +title+ if +sort_info+ is not set) of both
@@ -203,22 +204,16 @@ module Webgen
       self_so <=> other_so
     end
 
-    # Construct the absolute (localized) canonical name by using the +parent+ node and +name+ (which
-    # can be a cn or an lcn). The +type+ can be either <tt>:alcn</tt> or <tt>:acn</tt>.
-    def self.absolute_name(parent, name, type)
-      if parent.kind_of?(Tree)
-        ''
-      else
-        parent = parent.parent while parent.is_fragment? # Handle fragment nodes specially in case they are nested
-        parent_name = (type == :alcn ? parent.absolute_lcn : parent.absolute_cn)
-        parent_name + (parent_name !~ /\/$/ && (parent.is_directory? || parent == parent.tree.dummy_root) ? '/' : '') + name
-      end
-    end
+    # This pattern is the the same as URI::UNSAFE except that the hash character (#) is also
+    # not escaped. This is needed sothat paths with fragments work correctly.
+    URL_UNSAFE_PATTERN = Regexp.new("[^#{URI::PATTERN::UNRESERVED}#{URI::PATTERN::RESERVED}#]") # :nodoc:
 
-    # Construct an internal URL for the given +name+ which can be a acn/alcn/path.
-    def self.url(name)
-      url = URI::parse(name)
-      url = URI::parse('webgen://webgen.localhost/') + url unless url.absolute?
+    # Construct an internal URL for the given +name+ which can be an acn/alcn/path. If the parameter
+    # +make_absolute+ is +true+, then a relative URL will be made absolute by prepending the special
+    # URL <tt>webgen:://webgen.localhost/</tt>.
+    def self.url(name, make_absolute = true)
+      url = URI::parse(URI::escape(name, URL_UNSAFE_PATTERN))
+      url = URI::parse('webgen://webgen.localhost/') + url unless url.absolute? || !make_absolute
       url
     end
 
@@ -235,7 +230,7 @@ module Webgen
     # exists, an unlocalized version of the node. If no such node is found either, +nil+ is
     # returned.
     def in_lang(lang)
-      avail = @tree.node_access[:acn][@absolute_cn]
+      avail = @tree.node_access[:acn][@acn]
       avail.find do |n|
         n = n.parent while n.is_fragment?
         n.lang == lang
@@ -252,19 +247,23 @@ module Webgen
     # If the +path+ is an alcn and a node is found, it is returned. If the +path+ is an acn, the
     # correct localized node according to +lang+ is returned or if no such node exists but an
     # unlocalized version does, the unlocalized node is returned.
-    def resolve(path, lang = nil)
-      url = self.class.url(self.is_directory? ? File.join(@absolute_lcn, '/') : @absolute_lcn) + path
+    def resolve(path, lang = nil, use_passive_sources = true)
+      orig_path = path
+      url = self.class.url(@alcn) + self.class.url(path, false)
 
       path = url.path + (url.fragment.nil? ? '' : '#' + url.fragment)
-      path.chomp!('/') unless path == '/'
       return nil if path =~ /^\/\.\./
 
       node = @tree[path, :alcn]
-      if node && node.absolute_cn != path
-        node
-      else
-        (node = @tree[path, :acn]) && node.in_lang(lang)
+      if !node || node.acn == path
+        (node = (@tree[path, :acn] || @tree[path + '/', :acn])) && (node = node.in_lang(lang))
+      end
+      if !node && use_passive_sources && !website.config['passive_sources'].empty?
+        nodes = website.blackboard.invoke(:create_nodes_from_paths, [path])
+        node = resolve(orig_path, lang, false)
+        node.node_info[:used_meta_info_nodes] += nodes.collect {|n| n.alcn} if node
       end
+      node
     end
 
     # Return the relative path to the given path +other+. The parameter +other+ can be a Node or a
@@ -295,7 +294,7 @@ module Webgen
       if !is_directory?
         self
       else
-        key = [absolute_lcn, :index_node, lang]
+        key = [alcn, :index_node, lang]
         vcache = website.cache.volatile
         return vcache[key] if vcache.has_key?(key)
 
@@ -306,10 +305,10 @@ module Webgen
           index_node = resolve(index_path, lang)
           if index_node
             vcache[key] = index_node
-            log(:info) { "Directory index path for <#{absolute_lcn}> => <#{index_node.absolute_lcn}>" }
+            log(:info) { "Directory index path for <#{alcn}> => <#{index_node.alcn}>" }
           elsif log_warning
             vcache[key] = self
-            log(:warn) { "No directory index path found for directory <#{absolute_lcn}>" }
+            log(:warn) { "No directory index path found for directory <#{alcn}>" }
           end
         end
         vcache[key] || self
@@ -351,8 +350,8 @@ module Webgen
     # Do the rest of the initialization.
     def init_rest
       @lcn = Path.lcn(@cn, @lang)
-      @absolute_cn = self.class.absolute_name(@parent, @cn, :acn)
-      @absolute_lcn = self.class.absolute_name(@parent, @lcn, :alcn)
+      @acn = (@parent.kind_of?(Tree) ? '' : @parent.acn.sub(/#.*$/, '') + @cn)
+      @alcn = (@parent.kind_of?(Tree) ? '' : @parent.alcn.sub(/#.*$/, '') + @lcn)
 
       @level = -1
       @tree = @parent