webgen 1.0.0.beta3 → 1.0.0

data/lib/webgen/cli.rb

@@ -6,10 +6,10 @@ require 'webgen/website'
 require 'webgen/version'
 require 'webgen/cli/logger'
 require 'webgen/cli/utils'
-require 'webgen/cli/generate_command'
-require 'webgen/cli/show_command'
-require 'webgen/cli/bundle_command'
-require 'webgen/cli/create_command'
+require 'webgen/cli/commands/generate'
+require 'webgen/cli/commands/show'
+require 'webgen/cli/commands/create'
+require 'webgen/cli/commands/install'
 
 module Webgen
 
@@ -133,7 +133,7 @@ module Webgen
                   *Utils.format_option_desc("Specify a simple configuration option (key=value)")) do |v|
             k, v = v.split('=')
             begin
-              @config_options[k] = YAML.load(v)
+              @config_options[k.to_s] = YAML.load(v.to_s)
             rescue YAML::SyntaxError
               raise ConfigurationOptionError.new("Couldn't parse value for '#{k}': #{$!}")
             end
@@ -148,12 +148,16 @@ module Webgen
         end
         self.add_command(Webgen::CLI::GenerateCommand.new, true)
         self.add_command(Webgen::CLI::ShowCommand.new)
-        self.add_command(Webgen::CLI::BundleCommand.new)
         self.add_command(Webgen::CLI::CreateCommand.new)
+        self.add_command(Webgen::CLI::InstallCommand.new)
       end
 
       # Utility method for getting the Webgen::Website object.
-      def website
+      #
+      # Returns a new website object (not an already created one) if +force_new+ is set to +true+.
+      def website(force_new = false)
+        return @website if defined?(@website) && !force_new
+
         @directory = ENV['WEBGEN_WEBSITE'] if @directory.nil? && !ENV['WEBGEN_WEBSITE'].to_s.empty?
         if @directory.nil? && @do_search
           dir = Dir.pwd
@@ -162,7 +166,7 @@ module Webgen
           @directory = dir if !file_missing
         end
         @directory = Dir.pwd if @directory.nil?
-        @website ||= Webgen::Website.new(@directory, Webgen::CLI::Logger.new) do |site, before_init|
+        @website = Webgen::Website.new(@directory, Webgen::CLI::Logger.new) do |site, before_init|
           if before_init
             site.ext.cli = self
             site.logger.level = @log_level

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

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+require 'webgen/cli/utils'
+require 'webgen/cli/commands/create_website'
+require 'webgen/cli/commands/create_bundle'
+
+module Webgen
+  module CLI
+
+    # The CLI command for creating various products, like a basic website or an extension bundle.
+    class CreateCommand < CmdParse::Command
+
+      def initialize # :nodoc:
+        super('create', true, true, false)
+        self.short_desc = 'Create some product'
+        self.description = Webgen::CLI::Utils.format_command_desc(<<DESC)
+Groups various commands together that are used for creating products, like a
+website or an extension bundle.
+DESC
+        add_command(CreateWebsiteCommand.new)
+        add_command(CreateBundleCommand.new)
+      end
+
+    end
+
+  end
+end

data/lib/webgen/cli/{create_bundle_command.rb → commands/create_bundle.rb}

@@ -11,7 +11,7 @@ module Webgen
     class CreateBundleCommand < CmdParse::Command
 
       def initialize # :nodoc:
-        super('create', false, false, true)
+        super('bundle', false, false, true)
         self.short_desc = 'Create an extension bundle'
         self.description = Utils.format_command_desc(<<DESC)
 Creates a new extension bundle. This command can either create a local bundle in the
@@ -30,7 +30,7 @@ DESC
       end
 
       def usage # :nodoc:
-        "Usage: webgen [global options] bundle create [options] BUNDLE_NAME [DIRECTORY]"
+        "Usage: webgen [global options] create bundle [options] BUNDLE_NAME [DIRECTORY]"
       end
 
       def execute(args) # :nodoc:

data/lib/webgen/cli/{create_command.rb → commands/create_website.rb}

@@ -7,10 +7,10 @@ module Webgen
   module CLI
 
     # The CLI command for creating a webgen website.
-    class CreateCommand < CmdParse::Command
+    class CreateWebsiteCommand < CmdParse::Command
 
       def initialize # :nodoc:
-        super('create', false)
+        super('website', false)
         self.short_desc = 'Create a basic webgen website'
         self.description = Utils.format_command_desc(<<DESC)
 Creates a webgen website at the specified directory. If the --template

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

@@ -0,0 +1,66 @@
+# -*- encoding: utf-8 -*-
+
+require 'webgen/cli/utils'
+
+module Webgen
+  module CLI
+
+    # The CLI command for generating a webgen website.
+    class GenerateCommand < CmdParse::Command
+
+      def initialize # :nodoc:
+        super('generate', false, false, false)
+        self.short_desc = 'Generate the webgen website'
+        self.description = Webgen::CLI::Utils.format_command_desc(<<EOF)
+This command is executed by default when no other command was specified.
+EOF
+        self.options = CmdParse::OptionParserWrapper.new do |opts|
+          opts.separator "Options:"
+          opts.on('-a', '--auto [SEC]', Integer,
+                  *Utils.format_option_desc("Auto-generate the website every SEC seconds (5=default, 0=off)")) do |val|
+            @auto_generate_secs = val || 5
+          end
+        end
+        @auto_generate_secs = 0
+      end
+
+      def execute(args) # :nodoc:
+        if @auto_generate_secs <= 0
+          commandparser.website.execute_task(:generate_website)
+        else
+          auto_generate
+        end
+      end
+
+      def auto_generate #:nodoc:
+        puts 'Starting auto-generate mode'
+
+        time = Time.now
+        abort = false
+        old_paths = []
+        dirs = "{" << commandparser.website.config['sources'].map do |mp, type, *args|
+          type == :file_system ? File.join(args[0], args[1] || '**/*') : nil
+        end.compact.join(',') << "}"
+
+        Signal.trap('INT') {abort = true}
+
+        while !abort
+          paths = Dir[dirs].sort
+          if old_paths != paths || paths.any? {|p| File.mtime(p) > time}
+            begin
+              commandparser.website(true).execute_task(:generate_website)
+            rescue Webgen::Error => e
+              puts e.message
+            end
+          end
+          time = Time.now
+          old_paths = paths
+          sleep @auto_generate_secs
+        end
+      end
+      private :auto_generate
+
+    end
+
+  end
+end

data/lib/webgen/cli/{install_bundle_command.rb → commands/install.rb}

@@ -7,7 +7,7 @@ module Webgen
   module CLI
 
     # The CLI command for installing extension bundles.
-    class InstallBundleCommand < CmdParse::Command
+    class InstallCommand < CmdParse::Command
 
       def initialize # :nodoc:
         super('install', false, false, true)

data/lib/webgen/cli/{show_command.rb → commands/show.rb}

@@ -1,10 +1,11 @@
 # -*- encoding: utf-8 -*-
 
 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'
+require 'webgen/cli/commands/show_extensions'
+require 'webgen/cli/commands/show_config'
+require 'webgen/cli/commands/show_dependencies'
+require 'webgen/cli/commands/show_tree'
+require 'webgen/cli/commands/show_bundles'
 
 module Webgen
   module CLI
@@ -24,6 +25,7 @@ DESC
         add_command(ShowExtensionsCommand.new)
         add_command(ShowDependenciesCommand.new)
         add_command(ShowTreeCommand.new)
+        add_command(ShowBundlesCommand.new)
       end
 
     end

data/lib/webgen/cli/{list_bundle_command.rb → commands/show_bundles.rb}

@@ -5,24 +5,24 @@ require 'webgen/cli/utils'
 module Webgen
   module CLI
 
-    # The CLI command for listing extension bundles.
-    class ListBundleCommand < CmdParse::Command
+    # The CLI command for showing extension bundles.
+    class ShowBundlesCommand < CmdParse::Command
 
       def initialize # :nodoc:
-        super('list', false, false, true)
-        self.short_desc = 'List extension bundles'
+        super('bundles', false, false, true)
+        self.short_desc = 'Show extension bundles'
         self.description = Utils.format_command_desc(<<DESC)
-Lists all loaded, installed and available extension bundles.
+Shows all loaded, available and installable bundles.
 
-Loaded bundles are already used by the website, installed ones are installed but
-not used and available bundles can be installed if needed.
+Loaded bundles are already used by the website, available ones are installed but
+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 available bundles")) do |remote|
+                  *Utils.format_option_desc("Use remote server for listing installable bundles")) do |remote|
             @remote = remote
           end
         end
@@ -30,10 +30,7 @@ DESC
       end
 
       def execute(args) # :nodoc:
-        bundles = {}
-        commandparser.website.ext.bundles.each do |bundle, info_file|
-          bundles.update(bundle => (info_file ? YAML.load(File.read(info_file)) : {}))
-        end
+        bundles = commandparser.website.ext.bundle_infos.bundles.dup
         bundles.each {|n,d| d[:state] = :loaded}
 
         populate_hash = lambda do |file|
@@ -62,9 +59,9 @@ DESC
         end
 
         if @remote
-          dep = Gem::Deprecate.skip_during { Gem::Dependency.new(/webgen-.*-bundle/, Gem::Requirement.default) }
-          Gem::SpecFetcher.fetcher.find_matching(dep).each do |spec, uri|
-            bundle_name = spec.first.sub(/webgen-(.*)-bundle/, '\1')
+          Gem::SpecFetcher.fetcher.detect(:latest) do |name_tuple|
+            next unless name_tuple.name =~ /webgen-(.*)-bundle/
+            bundle_name = $1
             if !bundles.has_key?(bundle_name)
               bundles[bundle_name] = {:state => :installable, :gem => spec.first}
             end

data/lib/webgen/cli/{show_config_command.rb → commands/show_config.rb}

@@ -15,12 +15,11 @@ module Webgen
 Shows all available configuration options. The option name and default value as
 well as the currently used value are displayed.
 
-If the global verbosity option is set, option descriptions are additionally
-displayed.
-
 If an argument is given, only those options that have the argument in their name
 are displayed.
 
+The global verbosity flag enables all optional display parts.
+
 Hint: A debug message will appear at the top of the output if this command is run
 in the context of a website, there are unknown configuration options in the
 configuration file and the log level is set to debug.
@@ -31,28 +30,57 @@ DESC
                   *Utils.format_option_desc("Show modified configuration options only")) do |v|
             @modified = true
           end
+          opts.on("-d", "--[no-]descriptions",
+                  *Utils.format_option_desc("Show descriptions")) do |d|
+            @show_description = d
+          end
+          opts.on("-s", "--[no-]syntax",
+                  *Utils.format_option_desc("Show the syntax")) do |s|
+            @show_syntax = s
+          end
+          opts.on("-e", "--[no-]example",
+                  *Utils.format_option_desc("Show usage examples")) do |e|
+            @show_examples = e
+          end
         end
         @modified = false
+        @show_description = false
+        @show_syntax = false
+        @show_examples = false
       end
 
       def execute(args) # :nodoc:
+        @show_description = @show_syntax = @show_examples = true if commandparser.verbose
+
         config = commandparser.website.config
+        descriptions = commandparser.website.ext.bundle_infos.options
         selector = args.first.to_s
         config.options.select do |n, d|
           n.include?(selector) && (!@modified || config[n] != d.default)
         end.sort.each do |name, data|
-          format_config_option(name, data, config[name])
+          format_config_option(name, data, config[name], descriptions[name])
         end
       end
 
-      def format_config_option(name, data, cur_val)
+      def format_config_option(name, data, cur_val, meta_info)
         print("#{Utils.light(Utils.blue(name))}: ")
         if cur_val != data.default
           puts(Utils.green(cur_val.to_s) + " (default: #{data.default})")
         else
           puts(cur_val.inspect)
         end
-        puts(Utils.format(data.description, 78, 2, true).join("\n") + "\n\n") if commandparser.verbose
+
+        puts(Utils.format(meta_info['summary'], 78, 2, true).join("\n") + "\n\n") if @show_description
+        if @show_syntax
+          puts(Utils.format("Syntax:", 78, 2, true).join("\n"))
+          puts(Utils.format(meta_info['syntax'], 78, 4, true).join("\n") + "\n\n")
+        end
+        if @show_examples
+          meta_info['example'].each do |n,v|
+            puts(Utils.format("Example for usage in #{n}:", 78, 2, true).join("\n"))
+            puts(Utils.format(v, 78, 4, true).join("\n") + "\n\n")
+          end
+        end
       end
       private :format_config_option
 

data/lib/webgen/cli/{show_extensions_command.rb → commands/show_extensions.rb}

@@ -31,20 +31,8 @@ DESC
       end
 
       def execute(args) # :nodoc:
-        exts = {}
-        commandparser.website.ext.bundles.each do |bundle, info_file|
-          next if info_file.nil? || (@bundle && @bundle != bundle)
-          infos = YAML.load(File.read(info_file))
-          next unless infos['extensions']
-          infos['extensions'].each do |n, d|
-            d['bundle'] = bundle
-            d['author'] ||= infos['author']
-          end
-          exts.update(infos['extensions'])
-        end
-
         selector = args.first.to_s
-        exts.select {|n, d| n.include?(selector)}.sort.each do |name, data|
+        commandparser.website.ext.bundle_infos.extensions.select {|n, d| n.include?(selector)}.sort.each do |name, data|
           format_extension_info(name, data, !selector.empty?)
         end
       end

data/lib/webgen/cli/{show_tree_command.rb → commands/show_tree.rb}

@@ -20,6 +20,9 @@ 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.
 
+Due to the way webgen works this command may take some time before actually
+showing the tree because it has to be built first.
+
 If an argument is given, only those nodes that have the argument in their LCN
 are displayed.
 

data/lib/webgen/cli/utils.rb

@@ -10,7 +10,7 @@ module Webgen
     module Utils
 
       class << self; attr_accessor :use_colors; end
-      @use_colors = $stdout.tty? && RbConfig::CONFIG['host_os'] !~ /mswin|mingw/
+      @use_colors = $stdout.tty? && (RbConfig::CONFIG['host_os'] !~ /mswin|mingw/ || ENV['ANSICON'])
 
       DEFAULT_WIDTH = 80
 

data/lib/webgen/configuration.rb

@@ -9,26 +9,26 @@ module Webgen
   #
   # Configuration options can be created by using the define_option method:
   #
-  #   config.define_option "my.new.option", 'default value', 'description'
+  #   config.define_option "my.new.option", 'default value'
   #
   # and later accessed or set using the accessor methods #[] and #[]=. A validation block can also
   # be specified when defining an option. This validation block is called when a new value should be
   # set and it should return the (possibly changed) value to be set:
   #
-  #   config.define_option "my.new.option", 'default value', 'description' do |val|
+  #   config.define_option "my.new.option", 'default value' do |val|
   #     raise "Option must be a string" unless val.kind_of?(String)
   #     val.upcase
   #   end
   #
   # **Note**: When a Configuration object is dumped (via Marshal), the option validator procs are
-  # not dumped and can therefore not be restored.
+  # not dumped and can therefore not be restored!
   class Configuration
 
     # Raised by the Webgen::Configuration class.
     class Error < Webgen::Error; end
 
     # Struct class for storing a configuration option.
-    Option = Struct.new(:default, :description, :validator) do
+    Option = Struct.new(:default, :validator) do
       def dupped_default #:nodoc:
         default.dup rescue default
       end
@@ -38,12 +38,11 @@ module Webgen
       end
 
       def marshal_dump #:nodoc:
-        [self.default, self.description]
+        self.default
       end
 
       def marshal_load(data) #:nodoc:
-        self.default = data[0]
-        self.description = data[1]
+        self.default = data
       end
 
     end
@@ -82,17 +81,16 @@ module Webgen
       @options == other.options && @values == other.instance_variable_get(:@values)
     end
 
-    # Define a new option +name+ with a default value of +default+ and the description.
+    # Define a new option +name+ with a default value of +default+.
     #
     # If a validation block is provided, it is called with the new value when one is set and should
     # return a (possibly altered) value to be set.
-    def define_option(name, default, description, &validator)
+    def define_option(name, default, &validator)
       if @options.has_key?(name)
         raise ArgumentError, "Configuration option '#{name}' has already be defined"
       else
         @options[name] = Option.new
         @options[name].default = default.freeze
-        @options[name].description = description.freeze
         @options[name].validator = validator.freeze
         @options[name].freeze
       end
@@ -174,7 +172,7 @@ module Webgen
       data = if String === filename || filename.respond_to?(:read)
                begin
                  YAML::load(String === filename ? File.read(filename) : filename.read) || {}
-               rescue RuntimeError, ArgumentError, SyntaxError => e
+               rescue RuntimeError, ArgumentError, SyntaxError, YAML::SyntaxError => e
                  raise Error, "Problem parsing configuration data (it needs to contain a YAML hash): #{e.message}", e.backtrace
                end
              else