bee 0.3.1 → 0.4.0

data/test/tc_bee_util.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+# 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 'fileutils'
+$:.unshift(File.join(File.dirname(__FILE__)))
+require 'tmp_test_case'
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'bee_util'
+
+# Test case for utility methods.
+class TestBeeUtil < TmpTestCase
+
+  include Bee::Util::FileSelector
+
+  # Test FileSelector class.
+  def test_select_files
+    # make test files
+    path = File.join(@tmp_dir, '1.txt')
+    File.open(path, 'w') {|file| file.write('TEST')}
+    path = File.join(@tmp_dir, '2.txt')
+    File.open(path, 'w') {|file| file.write('TEST')}
+    path = File.join(@tmp_dir, '3.txt')
+    File.open(path, 'w') {|file| file.write('TEST')}
+    path = File.join(@tmp_dir, '1.tst')
+    File.open(path, 'w') {|file| file.write('TEST')}
+    path = File.join(@tmp_dir, '2.tst')
+    File.open(path, 'w') {|file| file.write('TEST')}
+    path = File.join(@tmp_dir, '3.tst')
+    File.open(path, 'w') {|file| file.write('TEST')}
+    # test file selection
+    includes = "#{@tmp_dir}/*"
+    excludes = nil
+    actual = select_files(includes, excludes)
+    expected = ["#{@tmp_dir}/1.tst", "#{@tmp_dir}/1.txt", 
+                "#{@tmp_dir}/2.tst", "#{@tmp_dir}/2.txt", 
+                "#{@tmp_dir}/3.tst", "#{@tmp_dir}/3.txt"]
+    assert_equal(expected, actual)
+    includes = "#{@tmp_dir}/*"
+    excludes = "#{@tmp_dir}/*.tst"
+    actual = select_files(includes, excludes)
+    expected = ["#{@tmp_dir}/1.txt", "#{@tmp_dir}/2.txt", "#{@tmp_dir}/3.txt"]
+    assert_equal(expected, actual)
+    includes = "#{@tmp_dir}/1.*"
+    excludes = nil
+    actual = select_files(includes, excludes)
+    expected = ["#{@tmp_dir}/1.tst", "#{@tmp_dir}/1.txt"]
+    assert_equal(expected, actual)
+  end
+
+  # Test find method.
+  def test_find
+    # nominal case
+    file = File.join(@tmp_dir, 'file.txt')
+    File.open(file, 'w') {|file| file.write('TEST')}
+    dir = File.join(@tmp_dir, 'dir')
+    FileUtils.mkdir(dir)
+    Dir.chdir(dir)
+    actual = Bee::Util::find('file.txt')
+    expected = '../file.txt'
+    assert_equal(expected, actual)
+    # failure: file not found
+    begin
+      Bee::Util::find('foo.bar')
+      flunk "Should have failed"
+    rescue
+      expected = 'File not found'
+      actual = $!.to_s
+      assert_equal(expected, actual)
+    end
+  end
+  
+end

data/test/test_build.rb

@@ -0,0 +1,26 @@
+# 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.
+
+# Empty build for testing purpose. Contains a single context.
+class TestBuild
+  
+  attr_reader :context
+  attr_reader :listener
+  
+  def initialize(context, listener)
+    @context = context
+    @listener = listener
+  end
+  
+end

data/test/test_build_listener.rb

@@ -0,0 +1,60 @@
+# 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.
+
+# Test build listener.
+class TestBuildListener
+
+  attr_reader :started
+  attr_reader :finished
+  attr_reader :targets
+  attr_reader :tasks
+  attr_reader :success
+  attr_reader :errors
+  attr_accessor :output
+  
+  def initialize
+    @targets = []
+    @tasks = []
+    @output = ''
+  end
+  
+  def build_started(build)
+    @started = true
+  end
+
+  def build_finished(build)
+    @finished = true
+  end
+
+  def target(target)
+    @targets << target
+  end
+
+  def task(task)
+    @tasks << tasks
+  end
+
+  def error(exception)
+    @errors = exception
+  end
+
+  def print(text)
+    @output << text
+  end
+
+  def puts(text)
+    @output << text + "\n"
+  end
+
+end

data/test/tmp_test_case.rb

@@ -0,0 +1,58 @@
+# 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 'test/unit'
+require 'fileutils'
+
+# Test case that creates a 'tmp' directory before each test and deletes it
+# after. Also disable tests if we can't write on disk (if we run tests while
+# installing with gem in a system directory for instance).
+class TmpTestCase < Test::Unit::TestCase
+
+  # Temporary directory.
+  TEMP_DIR = 'tmp'
+
+  # Constructor: disable test if we don't have write permission.
+  def initialize(*args)
+    super(*args)
+    @home = File.expand_path(File.dirname(__FILE__))
+    @working_dir = Dir.getwd
+    @tmp_dir = File.join(@home, TEMP_DIR)
+    begin
+      FileUtils.makedirs(@tmp_dir)
+      @run_tests = true
+    rescue
+      @run_tests = false
+      methods = self.class.public_instance_methods
+      for method in methods
+        self.class.remove_method(Symbol.new(method)) if method =~ /^test_.*/
+      end
+    end
+  end
+  
+  # Run before any test: create temporary directory.
+  def setup
+    FileUtils.makedirs(@tmp_dir)
+  end
+  
+  # Run after any test: delete temporary directory.
+  def teardown
+    Dir.chdir(@working_dir)
+    FileUtils.rm_rf(@tmp_dir)
+  end
+  
+  def test_
+  end
+
+end

data/test/ts_bee.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Copyright 2006 Michel Casabianca <casa@sweetohm.net>
+# 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.

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: bee
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
-date: 2006-11-10 00:00:00 +01:00
+  version: 0.4.0
+date: 2007-06-25 00:00:00 +02:00
 summary: bee is a build tool
 require_paths: 
 - lib
@@ -27,14 +27,24 @@ signing_key:
 cert_chain: 
 post_install_message: Enjoy bee!
 authors: 
-- Michel Casabianca
+- Michel Casabianca & Contributors
 files: 
 - bin/bee
+- bin/bee.bat
 - lib/bee.rb
 - lib/bee_console.rb
-- lib/bee_default_context.rb
+- lib/bee_task.rb
+- lib/bee_task_default.rb
+- lib/bee_util.rb
+- test/tc_bee_build.rb
+- test/tc_bee_console.rb
 - test/tc_bee_console_formatter.rb
-- test/tc_bee_default_tasks.rb
+- test/tc_bee_context.rb
+- test/tc_bee_task_default.rb
+- test/tc_bee_util.rb
+- test/test_build.rb
+- test/test_build_listener.rb
+- test/tmp_test_case.rb
 - test/ts_bee.rb
 - README
 - LICENSE
@@ -51,5 +61,22 @@ extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: archive-tar-minitar
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyzip
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 

data/lib/bee_default_context.rb

@@ -1,475 +0,0 @@
-# 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.
-
-# Default bee context. This script is evaluated before getting binding
-# for context, thus all defined functions are accessible in scripts
-# that run in targets. Furthermore, last evaluated expression is a
-# mapping of extension tasks.
-
-############################ UTILITY FUNCTIONS ############################
-
-# Convenient method to raise a BuildError. This is necessary to interrupt
-# build with an error message but without a stack trace (which would
-# indicate an internal error).
-# - message: error message.
-def error(message)
-  raise BuildError.new(message)
-end    
-
-# Run a shell script and raise a build error if script returned a value
-# different of 0.
-# - script: script to run.
-def sh(script)
-  system(script) or error "Script '#{script}' exited with value '#{$?}'"
-end
-
-############################ TASK DEFINITIONS #############################
-
-# Prints a message. This message may be a String (standard output) or any
-# Ruby object. In this latter case, print its inspected value.
-# - message: message to print.
-def print(message)
-  case message
-  when String
-    puts evaluate_object(message)
-  else
-    puts message.inspect
-  end
-end
-
-# Print a file contents.
-# - file: file to print out.
-def cat(file)
-  file = evaluate_object(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 run in
-# the target. Parameter is a string with directory to change to.
-def cd(dir)
-  dir = evaluate_object(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.
-# - dir: directory to create.
-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
-# Hash with following entries:
-# - src: glob for source files or directories.
-# - dest: destination file or directory.
-def cp(params)
-  require 'fileutils'
-  params_desc = {
-    'src' => :mandatory,
-    'dest' => :mandatory
-  }
-  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
-  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
-# a Hahs with following keys:
-# - src: glob for files and directories to move.
-# - dest: file or directory to move file(s) to.
-def mv(params)
-  require 'fileutils'
-  params_desc = {
-    'src' => :mandatory,
-    'dest' => :mandatory
-  }
-  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
-  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(globs)
-  require 'fileutils'
-  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(globs)
-  require 'fileutils'
-  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
-
-# Find files for a given glob 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.
-def find(parameters)
-  params_desc = {
-    'files' => :mandatory,
-    'toprop' => :mandatory
-  }
-  check_task_parameters(parameters, params_desc)
-  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)
-end
-
-# Run a set of tests selected using globs. Parameter is a glob or list of
-# globs for files or directories to run.
-# FIXME: if tasks runs twice, it will run twice loaded tests...
-def test(globs)
-  require 'test/unit'
-  require 'test/unit/testresult'
-  files = []
-  for glob in globs
-    error "Parameter must be a String or a list of Strings" unless
-      glob.kind_of?(String)
-    files += Dir.glob(evaluate_object(glob))
-  end
-  for file in files
-    load file
-  end
-  Test::Unit::AutoRunner.run
-end
-
-# Run an ERB file or source and store result in a file or property. Parameter
-# is a Hash with following keys:
-# - source: ERB source text (if no 'file').
-# - file: ERB file name (if no 'source').
-# - tofile: file where to store result (if no 'toprop').
-# - toprop: property name where to store result (if no 'tofile').
-def erb(params)
-  require 'erb'
-  # check parameters
-  params_desc = {
-    'source' => :optional,
-    'file'   => :optional,
-    'tofile' => :optional,
-    'toprop' => :optional
-  }
-  check_task_parameters(params, params_desc)
-  source = params['source']
-  file = evaluate_object(params['file'])
-  tofile = evaluate_object(params['tofile'])
-  toprop = evaluate_object(params['toprop'])
-  error "Must pass one of 'source' or 'file' parameters to erb task" if
-    not source and not file
-  error "Must pass one of 'tofile' or 'toprop' parameters to erb task" if
-    not tofile and not toprop
-  # load ERB source
-  erb_source = source||File.read(file)
-  template = ERB.new(erb_source)
-  begin
-    result = template.result(@context_binding)
-  rescue
-    error "Error processing ERB: #{$!}"
-  end
-  # write result in file or set property
-  if tofile
-    File.open(tofile, 'w') { |file| file.write(result) }
-  else
-    set(toprop, result)
-  end
-end
-
-# Generate RDoc documentation for a given list of globs and an output directory.
-# Parameter is a Hash with following keys:
-# - input: input files as a glob (or list of globs). File mays be directories.
-# - output: output directory for generated documentation.
-def rdoc(params)
-  require 'rdoc/rdoc'
-  params_desc = {
-    'input' => :mandatory,
-    'output' => :mandatory
-  }
-  check_task_parameters(params, params_desc)
-  files = []
-  input = params['input']
-  for glob in input
-    files += Dir.glob(evaluate_object(glob))
-  end
-  output = evaluate_object(params['output'])
-  command_line = ['-S', '-o', output] + 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).
-def gembuild(description)
-  require 'rubygems'
-  description = evaluate_object(description)
-  arguments = ['build', description]
-  Gem.manage_gems
-  Gem::GemRunner.new.run(arguments)
-end
-
-# Generate a ZIP archive. Parameter is a Hash with following entries:
-# - files: glob or list of globs for files to select for the archive.
-# - archive: the archive name.
-# - prefix: prefix for archive entries (default to nil).
-# Note: if archive exists, files are added to the archive.
-def zip(parameters)
-  require 'zip/zip'
-  # parse parameters
-  params_desc = {
-    'files' => :mandatory,
-    'archive' => :mandatory,
-    'prefix' => :optional
-  }
-  check_task_parameters(parameters, params_desc)
-  globs = evaluate_object(parameters['files'])
-  files = []
-  for glob in globs
-    files += Dir.glob(evaluate_object(glob))
-  end
-  archive = evaluate_object(parameters['archive'])
-  prefix = evaluate_object(parameters['prefix'])
-  # build the archive
-  zipfile = Zip::ZipFile.open(archive, 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
-
-############################## TASKS MAPPING ##############################
-
-{
-"print"    =>
-"Print a message on console. This message may be a String (standard output)
-or any Ruby object. In this latter case, print its inspected value. Parameter
-is the message to output as a String.
-
-- message: message to print.
-
-Example:
-
- - print: \"Hello World!\"",
-
-"cat"      =>
-"Print contents of a given file on the console. Parameter is file to output
-as a String.
-
-- file: file to print out.
-
-Example:
-
- - cat: \"doc/welcome-message.txt\"",
-
-"cd"       =>
-"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\"",
-
-"mkdir"    =>
-"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\"]",
-
-"cp"       =>
-"Copy files or directories to destination file or directory. Parameter is a
-Hash with following entries:
-
-- src: glob for source files or directories.
-- dest: destination file or directory.
-
-Example:
-
- - cp:
-     src: \"doc/png/*.png\"
-     dest: :doc",
-
-"mv"       =>
-"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: \"**/*.java\", dest: \"trash\" }",
-
-"rm"       =>
-"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: [\"**/*~\", \"**/.DS_Store\"]",
-
-"rmdir"    =>
-"Delete directories recursively. Parameter is a string for glob of directories
-to delete.
-
-Example:
-
- - rmdir: :build",
-
-"find"     =>
-"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.
-
-Example:
-
- - find: { files: \"**/*.rb\", toprop: \"rb_files_to_check\" }",
-
-"test"     =>
-"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...",
-
-"erb"      =>
-"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 'file').
-- file: ERB file name (if no 'source').
-- tofile: file where to store result (if no 'toprop').
-- toprop: property name where to store result (if no 'tofile').
-
-Example:
-
- - erb: { file: \"gem.spec.erb\", tofile: \"gem.spec\" }
-
-Notes: In these ERB files, you can access a property _foo_ writing:
-
- <p>Hello <%= foo %>!</p>",
-
-"rdoc"     =>
-"Generate RDoc documentation for a given list of globs and an output directory.
-Parameter is a Hash with following entries:
-
-- input: input files as a glob (or list of globs). File mays be directories.
-- output: output directory for generated documentation.
-
-Example:
-
- - rdoc:
-     input: [\"README\", \"LICENSE\", :src]
-     output: :api",
-
-"gembuild" =>
-"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",
-
-"zip"      =>
-"Generate a ZIP archive. Parameter is a Hash with following entries:
-
-- files: glob or list of globs for files to select for the archive.
-- archive: the archive name.
-- prefix: prefix for archive entries (default to nil).
-
-Example:
-
- - zip:
-     files: :zip_files
-     archive: :zip_archive
-
-Note: if archive already exists, files are added to the archive."
-}