main 2.0.0 → 2.1.0

data/README

@@ -370,6 +370,36 @@ DOCS
   API section below
 
 HISTORY
+  2.1.0
+    - added custom error handling dsl for parameters, this includes the ability
+      to prepend, append, or replace the standard error handlers:
+
+        require 'main'
+
+        Main {
+          argument 'x' do
+            error :before do
+              puts 'this fires *before* normal error handling using #instance_eval...'
+            end
+
+            error do
+              puts 'this fires *instead of* normal error handling using #instance_eval...'
+            end
+
+            error :after do
+              puts 'this fires *after* normal error handling using #instance_eval...'
+            end
+          end
+          
+          run(){ p param['x'].given? }
+        }
+
+    - added ability to exit at any time bypassing *all* error handling using
+      'throw :exit, 42' where 42 is the desired exit status.  throw without a
+      status simply exits with 0.
+
+    - added 'help!' method which simply dumps out usage and exits
+
   2.0.0
     - removed need for proxy.rb via Main::Base.wrap_run!
     - added error handling hooks for parameter parsing
@@ -617,6 +647,20 @@ API
     # defaults for paramters of > 1 arity
     #
       defaults 40, 2
+    #
+    # you can add custom per-parameter error handlers using the following
+    #
+      error :before do
+        puts 'this fires *before* normal error handling using #instance_eval...'
+      end
+
+      error do
+        puts 'this fires *instead of* normal error handling using #instance_eval...'
+      end
+
+      error :after do
+        puts 'this fires *after* normal error handling using #instance_eval...'
+      end
     }
 
   ###########################################################################

data/README.tmpl

@@ -186,6 +186,36 @@ DOCS
   API section below
 
 HISTORY
+  2.1.0
+    - added custom error handling dsl for parameters, this includes the ability
+      to prepend, append, or replace the standard error handlers:
+
+        require 'main'
+
+        Main {
+          argument 'x' do
+            error :before do
+              puts 'this fires *before* normal error handling using #instance_eval...'
+            end
+
+            error do
+              puts 'this fires *instead of* normal error handling using #instance_eval...'
+            end
+
+            error :after do
+              puts 'this fires *after* normal error handling using #instance_eval...'
+            end
+          end
+          
+          run(){ p param['x'].given? }
+        }
+
+    - added ability to exit at any time bypassing *all* error handling using
+      'throw :exit, 42' where 42 is the desired exit status.  throw without a
+      status simply exits with 0.
+
+    - added 'help!' method which simply dumps out usage and exits
+
   2.0.0
     - removed need for proxy.rb via Main::Base.wrap_run!
     - added error handling hooks for parameter parsing
@@ -433,6 +463,20 @@ API
     # defaults for paramters of > 1 arity
     #
       defaults 40, 2
+    #
+    # you can add custom per-parameter error handlers using the following
+    #
+      error :before do
+        puts 'this fires *before* normal error handling using #instance_eval...'
+      end
+
+      error do
+        puts 'this fires *instead of* normal error handling using #instance_eval...'
+      end
+
+      error :after do
+        puts 'this fires *after* normal error handling using #instance_eval...'
+      end
     }
 
   ###########################################################################

data/a.rb

@@ -1,26 +1,21 @@
 require 'main'
 
-main(){
-  argument('foo'){
-    arity -1
-  }
+puts Main.version
 
-  mode 'a' do
-    argument('bar'){
-      arity -1
-    }
-    run { 
-      foobar
-      puts 'a' 
-    }
-  end
+Main {
+  argument 'x' do
+    error :before do
+      puts 'this fires *before* normal error handling using #instance_eval...'
+    end
 
-  run { 
-      foobar
-    puts 'no mode' 
-  }
+    error do
+      puts 'this fires *instead of* normal error handling using #instance_eval...'
+    end
 
-  def foobar
-    puts :foobar
+    error :after do
+      puts 'this fires *after* normal error handling using #instance_eval...'
+    end
   end
+  
+  run(){ p param['x'].given? }
 }

data/gemspec.rb

@@ -19,6 +19,9 @@ Gem::Specification::new do |spec|
   spec.has_rdoc = File::exist? "doc" 
   spec.test_suite_file = "test/#{ lib }.rb" if File::directory? "test"
 
+  spec.add_dependency 'attributes', '>= 4.1.0'
+  spec.add_dependency 'arrayfields', '>= 4.3.0'
+
   spec.extensions << "extconf.rb" if File::exists? "extconf.rb"
 
   spec.author = "Ara T. Howard"

data/lib/main.rb

@@ -2,7 +2,7 @@ module Main
 #
 # top level constants
 #
-  Main::VERSION = '2.0.0' unless
+  Main::VERSION = '2.1.0' unless
     defined? Main::VERSION
   def self.version() Main::VERSION end
 
@@ -19,33 +19,28 @@ module Main
   require 'logger'
   require 'enumerator'
   require 'set'
-
 #
 # we try to use gems to pick up dependancies
 #
-
-=begin
   begin
     require 'rubygems'
   rescue LoadError
     42
   end
   begin
+    gem 'attributes', '~> 4.1.0'
     require 'attributes'
-  rescue LoadError
+  rescue Exception 
     require libdir + 'attributes'
   end
   begin
+    gem 'attributes', '~> 4.3.0'
     require 'arrayfields'
-  rescue LoadError
+  rescue Exception 
     require libdir + 'arrayfields'
   end
-=end
-  require libdir + 'attributes'
-  require libdir + 'arrayfields'
-
 #
-# main libs
+# main's own libs
 #
   require libdir + 'stdext'
   require libdir + 'softspoken'
@@ -58,4 +53,3 @@ module Main
   require libdir + 'base'
   require libdir + 'factories'
 end
-

data/lib/main/base.rb

@@ -6,28 +6,34 @@ module Main
 
         class_eval do
           def run *a, &b
-            begin
-              argv.push "--#{ argv.shift }" if argv.first == 'help'
+            status =
+              catch :exit do
+                begin
+                  argv.push "--#{ argv.shift }" if argv.first == 'help'
 
-              return mode_run! if mode_given?
+                  return mode_run! if mode_given?
 
-              parse_parameters
+                  parse_parameters
 
-              if params['help'] and params['help'].given?
-                print usage.to_s
-                exit
-              end
+                  if params['help'] and params['help'].given?
+                    print usage.to_s
+                    exit
+                  end
 
-              pre_run
+                  pre_run
 
-              self.class.const_get(:RUN).bind(self).call(*a, &b)
+                  self.class.const_get(:RUN).bind(self).call(*a, &b)
 
-              post_run
+                  post_run
 
-              finalize
-            rescue Exception => e
-              handle_exception e
-            end
+                  finalize
+                rescue Exception => e
+                  handle_exception e
+                end
+                nil
+              end
+
+            handle_throw status
           end
         end
       end
@@ -322,20 +328,53 @@ module Main
       main.run
     end
 
+    def help! status = 0
+      print usage.to_s
+      exit(status)
+    end
+
     def handle_exception e
-      if e.respond_to? :status
-        exit_status(( e.status ))
+      if e.respond_to?(:before_handler)
+        fcall(e, :before_handler, self)
       end
 
-      if Softspoken === e or SystemExit === e
-        stderr.puts e.message unless(SystemExit === e and e.message.to_s == 'exit')
+      if e.respond_to?(:handler)
+        fcall(e, :handler, self)
       else
-        fatal{ e }
+        if e.respond_to? :status
+          exit_status(( e.status ))
+        end
+
+        if Softspoken === e or SystemExit === e
+          stderr.puts e.message unless(SystemExit === e and e.message.to_s == 'exit')
+        else
+          fatal{ e }
+        end
+      end
+
+      if e.respond_to?(:after_handler)
+        fcall(e, :after_handler, self)
       end
 
       exit_status(( exit_failure )) if exit_status == exit_success
       exit_status(( Integer(exit_status) rescue(exit_status ? 0 : 1) ))
       exit exit_status
     end
+
+    def fcall obj, m, *argv, &block
+      m = obj.method m
+      arity = m.arity
+      if arity >= 0
+        argv = argv[0, arity]
+      else
+        arity = arity.abs - 1
+        argv = argv[0, arity] + argv[arity .. -1]
+      end
+      m.call *argv, &block
+    end
+
+    def handle_throw status
+      exit(( Integer(status) rescue 0 ))
+    end
   end
 end

data/lib/main/parameter.rb

@@ -69,6 +69,10 @@ module Main
     attribute 'arity' => 1
     attribute 'required' => false
 
+    attribute 'before_handler'
+    attribute 'error_handler'
+    attribute 'after_handler'
+
     def initialize name, *names, &block
       @names = Cast.list_of_string name, *names
       @names.map! do |name|
@@ -136,9 +140,11 @@ module Main
 
     def setup!
       return false unless given?
-      check_arity
-      apply_casting
-      check_validation
+      adding_handlers do
+        check_arity
+        apply_casting
+        check_validation
+      end
       true
     end
 
@@ -182,6 +188,42 @@ module Main
       end
     end
 
+    def add_handlers e
+      sc = 
+        class << e
+          self
+        end
+
+      this = self
+
+      if before_handler?
+        sc.module_eval do
+          define_method(:before_handler){|main| main.instance_eval &this.before_handler}
+        end
+      end
+
+      if error_handler?
+        sc.module_eval do
+          define_method(:handler){|main| main.instance_eval &this.error_handler}
+        end
+      end
+
+      if after_handler?
+        sc.module_eval do
+          define_method(:after_handler){|main| main.instance_eval &this.after_handler}
+        end
+      end
+    end
+
+    def adding_handlers
+      begin
+        yield
+      rescue Exception => e
+        add_handlers e
+        raise
+      end
+    end
+
     class Argument < Parameter
       attribute 'required' => true
 
@@ -385,8 +427,10 @@ module Main
 
       def validate!
         each do |p|
-          next if p.arity == -1
-          raise NotGiven, "#{ p.typename } not given" if(p.required? and (not p.given?))
+          p.adding_handlers do
+            next if p.arity == -1
+            raise NotGiven, "#{ p.typename } not given" if(p.required? and (not p.given?))
+          end
         end
       end
 
@@ -516,6 +560,10 @@ module Main
       def arity?
         p.arity?
       end
+
+      def error which = :error, &block
+        p.send "#{ which }_handler=", block
+      end
     end
 
     class Table < ::Array

data/test/main.rb

@@ -41,6 +41,9 @@ class T < Test::Unit::TestCase
           raise
         end
       end
+
+      define_method :handle_throw do |*a|
+      end
     end
 
     main = klass.new argv, env

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: main
 version: !ruby/object:Gem::Version 
-  version: 2.0.0
-date: 2007-10-18 00:00:00 -06:00
+  version: 2.1.0
+date: 2007-10-20 00:00:00 -06:00
 summary: main
 require_paths: 
 - lib
@@ -50,6 +50,7 @@ files:
 - lib/main/usage.rb
 - lib/main/util.rb
 - lib/main.rb
+- main-2.0.0.gem
 - README
 - README.tmpl
 - samples
@@ -61,7 +62,6 @@ files:
 - samples/f.rb
 - test
 - test/main.rb
-- TODO
 test_files: 
 - test/main.rb
 rdoc_options: []
@@ -74,5 +74,22 @@ extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: attributes
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 4.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: arrayfields
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 4.3.0
+    version: 

data/TODO

@@ -1,2 +0,0 @@
-* error handling for parameter parsing - callback hooks 
-* mode handling