bee 0.3.1 → 0.4.0

data/README

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

data/bin/bee

@@ -1,5 +1,21 @@
 #!/usr/bin/env ruby
 
+# 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.
+
+# Launching script for bee.
+
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'bee_console'
 

data/bin/bee.bat

@@ -0,0 +1,32 @@
+@echo off
+if not "%~f0" == "~f0" goto WinNT
+ruby -Sx "%0" %1 %2 %3 %4 %5 %6 %7 %8 %9
+goto endofruby
+:WinNT
+"%~d0%~p0ruby" -x "%~f0" %*
+goto endofruby
+#!/usr/bin/env ruby
+
+# 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.
+
+# Launching script for bee.
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'bee_console'
+
+Bee::Console.start_command_line
+
+__END__
+:endofruby

data/lib/bee.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,125 +12,139 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Module for Bee stuff.
-module Bee
-
-  require 'yaml'
-
-  #########################################################################
-  #                             BUILD ERROR                               #
-  #########################################################################
-
-  class BuildError < RuntimeError; end
-
-  module BuildErrorMixin
-
-    # Convenient method to raise a BuildError.
-    # - message: error message.
-    def error(message)
-      raise BuildError.new(message)
-    end    
+require 'yaml'
+require 'bee_util'
 
-  end
-
-  #########################################################################
-  #                             BUILD CLASS                               #
-  #########################################################################
+# Module for Bee core classes.
+module Bee
 
-  # Class for a given build.
+  # Class for a build. This class is built from an object resulting from YAML
+  # build file parsing.
   class Build
 
-    include BuildErrorMixin
+    include Bee::Util::BuildErrorMixin
+    include Bee::Util::HashCheckerMixin
 
     # Build file.
     attr_reader :file
-    # Base directory.
+    # Base directory (directory where lives the build file). All file paths
+    # are relative to this directory.
     attr_reader :base
     # Build name.
     attr_reader :name
-    # Default target.
+    # Default target (bee runs target passed on the command line, default
+    # target or first one in build file).
     attr_reader :default
     # Build description.
     attr_reader :description
-    # Properties hash (used for project help).
-    attr_reader :properties
     # Hash for targets, indexed by target name.
     attr_reader :targets
     # Context for Ruby scripts and properties.
     attr_reader :context
-    # Loaded tasks.
-    attr_reader :tasks
-    # Build listener.
+    # Package manager (for task invocation).
+    attr_reader :package_manager
+    # Build listener (responsible for displaying build status).
     attr_reader :listener
+    
+    # Load a build from a YAML build file.
+    # - file: YAML build file.
+    # - recursive: tells if we look for build file recursively (defaults to
+    #   nil).
+    def self.load(file, recursive=nil)
+      if recursive
+        begin
+          file = Bee::Util::find(file)
+        rescue
+          raise Bee::Util::BuildError.new("Build file '#{file}' " +
+                                          "not found recursively")
+        end
+      end
+      raise Bee::Util::BuildError.new("Build file '#{file}' not found") if 
+        not File.exists?(file)
+      raise Bee::Util::BuildError.new("Build file '#{file}' is not a file") if
+        not File.file?(file)
+      raise Bee::Util::BuildError.new("Build file '#{file}' is not readable") if
+        not File.readable?(file)
+      yaml = File.read(file)
+      begin
+        object = YAML::load(yaml)
+      rescue
+        raise Bee::Util::BuildError.
+          new("YAML syntax error in build file: #{$!}")
+      end
+      return Build.new(object, file)
+    end
 
     # Constructor:
-    # - file: build file to load.
-    def initialize(file)
+    # - object: build description as an object (resulting from YAML loading).
+    # - file: build file (nil if none).
+    def initialize(object, file)
+      require 'bee_task'
       @file = file
+      if file
+        @base = File.expand_path(File.dirname(file))
+      else
+        @base = File.expand_path(Dir.pwd)
+      end
+      error "Build must be a list" unless object.kind_of?(Array)
       @properties = {}
       @targets = {}
-      @tasks = {}
       @context = Context.new
-      default_context_file = File.join(File.dirname(__FILE__), 
-                                       'bee_default_context.rb')
-      source = File.read(default_context_file)
-      load_context(source)
-      @base = File.expand_path(File.dirname(@file))
-      @context.set('base', @base)
-      @properties['base'] = @base
-      # load build file
-      begin
-        source = File.read(@file)
-        build = YAML::load(source)
-        # parse object entries
-        for entry in build
-          if entry.key?('build')
-            # build info entry
-            error "Duplicate build info" if @name
-            @name = entry['build']
-            @default = entry['default']
-            @description = entry['description']
-            # load context files if any
-            if entry['context']
-              for script in entry['context']
-                begin
-                  based_script = File.join(@base, script)
-                  evaluated_script = @context.evaluate_object(based_script)
-                  source = File.read(evaluated_script)
-                  load_context(source)
-                rescue
-                  error "Error loading context '#{script}': #{$!}"
-                end
-              end
-            end
-          elsif entry.key?('properties')
-            # properties entry
-            for property in entry['properties']
+      @context.set_property(:base, @base)
+      @properties[:base] = @base
+      @package_manager = Bee::Task::PackageManager.new(self)
+      # parse object entries
+      for entry in object
+        if entry.key?('build')
+          # build info entry
+          begin
+            check_hash(entry,
+              {'build' => :mandatory, 
+                'default' => :optional, 
+                'description' => :optional,
+                'context' => :optional})
+          rescue
+            error "Error parsing build entry: #{$!}"
+          end
+          error "Duplicate build info" if @name
+          @name = entry['build']
+          @default = entry['default']
+          @description = entry['description']
+          # load context files if any
+          if entry['context']
+            for script in entry['context']
               begin
-                name = property.keys[0]
-                value = @context.evaluate_object(property[name])
-                error "Duplicate property '#{name}' definition" if 
-                  @properties[name]
-                @properties[name] = value
-                @context.set(name, value)
-              rescue
-                error "Error evaluating property '#{name}': #{$!}"
+                based_script = File.join(@base, script)
+                evaluated_script = @context.evaluate_object(based_script)
+                source = File.read(evaluated_script)
+                @context.evaluate_script(source)
+              rescue Exception
+                error "Error loading context '#{script}': #{$!}"
               end
             end
-          elsif entry.key?('target')
-            # target entry
+          end
+        elsif entry.key?('properties')
+          # properties entry
+          for property in entry['properties']
+            name = property.keys[0]
+            value = @context.evaluate_object(property[name])
+            @context.set_property(name, value, false)
+          end
+        elsif entry.key?('target')
+          # target entry
+          begin
             target = Target.new(entry, self)
-            @default = target.name if not @default and @targets.keys.length == 0
-            error "Duplicate target definition: '#{target.name}'" if 
-              @targets[target.name]
-            @targets[target.name] = target
-          else
-            # unknown entry
-            error "Unknown entry:\n#{YAML::dump(entry)}"
+          rescue
+            error "Error parsing target '#{entry['target']}': #{$!}"
           end
+          @default = target.name if !@default and @targets.keys.empty?
+          error "Duplicate target definition: '#{target.name}'" if
+            @targets[target.name]
+          @targets[target.name] = target
+        else
+          # unknown entry
+          error "Unknown entry:\n#{YAML::dump(entry)}"
         end
-      rescue
-        error "Error loading build file '#{@file}': #{$!}"
       end
     end
 
@@ -148,8 +162,8 @@ module Bee
         for target in targets
           run_target(target)
         end
-        @listener.build_finished(self)
-      rescue BuildError => e
+        @listener.build_finished(self) if @listener
+      rescue Bee::Util::BuildError => e
         if listener
           @listener.error(e)
         else
@@ -168,31 +182,14 @@ module Bee
       @targets[target].run      
     end
 
-    private
-
-    # Load a given context and add last expression evaluated in context to
-    # extension tasks mapping.
-    # - source: the context source.
-    def load_context(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]
-        end
-        @tasks.merge!(new_tasks)
-      end
-    end
-
   end
 
-  #########################################################################
-  #                            TARGET CLASS                               #
-  #########################################################################
-
-  # Class for a given target.
+  # Class for a target. It is built from the YAML build file and manages a
+  # target, in particular, tasks execution.
   class Target
 
-    include BuildErrorMixin
+    include Bee::Util::BuildErrorMixin
+    include Bee::Util::HashCheckerMixin
 
     # Build that encapsulates target.
     attr_reader :build
@@ -206,14 +203,19 @@ module Bee
     attr_reader :script
 
     # Constructor.
-    # - target: target for target, resulting from YAML parsing.
+    # - object: object for target, resulting from YAML parsing.
     # - build: build that encapsulate this target.
-    def initialize(target, build)
+    def initialize(object, build)
+      check_hash(object,
+        {'target' => :mandatory,
+          'depends' => :optional,
+          'description' => :optional,
+          'script' => :optional})
       @build = build
-      @name = target['target']
-      @depends = target['depends']||[]
-      @description = target['description']
-      @script = target['script']
+      @name = object['target']
+      @depends = object['depends']||[]
+      @description = object['description']
+      @script = object['script']
     end
 
     # Run target.
@@ -260,7 +262,7 @@ module Bee
           run_ruby(script)
         else
           # must be a task
-          run_extension(task)
+          run_bee_task(task)
         end
       end
     end
@@ -280,37 +282,26 @@ module Bee
       @listener.task(script) if @listener
       begin
         @build.context.evaluate_script(script)
-      rescue BuildError
+      rescue Exception
         error "Error running Ruby script: #{$!}"
       end
     end
 
-    # Run a given task.
+    # Run a given bee task.
     # - task: task to run as a Hash.
-    def run_extension(task)
+    def run_bee_task(task)
+      require 'bee_task'
       @listener.task(task) if @listener
-      name = task.keys[0]
-      error "Unknown task '#{name}'" if 
-        not @build.tasks.key?(name)
-      parameters = task[name]
-      script = "#{name}(#{parameters.inspect})"
-      begin
-        @build.context.evaluate_script(script)
-      rescue BuildError
-        error "Error running task #{name}: #{$!}"
-      end
+      @build.package_manager.run_task(task)
     end
-
+    
   end
 
-  #########################################################################
-  #                            CONTEXT CLASS                              #
-  #########################################################################
-
-  # Class for Ruby scripts context.
+  # Class for Ruby scripts context. All embedded Ruby scripts run in this
+  # context where build properties are defined as Ruby variables.
   class Context
 
-    include BuildErrorMixin
+    include Bee::Util::BuildErrorMixin
 
     # The binding of this context.
     attr_reader :context_binding
@@ -320,26 +311,37 @@ module Bee
       @context_binding = get_binding
     end
 
-    # Set a given value in context.
-    # - name: the variable name to set.
-    # - value: the variable value.
-    def set(name, value)
+    # Set a given property in context.
+    # - name: the property name.
+    # - value: the property value.
+    # - override: tells if we can overwrite an existing value.
+    def set_property(name, value, overwrite=true)
+      error "Property '#{name}' was already defined" if 
+        !overwrite and properties.include?(name.to_s)
       begin
         eval("#{name} = #{value.inspect}", @context_binding)
-      rescue
+      rescue Exception
         error "Error setting property '#{name} = #{value.inspect}': #{$!}"
       end
     end
 
-    # Get a given value in context.
-    # - name: the variable name.
-    def get(name)
+    # Get a given property in context.
+    # - name: the property name.
+    # - strict: raise an error if given property was not set.
+    def get_property(name, strict=false)
+      error "Property '#{name}' was not set" if 
+        strict and !properties.include?(name.to_s)
       begin
         eval("#{name}", @context_binding)
-      rescue
+      rescue Exception
         error "Error getting property '#{name}': #{$!}"
       end
     end
+    
+    # Return list of properties (as local variables of binding).
+    def properties
+      return eval('local_variables', @context_binding)
+    end
 
     # Evaluate a script in context.
     # - script: script to evaluate.
@@ -361,38 +363,31 @@ module Bee
         # 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 = get_property(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
-        return value
+        value = get_property(property, true)
+        return evaluate_object(value)
+      when Array
+        # array: evaluate each element
+        return object.collect { |element| evaluate_object(element) }
+      when Hash
+        # hash: evaluate all keys and values
+        evaluated = {}
+        object.each_pair do |key, value| 
+          evaluated[evaluate_object(key)] = evaluate_object(value)
+        end
+        return evaluated
       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
-    end
-
     private
 
     # Get a binding as script context.