main 6.3.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b6289d780438645efdd78c3c1dd205d93af94185ee591e7abbccd7f9092637f
-  data.tar.gz: 566196b12fb4268421df5f0a87ed1fdafb46424688b62bfedae86f477bb8a610
+  metadata.gz: '0599943ad7c254dc66a971cf4106c1681e749539715d097660c71e89d9b8296e'
+  data.tar.gz: d0adfd263b9f1866b34ee50d4f4f6449d71a6db03019cd5819478f177ce53a58
 SHA512:
-  metadata.gz: dcf296c3b1d49b6f4c001ac582d108cda0a12547827ef63c3310ff52342fca6c4b9c73556c19e68e7933cc688c74fd83cae3631f1b0fa3d576a1aabbd6f1205c
-  data.tar.gz: e064f2590b78ac9a900716f09771254599084d307356d5c8ffca51acf69790f62068d561bb3d98d7210b71737d896b47d7f30392585212a295ac2d3c13aa58c2
+  metadata.gz: 499625257c9d8abfad6748ddf2816d1273726bbbfb064c54e1df4103e14b4903df84b7756354e02b732ba613a2c67f83d5520aaa9e47958fa2cbd51cb1b79898
+  data.tar.gz: 439fc076475d87ceff4f632249f3728c1bf7e007d2c72d2f2c7fdf0013efe0f5fcbe3b11103c0acc726f5141286c45d8e5feaab2d94e5b279ae076f6c399bd93

data/LICENSE

@@ -0,0 +1 @@
+Ruby

data/README.erb

@@ -48,8 +48,8 @@ DESCRIPTION
       end
     }
 
-  sets up a program which requires one argument, 'bar', and which may accept one
-  command line switch, '--foo' in addition to the single option/mode which is always
+  sets up a program which requires one argument, 'foo', and which may accept one
+  command line switch, '--bar' in addition to the single option/mode which is always
   accepted and handled appropriately: 'help', '--help', '-h'.  for the most
   part main.rb stays out of your command line namespace but insists that your
   application has at least a help mode/option.
@@ -372,7 +372,7 @@ HISTORY
           end
         }
 
-    - added sanity check at end of paramter contruction
+    - added sanity check at end of paramter construction
 
     - improved auto usage generation when arity is used with arguments
 
@@ -627,7 +627,7 @@ HISTORY
 
     initial version.  this version extracts much of the functionality of alib's
     (gen install alib) Alib.script main program generator and also some of jim's
-    freeze's excellent CommandLine::Aplication into what i hope is a simpler and
+    freeze's excellent CommandLine::Application into what i hope is a simpler and
     more unified interface 
 
 API

data/Rakefile

@@ -98,7 +98,7 @@ task :gemspec do
     This.extensions = []
     extensions = This.extensions
     %w( Makefile configure extconf.rb ).each do |ext|
-      extensions << ext if File.exists?(ext)
+      extensions << ext if File.exist?(ext)
     end
   end
   extensions = [extensions].flatten.compact
@@ -137,6 +137,7 @@ task :gemspec do
             spec.require_path = "lib"
 
             spec.test_files = <%= test_files.inspect %>
+            spec.required_ruby_version = '>= 2.0'
 
             <% dependencies.each do |lib_version| %>
               spec.add_dependency(*<%= Array(lib_version).flatten.inspect %>)

data/a.rb

@@ -0,0 +1,14 @@
+require './lib/main'
+
+ARGV.replace %w()
+Main {
+  option('foo', 'f'){
+    #required  # by default options are not required, we could use 'foo=foo'
+              # above as a shortcut
+   # argument_required
+  }
+
+  def run
+    p "Did you pass --foo ? #{params['foo'].given? == true}"
+  end
+}

data/lib/main/parameter.rb

@@ -69,7 +69,7 @@ module Main
     fattr('defaults'){ [] }
     fattr('examples'){ [] }
 
-    fattr 'arity' => 1
+    fattr('arity'){ 1 }
     fattr 'required' => false
 
     fattr 'error_handler_before'
@@ -149,7 +149,7 @@ module Main
     end
 
     def argument_required?
-      argument and 
+      argument and
         argument.to_s.downcase.to_sym == :required
     end
     def argument_optional?
@@ -160,22 +160,10 @@ module Main
     def optional?
       not required?
     end
-    def optional= bool 
+    def optional= bool
       self.required !bool
     end
 
-=begin
-    def setup!
-      return false unless given?
-      adding_handlers do
-        check_arity
-        apply_casting
-        check_validation
-      end
-      true
-    end
-=end
-
     def setup!
       adding_handlers do
         check_arity
@@ -184,13 +172,18 @@ module Main
       end
     end
 
-    def check_arity 
+    def check_arity
       return true if not given? and optional?
 
+      arity = self.arity
       ex = values.size == 0 ? NotGiven : Arity
 
       (raise ex, "#{ typename })" if values.size.zero? and argument_required?) unless arity == -1
 
+      if arity >= 0 && values.size > arity
+        raise ex, "#{ typename } #{ values.size }/#{ arity }"
+      end
+
       if arity >= 0
         min = arity
         sign = ''
@@ -203,14 +196,14 @@ module Main
 
       if values.size < arity
         if argument_optional?
-          raise ex, "#{ typename }) #{ values.size }/#{ sign }#{ arity }" if(values.size < arity and values.size > 0)
+          raise ex, "#{ typename } #{ values.size }/#{ sign }#{ arity }" if(values.size < arity and values.size > 0)
         elsif argument_required? or argument_none?
-          raise ex, "#{ typename }) #{ values.size }/#{ sign }#{ arity }" if(values.size < arity)
+          raise ex, "#{ typename } #{ values.size }/#{ sign }#{ arity }" if(values.size < arity)
         end
       end
     end
 
-    def apply_casting 
+    def apply_casting
       if cast?
         op = cast.respond_to?('call') ? cast : Cast[cast]
         case op.arity
@@ -225,17 +218,17 @@ module Main
       end
     end
 
-    def check_validation 
+    def check_validation
       if validate?
         values.each do |value|
-          validate[value] or 
+          validate[value] or
             raise InValid, "invalid: #{ typename }=#{ value.inspect }"
         end
       end
     end
 
     def add_handlers e
-      esc = 
+      esc =
         class << e
           self
         end
@@ -244,7 +237,7 @@ module Main
         getter = "error_handler_#{ which }"
         query = "error_handler_#{ which }?"
         if send(query)
-          handler = send getter 
+          handler = send getter
           esc.module_eval do
             define_method(getter) do |main|
               main.instance_eval_block self, &handler
@@ -276,7 +269,7 @@ module Main
       fattr 'synopsis' do
         label = name
         op = required ? "->" : "~>"
-        value = defaults.size > 0 ? "#{ name }=#{ defaults.join ',' }" : name 
+        value = defaults.size > 0 ? "#{ name }=#{ defaults.join ',' }" : name
         value = "#{ cast }(#{ value })" if(cast and not cast.respond_to?(:call))
         "#{ label } (#{ arity } #{ op } #{ value })"
       end
@@ -284,16 +277,16 @@ module Main
 
     class Option < Parameter
       fattr 'required' => false
-      fattr 'arity' => 0
+      fattr('arity'){ 1 }
 
       fattr 'synopsis' do
         long, *short = names
-        value = cast || name 
-        rhs = argument ? (argument == :required ? "=#{ name }" : "=[#{ name }]") : nil 
+        value = cast || name
+        rhs = argument ? (argument == :required ? "=#{ name }" : "=[#{ name }]") : nil
         label = ["--#{ long }#{ rhs }", short.map{|s| "-#{ s }"}].flatten.join(", ")
         unless argument_none?
           op = required ? "->" : "~>"
-          value = defaults.size > 0 ? "#{ name }=#{ defaults.join ',' }" : name 
+          value = defaults.size > 0 ? "#{ name }=#{ defaults.join ',' }" : name
           value = "#{ cast }(#{ value })" if(cast and not cast.respond_to?(:call))
           "#{ label } (#{ arity } #{ op } #{ value })"
         else
@@ -304,24 +297,24 @@ module Main
 
     class Keyword < Parameter
       fattr 'required' => false
-      fattr 'argument' => :required 
+      fattr 'argument' => :required
 
       fattr 'synopsis' do
         label = "#{ name }=#{ name }"
         op = required ? "->" : "~>"
-        value = defaults.size > 0 ? "#{ name }=#{ defaults.join ',' }" : name 
+        value = defaults.size > 0 ? "#{ name }=#{ defaults.join ',' }" : name
         value = "#{ cast }(#{ value })" if(cast and not cast.respond_to?(:call))
         "#{ label } (#{ arity } #{ op } #{ value })"
       end
     end
 
     class Environment < Parameter
-      fattr 'argument' => :required 
+      fattr 'argument' => :required
 
       fattr 'synopsis' do
         label = "env[#{ name }]=#{ name }"
         op = required ? "->" : "~>"
-        value = defaults.size > 0 ? "#{ name }=#{ defaults.join ',' }" : name 
+        value = defaults.size > 0 ? "#{ name }=#{ defaults.join ',' }" : name
         value = "#{ cast }(#{ value })" if(cast and not cast.respond_to?(:call))
         "#{ label } (#{ arity } #{ op } #{ value })"
       end
@@ -355,7 +348,7 @@ module Main
         defaults!
         validate!
 
-        argv.push(*ignore) unless ignore.empty? 
+        argv.push(*ignore) unless ignore.empty?
 
         return self
       ensure
@@ -363,7 +356,7 @@ module Main
       end
 
       def parse_options argv, params = nil
-        params ||= options 
+        params ||= options
 
         spec, h, s = [], {}, {}
 
@@ -377,9 +370,9 @@ module Main
             else GetoptLong::NO_ARGUMENT
             end
           a = [ long, shorts, type ].flatten
-          spec << a 
-          h[long] = p 
-          s[long] = a 
+          spec << a
+          h[long] = p
+          s[long] = a
         end
 
         begin
@@ -404,12 +397,6 @@ module Main
           ex.extend Softspoken
           raise ex
         end
-
-=begin
-        params.each do |p|
-          p.setup!
-        end
-=end
       end
 
       def parse_arguments argv, params=nil
@@ -435,12 +422,6 @@ module Main
             end
           end
         end
-
-=begin
-        params.each do |p|
-          p.setup!
-        end
-=end
       end
 
       def parse_keywords argv, params=nil
@@ -454,7 +435,7 @@ module Main
 
           kre = %r/^\s*(#{ names.join '|' })\s*=/
           opt = "--#{ name }"
-          i = -1 
+          i = -1
 
           argv.each_with_index do |a, idx|
             i += 1
@@ -465,12 +446,6 @@ module Main
               replacements[i] ||= a.gsub %r/^\s*#{ key }/, opt
               next
             end
-=begin
-            abbrev = name.index(key) == 0
-            if abbrev
-              replacements[i] ||= a.gsub %r/^\s*#{ key }/, opt
-            end
-=end
           end
         end
 
@@ -480,7 +455,7 @@ module Main
 
         parse_options argv, params
       end
-      
+
       def parse_environment env, params=nil
         params ||= select{|p| p.type == :environment}
 
@@ -491,17 +466,11 @@ module Main
           next unless value
           p.add_value value
         end
-
-=begin
-        params.each do |p|
-          p.setup!
-        end
-=end
       end
 
       def defaults!
         each do |p|
-          if(p.defaults? and (not p.given?)) 
+          if(p.defaults? and (not p.given?))
             p.defaults.each do |default|
               p.values << (default.respond_to?('to_proc') ? main.instance_eval(&default) : default) # so as NOT to set 'given?'
             end
@@ -511,22 +480,18 @@ module Main
 
       def validate!
         each do |p|
-          #p.adding_handlers do
-            #next if p.arity == -1
-            #raise NotGiven, "#{ p.typename } not given" if(p.required? and (not p.given?))
-          #end
           p.setup!
         end
       end
 
-      [:parameter, :option, :argument, :keyword, :environment].each do |m| 
+      [:parameter, :option, :argument, :keyword, :environment].each do |m|
         define_method("#{ m }s"){ select{|p| p.type == m or m == :parameter} }
 
         define_method("has_#{ m }?") do |name, *names|
           catch :has do
             names = Cast.list_of_string name, *names
             send("#{ m }s").each do |param|
-              common = Cast.list_of_string(param.names) & names 
+              common = Cast.list_of_string(param.names) & names
               throw :has, true unless common.empty?
             end
             false
@@ -539,7 +504,7 @@ module Main
         names = Cast.list_of_string name, *names
         keep = []
         each do |param|
-          common = Cast.list_of_string(param.names) & names 
+          common = Cast.list_of_string(param.names) & names
           keep << param if common.empty?
         end
         replace keep
@@ -603,18 +568,18 @@ module Main
         param.type?
       end
 
-      def synopsis *arg 
+      def synopsis *arg
         arg.size == 0 ? param.synopsis : (param.synopsis arg.first)
       end
 
-      def argument arg 
-        param.argument arg 
+      def argument arg
+        param.argument arg
       end
       def argument_required bool = true
         if bool
           param.argument :required
         else
-          param.argument false 
+          param.argument false
         end
       end
       def argument_required?
@@ -625,46 +590,46 @@ module Main
         if bool
           param.argument :optional
         else
-          param.argument false 
+          param.argument false
         end
       end
       def argument_optional?
         param.argument_optional?
       end
 
-      def required bool = true 
-        param.required = bool 
+      def required bool = true
+        param.required = bool
       end
       def required?
         param.required?
       end
 
-      def optional bool = true 
-        if bool 
-          param.required !bool  
+      def optional bool = true
+        if bool
+          param.required !bool 
         else
-          param.required bool  
+          param.required bool 
         end
       end
       def optional?
         param.optional?
       end
 
-      def cast sym=nil, &b 
-        param.cast = sym || b 
+      def cast sym=nil, &b
+        param.cast = sym || b
       end
       def cast?
         param.cast?
       end
 
-      def validate sym=nil, &b 
-        param.validate = sym || b 
+      def validate sym=nil, &b
+        param.validate = sym || b
       end
       def validate?
         param.validate?
       end
 
-      def description s 
+      def description s
         param.description = s.to_s
       end
       def description?
@@ -725,7 +690,7 @@ module Main
         def [] *a, &b
           p = super
         ensure
-          raise NoneSuch, a.join(',') unless p 
+          raise NoneSuch, a.join(',') unless p
         end
       end
     end

data/lib/main/program/class_methods.rb

@@ -135,7 +135,7 @@ module Main
             end
           end
 
-          arg = argv.first && %r/^#{ argv.first }/
+          arg = argv.first && %r/^#{ Regexp.escape(argv.first) }/
           more_modes = (
             !modes.empty? and modes.any?{|mode| arg && mode.name =~ arg}
           )

data/lib/main/program/instance_methods.rb

@@ -15,13 +15,25 @@ module Main
       fattr('params'){ Parameter::Table.new }
       fattr('finalizers'){ [] }
 
-      %w( 
+      %w(
         program name synopsis description author version
-        exit_status exit_success exit_failure exit_warn exit_warning
+        exit_status
         logger_level
         usage
       ).each{|a| fattr(a){ self.class.send a}}
 
+      %w( success failure warn warning ).each do |status|
+        module_eval <<-____, __FILE__, __LINE__
+          def exit_#{ status }
+            self.class.send(:exit_#{ status })
+          end
+
+          def exit_#{ status }!
+            throw :exit, self.class.send(:exit_#{ status })
+          end
+        ____
+      end
+
       alias_method 'status', 'exit_status'
       alias_method 'status=', 'exit_status='
 
@@ -32,11 +44,11 @@ module Main
       end
 
       %w( debug info warn fatal error ).each do |m|
-        module_eval <<-code, __FILE__, __LINE__
+        module_eval <<-____, __FILE__, __LINE__
           def #{ m }(*a, &b)
             logger.#{ m }(*a, &b)
           end
-        code
+        ____
       end
 
       def pre_initialize() :hook end
@@ -254,11 +266,11 @@ module Main
       end
 
       %w[ before instead after ].each do |which|
-        module_eval <<-code, __FILE__, __LINE__
+        module_eval <<-____, __FILE__, __LINE__
           def error_handler_#{ which }(*argv, &block)
             block.call(*argv)
           end
-        code
+        ____
       end
 
       def instance_eval_block(*argv, &block)

data/lib/main.rb

@@ -1,7 +1,7 @@
 module Main
 # top level constants
 #
-  Main::VERSION = '6.3.0' unless
+  Main::VERSION = '6.4.0' unless
     defined? Main::VERSION
   def Main.version() Main::VERSION end
 

data/main.gemspec

@@ -3,17 +3,19 @@
 
 Gem::Specification::new do |spec|
   spec.name = "main"
-  spec.version = "6.3.0"
+  spec.version = "6.4.0"
   spec.platform = Gem::Platform::RUBY
   spec.summary = "main"
   spec.description = "a class factory and dsl for generating command line programs real quick"
   spec.license = "Ruby"
 
   spec.files =
-["README",
+["LICENSE",
+ "README",
  "README.erb",
  "Rakefile",
  "TODO",
+ "a.rb",
  "lib",
  "lib/main",
  "lib/main.rb",
@@ -53,6 +55,7 @@ Gem::Specification::new do |spec|
   spec.require_path = "lib"
 
   spec.test_files = nil
+  spec.required_ruby_version = '>= 2.0'
 
   
     spec.add_dependency(*["chronic", "~> 0.10", ">= 0.10.2"])

data/test/main_test.rb

@@ -40,7 +40,6 @@ class T < Test::Unit::TestCase
     main
   end
 
- 
 # basic test
 #
   def test_0000
@@ -57,9 +56,8 @@ class T < Test::Unit::TestCase
         define_method(:run){ x = 42 }
       }
     }
-    assert_equal 42, x 
+    assert_equal 42, x
   end
- 
 # exit status
 #
   def test_0020
@@ -992,6 +990,92 @@ class T < Test::Unit::TestCase
       end
     end
   end
+  def test_0930
+    argv = ['\1', '[' , ']', '\\']
+    assert_nothing_raised{
+      main(argv.dup){
+        argument('args') { arity(-1) }
+        define_method('run'){ 42 }
+      }.run
+    }
+  end
+  def test_0940
+    %w[ exit_failure! exit_success! exit_warn! ].each do |exit_method|
+      assert_nothing_raised{
+        result = 42
+
+        main(){
+          define_method :run do
+            send(exit_method)
+            result = :boom
+          end
+        }.run
+
+        assert result == 42
+      }
+    end
+  end
+  def test_0950
+    assert_nothing_raised{
+      error = nil
+
+      main{
+        define_method(:run) do
+          begin
+            params[:missing]
+          rescue Main::Parameter::NoneSuch => e
+            error = e
+          end
+        end
+      }.run
+
+      assert error.message =~ /missing/
+    }
+  end
+  def test_0960
+    argv = ['--foo', '--foo']
+    error = nil
+
+    assert_nothing_raised{
+      begin
+        main(argv){
+          option(:foo)
+
+          define_method(:run) do
+            params[:foo]
+          end
+        }.run
+      rescue => e
+        error = e
+      end
+    }
+
+    assert error
+    assert error.message =~ /foo/
+  end
+  def test_0970
+    argv = []
+    error = nil
+
+    assert_nothing_raised{
+      begin
+        main(argv){
+          option('foo', 'f'){
+            required
+          }
+
+          define_method(:run) do
+            params[:foo]
+          end
+        }.run
+      rescue => e
+        error = e
+      end
+    }
+
+    assert error
+    assert error.message =~ /foo/
+  end
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: main
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.4.0
 platform: ruby
 authors:
 - Ara T. Howard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -96,10 +96,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README
 - README.erb
 - Rakefile
 - TODO
+- a.rb
 - lib/main.rb
 - lib/main/cast.rb
 - lib/main/daemon.rb
@@ -140,14 +142,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: main