shellopts 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62e1be2ce8220b6bec3fac551a2c44fef7ca52fa4cf1f1565e15836387a85bd9
-  data.tar.gz: b5872f570a32ff841cb632f18e390eb060fe746cd62d09347dd449782ce529ef
+  metadata.gz: 68428ade0dd8ec48fa85a8d43362743d6dc5595d9f4af3347d0fa402eaf0e7bb
+  data.tar.gz: 51404fbc53ddbacb0b7a4552777e3de7c8abce1d508782f6c901da4b2cd332ba
 SHA512:
-  metadata.gz: '08b6078dbf4690562e7e4d68cdbd27f2e840ba6440dbe8cbcb0aef932e27b2db959608bf3630f5725d2d8629691839546a41c72d6ea9f178c662a61e984b43be'
-  data.tar.gz: 49bd8f950a6f1e3ce457b974b88301f4052a597578f2379680f6b7bed8581f522860a679d9a9600427b37927ea5f9a3f110dbe857be14c564cd4e7c221b361ff
+  metadata.gz: ca5499680c53cc74388102b130eb9a7dfc7dc53ba7556615991d93d882ddc4993e1854891d78bbd97ccb4d37e8d493fb1c4e199cc4361f96ddb2e55c536f4cc7
+  data.tar.gz: d75bef2e9b154a0332ed55a272341072654db8c615c5e4c9a27a94823efd6bae354fe32ca14679c92553af3e0e4f69f50ca3aeb675c5149d8394195f1f5a9f4a

data/lib/shellopts/program.rb

@@ -315,12 +315,14 @@ module ShellOpts
   class Program < Command
     # Accessors for standard options values that are not affected if the option
     # is renamed
+    attr_accessor :__silent__
     attr_accessor :__quiet__
     attr_accessor :__verbose__
     attr_accessor :__debug__
 
     def initialize
       super
+      @__silent__ = false
       @__quiet__ = false
       @__verbose__ = 0
       @__debug__ = false

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.3.1"
+  VERSION = "2.4.0"
 end

data/lib/shellopts.rb

@@ -110,6 +110,9 @@ module ShellOpts
     # Version of client program. If not nil, a --version option is added to the program
     attr_reader :version
 
+    # Automatically add a -s and a --silent option if true
+    attr_reader :silent
+
     # Automatically add a -q and a --quiet option if true
     attr_reader :quiet
 
@@ -140,6 +143,7 @@ module ShellOpts
         # Options
         help: true, 
         version: true, 
+        silent: nil,
         quiet: nil,
         verbose: nil,
         debug: nil,
@@ -157,6 +161,7 @@ module ShellOpts
       @name = name || File.basename($PROGRAM_NAME)
       @help = help
       @version = version || (version.nil? && !version_number.nil?)
+      @silent = silent
       @quiet = quiet
       @verbose = verbose
       @debug = debug
@@ -177,10 +182,13 @@ module ShellOpts
 
         help_spec = (@help == true ? "-h,help" : @help)
         version_spec = (@version == true ? "--version" : @version)
+        silent_spec = (@silent == true ? "-q,silent" : @silent)
         quiet_spec = (@quiet == true ? "-q,quiet" : @quiet)
         verbose_spec = (@verbose == true ? "+v,verbose" : @verbose)
         debug_spec = (@debug == true ? "--debug" : @debug)
 
+        @silent_option = 
+            ast.inject_option(silent_spec, "Quiet", "Do not write anything to standard output") if @silent
         @quiet_option = 
             ast.inject_option(quiet_spec, "Quiet", "Do not write anything to standard output") if @quiet
         @verbose_option = 
@@ -224,6 +232,8 @@ module ShellOpts
           puts version_number
           exit
         else
+          # Assign standard options. The targets doesn't change if the option is renamed
+          @program.__silent__ = @program.__send__(:"#{@silent_option.ident}?") if @silent
           @program.__quiet__ = @program.__send__(:"#{@quiet_option.ident}?") if @quiet
           @program.__verbose__ = @program.__send__(:"#{@verbose_option.ident}") if @verbose
           @program.__debug__ = @program.__send__(:"#{@debug_option.ident}?") if @debug
@@ -393,19 +403,35 @@ module ShellOpts
     end
   end
 
-  def self.process(spec, argv, quiet: nil, verbose: nil, debug: nil, **opts)
+  def self.process(spec, argv, silent: nil, quiet: nil, verbose: nil, debug: nil, **opts)
+    constrain silent, String, true, false, nil
     constrain quiet, String, true, false, nil
+    silent = silent.nil? ? Message.is_included? || Verbose.is_included? : silent
     quiet = quiet.nil? ? Message.is_included? || Verbose.is_included? : quiet
     verbose = verbose.nil? ? ::ShellOpts::Verbose.is_included? : verbose
     debug = debug.nil? ? Debug.is_included? : debug
-    ShellOpts.process(spec, argv, quiet: quiet, verbose: verbose, debug: debug, **opts)
+    ShellOpts.process(spec, argv, silent: silent, quiet: quiet, verbose: verbose, debug: debug, **opts)
   end
 
+  # The instance is a ShellOpts object. 'instance.program' and 'instance.argv'
+  # is the same as the values returned from ShellOpts.process
   @instance = nil
   def self.instance?() !@instance.nil? end
   def self.instance() @instance or raise Error, "ShellOpts is not initialized" end
   def self.instance=(instance) @instance = instance end
-  def self.shellopts() instance end
+  def self.shellopts() instance end # TODO: Yt
+
+  # Returns the corresponding option status on the program object. Note that
+  # the "bare" ShellOpts standard option methods (eg. ShellOpts.silent)
+  # determines if an option can be used while the query methods (eg.
+  # ShellOpts.silent?) reports if the option was present on the command line
+  #
+  # The methods below are implemented using the name-independent members of
+  # Program: __silent__ etc.
+  def self.silent?() instance.program.__silent__ end
+  def self.quiet?() silent? || instance.program.__quiet__ end
+  def self.verbose?(level = 1) level <= instance.program.__verbose__ end
+  def self.debug?() instance.program.__debug__ end
 
   def self.error(subject = nil, message)
     instance.error(subject, message) if instance? # Never returns
@@ -419,30 +445,29 @@ module ShellOpts
     exit 1
   end
 
+  # Emit a message on standard error. The --silent option suppresses these messages
   def self.notice(message, newline: true)
     method = newline ? :puts : :print
-    $stderr.send(method, message) if !instance.quiet || !instance.program.quiet? # FIXME quiet? vs __quiet__ below
+    $stderr.send(method, message) if !silent?
   end
 
+  # Emit a message on standard output. The --quiet option suppresses these messages
   def self.mesg(message, newline: true)
     method = newline ? :puts : :print
-    $stdout.send(method,  message) if !instance.quiet || !instance.program.__quiet__
+    $stdout.send(method, message) if !quiet?
   end
 
+  # Emit a message on standard output. The --verbose option controls these messages
   def self.verb(level = 1, message, newline: true)
     method = newline ? :puts : :print
-    $stdout.send(method,  message) if instance.verbose && level <= instance.program.__verbose__
+    $stdout.send(method, message) if verbose?(level)
   end
 
   def self.debug(message, newline: true)
     method = newline ? :puts : :print
-    $stdout.send(method,  message) if instance.debug && instance.program.__debug__
+    $stdout.send(method, message) if debug?
   end
 
-  def self.quiet?() instance.program.quiet? end
-  def self.verbose?(level = 1) level <= instance.program.verbose end
-  def self.debug?() instance.program.debug? end
-
   module Message
     @is_included = false
     def self.is_included?() @is_included end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-28 00:00:00.000000000 Z
+date: 2024-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forward_to