reap 4.5.2 → 5.0.0

data/doc/note/application.rb

@@ -0,0 +1,124 @@
+
+
+module Reap
+
+  class Application
+
+    def initialize
+      @tasks = {}
+    end
+
+    attr :tasks
+    attr_accessor :last_desc
+
+    def define_task( args, &block )
+      raise ArgumentError, "#{args.size} for 1" if Hash===args and args.size != 1
+      name, deps = parse_args( args )
+      new_task = Task.new( last_desc, deps, &block )
+      new_task.application = self
+      last_desc = nil
+      @tasks[name] = new_task
+    end
+
+    def attach_help( task, doc )
+      raise unless @tasks.has_key?(task.to_sym)
+      @tasks[task].help = doc
+    end
+
+    def run( task )
+      @tasks[task.to_sym].call
+    end
+
+    private
+
+    def parse_args( args )
+      if Hash === args
+        raise ArgumentError, "#{args.size} for 1" if args.size != 1
+        name, deps = *(args.to_a.flatten)
+        name = name.to_sym
+        deps = [deps].compact.collect{ |e| e.to_sym }
+      else
+        name, deps = args.to_sym, []
+      end
+      return name, deps
+    end
+
+  end
+
+
+  class Task
+
+    def initialize( name, deps, &action )
+      @name = name
+      @dependencies = deps
+      @action = action
+      @complete = false
+    end
+
+    attr :dependencies
+    attr_accessor :help, :application
+
+    def complete?
+      @complete
+    end
+
+    def call
+      @dependencies.each{ |d|
+        application.tasks[d].call unless application.tasks[d].complete?
+      }
+      @action.call
+      @complete = true
+    end
+
+    def to_proc
+      @action
+    end
+
+  end
+
+end
+
+
+
+module Reap
+
+  def application
+    @application ||= Reap::Application.new
+  end
+
+  def desc( line )
+    application.last_desc = line.gsub("\n",'')
+  end
+
+  def task( args, &block )
+    application.define_task( args, &block )
+  end
+
+  # Define help documentation for a task.
+  def help( task_name, doc )
+    application.attach_help( task_name, doc )
+  end
+
+end
+
+
+include Reap
+
+
+
+
+desc "Milk the cow!"
+task :milk do
+  puts "milk"
+end
+
+desc "Jump over the moon!"
+task :jump => [ :milk, :milk ] do
+  #milk; milk
+  puts "jump"
+end
+
+task :package, Package
+
+application.run( :jump )
+

data/doc/note/intro.txt

@@ -0,0 +1,42 @@
+
+An Introduction to Reap
+A Ruby Package Assitant
+
+
+
+  task :name do
+
+    when { projectfile? }
+
+    help <<-end
+      Help information.
+    end
+
+    run do |x|
+      # do the task
+    end
+
+  end
+
+
+
+
+  desc "This is a description"
+
+  task :name do |x|
+    # do the task
+  end
+
+  cont do
+
+    help <<-end
+      This is help text.
+    end
+
+    when do
+      projectfile?
+    end
+
+  end
+
+

data/lib/reap/app.rb

@@ -0,0 +1,74 @@
+
+module Reap
+
+  def self.application
+    Application.instance
+  end
+
+  class Application
+
+    def self.instance
+      @application ||= self.new
+    end
+
+    attr :tasks, :projectfile
+
+    def initialize
+      @tasks = {}
+      @projectfile = ProjectInfo.find
+      if @projectfile
+        @projectdir = File.dirname( @projectfile )
+        Dir.chdir( @projectdir )
+      end
+      require_custom_tasks
+      if @projectfile
+        require_custom_project_tasks
+        @projectinfo = ProjectInfo.load( @projectfile  )
+      end
+      initialize_tasks
+      initialize_special_tasks
+    end
+
+    def projectfile?() @projectfile end
+
+    def add_task( task )
+      @tasks[task.task_name] = task
+    end
+
+    # Load custom tasks.
+    def require_custom_tasks
+      # Universal custom tasks for all projects.
+      dir = File.join( Config::CONFIG['datadir'], 'reap/task' )
+      require_all( File.join(dir, '*') ) if File.directory?(dir)
+      # Personal tasks for all projects.
+      dir = File.expand_path( '~/.share/reap/task' )
+      require_all( File.join(dir, '*') ) if File.directory?(dir)
+    end
+
+    # Project specific tasks.
+    def require_custom_project_tasks
+      require_all('task/*') if File.directory?('task')
+    end
+
+    def initialize_tasks
+      return unless @projectinfo
+      @projectinfo.each { |key, value|
+        add_task( value ) if Reap::Task === value
+      }
+    end
+
+    # Load special tasks. There are tasks that don't require
+    # a ProjectInfo section or other special requirements.
+    def initialize_special_tasks
+      Reap.registry.each { |taskclass|
+        if taskclass.available?( self )
+          task = taskclass.new({})
+          task.task_name = taskclass.task_class
+          tasks[task.task_name] = task
+        end
+      }
+    end
+
+  end
+
+end

data/lib/reap/bin/reap.rb

@@ -6,11 +6,8 @@ require 'facets'
 require 'consoleapp'
 #require 'console/command'
 
-
-
 require 'reap/reap'
 
-
 class ReapCommand < Console::Command
 
   # to do first for every task
@@ -57,8 +54,6 @@ class ReapCommand < Console::Command
   #def _f( pif ) ; $PROJECT_FILE = pif ; end
   #alias_method :_f, :__file
 
-  # Commands
-
   # default action
 
   def default
@@ -68,15 +63,19 @@ class ReapCommand < Console::Command
   # display version
 
   def version
-    puts "Reap  v#{Reap::Version}"
+    puts "Reap v#{Reap::Version}"
     exit 0
   end
 
   # display help
 
-  def help(*args)
-    unless args.empty?
-      t = Reap.tasks[args[0]]
+  def help(tsk=nil)
+    if tsk
+      t = Reap.application.tasks[tsk]
+      unless t
+        puts "Unknown task '#{tsk}'."
+        exit 0
+      end
       s = "\n"
       s << "#{args[0]}: "
       s << t.task_desc.sub(/^\n+/, '').rstrip
@@ -95,93 +94,58 @@ class ReapCommand < Console::Command
   # list available tasks
 
   def tasks
-    #if Reap.projectfile?
-      tasklist = []
-      taskhash = {}
-      Reap.tasks.each { |key,taskclass|
-        taskhash[key] = taskclass #if taskclass.available?
-      }
-      if taskhash.empty?
-        puts "No tasks available."
-      else
-        sorted = taskhash.keys.sort
-        margin = sorted.collect{ |n| n.size }.max + 6
-        sorted.each do |name|
-          taskclass = taskhash[name]
-          tasklist << "  #{name}".ljust(margin) + "#{taskclass.task_desc}"
-        end
-        puts
-        puts tasklist.join("\n")
-        puts
+    app = Reap.application
+    tasklist = []
+    if app.tasks.empty?
+      puts "No tasks available."
+    else
+      sorted = app.tasks.keys.sort
+      margin = sorted.collect{ |t| t.size }.max + 6
+      sorted.each do |name|
+        tasklist << "  #{name}".ljust(margin) + "#{app.tasks[name].task_desc}"
       end
-    #else
-    #  puts "No project information file found."
-    #end
-    #exit 0
+      puts "(#{Dir.pwd})"
+      puts
+      puts tasklist.join("\n")
+      puts
+    end
   end
-  alias_method :ls, :tasks
+  #alias_method :ls, :tasks
 
   # Add all the reap tasks.
 
-  Reap.register
-
-  Reap.tasks.each { |sym,taskclass|
-    #if taskclass.available? #taskclass.section_required? or (taskclass.section_required? and pi)
-      define_method(sym) { |*args|
-        taskclass.new(*args).execute
-      }
-    #end
-  }
+  app = Reap.application
+  app.tasks.each do |name, task|
+    define_method(name) { |*args|
+      #puts "(#{Dir.pwd})"
+      task.execute( *args )
+    }
+  end
 
 end
 
 
 HELP = <<-HERE
 
-  reap v#{::Reap::Version}
-
-  USAGE: reap [options...] <command> [arguments...]
+  reap [options...] <command> [arguments...]
 
   COMMANDS:
 
     tasks
       List all the current tasks with descriptions.
-      This is the default action if no command
-      is given. (Also aliased as 'ls'.)
+      (This is the default if no command is given.)
 
     help [task]
-      Displays this help information. If a task name
-      is given, it will provide help information
-      specific to that task.
-
-    template
-        Copies a ProjectInfo template into the current
-        directory (if it does not already exist).
-
-    scaffold [type]
-        Builds a starter project in the current directory.
-        There are two types: 'standard' and 'subversion'.
-        These can be abbreviated 'std' and 'svn', repectively.
-        If no type is given then standard is used.
+      Displays this help information. If a task name is given,
+      it will provide help information specific to that task.
 
   OPTIONS:
 
-    -v --version
-        Display the current version.
-
-    -V --verbose
-        Provides extra verbose processing information.
-
-    -f --force
-        Forces certain operations to be performed.
-
-    -D --debug
-        Provides extra verbose processing information.
-
-    -f --file
-        Specify alternate project file.
-
-    -h --help
-        Display this help information.
+    -h --help      Display this help information.
+    -v --version   Display the current version.
+    -V --verbose   Provides extra verbose processing information.
+    -f --force     Forces certain operations to be performed.
+    -D --debug     Provides extra verbose processing information.
+    -f --file      Specify alternate project file.
 
 HERE

data/lib/reap/projectinfo.rb

@@ -9,21 +9,6 @@ require 'facet/kernel/require_all'
 require 'facet/basicobject'
 
 
-module Reap
-
-  def self.register #( alternative_project_file=nil )
-    pi = ProjectInfo.load( nil, true )
-    pi.require_custom_tasks if pi
-    pi
-  end
-
-  def self.projectfile?
-    ProjectInfo.instance.info_file
-  end
-
-end
-
-
 # Project information, generally read from a file.
 # Simply by calling 'ProjectInfo.load'.
 #
@@ -49,20 +34,6 @@ class ProjectInfo
       @instance ||= new( *args, &block )
     end
 
-    # Load the project information from a file. Generally
-    # no file needs to be specified; the file will be found
-    # by ascending up the current path until a default
-    # file name is found (eg. ProjectInfo or Reapfile).
-
-    def load( fpath=nil, report=false )
-      if fpath
-        new.read( fpath, report )
-      else
-        fpath = find
-        instance.read( fpath, report )
-      end
-    end
-
     # Find project information file.
 
     def find
@@ -75,9 +46,14 @@ class ProjectInfo
       return File.join( info_dir, info_file )
     end
 
-    #def add_file( f )
-    #  INFO_FILES.unshift( f )
-    #end
+    # Load the project information from a file. Generally
+    # no file needs to be specified; the file will be found
+    # by ascending up the current path until a default
+    # file name is found (eg. ProjectInfo or Reapfile).
+
+    def load( fpath=nil )
+      instance.read( fpath )
+    end
 
   end
 
@@ -111,7 +87,7 @@ class ProjectInfo
 
   # Load project information from YAML file.
 
-  def read( fpath, report=true )
+  def read( fpath )
     return unless fpath
 
     @info_dir = File.dirname( fpath )
@@ -119,14 +95,15 @@ class ProjectInfo
     @info_stream = File.read( fpath ).strip
     @info = YAML::load( info_stream ).traverse{ |k,v| [k.to_s.downcase, v] }
 
-    Dir.chdir(@info_dir)
-    if report
-      puts "(in #{Dir.pwd})" #unless dir == Dir.pwd
-    end
-
     #validate
     defaults
 
+    @info.each do |key, value|
+      case value when Reap::Task
+        value.task_name = key
+      end
+    end
+
     self
   end
 
@@ -177,19 +154,6 @@ class ProjectInfo
     self['homepage']    ||= self['rubyforge'] ? self['rubyforge']['homepage'] : nil
   end
 
-  # Load custom tasks.
-
-  def require_custom_tasks
-    # Universal custom tasks for all projects.
-    dir = File.join( Config::CONFIG['datadir'], 'reap/task' )
-    require_all( File.join(dir, '*') ) if File.directory?(dir)
-    # Personal tasks for all projects.
-    dir = File.expand_path( '~/.share/reap/task' )
-    require_all( File.join(dir, '*') ) if File.directory?(dir)
-    # Project specific tasks.
-    require_all('task/*') if File.directory?('task')
-  end
-
   # Convert to a CascadinOpenObject.
 
   def to_cascading_open_object
@@ -208,10 +172,14 @@ class ProjectInfo
     info[name] = x
   end
 
+  def each( &block )
+    @info.each( &block )
+  end
+
   # Information to hash.
 
   def to_h
-    @info
+    @info.dup
   end
 
 end