appl 1.6.2 → 1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3006d9d18efb0699ffb9cce15b9f5ebad26dbe0d62e723b982ef010f0667d2fd
-  data.tar.gz: f13bdd180f26807607895846f19130a3e927b1cbb97bdc54beab2fc6f2d62762
+  metadata.gz: 799aaa0707086bc632ccb65a3edfd9adc5d8078e06f60114ffe01b92e086657d
+  data.tar.gz: 5283ca005a83855d096f2f5fca5015fd64afaa1df1e0348a0a5f814d33a66dcd
 SHA512:
-  metadata.gz: 76f086e3cacbd25034ce77d242c0eae9d1b8c161f02a7cce354796f9d344751ce9425613357e945f9ef50e854ff7bbd84f8255b111cdecd21acc53b0be0b214c
-  data.tar.gz: 701155765e67cf6519b5cb91a8b528e65b14f2175bc6dd53dbb76d232c7a6c41bfa8a0e7467eb2bbed373fbde3ca9437e65f73a763658ba430487565e31d9e87
+  metadata.gz: 8b7529480160d067b949652c5003e77864a5a358e45b1999713f770082f93cdf6ae70fa9886ba0b7b934b130e1b453931ba6396ad0296791628547bdaada6ddd
+  data.tar.gz: 62629af63de9b84692ff6e02eafad0601e13d9a3ed0b83ba294b83b37b0ca0f7a637135d89966f7a3e79b9b0d36d2328d0ba477a31144c31776e6b02bcf21786

data/bin/intar

@@ -28,33 +28,10 @@ class IntarApp < Application
 
   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 @@ class IntarApp < Application
   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"
@@ -103,6 +80,18 @@ class IntarApp < Application
   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

@@ -46,9 +46,9 @@ class DemoAppl < Application
   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.6.2".freeze
+  APPL_VERSION = "1.8".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,40 +49,27 @@ 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
+  end
+
+  def execute
+    run
+    warn_unprocessed
     0
   rescue SignalException
     raise if @debug
@@ -98,14 +88,6 @@ class Application
       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 +101,9 @@ class Application
     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 +146,12 @@ class Application
     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 +159,12 @@ class Application
     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 +173,13 @@ class Application
           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 +189,7 @@ class Application
 
     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 +205,32 @@ class Application
         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 show_version
-      puts version
+    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 version
+      puts "#{applname} #{self::VERSION}  --  #{self::SUMMARY}"
       puts self::COPYRIGHT if const_defined? :COPYRIGHT
       puts "License: #{self::LICENSE}" if const_defined? :LICENSE
       a = []

data/lib/applfan.rb

@@ -0,0 +1,81 @@
+#
+#  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
+    (cmd.new @args.slice! 0, @args.length).tap { |sub|
+      yield sub if block_given?
+      sub.run
+      sub.warn_unprocessed
+    }
+  end
+
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appl
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: '1.8'
 platform: ruby
 authors:
 - Bertram Scharpf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-31 00:00:00.000000000 Z
+date: 2020-03-26 00:00:00.000000000 Z
 dependencies: []
 description: |
   A base class for command line applications doing options parsing
@@ -21,7 +21,9 @@ 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: