rap 0.14.0 → 0.15.0

data/History

@@ -1,3 +1,9 @@
+== 0.15.0 / 2009-12-05
+
+* moved version information into separate file
+* made Rap::Utils required by Rap::Task
+* updates for Tap-0.19.0
+
 ==  0.14.0 / 2009-06-17
 
 * added dependencies directly to Rap::Task

data/MIT-LICENSE

@@ -1,19 +1,21 @@
 Copyright (c) 2009, Regents of the University of Colorado.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this
-software and associated documentation files (the "Software"), to deal in the Software
-without restriction, including without limitation the rights to use, copy, modify, merge,
-publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
-to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2009, Simon Chiang.
 
-The above copyright notice and this permission notice shall be included in all copies or
-substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README

@@ -14,7 +14,6 @@ Rap is a part of the {Tap-Suite}[http://tap.rubyforge.org/tap-suite].
 Check out these links for documentation, development, and bug tracking.
 
 * Website[http://tap.rubyforge.org]
-* Lighthouse[http://bahuvrihi.lighthouseapp.com/projects/9908-tap-task-application/tickets]
 * Github[http://github.com/bahuvrihi/tap/tree/master]
 * {Google Group}[http://groups.google.com/group/ruby-on-tap]
 
@@ -24,7 +23,7 @@ Usage is much like {Rake}[http://rake.rubyforge.org/]:
 
   [Rapfile]
   
-  # ::desc your basic goodnight moon task
+  # :: your basic goodnight moon task
   # Says goodnight with a configurable message.
   Rap.task(:goodnight, :obj, :message => 'goodnight') do |task, args|
     puts "#{task.message} #{args.obj}\n"
@@ -115,21 +114,11 @@ workflow you can run with 'tap run' can be run without alteration by rap.
 
 == Installation
 
-Rap is available as a gem on RubyForge[http://rubyforge.org/projects/tap].
-Use:
+Rap is available as a gem on Gemcutter[http://gemcutter.org/gems/rap].
 
   % gem install rap
 
-Rap requires an updated version of RubyGems[http://docs.rubygems.org/] 
-(>= 1.2.0).  To check the version and update RubyGems:
-
-  % gem --version
-  % gem --update system
-    
 == Info 
 
-Copyright (c) 2009, Regents of the University of Colorado.
-Developer:: {Simon Chiang}[http://bahuvrihi.wordpress.com], {Biomolecular Structure Program}[http://biomol.uchsc.edu/], {Hansen Lab}[http://hsc-proteomics.uchsc.edu/hansenlab/] 
-Support:: CU Denver School of Medicine Deans Academic Enrichment Fund
+Developer:: {Simon Chiang}[http://bahuvrihi.wordpress.com]
 License:: {MIT-Style}[link:files/MIT-LICENSE.html]
-

data/bin/rap

@@ -3,13 +3,20 @@
 
 $:.unshift "#{File.dirname(__FILE__)}/../lib"
 require 'rap'
+require 'tap/parser'
+
+#
+# setup the application
+#
 
-# setup the environment
 begin
-  
-  env = Tap::Exe.setup
-  Rap::Declarations.env = env
-  env.activate
+  app = Tap::App.setup
+  env = app.env
+  unless env.any? {|e| e.root.root == Rap::RAP_HOME }
+    env.deactivate
+    env.push Tap::Env.new(Rap::RAP_HOME, env.context)
+    env.activate
+  end
   
 rescue(Tap::Env::ConfigError)
   # catch errors and exit gracefully
@@ -22,56 +29,51 @@ end
 # run rap
 #
 
-Dir.glob('[TtRr]apfile{,.rb}').each do |rapfile|
-  next unless File.file?(rapfile)
-  env.scan(rapfile, "task|join|middleware")
+env.root.glob(:root, '[TtRr]apfile{,.rb}').each do |rapfile|
+  env.scan(:root, File.basename(rapfile))
   load rapfile
 end
 
 case ARGV[0]
 when '--help', nil, '-T'
-  
-  # same as normal summarize, but pass over tasks that have no comment
-  summary_template = %Q{<% entries.delete_if {|key, const| const.comment.kind_of?(Rap::Description) && const.comment.resolve.desc == nil } %>
-<% if !entries.empty? && count > 1 %>
-<%= env_key %>:
-<% end %>
-<% entries.each do |key, const| %>
-  <%= key.ljust(width) %> # <%= const.comment %>
-<% end %>
-}
-  
+  constants = app.env.constants
+  tasks = constants.summarize do |constant|
+    constant.types['task'] or begin
+      const = constant.constantize(false)
+      const && const.ancestors.include?(Rap::Task) && const.desc ? const.desc.desc : nil
+    end
+  end
+
   puts Lazydoc.usage(__FILE__)
   puts
   puts "===  tap tasks ==="
-  puts env.manifest(:task).summarize(summary_template)
-  
+  puts tasks
   if Rap::Rake.has_rakefile?
     puts
     puts "=== rake tasks ==="
     Rap::Rake.new.execute('-T')
   end
-  
+
   puts
   puts "version #{Rap::VERSION} -- #{Rap::WEBSITE}"
+  
 else
   begin
-    schema = Tap::Schema.parse(ARGV)
-    schema.tasks.each_pair do |key, task|
-      if tasc = env[:task][task[0]]
-        task[0] = tasc
-      elsif Rap::Rake.has_rakefile?
-        warn "warning: implict rake for '#{task.join(' ')}'"
-        task.unshift(Rap::Rake)
+    app.call('sig' => 'parse', 'args' => ARGV) do |spec|
+      type, obj, sig, var, klass = spec
+
+      if type == :node
+        if env.constants.seek(klass).nil? && Rap::Rake.has_rakefile?
+          warn "warning: implict rake for #{spec.inspect}"
+          spec.insert(4, 'rap:rake')
+        end
       end
+
+      true
     end
     
-    app = Tap::App.instance
-    app.build(schema, :resources => env)
-    Tap::Exe.set_signals(app)
     app.run
   rescue
-    raise if $DEBUG
     puts $!.message
     exit(1)
   end

data/doc/Syntax Reference

@@ -27,7 +27,7 @@ Simple documentation:
   
 Extended documentation:
   
-  # ::desc description
+  # :: description
   # Extended documentation may span multiple lines, and 
   # supports
   #

data/lib/rap.rb

@@ -1,13 +1,8 @@
 require 'tap'
 require 'rap/declarations'
+require 'rap/version'
 
 module Rap
   autoload(:Rake, 'rap/rake')
-
-  MAJOR = 0
-  MINOR = 14
-  TINY = 0
-  
-  VERSION="#{MAJOR}.#{MINOR}.#{TINY}"
-  WEBSITE="http://tap.rubyforge.org/rap"
+  RAP_HOME = File.expand_path("#{File.dirname(__FILE__)}/..")
 end

data/lib/rap/declarations.rb

@@ -1,16 +1,15 @@
-require 'rap/task'
+require 'rap/declarations/context'
 
 module Rap
   
-  # Defines the Rap task declaration methods.  They may be included at the
-  # top level (like Rake) or used through Rap.
+  # Defines the Rap task declaration methods.  They may be included at the top
+  # level (like Rake) or used through Rap.
   #
   # === Usage
   #
   # Unlike in rake, task will define actual task classes according to the task
-  # names.  Task classes may be nested within modules using namespace.  It's
-  # VERY important to realize this is the case both to aid in thing like
-  # testing and to prevent namespace conflicts.  For example:
+  # names.  Task classes may be nested within modules using namespace.  For
+  # example:
   #
   #   t = Rap.task(:sample)                  
   #   t.class                            # => Sample
@@ -20,10 +19,10 @@ module Rap
   #     t.class                          # => Nested::Sample
   #   end
   #
-  # Normally all declared tasks are subclasses of Rap::Task, but
-  # subclasses of Rap::Task can declare tasks as well.
+  # Normally all declared tasks are subclasses of Rap::Task, but subclasses of
+  # Rap::Task can declare tasks as well.
   #
-  #   class Alt < Rap::Task
+  #   class Subclass < Rap::Task
   #   end
   #
   #   include Rap::Declarations
@@ -35,46 +34,30 @@ module Rap
   #   o.class.desc.to_s                  # => "task one, a subclass of Rap::Task"
   #
   #   namespace(:nest) do
-  #     desc "task two, a nested subclass of Alt"
-  #     t = Alt.task(:two)
+  #     desc "task two, a nested subclass of Subclass"
+  #     t = Subclass.task(:two)
   #     t.class                          # => Nest::Two
-  #     t.class.superclass               # => Alt
-  #     t.class.desc.to_s                # => "task two, a nested subclass of Alt"
+  #     t.class.superclass               # => Subclass
+  #     t.class.desc.to_s                # => "task two, a nested subclass of Subclass"
   #   end
   #
-  # This feature is only available to subclasses of Rap::Task and can
-  # be very useful for creating inheritance hierarchies.  Note that other
-  # declaration methods like 'desc' and 'namespace' are not available on
-  # Rap::Task or subclasses, just 'task'.
+  # This feature is only available to subclasses of Rap::Task and can be very
+  # useful for creating inheritance hierarchies.  Note that other declaration
+  # methods like 'desc' and 'namespace' are not available on Rap::Task or
+  # subclasses, just 'task'.
   #
-  # See the {Syntax Reference}[link:files/doc/Syntax%20Reference.html] for more
-  # information.
+  # See the {Syntax Reference}[link:files/doc/Syntax%20Reference.html] for
+  # more information.
   module Declarations
-    # 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
     
-    # Sets the declaration environment.
-    def Declarations.env=(env) @@env=env; end
-    
-    # The declaration App (default Tap::App.instance)
-    def Declarations.app() @@app ||= Tap::App.instance; end
-    
-    # Sets the declaration App.
-    def Declarations.app=(app) @@app=app; end
-    
-    # The base constant for all task declarations, prepended to the task name.
-    def Declarations.current_namespace() @@current_namespace; end
-    @@current_namespace = ''
-    
-    # Tracks the current description, which will be used to
-    # document the next task declaration.
-    def Declarations.current_desc() @@current_desc; end
-    @@current_desc = nil
+    # Returns the context app.
+    def app
+      context.app
+    end
     
-    # Returns the instance of the task class in app.
-    def Declarations.instance(tasc)
-      tasc.instance(Declarations.app)
+    # Returns the instance for the class, registered to app.
+    def instance(klass)
+      klass.instance(app)
     end
     
     # Declares a task with a rake-like syntax.  Task generates a subclass of
@@ -86,42 +69,39 @@ module Rap
       end
       
       # generate the task class
-      const_name = File.join(@@current_namespace, name.to_s).camelize
+      const_name = File.join(context.namespace, name.to_s).camelize
       tasc = declaration_class.subclass(const_name, configs, dependencies)
+      register tasc
       
-      # register documentation        
+      # register documentation
       desc = Lazydoc.register_caller(Description)
-      desc.desc = @@current_desc
-      @@current_desc = nil
+      desc.desc = context.desc
+      context.desc = nil
       
       tasc.arg_names = arg_names
       tasc.desc = desc
-      tasc.source_file = desc.document.source_file
       
       # add the action
       tasc.actions << action if action
       
-      # register
-      register tasc
-      
       # return the instance
-      instance = Declarations.instance(tasc)
-      instance.config.bind(instance, true)
+      instance = tasc.instance(app)
+      instance.config.import(configs)
       instance
     end
     
     # Nests tasks within the named module for the duration of the block.
     # Namespaces may be nested.
     def namespace(name)
-      previous_namespace = @@current_namespace
-      @@current_namespace = File.join(previous_namespace, name.to_s.underscore)
+      previous_namespace = context.namespace
+      context.namespace = File.join(previous_namespace, name.to_s.underscore)
       yield
-      @@current_namespace = previous_namespace
+      context.namespace = previous_namespace
     end
     
     # Sets the description for use by the next task declaration.
     def desc(str)
-      @@current_desc = str
+      context.desc = str
     end
     
     private
@@ -195,6 +175,11 @@ module Rap
       name.to_s.tr(":", "/")
     end
     
+    # The declarations context.
+    def context
+      @context ||= Context.instance
+    end
+    
     # The class of task declared by task, by default Rap::Task. 
     # Used as a hook to set the declaring class in including modules 
     # (such as Rap::Task itself).
@@ -202,22 +187,10 @@ module Rap
       Rap::Task
     end
     
-    # Registers a task class with the Declarations.env, if necessary.
+    # Registers a task class with the Declarations.app.env, if necessary.
     # Returns task_class.
     def register(tasc)
-      tasks = Declarations.env.manifest(:task)
-      
-      const_name = tasc.to_s
-      constant = tasks.find do |const| 
-        const.const_name == const_name
-      end
-      
-      unless constant
-        constant = Tap::Env::Constant.new(const_name)
-        tasks.entries << constant
-      end
-      
-      constant.comment = tasc.desc(false)
+      app.env.register(tasc)
       tasc
     end
   end
@@ -226,6 +199,7 @@ module Rap
     class << self
       # :stopdoc:
       alias original_desc desc
+      alias original_instance instance
       # :startdoc:
       
       include Declarations
@@ -234,8 +208,11 @@ module Rap
       undef_method :desc
       alias desc original_desc
       
+      undef_method :instance
+      alias instance original_instance
+      
       # hide remaining Declarations methods (including Utils methods)
-      private :namespace
+      private :namespace, :app
       # :startdoc:
       
       private

data/lib/rap/declarations/context.rb

@@ -0,0 +1,30 @@
+require 'rap/task'
+
+module Rap
+  module Declarations
+    class Context
+      class << self
+        def instance
+          @instance ||= new
+        end
+      end
+      
+      # The declarations App
+      attr_accessor :app
+      
+      # The base constant for all task declarations, prepended to the task name.
+      attr_accessor :namespace
+      
+      # Tracks the current description, which will be used to document the
+      # next task declaration.
+      attr_accessor :desc
+      
+      def initialize(app=Tap::App.instance)
+        app.env ||= Tap::Env.new
+        @app = app
+        @namespace = ""
+        @desc = nil
+      end
+    end
+  end
+end

data/lib/rap/description.rb

@@ -6,7 +6,7 @@ module Rap
   #
   # Description instances can be assigned a description, or they may parse
   # one directly from the comment.  Comment lines with the constant attribute
-  # '::desc' will have the value set as desc.
+  # '::' will have the value set as desc.
   # :startdoc:::+
   class Description < Lazydoc::Comment
     
@@ -15,7 +15,7 @@ module Rap
     
     # Parses in-comment descriptions from prepended lines, if present.
     def prepend(line)
-      if line =~ /::desc(?:\s+(.*?))?\s*$/
+      if line =~ /\s::(?:\s+(.*?)\s*)?$/
         self.desc = $1.to_s
         false
       else

data/lib/rap/rake.rb

@@ -17,17 +17,15 @@ module Rap
   #
   class Rake < Tap::Task
     class << self
-
-      # Overrides Tap::Support::FrameworkClass#parse! to do  
-      # nothing so that all args get passed forward to rake.
-      def parse!(argv, app=Tap::App.instance) # => instance, argv
+      
+      def parse!(argv, app=Tap::App.instance)
         if argv.include?('--help')
           puts help
           exit
         end
         argv.collect! {|arg| arg == '--rake-help' ? '--help' : arg}
         
-        new({}, app)
+        [new({}, app), argv]
       end
       
       # Returns true if Rake detects a rakefile.

data/lib/rap/task.rb

@@ -1,7 +1,8 @@
 require 'tap/task'
 require 'tap/env'
-require 'ostruct'
 require 'rap/description'
+require 'rap/utils'
+require 'ostruct'
 
 module Rap
   
@@ -26,7 +27,7 @@ module Rap
   #   #   def helper(); "help"; end
   #   # end
   #   #
-  #   # # ::desc a help task
+  #   # # :: a help task
   #   # Subclass.task(:help) {|task, args| puts "got #{task.helper}"}
   #   
   #   % rap help
@@ -40,15 +41,10 @@ module Rap
 
       # 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)
+        app.objects[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
@@ -90,26 +86,29 @@ module Rap
       #   B world
       #
       def parse!(argv=ARGV, app=Tap::App.instance)
-        instance = super
+        parser = self.parser
         
-        # store args on instance and clear so that instance
-        # will not be enqued with any inputs
-        instance.args = argv.dup
-        argv.clear
+        argv = parser.parse!(argv, :add_defaults => false)
+        enque = parser.config.delete('enque')
+        instance = build({'config' => parser.nested_config, 'args' => argv.dup}, app)
         
-        instance
+        # enque with no inputs to satisfy call, and
+        # clear argv so auto-enque will do the same
+        instance.enq if enque
+        
+        [instance, []]
       end
       
       # Instantiates the instance of self for app and reconfigures it as
       # specified in argh.
-      def instantiate(argh={}, app=Tap::App.instance)
+      def build(argh={}, app=Tap::App.instance)
         instance = self.instance(app)
         
-        if config = argh[:config]
+        if config = argh['config']
           instance.reconfigure(config)
         end
         
-        if args = argh[:args]
+        if args = argh['args']
           instance.args = args
         end
         
@@ -202,7 +201,8 @@ module Rap
       end
     end
     
-    instance_variable_set(:@dependencies, [])
+    # This sets the class-level dependencies array.
+    @dependencies = []
     
     # An array of node dependencies
     attr_reader :dependencies
@@ -301,7 +301,6 @@ module Rap
       end
       self
     end
-    
   end
   
   # Raised for circular dependencies during Rap::Task.resolve!

data/lib/rap/version.rb

@@ -0,0 +1,8 @@
+module Rap
+  MAJOR = 0
+  MINOR = 15
+  TINY = 0
+  
+  VERSION="#{MAJOR}.#{MINOR}.#{TINY}"
+  WEBSITE="http://tap.rubyforge.org/rap"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rap
 version: !ruby/object:Gem::Version 
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-17 00:00:00 -06:00
+date: 2009-12-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.18.0
+        version: 0.19.0
     version: 
 description: 
 email: simon.a.chiang@gmail.com
@@ -36,10 +36,12 @@ extra_rdoc_files:
 files: 
 - lib/rap/task.rb
 - lib/rap/declarations.rb
+- lib/rap/declarations/context.rb
 - lib/rap/description.rb
 - lib/rap/rake.rb
 - lib/rap.rb
 - lib/rap/utils.rb
+- lib/rap/version.rb
 - tap.yml
 - README
 - MIT-LICENSE
@@ -47,6 +49,8 @@ files:
 - doc/Syntax Reference
 has_rdoc: true
 homepage: http://tap.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -72,9 +76,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: tap
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A rakish extension to tap.
 test_files: []