bee 0.5.3 → 0.6.0

data/README

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

data/lib/bee.rb

@@ -541,9 +541,7 @@ module Bee
         end
         @targets.build.listener.target(self) if 
           @targets.build.listener and @targets.is_last(self)
-        for task in @script
-          run_task(task, dry)
-        end
+        run_block(@script, dry)
       ensure
         Dir.chdir(current_dir)
       end
@@ -561,18 +559,25 @@ module Bee
         # shell script
         run_shell(task, dry)
       when Hash
-        error "A task entry must be a Hash with a single key" if
-          task.keys.length != 1
-        if task.key?('rb')
-          # ruby script
-          script = task['rb']
-          run_ruby(script, dry)
-        elsif task.key?('super')
-          # call super target
-          targets.call_super(self, dry)
+        if task.keys.length > 1
+          # construct
+          run_construct(task, dry)
         else
-          # must be a task
-          run_bee_task(task, dry)
+          if task.key?('rb')
+            # ruby script
+            script = task['rb']
+            run_ruby(script, dry)
+          elsif task.key?('sh')
+            # shell script
+            script = task['sh']
+            run_shell(script, dry)
+          elsif task.key?('super')
+            # call super target
+            targets.call_super(self, dry)
+          else
+            # must be a task
+            run_bee_task(task, dry)
+          end
         end
       end
     end
@@ -610,6 +615,107 @@ module Bee
       @targets.build.package_manager.run_task(task)
     end
 
+    # Run a given construct.
+    # - construct: construct to run as a Hash.
+    def run_construct(construct, dry=false)
+      @listener.task(construct) if @listener
+      return if dry
+      # if construct
+      if construct.keys.include?('if')
+        construct_if(construct, dry)
+      # while construct
+      elsif construct.keys.include?('while')
+        construct_while(construct, dry)
+      # for construct
+      elsif construct.keys.include?('for')
+        construct_for(construct, dry)
+      else
+        error "Unknown construct '#{construct.keys.join('-')}'"
+      end
+    end
+
+    # Run if construct.
+    # - task: the construct as a hash.
+    # - dry: tells if we run in dry mode.
+    def construct_if(task, dry)
+      # test entries
+      error "If construct must include 'then' entry" if
+        not task.keys.include?('then')
+      unknown_keys = task.keys - ['if', 'then', 'else']
+      error "If construct may only include 'if', 'then' and 'else' entries" if
+        unknown_keys.length > 0
+      # evaluate condition in the build context
+      if evaluate(task['if'].to_s)
+        run_block(task['then'], dry)
+      else
+        run_block(task['else'], dry) if task['else']
+      end
+    end
+
+    # Run while construct.
+    # - task: the construct as a hash.
+    # - dry: tells if we run in dry mode.
+    def construct_while(task, dry)
+      # test entries
+      error "While construct must include 'do' entry" if
+        not task.keys.include?('do')
+      unknown_keys = task.keys - ['while', 'do']
+      error "While construct may only include 'while' and 'do' entries" if
+        unknown_keys.length > 0
+      # evaluate condition in the build context
+      while evaluate(task['while'])
+        run_block(task['do'], dry)
+      end
+    end
+
+    # Run for construct.
+    # - task: the construct as a hash.
+    # - dry: tells if we run in dry mode.
+    def construct_for(task, dry)
+      # test entries
+      error "For construct must include 'in' and 'do' entries" if
+        not task.keys.include?('in') or not task.keys.include?('do')
+      unknown_keys = task.keys - ['for', 'in', 'do']
+      error "For construct may only include 'for', 'in' and 'do' entries" if
+        unknown_keys.length > 0
+      error "For entry in for construct must be a string" if
+        not task['for'].kind_of?(String)
+      error "In entry in for construct must be a list or a string" if
+        not task['in'].kind_of?(Enumerable) and not task['in'].kind_of?(String)
+      # iterate over list
+      if task['in'].kind_of?(String)
+        enumerable = evaluate(task['in'])
+      else
+        enumerable = task['in']
+      end
+      for element in enumerable
+        begin
+          @targets.build.context.set_property(task['for'], element)
+        rescue
+          error "Error setting property '#{task['for']}'"
+        end
+        run_block(task['do'], dry)
+      end
+    end
+
+    # Run a block, that is a list of tasks.
+    # - block: the block to run as a list of tasks.
+    # - dry: tells if we run in dry mode.
+    def run_block(block, dry)
+      for task in block
+        run_task(task, dry)
+      end   
+    end
+
+    # Evaluate a given condition and raise a BuildError if an error happens.
+    def evaluate(condition)
+      begin
+        return @targets.build.context.evaluate_script(condition)
+      rescue
+        error "Error evaluating condition: #{$!}"
+      end
+    end
+
   end
   
   # Class for Ruby scripts context. All embedded Ruby scripts run in this

data/lib/bee_console.rb

@@ -60,7 +60,7 @@ targets        Targets to run (default target if omitted).'
        | |__   ___  ___                                                   
  ____  | '_ \ / _ \/ _ \  _____ _____ _____ _____ _____ _____ _____ _____ _____
 |____| | |_) |  __/  __/ |_____|_____|_____|_____|_____|_____|_____|_____|_____|
-       |_.__/ \___|\___|  0.5.3                         http://bee.rubyforge.org
+       |_.__/ \___|\___|  0.6.0                         http://bee.rubyforge.org
 
 EOF
 

data/lib/bee_task_default.rb

@@ -97,7 +97,8 @@ module Bee
           :default  => { :mandatory => false, :type => :string },
           :pattern  => { :mandatory => false, :type => :string },
           :error    => { :mandatory => false, :type => :string },
-          :attempts => { :mandatory => false, :type => :integer, :default => 0 }
+          :attempts => { :mandatory => false, :type => :integer,
+                         :default   => 0 }
         }
         check_parameters(params, params_desc)
         message = params[:message]
@@ -281,7 +282,8 @@ module Bee
         params_desc = {
           :files     => { :mandatory => true,  :type => :string_or_array },
           :mode      => { :mandatory => true,  :type => :integer },
-          :recursive => { :mandatory => false, :type => :boolean, :default => false }
+          :recursive => { :mandatory => false, :type => :boolean,
+                          :default   => false }
         }
         check_parameters(parameters, params_desc)
         files = parameters[:files]
@@ -329,7 +331,8 @@ module Bee
           :files     => { :mandatory => true,  :type => :string_or_array },
           :user      => { :mandatory => false, :type => :string_or_integer },
           :group     => { :mandatory => false, :type => :string_or_integer },
-          :recursive => { :mandatory => false, :type => :boolean, :default => false }
+          :recursive => { :mandatory => false, :type => :boolean,
+                          :default   => false }
         }
         check_parameters(parameters, params_desc)
         files = parameters['files']
@@ -475,13 +478,17 @@ module Bee
       def copy(params)
         # check parameters and set default values
         params_desc = {
-          :root     => { :mandatory => false, :type => :string, :default => '.' },
+          :root     => { :mandatory => false, :type => :string,
+                         :default   => '.' },
           :includes => { :mandatory => false, :type => :string_or_array },
           :excludes => { :mandatory => false, :type => :string_or_array },
           :dest     => { :mandatory => true,  :type => :string },
-          :flatten  => { :mandatory => false, :type => :boolean, :default => false },
-          :dotmatch => { :mandatory => false, :type => :boolean, :default => false },
-          :lenient  => { :mandatory => false, :type => :boolean, :default => false }
+          :flatten  => { :mandatory => false, :type => :boolean,
+                         :default   => false },
+          :dotmatch => { :mandatory => false, :type => :boolean,
+                         :default   => false },
+          :lenient  => { :mandatory => false, :type => :boolean,
+                         :default   => false }
         }
         check_parameters(params, params_desc)
         root     = params[:root]
@@ -555,13 +562,17 @@ module Bee
       def move(params)
         # check parameters and set default values
         params_desc = {
-          :root     => { :mandatory => false, :type => :string, :default => '.' },
+          :root     => { :mandatory => false, :type => :string,
+                         :default   => '.' },
           :includes => { :mandatory => false, :type => :string_or_array },
           :excludes => { :mandatory => false, :type => :string_or_array },
           :dest     => { :mandatory => true,  :type => :string },
-          :flatten  => { :mandatory => false, :type => :boolean, :default => false },
-          :dotmatch => { :mandatory => false, :type => :boolean, :default => false },
-          :lenient  => { :mandatory => false, :type => :boolean, :default => false }
+          :flatten  => { :mandatory => false, :type => :boolean,
+                         :default   => false },
+          :dotmatch => { :mandatory => false, :type => :boolean,
+                         :default   => false },
+          :lenient  => { :mandatory => false, :type => :boolean,
+                         :default   => false }
         }
         check_parameters(params, params_desc)
         root     = params[:root]
@@ -715,11 +726,13 @@ module Bee
       #      property: "image_files"
       def find(params)
         params_desc = {
-          :root     => { :mandatory => false, :type => :string, :default => '.' },
+          :root     => { :mandatory => false, :type => :string,
+                         :default => '.' },
           :includes => { :mandatory => false, :type => :string_or_array },
           :excludes => { :mandatory => false, :type => :string_or_array },
           :property => { :mandatory => true,  :type => :string },
-          :dotmatch => { :mandatory => false, :type => :boolean, :default => false },
+          :dotmatch => { :mandatory => false, :type => :boolean,
+                         :default => false },
           :join     => { :mandatory => false, :type => :string }
         }
         check_parameters(params, params_desc)
@@ -736,6 +749,59 @@ module Bee
         @build.context.set_property(property, files)
       end
 
+      # 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.
+      # 
+      # Example
+      #
+      #  - yaml_load:
+      #      prop: "my_list"
+      #      file: "my_list.yml"
+      def yaml_load(params)
+        params_desc = {
+          :prop  => { :mandatory => true, :type => :string },
+          :file  => { :mandatory => true, :type => :string }
+        }
+        check_parameters(params, params_desc)
+        prop = params[:prop]
+        file = params[:file]
+        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
+          error "Error loading YAML file '#{file}': #{$!}"
+        end
+      end      
+
+      # Dump the content of a given property into a YAML file.
+      # 
+      # - prop: the property to dump.
+      # - file: the YAML file name to dump into.
+      # 
+      # Example
+      #
+      #  - yaml_dump:
+      #      prop: "my_list"
+      #      file: "my_list.yml"
+      def yaml_dump(params)
+        params_desc = {
+          :prop  => { :mandatory => true, :type => :string },
+          :file  => { :mandatory => true, :type => :string }
+        }
+        check_parameters(params, params_desc)
+        prop = params[:prop]
+        file = params[:file]
+        script = "File.open('#{file}', 'w') {|f| f.write(YAML.dump(#{prop}))}"
+        begin
+          @build.context.evaluate_script(script)
+        rescue
+          error "Error dumping YAML file '#{file}': #{$!}"
+        end
+      end      
+
       ######################################################################
       #                        RUBY RELATED TASKS                          #
       ######################################################################
@@ -803,8 +869,10 @@ module Bee
           :root     => { :mandatory => false, :type => :string },
           :includes => { :mandatory => true,  :type => :string },
           :excludes => { :mandatory => false, :type => :string },
-          :dotmatch => { :mandatory => false, :type => :boolean, :default => false },
-          :dir      => { :mandatory => false, :type => :string, :default => '.' }
+          :dotmatch => { :mandatory => false, :type => :boolean,
+                         :default => false },
+          :dir      => { :mandatory => false, :type => :string,
+                         :default => '.' }
         }
         check_parameters(params, params_desc)
         root     = params[:root]
@@ -838,6 +906,14 @@ module Bee
       # - src: ERB file name (if no 'source').
       # - dest: file where to store result (if no 'property').
       # - property: property name where to store result (if no 'dest').
+      # - options: ERB options, a String containing one or more of the
+      #   following modifiers:
+      #   %  enables Ruby code processing for lines beginning with %
+      #   <> omit newline for lines starting with <% and ending in %>
+      #   >  omit newline for lines ending in %>
+      #
+      # For more information ebout ERB syntax, please see documentation at:
+      # http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/.
       # 
       # Example
       # 
@@ -853,13 +929,15 @@ module Bee
           :source   => { :mandatory => false, :type => :string },
           :src      => { :mandatory => false, :type => :string },
           :dest     => { :mandatory => false, :type => :string },
-          :property => { :mandatory => false, :type => :string }
+          :property => { :mandatory => false, :type => :string },
+          :options  => { :mandatory => false, :type => :string }
         }
         check_parameters(params, params_desc)
         source   = params[:source]
         src      = params[:src]
         dest     = params[:dest]
         property = params[:property]
+        options  = params[:options]
         error "Must pass one of 'source' or 'src' parameters to erb task" if
           not source and not src
         error "Must pass one of 'dest' or 'property' parameters to erb task" if
@@ -869,7 +947,11 @@ module Bee
            not File.readable?(src))
         # load ERB source
         erb_source = source||File.read(src)
-        template = ERB.new(erb_source)
+        if options
+          template = ERB.new(erb_source, 0, options)
+        else
+          template = ERB.new(erb_source)
+        end
         if src
           puts "Processing ERB '#{src}'"
         else
@@ -1347,6 +1429,78 @@ module Bee
         end
       end
       
+      ######################################################################
+      #                             CONSTRUCTS                             #
+      ######################################################################
+    
+      # 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.
+      #
+      # Example
+      #
+      #   - if: RUBY_PLATFORM =~ /darwin/
+      #     then:
+      #       - print: Hello, I'm a Mac
+      #     else:
+      #       - print: Hello, I'm a PC
+      def if
+      end
+
+      # While construct will run the block in the 'do' entry while the
+      # condition in the 'while' entry is true.
+      #
+      # - while: the condition to evaluate. This is a Ruby expression evaluated
+      #   in the build context.
+      # - do: the block to run while the condition is true.
+      #
+      # Example:
+      #
+      #   - while: i > 0
+      #     do:
+      #       - print: :i
+      #       - rb: i -= 1
+      def while
+      end
+
+      # For construct iterates on a list in the 'in' entry, putting values in
+      # 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.
+      # - do: the block to run at each iteration.
+      #
+      # Example
+      #
+      #   - for: file
+      #     in:  [foo, bar]
+      #     do:
+      #       - print: "Creating #{file}..."
+      #       - touch: :file
+      #
+      # To iterate five times, we could write (using a Ruby Range):
+      #
+      #   - for: i
+      #     in:  (1..5)
+      #     do:
+      #       - print: :i
+      #
+      # To iterate on files in current directory, we could write:
+      #
+      #   - for: file
+      #     in:  "Dir.glob('*')"
+      #     do:
+      #       - print: :file
+      def for
+      end
+
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bee
 version: !ruby/object:Gem::Version 
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors: 
 - Michel Casabianca & Contributors
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-03 00:00:00 +01:00
+date: 2010-02-08 00:00:00 +01:00
 default_executable: bee
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,28 +42,28 @@ extra_rdoc_files:
 - README
 - LICENSE
 files: 
-- bin/bee
 - bin/bee.bat
-- lib/bee.rb
+- bin/bee
 - lib/bee_console.rb
 - lib/bee_task.rb
 - lib/bee_task_default.rb
 - lib/bee_util.rb
-- egg/package/bee_task.erb
+- lib/bee.rb
+- egg/package.yml
+- egg/package/test.erb
+- egg/package/test_suite.rb
+- egg/package/gem_spec.erb
 - egg/package/build.erb
-- egg/package/egg.yml
-- egg/package/egg_build.erb
-- egg/package/egg_launcher.erb
 - egg/package/egg_script.rb
-- egg/package/gem_spec.erb
 - egg/package/license
+- egg/package/egg_launcher.erb
 - egg/package/readme.erb
-- egg/package/test.erb
+- egg/package/bee_task.erb
+- egg/package/egg.yml
 - egg/package/test_build.erb
-- egg/package/test_build.rb
+- egg/package/egg_build.erb
 - egg/package/test_build_listener.rb
-- egg/package/test_suite.rb
-- egg/package.yml
+- egg/package/test_build.rb
 - README
 - LICENSE
 has_rdoc: true