bee 0.11.2 → 0.11.3

data/README

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

data/lib/bee_build.rb

@@ -38,7 +38,8 @@ module Bee
       'description' => :optional,
       'context'     => :optional,
       'extends'     => :optional,
-      'abstract'    => :optional
+      'abstract'    => :optional,
+      'alias'       => :optional
     }
 
     # Build file.
@@ -189,12 +190,17 @@ module Bee
       end
       error "Duplicate build info" if @name
       @name = entry['build']
-      @targets.default = entry['default']
+      # check that 'default' entry is a string or an array
+      error "'default' entry of the 'build' block must be a string or an array" if
+        entry['default'] and (!entry['default'].kind_of?(String) and
+                              !entry['default'].kind_of?(Array))
+      @targets.default = Array(entry['default']) if entry['default']
+      # check that 'alias' entry is a hash
+      error "'alias' entry of the 'build' block must be a hash" if
+        entry['alias'] and !entry['alias'].kind_of?(Hash)
+      @targets.alias = entry['alias'] if entry['alias']
       @description = entry['description']
       @abstract = entry['abstract']
-      # check that 'default' entry is a string
-      error "'default' entry of the 'build' block must be a string" if
-        @targets.default and !@targets.default.kind_of?(String)
       # load parents build if any
       parents = Array(entry['extends'])
       if parents.length > 0

data/lib/bee_console.rb

@@ -44,6 +44,7 @@ Usage: bee [options] [targets]
 -f file        Build file to run (defaults to "build.yml").
 -r             Look for build file recursively up in file system.
 -l             Print bee logo on console.
+-R resource    Print given resource (such as ':bee:clean.yml') on console.
 -a             Print list of available targets.
 -o             Print list of available options.
 -x             Print list of available tasks.
@@ -67,6 +68,7 @@ EOF
         ['--file', '-f', GetoptLong::REQUIRED_ARGUMENT],
         ['--recursive', '-r', GetoptLong::NO_ARGUMENT],
         ['--logo', '-l', GetoptLong::NO_ARGUMENT],
+        ['--resource', '-R', GetoptLong::REQUIRED_ARGUMENT],
         ['--targets', '-a', GetoptLong::NO_ARGUMENT],
         ['--options', '-o', GetoptLong::NO_ARGUMENT],
         ['--tasks', '-x', GetoptLong::NO_ARGUMENT],
@@ -113,6 +115,7 @@ EOF
       file = DEFAULT_BUILD_FILE
       recursive = false
       logo = false
+      resource = nil
       print_targets = false
       print_options = false
       print_tasks = false
@@ -162,6 +165,8 @@ EOF
           recursive = true
         when '--logo'
           logo = true
+        when '--resource'
+          resource = arg
         when '--targets'
           print_targets = true
         when '--options'
@@ -176,8 +181,8 @@ EOF
       ARGV.replace(old_argv)
       return version, help, help_build, help_task, task, help_template,
              template, properties, dry_run, verbose, style, color, file,
-             recursive, logo, print_targets, print_options, print_tasks,
-             print_templates, targets
+             recursive, logo, resource, print_targets, print_options,
+             print_tasks, print_templates, targets
     end
 
     # Parse a command line property.
@@ -202,8 +207,8 @@ EOF
       begin
         version, help, help_build, help_task, task, help_template,
           template, properties, dry_run, verbose, style, color, file,
-          recursive, logo, print_targets, print_options, print_tasks,
-          print_templates, targets = parse_command_line(arguments)
+          recursive, logo, resource, print_targets, print_options,
+          print_tasks, print_templates, targets = parse_command_line(arguments)
       rescue
         puts "ERROR: parsing command line: #{$!}"
         exit(EXIT_PARSING_CMDLINE)
@@ -232,10 +237,19 @@ EOF
           listener = Listener.new(formatter)
           build = Build.load(file, false, properties)
           build.run(targets, listener, dry_run)
+        elsif resource
+          raise Bee::Util::BuildError.new("'#{resource}' is not a valid resource") if
+            !Util::resource?(resource)
+          begin
+            puts File.read(Bee::Util::resource_path(resource))
+          rescue Exception
+            raise Bee::Util::BuildError.new("Resource '#{resource}' not found")
+          end
         elsif print_targets
           begin
             build = Build.load(file)
             targets = build.targets.hash.keys
+            targets += build.targets.alias.keys if build.targets.alias
           rescue Exception
             targets = []
           end

data/lib/bee_console_formatter.rb

@@ -215,7 +215,7 @@ module Bee
           help << "build: #{build.name}\n"
         end
         if build.extends
-          help << "extends: #{build.extends.map{|b| b.name}.join(', ')}\n"
+          help << "extends: #{format_list(build.extends.map{|b| b.name})}\n"
         end
         if build.description
           help << format_description('description', build.description, 0, false)
@@ -237,7 +237,15 @@ module Bee
           end
         end
         # print default target
-        help << "default: #{build.targets.default}\n"
+        help << "default: #{format_list(build.targets.default)}\n" if
+          build.targets.default
+        # print alias for targets
+        if build.targets.alias and build.targets.alias.keys.length > 0
+          help << "alias:\n"
+          for name in build.targets.alias.keys.sort
+            help << "  #{name}: #{format_list(build.targets.alias[name])}\n"
+          end
+        end
         return help.strip
       end
 
@@ -320,6 +328,18 @@ module Bee
         end
       end
 
+      def format_list(list)
+        if list.kind_of?(Array)
+          if list.length > 1
+            return "[#{list.join(', ')}]"
+          else
+            return list[0]
+          end
+        else
+          return list
+        end
+      end
+
     end
 
   end

data/lib/bee_targets.rb

@@ -31,6 +31,8 @@ module Bee
     attr_reader :already_run
     # Default target.
     attr_accessor :default
+    # Alias for targets
+    attr_accessor :alias
 
     # Constructor.
     # - build: build object.
@@ -51,7 +53,7 @@ module Bee
       error "Duplicate target definition: '#{target.name}'" if
         @hash.has_key?(target.name)
       @hash[target.name] = [target]
-      @default = target.name if !@default
+      # record first target for default
     end
 
     # Extend parent targets.
@@ -85,6 +87,17 @@ module Bee
       end
       # set default default target to parent one if none was set
       @default = @default || parent.default
+      # manage alias
+      if parent.alias
+        @alias = {} if !@alias
+        for key in parent.alias.keys
+          if @alias.has_key?(key)
+            @alias[key] = Array(@alias[key]) + Array(parent.alias[key])
+          else
+            @alias[key] = Array(parent.alias[key])
+          end
+        end
+      end
     end
 
     # Run a given target.
@@ -101,9 +114,22 @@ module Bee
     # 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
+      if targets.length == 0
+        if @default
+          targets = @default
+        else
+          error "No default target given"
+        end
+      end
+      aliased_targets = []
       for target in targets
+        if @alias and @alias.has_key?(target)
+          aliased_targets += Array(@alias[target])
+        else
+          aliased_targets << target
+        end
+      end
+      for target in aliased_targets
         run_target(target, dry)
         @already_run.clear
       end

data/lib/bee_task_default.rb

@@ -556,12 +556,15 @@ EOF
       #   '**/*' to include all files recursively.
       # - excludes: list of globs for files to exclude from copy. Optional,
       #   default to nil to exclude no file.
-      # - dest: destination directory for the copy, must be an existing
-      #   directory.
       # - dotmatch: tells if joker matches dot files. Optional, defaults to
       #   false.
       # - flatten: tells if included files should be copied in destination
       #   directory, ignoring their subdirectory. Optional, defaults to false.
+      # - sets: a single or list of sets made of root, includes, excludes,
+      #   dotmatch and flatten entries, as defined previously. Can be defined
+      #   only if no root, includes, excludes, dotmatch or flatten are defined.
+      # - dest: destination directory for the copy, must be an existing
+      #   directory.
       # - lenient: tells if copy is lenient, which will silently succeed on
       #   errors (for instance if root or destination directory don't exist).
       #   Optional, defaults to false.
@@ -576,21 +579,32 @@ EOF
       #       includes: **/*
       #       excludes: **/CVS/**/*
       #       dest:     destination
+      # 
+      # Example:
+      # 
+      # With sets, you could write :
+      # 
+      #   - copy:
+      #       sets:
+      #         - root:     src
+      #           excludes: **/CVS/**/*
+      #         - root:     res
+      #           includes: **/*.properties
+      #       dest: destination
       #
       # Note: this task only deals with files. Thus, 'includes' and 'excludes'
       # globs should be ones for files.
       def copy(params)
         # check parameters and set default values
         params_desc = {
-          :root     => { :mandatory => false, :type => :string,
-                         :default   => '.' },
+          :root     => { :mandatory => false, :type => :string },
           :includes => { :mandatory => false, :type => :string_or_array },
           :excludes => { :mandatory => false, :type => :string_or_array },
+          :dotmatch => { :mandatory => false, :type => :boolean },
+          :sets     => { :mandatory => false, :type => :hash_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 }
         }
@@ -598,18 +612,12 @@ EOF
         root     = params[:root]
         includes = params[:includes]
         excludes = params[:excludes]
+        dotmatch = params[:dotmatch]
+        sets     = params[:sets]
         dest     = params[:dest]
         flatten  = params[:flatten]
-        dotmatch = params[:dotmatch]
         lenient  = params[:lenient]
-        # check that root and dest are existing directories
-        if not (File.exists?(root) and File.directory?(root))
-          if lenient
-            return
-          else
-            error "copy 'root' parameter must be an existing directory"
-          end
-        end
+        # check that destination is an existing directory
         if not (File.exists?(dest) and File.directory?(dest))
           if lenient
             return
@@ -617,19 +625,43 @@ EOF
             error "copy 'dest' parameter must be an existing directory"
           end
         end
-        # select files and copy
-        files = filter_files(includes, excludes, root, dotmatch)
-        puts "Copying #{files.length} file(s) to '#{dest}'"
-        for file in files
-          from_file = File.join(root, file)
-          if flatten
-            to_file = File.join(dest, File.basename(file))
-          else
-            to_file = File.join(dest, file)
+        # if no sets defined
+        if sets == nil
+          root = '.' if root == nil
+          dotmatch = false if dotmatch == nil
+          if not (File.exists?(root) and File.directory?(root))
+            if lenient
+              return
+            else
+              error "copy 'root' parameter must be an existing directory"
+            end
+          end
+          files = filter_files(root, includes, excludes, dotmatch)
+          copy_files(root, files, dest, flatten)
+        # if sets are defined
+        else
+          for _set in sets
+            _unknown = _set.keys - ['root', 'includes', 'excludes', 'dotmatch', 'flatten']
+            error "copy 'sets' parameter has unknown entry #{_unknown.join(', ')}" if
+              _unknown.size > 0
+            _root = _set['root']
+            _root = '.' if _root == nil
+            if not (File.exists?(_root) and File.directory?(_root))
+              if lenient
+                continue
+              else
+                error "copy 'root' entries of 'sets' parameter must be an existing directory"
+              end
+            end
+            _includes = _set['includes']
+            _excludes = _set['excludes']
+            _dotmatch = _set['dotmatch']
+            _dotmatch = false if _dotmatch == nil
+            _flatten  = _set['flatten']
+            _flatten  = false if _flatten == nil
+            _files = filter_files(_root, _includes, _excludes, _dotmatch)
+            copy_files(_root, _files, dest, _flatten)
           end
-          to_dir    = File.dirname(to_file)
-          FileUtils.makedirs(to_dir) if not File.exists?(to_dir)
-          FileUtils.cp(from_file, to_file)
         end
       end
 
@@ -702,7 +734,7 @@ EOF
           end
         end
         # select files and make move
-        files = filter_files(includes, excludes, root, dotmatch)
+        files = filter_files(root, includes, excludes, dotmatch)
         puts "Moving #{files.length} file(s) to '#{dest}'"
         for file in files
           from_file = File.join(root, file)
@@ -847,7 +879,7 @@ EOF
         property = params[:property]
         dotmatch = params[:dotmatch]
         join     = params[:join]
-        files = filter_files(includes, excludes, root, dotmatch)
+        files = filter_files(root, includes, excludes, dotmatch)
         if join
           files = files.join(join)
         end
@@ -978,7 +1010,7 @@ EOF
         dir      = params[:dir]
         error "Test directory '#{dir}' not found" if 
           not (File.exists?(dir) and File.directory?(dir))
-        files = filter_files(includes, excludes, root, dotmatch)
+        files = filter_files(root, includes, excludes, dotmatch)
         files.map! { |file| File.expand_path(File.join(root, file)) }
         for file in files
           load file
@@ -1109,7 +1141,7 @@ EOF
         dotmatch = params[:dotmatch]
         dest     = params[:dest]
         options  = params[:options]
-        files = filter_files(includes, excludes, root, dotmatch)
+        files = filter_files(root, includes, excludes, dotmatch)
         command_line = ['-S', '-o', dest]
         command_line += options if options
         command_line += files
@@ -1228,7 +1260,7 @@ EOF
         dotmatch = parameters[:dotmatch]
         dest     = parameters[:dest]
         prefix   = parameters[:prefix]
-        files = filter_files(includes, excludes, root, dotmatch)
+        files = filter_files(root, includes, excludes, dotmatch)
         # build the archive
         puts "Building ZIP archive '#{dest}'"
         begin
@@ -1329,7 +1361,7 @@ EOF
         excludes = parameters[:excludes]
         dotmatch = parameters[:dotmatch]
         dest     = parameters[:dest]
-        files = filter_files(includes, excludes, root, dotmatch)
+        files = filter_files(root, includes, excludes, dotmatch)
         # build the archive
         puts "Processing TAR archive '#{dest}'"
         begin
@@ -1476,7 +1508,7 @@ EOF
         excludes = parameters[:excludes]
         dotmatch = parameters[:dotmatch]
         dest     = parameters[:dest]
-        files = filter_files(includes, excludes, root, dotmatch)
+        files = filter_files(root, includes, excludes, dotmatch)
         # build the archive
         puts "Building TARGZ archive '#{dest}'"
         begin

data/lib/bee_task_package.rb

@@ -87,6 +87,14 @@ module Bee
             when :hash
               error "#{task} '#{param}' parameter must be a hash" unless
                 params[param.to_s].kind_of?(Hash)
+            when :hash_or_array
+              error "#{task} '#{param}' parameter must be a hash or list of hashes" unless
+                params[param.to_s].kind_of?(Hash) or params[param.to_s].kind_of?(Array)
+              if params[param.to_s].kind_of?(Hash)
+                params[param.to_s] = [params[param.to_s]]
+              elsif !params[param.to_s].kind_of?(Array)
+                error "#{task} '#{param}' parameter must be a hash or a list of hashes"
+              end
             else
               error "Unknown parameter type '#{description[param][:type]}'"
             end
@@ -110,7 +118,7 @@ module Bee
       # - excludes: list of globs for files to exclude from search.
       # - dotmatch: tells if joker matches dot files.
       # Return: the list of found files (no directories included).
-      def filter_files(includes, excludes, root, dotmatch=true)
+      def filter_files(root, includes, excludes, dotmatch=true)
         error "includes must be a glob or a list of globs" unless
           !includes or includes.kind_of?(String) or includes.kind_of?(Array)
         error "excludes must be a glob or a list of globs" unless
@@ -156,6 +164,73 @@ module Bee
         end
       end
 
+      def evaluate_sets(root, includes, excludes, dotmatch, flatten, sets, lenient)
+        response = []
+        # check that no root and sets are defined at the same time
+        if (root || includes || excludes || dotmatch || flatten) && sets
+          error "Sets might not be used along with root, includes, excludes, dotmatch or flatten"
+        end
+        # if no sets defined
+        if sets == nil
+          root = '.' if root == nil
+          dotmatch = false if dotmatch == nil
+          flatten = false if flatten == nil
+          if not (File.exists?(root) and File.directory?(root))
+            if lenient
+              return
+            else
+              error "'root' parameter must be an existing directory"
+            end
+          end
+          response << {:files => filter_files(root, includes, excludes, dotmatch), :flatten => flatten}
+        # if sets are defined
+        else
+          for _set in sets
+            _unknown = _set.keys - ['root', 'includes', 'excludes', 'dotmatch', 'flatten']
+            error "'sets' parameter has unknown entry #{_unknown.join(', ')}" if
+              _unknown.size > 0
+            _root = _set['root']
+            _root = '.' if _root == nil
+            if not (File.exists?(_root) and File.directory?(_root))
+              if lenient
+                continue
+              else
+                error "'root' entries of 'sets' parameter must be an existing directory"
+              end
+            end
+            _includes = _set['includes']
+            _excludes = _set['excludes']
+            _dotmatch = _set['dotmatch']
+            _dotmatch = false if _dotmatch == nil
+            _flatten  = _set['flatten']
+            _flatten  = false if _flatten == nil
+            files += filter_files(_root, _includes, _excludes, _dotmatch)
+          end
+          response << {:files => files, :flatten => _flatten}
+        end
+        return response
+       end
+
+      # Copy a list of files to a given diretory:
+      # - root: root directory of source files.
+      # - files: a list of files to copy relative to root.
+      # - dest: destination directory.
+      # - flatten: tells if a flat copy is made.
+      def copy_files(root, files, dest, flatten)
+        puts "Copying #{files.length} file(s) to '#{dest}'"
+        for file in files
+          from_file = File.join(root, file)
+          if flatten
+            to_file = File.join(dest, File.basename(file))
+          else
+            to_file = File.join(dest, file)
+          end
+          to_dir    = File.dirname(to_file)
+          FileUtils.makedirs(to_dir) if not File.exists?(to_dir)
+          FileUtils.cp(from_file, to_file)
+        end
+      end
+
       # Print text on the console.
       # - text: text to print.
       def print(text)

data/lib/bee_version.rb

@@ -1,5 +1,5 @@
 module Bee
 
-    VERSION = '0.11.2'
+    VERSION = '0.11.3'
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bee
 version: !ruby/object:Gem::Version 
-  hash: 55
+  hash: 53
   prerelease: 
   segments: 
   - 0
   - 11
-  - 2
-  version: 0.11.2
+  - 3
+  version: 0.11.3
 platform: ruby
 authors: 
 - Michel Casabianca & Contributors
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-29 00:00:00 +01:00
+date: 2012-06-01 00:00:00 +02:00
 default_executable: bee
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -127,7 +127,6 @@ files:
 - egg/xmlrpc/client.rb
 - egg/xmlrpc/server.rb
 - egg/xmlrpc.yml
-- clean.yml
 - README
 - LICENSE
 has_rdoc: true

data/clean.yml

@@ -1,36 +0,0 @@
-# Copyright 2006-2012 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.
-
-# Build info
-- build:       bee
-  default:     clean
-  description: Parent build file to clean
-  abstract:    true
-
-# Build properties
-- properties:
-    build_dir: ~
-    clean_dirs:
-    - :build_dir
-    clean_files:
-    - "**/*~"
-    - "**/.#*#"
-
-# Build targets
-- target:      clean
-  description: Clean generated files
-  script:
-  - rmdir: :clean_dirs
-  - rm:    :clean_files
-