bee 0.2.0 → 0.3.0

data/README

@@ -25,4 +25,4 @@ or go to URL http://www.apache.org/licenses/LICENSE-2.0).
 
 = Copyright
 
-bee version 0.2.0 (C) Michel Casabianca - 2006
+bee version 0.3.0 (C) Michel Casabianca - 2006

data/lib/bee.rb

@@ -95,7 +95,7 @@ module Bee
               for script in entry['context']
                 begin
                   based_script = File.join(@base, script)
-                  evaluated_script = @context.evaluate_string(based_script)
+                  evaluated_script = @context.evaluate_object(based_script)
                   source = File.read(evaluated_script)
                   load_context(source)
                 rescue
@@ -108,7 +108,7 @@ module Bee
             for property in entry['properties']
               begin
                 name = property.keys[0]
-                value = @context.evaluate_string(property[name])
+                value = @context.evaluate_object(property[name])
                 error "Duplicate property '#{name}' definition" if 
                   @properties[name]
                 @properties[name] = value
@@ -174,7 +174,7 @@ module Bee
     # extension tasks mapping.
     # - source: the context source.
     def load_context(source)
-      new_tasks = @context.evaluate(source)
+      new_tasks = @context.evaluate_script(source)
       if new_tasks.kind_of?(Hash)
         for task in new_tasks.keys
           error "Duplicate definition for task '#{task}'" if @tasks[task]
@@ -218,22 +218,26 @@ module Bee
 
     # Run target.
     def run
-      if not @evaluated
-        @evaluated = true
-        for depend in @depends
-          @build.run_target(depend)
-        end
-        @build.listener.target(self) if @build.listener
-        if @script
-          case @script
-          when String
-            run_task(@script)
-          when Array
-            for task in @script
-              run_task(task)
+      begin
+        if not @evaluated
+          @evaluated = true
+          for depend in @depends
+            @build.run_target(depend)
+          end
+          @build.listener.target(self) if @build.listener
+          if @script
+            case @script
+            when String
+              run_task(@script)
+            when Array
+              for task in @script
+                run_task(task)
+              end
             end
           end
         end
+      ensure
+        Dir.chdir(@build.base)
       end
     end
 
@@ -265,7 +269,7 @@ module Bee
     # - script: the scrip to run.
     def run_shell(script)
       @listener.task(script) if @listener
-      evaluated_script = @build.context.evaluate_string(script)
+      evaluated_script = @build.context.evaluate_object(script)
       system(evaluated_script)
       error "Script exited with value #{$?}" if $? != 0
     end
@@ -275,7 +279,7 @@ module Bee
     def run_ruby(script)
       @listener.task(script) if @listener
       begin
-        @build.context.evaluate(script)
+        @build.context.evaluate_script(script)
       rescue BuildError
         error "Error running Ruby script: #{$!}"
       end
@@ -291,7 +295,7 @@ module Bee
       parameters = task[name]
       script = "#{name}(#{parameters.inspect})"
       begin
-        @build.context.evaluate(script)
+        @build.context.evaluate_script(script)
       rescue BuildError
         error "Error running task #{name}: #{$!}"
       end
@@ -339,24 +343,54 @@ module Bee
 
     # Evaluate a script in context.
     # - script: script to evaluate.
-    def evaluate(script)
+    def evaluate_script(script)
       eval(script, @context_binding)
     end
 
-    # Process a given string, replacing properties references with their
-    # value. Property references have same form than variable references
-    # in ruby strings: '#{variable}' will be replaced with variable value.
-    # - string: string to process.
-    def evaluate_string(string)
-      return nil if string == nil
-      return string if not string.kind_of?(String)
-      string = string.gsub(/#\{.+?\}/) do |match|
-        property = match[2..-2]
+    # Process a given object, replacing properties references with their
+    # string value, symbol with their raw value. Property references have
+    # same form than variable references in ruby strings: '#{variable}'
+    # will be replaced with variable string value.
+    # - object: object to process.
+    def evaluate_object(object)
+      case object
+      when NilClass
+        # nil: return nil
+        return nil
+      when String
+        # string: replace property references
+        object = object.gsub(/#\{.+?\}/) do |match|
+          property = match[2..-2]
+          value = get(property)
+          error ("Property '#{property}' was not defined") unless value
+          value
+        end
+        return object 
+      when Symbol
+        # symbol: return property object
+        property = object.to_s
         value = get(property)
         error ("Property '#{property}' was not defined") unless value
-        value
+        return value
+      else
+        return object
+      end
+    end
+
+    # 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
-      return string
     end
 
     private

data/lib/bee_console.rb

@@ -317,9 +317,11 @@ targets   Targets to run (default target if omitted).'
           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 << format_description(task, build.tasks[task], 0, true)
+            help << "#{task}, "
           end
+          help = help[0..-3]
         end
         return help
       end

data/lib/bee_default_context.rb

@@ -19,67 +19,174 @@
 
 ############################ UTILITY FUNCTIONS ############################
 
-# Convenient method to raise a BuildError.
+# Convenient method to raise a BuildError. This is necessary to interrupt
+# build with an error message but without a stack trace (which would
+# indicate an internal error).
 # - message: error message.
 def error(message)
   raise BuildError.new(message)
 end    
 
-# 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_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
-
-# Run a shell script and raise an exception if script returned a value
+# Run a shell script and raise a build error if script returned a value
 # different of 0.
 # - script: script to run.
 def sh(script)
   system(script) or error "Script '#{script}' exited with value '#{$?}'"
 end
 
-# Find files that match a given pattern.
-# - pattern: pattern to select files.
-# - base: base directory for search.
-# - dir: tells if we must include directories.
-# Return: a file list.
-def find(pattern=//, base='.', dir=true)
-  require 'find'
-  files = []
-  Find.find(base) do |path|
-    if path =~ pattern and (File.file?(path) or (File.directory?(path) and dir))
-      files << path
-    end
+############################ TASK DEFINITIONS #############################
+
+# Prints a message. This message may be a String (standard output) or any
+# Ruby object. In this latter case, print its inspected value.
+# - message: message to print.
+def print(message)
+  case message
+  when String
+    puts evaluate_object(message)
+  else
+    puts message.inspect
   end
-  return files
 end
 
-############################ TASK DEFINITIONS #############################
+# Print a file contents.
+# - file: file to print out.
+def cat(file)
+  file = evaluate_object(file)
+  error "Parameter must be a String" unless file.kind_of?(String)
+  error "File '#{file}' not found" unless 
+    File.exists?(file) or File.directory?(file)
+  puts File.read(file).strip
+end
 
-# Prints a message.
-def print(message)
-  error "Parameter must be a String" unless message.kind_of?(String)
-  puts evaluate_string(message)
+# Change working directory. This change will persist for all tasks run in
+# the target. Parameter is a string with directory to change to.
+def cd(dir)
+  dir = evaluate_object(dir)
+  error "cd parameter is a String" unless dir.kind_of?(String)
+  Dir.chdir(dir)
 end
 
-# Make a directory and parent directories if necessary.
+# Make a directory and parent directories if necessary. Doesn't complain if
+# directory already exists.
+# - dir: directory to create.
 def mkdir(dir)
+  dir = evaluate_object(dir)
   error "Parameter must be a String" unless dir.kind_of?(String)
   require "fileutils"
   FileUtils.makedirs(dir)
 end
 
-# Run an ERB file or source and store result in a file or property.
+# Copy a files or directoris to destination file or directory. Parameter is a
+# Hash with following entries:
+# - src: glob for source files or directories.
+# - dest: destination file or directory.
+def cp(params)
+  require 'fileutils'
+  params_desc = {
+    'src' => :mandatory,
+    'dest' => :mandatory
+  }
+  check_task_parameters(params, params_desc)
+  src = evaluate_object(params['src'])
+  dest = evaluate_object(params['dest'])
+  files = []
+  for element in src
+    files += Dir.glob(element)
+  end
+  for file in files
+    FileUtils.cp_r(file, dest)
+  end
+end
+
+# Move source file(s) or directories to dest file or directory. Parameter is
+# a Hahs with following keys:
+# - src: glob for files and directories to move.
+# - dest: file or directory to move file(s) to.
+def mv(params)
+  require 'fileutils'
+  params_desc = {
+    'src' => :mandatory,
+    'dest' => :mandatory
+  }
+  check_task_parameters(params, params_desc)
+  src = evaluate_object(params['src'])
+  dest = evaluate_object(params['dest'])
+  files = []
+  for element in src
+    files += Dir.glob(element)
+  end
+  for file in files
+    FileUtils.mv(file, dest)
+  end
+end
+
+# Delete files for a given glob. Parameter is a string for glob of files
+# to delete.
+def rm(glob)
+  require 'fileutils'
+  glob = evaluate_object(glob)
+  error "rm parameter is a String" unless glob.kind_of?(String)
+  files = Dir.glob(glob)
+  for file in files
+    FileUtils.rm_f(file)
+  end
+end
+
+# Delete directories recursively. Parameter is a string for glob of directories
+# to delete.
+def rmdir(glob)
+  require 'fileutils'
+  glob = evaluate_object(glob)
+  error "rm parameter is a String" unless glob.kind_of?(String)
+  dirs = Dir.glob(glob)
+  for dir in dirs
+    FileUtils.rm_rf(dir)
+  end
+end
+
+# Find files for a given glob and store list in a property. Parameter is
+# a Hash with entries:
+# - files: glob or list of globs for files to look for.
+# - toprop: name of the property to set.
+def find(parameters)
+  params_desc = {
+    'files' => :mandatory,
+    'toprop' => :mandatory
+  }
+  check_task_parameters(parameters, params_desc)
+  files = []
+  globs = parameters['files']
+  toprop = evaluate_object(parameters['toprop'])
+  for glob in globs
+    files += Dir.glob(evaluate_object(glob))
+  end
+  set(toprop, files)
+end
+
+# Run a set of tests selected using globs. Parameter is a glob or list of
+# globs for files or directories to run.
+# FIXME: if tasks runs twice, it will run twice loaded tests...
+def test(globs)
+  require 'test/unit'
+  require 'test/unit/testresult'
+  files = []
+  for glob in globs
+    error "Parameter must be a String or a list of Strings" unless
+      glob.kind_of?(String)
+    files += Dir.glob(evaluate_object(glob))
+  end
+  for file in files
+    load file
+  end
+  Test::Unit::AutoRunner.run
+end
+
+# Run an ERB file or source and store result in a file or property. Parameter
+# is a Hash with following keys:
+# - source: ERB source text (if no 'file').
+# - file: ERB file name (if no 'source').
+# - tofile: file where to store result (if no 'toprop').
+# - toprop: property name where to store result (if no 'tofile').
 def erb(params)
   require 'erb'
   # check parameters
@@ -89,11 +196,11 @@ def erb(params)
     'tofile' => :optional,
     'toprop' => :optional
   }
-  check_parameters(params, params_desc)
+  check_task_parameters(params, params_desc)
   source = params['source']
-  file = evaluate_string(params['file'])
-  tofile = evaluate_string(params['tofile'])
-  toprop = evaluate_string(params['toprop'])
+  file = evaluate_object(params['file'])
+  tofile = evaluate_object(params['tofile'])
+  toprop = evaluate_object(params['toprop'])
   error "Must pass one of 'source' or 'file' parameters to erb task" if
     not source and not file
   error "Must pass one of 'tofile' or 'toprop' parameters to erb task" if
@@ -114,18 +221,224 @@ def erb(params)
   end
 end
 
+# Generate RDoc documentation for a given list of globs and an output directory.
+# Parameter is a Hash with following keys:
+# - input: input files as a glob (or list of globs). File mays be directories.
+# - output: output directory for generated documentation.
+def rdoc(params)
+  require 'rdoc/rdoc'
+  params_desc = {
+    'input' => :mandatory,
+    'output' => :mandatory
+  }
+  check_task_parameters(params, params_desc)
+  files = []
+  input = params['input']
+  for glob in input
+    files += Dir.glob(evaluate_object(glob))
+  end
+  output = evaluate_object(params['output'])
+  command_line = ['-S', '-o', output] + files
+  rdoc = RDoc::RDoc.new
+  rdoc.document(command_line)
+end
+
+# Generate a Gem package. Parameter is the name of the Gem description file.
+# Resulting Gem package is generated in current directory (as with command
+# line tool).
+def gembuild(description)
+  require 'rubygems'
+  description = evaluate_object(description)
+  arguments = ['build', description]
+  Gem.manage_gems
+  Gem::GemRunner.new.run(arguments)
+end
+
+# Generate a ZIP archive. Parameter is a Hash with following entries:
+# - files: glob or list of globs for files to select for the archive.
+# - archive: the archive name.
+# - prefix: prefix for archive entries (default to nil).
+# Note: if archive exists, files are added to the archive.
+def zip(parameters)
+  require 'zip/zip'
+  # parse parameters
+  params_desc = {
+    'files' => :mandatory,
+    'archive' => :mandatory,
+    'prefix' => :optional
+  }
+  check_task_parameters(parameters, params_desc)
+  globs = evaluate_object(parameters['files'])
+  files = []
+  for glob in globs
+    files += Dir.glob(evaluate_object(glob))
+  end
+  archive = evaluate_object(parameters['archive'])
+  prefix = evaluate_object(parameters['prefix'])
+  # build the archive
+  zipfile = Zip::ZipFile.open(archive, Zip::ZipFile::CREATE) do |zip|
+    for file in files
+      entry = prefix ? File.join(prefix, file) : file
+      puts "Adding '#{entry}'"
+      zip.add(entry, file)
+    end
+    zip.close
+  end
+end
+
 ############################## TASKS MAPPING ##############################
 
 {
-  "print" =>
-  "Print a message passed as parameter.",
-  "mkdir" =>
-  "Create a directory and all parent directories if necessary. Do nothing if
-directory already exists. Parameter is a String for directory to create.",
-  "erb" =>
-  "Run an ERB:
-- source: ERB source to run (if no 'file').
-- file: ERB file to run (if no 'source').
-- tofile: file where to write ERB result (if no 'toprop').
-- toprop: bee property where to put result (if no 'tofile')."
+"print"    =>
+"Print a message on console. This message may be a String (standard output)
+or any Ruby object. In this latter case, print its inspected value. Parameter
+is the message to output as a String.
+
+- message: message to print.
+
+Example:
+
+ - print: \"Hello World!\"",
+
+"cat"      =>
+"Print contents of a given file on the console. Parameter is file to output
+as a String.
+
+- file: file to print out.
+
+Example:
+
+ - cat: \"doc/welcome-message.txt\"",
+
+"cd"       =>
+"Change working directory. This change will persist for all tasks in the
+target but not in other targets. Parameter is a String with directory to
+change to.
+
+Example:
+
+ - cd: \"build\"",
+
+"mkdir"    =>
+"Make a directory and parent directories if necessary. Doesn't complain if
+directory already exists. Parameter is directory to create as a String.
+
+Example:
+
+ - mkdir \"foo/bar\"",
+
+"cp"       =>
+"Copy files or directories to destination file or directory. Parameter is a
+Hash with following entries:
+
+- src: glob for source files or directories.
+- dest: destination file or directory.
+
+Example:
+
+ - cp:
+     src: \"doc/png/*.png\"
+     dest: :doc",
+
+"mv"       =>
+"Move source file(s) or directories to dest file or directory. Parameter is
+a Hahs with following entries:
+
+- src: glob for files and directories to move.
+- dest: file or directory to move file(s) to.
+
+Example:
+
+ - mv: { src: :gem_package, dest: :build }",
+
+"rm"       =>
+"Delete files for a given glob. Parameter is a String or list of Strings for
+glob(s) of files to delete.
+
+Example:
+
+ - rm: \"**/*~\"",
+
+"rmdir"    =>
+"Delete directories recursively. Parameter is a string for glob of directories
+to delete.
+
+Example:
+
+ - rmdir: :build",
+
+"find"     =>
+"Find files for a given glob and store list in a property. Parameter is
+a Hash with entries:
+
+- files: glob or list of globs for files to look for.
+- toprop: name of the property to set.
+
+Example:
+
+ - find: { files: \"**/*.rb\", toprop: \"rb_files_to_check\" }",
+
+"test"     =>
+"Run a set of tests selected using globs. Parameter is a glob or list of
+globs for files or directories to run.
+
+Example:
+
+ - test: \"**/tc_*.rb\"
+
+*FIXME*: if tasks runs twice, it will run twice loaded tests...",
+
+"erb"      =>
+"Run an ERB file or source in bee context and store result in a file or
+property. Parameter is a Hash with following entries:
+
+- source: ERB source text (if no 'file').
+- file: ERB file name (if no 'source').
+- tofile: file where to store result (if no 'toprop').
+- toprop: property name where to store result (if no 'tofile').
+
+Example:
+
+ - erb: { file: \"gem.spec.erb\", tofile: \"gem.spec\" }
+
+Notes: In these ERB files, you can access a property _foo_ writing:
+
+ <p>Hello <%= foo %>!</p>",
+
+"rdoc"     =>
+"Generate RDoc documentation for a given list of globs and an output directory.
+Parameter is a Hash with following entries:
+
+- input: input files as a glob (or list of globs). File mays be directories.
+- output: output directory for generated documentation.
+
+Example:
+
+ - rdoc:
+     input: [\"README\", \"LICENSE\", :src]
+     output: :api",
+
+"gembuild" =>
+"Generate a Gem package. Parameter is the name of the Gem description file.
+Resulting Gem package is generated in current directory (as with command
+line tool).
+
+Example:
+
+ - gembuild: :gem_spec",
+
+"zip"      =>
+"Generate a ZIP archive. Parameter is a Hash with following entries:
+
+- files: glob or list of globs for files to select for the archive.
+- archive: the archive name.
+- prefix: prefix for archive entries (default to nil).
+
+Example:
+
+ - zip:
+     files: :zip_files
+     archive: :zip_archive
+
+Note: if archive already exists, files are added to the archive."
 }

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: bee
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
-date: 2006-11-06 00:00:00 +01:00
+  version: 0.3.0
+date: 2006-11-08 00:00:00 +01:00
 summary: bee is a build tool
 require_paths: 
 - lib