bee 0.4.0 → 0.5.0

data/lib/bee_util.rb

@@ -1,4 +1,4 @@
-# Copyright 2006-2007 Michel Casabianca <michel.casabianca@gmail.com>
+# Copyright 2006-2008 Michel Casabianca <michel.casabianca@gmail.com>
 #           2006 Avi Bryant
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,38 +13,53 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'net/http'
 
 module Bee
   
   module Util
-    
-    # Get line length calling IOCTL. Return nil if call failed.
-    # FIXME: doesn't work on MacOSX.
+
+    # 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  = /^:(.*?)\.(.*?)(\[(.*)\])?$/
+    # Expanded pattern for resource
+    EXPANDED_PATTERN = /^ruby:\/\/(.*?)(:(.*?))?\/(.*)$/
+    # Default terminal width
+    DEFAULT_TERM_WIDTH = 80
+
+    # Get line length calling IOCTL. Return DEFAULT_TERM_WIDTH if call failed.
     def self.term_width
       begin
-        tiocgwinsz = 0x5413
+        tiocgwinsz = RUBY_PLATFORM =~ /darwin/ ? 0x40087468 : 0x5413
         string = [0, 0, 0, 0].pack('SSSS')
         if $stdin.ioctl(tiocgwinsz, string) >= 0 then
           rows, cols, xpixels, ypixels = string.unpack('SSSS')
+          cols = DEFAULT_TERM_WIDTH if cols <= 0
           return cols
+        else
+          return DEFAULT_TERM_WIDTH
         end
       rescue
-        return nil
+        return DEFAULT_TERM_WIDTH
       end
     end
 
-    # Looks recursively up in file system for a file.
-    # - file: file name to look for.
-    # Return: found file or raises an exception if file was not found.
-    def self.find(file)
-      return file if File.exists?(file)
-      raise "File not found" if File.identical?(File.dirname(file), '/')
-      file = File.join('..', file)
-      find(file)
+    # 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
     end
-
-    # Default package name.
-    DEFAULT_PACKAGE = 'default'
     
     # Parse packaged name and return package and name.
     # - packaged: packaged name (such as 'foo.bar').
@@ -57,12 +72,186 @@ module Bee
       end
       return package, name
     end
-      
+
+    # 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).
+    def self.get_file(location, base=nil)
+      base = base || Dir.pwd
+      abs = absolute_path(location, base)
+      if abs =~ /^http:/
+        # this is HTTP
+        return fetch(abs)
+      else
+        # this is a file
+        return File.read(abs)
+      end  
+    end
+
+    private
+
+    # Looks recursively up in file system for a file.
+    # - file: file name to look for.
+    # Return: found file or raises an exception if file was not found.
+    def self.find(file)
+      return file if File.exists?(file)
+      raise "File not found" if File.identical?(File.dirname(file), '/')
+      file = File.join('..', file)
+      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:/
+    end
+
+    # Tells if a given path is absolute.
+    # - location: file to consider.
+    def self.absolute_path?(location)
+      if url?(location) or resource?(location)
+        return true
+      else
+        case RUBY_PLATFORM
+        when /mswin/
+          return location =~ /^(([a-z]|[A-Z]):)?\//
+        else
+          return location =~ /^\//
+        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)
+        end
+        return location
+      else
+        return File.join(base, location)
+      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)
+      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)
+      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).
+    def self.resource_path(resource)
+      # get gem, version and path from resource
+      case resource
+      when COMPACT_PATTERN
+        gem, version, path = $1, $4, $2
+      when EXPANDED_PATTERN
+        gem, version, path = $1, $3, $4
+      else
+        raise "'#{resource}' is not a valid resource"
+      end
+      # get gem descriptor
+      if version
+        gem_descriptor = Gem.source_index.find_name(gem, version)[0]
+        raise "Gem '#{gem}' was not found in version '#{version}'" if
+          not gem_descriptor
+      else
+        gem_descriptor = Gem.source_index.find_name(gem)[0]
+        raise "Gem '#{gem}' was not found" if
+          not gem_descriptor
+      end
+      # get resource path
+      gem_path = gem_descriptor.full_gem_path
+      file_path = File.join(gem_path, path)
+      return file_path
+    end
+
+    # Find a given template and return associated file.
+    # - template: template to look for.
+    # return: found associated file.
+    def self.find_template(template)
+      raise Bee::Util::BuildError.
+        new("Invalid template name '#{template}'") if
+        not template =~ /^([^.]+\.)?[^.]+$/
+      package, egg = template.split('.')
+      if not egg
+        egg = package
+        package = 'bee'
+      end
+      prefix = (package == 'bee' ? '':'bee_')
+      resource = ":#{prefix}#{package}.egg/#{egg}.yml"
+      begin
+        file = absolute_path(resource, Dir.pwd)
+      rescue
+        raise BuildError.new("Template '#{template}' not found")
+      end
+      raise BuildError.new("Template '#{template}' not found") if
+        not File.exists?(file)
+      return file
+    end
+
+    # Search files for a given templates that might contain a joker (*).
+    # - template: template to look for.
+    # return: a hash associating template and corresponding file.
+    def self.search_templates(template)
+      raise Bee::Util::BuildError.
+        new("Invalid template name '#{template}'") if
+          not template =~ /^([^.]+\.)?[^.]+$/
+      package, egg = template.split('.')
+      if not egg
+        egg = package
+        package = 'bee'
+      end
+      prefix = (package == 'bee' ? '':'bee_')
+      egg = '*' if egg == '?'
+      resource = ":#{prefix}#{package}.egg/#{egg}.yml"
+      begin
+        glob = absolute_path(resource, Dir.pwd)
+      rescue
+        if egg == '*'
+          raise BuildError.new("Template package '#{package}' not found")
+        else
+          raise BuildError.new("Template '#{template}' not found")
+        end
+      end
+      files = Dir.glob(glob)
+      hash = {}
+      for file in files
+        egg = file.match(/.*?([^\/]+)\.yml/)[1]
+        name = "#{package}.#{egg}"
+        hash[name] = file
+      end
+      return hash
+    end
+
     # Class that holds information about a given method.
     class MethodInfo
       
       attr_accessor :source, :comment, :defn, :params
-      
+
+      # Constructor taking file name and line number.
+      # - file: file name of the method.
+      # - lineno: line number of the method.
       def initialize(file, lineno)
         lines = file_cache(file)
         @source = match_tabs(lines, lineno, "def")
@@ -72,7 +261,7 @@ module Bee
       end
       
       private
-      
+
       @@file_cache = {}
       
       def file_cache(file)
@@ -118,18 +307,21 @@ module Bee
     class MethodInfoBase
       
       @@minfo = {}
-      
+
+      # Return comment for a given method.
+      # - method: the method name to get info for.
       def self.method_info(method)
         @@minfo[method.to_s]
       end
       
       private
-      
+
+      # Called when a method is added.
+      # - method: added method.
       def self.method_added(method)
         super if defined? super
         last = caller[0]
-        file = last[0, last.rindex(':')]
-        lineno = last[last.rindex(':')+1, last.length]
+        file, lineno = last.match(/(.+?):(\d+)/)[1, 2]
         @@minfo[method.to_s] = MethodInfo.new(file, lineno.to_i - 1)
       end
       
@@ -172,7 +364,7 @@ module Bee
         for key in description.keys
           case description[key]
           when :mandatory
-            error "Missing mandatory key '#{key}'" if not hash[key]
+            error "Missing mandatory key '#{key}'" if not hash.has_key?(key)
           when :optional
           else
             error "Unknown symbol '#{description[key]}'"
@@ -185,45 +377,6 @@ module Bee
       end
       
     end
-
-    # Module that includes a mixin that provides file selection using include
-    # and exclude globs.
-    module FileSelector
-      
-      include BuildErrorMixin
-      
-      # Select files with globs to include and exclude.
-      # - include: glob (or list of globs) for files to include.
-      # - exclude: glob (or list of globs) for files to exclude.
-      # Return: a list of files as strings.
-      def select_files(includes, excludes)
-        return [] if !includes
-        error "includes can't be nil" if not includes
-        error "includes must be a glob or a list of globs" unless
-        includes.kind_of?(String) or includes.kind_of?(Array)
-        error "excludes must be a glob or a list of globs" unless
-        !excludes or excludes.kind_of?(String) or excludes.kind_of?(Array)
-        included = []
-        for include in includes
-          error "includes must be a glob or a list of globs" unless
-          include.kind_of?(String)
-          included += Dir.glob(include)
-        end
-        if excludes
-          excluded = []
-          for exclude in excludes
-            error "excludes must be a glob or a list of globs" unless
-            exclude.kind_of?(String)
-            excluded += Dir.glob(exclude)
-          end
-          included = included.select do |file|
-            !excluded.member?(file)
-          end
-        end
-        return included
-      end
-      
-    end
     
   end
   

metadata

@@ -1,71 +1,22 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: bee
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2007-06-25 00:00:00 +02:00
-summary: bee is a build tool
-require_paths: 
-- lib
-email: michel.casabianca@gmail.com
-homepage: http://bee.rubyforge.org
-rubyforge_project: 
-description: 
-autorequire: bee
-default_executable: bee
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.5.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: Enjoy bee!
 authors: 
 - Michel Casabianca & Contributors
-files: 
-- bin/bee
-- bin/bee.bat
-- lib/bee.rb
-- lib/bee_console.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_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
-test_files: 
-- test/ts_bee.rb
-rdoc_options: []
-
-extra_rdoc_files: 
-- README
-- LICENSE
-executables: 
-- bee
-extensions: []
-
-requirements: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2008-12-31 00:00:00 +01:00
+default_executable: bee
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: archive-tar-minitar
+  type: :runtime
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -73,10 +24,74 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: rubyzip
+  type: :runtime
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 0.9.1
     version: 
+description: 
+email: michel.casabianca@gmail.com
+executables: 
+- bee
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- bin/bee
+- bin/bee.bat
+- lib/bee.rb
+- lib/bee_console.rb
+- lib/bee_task.rb
+- lib/bee_task_default.rb
+- lib/bee_util.rb
+- egg/package
+- egg/package/bee_task.erb
+- egg/package/build.erb
+- egg/package/egg.yml
+- egg/package/egg_build.erb
+- egg/package/egg_launcher.erb
+- egg/package/egg_script.rb
+- egg/package/gem_spec.erb
+- egg/package/license
+- egg/package/readme.erb
+- egg/package/test.erb
+- egg/package/test_build.erb
+- egg/package/test_build.rb
+- egg/package/test_build_listener.rb
+- egg/package/test_suite.rb
+- egg/package.yml
+- README
+- LICENSE
+has_rdoc: true
+homepage: http://bee.rubyforge.org
+post_install_message: Enjoy bee!
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: bee
+rubygems_version: 1.3.0
+signing_key: 
+specification_version: 2
+summary: bee is a build tool
+test_files: []
+