bee 0.4.0 → 0.5.0

data/lib/bee_console.rb

@@ -1,4 +1,4 @@
-# Copyright 2006-2007 Michel Casabianca <michel.casabianca@gmail.com>
+# Copyright 2006-2008 Michel Casabianca <michel.casabianca@gmail.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,6 +16,7 @@ require 'bee'
 require 'bee_task'
 require 'bee_util'
 require 'getoptlong'
+require 'yaml'
 
 # Module for Bee stuff.
 module Bee
@@ -24,17 +25,22 @@ module Bee
 
     # Command line help.
     HELP = 'Usage: bee [options] [targets]
--h        Print help about usage and exit.
--b        Print help about build and exit.
--k task   Print help about tasks in a package (writing "foo.?") or a 
-          given one (writing "foo.bar") and exit.
--t        Write template build file on disk (use -f to write build file
-          in another one than default "build.yml").
--v        Enable verbose mode.
--s style  Define style for output (see documentation).
--f file   Build file to run (defaults to "build.yml").
--r        Look for build file recursively up in file system.
-targets   Targets to run (default target if omitted).'
+-V             Print version and exit.
+-h             Print help about usage and exit.
+-b             Print help about build and exit.
+-n             Don\'t actually run any commands; just print them.
+-k task        Print help about tasks in a package (writing "foo.?") or a 
+               given one (writing "foo.bar") and exit.
+-e egg         Print help about templates in a given package (writing 
+               "foo.?") or a given one (writing "foo.bar") and exit.
+-p name=value  Set a named property with a given value.
+-t egg         Run a given egg to generate a template project.
+-v             Enable verbose mode.
+-s style       Define style for output (see documentation).
+-f file        Build file to run (defaults to "build.yml").
+-r             Look for build file recursively up in file system.
+-l             Print bee logo on console.
+targets        Targets to run (default target if omitted).'
     # Name for default build file.
     DEFAULT_BUILD_FILE = 'build.yml'
     # Exit value on error parsing command line
@@ -45,36 +51,55 @@ targets   Targets to run (default target if omitted).'
     EXIT_UNKNOWN_ERROR = 3
     # Bee options environment variable.
     BEE_OPT_ENV = 'BEEOPT'
-    # README file where copyright is extracted.
-    README_FILE = 'README'
+    # Bee text logo (generated with http://www.network-science.de/ascii/)
+    BEE_LOGO = <<'EOF'
+         _                                                                 
+        | |__   ___  ___                                                   
+ _____  | '_ \ / _ \/ _ \  _____ _____ _____ _____ _____ _____ _____ _____ 
+|_____| | |_) |  __/  __/ |_____|_____|_____|_____|_____|_____|_____|_____|
+        |_.__/ \___|\___|  0.5.0                   http://bee.rubyforge.org
+
+EOF
 
     # Parse command line and return parsed arguments.
     def self.parse_command_line
+      version = false
       help = false
       help_build = false
       help_task = false
+      help_template = false
+      properties = {}
       task = nil
-      template = false
+      dry_run = false
+      template = nil
       verbose = false
       style = nil
       file = DEFAULT_BUILD_FILE
       recursive = false
+      logo = false
       targets = []
       # read options in BEEOPT environment variable
       options = ENV[BEE_OPT_ENV]
       options.split(' ').reverse.each { |option| ARGV.unshift(option) } if
         options
       # parse command line arguments
-      opts = GetoptLong.new(['--help', '-h', GetoptLong::NO_ARGUMENT],
+      opts = GetoptLong.new(['--version', '-V', GetoptLong::NO_ARGUMENT],
+                            ['--help', '-h', GetoptLong::NO_ARGUMENT],
                             ['--help-build', '-b', GetoptLong::NO_ARGUMENT],
                             ['--help-task','-k', GetoptLong::REQUIRED_ARGUMENT],
-                            ['--template', '-t', GetoptLong::NO_ARGUMENT ],
+                            ['--help-template','-e', GetoptLong::REQUIRED_ARGUMENT],
+                            ['--dry-run', '-n', GetoptLong::NO_ARGUMENT],
+                            ['--property', '-p', GetoptLong::REQUIRED_ARGUMENT],
+                            ['--template', '-t', GetoptLong::REQUIRED_ARGUMENT],
                             ['--verbose', '-v', GetoptLong::NO_ARGUMENT],
                             ['--style', '-s', GetoptLong::REQUIRED_ARGUMENT],
                             ['--file', '-f', GetoptLong::REQUIRED_ARGUMENT],
-                            ['--recursive', '-r', GetoptLong::NO_ARGUMENT])
+                            ['--recursive', '-r', GetoptLong::NO_ARGUMENT],
+                            ['--logo', '-l', GetoptLong::NO_ARGUMENT])
       opts.each do |opt, arg|
         case opt
+        when '--version'
+          version = true
         when '--help'
           help = true
         when '--help-build'
@@ -82,8 +107,17 @@ targets   Targets to run (default target if omitted).'
         when '--help-task'
           help_task = true
           task = arg
+        when '--help-template'
+          help_template = true
+          template = arg
+        when '--dry-run'
+          dry_run = true
+          verbose = true
+        when '--property'
+          name, value = parse_property(arg)
+          properties[name] = value
         when '--template'
-          template = true
+          template = arg
         when '--verbose'
           verbose = true
         when '--style'
@@ -92,48 +126,69 @@ targets   Targets to run (default target if omitted).'
           file = arg
         when '--recursive'
           recursive = true
+        when '--logo'
+          logo = true
         end
       end
-      targets = ARGV
-      return [help, help_build, help_task, task, template, verbose, style,
-              file, recursive, targets]
+      targets = Array.new(ARGV)
+      return [version, help, help_build, help_task, help_template, task,
+              properties, dry_run, template, verbose, style, file, recursive,
+              logo, targets]
+    end
+
+    # Parse a command line property.
+    # - property: property definition as "name=value".
+    # Return: name and value of the property.
+    def self.parse_property(property)
+      begin
+        index = property.index('=')
+        raise "No = sign" if not index
+        name = property[0..index-1]
+        value = YAML::load(property[index+1..-1])
+        return name, value
+      rescue
+        raise "Error parsing property '#{property}': #{$!}"
+      end
     end
 
     # Start build from command line.
     def self.start_command_line
       STDOUT.sync = true
       begin
-        help, help_build, help_task, task, template, verbose, style, file,
-          recursive, targets = parse_command_line
+        version, help, help_build, help_task, help_template, task,
+          properties, dry_run, template, verbose, style, file, recursive,
+          logo, targets = parse_command_line
       rescue
         puts "ERROR: parsing command line (type 'bee -h' for help)"
         exit(EXIT_PARSING_CMDLINE)
       end
       formatter = Formatter.new(style)
       begin
-        if help
-          readme = File.join(File.dirname(__FILE__), '..', README_FILE)
-          if File.exists?(readme) and File.file?(readme) and
-            File.readable?(readme)
-            copyright = File.read(readme).strip!.split("\n")[-1]
-            puts copyright
-          end
+        if logo
+          puts BEE_LOGO
+        end
+        if version
+          copyright = Bee::Util::copyright
+          puts copyright if copyright
+        elsif help
           puts HELP
         elsif help_build
-          build = Build.load(file, recursive)
+          build = Build.load(file, recursive, properties)
+          build.evaluate_properties
           puts formatter.help_build(build)
         elsif help_task
           puts formatter.help_task(task)
+        elsif help_template
+          puts formatter.help_template(template)
         elsif template
-          puts "Writing build template in file '#{file}'..."
-          raise Bee::Util::BuildError.new("Build file '#{file}' already exists") if 
-            File.exists?(file)
-          File.open(file, 'w') { |file| file.write(BUILD_TEMPLATE) }
-          puts formatter.format_success("OK")
+          file = Bee::Util::find_template(template)
+          listener = Listener.new(formatter, verbose)
+          build = Build.load(file, false, properties)
+          build.run(targets, listener, dry_run)
         else
           listener = Listener.new(formatter, verbose)
-          build = Build.load(file, recursive)
-          build.run(targets, listener)
+          build = Build.load(file, recursive, properties)
+          build.run(targets, listener, dry_run)
         end
       rescue Bee::Util::BuildError => e
         puts "#{formatter.format_error('ERROR')}: #{$!}"
@@ -192,8 +247,6 @@ targets   Targets to run (default target if omitted).'
       DEFAULT_STYLE = {
         :line_character => '-'
       }
-      # Default line length.
-      DEFAULT_LINE_LENGTH = 80
       # Short style keys for command line
       SHORT_STYLE_KEYS = {
         'lc' => 'line_character',
@@ -279,7 +332,10 @@ targets   Targets to run (default target if omitted).'
         help = ''
         # print build name and description
         if build.name
-          help << "- Build: #{build.name.inspect}\n"
+          help << "- Build: #{build.name}\n"
+        end
+        if build.extends
+          help << "  Extends: #{build.extends}\n"
         end
         if build.description
           help << format_description('Description', build.description, 2, false)
@@ -293,28 +349,63 @@ targets   Targets to run (default target if omitted).'
           end
         end
         # print build targets
-        if build.targets.length > 0
+        description = build.targets.description
+        if description.length > 0
           help << "- Targets:\n"
-          for target in build.targets.values.sort { |a, b| a.name <=> b.name }
-            help << format_description(target.name, target.description, 2)
+          for name in description.keys.sort
+            help << format_description(name, description[name], 2)
           end
         end
         # print default target
-        help << "- Default: #{build.default}"
+        help << "- Default: #{build.default}\n"
         return help.strip
       end
 
       # Return help about task(s).
       # - task: task to print help about (all tasks if nil).
       def help_task(task)
-        task = '*' if task == nil or task.length == 0
+        task = '?' if task == nil or task.length == 0
         package_manager = Bee::Task::PackageManager.new(nil)
         methods = package_manager.help_task(task)
         help = ''
-        for method in methods.keys
+        for method in methods.keys.sort
+          text = methods[method].strip
           help << format_title(method)
           help << "\n"
-          help << methods[method].strip
+          help << text
+          help << "\n"
+          if text =~ /Alias for \w+/
+            alias_method = text.scan(/Alias for (\w+)/).flatten[0]
+            help << "\n"
+            help << package_manager.help_task(alias_method)[alias_method].strip
+            help << "\n"
+          end
+        end
+        return help
+      end
+
+      # Return help about template(s).
+      # - template: template to print help about (all templates if nil).
+      def help_template(template)
+        templates = Bee::Util::search_templates(template)
+        help = ''
+        for name in templates.keys
+          build = YAML::load(File.read(templates[name]))
+          properties = nil
+          for entry in build
+            properties = entry['properties'] if entry['properties']
+          end
+          description = 'No description found'
+          if properties
+            for property in properties
+              if property.keys == ['description']
+                description = property['description']
+              end
+            end
+          end
+          help << format_title(name)
+          help << "\n"
+          help << description
           help << "\n"
         end
         return help
@@ -400,15 +491,15 @@ targets   Targets to run (default target if omitted).'
         end
         return string
       end
-      
+
       # Format a title.
       # - title: title to format.
       def format_title(title)
-        length = @style[:line_length] || 
-          Bee::Util::term_width || 
-          DEFAULT_LINE_LENGTH
+        length = @style[:line_length] || Bee::Util::term_width
         right = ' ' + @style[:line_character]*2
-        left = @style[:line_character]*(length - (title.length + 4)) + ' '
+        size = length - (title.length + 4)
+        size = 2 if size <= 0
+        left = @style[:line_character]*size + ' '
         line = left + title + right
         # apply style
         formatted = style(line, 
@@ -451,24 +542,15 @@ targets   Targets to run (default target if omitted).'
 
       # Called when build is started.
       # - build: the build object.
-      def build_started(build)
+      def build_started(build, dry_run)
         @start_time = Time.now
         @end_time = nil
         @duration = nil
         @success = nil
         @last_target = nil
         @last_task = nil
-        puts "Starting build '#{build.file}'..." if @verbose
-      end
-
-      # Called when build is finished.
-      # - build: the build object.
-      def build_finished(build)
-        @end_time = Time.now
-        @duration = @end_time - @start_time
-        @success = true
-        puts "Built in #{@duration} s" if @verbose
-        puts @formatter.format_success('OK')
+        build_type = dry_run ? "dry run of" : "build"
+        puts "Starting #{build_type} '#{build.file}'..." if @verbose
       end
 
       # Called when a target is met.
@@ -486,22 +568,28 @@ targets   Targets to run (default target if omitted).'
         puts @formatter.format_task(task) if @verbose
       end
 
+      # Called when build is finished.
+      # - build: the build object.
+      def build_finished(build, dry_run)
+        duration unless dry_run
+        @success = true
+        puts @formatter.format_success('OK')
+      end
+
       # Called when an error was raised.
       # - exception: raised exception.
       def error(exception)
-        @end_time = Time.now
-        @duration = @end_time - @start_time
+        duration
         @success = false
-        puts "Built in #{@duration} s" if @verbose
         message = ''
         message << "In target '#{@last_target.name}'" if @last_target
         message << ", in task:\n#{@formatter.format_task(@last_task)}\n" if
           @last_task
         message << ': ' if @last_target and not @last_task
         message << exception.to_s
-        puts "#{@formatter.format_error('ERROR')}: #{message}"
+        raise Bee::Util::BuildError.new(message)
       end
-      
+
       # Print text on the console.
       # - text: text to print.
       def print(text)
@@ -514,30 +602,22 @@ targets   Targets to run (default target if omitted).'
         Kernel.puts(text)
       end
 
-    end
+      # Get input string.
+      # Return string entered by the user.
+      def gets
+        return STDIN.gets
+      end
+
+      private
 
-    # Build template.
-    BUILD_TEMPLATE = 
-      '# Template build file
-- build: template
-  description: Template build file.
-  default: hello
-
-# Build properties
-- properties:
-  - user: "#{ENV[\'USER\']}"
-
-# Build targets
-- target: capitalize
-  description: Capitalize user name
-  script:
-  - rb: "who = user.capitalize"
-
-- target: hello
-  depends: capitalize
-  description: Print greatings.
-  script:
-  - print: "Hello #{who}!"'
+      # Compute build duration and print it if verbose.
+      def duration
+        @end_time = Time.now
+        @duration = @end_time - @start_time
+        puts "Built in #{@duration} s" if @verbose        
+      end
+      
+    end
 
   end
 

data/lib/bee_task.rb

@@ -1,4 +1,4 @@
-# Copyright 2006-2007 Michel Casabianca <michel.casabianca@gmail.com>
+# Copyright 2006-2008 Michel Casabianca <michel.casabianca@gmail.com>
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,8 +20,10 @@ module Bee
   # Module for bee tasks.
   module Task
 
-    # Base class for task package. Provides methods to access build context
-    # (to set and get properties and evaluate an object in this context).
+    # Base class for task package. Provides methods to print output using
+    # the build formatter and a method to check task parameters. Furthermore,
+    # this base class extends MethodInfoBase which provides methods
+    # comments, for autodocumentation purpose.
     class Package < Bee::Util::MethodInfoBase
       
       include Bee::Util::BuildErrorMixin
@@ -34,22 +36,116 @@ module Bee
 
       protected
 
-      # Check a task parameters. Raise a RuntimeError with explanation message
+      # Check task parameters. Raise a RuntimeError with explanation message
       # if a mandatory parameter is missing or an unknown parameter was found.
       # - params: task parameters as a Hash.
-      # - description: parameters description as a Hash associating a parameter
-      #   name with symbol :mandatory or :optional.
-      def check_task_parameters(params, description)
-        error "Parameters must be a Hash" unless params.kind_of?(Hash)
+      # - description: parameters description as a Hash with following keys:
+      #   :mandatory telling if the parameter is mandatory (true or false),
+      #   :type which is the class name of the parameter and
+      #   :default for default value.
+      def check_parameters(params, description)
+        task = caller[0].match(/`(.*)'/)[1]
+        error "'#{task}' parameters must be a hash" unless params.kind_of?(Hash)
         for param in description.keys
-          error "Missing mandatory parameter '#{param}'" unless
-          params[param] or description[param] == :optional
+          error "#{task} '#{param}' parameter is mandatory" unless
+            params[param.to_s] or description[param][:mandatory] == false
+          if params[param.to_s]
+            case description[param][:type]
+            when :string
+              error "#{task} '#{param}' parameter must be a string" unless
+                params[param.to_s].kind_of?(String)
+            when :integer
+              error "#{task} '#{param}' parameter must be an integer" unless
+                params[param.to_s].kind_of?(Integer)
+            when :float
+              error "#{task} '#{param}' parameter must be a float" unless
+                params[param.to_s].kind_of?(Float)
+            when :number
+              error "#{task} '#{param}' parameter must be a number" unless
+                params[param.to_s].kind_of?(Numeric)
+            when :boolean
+              error "#{task} '#{param}' parameter must be a boolean" unless
+                params[param.to_s] == true or params[param] == false
+            when :array
+              error "#{task} '#{param}' parameter must be an array" unless
+                params[param.to_s].kind_of?(Array)
+            when :string_or_array
+              error "#{task} '#{param}' parameter must be a string or an array" unless
+                params[param.to_s].kind_of?(String) or params[param.to_s].kind_of?(Array)
+            when :string_or_integer
+              error "#{task} '#{param}' parameter must be a string or an integer" unless
+                params[param.to_s].kind_of?(String) or params[param.to_s].kind_of?(Integer)
+            when :hash
+              error "#{task} '#{param}' parameter must be a hash" unless
+                params[param.to_s].kind_of?(Hash)
+            else
+              error "Unknown parameter type '#{description[param][:type]}'"
+            end
+            params[param.to_sym] = params[param.to_s]
+          else
+            params[param.to_sym] = description[param][:default] if
+              description[param][:default]
+            params[param.to_s] = description[param][:default] if
+              description[param][:default]
+          end
         end
         for param in params.keys
-          error "Unknown parameter '#{param}'" if not description.key?(param)
+          error "Unknown parameter '#{param}'" if 
+            not (description.key?(param) or description.key?(param.to_sym))
         end
       end
       
+      # Utility method to find and filter files.
+      # - root: root directory for files to search.
+      # - includes: list of globs for files to include in search.
+      # - excludes: list of globs for files to exclude from search.
+      # - dotmatch: tells if joker matches dot files.
+      # Return: the list of found files (no directories included).
+      def filter_files(includes, excludes, root, dotmatch=true)
+        error "includes must be a glob or a list of globs" unless
+          !includes or includes.kind_of?(String) or includes.kind_of?(Array)
+        error "excludes must be a glob or a list of globs" unless
+          !excludes or excludes.kind_of?(String) or excludes.kind_of?(Array)
+        error "root must be an existing directory" unless
+          !root or File.exists?(root)
+        current_dir = Dir.pwd
+        begin
+          if dotmatch
+            options = File::FNM_PATHNAME | File::FNM_DOTMATCH
+          else
+            options = File::FNM_PATHNAME
+          end
+          Dir.chdir(root) if root
+          included = []
+          includes = '**/*' if not includes
+          for include in includes
+            error "includes must be a glob or a list of globs" unless
+              include.kind_of?(String)
+            # should expand directories ?
+            # include = "#{include}/**/*" if File.directory?(include)
+            entries = Dir.glob(include, options)
+            included += entries if entries
+          end
+          included.uniq!
+          if excludes
+            included.reject! do |file|
+              rejected = false
+              for exclude in excludes
+                if File.fnmatch?(exclude, file, options)
+                  rejected = true
+                  break
+                end
+              end
+              rejected
+            end
+          end
+          included.reject! { |file| File.directory?(file) }
+          return included
+        ensure
+          Dir.chdir(current_dir)
+        end
+      end
+
       # Print text on the console.
       # - text: text to print.
       def print(text)
@@ -69,6 +165,16 @@ module Bee
           Kernel.puts(text)
         end
       end
+
+      # Prompts the user for a string.
+      # Return the user input string.
+      def gets
+        if @build.listener
+          return @build.listener.gets
+        else
+          return Kernel::STDIN.gets
+        end        
+      end
       
     end
     
@@ -126,14 +232,10 @@ module Bee
       # named after the package capitalized, in module Bee::Task.
       # - package: the package name.
       def load_package(package)
-        if package
-          package.downcase!
-          script = "bee_task_#{package.downcase}"
-          clazz = package.capitalize
-        else
-          script = 'bee_task'
-          clazz = 'Default'
-        end
+        package = 'default' if not package
+        package.downcase!
+        script = "bee_task_#{package}"
+        clazz = package.capitalize
         begin
           require script
           @packages[package] = Bee::Task.const_get(clazz).new(@build)