webgen 1.0.0.beta1 → 1.0.0.beta2

data/README.md

@@ -31,7 +31,7 @@ Apart from this basic functionality, webgen offers many features that
 makes authoring websites easier:
 
 * Multiple markup languages to choose from for writing HTML and CSS
-  files (Markdown, Textile, RDoc, Haml, Sass ...)
+  files (Markdown, Textile, RDoc, Haml, Sass, ...)
 
 * Automatic generation of menus, breadcrumb trails, ... and more!
 
@@ -42,7 +42,7 @@ makes authoring websites easier:
   view the website *without a web server*)
 
 * Easily extendable (all major components can be extended with new
-  functionality)
+  functionality or existing functionality can be replaced)
 
 * No need to know the Ruby language for basic websites
 

data/VERSION

@@ -1 +1 @@
-1.0.0.beta1
+1.0.0.beta2

data/data/webgen/passive_sources/templates/tag.template

@@ -1,6 +1,6 @@
 --- name:tag.langbar pipeline:ruby ------------------------------------------------------------------
 context.content = context[:nodes].map do |node|
-  attrs = {:link_text => node.lang}
+  attrs = {'link_text' => node.lang}
   attrs['class'] = 'webgen-langbar-current-lang' if context.content_node.lang == node.lang
   context.dest_node.link_to(node, node.lang, attrs)
 end.join(context[:config]['tag.langbar.separator'])

data/data/webgen/passive_sources/templates/tikz.template

@@ -0,0 +1,14 @@
+--- name:content pipeline:erb
+\nonstopmode
+\documentclass{standalone}
+\usepackage{tikz}
+
+<% if context['content_processor.tikz.libraries'] %>
+\usetikzlibrary{<%= context['content_processor.tikz.libraries'].join(',') %>}
+<% end %>
+
+\begin{document}
+\begin{tikzpicture}[<%= context['content_processor.tikz.opts'] %>]
+<%= context['data'] %>
+\end{tikzpicture}
+\end{document}

data/lib/webgen/bundle/built-in/init.rb

@@ -59,6 +59,8 @@ website.ext.content_processor = content_processor = Webgen::ContentProcessor.new
 content_processor.register('Blocks')
 content_processor.register('Builder')
 content_processor.register('Erb')
+option('content_processor.erb.trim_mode', '',
+       "Specifies the ERB trim mode, can contain any combination of '%', '<' and '<>'", &is_string)
 
 content_processor.register('Erubis')
 option('content_processor.erubis.use_pi', false,
@@ -112,6 +114,8 @@ option('content_processor.tikz.resolution', '72 72',
 end
 option('content_processor.tikz.transparent', false,
        'Specifies whether the generated image should be transparent (only if the extension is png)', &true_or_false)
+option('content_processor.tikz.template', '/templates/tikz.template',
+       'Specifies the template with the LaTeX framework that should be used for rendering', &is_string)
 
 content_processor.register('Xmllint')
 option('content_processor.xmllint.options', "--catalogs --noout --valid",
@@ -196,6 +200,8 @@ option('path_handler.version_in_dest_path', 'except_default',
     raise "The value has to be 'true', 'false' or 'except_default'"
   end
 end
+option('path_handler.default_template', 'default.template',
+       'The name of the default template file')
 
 website.ext.path_handler = path_handler = Webgen::PathHandler.new(website)
 
@@ -203,11 +209,7 @@ website.ext.path_handler = path_handler = Webgen::PathHandler.new(website)
 
 path_handler.register('Directory')
 path_handler.register('MetaInfo', :patterns => ['/**/metainfo', '/**/*.metainfo'])
-
 path_handler.register('Template')
-option('path_handler.template.default_template', 'default.template',
-       'The name of the default template file')
-
 path_handler.register('Page')
 path_handler.register('Copy')
 path_handler.register('Feed')
@@ -255,7 +257,7 @@ tag.register('Date')
 option('tag.date.format', '%Y-%m-%d %H:%M:%S',
        'The format of the date (same options as Ruby\'s Time#strftime)', &is_string)
 
-tag.register('MetaInfo', :names => :default)
+tag.register('MetaInfo', :names => ['meta_info', :default])
 option('tag.meta_info.escape_html', true,
        'Special HTML characters in the output will be escaped if true', &true_or_false)
 
@@ -271,7 +273,7 @@ option('tag.link.path', nil,
 option('tag.link.attr', {},
        'A hash of additional HTML attributes that should be set on the link', &is_hash)
 
-tag.register('ExecuteCommand', :names => 'execute_cmd', :mandatory => ['command'])
+tag.register('ExecuteCommand', :mandatory => ['command'])
 option('tag.execute_command.command', nil,
        'The command which should be executed', &is_string)
 option('tag.execute_command.process_output', true,
@@ -293,7 +295,7 @@ option('tag.coderay.lang', 'ruby',
 option('tag.coderay.process_body', true,
        'The tag body will be scanned for tags before highlighting if true', &true_or_false)
 option('tag.coderay.wrap', :div,
-       'Specifies how the code should be wrapped, either "div" or "span"') do |val|
+       "Specifies how the code should be wrapped, either 'div' or 'span'") do |val|
   val = val.to_s.intern
   raise "The value has to be either div or span" unless val == :div || val == :span
   val

data/lib/webgen/bundle_loader.rb

@@ -54,7 +54,7 @@ module Webgen
 
         info_file = File.join(File.dirname(file), 'info.yaml')
         next unless File.file?(info_file)
-        next unless YAML.load(File.read(info_file))['autoload']
+        next unless (begin YAML.load(File.read(info_file))['autoload']; rescue Exception; false end)
 
         load(bundle_name)
       end

data/lib/webgen/cli/show_command.rb

@@ -4,6 +4,7 @@ require 'webgen/cli/utils'
 require 'webgen/cli/show_extensions_command'
 require 'webgen/cli/show_config_command'
 require 'webgen/cli/show_dependencies_command'
+require 'webgen/cli/show_tree_command'
 
 module Webgen
   module CLI
@@ -22,6 +23,7 @@ DESC
         add_command(ShowConfigCommand.new)
         add_command(ShowExtensionsCommand.new)
         add_command(ShowDependenciesCommand.new)
+        add_command(ShowTreeCommand.new)
       end
 
     end

data/lib/webgen/cli/show_config_command.rb

@@ -33,7 +33,6 @@ DESC
           end
         end
         @modified = false
-        @unknown = true
       end
 
       def execute(args) # :nodoc:

data/lib/webgen/cli/show_dependencies_command.rb

@@ -24,79 +24,22 @@ DESC
       end
 
       def execute(args) # :nodoc:
-        cache = commandparser.website.cache[:item_tracker_data]
-        if cache.nil?
+        data = commandparser.website.ext.item_tracker.cached_items(commandparser.verbose)
+        if data.empty?
           puts "No data available, you need to generate the website first!"
           return
         end
         arg = args.shift
 
-        data = cache[:node_dependencies]
-        data = data.select {|alcn, _| alcn.include?(arg) } if arg
-        data.sort.each do |alcn, deps|
-          deps = deps.sort {|a,b| a.first <=> b.first }.map do |uid|
-            method = "format_#{uid.first}"
-            if respond_to?(method, true)
-              send(method, alcn, uid, cache[:item_data][uid])
-            else
-              unknown_uid(uid)
-            end
-          end.compact
-
-          if deps.length > 0 || commandparser.verbose
+        data.select! {|alcn, _| alcn.include?(arg) } if arg
+        data.sort.each do |alcn, items|
+          if items.length > 0 || commandparser.verbose
             puts("#{Utils.light(Utils.blue(alcn))}: ")
-            deps.each {|d| puts("  #{[d].flatten.join("\n    ")}")}
+            items.each {|d| puts("  #{[d].flatten.join("\n    ")}")}
           end
         end
       end
 
-      def unknown_uid(uid)
-        uid.first.to_s
-      end
-      private :unknown_uid
-
-      def format_node_meta_info(alcn, uid, data)
-        dep_alcn, key = *uid.last
-        return if alcn == dep_alcn && !commandparser.verbose
-
-        if key.nil?
-          "Any meta info from <#{dep_alcn}>"
-        else
-          "Meta info key '#{key}' from <#{dep_alcn}>"
-        end
-      end
-      private :format_node_meta_info
-
-      def format_node_content(alcn, uid, data)
-        dep_alcn = uid.last
-        return if alcn == dep_alcn && !commandparser.verbose
-
-        "Content from node <#{dep_alcn}>"
-      end
-      private :format_node_content
-
-      def format_file(alcn, uid, data)
-        "Content from file '#{uid.last}'"
-      end
-      private :format_file
-
-      def format_missing_node(alcn, uid, data)
-        path, lang = *uid.last
-
-        "Missing acn, alcn or dest path <#{path}>" << (lang.nil? ? '' : " in language '#{lang}'")
-      end
-      private :format_missing_node
-
-      def format_nodes(alcn, uid, data)
-        method, _, type = *uid.last
-
-        res = [(type == :content ? "Content" : "Meta info") + " from these nodes"]
-        res.first << " (result of #{[method].flatten.join('.')})" if commandparser.verbose
-        res.first << ":"
-        res += data.flatten
-      end
-      private :format_nodes
-
     end
 
   end

data/lib/webgen/cli/show_tree_command.rb

@@ -0,0 +1,85 @@
+# -*- encoding: utf-8 -*-
+
+require 'webgen/cli/utils'
+
+module Webgen
+  module CLI
+
+    # The CLI command for showing the node tree.
+    class ShowTreeCommand < CmdParse::Command
+
+      def initialize # :nodoc:
+        super('tree', false, false, true)
+        self.short_desc = 'Show the node tree'
+        self.description = Utils.format_command_desc(<<DESC)
+Shows the internal representation of all destination paths that have been created
+from the source paths. Additionally, the meta information associated with each
+node can be shown as well.
+
+This command can be used before or after the website has been generated. Note,
+however, that nodes that are created during generation like fragment nodes can
+only be shown if the website has been generated.
+
+If an argument is given, only those nodes that have the argument in their LCN
+are displayed.
+
+Hint: The global verbosity option enables additional output.
+DESC
+        self.options = CmdParse::OptionParserWrapper.new do |opts|
+          opts.separator "Options:"
+          opts.on("-a", "--alcn",
+                  *Utils.format_option_desc("Use ALCN insted of LCN for paths")) do |v|
+            @use_alcn = true
+          end
+          opts.on("-f", "--[no-]fragments",
+                  *Utils.format_option_desc("Show fragment nodes (default: no)")) do |v|
+            @show_fragments = v
+          end
+          opts.on("-m", "--[no-]meta-info",
+                  *Utils.format_option_desc("Show meta information (default: no)")) do |v|
+            @meta_info = v
+          end
+        end
+        @meta_info = false
+        @use_alcn = false
+        @show_fragments = false
+      end
+
+      def execute(args) # :nodoc:
+        selector = args.shift
+        commandparser.website.ext.path_handler.populate_tree
+        data = collect_data(commandparser.website.tree.dummy_root.children, selector)
+        print_tree(data, selector)
+      end
+
+      def collect_data(children, selector)
+        children.sort {|a,b| a.alcn <=> b.alcn}.map do |node|
+          sub = collect_data(node.children, selector)
+          if sub.length > 0 ||
+              ((selector.nil? || node.lcn.include?(selector)) &&
+               ((!node.is_fragment? || @show_fragments) &&
+                (!node['passive'] || commandparser.website.ext.item_tracker.node_referenced?(node))))
+            data = [@use_alcn ? node.alcn : node.lcn]
+            data << (@meta_info ? node.meta_info.map {|k,v| "#{k}: #{v.inspect}"} : [])
+            data << sub
+            data
+          else
+            nil
+          end
+        end.compact
+      end
+      private :collect_data
+
+      def print_tree(data, indent = '', selector)
+        data.each do |name, info, children|
+          puts("#{indent}#{Utils.light(Utils.blue(name))}")
+          info.each {|i| puts("#{indent}  #{i}")} if info.length > 0 && (selector.nil? || name.include?(selector))
+          print_tree(children, indent + '  ', selector)
+        end
+      end
+      private :print_tree
+
+    end
+
+  end
+end

data/lib/webgen/content_processor/erb.rb

@@ -13,7 +13,7 @@ module Webgen
 
       # Process the Ruby statements embedded in the content of +context+.
       def self.call(context)
-        erb = ERB.new(context.content)
+        erb = ERB.new(context.content, nil, context.website.config['content_processor.erb.trim_mode'])
         erb.filename = context.ref_node.alcn
         context.content = erb.result(binding)
         context

data/lib/webgen/content_processor/ruby.rb

@@ -1,6 +1,7 @@
 # -*- encoding: utf-8 -*-
 
 require 'webgen/content_processor'
+require 'erb'
 
 module Webgen
   class ContentProcessor
@@ -8,6 +9,8 @@ module Webgen
     # Processes the content that is valid Ruby to generate new content.
     module Ruby
 
+      extend ERB::Util
+
       # Process the content of +context+ which needs to be valid Ruby code.
       def self.call(context)
         eval(context.content, binding, context.ref_node.alcn)

data/lib/webgen/content_processor/sass.rb

@@ -105,14 +105,18 @@ module Webgen
           context = options[:webgen_context]
           path = path.value
 
-          dest_node = context.website.tree[options[:filename]].resolve(path, context.dest_node.lang, true)
-          if dest_node
-            context.website.ext.item_tracker.add(context.dest_node, :node_meta_info, dest_node.alcn)
-            result = context.dest_node.route_to(dest_node)
+          ref_node = context.website.tree[options[:filename]]
+          ref_node = context.website.tree.root if ref_node.nil? && path[0] == ?/
+
+          if ref_node
+            if dest_node = ref_node.resolve(path, context.dest_node.lang, true)
+              context.website.ext.item_tracker.add(context.dest_node, :node_meta_info, dest_node.alcn)
+              path = context.dest_node.route_to(dest_node)
+            end
           else
-            result = path
+            context.website.logger.warn { "Couldn't determine reference node for resolving node in Sass file." }
           end
-          ::Sass::Script::String.new("url(\"#{result}\")")
+          ::Sass::Script::String.new(path, :string)
         end
         declare :relocatable, [:string]
 

data/lib/webgen/content_processor/tikz.rb

@@ -18,22 +18,11 @@ module Webgen
     # Uses LaTeX and the TikZ library for creating images from LaTeX code.
     module Tikz
 
-      LATEX_TEMPLATE = <<EOF
-\\nonstopmode \\documentclass{article} \\usepackage{tikz} \\pagestyle{empty}
-<% if context['content_processor.tikz.libraries'] %>
-\\usetikzlibrary{<%= context['content_processor.tikz.libraries'].join(',') %>}
-<% end %>
-\\begin{document}
-\\begin{tikzpicture}[<%= context['content_processor.tikz.opts'] %>]
-<%= context.content %>
-\\end{tikzpicture}
-\\end{document}
-EOF
-
       # Process the content with LaTeX to generate a TikZ image.
       def self.call(context)
         prepare_options(context)
-        context.content = ERB.new(LATEX_TEMPLATE).result(binding)
+        context.content = context.render_block(:name => 'content',
+                                               :chain => [context.website.tree[context['content_processor.tikz.template']]])
         context.content = File.binread(compile(context))
         context
       end
@@ -41,9 +30,11 @@ EOF
       # Collect the necessary options and save them in the context object.
       def self.prepare_options(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|
           context[opt] = context.content_node[opt] || context.website.config[opt]
         end
+        context['data'] = context.content
       end
       private_class_method :prepare_options
 
@@ -54,17 +45,16 @@ EOF
       # Returns the path to the created image.
       def self.compile(context)
         cwd = context.website.tmpdir('content_processor.tikz')
+        tex_file = File.join(cwd, context.dest_node.dest_path.tr('/', '_').sub(/\..*?$/, '.tex'))
         FileUtils.mkdir_p(cwd)
-        tempfile = Tempfile.open(['webgen-tikz', '.tex'], cwd)
-        tempfile.write(context.content)
-        tempfile.close
+        File.write(tex_file, context.content)
 
-        file = File.basename(tempfile.path, '.tex')
+        file = File.basename(tex_file, '.tex')
         ext = File.extname(context.dest_node.dest_path)
         render_res, output_res = context['content_processor.tikz.resolution'].split(' ')
 
-        execute("pdflatex --shell-escape -interaction=batchmode #{file}.tex", cwd, context) do |status, stdout, stderr|
-          errors = stderr.scan(/^!(.*\n.*)/).join("\n")
+        execute("pdflatex -shell-escape -interaction=nonstopmode -halt-on-error #{file}.tex", cwd, context) do |status, stdout, stderr|
+          errors = (stdout+stderr).scan(/^!(.*\n.*)/).join("\n")
           raise Webgen::RenderError.new("Error while parsing TikZ picture commands with PDFLaTeX: #{errors}",
                                         self.name, context.dest_node, context.ref_node)
         end

data/lib/webgen/context/html_head.rb

@@ -16,6 +16,13 @@ module Webgen
           @context = context
         end
 
+        # Set the meta tag to the provided value.
+        #
+        # Note that some meta information keys may not be specified multiple times!
+        def meta(name, content)
+          (cp_hash[:meta] ||= {})[name] = content
+        end
+
         # Add a link to the given file in the HTML head section.
         #
         # The type can either be :css for CSS files or :js for javascript files. The path to the