appl 1.5.1 → 1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ca5c3e7d0c0283079f9bd0981807b994cc1ea40bdf39830e14ddc7139f6e2e3
-  data.tar.gz: dba6e93d8c2dba17713ae40e0b828ca2ad8f2b9a526b8024f3f6ec30ffd3a6bc
+  metadata.gz: 1688b3e222470fd0e8d460eb628e5cd0d367f6310657f55fe465f004b7d09974
+  data.tar.gz: 2377f5d01f50f75922cd10fef21d17ef123cfec1d8bce0cf8873283cd73df2ac
 SHA512:
-  metadata.gz: cabd022a9b45ef68fe54ebe962d102c6fef398dd816a811c0647157f474bb7d90cf2b7c86558b384ce5f2946c5e801b0eaed4f22168afd976efdd580e93f1a20
-  data.tar.gz: 00ff5f113cbfc1fdf390ba5790131c72a2e672c8651e506fa88eea8ffe67e8b2065047f1c911b290279cb9f6148bb1ebfea24f937dfd18c766f75a22f5b92316
+  metadata.gz: 4c4a1b091ac1e4bdab240d55627eb78811fddeb0962b30aef7185f2fe466809a3d8cbf847387b1aa1ab07e782770e7b4e3507821682557e7388915d2cc1b1056
+  data.tar.gz: ee2e1d53b6f6c32a8be5d48e7f1489104d3f316d58a67f82318f0f21b16d038676812a063d5500d80663050963d086ad9bbcdff00b810d299d3ac731c0abba3b

data/bin/intar

@@ -17,44 +17,21 @@ class IntarApp < Application
   LICENSE   = "BSD"
   AUTHOR    = "Bertram Scharpf <software@bertram-scharpf.de>"
 
-  DESCRIPTION = <<EOT
-Prompt for Ruby statements, evaluate them. This is a replacement
-for "irb". The underlying library may be entered from inside any
-Ruby program.
+  DESCRIPTION = <<~EOT
+    Prompt for Ruby statements, evaluate them. This is a replacement
+    for "irb". The underlying library may be entered from inside any
+    Ruby program.
 
-Example:
+    Example:
 
-  $ intar -p '%(33 1)c%t%c%> '
+      $ intar -p '%(33 1)c%t%c%> '
 
-EOT
+  EOT
 
-  def quiet!
-    Intar.show = nil
-  end
-  def show= s
-    Intar.show = s.to_i
-  end
-  def prompt= p
-    Intar.prompt = p if p
-  end
-  def bw!
-    Intar.colour = false
-  end
-  def catch_exit!
-    Intar.catch_exit = (Intar.catch_exit||0) + 3
-  end
-  def histall!
-    Intar.histhid = false
-  end
-  def histfile= h
-    Intar.histfile = nil_if_none h
-  end
-  def histmax= m
-    Intar.histmax = (Integer m rescue m.to_i)
-  end
-  def configfile= c
-    @configfile = nil_if_none c
-  end
+  attr_writer :show, :prompt, :histmax
+  def histfile=   f ; @histfile   = nil_if_none f ; end
+  def configfile= f ; @configfile = nil_if_none f ; end
+  attr_bang :quiet, :bw, :catch_exit, :histall
 
   define_option "p", :prompt=, "STR",
                               "prompt - see source code for % escapes"
@@ -63,8 +40,8 @@ EOT
   define_option "q", :quiet!,                     "don't show results"
   alias_option  "q", "quiet"
 
-  define_option "S", :show=, "N", 1,  "show result line limit (0=all)"
-  alias_option  "S", "show"
+  define_option "s", :show=, "N",     "show result line limit (0=all)"
+  alias_option  "s", "show"
 
   define_option "r", :require, "FILE",                  "Ruby require"
   alias_option  "r", "require"
@@ -75,7 +52,7 @@ EOT
                                         "config file, NONE means none"
   alias_option  "c", "configfile"
 
-  define_option "H", :histfile=, "FILE", ".intar_history",
+  define_option "H", :histfile=, "FILE",
                                        "history file, NONE means none"
   alias_option  "H", "histfile"
 
@@ -103,6 +80,18 @@ EOT
   def run
     # @debug = true      # Only development.
     read_cfg
+    if @quiet then
+      Intar.show = 0
+    elsif @show then
+      Intar.show = Integer @show
+    end
+    Intar.prompt = @prompt if @prompt
+    Intar.colour = false if @bw
+    Intar.catch_exit = (Intar.catch_exit||0) + 3 if @catch_exit
+    Intar.histhid = false if @histall
+    Intar.histfile = @histfile if @histfile
+    Intar.histmax = Integer @histmax if @histmax
+
     main = eval "self", TOPLEVEL_BINDING
     Intar.open main do |i|
       i.run *(@args.shift @args.length)

data/doc/demoappl

@@ -15,11 +15,10 @@ class DemoAppl < Application
   LICENSE   = "For internal use only"
   AUTHOR    = "Bertram Scharpf <software@bertram-scharpf.de>"
 
-  DESCRIPTION = <<EOT
-This is an example how to define an Application subclass.
-The program just prints out its parameters.
-
-EOT
+  DESCRIPTION = <<~EOT
+    This is an example how to define an Application subclass.
+    The program just prints out its parameters.
+  EOT
 
   OPTIONS_ENV = "DEMO_OPTS"
 
@@ -47,9 +46,9 @@ EOT
   define_option "V", :version,                    "show version information"
   alias_option  "V", "version"
 
-  UNKNOWN = "Sorry, unknown option"
-  STOPOPT = "no more options"
-  UNPROCA = "Warning: unprocessed arguments left"
+  STOPOPT = "Stop option processing"
+  UNKNOWN = "Not a valid option: `%s'."
+  UNPROCA = "Warning. Unprocessed arguments: %s"
 
   def run
     puts inspect

data/doc/demofan

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+#
+#  demofan  -- Test the Application class with commands
+#
+
+require "applfan"
+
+
+class DemoFan < ApplicationFan
+
+  NAME      = "demofan"
+  VERSION   = "1.0"
+  SUMMARY   = "Test the Application class with commands"
+  COPYRIGHT = "(C) 2020 Bertram Scharpf"
+  LICENSE   = "For internal use only"
+  AUTHOR    = "Bertram Scharpf <software@bertram-scharpf.de>"
+
+  DESCRIPTION = <<~EOT
+    This is an example how to define an Application subclass
+    with commands inside.
+  EOT
+
+  attr_bang :verbose
+  define_option "v", :verbose!,                               "verbose mode"
+
+  define_option "h", :help,                         "show this options list"
+  alias_option  "h", "help"
+  define_option "V", :version,                    "show version information"
+  alias_option  "V", "version"
+
+  def run
+    super do |cmd|
+      cmd.verbose! if @verbose
+    end
+  end
+
+  class Init < Command
+    NAME        = "init"
+    SUMMARY     = "Initialize"
+    DESCRIPTION = <<~EOT
+      Initialization of nothing.
+    EOT
+    define_option "h", :help,                       "show init's options list"
+    alias_option  "h", "help"
+    def verbose! ; end
+    def run
+      puts "Initializing...done."
+    end
+  end
+
+  class Run < Command
+    NAME        = "run"
+    SUMMARY     = "Run a job"
+    DESCRIPTION = <<~EOT
+      Running nothing.
+    EOT
+    define_option "h", :help,                        "show run's options list"
+    alias_option  "h", "help"
+    def verbose! ; @verbose = true ; end
+    def run
+      if @verbose then
+        puts "Starting..."
+        puts "Running..."
+        puts "Done."
+      else
+        puts "Running...done."
+      end
+    end
+  end
+
+  class Cleanup < Command
+    NAME        = "cleanup"
+    SUMMARY     = "Cleanup"
+    DESCRIPTION = <<~EOT
+      Cleanup of nothing.
+    EOT
+    define_option "h", :help,                    "show cleanup's options list"
+    alias_option  "h", "help"
+    def verbose! ; end
+    def run
+      puts "Cleaning up...done."
+    end
+  end
+
+end
+
+
+DemoFan.run
+

data/lib/appl.rb

@@ -5,13 +5,16 @@
 
 class Application
 
-  APPL_VERSION = "1.5.1".freeze
+  APPL_VERSION = "1.10".freeze
 
   OPTIONS_ENV = nil
 
   STOPOPT = "stop option processing"
-  UNKNOWN = "Unknown option"
-  UNPROCA = "Warning: unprocessed arguments"
+  UNKNOWN = "Unknown option: `%s'."
+  UNPROCA = "Warning: unprocessed arguments: %s"
+
+  W_OPTS = 10
+  W_ARGS = 16
 
   class OptionError < StandardError ; end
   class Done        < Exception     ; end
@@ -46,45 +49,33 @@ class Application
   end
 
   def help
-    c = self.class
-    puts c.version
-    puts
-    puts c::DESCRIPTION
-    puts
-    c.show_options
-    if block_given? then
-      puts
-      yield
-    end
+    self.class.help
     raise Done
   end
 
   def version
-    self.class.show_version
+    self.class.version
     raise Done
   end
 
-  VERSION = "0"
-  NAME    = "appl"
-  SUMMARY = "Dummy application"
-  DESCRIPTION = <<-EOT
-This base class does nothing by default.
-  EOT
-
   def run
   end
 
-  def execute
-    run
+  def warn_unprocessed
     if @args.any? then
-      u = @args.join " "
-      puts "#{self.class::UNPROCA}: #{u}"
+      $stderr.puts self.class.root::UNPROCA % (@args.join " ")
     end
-    0
+  end
+
+  def execute
+    r = run
+    r = 0 unless Integer === r
+    warn_unprocessed
+    r
   rescue SignalException
     raise if @debug
     self.class.show_message $!.inspect
-    128 + ($!.signo||2)    # Ruby 1.8 returns signo +nil+; assume SIGINT
+    128 + $!.signo
   rescue
     raise if @debug
     self.class.show_message "Error: #$!", "(#{$!.class})"
@@ -98,14 +89,6 @@ This base class does nothing by default.
       exit e
     end
 
-    def version
-      if self::VERSION =~ %r/\s/ then
-        self::VERSION
-      else
-        "#{self::NAME} #{self::VERSION}  --  #{self::SUMMARY}"
-      end
-    end
-
     private
 
     def execute args = nil
@@ -119,7 +102,9 @@ This base class does nothing by default.
     end
 
     def inherited sub
-      sub.instance_eval { @options, @aliases = {}, {} }
+      sub.name or return
+      o, a = @options.dup.to_h, @aliases.dup.to_h
+      sub.instance_eval { @options, @aliases = o, a }
     end
 
     def attr_bang *syms
@@ -162,16 +147,12 @@ This base class does nothing by default.
     end
 
     def delete_option opt
-      self < Application or return
-      superclass.delete_option opt
-      @options.delete opt
       @aliases.reject! { |k,v| v == opt }
+      @options.delete opt
       nil
     end
 
     def unalias_option opt
-      self < Application or return
-      superclass.unalias_option opt
       @aliases.delete opt
       nil
     end
@@ -179,32 +160,12 @@ This base class does nothing by default.
     protected
 
     def find_option_act opt
-      self < Application or return
-      @options[ opt] || @options[ @aliases[ opt]] ||
-        (superclass.find_option_act opt)
-    end
-
-    def all_options
-      if self < Application then
-        r = superclass.all_options
-        r.update @options
-      else
-        {}
-      end
-    end
-
-    def all_aliases
-      if self < Application then
-        r = superclass.all_aliases
-        r.update @aliases
-      else
-        {}
-      end
+      @options[ opt] || @options[ @aliases[ opt]]
     end
 
     def options_desc &block
       a = Hash.new do |h,k| h[ k] = [] end
-      all_aliases.each { |k,v|
+      @aliases.each { |k,v|
         a[ v].push k
       }
       each_option { |opt,desc,arg,dfl,|
@@ -213,14 +174,13 @@ This base class does nothing by default.
           yield l, nil, nil, nil
         }
       }
-      yield "", nil, nil, self::STOPOPT
+      yield "", nil, nil, root::STOPOPT
     end
 
     public
 
     def each_option
-      o = all_options
-      o.each { |opt,(desc,arg,dfl,act)|
+      @options.each { |opt,(desc,arg,dfl,act)|
         case dfl
           when Symbol then dfl = const_get dfl
         end
@@ -230,7 +190,7 @@ This base class does nothing by default.
 
     def option_act args, opt, rest
       dada = find_option_act opt
-      dada or raise OptionError, "#{self::UNKNOWN}: `#{opt}'."
+      dada or raise OptionError, root::UNKNOWN % opt
       desc, arg, dfl, act = *dada
       r = [ act]
       if arg then
@@ -246,12 +206,32 @@ This base class does nothing by default.
         arg &&= "#{arg}"
         dfl &&= "[#{dfl}]"
         arg << dfl if arg && dfl
-        puts "  %-10s  %-12s  %s" % [ opt, arg, desc]
+        puts "  %-*s  %-*s  %s" % [ root::W_OPTS, opt, root::W_ARGS, arg, desc]
+      end
+    end
+
+    def root
+      self
+    end
+
+    def applname
+      self::NAME
+    end
+
+    def help
+      puts "#{applname}  --  #{self::SUMMARY}"
+      puts
+      puts self::DESCRIPTION
+      puts
+      show_options
+      if block_given? then
+        puts
+        yield
       end
     end
 
-    def show_version
-      puts version
+    def version
+      puts "#{applname} #{self::VERSION}  --  #{self::SUMMARY}"
       puts self::COPYRIGHT if const_defined? :COPYRIGHT
       puts "License: #{self::LICENSE}" if const_defined? :LICENSE
       a = []
@@ -264,6 +244,7 @@ This base class does nothing by default.
         h = a.length == 1 ? "Author" : "Authors"
         puts "#{h}: #{j}"
       end
+      puts "Ruby version: #{RUBY_VERSION}"
     end
 
     def show_message msg, extra = nil

data/lib/applfan.rb

@@ -0,0 +1,79 @@
+#
+#  lib/applfan.rb  --  ApplicationFan class
+#
+
+require "appl"
+
+
+ApplicationFan = Class.new Application
+
+class ApplicationFan
+
+  AVAILCMDS = "Available commands (say -h after one for help)"
+  NOCOMMAND = "No command given. Say -h for a list."
+  UNKNWNCMD = "Unknown command: `%s'. Say -h for a list."
+
+  W_CMDS = 16
+
+  class CommandError < StandardError ; end
+
+  class <<self
+
+    attr_accessor :commands
+
+    def find_command name
+      @commands.find { |c| c::NAME == name }
+    end
+
+
+    def help
+      super do
+        if block_given? then
+          yield
+          puts
+        end
+        puts self::AVAILCMDS
+        puts
+        @commands.each { |c|
+          puts "  %-*s  %s" % [ self::W_CMDS, c::NAME, c::SUMMARY]
+        }
+      end
+    end
+
+    private
+
+    def inherited sub
+      sub.instance_eval do
+        @commands = []
+        const_set :Command, (
+          Class.new Application do
+            define_singleton_method :inherited do |c|
+              sub.commands.push c
+              super c
+            end
+            define_singleton_method :root do
+              sub
+            end
+            define_singleton_method :applname do
+              "#{root::NAME} #{self::NAME}"
+            end
+          end
+        )
+      end
+      super
+    end
+
+  end
+
+  def run
+    c = @args.shift
+    c or raise CommandError, self.class::NOCOMMAND
+    cmd = self.class.find_command c
+    cmd or raise CommandError, self.class::UNKNWNCMD % c
+    sub = cmd.new @args.slice! 0, @args.length
+    yield sub if block_given?
+    sub.execute
+  end
+
+end
+

data/lib/intar.rb

@@ -128,7 +128,7 @@ class Intar
 
   class <<self
 
-    attr_accessor :prompt, :show, :colour
+    attr_accessor :prompt, :show, :shownil, :colour
 
     attr_reader :histfile
     def histfile= hf
@@ -158,6 +158,7 @@ class Intar
         s = superclass
         @prompt     = s.prompt
         @show       = s.show
+        @shownil    = s.shownil
         @colour     = s.colour
         @histfile   = s.histfile
         @histmax    = s.histmax
@@ -206,6 +207,7 @@ class Intar
 
   self.prompt     = "%(32)c%i%c:%1c%03n%c%> "
   self.show       = 1
+  self.shownil    = false
   self.colour     = true
   self.histfile   = nil
   self.histmax    = 500
@@ -221,7 +223,7 @@ class Intar
     @n = 0
   end
 
-  OLDSET = <<-EOT
+  OLDSET = <<~EOT
     _, __, ___ = nil, nil, nil
     proc { |r,n|
       Array === __ or __ = []
@@ -312,19 +314,18 @@ class Intar
   # :startdoc:
 
   def display r
-    return if r.nil?
+    return if r.nil? and not self.class.shownil
     show = (self.class.show or return)
-    i = r.inspect
+    i = ARROW.dup
+    i << r.inspect
     if show > 0 then
       siz, = $stdout.winsize
       siz *= show
-      siz -= ARROW.length
       if i.length > siz then
         i.cut! siz-ELLIPSIS.length
         i << ELLIPSIS
       end
     end
-    i.prepend ARROW
     puts i
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appl
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: '1.10'
 platform: ruby
 authors:
 - Bertram Scharpf
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-13 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies: []
 description: |
   A base class for command line applications doing options parsing
@@ -21,13 +21,15 @@ extra_rdoc_files: []
 files:
 - bin/intar
 - doc/demoappl
+- doc/demofan
 - lib/appl.rb
+- lib/applfan.rb
 - lib/intar.rb
 homepage: http://www.bertram-scharpf.de/software/appl
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -43,9 +45,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - Just Ruby
-rubyforge_project: NONE
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Easy option parsing
 test_files: []