bee 0.3.1 → 0.4.0

data/lib/bee_console.rb

@@ -1,4 +1,4 @@
-# Copyright 2006 Michel Casabianca <casa@sweetohm.net>
+# Copyright 2006-2007 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.
@@ -12,23 +12,28 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'bee'
+require 'bee_task'
+require 'bee_util'
+require 'getoptlong'
+
 # Module for Bee stuff.
 module Bee
 
   module Console
 
-    require 'bee'
-    require 'getoptlong'
-
     # 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 all tasks or given one.
--t        Write template build file on disk.
+-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).'
     # Name for default build file.
     DEFAULT_BUILD_FILE = 'build.yml'
@@ -38,6 +43,10 @@ targets   Targets to run (default target if omitted).'
     EXIT_BUILD_ERROR = 2
     # Exit value on unknown error
     EXIT_UNKNOWN_ERROR = 3
+    # Bee options environment variable.
+    BEE_OPT_ENV = 'BEEOPT'
+    # README file where copyright is extracted.
+    README_FILE = 'README'
 
     # Parse command line and return parsed arguments.
     def self.parse_command_line
@@ -49,19 +58,21 @@ targets   Targets to run (default target if omitted).'
       verbose = false
       style = nil
       file = DEFAULT_BUILD_FILE
+      recursive = false
       targets = []
       # read options in BEEOPT environment variable
-      options = ENV['BEEOPT']
+      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],
                             ['--help-build', '-b', GetoptLong::NO_ARGUMENT],
-                            ['--help-task','-k', GetoptLong::OPTIONAL_ARGUMENT],
+                            ['--help-task','-k', GetoptLong::REQUIRED_ARGUMENT],
                             ['--template', '-t', GetoptLong::NO_ARGUMENT ],
                             ['--verbose', '-v', GetoptLong::NO_ARGUMENT],
                             ['--style', '-s', GetoptLong::REQUIRED_ARGUMENT],
-                            ['--file', '-f', GetoptLong::REQUIRED_ARGUMENT])
+                            ['--file', '-f', GetoptLong::REQUIRED_ARGUMENT],
+                            ['--recursive', '-r', GetoptLong::NO_ARGUMENT])
       opts.each do |opt, arg|
         case opt
         when '--help'
@@ -79,11 +90,13 @@ targets   Targets to run (default target if omitted).'
           style = arg
         when '--file'
           file = arg
+        when '--recursive'
+          recursive = true
         end
       end
       targets = ARGV
       return [help, help_build, help_task, task, template, verbose, style,
-              file, targets]
+              file, recursive, targets]
     end
 
     # Start build from command line.
@@ -91,7 +104,7 @@ targets   Targets to run (default target if omitted).'
       STDOUT.sync = true
       begin
         help, help_build, help_task, task, template, verbose, style, file,
-        targets = parse_command_line
+          recursive, targets = parse_command_line
       rescue
         puts "ERROR: parsing command line (type 'bee -h' for help)"
         exit(EXIT_PARSING_CMDLINE)
@@ -99,34 +112,33 @@ targets   Targets to run (default target if omitted).'
       formatter = Formatter.new(style)
       begin
         if help
-          readme = File.join(File.dirname(__FILE__), '..', 'README')
-          if File.exists?(readme)
+          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
           puts HELP
         elsif help_build
-          build = Build.new(file)
+          build = Build.load(file, recursive)
           puts formatter.help_build(build)
         elsif help_task
-          build = Build.new(file)
-          puts formatter.help_task(build, task)
+          puts formatter.help_task(task)
         elsif template
           puts "Writing build template in file '#{file}'..."
-          raise BuildError.new("Build file '#{file}' already exists") if 
+          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")
         else
-          listener = ConsoleListener.new(formatter, verbose)
-          build = Build.new(file)
+          listener = Listener.new(formatter, verbose)
+          build = Build.load(file, recursive)
           build.run(targets, listener)
         end
-      rescue BuildError
+      rescue Bee::Util::BuildError => e
         puts "#{formatter.format_error('ERROR')}: #{$!}"
+        puts e.backtrace.join("\n") if verbose
         exit(EXIT_BUILD_ERROR)
-      rescue SystemExit
-        # do nothing, exit in code
       rescue Exception => e
         puts "#{formatter.format_error('ERROR')}: #{$!}"
         puts e.backtrace.join("\n")
@@ -134,16 +146,10 @@ targets   Targets to run (default target if omitted).'
       end
     end
 
-    #########################################################################
-    #                            FORMATTER CLASS                            #
-    #########################################################################
-
     # Class to format build output on console.
     class Formatter
 
-      include BuildErrorMixin
-
-      ###################### ANSI COLORS AND STYLES #########################
+      include Bee::Util::BuildErrorMixin
 
       # List of colors.
       COLORS = [:black, :red, :green, :yellow, :blue, :magenta, :cyan, :white]
@@ -182,8 +188,6 @@ targets   Targets to run (default target if omitted).'
         :hidden     => 8
       }
 
-      ############################ DEFAULT STYLE ############################
-
       # Default style (supposed to work on any configuration).
       DEFAULT_STYLE = {
         :line_character => '-'
@@ -205,11 +209,9 @@ targets   Targets to run (default target if omitted).'
         'sb' => 'success_background',
         'es' => 'error_style',
         'ef' => 'error_foreground',
-        'eb' => 'error_background'      
+        'eb' => 'error_background'
       }
 
-      ############################## METHODS ################################
-
       # Constructor.
       # - style: style as a Hash or a String.
       def initialize(style)
@@ -227,17 +229,7 @@ targets   Targets to run (default target if omitted).'
       # - target: target to format.
       def format_target(target)
         name = target.name
-        # generate title line
-        length = @style[:line_length] || line_length || DEFAULT_LINE_LENGTH
-        right = ' ' + @style[:line_character]*2
-        left = @style[:line_character]*(length - (name.length + 4)) + ' '
-        line = left + name + right
-        # apply style
-        formatted = style(line, 
-                          @style[:target_style], 
-                          @style[:target_foreground],
-                          @style[:target_background])
-        return formatted
+        return format_title(name)
       end
 
       # Format a task.
@@ -247,7 +239,7 @@ targets   Targets to run (default target if omitted).'
           source = task
         elsif task.kind_of?(Hash)
           if task.key?('rb')
-            source = task['rb']
+            source = "rb: #{task['rb']}"
           else
             source = YAML::dump(task)
             source = source.sub(/---/, '')
@@ -285,43 +277,45 @@ targets   Targets to run (default target if omitted).'
       # - build: running build.
       def help_build(build)
         help = ''
+        # print build name and description
         if build.name
           help << "- Build: #{build.name.inspect}\n"
         end
         if build.description
           help << format_description('Description', build.description, 2, false)
         end
-        if build.properties.keys.length > 0
+        # print build properties
+        if build.context.properties.length > 0
           help << "- Properties:\n"
-          for property in build.properties.keys.sort
-            help << "  - #{property}: #{build.properties[property].inspect}\n"
+          for property in build.context.properties.sort
+            help << "  - #{property}: " +
+              "#{build.context.get_property(property, true).inspect}\n"
           end
         end
+        # print build targets
         if build.targets.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)
           end
         end
+        # print default target
         help << "- Default: #{build.default}"
         return help.strip
       end
 
       # Return help about task(s).
-      # - build: running build.
       # - task: task to print help about (all tasks if nil).
-      def help_task(build, task)
-        task = nil if task.length == 0
+      def help_task(task)
+        task = '*' if task == nil or task.length == 0
+        package_manager = Bee::Task::PackageManager.new(nil)
+        methods = package_manager.help_task(task)
         help = ''
-        if task
-          error "Task '#{task}' not loaded" if not build.tasks[task]
-          help << build.tasks[task]
-        else
-          help << "Loaded tasks: "
-          for task in build.tasks.keys.sort
-            help << "#{task}, "
-          end
-          help = help[0..-3]
+        for method in methods.keys
+          help << format_title(method)
+          help << "\n"
+          help << methods[method].strip
+          help << "\n"
         end
         return help
       end
@@ -353,20 +347,6 @@ targets   Targets to run (default target if omitted).'
         return colorized
       end
 
-      # Get line length calling IOCTL. Return nil if call failed.
-      def line_length
-        begin
-          tiocgwinsz = 0x5413
-          string = [0, 0, 0, 0].pack('SSSS')
-          if $stdin.ioctl(tiocgwinsz, string) >= 0 then
-            rows, cols, xpixels, ypixels = string.unpack('SSSS')
-            return cols
-          end
-        rescue
-          return nil
-        end
-      end
-
       # Parse style from command line. If error occurs parsing style, return
       # nil (which means default style).
       # - string: style to parse.
@@ -405,7 +385,7 @@ targets   Targets to run (default target if omitted).'
         string = ' '*indent
         string << '- ' if bullet
         string << title
-        if text
+        if text and !text.empty?
           string << ": "
           if text.split("\n").length > 1
             string << "\n"
@@ -415,19 +395,34 @@ targets   Targets to run (default target if omitted).'
           else
             string << text.strip + "\n"
           end
+        else
+          string << "\n"
         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
+        right = ' ' + @style[:line_character]*2
+        left = @style[:line_character]*(length - (title.length + 4)) + ' '
+        line = left + title + right
+        # apply style
+        formatted = style(line, 
+                          @style[:target_style], 
+                          @style[:target_foreground],
+                          @style[:target_background])
+        return formatted
+      end
 
     end
 
-    #########################################################################
-    #                           CONSOLE LISTENER                            #
-    #########################################################################
-
     # Listener when running in a console. Prints messages on the console using
     # a given formatter.
-    class ConsoleListener
+    class Listener
 
       # Formatter used by listener.
       attr_reader :formatter
@@ -506,13 +501,22 @@ targets   Targets to run (default target if omitted).'
         message << exception.to_s
         puts "#{@formatter.format_error('ERROR')}: #{message}"
       end
+      
+      # Print text on the console.
+      # - text: text to print.
+      def print(text)
+        Kernel.print(text)
+      end
+      
+      # Puts text on the console.
+      # - text: text to puts.
+      def puts(text)
+        Kernel.puts(text)
+      end
 
     end
 
-    #########################################################################
-    #                            BUILD TEMPLATE                             #
-    #########################################################################
-
+    # Build template.
     BUILD_TEMPLATE = 
       '# Template build file
 - build: template
@@ -533,8 +537,7 @@ targets   Targets to run (default target if omitted).'
   depends: capitalize
   description: Print greatings.
   script:
-  - "echo \"Hello #{who}!\""
-'
+  - print: "Hello #{who}!"'
 
   end
 

data/lib/bee_task.rb

@@ -0,0 +1,149 @@
+# Copyright 2006-2007 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.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'bee'
+require 'bee_util'
+
+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).
+    class Package < Bee::Util::MethodInfoBase
+      
+      include Bee::Util::BuildErrorMixin
+      
+      # Constructor.
+      # - build: the build we are running.
+      def initialize(build)
+        @build = build
+      end
+
+      protected
+
+      # Check a 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)
+        for param in description.keys
+          error "Missing mandatory parameter '#{param}'" unless
+          params[param] or description[param] == :optional
+        end
+        for param in params.keys
+          error "Unknown parameter '#{param}'" if not description.key?(param)
+        end
+      end
+      
+      # Print text on the console.
+      # - text: text to print.
+      def print(text)
+        if @build.listener
+          @build.listener.print(text)
+        else
+          Kernel.print(text)
+        end
+      end
+      
+      # Puts text on the console.
+      # - text: text to puts.
+      def puts(text)
+        if @build.listener
+          @build.listener.puts(text)
+        else
+          Kernel.puts(text)
+        end
+      end
+      
+    end
+    
+    # Package manager is responsible for loading packages and calling tasks.
+    class PackageManager
+      
+      include Bee::Util::BuildErrorMixin
+      
+      # Constructor.
+      # - build: the build we are running.
+      def initialize(build)
+        @build = build
+        @packages = {}
+      end
+      
+      # Run a given task.
+      # - task: YAML object for the task to run.
+      def run_task(task)
+        packaged = task.keys[0]
+        package, name = Bee::Util::get_package_name(packaged)
+        parameters = @build.context.evaluate_object(task[packaged])
+        if not @packages[package]
+          load_package(package)
+        end
+        error "Task '#{name}' not found in package '#{package}'" if
+          not @packages[package].respond_to?(name)
+        @packages[package].send(name, parameters)
+      end
+      
+      # Get help for a given task.
+      # - task: YAML object for the task to run.
+      def help_task(task)
+        package, name = Bee::Util::get_package_name(task)
+        if not @packages[package]
+          load_package(package)
+        end
+        help = {}
+        if name == '?'
+          methods = @packages[package].class.public_instance_methods(false)
+          for method in methods
+            help[method] = @packages[package].class.method_info(method).comment
+          end
+          return help
+        else
+          error "Task '#{name}' not found in package '#{package}'" if
+            not @packages[package].respond_to?(name)
+          help[task] = @packages[package].class.method_info(name).comment
+        end
+        return help
+      end
+      
+      private
+
+      # Load a given package using introspection: we try to instantiate class
+      # 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
+        begin
+          require script
+          @packages[package] = Bee::Task.const_get(clazz).new(@build)
+        rescue Exception
+          error "Task package '#{package}' not found"
+        end
+      end
+      
+    end
+
+  end
+  
+end