webgen 0.5.17 → 1.0.0.beta1

data/lib/webgen/cli/bundle_command.rb

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+require 'webgen/cli/utils'
+require 'webgen/cli/install_bundle_command'
+require 'webgen/cli/list_bundle_command'
+require 'webgen/cli/create_bundle_command'
+
+module Webgen
+  module CLI
+
+    # The CLI command for bundle related operations.
+    class BundleCommand < CmdParse::Command
+
+      def initialize # :nodoc:
+        super('bundle', true, true, false)
+        self.short_desc = 'Work with extension bundles'
+        self.description = Webgen::CLI::Utils.format_command_desc(<<DESC)
+Groups various commands together that are used for working with extension bundles. If
+a sub-command is invoked in the context of a webgen website, information about the
+website is also included.
+DESC
+        add_command(ListBundleCommand.new, true)
+        add_command(InstallBundleCommand.new)
+        add_command(CreateBundleCommand.new)
+      end
+
+    end
+
+  end
+end

data/lib/webgen/cli/create_bundle_command.rb

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+require 'webgen/cli/utils'
+require 'fileutils'
+require 'erb'
+
+module Webgen
+  module CLI
+
+    # The CLI command for creating a new extension bundle.
+    class CreateBundleCommand < CmdParse::Command
+
+      def initialize # :nodoc:
+        super('create', 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
+website's ext/ directory or a bundle that can be distributed via Rubygems. In the
+latter case you can optionally specify the directory under which the bundle should
+be created.
+DESC
+        self.options = CmdParse::OptionParserWrapper.new do |opts|
+          opts.separator "Options:"
+          opts.on("-d", "--distribution-format",
+                  *Utils.format_option_desc("Create the bundle in distribution format")) do
+            @type = :gem
+          end
+        end
+        @type = :local
+      end
+
+      def usage # :nodoc:
+        "Usage: webgen [global options] bundle create [options] BUNDLE_NAME [DIRECTORY]"
+      end
+
+      def execute(args) # :nodoc:
+        bundle_name = args.shift
+        raise "The argument NAME is mandatory" if bundle_name.to_s.empty?
+        directory = args.shift || bundle_name
+        commandparser.website.execute_task(:create_bundle, bundle_name, @type, directory)
+      end
+
+    end
+
+  end
+end

data/lib/webgen/cli/create_command.rb

@@ -1,72 +1,60 @@
 # -*- encoding: utf-8 -*-
 
-require 'webgen/cli'
-require 'webgen/websitemanager'
-
-module Webgen::CLI
-
-  # The CLI command for creating a webgen website.
-  class CreateCommand < CmdParse::Command
-
-    def initialize #:nodoc:
-      super('create', false)
-      self.description = Utils.format("If the verbosity level is set to verbose, the created files are listed.")
-      @bundles = []
-
-      self.short_desc = 'Create a basic webgen website from website bundles'
-      self.options = CmdParse::OptionParserWrapper.new do |opts|
-        opts.separator "Options:"
-        opts.on('-b', '--bundle BUNDLE', String, "A website bundle name/URL or 'none'. Can be used more than once (default: [default, style-andreas07])") do |val|
-          if val.downcase == 'none'
-            @bundles = nil
-          elsif !@bundles.nil?
-            @bundles << val
+require 'webgen/cli/utils'
+
+module Webgen
+  module CLI
+
+    # The CLI command for creating a webgen website.
+    class CreateCommand < CmdParse::Command
+
+      def initialize # :nodoc:
+        super('create', 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
+option is not used, a basic website is created. Otherwise the template
+defines the content of website.
+
+Hint: If the global verbosity option is enabled, the created files are
+displayed.
+DESC
+
+        @template = nil
+        self.options = CmdParse::OptionParserWrapper.new do |opts|
+          opts.separator "Options:"
+          opts.on('-t', '--template TEMPLATE', String, "A website template (optional)") do |val|
+            @template = val
           end
+          opts.separator ""
+          opts.separator "Arguments:"
+          opts.separator opts.summary_indent + "DIR: the directory in which the website should be created"
         end
-        opts.separator ""
-        opts.separator "Arguments:"
-        opts.separator opts.summary_indent + "DIR: the directory in which the website should be created"
       end
-    end
-
-    def usage # :nodoc:
-      "Usage: #{commandparser.program_name} [global options] create [options] DIR"
-    end
-
-    def show_help # :nodoc:
-      super
-      wm = Webgen::WebsiteManager.new(commandparser.directory)
 
-      puts
-      puts "Available bundles:"
-      puts Utils.headline('Bundles')
-      wm.bundles.sort.each {|name, entry| Utils.hash_output(name, entry.instance_eval { @table }) }
-    end
+      def show_help #:nodoc:
+        super
+        templates = commandparser.website.ext.task.data(:create_website)[:templates].keys.sort
+        puts "Available templates:"
+        output = if templates.empty?
+                   "No templates available"
+                 else
+                   templates.join(', ')
+                 end
+        puts Utils.format(output, Utils::DEFAULT_WIDTH - 4, 4, true).join("\n")
+      end
 
-    # Create a webgen website in the directory <tt>args[0]</tt>.
-    def execute(args)
-      if args.length == 0
-        raise OptionParser::MissingArgument.new('DIR')
-      else
-        wm = Webgen::WebsiteManager.new(args[0])
-        paths = wm.create_website
-        begin
-          if @bundles
-            @bundles = ['default', 'style-andreas07'] if @bundles.empty?
-            @bundles.each {|name| paths += wm.apply_bundle(Utils.match_bundle_name(wm, name)) }
-          end
-        rescue
-          require 'fileutils'
-          FileUtils.rm_rf(args[0])
-          raise
-        end
-        if commandparser.verbosity == :verbose
-          puts "The following files were created in the directory #{args[0]}:"
-          puts paths.sort.join("\n")
-        end
+      def execute(args) # :nodoc:
+        raise OptionParser::MissingArgument.new('DIR') if args.length == 0
+        Webgen::Website.new(args[0], Webgen::CLI::Logger.new) do |website|
+          website.logger.verbose = commandparser.verbose
+        end.execute_task(:create_website, @template)
+        puts "Created a new webgen website in <#{args[0]}>" + (@template ? "using the '#{template}' template" : '')
+      rescue Webgen::Task::CreateWebsite::Error => e
+        puts "An error occured while creating the website: #{e.message}"
       end
+
     end
 
   end
-
 end

data/lib/webgen/cli/generate_command.rb

@@ -0,0 +1,25 @@
+# -*- 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("This command is executed by default when " +
+                                                                  "no other command was specified.")
+      end
+
+      def execute(args) # :nodoc:
+        commandparser.website.execute_task(:generate_website)
+      end
+
+    end
+
+  end
+end

data/lib/webgen/cli/install_bundle_command.rb

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+require 'webgen/cli/utils'
+require 'rubygems/dependency_installer'
+
+module Webgen
+  module CLI
+
+    # The CLI command for installing extension bundles.
+    class InstallBundleCommand < CmdParse::Command
+
+      def initialize # :nodoc:
+        super('install', false, false, true)
+        self.short_desc = 'Install an extension bundle'
+        self.description = Utils.format_command_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
+        name = "webgen-#{name}-bundle" unless name =~ /\.gem$/ || name =~ /webgen-.*-bundle/
+
+        inst = Gem::DependencyInstaller.new(:domain => :both, :force => false)
+        inst.install(name)
+        puts "Installed #{name}"
+      end
+
+    end
+
+  end
+end

data/lib/webgen/cli/list_bundle_command.rb

@@ -0,0 +1,108 @@
+# -*- encoding: utf-8 -*-
+
+require 'webgen/cli/utils'
+
+module Webgen
+  module CLI
+
+    # The CLI command for listing extension bundles.
+    class ListBundleCommand < CmdParse::Command
+
+      def initialize # :nodoc:
+        super('list', false, false, true)
+        self.short_desc = 'List extension bundles'
+        self.description = Utils.format_command_desc(<<DESC)
+Lists all loaded, installed and available extension bundles.
+
+Loaded bundles are already used by the website, installed ones are installed but
+not used and available 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|
+            @remote = remote
+          end
+        end
+        @remote = false
+      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.each {|n,d| d[:state] = :loaded}
+
+        populate_hash = lambda do |file|
+          bundle_name = File.basename(File.dirname(file))
+          info_file = File.join(File.dirname(file), 'info.yaml')
+          bundles[bundle_name] ||= (File.file?(info_file) ? YAML.load(File.read(info_file)) : {})
+          bundles[bundle_name][:state] ||= :available
+          bundles[bundle_name]
+        end
+
+        $LOAD_PATH.each do |path|
+          Dir.glob(File.join(path, 'webgen/bundle', '*', 'init.rb')).each do |file|
+            populate_hash.call(file)
+          end
+        end
+
+        Gem::Specification.map do |spec|
+          [spec.name, spec.matches_for_glob("webgen/bundle/*/init.rb")]
+        end.select do |name, files|
+          !files.empty?
+        end.each do |name, files|
+          files.each do |file|
+            hash = populate_hash.call(file)
+            hash[:gem] = name
+          end
+        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')
+            if !bundles.has_key?(bundle_name)
+              bundles[bundle_name] = {:state => :installable, :gem => spec.first}
+            end
+          end
+        end
+
+        bundles.sort do |a, b|
+          if a.last[:state] == b.last[:state]
+            a.first <=> b.first
+          elsif a.last[:state] == :loaded
+            -1
+          elsif b.last[:state] == :loaded
+            1
+          elsif a.last[:state] == :available
+            -1
+          else
+            1
+          end
+        end.each do |name, data|
+          format_bundle_info(name, data)
+        end
+      end
+
+      def format_bundle_info(name, data)
+        puts(Utils.light(Utils.blue(name)))
+        puts("  State:    #{data[:state]}")
+        puts("  Rubygem:  #{data[:gem]}") if data[:gem]
+        if commandparser.verbose && data['author']
+          puts("  Author:   #{data['author']}")
+          print("  Summary:  ")
+          puts(Utils.format(data['summary'], 78, 12, false))
+          puts("  Version:  #{data['version']}") if data['version']
+        end
+        puts
+      end
+      private :format_bundle_info
+
+    end
+
+  end
+end

data/lib/webgen/cli/logger.rb

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+require 'webgen/logger'
+require 'webgen/cli/utils'
+
+module Webgen
+
+  module CLI
+
+    # The logger class used by the command line interface.
+    class Logger < Webgen::Logger
+
+      attr_accessor :prefix
+
+      # Create a new Logger object for the command line interface.
+      def initialize(outdev = $stdout)
+        super(outdev)
+        @prefix = ''
+        outdev.sync = true if outdev.respond_to?(:sync=)
+        self.formatter = Proc.new do |severity, timestamp, progname, msg|
+          msg = msg.dup
+          msg.gsub!(/<.*?>/) {|m| Utils.bold(m)}
+          msg.gsub!(/\n/, "\n      ")
+          case severity
+          when 'INFO'
+            msg.sub!(/^\s*\[(?:create|update)\]/) {|m| Utils.bold(Utils.green(m))}
+            "%s%-5s %s\n" % [@prefix, severity, msg]
+          when 'WARN'
+            "%s%s%-5s%s %s\n" % [@prefix, Utils.bold + Utils.yellow, severity, Utils.reset, msg]
+          when 'ERROR', 'FATAL'
+            "%s%s%-5s%s %s\n" % [@prefix, Utils.bold + Utils.red, severity, Utils.reset, msg]
+          when 'DEBUG'
+            "%s%-5s%s %s\n" % [@prefix, severity, progname ? " (#{progname})" : '', msg]
+          else
+            raise ArgumentError, 'Unsupported logger severity level'
+          end
+        end
+        self.level = ::Logger::INFO
+      end
+
+    end
+
+  end
+
+end

data/lib/webgen/cli/show_command.rb

@@ -0,0 +1,30 @@
+# -*- 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'
+
+module Webgen
+  module CLI
+
+    # The CLI command for showing various information about webgen itself or a webgen website.
+    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)
+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.
+DESC
+        add_command(ShowConfigCommand.new)
+        add_command(ShowExtensionsCommand.new)
+        add_command(ShowDependenciesCommand.new)
+      end
+
+    end
+
+  end
+end