rap 0.13.1 → 0.14.0

data/History

@@ -1,4 +1,11 @@
-== 0.17.1 / 2009-06-06
+==  0.14.0 / 2009-06-17
+
+* added dependencies directly to Rap::Task
+* removed sh method from Declarations
+  (include Rap::Utils instead)
+* updates for Tap-0.18.0
+
+== 0.13.1 / 2009-06-06
 
 Updates for Tap-0.17.1.
 

data/README

@@ -43,7 +43,7 @@ Now from the command line:
   --------------------------------------------------------------------------------
     Says goodnight with a configurable message.
   --------------------------------------------------------------------------------
-  usage: rap goodnight OBJ
+  usage: tap run -- goodnight OBJ
 
   configurations:
           --message MESSAGE

data/bin/rap

@@ -24,6 +24,7 @@ end
 
 Dir.glob('[TtRr]apfile{,.rb}').each do |rapfile|
   next unless File.file?(rapfile)
+  env.scan(rapfile, "task|join|middleware")
   load rapfile
 end
 
@@ -52,7 +53,7 @@ when '--help', nil, '-T'
   end
   
   puts
-  puts "version #{Tap::VERSION} -- #{Tap::WEBSITE}"
+  puts "version #{Rap::VERSION} -- #{Rap::WEBSITE}"
 else
   begin
     schema = Tap::Schema.parse(ARGV)

data/lib/rap.rb

@@ -3,4 +3,11 @@ require 'rap/declarations'
 
 module Rap
   autoload(:Rake, 'rap/rake')
+
+  MAJOR = 0
+  MINOR = 14
+  TINY = 0
+  
+  VERSION="#{MAJOR}.#{MINOR}.#{TINY}"
+  WEBSITE="http://tap.rubyforge.org/rap"
 end

data/lib/rap/declarations.rb

@@ -1,5 +1,4 @@
 require 'rap/task'
-require 'rap/utils'
 
 module Rap
   
@@ -51,8 +50,6 @@ module Rap
   # See the {Syntax Reference}[link:files/doc/Syntax%20Reference.html] for more
   # information.
   module Declarations
-    include Utils
-    
     # The environment in which declared task classes are registered.
     # By default a Tap::Env for Dir.pwd.
     def Declarations.env() @@env ||= Tap::Env.new; end
@@ -238,7 +235,7 @@ module Rap
       alias desc original_desc
       
       # hide remaining Declarations methods (including Utils methods)
-      private :namespace, :sh
+      private :namespace
       # :startdoc:
       
       private

data/lib/rap/task.rb

@@ -35,6 +35,24 @@ module Rap
   class Task < Tap::Task
     class << self
       
+      # Returns class dependencies
+      attr_reader :dependencies
+
+      # Returns or initializes the instance of self cached with app.
+      def instance(app=Tap::App.instance, auto_initialize=true)
+        app.cache[self] ||= (auto_initialize ? new({}, app) : nil)
+      end
+
+      def inherited(child) # :nodoc:
+        unless child.instance_variable_defined?(:@source_file)
+          caller[0] =~ Lazydoc::CALLER_REGEXP
+          child.instance_variable_set(:@source_file, File.expand_path($1)) 
+        end
+
+        child.instance_variable_set(:@dependencies, dependencies.dup)
+        super
+      end
+      
       # Sets actions.
       attr_writer :actions
       
@@ -73,7 +91,12 @@ module Rap
       #
       def parse!(argv=ARGV, app=Tap::App.instance)
         instance = super
-        instance.args = argv
+        
+        # store args on instance and clear so that instance
+        # will not be enqued with any inputs
+        instance.args = argv.dup
+        argv.clear
+        
         instance
       end
       
@@ -135,62 +158,115 @@ module Rap
         
         subclass
       end
+      
+      # Sets a class-level dependency; when task class B depends_on another
+      # task class A, instances of B are initialized to depend on a shared
+      # instance of A.  The shared instance is specific to an app and can
+      # be accessed through instance(app).
+      #
+      # If a non-nil name is specified, depends_on will create a reader of 
+      # the dependency instance.
+      #
+      #   class A < Rap::Task
+      #   end
+      #
+      #   class B < Rap::Task
+      #     depends_on :a, A
+      #   end
+      #
+      #   app = Tap::App.new
+      #   b = B.new({}, app)
+      #   b.dependencies           # => [A.instance(app)]
+      #   b.a                      # => A.instance(app)
+      #
+      # Returns self.
+      def depends_on(name, dependency_class)
+        unless dependency_class.ancestors.include?(Rap::Task)
+          raise "not a Rap::Task: #{dependency_class}"
+        end
+        
+        unless dependencies.include?(dependency_class)
+          dependencies << dependency_class
+        end
+        
+        if name
+          # returns the resolved result of the dependency
+          define_method(name) do
+            dependency_class.instance(app)
+          end
+        
+          public(name)
+        end
+        
+        self
+      end
     end
     
-    # The result of self, set by call.
-    attr_reader :result
+    instance_variable_set(:@dependencies, [])
     
-    # The arguments assigned to self during call.
+    # An array of node dependencies
+    attr_reader :dependencies
+    
+    # The arguments assigned to self.
     attr_accessor :args
     
     def initialize(config={}, app=Tap::App.instance)
       super
+      @dependencies = []
       @resolved = false
-      @result = nil
       @args = nil
+      
+      # setup class dependencies
+      self.class.dependencies.each do |dependency_class|
+        depends_on dependency_class.instance(app)
+      end
     end
     
-    # Conditional call to the super call; only calls once.  Returns result.
-    def call(*args)
+    # Conditional call to the super call; only calls once and with args (if
+    # set).  Call recursively resolves dependencies and raises an error for
+    # circular dependencies.
+    #
+    def call
+      if resolved?
+        return
+      end
       
-      # Declaration tasks function as dependencies, but unlike normal
-      # dependencies, they CAN take arguments from the command line.
-      # Such arguments will be set as args, and be used to enque the
-      # task.  
-      #
-      # If the task executes from the queue first, args will be
-      # provided to call and they should equal self.args.  If the task
-      # executes as a dependency first, call will not receive args and
-      # in that case self.args will be used.
-      #
-      # This warns for cases that odd workflows can produce where the
-      # args have been set and DIFFERENT args are used to enque the task.
-      # In these cases always go with the pre-set args but warn the issue.
-      self.args ||= args
-      unless self.args == args
-        if @resolved
-          warn "warn: ignorning dependency task inputs #{args.inspect} (#{self})"
-        else
-          warn "warn: invoking dependency task with preset args #{self.args.inspect} and not inputs #{args.inspect} (#{self})"
-        end
+      if resolving?
+        raise DependencyError.new(self)
       end
       
-      unless @resolved
-        @resolved = true
-        @result = super(*self.args)
+      @resolved = nil
+      begin
+        dependencies.each do |dependency|
+          dependency.call
+        end
+      rescue(DependencyError)
+        $!.trace.unshift(self)
+        raise $!
       end
-      result
+
+      @resolved = true
+      args ? super(*args) : super()
     end
     
+    # Alias for call.
+    def resolve!
+      call
+    end
+
     # Returns true if already resolved by call.
     def resolved?
-      @resolved
+      @resolved == true
+    end
+    
+    def resolving?
+      @resolved == nil
     end
     
     # Resets self so call will call again.  Also sets result to nil.
     def reset
+      raise "cannot reset when resolving" if resolving?
       @resolved = false
-      @result = nil
     end
     
     # Collects the inputs into an OpenStruct according to the class arg_names,
@@ -216,5 +292,29 @@ module Rap
       
       nil
     end
+    
+    # Adds the dependency to self.
+    def depends_on(dependency)
+      raise "cannot depend on self" if dependency == self
+      unless dependencies.include?(dependency)
+        dependencies << dependency
+      end
+      self
+    end
+    
+  end
+  
+  # Raised for circular dependencies during Rap::Task.resolve!
+  class DependencyError < StandardError
+    attr_reader :trace
+    
+    def initialize(task)
+      @trace = [task]
+      super()
+    end
+    
+    def message
+      "circular dependency: [#{trace.collect {|task| task.class.to_s }.join(', ')}]"
+    end
   end
 end

data/lib/rap/utils.rb

@@ -1,18 +1,67 @@
+require 'tempfile'
+
 module Rap
+  # Provides several shell utility methods for calling programs.
+  #
+  # == Windows 
+  # MSDOS has command line length limits specific to the version of Windows being
+  # run (from http://www.ss64.com/nt/cmd.html):
+  #
+  # Windows NT:: 256 characters
+  # Windows 2000::  2046 characters
+  # Windows XP:: 8190 characters
+  #
+  # Commands longer than these limits fail, usually with something like: 'the input
+  # line is too long'
   module Utils
+    
+    # :startdoc:::-
     # Run the system command +cmd+, passing the result to the block, if given.
     # Raises an error if the command fails. Uses the same semantics as 
     # Kernel::exec and Kernel::system.
     #
     # Based on FileUtils#sh from Rake.
+    # :startdoc:::+
     def sh(*cmd) # :yields: ok, status
       ok = system(*cmd)
 
       if block_given?
         yield(ok, $?)
       else
-        ok or raise "Command failed with status (#{$?.exitstatus}): [#{cmd.join(' ')}]"
+        ok or raise "Command failed with status (#{$?.exitstatus}): [#{ cmd.join(' ')}]"
+      end
+    end
+  
+    # Runs the system command +cmd+ using sh, redirecting the output to the 
+    # specified file path.  Uses the redirection command:
+    #
+    #   "> \"#{path}\" 2>&1 #{cmd}"
+    #
+    # This redirection has been tested on Windows, OS X, and Fedora.  See 
+    # http://en.wikipedia.org/wiki/Redirection_(Unix) for pointers on
+    # redirection.  This style of redirection SHOULD NOT be used with
+    # commands that contain other redirections.  
+    def redirect_sh(cmd, path, &block) # :yields: ok, status
+      sh( "> \"#{path}\" 2>&1 #{cmd}", &block)
+    end
+  
+    # Runs the system command +cmd+ and returns the output as a string.
+    def capture_sh(cmd, quiet=false, &block) # :yields: ok, status, tempfile_path
+      tempfile = Tempfile.new('shell_utils')
+      tempfile.close
+      redirect_sh(cmd, tempfile.path) do |ok, status|
+        if block_given?
+          yield(ok, $?, tempfile.path)
+        else
+          ok or raise %Q{Command failed with status (#{$?.exitstatus}): [#{cmd}]
+-------------- command output -------------------
+#{File.read(tempfile.path)}
+-------------------------------------------------
+}
+        end
       end
+    
+      quiet == true ? "" : File.read(tempfile.path)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rap
 version: !ruby/object:Gem::Version 
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-06 00:00:00 -06:00
+date: 2009-06-17 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.17.1
+        version: 0.18.0
     version: 
 description: 
 email: simon.a.chiang@gmail.com
@@ -38,8 +38,8 @@ files:
 - lib/rap/declarations.rb
 - lib/rap/description.rb
 - lib/rap/rake.rb
-- lib/rap/utils.rb
 - lib/rap.rb
+- lib/rap/utils.rb
 - tap.yml
 - README
 - MIT-LICENSE