webgen 1.3.0 → 1.4.0

data/lib/webgen/cli/commands/install.rb

@@ -10,17 +10,15 @@ module Webgen
     class InstallCommand < CmdParse::Command
 
       def initialize # :nodoc:
-        super('install', false, false, true)
-        self.short_desc = 'Install an extension bundle'
-        self.description = Utils.format_command_desc(<<DESC)
+        super('install', takes_commands: false)
+        short_desc('Install an extension bundle')
+        long_desc(<<DESC)
 Installs an extension bundle via Rubygems. You can either provide the name
 of a webgen extension bundle, the name of a Rubygem or a local file name.
 DESC
       end
 
-      def execute(args) # :nodoc:
-        raise CmdParse::InvalidArgumentError.new("Bundle name needed but none given") if args.length == 0
-        name = args.first
+      def execute(name) # :nodoc:
         name = "webgen-#{name}-bundle" unless name =~ /\.gem$/ || name =~ /webgen-.*-bundle/
 
         inst = Gem::DependencyInstaller.new(:domain => :both, :force => false)

data/lib/webgen/cli/commands/show.rb

@@ -14,9 +14,9 @@ module Webgen
     class ShowCommand < CmdParse::Command
 
       def initialize # :nodoc:
-        super('show', true, true, false)
-        self.short_desc = 'Show various information about webgen or a website'
-        self.description = Webgen::CLI::Utils.format_command_desc(<<DESC)
+        super('show', takes_commands: true)
+        short_desc('Show various information about webgen or a website')
+        long_desc(<<DESC)
 Groups various commands together that are used for showing information about webgen,
 like available extensions or configuration options. If a sub-command is invoked in the
 context of a webgen website, information about the website is also included.

data/lib/webgen/cli/commands/show_bundles.rb

@@ -9,9 +9,9 @@ module Webgen
     class ShowBundlesCommand < CmdParse::Command
 
       def initialize # :nodoc:
-        super('bundles', false, false, true)
-        self.short_desc = 'Show extension bundles'
-        self.description = Utils.format_command_desc(<<DESC)
+        super('bundles', takes_commands: false)
+        short_desc('Show extension bundles')
+        long_desc(<<DESC)
 Shows all loaded, available and installable bundles.
 
 Loaded bundles are already used by the website, available ones are installed but
@@ -19,18 +19,14 @@ not used and installable bundles can be installed if needed.
 
 Hint: The global verbosity option enables additional output.
 DESC
-        self.options = CmdParse::OptionParserWrapper.new do |opts|
-          opts.separator "Options:"
-          opts.on("-r", "--[no-]remote",
-                  *Utils.format_option_desc("Use remote server for listing installable bundles")) do |remote|
-            @remote = remote
-          end
+        options.on("-r", "--[no-]remote", "Use remote server for listing installable bundles") do |remote|
+          @remote = remote
         end
         @remote = false
       end
 
-      def execute(args) # :nodoc:
-        bundles = commandparser.website.ext.bundle_infos.bundles.dup
+      def execute # :nodoc:
+        bundles = command_parser.website.ext.bundle_infos.bundles.dup
         bundles.each {|n,d| d[:state] = :loaded}
 
         populate_hash = lambda do |file|
@@ -63,7 +59,7 @@ DESC
             next unless name_tuple.name =~ /webgen-(.*)-bundle/
             bundle_name = $1
             if !bundles.has_key?(bundle_name)
-              bundles[bundle_name] = {:state => :installable, :gem => spec.first}
+              bundles[bundle_name] = {:state => :installable, :gem => name_tuple.name}
             end
           end
         end
@@ -89,7 +85,7 @@ DESC
         puts(Utils.light(Utils.blue(name)))
         puts("  State:    #{data[:state]}")
         puts("  Rubygem:  #{data[:gem]}") if data[:gem]
-        if commandparser.verbose && data['author']
+        if command_parser.verbose && data['author']
           puts("  Author:   #{data['author']}")
           print("  Summary:  ")
           puts(Utils.format(data['summary'], 78, 12, false))

data/lib/webgen/cli/commands/show_config.rb

@@ -9,9 +9,9 @@ module Webgen
     class ShowConfigCommand < CmdParse::Command
 
       def initialize # :nodoc:
-        super('config', false, false, true)
-        self.short_desc = 'Show available configuration options'
-        self.description = Utils.format_command_desc(<<DESC)
+        super('config', takes_commands: false)
+        short_desc('Show available configuration options')
+        long_desc(<<DESC)
 Shows all available configuration options. The option name and default value as
 well as the currently used value are displayed.
 
@@ -24,22 +24,17 @@ Hint: A debug message will appear at the top of the output if this command is ru
 in the context of a website, there are unknown configuration options in the
 configuration file and the log level is set to debug.
 DESC
-        self.options = CmdParse::OptionParserWrapper.new do |opts|
-          opts.separator "Options:"
-          opts.on("-m", "--modified",
-                  *Utils.format_option_desc("Show modified configuration options only")) do |v|
+        options do |opts|
+          opts.on("-m", "--modified", "Show modified configuration options only") do |v|
             @modified = true
           end
-          opts.on("-d", "--[no-]descriptions",
-                  *Utils.format_option_desc("Show descriptions")) do |d|
+          opts.on("-d", "--[no-]descriptions", "Show descriptions") do |d|
             @show_description = d
           end
-          opts.on("-s", "--[no-]syntax",
-                  *Utils.format_option_desc("Show the syntax")) do |s|
+          opts.on("-s", "--[no-]syntax", "Show the syntax") do |s|
             @show_syntax = s
           end
-          opts.on("-e", "--[no-]example",
-                  *Utils.format_option_desc("Show usage examples")) do |e|
+          opts.on("-e", "--[no-]example", "Show usage examples") do |e|
             @show_examples = e
           end
         end
@@ -49,12 +44,11 @@ DESC
         @show_examples = false
       end
 
-      def execute(args) # :nodoc:
-        @show_description = @show_syntax = @show_examples = true if commandparser.verbose
+      def execute(selector = '') # :nodoc:
+        @show_description = @show_syntax = @show_examples = true if command_parser.verbose
 
-        config = commandparser.website.config
-        descriptions = commandparser.website.ext.bundle_infos.options
-        selector = args.first.to_s
+        config = command_parser.website.config
+        descriptions = command_parser.website.ext.bundle_infos.options
         config.options.select do |n, d|
           n.include?(selector) && (!@modified || config[n] != d.default)
         end.sort.each do |name, data|

data/lib/webgen/cli/commands/show_dependencies.rb

@@ -9,9 +9,9 @@ module Webgen
     class ShowDependenciesCommand < CmdParse::Command
 
       def initialize # :nodoc:
-        super('deps', false, false, true)
-        self.short_desc = 'Show dependencies for all paths'
-        self.description = Utils.format_command_desc(<<DESC)
+        super('deps', takes_commands: false)
+        short_desc('Show dependencies for all paths')
+        long_desc(<<DESC)
 Shows the dependencies (i.e. tracked items) for each path. This is only useful
 after webgen has generated the website at least once so that this information
 is available.
@@ -23,17 +23,16 @@ Hint: The global verbosity option enables additional output.
 DESC
       end
 
-      def execute(args) # :nodoc:
-        data = commandparser.website.ext.item_tracker.cached_items(commandparser.verbose)
+      def execute(selector = nil) # :nodoc:
+        data = command_parser.website.ext.item_tracker.cached_items(command_parser.verbose)
         if data.empty?
           puts "No data available, you need to generate the website first!"
           return
         end
-        arg = args.shift
 
-        data.select! {|alcn, _| alcn.include?(arg) } if arg
+        data.select! {|alcn, _| alcn.include?(selector) } if selector
         data.sort.each do |alcn, items|
-          if items.length > 0 || commandparser.verbose
+          if items.length > 0 || command_parser.verbose
             puts("#{Utils.light(Utils.blue(alcn))}: ")
             items.each {|d| puts("  #{[d].flatten.join("\n    ")}")}
           end

data/lib/webgen/cli/commands/show_extensions.rb

@@ -9,9 +9,9 @@ module Webgen
     class ShowExtensionsCommand < CmdParse::Command
 
       def initialize # :nodoc:
-        super('extensions', false, false, true)
-        self.short_desc = 'Show available extensions'
-        self.description = Utils.format_command_desc(<<DESC)
+        super('extensions', takes_commands: false)
+        short_desc('Show available extensions')
+        long_desc(<<DESC)
 Shows all available extensions and additional information about them, e.g. a
 short summary of the functionality or the extension bundle it is defined in.
 
@@ -20,19 +20,16 @@ name are displayed.
 
 Hint: The global verbosity option enables additional output.
 DESC
-        self.options = CmdParse::OptionParserWrapper.new do |opts|
-          opts.separator "Options:"
-          opts.on("-b NAME", "--bundle NAME", String,
-                  *Utils.format_option_desc("Only show extensions of this bundle")) do |bundle|
-            @bundle = bundle
-          end
+        options.on("-b NAME", "--bundle NAME", String, "Only show extensions of this bundle") do |bundle|
+          @bundle = bundle
         end
         @bundle = nil
       end
 
-      def execute(args) # :nodoc:
-        selector = args.first.to_s
-        commandparser.website.ext.bundle_infos.extensions.select {|n, d| n.include?(selector)}.sort.each do |name, data|
+      def execute(selector = '') # :nodoc:
+        command_parser.website.ext.bundle_infos.extensions.select do |n, d|
+          n.include?(selector) && (@bundle.nil? || d['bundle'] == @bundle)
+        end.sort.each do |name, data|
           format_extension_info(name, data, !selector.empty?)
         end
       end
@@ -42,7 +39,7 @@ DESC
 
         indentation = (has_selector ? 0 : name.count('.')*2)
         puts(" "*indentation + Utils.light(Utils.blue(name)))
-        if commandparser.verbose
+        if command_parser.verbose
           print(" "*(indentation + 2) + "Bundle:  ")
           puts(Utils.format(data['bundle'], 78, indentation + 11, false))
           print(" "*(indentation + 2) + "Author:  ")

data/lib/webgen/cli/commands/show_tree.rb

@@ -9,9 +9,9 @@ module Webgen
     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)
+        super('tree', takes_commands: false)
+        short_desc('Show the node tree')
+        long_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.
@@ -28,18 +28,14 @@ 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|
+        options do |opts|
+          opts.on("-a", "--alcn", "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|
+          opts.on("-f", "--[no-]fragments", "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|
+          opts.on("-m", "--[no-]meta-info", "Show meta information (default: no)") do |v|
             @meta_info = v
           end
         end
@@ -48,10 +44,9 @@ DESC
         @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)
+      def execute(selector = nil) # :nodoc:
+        command_parser.website.ext.path_handler.populate_tree
+        data = collect_data(command_parser.website.tree.dummy_root.children, selector)
         print_tree(data, selector)
       end
 
@@ -61,7 +56,7 @@ DESC
           if sub.length > 0 ||
               ((selector.nil? || node.alcn.include?(selector)) &&
                ((!node.is_fragment? || @show_fragments) &&
-                (!node['passive'] || commandparser.website.ext.item_tracker.node_referenced?(node))))
+                (!node['passive'] || command_parser.website.ext.item_tracker.node_referenced?(node))))
             data = [@use_alcn ? node.alcn : node.lcn]
             data << node.alcn
             data << (@meta_info ? node.meta_info.map {|k,v| "#{k}: #{v.inspect}"} : [])

data/lib/webgen/cli/utils.rb

@@ -38,24 +38,6 @@ module Webgen
         end
       end
 
-      # Format the command description.
-      #
-      # Returns an array of Strings.
-      #
-      # See Utils.format for more information.
-      def self.format_command_desc(desc)
-        format(desc, 76)
-      end
-
-      # Format the option description.
-      #
-      # Returns an array of Strings.
-      #
-      # See Utils.format for more information.
-      def self.format_option_desc(desc)
-        format(desc, 48)
-      end
-
       # Return an array of lines which represents the text in +content+ formatted so that no line is
       # longer than +width+ characters.
       #

data/lib/webgen/content_processor.rb

@@ -113,13 +113,13 @@ module Webgen
     # Normalize the content processor pipeline.
     #
     # The pipeline parameter can be a String in the format 'a,b,c' or 'a, b, c' or an array '[a, b,
-    # c]' with content processors a, b and c.
+    # c]' with content processor names a, b and c.
     #
     # Raises an error if an unknown content processor is found.
     #
     # Returns an array with valid content processors.
     def normalize_pipeline(pipeline)
-      pipeline = (pipeline.kind_of?(String) ? pipeline.split(/,\s*/) : pipeline)
+      pipeline = (pipeline.kind_of?(String) ? pipeline.split(/,\s*/) : pipeline.to_a)
       pipeline.each do |processor|
         raise Webgen::Error.new("Unknown content processor '#{processor}'") if !registered?(processor)
       end

data/lib/webgen/content_processor/sass.rb

@@ -34,6 +34,12 @@ module Webgen
           @context = context
         end
 
+        def marshal_dump #:nodoc:
+        end
+
+        def marshal_load(data) #:nodoc:
+        end
+
         # @see Base#find_relative
         def find_relative(name, base, options)
           _find(base, name, options)

data/lib/webgen/item_tracker/nodes.rb

@@ -62,7 +62,14 @@ module Webgen
         method, _, type = *iid
         str = (type == :content ? "Content" : "Meta info") << " from these nodes"
         str << " (result of #{[method].flatten.join('.')}):"
-        [str] + data.flatten
+        data_mapper = lambda do |item|
+          if item.kind_of?(Array)
+            [item[0], item[1].map(&data_mapper).map {|inner| [inner].flatten.map {|l| "  #{l}"}}]
+          else
+            item
+          end
+        end
+        [str] + data.map(&data_mapper).flatten
       end
 
       # Use Webgen::NodeFinder to generate a (nested) list of nodes. The options hash has to contain

data/lib/webgen/node_finder.rb

@@ -34,8 +34,13 @@ module Webgen
   #
   # The +result.nodes+ accessor contains the array of nodes that should be manipulated in-place.
   #
-  # If a filter uses the reference node in any way, it has to set +result.ref_node_used+ to +true+
-  # to allow proper caching!
+  # If a filter uses the reference node, it has to tell the node finder about it to allow proper
+  # caching:
+  #
+  # * If the node's language property is used, +result.lang_used+ has to be set to +true+.
+  # * If the node's hierarchy level is used, +result.level_used+ has to be set to +true+.
+  # * If the node's parent is used, +result.parent_node_used+ has to be set to +true+.
+  # * In all other cases, +result.ref_node_used+ has to be set to +true+
   #
   # Here is a sample filter module which provides the ability to filter nodes based on the meta
   # information key +category+. The +category+ key contains an array with one or more categories.
@@ -58,7 +63,14 @@ module Webgen
     # Result class used when filtering the nodes.
     #
     # The attribute +ref_node_used+ must not be set to +false+ once it is +true+!
-    Result = Struct.new(:nodes, :ref_node_used)
+    Result = Struct.new(:nodes, :ref_node_used, :level_used, :lang_used, :parent_node_used) do
+      def merge_attrs!(result)
+        self.ref_node_used ||= result.ref_node_used
+        self.lang_used ||= result.lang_used
+        self.level_used ||= result.level_used
+        self.parent_node_used ||= result.parent_node_used
+      end
+    end
 
     # Create a new NodeFinder object for the given website.
     def initialize(website)
@@ -99,7 +111,7 @@ module Webgen
     # +ref_node+ is used as reference node.
     def find(opts_or_name, ref_node)
       if result = cached_result(opts_or_name, ref_node)
-        return result
+        return result.nodes
       end
       opts = prepare_options_hash(opts_or_name)
 
@@ -107,20 +119,21 @@ module Webgen
       flatten = true if limit || offset
       levels = [levels || [1, 1_000_000]].flatten.map {|i| i.to_i}
 
-      nodes, ref_node_used = filter_nodes(opts, ref_node)
+      result = filter_nodes(opts, ref_node)
+      nodes = result.nodes
 
       if flatten
         sort_nodes(nodes, sort, reverse)
         nodes = nodes[(offset.to_s.to_i)..(limit ? offset.to_s.to_i + limit.to_s.to_i - 1 : -1)] if limit || offset
       else
-        result = {}
+        temp = {}
         min_level = 1_000_000
         nodes.each {|n| min_level = n.level if n.level < min_level}
 
         nodes.each do |n|
           hierarchy_nodes = []
           (hierarchy_nodes.unshift(n); n = n.parent) while n.level >= min_level
-          hierarchy_nodes.inject(result) {|memo, hn| memo[hn] ||= {}}
+          hierarchy_nodes.inject(temp) {|memo, hn| memo[hn] ||= {}}
         end
 
         reducer = lambda do |h, level|
@@ -133,11 +146,13 @@ module Webgen
             h.map {|k,v| k}
           end
         end
-        nodes = reducer.call(result, 1)
+        nodes = reducer.call(temp, 1)
         sort_nodes(nodes, sort, reverse, false)
       end
 
-      cache_result(opts_or_name, ref_node, nodes, ref_node_used)
+      result.nodes = nodes
+      cache_result(opts_or_name, ref_node, result)
+      result.nodes
     end
 
     #######
@@ -145,15 +160,20 @@ module Webgen
     #######
 
     def cached_result(opts, ref_node)
-      result_cache[opts] || result_cache[[opts, ref_node.alcn]]
+      (result = result_cache[opts]) && result_cache[cache_key(opts, ref_node, result)]
     end
 
-    def cache_result(opts, ref_node, result, ref_node_used)
-      if ref_node_used
-        result_cache[[opts, ref_node.alcn]] = result
-      else
-        result_cache[opts] = result
-      end
+    def cache_result(opts, ref_node, result)
+      result_cache[opts] = result
+      result_cache[cache_key(opts, ref_node, result)] = result
+    end
+
+    def cache_key(opts, ref_node, result)
+      [opts,
+       result.ref_node_used && ref_node.alcn,
+       result.lang_used && ref_node.lang,
+       result.level_used && ref_node.level,
+       result.parent_node_used && ref_node.parent.alcn]
     end
 
     def result_cache
@@ -189,7 +209,7 @@ module Webgen
         end
       end
 
-      [result.nodes, result.ref_node_used]
+      result
     end
 
     def sort_nodes(nodes, sort, reverse, flat_mode = true)
@@ -217,9 +237,9 @@ module Webgen
       [opts].flatten.each do |cur_opts|
         cur_opts = prepare_options_hash(cur_opts)
         remove_non_filter_options(cur_opts)
-        nodes, ref_node_used = filter_nodes(cur_opts, ref_node)
-        result.nodes &= nodes
-        result.ref_node_used |= ref_node_used
+        inner_result = filter_nodes(cur_opts, ref_node)
+        result.nodes &= inner_result.nodes
+        result.merge_attrs!(inner_result)
       end
     end
 
@@ -227,9 +247,9 @@ module Webgen
       [opts].flatten.each do |cur_opts|
         cur_opts = prepare_options_hash(cur_opts)
         remove_non_filter_options(cur_opts)
-        nodes, ref_node_used = filter_nodes(cur_opts, ref_node)
-        result.nodes |= nodes
-        result.ref_node_used |= ref_node_used
+        inner_result = filter_nodes(cur_opts, ref_node)
+        result.nodes |= inner_result.nodes
+        result.merge_attrs!(inner_result)
       end
     end
 
@@ -237,9 +257,9 @@ module Webgen
       [opts].flatten.each do |cur_opts|
         cur_opts = prepare_options_hash(cur_opts)
         remove_non_filter_options(cur_opts)
-        nodes, ref_node_used = filter_nodes(cur_opts, ref_node)
-        result.nodes -= nodes
-        result.ref_node_used |= ref_node_used
+        inner_result = filter_nodes(cur_opts, ref_node)
+        result.nodes -= inner_result.nodes
+        result.merge_attrs!(inner_result)
       end
     end
 
@@ -248,15 +268,17 @@ module Webgen
     end
 
     def filter_alcn(result, ref_node, alcn)
-      result.ref_node_used = true
-      alcn = [alcn].flatten.map {|a| Webgen::Path.append(ref_node.alcn, a.to_s)}
+      alcn = [alcn].flatten.map do |a|
+        result.ref_node_used = true unless a.to_s.start_with?('/')
+        Webgen::Path.append(ref_node.alcn, a.to_s)
+      end
       result.nodes.keep_if {|n| alcn.any? {|a| n =~ a}}
     end
 
     def filter_absolute_levels(result, ref_node, range)
       range = [range].flatten.map do |i|
         if (i = i.to_i) < 0
-          result.ref_node_used = true
+          result.level_used = true
           ref_node.level + 1 + i
         else
           i
@@ -268,7 +290,7 @@ module Webgen
     def filter_lang(result, ref_node, langs)
       langs = [langs].flatten.map do |l|
         if l == 'node'
-          result.ref_node_used = true
+          result.lang_used = true
           ref_node.lang
         else
           l
@@ -306,7 +328,7 @@ module Webgen
 
     def filter_siblings(result, ref_node, value)
       return unless value
-      result.ref_node_used = true
+      result.parent_node_used = true
 
       if value == true
         result.nodes.keep_if {|n| n.parent == ref_node.parent}