bee 0.3.0 → 0.3.1

data/README

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

data/lib/bee_default_context.rb

@@ -69,11 +69,17 @@ end
 # Make a directory and parent directories if necessary. Doesn't complain if
 # directory already exists.
 # - dir: directory to create.
-def mkdir(dir)
-  dir = evaluate_object(dir)
-  error "Parameter must be a String" unless dir.kind_of?(String)
-  require "fileutils"
-  FileUtils.makedirs(dir)
+def mkdir(dirs)
+  require 'fileutils'
+  dirs = evaluate_object(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
+    dir = evaluate_object(dir)
+    error "mkdir parameter must a String or an array of Strings" unless
+      dir.kind_of?(String)
+    FileUtils.makedirs(dir)
+  end
 end
 
 # Copy a files or directoris to destination file or directory. Parameter is a
@@ -88,14 +94,19 @@ def cp(params)
   }
   check_task_parameters(params, params_desc)
   src = evaluate_object(params['src'])
+  error "cp 'src' parameter must a glob or a list of globs" unless 
+    src.kind_of?(String) or src.kind_of?(Array)
   dest = evaluate_object(params['dest'])
+  error "cp 'dest' parameter must a glob or a list of globs" unless 
+    dest.kind_of?(String)
   files = []
   for element in src
+    error "cp 'src' parameter must a glob or a list of globs" unless 
+      element.kind_of?(String)
     files += Dir.glob(element)
   end
-  for file in files
-    FileUtils.cp_r(file, dest)
-  end
+  files = files[0] if files.length == 1
+  FileUtils.cp_r(files, dest)
 end
 
 # Move source file(s) or directories to dest file or directory. Parameter is
@@ -110,37 +121,50 @@ def mv(params)
   }
   check_task_parameters(params, params_desc)
   src = evaluate_object(params['src'])
+  error "mv 'src' parameter must a glob or a list of globs" unless 
+    src.kind_of?(String) or src.kind_of?(Array)
   dest = evaluate_object(params['dest'])
+  error "mv 'dest' parameter must a glob or a list of globs" unless 
+    dest.kind_of?(String)
   files = []
   for element in src
+    error "mv 'src' parameter must a glob or a list of globs" unless 
+      element.kind_of?(String)
     files += Dir.glob(element)
   end
-  for file in files
-    FileUtils.mv(file, dest)
-  end
+  files = files[0] if files.length == 1
+  FileUtils.mv(files, dest)
 end
 
 # Delete files for a given glob. Parameter is a string for glob of files
 # to delete.
-def rm(glob)
+def rm(globs)
   require 'fileutils'
-  glob = evaluate_object(glob)
-  error "rm parameter is a String" unless glob.kind_of?(String)
-  files = Dir.glob(glob)
-  for file in files
-    FileUtils.rm_f(file)
+  globs = evaluate_object(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
+    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.
-def rmdir(glob)
+def rmdir(globs)
   require 'fileutils'
-  glob = evaluate_object(glob)
-  error "rm parameter is a String" unless glob.kind_of?(String)
-  dirs = Dir.glob(glob)
-  for dir in dirs
-    FileUtils.rm_rf(dir)
+  globs = evaluate_object(globs)
+  error "rm parameter is a String or an Array of Strings" unless
+    globs.kind_of?(String) or globs.kind_of?(Array)
+  for glob in globs
+    error "rm 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
 
@@ -155,9 +179,13 @@ def find(parameters)
   }
   check_task_parameters(parameters, params_desc)
   files = []
-  globs = parameters['files']
+  globs = evaluate_object(parameters['files'])
+  error "find 'files' parameter is a String or an Array of Strings" unless
+    globs.kind_of?(String) or globs.kind_of?(Array)
   toprop = evaluate_object(parameters['toprop'])
   for glob in globs
+    error "find 'files' parameter is a String or an Array of Strings" unless
+      glob.kind_of?(String)    
     files += Dir.glob(evaluate_object(glob))
   end
   set(toprop, files)
@@ -321,11 +349,13 @@ Example:
 
 "mkdir"    =>
 "Make a directory and parent directories if necessary. Doesn't complain if
-directory already exists. Parameter is directory to create as a String.
+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\"
+ - mkdir: [\"foo\", \"bar\"]",
 
 "cp"       =>
 "Copy files or directories to destination file or directory. Parameter is a
@@ -341,23 +371,24 @@ Example:
      dest: :doc",
 
 "mv"       =>
-"Move source file(s) or directories to dest file or directory. Parameter is
-a Hahs with following entries:
+"Move source file(s) or directory(ies) to dest file or directory. Parameter is
+a Hash with following entries:
 
 - src: glob for files and directories to move.
 - dest: file or directory to move file(s) to.
 
 Example:
 
- - mv: { src: :gem_package, dest: :build }",
+ - mv: { src: \"**/*.java\", dest: \"trash\" }",
 
 "rm"       =>
-"Delete files for a given glob. Parameter is a String or list of Strings for
-glob(s) of files to delete.
+"Delete files for a given glob or list of globs. Parameter is a glob or list
+of globs for files to delete.
 
 Example:
 
- - rm: \"**/*~\"",
+ - rm: \"**/*~\"
+ - rm: [\"**/*~\", \"**/.DS_Store\"]",
 
 "rmdir"    =>
 "Delete directories recursively. Parameter is a string for glob of directories
@@ -368,8 +399,8 @@ Example:
  - rmdir: :build",
 
 "find"     =>
-"Find files for a given glob and store list in a property. Parameter is
-a Hash with entries:
+"Find files for a glob or list of globs and store list in a property. 
+Parameter is a Hash with entries:
 
 - files: glob or list of globs for files to look for.
 - toprop: name of the property to set.

data/test/tc_bee_default_tasks.rb

@@ -0,0 +1,298 @@
+#!/usr/bin/env ruby
+
+# Copyright 2006 Michel Casabianca <casa@sweetohm.net>
+#
+# 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 'test/unit'
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'bee.rb'
+require 'fileutils'
+
+class TestBeeDefaultTasks < Test::Unit::TestCase
+
+  # Temporary directory.
+  TEMP_DIR = 'tmp'
+
+  # Constructor.
+  def initialize(*args)
+    super(*args)
+    @home = File.expand_path(File.dirname(__FILE__))
+    @working_dir = Dir.getwd
+    @tmp_dir = File.join(@home, TEMP_DIR)
+    # try to create temporary directory and disable tests if we can't
+    begin
+      FileUtils.makedirs(@tmp_dir)
+      @run_tests = true
+    rescue
+      @run_tests = false
+    end
+  end
+
+  # Run before any test:
+  # - Create temporary directory.
+  # - Create a context object and load tasks in it.
+  def setup
+    FileUtils.makedirs(@tmp_dir)
+    @context = Bee::Context.new
+    script = File.read(File.join(@home, '..', 'lib', 'bee_default_context.rb'))
+    @context.evaluate_script(script)
+  end
+
+  # Run after any test: delete temporary directory.
+  def teardown
+    FileUtils.rm_rf(@tmp_dir)
+    Dir.chdir(@working_dir)
+  end
+
+  ############################ UTILITY FUNCTIONS ##########################
+
+  # Clean temporary directory.
+  def clean_tmp
+    FileUtils.rm_rf(@tmp_dir)
+    FileUtils.makedirs(@tmp_dir)    
+  end
+
+  # Create a given file in tmp directory with its name as contents.
+  # - name: file name, relative to temporary directory.
+  def create_file(name)
+    File.open(name, 'w') { |file| file.write(name) }    
+  end
+
+  # Assert file exists and test its contents.
+  def assert_file(file, contents)
+    assert(File.exists?(file))
+    text = File.read(file)
+    assert_equal(contents, text)
+  end
+
+  ############################ TEST FUNCTIONS #############################
+
+  # Test task print.
+  # TODO: implement.
+  def test_task_print
+    return unless @run_tests
+  end
+
+  # Test task cat.
+  # TODO: implement.
+  def test_task_cat
+    return unless @run_tests
+  end
+
+  # Test task cd.
+  def test_task_cd
+    return unless @run_tests
+    working_dir = File.expand_path(File.dirname(__FILE__))
+    # test nominal case
+    @context.cd(@tmp_dir)
+    expected = @tmp_dir
+    actual = Dir.getwd
+    assert_equal(expected, actual)
+    # test changing to a directory that doesn't exists
+    begin
+      dir = File.join(@tmp_dir, 'lkjqzcjv')
+      @context.cd(dir)
+      flunk "Should have raised an Errno::ENOENT"
+    rescue Errno::ENOENT
+    end
+    # test bad arguments
+    begin
+      @context.cd(Object.new)
+      flunk "Should have raised a BuildError"
+    rescue Bee::BuildError
+      expected = 'cd parameter is a String'
+      actual = $!.message
+      assert_equal(expected, actual)
+    end
+  end
+
+  # Test task mkdir.
+  def test_task_mkdir
+    return unless @run_tests
+    # nominal case with a single recursive dir
+    dir = File.join(@tmp_dir, 'foo', 'bar')
+    @context.mkdir(dir)
+    expected = true
+    actual = File.exists?(dir) and File.directory?(dir)
+    assert_equal(expected, actual)
+    # nominal case with a list of directories
+    dirs = [File.join(@tmp_dir, 'toto'), File.join(@tmp_dir, 'titi')]
+    @context.mkdir(dirs)
+    found = Dir.entries(@tmp_dir)
+    assert(found.member?('toto'))
+    assert(found.member?('titi'))
+    # error case
+    dir = Object.new
+    begin
+      @context.mkdir(dir)
+      flunk "Should have raised a BuildError"
+    rescue Bee::BuildError => e
+      expected = 'mkdir parameter must a String or an array of Strings'
+      actual = $!.message
+      assert_equal(expected, actual)
+    end
+    # another error case
+    dirs = [File.join(@tmp_dir, 'foo'), Object.new]
+    begin
+      @context.mkdir(dirs)
+      flunk "Should have raised a BuildError"
+    rescue Bee::BuildError => e
+      expected = 'mkdir parameter must a String or an array of Strings'
+      actual = $!.message
+      assert_equal(expected, actual)
+    end
+  end
+
+  # Test task cp.
+  def test_task_cp
+    return unless @run_tests
+    # nominal case for a src and dest file
+    src = File.join(@tmp_dir, 'src.txt')
+    create_file(src)
+    dest = File.join(@tmp_dir, 'dest.txt')
+    @context.cp({ 'src' => src, 'dest' => dest })
+    assert_file(dest, src)
+    # nominal case for src files and destination directory
+    clean_tmp
+    src2 = File.join(@tmp_dir, 'src2.txt')
+    dest = File.join(@tmp_dir, 'dir')
+    create_file(src)
+    create_file(src2)
+    FileUtils.makedirs(dest)
+    @context.cp({ 'src' => [src, src2], 'dest' => dest })
+    assert_file(File.join(dest, 'src.txt'), src)
+    assert_file(File.join(dest, 'src2.txt'), src2)
+    # nominal case for src and dest directory
+    clean_tmp
+    src = File.join(@tmp_dir, 'dir')
+    dest = File.join(@tmp_dir, 'todir')
+    FileUtils.makedirs(src)
+    FileUtils.makedirs(dest)
+    file1 = File.join(src, 'file1.txt')
+    file2 = File.join(src, 'file2.txt')
+    create_file(file1)
+    create_file(file2)
+    @context.cp({ 'src' => src, 'dest' => dest })
+    assert_file(File.join(dest, 'dir', 'file1.txt'), file1)
+    assert_file(File.join(dest, 'dir', 'file2.txt'), file2)
+  end
+
+  # Test task mv.
+  def test_task_mv
+    return unless @run_tests
+    # nominal case for a src and dest file
+    src = File.join(@tmp_dir, 'src.txt')
+    create_file(src)
+    dest = File.join(@tmp_dir, 'dest.txt')
+    @context.mv({ 'src' => src, 'dest' => dest })
+    assert_file(dest, src)
+    assert(!File.exists?(File.join(@tmp_dir, src)))
+    # nominal case with two source files
+    clean_tmp
+    src = File.join(@tmp_dir, 'src.txt')
+    src2 = File.join(@tmp_dir, 'src2.txt')
+    dest = File.join(@tmp_dir, 'dir')
+    create_file(src)
+    create_file(src2)
+    FileUtils.makedirs(dest)
+    @context.mv({ 'src' => File.join(@tmp_dir, '*.txt'), 'dest' => dest })
+    assert_file(File.join(dest, 'src.txt'), src)
+    assert_file(File.join(dest, 'src2.txt'), src2)
+    assert(!File.exists?(src))
+    assert(!File.exists?(src2))
+    # nominal case with directory for src and dest
+    clean_tmp
+    src = File.join(@tmp_dir, 'dir1')
+    dest = File.join(@tmp_dir, 'dir2')
+    FileUtils.makedirs(src)
+    create_file(File.join(src, 'test.txt'))
+    @context.mv({ 'src' => src, 'dest' => dest })
+    assert(File.exists?(dest))
+    assert(File.directory?(dest))
+    assert_file(File.join(dest, 'test.txt'), File.join(src, 'test.txt'))
+    assert(!File.exists?(src))
+  end
+
+  # Test task rm.
+  def test_task_rm
+    return unless @run_tests
+    # nominal case with a glob
+    file = File.join(@tmp_dir, 'test.txt')
+    create_file(file)
+    @context.rm(File.join(@tmp_dir, file))
+    assert(!File.exists?(File.join(@tmp_dir, file)))
+    # nominal case with two globs and three files
+    clean_tmp
+    file1 = File.join(@tmp_dir, 'test1.txt')
+    file2 = File.join(@tmp_dir, 'test2.txt')
+    file3 = File.join(@tmp_dir, 'test3.log')
+    create_file(file1)
+    create_file(file2)
+    create_file(file3)
+    @context.rm([File.join(@tmp_dir, '**/*.txt'), 
+                 File.join(@tmp_dir, '**/*.log')])
+    assert(!File.exists?(file1))
+    assert(!File.exists?(file2))
+    assert(!File.exists?(file3))
+  end
+
+  # Test task rmdir.
+  def test_task_rmdir
+    return unless @run_tests
+    # nominal case with one dir
+    dir = File.join(@tmp_dir, 'dir')
+    FileUtils.makedirs(dir)
+    @context.rmdir(dir)
+    assert(!File.exists?(dir))
+    # nominal case with two dirs
+    clean_tmp
+    dir1 = File.join(@tmp_dir, 'dir1')
+    dir2 = File.join(@tmp_dir, 'dir2')
+    FileUtils.makedirs(dir1)
+    FileUtils.makedirs(dir2)
+    @context.rmdir([dir1, dir2])
+    assert(!File.exists?(dir1))
+    assert(!File.exists?(dir2))
+  end
+
+  # Test task find.
+  def test_task_find
+    return unless @run_tests
+    file1 = File.join(@tmp_dir, 'file1.txt')
+    file2 = File.join(@tmp_dir, 'file2.txt')
+    dir = File.join(@tmp_dir, 'dir')
+    file3 = File.join(dir, 'file3.txt')
+    create_file(file1)
+    create_file(file2)
+    FileUtils.makedirs(dir)
+    create_file(file3)
+    @context.find({ 'files' => "#{File.join(@tmp_dir, '**/*.txt')}",
+                    'toprop' => 'list'})
+    list = @context.get('list').sort
+    expected = [file1, file2, file3].sort
+    assert_equal(expected, list)
+  end
+
+  # Test task erb.
+  def test_task_erb
+    return unless @run_tests
+    @context.set('test', 'TEST')
+    source = 'This is a <%= test %>'
+    @context.erb({ 'source' => source, 'toprop' => 'result' })
+    actual = @context.get('result')
+    expected = 'This is a TEST'
+    assert_equal(expected, actual)
+  end
+
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: bee
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2006-11-08 00:00:00 +01:00
+  version: 0.3.1
+date: 2006-11-10 00:00:00 +01:00
 summary: bee is a build tool
 require_paths: 
 - lib
@@ -34,6 +34,7 @@ files:
 - lib/bee_console.rb
 - lib/bee_default_context.rb
 - test/tc_bee_console_formatter.rb
+- test/tc_bee_default_tasks.rb
 - test/ts_bee.rb
 - README
 - LICENSE