bee 0.10.2 → 0.11.0

data/lib/{bee_task.rb → bee_task_package.rb}

@@ -1,4 +1,4 @@
-# Copyright 2006-2010 Michel Casabianca <michel.casabianca@gmail.com>
+# Copyright 2006-2011 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.
@@ -13,12 +13,11 @@
 # limitations under the License.
 
 require 'rubygems'
-require 'bee'
+require 'bee_build'
 require 'bee_util'
 
 module Bee
   
-  # Module for bee tasks.
   module Task
 
     # Base class for task package. Provides methods to print output using
@@ -28,11 +27,19 @@ module Bee
     class Package < Bee::Util::MethodInfoBase
       
       include Bee::Util::BuildErrorMixin
+
+      # Verbosity indicator
+      attr_reader :verbose
       
       # Constructor.
       # - build: the build we are running.
       def initialize(build)
         @build = build
+        if @build and @build.listener
+          @verbose = @build.listener.formatter.verbose
+        else
+          @verbose = false
+        end
       end
 
       protected
@@ -50,7 +57,7 @@ module Bee
         for param in description.keys
           error "#{task} '#{param}' parameter is mandatory" unless
             params[param.to_s] or description[param][:mandatory] == false
-          if params[param.to_s]
+          if params[param.to_s] != nil
             case description[param][:type]
             when :string
               error "#{task} '#{param}' parameter must be a string" unless
@@ -66,7 +73,7 @@ module Bee
                 params[param.to_s].kind_of?(Numeric)
             when :boolean
               error "#{task} '#{param}' parameter must be a boolean" unless
-                params[param.to_s] == true or params[param] == false
+                params[param.to_s] == true or params[param.to_s] == false
             when :array
               error "#{task} '#{param}' parameter must be an array" unless
                 params[param.to_s].kind_of?(Array)
@@ -152,8 +159,8 @@ module Bee
       # Print text on the console.
       # - text: text to print.
       def print(text)
-        if @build.listener
-          @build.listener.print(text)
+        if @build and @build.listener
+          @build.listener.formatter.print(text)
         else
           Kernel.print(text)
         end
@@ -162,93 +169,15 @@ module Bee
       # Puts text on the console.
       # - text: text to puts.
       def puts(text)
-        if @build.listener
-          @build.listener.puts(text)
+        if @build and @build.listener
+          @build.listener.formatter.puts(text)
         else
           Kernel.puts(text)
         end
       end
 
-      # Prompts the user for a string.
-      # Return the user input string.
-      def gets
-        if @build.listener
-          return @build.listener.gets
-        else
-          return Kernel::STDIN.gets
-        end        
-      end
-      
     end
     
-    # Package manager is responsible for loading packages and calling tasks.
-    class PackageManager
-      
-      include Bee::Util::BuildErrorMixin
-      
-      # Constructor.
-      # - build: the build we are running.
-      def initialize(build)
-        @build = build
-        @packages = {}
-      end
-      
-      # Run a given task.
-      # - task: YAML object for the task to run.
-      def run_task(task)
-        packaged = task.keys[0]
-        package, name = Bee::Util::get_package_name(packaged)
-        parameters = @build.context.evaluate_object(task[packaged])
-        if not @packages[package]
-          load_package(package)
-        end
-        error "Task '#{name}' not found in package '#{package}'" if
-          not @packages[package].respond_to?(name)
-        @packages[package].send(name, parameters)
-      end
-      
-      # Get help for a given task.
-      # - task: YAML object for the task to run.
-      def help_task(task)
-        package, name = Bee::Util::get_package_name(task)
-        if not @packages[package]
-          load_package(package)
-        end
-        help = {}
-        if name == '?'
-          methods = @packages[package].class.public_instance_methods(false)
-          for method in methods
-            help[method] = @packages[package].class.method_info(method).comment
-          end
-          return help
-        else
-          error "Task '#{name}' not found in package '#{package}'" if
-            not @packages[package].respond_to?(name)
-          help[task] = @packages[package].class.method_info(name).comment
-        end
-        return help
-      end
-      
-      private
-
-      # Load a given package using introspection: we try to instantiate class
-      # named after the package capitalized, in module Bee::Task.
-      # - package: the package name.
-      def load_package(package)
-        package = 'default' if not package
-        package.downcase!
-        script = "bee_task_#{package}"
-        clazz = package.capitalize
-        begin
-          require script
-          @packages[package] = Bee::Task.const_get(clazz).new(@build)
-        rescue Exception
-          error "Task package '#{package}' not found"
-        end
-      end
-      
-    end
-
   end
   
 end

data/lib/bee_task_packagemanager.rb

@@ -0,0 +1,135 @@
+# Copyright 2006-2011 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 'rubygems'
+require 'bee_util'
+
+module Bee
+
+  module Task
+
+    # Package manager is responsible for loading packages and calling tasks.
+    class PackageManager
+
+      include Bee::Util::BuildErrorMixin
+
+      # Constructor.
+      # - build: the build we are running.
+      def initialize(build)
+        @build = build
+        @packages = {}
+      end
+
+      # Run a given task.
+      # - task: YAML object for the task to run.
+      def run_task(task)
+        packaged = task.keys[0]
+        package, name = Bee::Util::get_package_name(packaged)
+        parameters = @build.context.evaluate_object(task[packaged])
+        if not @packages[package]
+          @packages[package] = Bee::Task::PackageManager.load_package(package, @build)
+        end
+        error "Task '#{name}' not found in package '#{package}'" if
+          not @packages[package].respond_to?(name)
+        @packages[package].send(name, parameters)
+      end
+
+      # Get help for a given task.
+      # - task: YAML object for the task to run.
+      def help_task(task)
+        package, name = Bee::Util::get_package_name(task)
+        if not @packages[package]
+          @packages[package] = Bee::Task::PackageManager.load_package(package, @build)
+        end
+        help = {}
+        if name == '?'
+          methods = @packages[package].class.public_instance_methods(false)
+          for method in methods
+            help[method] = @packages[package].class.method_info(method).comment
+          end
+          return help
+        else
+          error "Task '#{name}' not found in package '#{package}'" if
+            not @packages[package].respond_to?(name)
+          help[task] = @packages[package].class.method_info(name).comment
+        end
+        return help
+      end
+
+      # List all available tasks.
+      def self.list_tasks
+        names = [nil] + self.find_gems(/^bee_/).map {|gem| gem.name[4..-1]}
+        tasks = []
+        for name in names
+          package = self.load_package(name)
+          methods = package.class.public_instance_methods(false)
+          if name
+            methods.map! {|method| "#{name}.#{method}"}
+          end
+          tasks += methods
+        end
+        return tasks.sort
+      end
+
+      # List all available templates.
+      def self.list_templates
+        gems = self.find_gems(/^bee$/, /^bee_/)
+        templates = []
+        for gem in gems
+          package = gem.name == 'bee' ? nil : gem.name[4..-1]
+          for file in gem.files
+            if file =~ /egg\/(\w+?).yml/
+              if package
+                templates << "#{package}.#{$1}"
+              else
+                templates << $1
+              end
+            end
+          end
+        end
+        return templates.sort
+      end
+
+      private
+
+      # Load a given package using introspection: we try to instantiate class
+      # named after the package capitalized, in module Bee::Task.
+      # - package: the package name.
+      def self.load_package(package, build=nil)
+        package = 'default' if not package
+        package.downcase!
+        script = "bee_task_#{package}"
+        clazz = package.capitalize
+        begin
+          require script
+          return Bee::Task.const_get(clazz).new(build)
+        rescue Exception
+          raise Bee::Util::BuildError.new("Task package '#{package}' not found")
+        end
+      end
+
+      def self.find_gems(*patterns)
+        gems = []
+        index = Gem::SourceIndex.from_installed_gems()
+        for pattern in patterns
+          gems += index.find_name(pattern)
+        end
+        return gems
+      end
+
+    end
+
+  end
+
+end

data/lib/bee_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2006-2010 Michel Casabianca <michel.casabianca@gmail.com>
+# Copyright 2006-2011 Michel Casabianca <michel.casabianca@gmail.com>
 #           2006 Avi Bryant
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -22,13 +22,11 @@ module Bee
 
     # Limit of number of HTTP redirections to follow.
     HTTP_REDIRECTIONS_LIMIT = 10
-    # README file where copyright is extracted.
-    README_FILE = 'README'
     # Default package name.
     DEFAULT_PACKAGE = 'default'    
-    # Compact pattern for resource
+    # Compact pattern for resource (':gem.file[version]')
     COMPACT_PATTERN  = /^:(.*?)\.(.*?)(\[(.*)\])?$/
-    # Expanded pattern for resource
+    # Expanded pattern for resource ('ruby://gem:version/file')
     EXPANDED_PATTERN = /^ruby:\/\/(.*?)(:(.*?))?\/(.*)$/
     # Default terminal width
     DEFAULT_TERM_WIDTH = (RUBY_PLATFORM =~ /win32/ ? 79 : 80)
@@ -50,18 +48,11 @@ module Bee
       end
     end
 
-    # Return copyright parsing README file. Returns nil if COPYRIGHT file
-    # was not found.
-    def self.copyright
-      readme = File.join(File.dirname(__FILE__), '..', README_FILE)
-      begin
-        copyright = File.read(readme).strip!.split("\n")[-1]
-      rescue
-        copyright = nil
-      end
-      return copyright
+    # Tells if we are running under Windows.
+    def self.windows?
+      return RUBY_PLATFORM =~ /(mswin|ming)/
     end
-    
+
     # Parse packaged name and return package and name.
     # - packaged: packaged name (such as 'foo.bar').
     # Return: package ('foo') and name ('bar').
@@ -76,7 +67,7 @@ module Bee
 
     # Get a given file or URL. Manages HTTP redirections.
     # - location: file path, resource or URL of the file to get.
-    # - base: base for relative files (defaults to nil).
+    # - base: base for relative files (defaults to nil, which is current dir).
     def self.get_file(location, base=nil)
       base = base || Dir.pwd
       abs = absolute_path(location, base)
@@ -101,68 +92,70 @@ module Bee
       find(file)
     end
 
-    # Function to tell if a file name is a URL.
-    # - file: file name to consider.
-    def self.url?(file)
-      return file =~ /^http:/
+    # Tells is a given location is a URL (starting with 'http://').
+    # - location: location to consider as a string.
+    def self.url?(location)
+      return false if not location.kind_of?(String)
+      return location =~ /^http:\/\//
+    end
+
+    # Tells is a given location is a resource (starting with 'ruby://' or ':').
+    # - location: location to consider as a string.
+    def self.resource?(location)
+      return false if not location.kind_of?(String)
+      return location =~ /^ruby:\/\// || location =~ /^:/
     end
 
     # Tells if a given path is absolute.
-    # - location: file to consider.
-    def self.absolute_path?(location)
-      if url?(location) or resource?(location)
+    # - path: path to consider.
+    def self.absolute_path?(path)
+      if url?(path) or resource?(path)
         return true
       else
-        case RUBY_PLATFORM
-        when /mswin/
-          return location =~ /^(([a-z]|[A-Z]):)?\//
+        if windows?
+          return path =~ /^(([a-zA-Z]):)?\//
         else
-          return location =~ /^\//
+          return path =~ /^\//
         end
       end
     end
 
-    # Utility method that returns absolute path for a given file relative
-    # to base.
-    # - location: location to get absolute path for.
-    # - base: base for relative paths (may be an URL).
-    def self.absolute_path(location, base)
-      if absolute_path?(location)
-        if resource?(location)
-          location = resource_path(location)
+    # Return absolute path for a given path and optional base:
+    # - path: relative path to get absolute path for.
+    # - base: optional base for path (defaults to current directory).
+    def self.absolute_path(path, base=nil)
+      if absolute_path?(path)
+        if resource?(path)
+          path = resource_path(path)
         end
-        return location
+        return path
       else
-        return File.join(base, location)
+        base = Dir.pwd if not base
+        return File.join(base, path)
       end
     end
 
     # Get a given URL.
     # - url: URL to get.
     # - limit: redirectrion limit (defaults to HTTP_REDIRECTIONS_LIMIT).
-    def self.fetch(url, limit = HTTP_REDIRECTIONS_LIMIT)
+    def self.fetch(url, limit=HTTP_REDIRECTIONS_LIMIT)
       raise 'HTTP redirect too deep' if limit == 0
       response = Net::HTTP.get_response(URI.parse(url))
       case response
       when Net::HTTPSuccess
         response.body
       when Net::HTTPRedirection
-        fetch(response['location'], limit - 1)
+        fetch(response['location'], limit-1)
       else
         response.error!
       end
     end
 
-    # Tells is a given location is a resource.
-    # - location: location to examine.
-    def self.resource?(location)
-      return location.to_s =~ /^ruby:\/\// || location.to_s =~ /^:/
-    end
-
-    # Return the path to a given resoure and test that file exists.
-    # - resource: the resource (expanded or compact pattern).
+    # Return absolute path to a given resoure:
+    # - resource: the resource (expanded patterns are like ':gem.file[version]'
+    # and compact ones like 'ruby://gem:version/file').
     def self.resource_path(resource)
-      # get gem, version and path from resource
+      # get gem, version and path from resource or interrupt build with an error
       case resource
       when COMPACT_PATTERN
         gem, version, path = $1, $4, $2
@@ -178,8 +171,7 @@ module Bee
           not gem_descriptor
       else
         gem_descriptor = Gem.source_index.find_name(gem)[0]
-        raise "Gem '#{gem}' was not found" if
-          not gem_descriptor
+        raise "Gem '#{gem}' was not found" if not gem_descriptor
       end
       # get resource path
       gem_path = gem_descriptor.full_gem_path
@@ -188,7 +180,7 @@ module Bee
     end
 
     # Find a given template and return associated file.
-    # - template: template to look for.
+    # - template: template to look for (like 'foo.bar').
     # return: found associated file.
     def self.find_template(template)
       raise Bee::Util::BuildError.
@@ -212,7 +204,7 @@ module Bee
     end
 
     # Search files for a given templates that might contain a joker (*).
-    # - template: template to look for.
+    # - template: template to look for ('foo.bar' or 'foo.*' or '*.bar').
     # return: a hash associating template and corresponding file.
     def self.search_templates(template)
       raise Bee::Util::BuildError.
@@ -257,8 +249,12 @@ module Bee
         lines = file_cache(file)
         @source = match_tabs(lines, lineno, "def")
         @comment = preceding_comment(lines, lineno)
-        @defn = lines[lineno].strip.gsub(/^def\W+(.*?\W*\((.*?)\))/){$1}
-        @params = $2 ? $2.split(',') : nil
+        @defn = lines[lineno].strip.gsub(/^def\W+(.*)/){$1}
+        if @defn =~ /.*?\(.*?\)/
+          @params = @defn.gsub(/.*?\((.*?)\)/){$1}.split(',').map{|p| p.strip}
+        else
+          @params = []
+        end
       end
       
       private
@@ -333,6 +329,12 @@ module Bee
     # be displayed on an internal error only). Include BuildErrorMixin to get
     # a convenient way to raise such an error.
     class BuildError < RuntimeError
+      
+      # Last met target.
+      attr_accessor :target
+      # Last met task.
+      attr_accessor :task
+
     end
     
     # Build error mixin provides error() function to raise a BuildError.
@@ -344,7 +346,7 @@ module Bee
       # Convenient method to raise a BuildError.
       # - message: error message.
       def error(message)
-        raise BuildError.new(message)
+        Kernel.raise BuildError.new(message)
       end
       
     end