bee 0.3.1 → 0.4.0

data/lib/bee_task_default.rb

@@ -0,0 +1,525 @@
+# 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.
+
+require 'bee'
+require 'bee_task'
+require 'bee_util'
+
+module Bee
+  
+  module Task
+  
+    # Package for default tasks (tasks with no package).
+    class Default < Package
+    
+      include Bee::Util::FileSelector
+      
+      # Print a message on console. If message is a string, it is printed
+      # on standard output, if message is another Ruby object, this task
+      # outputs its inspected value instead.
+      # 
+      # - message: message to print.
+      # 
+      # Example
+      # 
+      #  - print: "Hello World!"
+      def print(message)
+        case message
+        when String
+          puts message
+        else
+          puts message.inspect
+        end
+      end
+      
+      # Print contents of a given file on the console. Parameter is the name
+      # of the file to output, as a String.
+      # 
+      # Example
+      # 
+      #  - cat: "doc/welcome-message.txt"
+      def cat(file)
+        file = file
+        error "Parameter must be a String" unless file.kind_of?(String)
+        error "File '#{file}' not found" unless 
+        File.exists?(file) or File.directory?(file)
+        puts File.read(file).strip
+      end
+      
+      # Change working directory. This change will persist for all tasks in
+      # the target but not in other targets. Parameter is a String with 
+      # directory to change to.
+      # 
+      # Example
+      # 
+      #  - cd: "build"
+      def cd(dir)
+        dir = dir
+        error "cd parameter is a String" unless dir.kind_of?(String)
+        Dir.chdir(dir)
+      end
+      
+      # Make a directory and parent directories if necessary. Doesn't complain 
+      # if directory already exists. Parameter is directory to create as a 
+      # String or a list of directories as Strings.
+      # 
+      # Example
+      # 
+      #  - mkdir: "foo/bar"
+      #  - mkdir: ["foo", "bar"]
+      def mkdir(dirs)
+        require 'fileutils'
+        dirs = dirs
+        error "mkdir parameter must a String or an array of Strings" unless
+        dirs.kind_of?(String) or dirs.kind_of?(Array)
+        for dir in dirs
+          error "mkdir parameter must a String or an array of Strings" unless
+          dir.kind_of?(String)
+          FileUtils.makedirs(dir)
+        end
+      end
+      
+      # Copy files or directories to destination file or directory. Parameter 
+      # is a Hash with following entries:
+      # 
+      # - includes: glob or list of globs for source files or directories to
+      #   include.
+      # - excludes: glob or list of globs for source files or directories to
+      #   exclude.
+      # - dest: destination file or directory.
+      # 
+      # Example
+      # 
+      #  - cp:
+      #      includes: "doc/img/**/*"
+      #      excludes: ["**/*.bmp", "**/*.psd"]
+      #      dest: :doc
+      def cp(params)
+        require 'fileutils'
+        params_desc = {
+          'includes' => :mandatory,
+          'excludes' => :optional,
+          'dest' => :mandatory
+        }
+        check_task_parameters(params, params_desc)
+        includes = params['includes']
+        excludes = params['excludes']
+        dest = params['dest']
+        error "cp 'dest' parameter must a String" unless dest.kind_of?(String)
+        files = select_files(includes, excludes)
+        files = files[0] if files.length == 1
+        FileUtils.cp_r(files, dest)
+      end
+      
+      # Move source file(s) or directory(ies) to dest file or directory. 
+      # Parameter is a Hash with following entries:
+      # 
+      # - includes: glob or list of globs for files or directories to move.
+      # - excludes: glob or list of globs for files or directories that should
+      #   not move.
+      # - dest: file or directory to move file(s) to.
+      # 
+      # Example
+      # 
+      #  - mv: { includes: "**/*~", dest: "trash" }
+      def mv(params)
+        require 'fileutils'
+        params_desc = {
+          'includes' => :mandatory,
+          'excludes' => :optional,
+          'dest' => :mandatory
+        }
+        check_task_parameters(params, params_desc)
+        includes = params['includes']
+        excludes = params['excludes']
+        dest = params['dest']
+        error "mv 'dest' parameter must a String" unless dest.kind_of?(String)
+        files = select_files(includes, excludes)
+        files = files[0] if files.length == 1
+        FileUtils.mv(files, dest)
+      end
+      
+      # Delete files for a given glob or list of globs. Parameter is a glob or 
+      # list of globs for files to delete.
+      # 
+      # Example
+      # 
+      #  - rm: "**/*.bak"
+      #  - rm: ["**/*~", "**/.DS_Store"]
+      def rm(globs)
+        require 'fileutils'
+        globs = globs
+        error "rm parameter is a String or Array of Strings" unless
+          globs.kind_of?(String) or globs.kind_of?(Array)
+        for glob in globs
+          error "rm parameter is a String or Array of Strings" unless
+            glob.kind_of?(String)
+          files = Dir.glob(glob)
+          for file in files
+            FileUtils.rm_f(file)
+          end
+        end
+      end
+      
+      # Delete directories recursively. Parameter is a string for glob of
+      # directories to delete.
+      # 
+      # Example
+      # 
+      #  - rmdir: :build
+      def rmdir(globs)
+        require 'fileutils'
+        globs = globs
+        error "rmdir parameter is a String or an Array of Strings" unless
+          globs.kind_of?(String) or globs.kind_of?(Array)
+        for glob in globs
+          error "rmdir parameter is a String or an Array of Strings" unless
+            glob.kind_of?(String)
+          dirs = Dir.glob(glob)
+          for dir in dirs
+            FileUtils.rm_rf(dir)
+          end
+        end
+      end
+      
+      # Find files for a glob or list of globs and store list in a property. 
+      # Parameter is a Hash with entries:
+      # 
+      # - includes: glob or list of globs for files to look for.
+      # - excludes: glob or list of globs for files to exclude from search.
+      # - property: name of the property to set.
+      # 
+      # Example
+      # 
+      #  - find: { includes: "**/*.rb", property: "rb_files_to_check" }
+      #  - find:
+      #      - includes: "doc/img/**/*"
+      #      - excludes: "**/*.psd"
+      #      - property: "image_files"
+      def find(parameters)
+        params_desc = {
+          'includes' => :mandatory,
+          'excludes' => :optional,
+          'property' => :mandatory
+        }
+        check_task_parameters(parameters, params_desc)
+        includes = parameters['includes']
+        excludes = parameters['excludes']
+        property = parameters['property']
+        files = select_files(includes, excludes)
+        @build.context.set_property(property, files)
+      end
+      
+      # Run a set of tests selected using globs. Parameter is a glob or list of
+      # globs for files or directories to run.
+      # 
+      # Example
+      # 
+      #  - test: "**/tc_*.rb"
+      # 
+      # FIXME
+      # 
+      # if tasks runs twice, it will run twice loaded tests...
+      def test(globs)
+        require 'test/unit'
+        require 'test/unit/testresult'
+        files = []
+        globs = globs
+        error "test parameter must be a String or a list of Strings" unless
+          globs.kind_of?(String) or globs.kind_of?(Array)
+        for glob in globs
+          error "Parameter must be a String or a list of Strings" unless
+            glob.kind_of?(String)
+          files += Dir.glob(glob)
+        end
+        for file in files
+          load file
+        end
+        Test::Unit::AutoRunner.run
+      end
+      
+      # Run an ERB file or source in bee context and store result in a file or
+      # property. Parameter is a Hash with following entries:
+      # 
+      # - source: ERB source text (if no 'src').
+      # - 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').
+      # 
+      # Example
+      # 
+      #  - erb: { src: "gem.spec.erb", dest: "gem.spec" }
+      # 
+      # Notes
+      # 
+      # In these ERB files, you can access a property _foo_ writing:
+      # 
+      #  <p>Hello <%= foo %>!</p>
+      def erb(params)
+        require 'erb'
+        # check parameters
+        params_desc = {
+          'source' => :optional,
+          'src'   => :optional,
+          'dest' => :optional,
+          'property' => :optional
+        }
+        check_task_parameters(params, params_desc)
+        source = params['source']
+        error "erb 'source' parameter must be a String" unless 
+          source.kind_of?(String) or source == nil
+        src = params['src']
+        error "erb 'src' parameter must be a String" unless 
+          src.kind_of?(String) or src == nil
+        dest = params['dest']
+        error "erb 'dest' parameter must be a String" unless
+          dest.kind_of?(String) or dest == nil
+        property = params['property']
+        error "erb 'property' parameter must be a String" unless
+          property.kind_of?(String) or property == nil
+        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
+          not dest and not property
+        # load ERB source
+        erb_source = source||File.read(src)
+        template = ERB.new(erb_source)
+        begin
+          result = template.result(@build.context.context_binding)
+        rescue
+          error "Error processing ERB: #{$!}"
+        end
+        # write result in file or set property
+        if dest
+          File.open(dest, 'w') { |file| file.write(result) }
+        else
+          @build.context.set_property(property, result)
+        end
+      end
+      
+      # Generate RDoc documentation for a given list of globs to include or
+      # exclude and a destination directory. Parameter is a Hash with following
+      # entries:
+      # 
+      # - includes: glob or list of globs for files to document.
+      # - excludes: glob or list of globs for files that should not be
+      #   documented.
+      # - dest: destination directory for generated documentation.
+      # - options: additional options as a string or list of strings.
+      # 
+      # Example
+      # 
+      #  - rdoc:
+      #      includes: ["README", "LICENSE", :src]
+      #      dest: :api
+      def rdoc(parameters)
+        require 'rdoc/rdoc'
+        params_desc = {
+          'includes' => :mandatory,
+          'excludes' => :optional,
+          'dest' => :mandatory,
+          'options' => :optional
+        }
+        check_task_parameters(parameters, params_desc)
+        includes = parameters['includes']
+        excludes = parameters['excludes']
+        dest = parameters['dest']
+        options = parameters['options']
+        error "rdoc 'dest' parameter must be a String" unless 
+          dest.kind_of?(String)
+        files = select_files(includes, excludes)
+        command_line = ['-S', '-o', dest]
+        command_line << options if options
+        command_line += files
+        rdoc = RDoc::RDoc.new
+        rdoc.document(command_line)
+      end
+      
+      # Generate a Gem package. Parameter is the name of the Gem description 
+      # file. Resulting Gem package is generated in current directory (as with
+      # command line tool).
+      # 
+      # Example
+      # 
+      #  - gembuild: :gem_spec
+      def gembuild(description)
+        require 'rubygems'
+        description = description
+        arguments = ['build', description]
+        Gem.manage_gems
+        Gem::GemRunner.new.run(arguments)
+      end
+      
+      # Generate a ZIP archive. Parameter is a Hash with following entries:
+      # 
+      # - includes: glob or list of globs for files to select for the archive.
+      # - excludes: glob or list of globs for files to exclude from the archive.
+      # - dest: the archive file to generate.
+      # - prefix: prefix for archive entries (default to nil).
+      # 
+      # Example
+      # 
+      #  - zip:
+      #      includes: "**/*"
+      #      excludes: ["build", "build/**/*", "**/*~"]
+      #      dest: :zip_archive
+      # 
+      # Note
+      # 
+      # If archive already exists, files are added to the archive.
+      def zip(parameters)
+        require 'zip/zip'
+        # parse parameters
+        params_desc = {
+          'includes' => :mandatory,
+          'excludes' => :optional,
+          'dest' => :mandatory,
+          'prefix' => :optional
+        }
+        check_task_parameters(parameters, params_desc)
+        includes = parameters['includes']
+        excludes = parameters['excludes']
+        dest = parameters['dest']
+        error "zip 'dest' parameter must be a String" unless
+          dest.kind_of?(String)
+        prefix = parameters['prefix']
+        error "zip 'prefix' parameter must be a String" unless
+          !prefix or prefix.kind_of?(String)
+        files = select_files(includes, excludes)
+        # build the archive
+        zipfile = Zip::ZipFile.open(dest, Zip::ZipFile::CREATE) do |zip|
+          for file in files
+            entry = prefix ? File.join(prefix, file) : file
+            puts "Adding '#{entry}'"
+            zip.add(entry, file)
+          end
+          zip.close
+        end
+      end
+      
+      # Generate a TAR archive. Parameter is a Hash with following entries:
+      # 
+      # - includes: glob or list of globs for files to select for the archive.
+      # - excludes: glob or list of globs for files to exclude from the archive.
+      # - dest: the archive file to generate.
+      # 
+      # Example
+      # 
+      #  - tar:
+      #      includes: "**/*"
+      #      excludes: ["build", "build/**/*", "**/*~"]
+      #      dest: :tar_archive
+      # 
+      # Note
+      # 
+      # If archive already exists, its is overwritten.
+      def tar(parameters)
+        require 'archive/tar/minitar'
+        # parse parameters
+        params_desc = {
+          'includes' => :mandatory,
+          'excludes' => :optional,
+          'dest' => :mandatory
+        }
+        check_task_parameters(parameters, params_desc)
+        includes = parameters['includes']
+        excludes = parameters['excludes']
+        dest = parameters['dest']
+        error "tar 'dest' parameter must be a String" unless
+          dest.kind_of?(String)
+        files = select_files(includes, excludes)
+        # build the archive
+        Archive::Tar::Minitar::Output.open(dest) do |tarfile|
+          for file in files
+            puts "Adding '#{file}'"
+            Archive::Tar::Minitar.pack_file(file, tarfile)
+          end
+        end
+      end
+      
+      # Generate a GZIP archive for a given file. Parameter is a Hash with
+      # following entries:
+      # 
+      # - src: source file to generate GZIP for.
+      # - dest: GZIP file to generate.
+      # 
+      # Example
+      # 
+      #  - gzip:
+      #      src: "dist.tar"
+      #      dest: "dist.tar.gz"
+      def gzip(parameters)
+        require 'zlib'
+        # parse parameters
+        params_desc = {
+          'src' => :mandatory,
+          'dest' => :mandatory
+        }
+        check_task_parameters(parameters, params_desc)
+        src = parameters['src']
+        dest = parameters['dest']
+        # compress file
+        File.open(src) do |input|
+          output = Zlib::GzipWriter.new(File.open(dest, 'wb'))
+          output.write(input.read)
+          output.close
+        end
+      end
+
+      # Generate a TAR.GZ archive. Parameter is a Hash with following entries:
+      # 
+      # - includes: glob or list of globs for files to select for the archive.
+      # - excludes: glob or list of globs for files to exclude from the archive.
+      # - dest: the archive file to generate.
+      # 
+      # Example
+      # 
+      #  - targz:
+      #      includes: "**/*"
+      #      excludes: ["build", "build/**/*", "**/*~"]
+      #      dest: :targz_archive
+      # 
+      # Note
+      # 
+      # If archive already exists, its is overwritten.
+      def targz(parameters)
+        require 'archive/tar/minitar'
+        require 'zlib'
+        # parse parameters
+        params_desc = {
+          'includes' => :mandatory,
+          'excludes' => :optional,
+          'dest' => :mandatory
+        }
+        check_task_parameters(parameters, params_desc)
+        includes = parameters['includes']
+        excludes = parameters['excludes']
+        dest = parameters['dest']
+        error "targz 'dest' parameter must be a String" unless
+          dest.kind_of?(String)
+        files = select_files(includes, excludes)
+        # build the archive
+        Archive::Tar::Minitar::Output.open(Zlib::GzipWriter.new(File.open(dest, 'wb'))) do |tgz|
+          for file in files
+            puts "Adding '#{file}'"
+            Archive::Tar::Minitar.pack_file(file, tgz)
+          end
+        end
+      end
+
+    end
+
+  end
+
+end