bee 0.10.2 → 0.11.0

data/lib/bee_context.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,44 +12,60 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# Module for Bee core classes.
+require 'rubygems'
+require 'bee_util'
+require 'bee_properties'
+
 module Bee
-  
-  # Class for Ruby scripts context. All embedded Ruby scripts run in this
-  # context where build properties are defined as Ruby variables.
+
+  # Class for build context where properties live as local variables and where
+  # all scripts (from context or in Ruby tasks) are evaluated.
   class Context
 
     include Bee::Util::BuildErrorMixin
-    
-    # The binding of this context.
+
+    # The context binding
     attr_reader :context_binding
-    
+
     # Constructor.
-    def initialize(properties)
-      @properties = properties
+    # - properties: properties as a hash that gives expression for a given
+    #   property.
+    # - scripts: list of script files to run in context.
+    def initialize(properties={}, scripts=[])
       @context_binding = get_binding
+      @properties = properties
+      @scripts = scripts
     end
-    
+
+    # Evaluate properties and scripts in the context. Should run while running
+    # the build, not while loading it.
+    def evaluate
+      evaluate_default_properties
+      evaluate_scripts
+      evaluate_properties
+    end
+
+    # Return the list of properties (that is the list of local variables of
+    # context) as an unsorted list of strings.
+    def properties
+      return eval('local_variables', @context_binding).map{|var| var.to_s}
+    end
+
     # 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)
+    # - name: the property name as a string or symbol.
+    # - value: the property value as an object.
+    def set_property(name, value)
       begin
         eval("#{name} = #{value.inspect}", @context_binding)
       rescue Exception
         error "Error setting property '#{name} = #{value.inspect}': #{$!}"
       end
     end
-    
-    # Get a given property in context.
+
+    # Get a given property in context. Raises an error if the property was not
+    # set.
     # - 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)
+    def get_property(name)
       begin
         eval("#{name}", @context_binding)
       rescue NameError
@@ -58,18 +74,13 @@ module Bee
         error "Error getting property '#{name}': #{$!}"
       end
     end
-    
-    # Return list of properties (as local variables of binding).
-    def properties
-      return eval('local_variables', @context_binding).map{ |var| var.to_s }
-    end
-    
+
     # Evaluate a script in context.
-    # - script: source of the script to evaluate.
-    def evaluate_script(script)
-      eval(script, @context_binding)
+    # - source: source of the script to evaluate.
+    def evaluate_script(source)
+      eval(source, @context_binding)
     end
-    
+
     # 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}'
@@ -85,7 +96,7 @@ module Bee
         object = object.gsub(/#\{.+?\}/) do |match|
           expression = match[2..-2]
           begin
-            value = evaluate_script(expression)
+            value = eval(expression, @context_binding)
           rescue
             error "Error evaluating expression '#{expression}': #{$!}"
           end
@@ -115,24 +126,76 @@ module Bee
         return object
       end
     end
-    
+
     private
-    
-    # Get a binding as script context.
-    def get_binding
-      return binding
+
+    # Evaluate properties in context, except system properties.
+    def evaluate_properties
+      for name in (@properties.keys - Bee::Properties::SYSTEM_PROPERTIES)
+        begin
+          Thread.current[:stack] = []
+          evaluate_property(name)
+        ensure
+          Thread.current[:stack] = nil
+        end
+      end
     end
 
-    # Catch missing properties
-    def method_missing(name, *args, &block)
+    # Evaluate default properties in context.
+    def evaluate_default_properties
+      for name in Bee::Properties::SYSTEM_PROPERTIES
+        begin
+          Thread.current[:stack] = []
+          evaluate_property(name)
+        ensure
+          Thread.current[:stack] = nil
+        end
+      end
+    end
+
+    # Evaluate a property with given name.
+    # - name: the name of the property to evaluate.
+    def evaluate_property(name)
       stack = Thread.current[:stack]
-      if stack
-        @properties.evaluate_property(name, self)
+      error "Circular properties: #{stack.join(', ')}" if stack.include?(name)
+      begin
+        stack.push(name)
+        value = evaluate_object(@properties[name])
+        stack.pop
+        set_property(name, value)
+        return value
+      rescue
+        error "Error evaluating property '#{name}': #{$!}"
+      end
+    end
+
+    # Evaluate scripts in the context.
+    def evaluate_scripts
+      for script in @scripts
+        begin
+          source = Bee::Util::get_file(script, @base)
+          evaluate_script(source)
+        rescue Exception
+          error "Error loading context '#{script}': #{$!}"
+        end
+      end
+    end
+
+    # Catch missing properties as missing methods.
+    # - name: the name of the missing property or method.
+    def method_missing(name, *args, &block)
+      if Thread.current[:stack]
+        return evaluate_property(name)
       else
         raise NoMethodError.new("undefined method `#{name}'", name, args)
       end
-    end 
-    
+    end
+
+    # Get a binding as script context.
+    def get_binding
+      return binding
+    end
+
   end
 
 end

data/lib/bee_listener.rb

@@ -0,0 +1,114 @@
+# 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'
+
+module Bee
+
+  # Listener called when build events are triggered. Calls formatter to print
+  # events on the console.
+  class Listener
+
+    # Formatter used by listener.
+    attr_reader :formatter
+    # Build start time.
+    attr_reader :start_time
+    # Build end time.
+    attr_reader :end_time
+    # Build duration.
+    attr_reader :duration
+    # Build success.
+    attr_reader :successful
+    # Last target met.
+    attr_reader :last_target
+    # Last task met.
+    attr_reader :last_task
+    # Raised exception during build
+    attr_reader :exception
+
+    # Constructor.
+    # - formatter: the formatter to use to output on console.
+    def initialize(formatter)
+      @formatter = formatter
+    end
+
+    # Called when build is started.
+    # - build: the build object.
+    # - dry_run: tells if we are running in dry run.
+    def start(build, dry_run)
+      @start_time = Time.now
+      @end_time = nil
+      @duration = nil
+      @successful = nil
+      @last_target = nil
+      @last_task = nil
+      @formatter.print_build_started(build, dry_run)
+    end
+
+    # Called when build is finished.
+    def stop()
+      stop_chrono()
+      @formatter.print_build_finished(@duration)
+    end
+
+    # Called when a target is met.
+    # - target: the target object.
+    def target(target)
+      @last_target = target
+      @last_task = nil
+      @formatter.print_target(target)
+    end
+
+    # Called when a task is met.
+    # - task: task source (shell, Ruby or task).
+    def task(task)
+      @last_task = task
+      @formatter.print_task(task)
+    end
+
+    # Called when the build is a success.
+    def success()
+      @successful = true
+      @exception = nil
+    end
+
+    # Called when an error was raised.
+    # - exception: raised exception.
+    def error(exception)
+      @successful = false
+      @exception = exception
+      if exception.kind_of?(Bee::Util::BuildError)
+        exception.target = @last_target if @last_target
+        exception.task = @last_task if @last_task
+      end
+    end
+
+    # Recover from a previous error (catching it for instance).
+    def recover()
+      @successful = true
+      @exception = nil
+    end
+
+    private
+
+    # Stop chronometer, write build end time and build duration.
+    def stop_chrono()
+      @end_time = Time.now
+      @duration = @end_time - @start_time
+      @duration = (@duration * 1000).round / 1000
+    end
+
+  end
+
+end

data/lib/bee_properties.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,9 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'bee_context'
+require 'rubygems'
+require 'bee_util'
 
-# Module for Bee core classes.
 module Bee
   
   # Class to manage properties.
@@ -22,117 +22,88 @@ module Bee
 
     include Bee::Util::BuildErrorMixin
 
+    # System properties
+    SYSTEM_PROPERTIES = [:base, :here]
+
     # Key for properties entry.
     KEY = 'properties'
 
-    # List of system properties
-    SYSTEM_PROPERTIES = [:base, :here]
-
-    # Properties expressions as a hash.
+    # Properties expressions
     attr_reader :expressions
-    # Properties values as a hash
-    attr_reader :values
 
     # Constructor.
-    # - build: build object.
-    def initialize(build)
-      @build = build
+    # - properties: properties as a hash.
+    def initialize(properties={})
       @expressions = {}
-      @values = {}
-      defaults
+      check_properties(properties)
+      set_properties(properties, false)
     end
 
-    # Write properties. Will raise an error on duplicate definitions.
-    # - object: object tree resulting from YAML build file parsing or string
-    #   for a properties file to load.
-    def write(object)
-      properties = object[Properties::KEY]
-      if properties.kind_of?(String)
-        begin
-          source = Bee::Util::get_file(properties, @build.base)
-          hash = YAML::load(source)
-          set_properties(hash, false)
-        rescue Exception
-          error "Error loading properties file '#{properties}': #{$!}"
-        end
-      else
-        set_properties(properties, false)
-      end
+    # Write new properties with passed expressions.
+    # - properties: properties as a hash.
+    def write(properties)
+      check_properties(properties)
+      set_properties(properties, false)
     end
 
     # Overwrite properties with those passed.
     # - properties: properties as a hash.
     def overwrite(properties)
+      check_properties(properties)
+      set_properties(properties, true)
+    end
+
+    # Set default properties: if they are already defined, will raise an error.
+    # - properties: default properties as a hash.
+    def defaults(properties)
       set_properties(properties, true)
     end
 
     # Extend with properties of parent build.
-    # - properties: properties of parent build.
+    # - properties: properties of parent build as a hash.
     def extend(properties)
-      for name in properties.expressions.keys
-        @expressions[name] = properties.expressions[name] if 
-          !@expressions.include?(name)
+      check_properties_type(properties)
+      for name in properties.keys
+        @expressions[name] = properties[name] if !@expressions.include?(name)
       end
     end
 
-    # Evaluate properties in context.
-    # - context: build context where properties must be evaluated.
-    def evaluate(context)
-      for name in @expressions.keys
-        Thread.current[:stack] = []
-        evaluate_property(name, context) if !@values[name]
-      end
-      Thread.current[:stack] = nil
-    end
+    private
 
-    # Evaluate a given property.
-    # - name: the name of the property to evaluate.
-    # - context: the context in which the property must be evaluated.
-    # - stack: the stack of evaluated objects.
-    def evaluate_property(name, context)
-      stack = Thread.current[:stack]
-      error "Unknown property '#{name}'" if !@expressions.keys.include?(name)
-      error "Circular properties: #{stack.join(', ')}" if stack.include?(name)
-      begin
-        stack.push(name)
-        value = context.evaluate_object(@expressions[name])
-        stack.pop
-        @values[name] = value
-        context.set_property(name, value, true)
-      rescue
-        error "Error evaluating property '#{name}': #{$!}"
-      end
-      value
+    # Check that properties are a hash and raise a BuildError if not.
+    # - properties: properties to check as a hash.
+    def check_properties_type(properties)
+      error "Properties must be a hash" if not properties.kind_of?(Hash)
     end
 
-    private
-
-    # Set default properties.
-    def defaults
-      set(:base, @build.base, false)
-      set(:here, @build.here, false)
+    # Check properties for system ones:
+    # - properties: properties expressions as a hash.
+    def check_properties(properties)
+      check_properties_type(properties)
+      names = SYSTEM_PROPERTIES & properties.keys.map {|k| k.to_sym}
+      if names.length > 1
+        error "#{names.join(' and ')} are reserved property names"
+      elsif names.length > 0
+        error "#{names[0]} is a reserved property name"
+      end
     end
 
     # Set properties.
     # - properties: properties as a hash.
     # - overwrite: tells if we can overwrite existing properties.
     def set_properties(properties, overwrite)
-      error "Properties must be a hash" if not properties.kind_of?(Hash)
+      check_properties_type(properties)
       for name in properties.keys
         expression = properties[name]
-        set(name, expression, overwrite)
+        set_property(name, expression, overwrite)
       end
     end
 
-    # Set a property.
+    # Set a given named property with an expression.
     # - name: property name (as a string or symbol).
-    # - expression: property expression (as a string) to be evaluated in
-    #   context to get value.
+    # - expression: property expression as a string.
     # - overwrite: tells if we can overwrite existing properties.
-    def set(name, expression, overwrite)
-      error "Property '#{name}' collides with a function of the context" if
-        Bee::Context.method_defined?(name) or 
-        Bee::Context.private_method_defined?(name)
+    def set_property(name, expression, overwrite)
       return if expression == nil
       name = name.to_sym
       error "Duplicate property definition: '#{name}'" if