bee 0.10.2 → 0.11.0

data/lib/bee_target.rb

@@ -1,4 +1,4 @@
-# Copyright 2006-2010 Michel Casabianca <michel.casabianca@gmail.com>
+# Copyright 2006-2011 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,7 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Module for Bee core classes.
+require 'rubygems'
+require 'bee_util'
+
 module Bee
   
   # Class for a target. It is built from the YAML build file and manages a
@@ -50,12 +52,9 @@ module Bee
       @targets = targets
       @name = object[Target::KEY]
       error "Target name cannot be 'null'" if @name == nil
-      @depends = object['depends']||[]
-      @depends = Array(@depends)
+      @depends = Array(object['depends']||[])
       @description = object['description']
-      @script = object['script']
-      @script = [@script] if @script.kind_of?(String)
-      @script = [] if not @script
+      @script = Array(object['script']||[])
     end
     
     # Run target.
@@ -102,10 +101,12 @@ module Bee
             # call super target
             targets.call_super(self, dry)
           else
-            # must be a task
+            # bee task
             run_bee_task(task, dry)
           end
         end
+      else
+        raise "Task must be a string or a hash"
       end
     end
     
@@ -129,6 +130,8 @@ module Bee
       return if dry
       begin
         @targets.build.context.evaluate_script(script)
+      rescue Interrupt
+        raise $!
       rescue Exception
         error "Error running Ruby script: #{$!}"
       end
@@ -144,6 +147,7 @@ module Bee
 
     # Run a given construct.
     # - construct: construct to run as a Hash.
+    # -dry: tells if we are running in dry mode. Defaults to false.
     def run_construct(construct, dry=false)
       @listener.task(construct) if @listener
       return if dry
@@ -174,8 +178,10 @@ module Bee
       unknown_keys = task.keys - ['if', 'then', 'else']
       error "If-then-else construct may only include 'if', 'then' and 'else' entries" if
         unknown_keys.length > 0
-      error "If entry in if-then-else construct must be a string" if
-        not task['if'].kind_of?(String)
+      error "If entry in if-then-else construct must be a string, a symbol or a boolean" if
+        not task['if'].kind_of?(String) and
+        not task['if'].kind_of?(Symbol) and
+        not (task['if'].kind_of?(TrueClass) or task['if'].kind_of?(FalseClass))
       error "Then entry in if-then-else construct must be a list" if
         not task['then'].kind_of?(Array)
       error "Else entry in if-then-else construct must be a list" if
@@ -214,20 +220,24 @@ module Bee
     def construct_for(task, dry)
       # test entries
       error "For-in-do construct must include 'in' and 'do' entries" if
-        not task.keys.include?('in') or not task.keys.include?('do')
+        not task.keys.include?('in') or
+        not task.keys.include?('do')
       unknown_keys = task.keys - ['for', 'in', 'do']
       error "For-in-do construct may only include 'for', 'in' and 'do' entries" if
         unknown_keys.length > 0
       error "For entry in for-in-do construct must be a string" if
         not task['for'].kind_of?(String)
-      error "In entry in for-in-do construct must be a list or a string" if
-        not task['in'].kind_of?(Enumerable) and not task['in'].kind_of?(String)
+      error "In entry in for-in-do construct must be a list, a string or a symbol" if
+        not task['in'].kind_of?(Enumerable) and
+        not task['in'].kind_of?(String) and
+        not task['in'].kind_of?(Symbol)
       error "Do entry in for-in-do construct must be a list" if
         not task['do'].kind_of?(Array)
       # iterate over list
-      if task['in'].kind_of?(String)
-        enumerable = evaluate(@targets.build.context.
-                              evaluate_object(task['in']))
+      if task['in'].kind_of?(String) or task['in'].kind_of?(Symbol)
+        enumerable = evaluate(task['in'])
+        error "In entry in for-in-do construct must result in an enumerable" if
+          not enumerable.kind_of?(Enumerable)
       else
         enumerable = task['in']
       end
@@ -254,13 +264,14 @@ module Bee
       error "Try entry in try-catch construct must be a list" if
         not task['try'].kind_of?(Array)
       error "Catch entry in try-catch construct must be a list" if
-        not task['catch'].kind_of?(Array)
+        task['catch'] and not task['catch'].kind_of?(Array)
       # try and catch errors
       begin
         run_block(task['try'], dry)
       rescue
         @targets.build.listener.recover if @targets.build.listener
-        run_block(task['catch'], dry)
+        run_block(task['catch'], dry) if task['catch']
+
       end
     end
 
@@ -276,7 +287,13 @@ module Bee
     # Evaluate a given expression and raise a BuildError if an error happens.
     def evaluate(expression)
       begin
-        return @targets.build.context.evaluate_script(expression)
+        if expression.kind_of?(String)
+          return @targets.build.context.evaluate_script(expression)
+        elsif (expression.kind_of?(TrueClass) or expression.kind_of?(FalseClass))
+          return expression
+        else
+          return @targets.build.context.evaluate_object(expression)
+        end
       rescue
         error "Error evaluating expression: #{$!}"
       end

data/lib/bee_targets.rb

@@ -0,0 +1,147 @@
+# Copyright 2006-2011 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 'rubygems'
+require 'bee_util'
+require 'bee_target'
+
+module Bee
+
+  # Class to manage targets in a build.
+  class Targets
+
+    include Bee::Util::BuildErrorMixin
+
+    # The build.
+    attr_reader :build
+    # Targets hash by name.
+    attr_reader :hash
+    # List of targets that already ran.
+    attr_reader :already_run
+    # Default target.
+    attr_accessor :default
+
+    # Constructor.
+    # - build: build object.
+    def initialize(build)
+      @build = build
+      @hash = {}
+      @already_run = []
+    end
+
+    # Add a new target.
+    # - object: object tree resulting from YAML build file parsing.
+    def add(object)
+      begin
+        target = Target.new(object, self)
+      rescue
+        error "Error parsing target '#{object[Bee::Target::KEY]}': #{$!}"
+      end
+      error "Duplicate target definition: '#{target.name}'" if
+        @hash.has_key?(target.name)
+      @hash[target.name] = [target]
+      @default = target.name if !@default
+    end
+
+    # Extend parent targets.
+    # - parent: parent targets.
+    def extend(parent)
+      # set appropriate targets for targets of parent
+      for targets in parent.hash.values
+        for target in targets
+          target.targets = self
+        end
+      end
+      # insert parent targets before current ones
+      for name in parent.hash.keys
+        if @hash[name]
+          @hash[name] = parent.hash[name] + @hash[name]
+          # clean dependencies for redefined targets
+          for target in parent.hash[name]
+            target.depends.clear
+          end
+          # copy documentation of parent if target not documented
+          if not @hash[name].last.description
+            description = nil
+            for target in parent.hash[name]
+              description = target.description || description
+            end
+            @hash[name].last.description = description
+          end
+        else
+          @hash[name] = parent.hash[name]
+        end
+      end
+      # set default default target to parent one if none was set
+      @default = @default || parent.default
+    end
+
+    # Run a given target.
+    # - target: the target to run.
+    # - dry: tells if we run in dry mode. Defaults to false.
+    def run_target(target, dry=false)
+      error "Target '#{target}' not found" if not @hash[target]
+      if not @already_run.include?(target)
+        @already_run << target
+        @hash[target].last.run(dry)
+      end
+    end
+
+    # Run targets.
+    # - targets: list of target names to run.
+    def run(targets, dry)
+      error "No default target given" if (!@default and targets.length == 0)
+      targets = [@default] if targets.length == 0
+      for target in targets
+        run_target(target, dry)
+        @already_run.clear
+      end
+    end
+
+    # Call super target.
+    # - target: target to call super onto.
+    def call_super(target, dry=false)
+      index = @hash[target.name].index(target)
+      error "No super target to call for '#{target.name}'" if index == 0
+      index -= 1
+      @hash[target.name][index].run(dry)
+    end
+
+    # Tells if a given target is last in hierarchy.
+    # - target: given target.
+    def is_last(target)
+      index = @hash[target.name].index(target)
+      last = @hash[target.name].size - 1
+      return index == last
+    end
+
+    # Return targets description as a hash of descriptions indexed by
+    # target name. Dependencies are added after target description.
+    def description
+      description = {}
+      for name in @hash.keys
+        text = @hash[name].last.description
+        if @hash[name].last.depends and @hash[name].last.depends.length > 0
+          depends = ' [' + @hash[name].last.depends.join(', ') + ']'
+        else
+          depends = nil
+        end
+        description[name] = (text ? text : '') + (depends ? depends : '')
+      end
+      return description
+    end
+
+  end
+
+end

data/lib/bee_task_default.rb

@@ -1,4 +1,4 @@
-# Copyright 2006-2010 Michel Casabianca <michel.casabianca@gmail.com>
+# Copyright 2006-2011 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.
@@ -13,8 +13,8 @@
 # limitations under the License.
 
 require 'rubygems'
-require 'bee'
-require 'bee_task'
+require 'bee_build'
+require 'bee_task_package'
 require 'bee_util'
 require 'erb'
 require 'fileutils'
@@ -28,7 +28,7 @@ module Bee
   
     # Package for default tasks (tasks with no package).
     class Default < Package
-    
+      
       ######################################################################
       #                        MISCELLANEOUS TASKS                         #
       ######################################################################
@@ -141,7 +141,7 @@ module Bee
         @build.context.set_property(property, value)
       end
 
-      # Trow a build error with a given message.
+      # Throw a build error with a given message.
       #
       # - message: the error message. Will be printed on the console as the
       #   build failure reason.
@@ -156,6 +156,9 @@ module Bee
         error message
       end
 
+      # Alias for throw.
+      alias :raise :throw
+
       # Get a given URL and store its content in a given file. Parameters
       # is a Hash with following entries:
       #
@@ -171,7 +174,7 @@ module Bee
       #
       #   - get:
       #       url: http://rubyforge.org/frs/download.php/22185/bee-0.4.0.zip
-      def get(parameters)
+      def http_get(parameters)
         params_desc = {
           :url   => { :mandatory => true,  :type => :string },
           :dest  => { :mandatory => false, :type => :string },
@@ -211,7 +214,6 @@ module Bee
           @build.context.set_property(prop, content)
         end
       end
-
       
       # Send an email using SMTP.
       #
@@ -342,7 +344,7 @@ EOF
         puts "Linking #{files.length} file(s) to '#{new}'"
         begin
           FileUtils.ln_s(files, new)
-        rescue
+        rescue Exception
           error "Error making the link: #{$!}"
         end
       end
@@ -389,7 +391,7 @@ EOF
             else
               FileUtils.chmod(mode, files)
             end
-          rescue
+          rescue Exception
             error "Error changing permissions: #{$!}"
           end
         end
@@ -439,10 +441,10 @@ EOF
             else
               FileUtils.chown(user, group, files)
             end
-          rescue
+          rescue Exception
             error "Error changing owner: #{$!}"
           end
-        end        
+        end
       end
 
       # Make a directory, and parent directories if necessary. Doesn't
@@ -462,7 +464,7 @@ EOF
           puts "Creating directory '#{dir}'"
           begin
             FileUtils.makedirs(dir)
-          rescue
+          rescue Exception
             error "Error creating directory '#{dir}': #{$!}"
           end
         end
@@ -498,7 +500,7 @@ EOF
         puts "Copying #{nb_copies} file(s) to '#{dest}'"
         begin
           FileUtils.cp_r(src, dest)
-        rescue
+        rescue Exception
           error "Error copying file(s): #{$!}"
         end
       end
@@ -533,7 +535,7 @@ EOF
         puts "Moving #{nb_moves} file(s) to '#{dest}'"
         begin
           FileUtils.mv(src, dest)
-        rescue
+        rescue Exception
           error "Error moving file(s): #{$!}"
         end
       end
@@ -725,7 +727,7 @@ EOF
           for file in files
             begin
               FileUtils.rm(file)
-            rescue
+            rescue Exception
               error "Error deleting files: #{$!}"
             end
           end
@@ -751,7 +753,7 @@ EOF
           for dir in dirs
             begin
               FileUtils.rm_rf(dir)
-            rescue
+            rescue Exception
               error "Error deleting directory(ies): #{$!}"
             end
           end
@@ -788,7 +790,7 @@ EOF
         puts "Touching #{size} file(s)" if size > 0
         begin
           FileUtils.touch(files)
-        rescue
+        rescue Exception
           error "Error touching file(s): #{$!}"
         end
       end
@@ -844,27 +846,27 @@ EOF
 
       # Load a YAML file in a given property.
       # 
-      # - prop: the property name to set with YAML parsed content.
       # - file: the YAML file name to load.
+      # - prop: the property name to set with YAML parsed content.
       # 
       # Example
       #
       #  - yaml_load:
-      #      prop: "my_list"
       #      file: "my_list.yml"
+      #      prop: "my_list"
       def yaml_load(params)
         params_desc = {
+          :file  => { :mandatory => true, :type => :string },
           :prop  => { :mandatory => true, :type => :string },
-          :file  => { :mandatory => true, :type => :string }
         }
         check_parameters(params, params_desc)
-        prop = params[:prop]
         file = params[:file]
+        prop = params[:prop]
         error "YAML file '#{file}' not found" if not File.exists?(file)
         script = "#{prop} = YAML.load(File.read('#{file}'))"
         begin
           @build.context.evaluate_script(script)
-        rescue
+        rescue Exception
           error "Error loading YAML file '#{file}': #{$!}"
         end
       end      
@@ -890,7 +892,7 @@ EOF
         script = "File.open('#{file}', 'w') {|f| f.write(YAML.dump(#{prop}))}"
         begin
           @build.context.evaluate_script(script)
-        rescue
+        rescue Exception
           error "Error dumping YAML file '#{file}': #{$!}"
         end
       end      
@@ -958,7 +960,8 @@ EOF
       def test(params)
         require 'test/unit'
         params_desc = {
-          :root     => { :mandatory => false, :type => :string },
+          :root     => { :mandatory => false, :type => :string,
+                         :default   => '.' },
           :includes => { :mandatory => true,  :type => :string },
           :excludes => { :mandatory => false, :type => :string },
           :dotmatch => { :mandatory => false, :type => :boolean,
@@ -975,8 +978,9 @@ EOF
         error "Test directory '#{dir}' not found" if 
           not (File.exists?(dir) and File.directory?(dir))
         files = filter_files(includes, excludes, root, dotmatch)
+        files.map! { |file| File.expand_path(File.join(root, file)) }
         for file in files
-          load File.join(root || '.', file)
+          load file
         end
         size = (files.kind_of?(Array) ? files.size : 1)
         puts "Running #{size} unit test(s)"
@@ -1051,15 +1055,15 @@ EOF
         end
         begin
           result = template.result(@build.context.context_binding)
-        rescue
+        rescue Exception
           error "Error processing ERB: #{$!}"
         end
         # write result in file or set property
         if dest
           begin
             File.open(dest, 'w') { |file| file.write(result) }
-          rescue
-            error "Error writing ERB processing result in file: #{$!}"
+          rescue Exception
+            error "Error writing ERB result in file: #{$!}"
           end
         else
           @build.context.set_property(property, result)
@@ -1111,7 +1115,7 @@ EOF
         begin
           rdoc = RDoc::RDoc.new
           rdoc.document(command_line)
-        rescue
+        rescue Exception
           error "Error generating RDoc: #{$!}"
         end
       end
@@ -1172,7 +1176,7 @@ EOF
         begin
           build = Bee::Build.load(file, false, props)
           build.run(target, @build.listener.clone)
-        rescue
+        rescue Exception
           error "Error invoking build file '#{file}': #{$!}"
         end
       end
@@ -1227,16 +1231,16 @@ EOF
         # build the archive
         puts "Building ZIP archive '#{dest}'"
         begin
-          zipfile = Zip::ZipFile.open(dest, Zip::ZipFile::CREATE) do |zip|
+          Zip::ZipFile.open(dest, Zip::ZipFile::CREATE) do |zip|
             for file in files
               path = (root == nil ? file : File.join(root, file))
               entry = prefix ? File.join(prefix, file) : file
-              puts "Adding '#{entry}'" if @build.listener.verbose
+              puts "Adding '#{entry}'" if @verbose
               zip.add(entry, path)
             end
             zip.close
           end
-        rescue
+        rescue Exception
           error "Error building ZIP archive: #{$!}"
         end
       end
@@ -1269,7 +1273,7 @@ EOF
         puts "Extracting ZIP file '#{src}' to '#{dest}'"
         begin
           Zip::ZipFile.foreach(src) do |entry|
-            puts "Writing '#{entry}'" if @build.listener.verbose
+            puts "Writing '#{entry}'" if @verbose
             tofile = File.join(dest, entry.name)
             if entry.file?
               dir = File.dirname(tofile)
@@ -1279,7 +1283,7 @@ EOF
               FileUtils.makedirs(tofile)
             end
           end
-        rescue
+        rescue Exception
           error "Error extracting ZIP archive: #{$!}"
         end
       end
@@ -1331,7 +1335,7 @@ EOF
           Dir.chdir(root) if root
           Archive::Tar::Minitar::Output.open(abs_dest) do |tarfile|
             for file in files
-              puts "Adding '#{file}'" if @build.listener.verbose
+              puts "Adding '#{file}'" if @verbose
               Archive::Tar::Minitar.pack_file(file, tarfile)
             end
           end
@@ -1373,7 +1377,7 @@ EOF
             output.write(input.read)
             output.close
           end
-        rescue
+        rescue Exception
           error "Error generating GZIP archive: #{$!}"
         end
       end
@@ -1422,7 +1426,7 @@ EOF
             output.write(input.read)
             output.close
           end
-        rescue
+        rescue Exception
           error "Error expanding GZIP archive: #{$!}"
         end
       end
@@ -1478,11 +1482,11 @@ EOF
           Archive::Tar::Minitar::Output.
             open(Zlib::GzipWriter.new(File.open(abs_dest, 'wb'))) do |tgz|
             for file in files
-              puts "Adding '#{file}'" if @build.listener.verbose
+              puts "Adding '#{file}'" if @verbose
               Archive::Tar::Minitar.pack_file(file, tgz)
             end
           end
-        rescue
+        rescue Exception
           error "Error generating TARGZ archive: #{$!}"
         ensure
           Dir.chdir(current_dir)
@@ -1524,7 +1528,7 @@ EOF
           else
             Archive::Tar::Minitar.unpack(src, dest)
           end
-        rescue
+        rescue Exception
           error "Error extracting TAR archive: #{$!}"
         end
       end
@@ -1563,7 +1567,7 @@ EOF
             ftp.close
           end
           puts "Connection to FTP host '#{host}' sucessful"
-        rescue
+        rescue Exception
           error "Error connecting to FTP host: #{$!}"
         end
       end
@@ -1615,7 +1619,7 @@ EOF
             end
             ftp.close
           end
-        rescue
+        rescue Exception
           error "Error getting file '#{basename}': #{$!}"
         end
       end
@@ -1667,7 +1671,7 @@ EOF
             end
             ftp.close
           end
-        rescue
+        rescue Exception
           error "Error putting file '#{basename}': #{$!}"
         end
       end
@@ -1707,7 +1711,7 @@ EOF
             ftp.mkdir(dir)
             ftp.close
           end
-        rescue
+        rescue Exception
           error "Error making directory '#{basename}': #{$!}"
         end
       end
@@ -1719,18 +1723,19 @@ EOF
       # If construct will evaluate the expression in the 'if' entry and run
       # block in the 'then' entry or 'else' entry accordingly.
       #
-      # - if: the condition to evaluate. This is a Ruby expression evaluated
-      #   in the build context.
-      # - then: block that is evaluated if confition in if is true.
-      # - else: block that is evaluated if confition in if is false.
+      # - if: the condition to evaluate. This is a Ruby expression (thus a 
+      #   string) evaluated in the build context, a symbol that refers to a
+      #   property or a boolean.
+      # - then: block that is evaluated if condition in if is true.
+      # - else: block that is evaluated if condition in if is false.
       #
       # Example
       #
       #   - if: RUBY_PLATFORM =~ /darwin/
       #     then:
-      #       - print: Hello, I'm a Mac
+      #     - print: Hello, I'm a Mac
       #     else:
-      #       - print: Hello, I'm a PC
+      #     - print: Hello, I'm a PC
       def if
       end
 
@@ -1745,8 +1750,8 @@ EOF
       #
       #   - while: i > 0
       #     do:
-      #       - print: :i
-      #       - rb: i -= 1
+      #     - print: :i
+      #     - rb: i -= 1
       def while
       end
 
@@ -1754,10 +1759,11 @@ EOF
       # a property which name is in the 'for' entry and running the block in
       # the 'do' entry for each value.
       #
-      # - for: the name of the property which receives values of the iteration.
-      # - in: a list on which to iterate. This can be a list or a ruby
-      #   expression to evaluate in the context of the build to obtain the
-      #   Enumerable on which to iterate.
+      # - for: the name of the property which receives values of the iteration,
+      #   as a string.
+      # - in: a list on which to iterate. This can be a list, a ruby expression
+      #   to evaluate in the context of the build to obtain the Enumerable on
+      #   which to iterate or a symbol that refers to a property that is a list.
       # - do: the block to run at each iteration.
       #
       # Example
@@ -1768,6 +1774,18 @@ EOF
       #       - print: "Creating #{file}..."
       #       - touch: :file
       #
+      # The same using a reference to a property that is a list:
+      #
+      #   - properties:
+      #       list: ['foo', 'bar']
+      #
+      #   - target: test
+      #     script:
+      #     - for: name
+      #       in:  :list
+      #       do:
+      #       - print: "Hi #{name}!"
+      #
       # To iterate five times, we could write (using a Ruby Range):
       #
       #   - for: i
@@ -1793,10 +1811,10 @@ EOF
       # Example:
       #
       #   - try:
-      #       - print: "In the try block"
-      #       - throw: "Something went terribly wrong!"
+      #     - print: "In the try block"
+      #     - throw: "Something went terribly wrong!"
       #     catch:
-      #       - print: "An error occured"
+      #     - print: "An error occured"
       def try
       end