shellopts 2.0.2 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 013afe67b6f86e17d37bfbd1b18f3b4b7e7e5026d3249900326b23d1ed75ed95
-  data.tar.gz: 7ccfcca5ef44d9958e3f03ea23ea211893357ff32c7c5e5fdc4953ec61548306
+  metadata.gz: a3a8b18b0a610c14ac4a85f80cd70ff5f85ca7dc868b25615a67a3ad71f737b5
+  data.tar.gz: 2b0442868d8ddf102a5f8ee1b3d3307ecbea17a95512f5164d4a64a9d3fa9ec7
 SHA512:
-  metadata.gz: 5a50d291b69952d04bc054ea09cf292f6df414a4d6e1df69ac47cb3d2489626301c7eba4f66edd268f1c486463d6c37a1fd0b3cd431060c7100da980272c2b9e
-  data.tar.gz: 0bd422a52a4b11f69ade0d744df2a0bf8db6a05d67e282bfadb6a1a72af6f1ebe21ec0dd24b8ce663379d9e69db643036606e2fc1e502995e24f2f7b5c8bdea3
+  metadata.gz: c90ab9e0049ba64e21c2b0fd408b438df84c0265fced52b84d221bdb2b96f92e75624c00ab59526c9caa80f67e2e7d55c5bcf0cb8138b803722b424e08ea9202
+  data.tar.gz: 372e29956c8f3e27f8f5617215cf610403d40a307257c0c63605e94bd39fffaa8bf9cb165e82fe61497fcc8f0519c4298c1bf4480fa26735f5bf5c01e12fe8e2

data/lib/shellopts/formatter.rb

@@ -38,16 +38,17 @@ module ShellOpts
       using Ext::Array::Wrap
 
       def puts_usage(bol: false)
+        width = [Formatter.rest, Formatter::USAGE_MAX_WIDTH].min
         if descrs.size == 0
           print (lead = Formatter.command_prefix || "")
           indent(lead.size, ' ', bol: bol && lead == "") { 
-            puts render(:multi, Formatter::USAGE_MAX_WIDTH) 
+            puts render(:multi, width) 
           }
         else
           lead = Formatter.command_prefix || ""
           descrs.each { |descr|
             print lead
-            puts render(:single, Formatter::USAGE_MAX_WIDTH, args: [descr.text]) 
+            puts render(:single, width, args: [descr.text]) 
           } 
         end
       end

data/lib/shellopts/program.rb

@@ -4,30 +4,33 @@
 module ShellOpts
   # Command represents a program or a subcommand. It is derived from
   # BasicObject to have only a minimum of inherited member methods.
-  # Additional methods defined in Command use the  '__<identifier>__' naming
-  # convention that doesn't collide with option or subcommand names but
-  # they're rarely used in application code
   #
   # The names of the inherited methods can't be used as options or
   # command namess. They are: instance_eval, instance_exec method_missing,
   # singleton_method_added, singleton_method_removed, and
-  # singleton_method_undefined
+  # singleton_method_undefined.
+  #
+  # Additional methods defined in Command use the  '__<identifier>__' naming
+  # convention that doesn't collide with option or subcommand names but
+  # they're rarely used in application code
   #
   # Command also defines #subcommand and #subcommand! but they can be
   # overshadowed by an option or command declaration. Their values can
   # still be accessed using the dashed name, though
   #
-  # Options and subcommands can be accessed using #[]
+  # Option and Command objects can be accessed using #[]. #key? is also defined
   #
   # The following methods are created dynamically for each declared option
   # with an attribute name
   #
-  #   def <identifier>(default = nil) self["<identifier>"] || default end
-  #   def <identifier>=(value) self["<identifier>"] = value end
-  #   def <identifier>?() self.key?("<identifier>") end
+  #   <identifier>(default = nil)
+  #   <identifier>=(value)
+  #   <identifier>?()
+  #
+  # The default value is used if the option or its value is missing
   #
   # Options without an an attribute can still be accessed using #[] or trough
-  # #__options__ or #__options_list__):
+  # #__option_values__, #__option_hash, or #__options_list__
   #
   # Each subcommand has a single method:
   #
@@ -42,9 +45,9 @@ module ShellOpts
 
     # These names can't be used as option or command names
     RESERVED_OPTION_NAMES = %w(
-        is_a
-        instance_eval instance_exec method_missing singleton_method_added
-        singleton_method_removed singleton_method_undefined)
+        is_a instance_eval instance_exec method_missing singleton_method_added
+        singleton_method_removed singleton_method_undefined
+    )
 
     # These methods can be overridden by an option (the value is not used -
     # this is just for informational purposes)
@@ -59,43 +62,25 @@ module ShellOpts
       object
     end
 
-    # Return command object or option argument value if present, otherwise nil
+    # Return command or option object if present, otherwise nil. Returns a
+    # possibly empty array of option objects if the option is repeatable
     #
     # The key is the name or identifier of the object or any any option
     # alias. Eg.  :f, '-f', :file, or '--file' are all usable as option keys
     # and :cmd!  or 'cmd' as command keys
     #
-    # For options, the returned value is the argument given by the user
-    # optionally converted to Integer or Float or nil if the option doesn't
-    # take arguments. If the option takes an argument and it is repeatable
-    # the value is an array of the arguments. Repeatable options without
-    # arguments have the number of occurences as the value
-    #
     def [](key)
       case object = __grammar__[key]
         when ::ShellOpts::Grammar::Command
           object.ident == __subcommand__!.__ident__ ? __subcommand__! : nil
         when ::ShellOpts::Grammar::Option
-          __options__[object.ident]
-        else
-          nil
-      end
-    end
-
-    # Assign a value to an existing option. This can be used to implement
-    # default values. #[]= doesn't currently check the type of the given
-    # value so take care. Note that the corresponding option(s) in
-    # #__option_list__ is not updated
-    def []=(key, value)
-      case object = __grammar__[key]
-        when ::ShellOpts::Grammar::Command
-          ::Kernel.raise ArgumentError, "#{key.inspect} is not an option"
-        when ::ShellOpts::Grammar::Option
-          object.argument? || object.repeatable? or
-              ::Kernel.raise ArgumentError, "#{key.inspect} is not assignable"
-          __options__[object.ident] = value
+          if object.repeatable?
+            __option_hash__[object.ident] || []
+          else
+            __option_hash__[object.ident]
+          end
         else
-          ::Kernel.raise ArgumentError, "Unknown option or command: #{key.inspect}"
+          ::Kernel.raise ::ArgumentError, "Unknown command or option: '#{key}'"
       end
     end
 
@@ -103,11 +88,11 @@ module ShellOpts
     def key?(key)
       case object = __grammar__[key]
         when ::ShellOpts::Grammar::Command
-          object.ident == __subcommand__!.ident ? __subcommand__! : nil
+          object.ident == __subcommand__
         when ::ShellOpts::Grammar::Option
-          __options__.key?(object.ident)
+          __option_hash__.key?(object.ident)
         else
-          nil
+          ::Kernel.raise ::ArgumentError, "Unknown command or option: '#{key}'"
       end
     end
       
@@ -153,13 +138,17 @@ module ShellOpts
     # depending on the option's type. Repeated options options without
     # arguments have the number of occurences as the value, with arguments
     # the value is an array of the given values
-    attr_reader :__options__
+    attr_reader :__option_values__
 
     # List of Option objects for the subcommand in the same order as
     # given by the user but note that options are reordered to come after
     # their associated subcommand if float is true. Repeated options are not
     # collapsed
     attr_reader :__option_list__
+
+    # Map from identifier to option object or to a list of option objects if
+    # the option is repeatable
+    attr_reader :__option_hash__
     
     # The subcommand identifier (a Symbol incl. the exclamation mark) or nil
     # if not present. Use #subcommand!, or the dynamically generated
@@ -172,9 +161,10 @@ module ShellOpts
   private
     def __initialize__(grammar)
       @__grammar__ = grammar
-      @__options__ = {}
+      @__option_values__ = {}
       @__option_list__ = [] 
-      @__options__ = {}
+      @__option_hash__ = {}
+      @__option_values__ = {}
       @__subcommand__ = nil
 
       __define_option_methods__
@@ -182,36 +172,34 @@ module ShellOpts
 
     def __define_option_methods__
       @__grammar__.options.each { |opt|
-        next if opt.attr.nil?
         if opt.argument? || opt.repeatable?
           if opt.optional?
             self.instance_eval %(
               def #{opt.attr}(default = nil)
-                if @__options__.key?(:#{opt.attr}) 
-                  @__options__[:#{opt.attr}] || default
+                if @__option_values__.key?(:#{opt.attr}) 
+                  @__option_values__[:#{opt.attr}]
                 else
-                  nil
+                  default
                 end
               end
             )
-          elsif !opt.argument?
+          elsif !opt.argument? # Repeatable w/o argument
             self.instance_eval %(
-              def #{opt.attr}(default = nil) 
-                if @__options__.key?(:#{opt.attr})
-                  value = @__options__[:#{opt.attr}] 
-                  value == 0 ? default : value
+              def #{opt.attr}(default = []) 
+                if @__option_values__.key?(:#{opt.attr})
+                  @__option_values__[:#{opt.attr}]
                 else
-                  nil
+                  default
                 end
               end
             )
           else
-            self.instance_eval("def #{opt.attr}() @__options__[:#{opt.attr}] end")
+            self.instance_eval("def #{opt.attr}() @__option_values__[:#{opt.attr}] end")
           end
-          self.instance_eval("def #{opt.attr}=(value) @__options__[:#{opt.attr}] = value end")
-          @__options__[opt.attr] = 0 if !opt.argument?
+          self.instance_eval("def #{opt.attr}=(value) @__option_values__[:#{opt.attr}] = value end")
+          @__option_values__[opt.attr] = 0 if !opt.argument?
         end
-        self.instance_eval("def #{opt.attr}?() @__options__.key?(:#{opt.attr}) end")
+        self.instance_eval("def #{opt.attr}?() @__option_values__.key?(:#{opt.attr}) end")
       }
 
       @__grammar__.commands.each { |cmd|
@@ -228,14 +216,15 @@ module ShellOpts
       ident = option.grammar.ident
       @__option_list__ << option
       if option.repeatable?
+        (@__option_hash__[ident] ||= []) << option
         if option.argument?
-          (@__options__[ident] ||= []) << option.argument
+          (@__option_values__[ident] ||= []) << option.argument
         else
-          @__options__[ident] ||= 0
-          @__options__[ident] += 1
+          @__option_values__[ident] = (@__option_values__[ident] || 0) + 1
         end
       else
-        @__options__[ident] = option.argument
+        @__option_hash__[ident] = option
+        @__option_values__[ident] = option.argument
       end
     end
 
@@ -254,7 +243,7 @@ module ShellOpts
 
   # Option models an option as given by the user on the subcommand line.
   # Compiled options (and possibly aggregated) options are stored in the
-  # Command#__options__ array
+  # Command#__option_values__ array
   class Option
     # Associated Grammar::Option object
     attr_reader :grammar

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.0.2"
+  VERSION = "2.0.5"
 end

data/lib/shellopts.rb

@@ -102,6 +102,9 @@ module ShellOpts
     attr_accessor :stdopts
     attr_accessor :msgopts
 
+    # Version of client program. This is only used if +stdopts+ is true
+    attr_reader :version
+
     # Interpreter flags
     attr_accessor :float
 
@@ -116,14 +119,17 @@ module ShellOpts
     attr_reader :tokens
     alias_method :ast, :grammar # Oops - defined earlier FIXME
 
-    def initialize(name: nil, stdopts: true, msgopts: false, float: true, exception: false)
+    def initialize(name: nil, stdopts: true, version: nil, msgopts: false, float: true, exception: false)
       @name = name || File.basename($PROGRAM_NAME)
-      @stdopts, @msgopts, @float, @exception = stdopts, msgopts, float, exception
+      @stdopts, @version, @msgopts, @float, @exception = stdopts, version, msgopts, float, exception
     end
 
     # Compile source and return grammar object. Also sets #spec and #grammar.
     # Returns the grammar
     def compile(spec)
+      if stdopts
+        spec += "\n--version\n  Write version number and exit\n-h,help @ Write help text and exit\n  Write help text. -h prints a brief text, --help prints a longer man-style description of the command"
+      end
       handle_exceptions {
         @oneline = spec.index("\n").nil?
         @spec = spec.sub(/^\s*\n/, "")
@@ -143,6 +149,20 @@ module ShellOpts
       handle_exceptions { 
         @argv = argv.dup
         @program, @args = Interpreter.interpret(grammar, argv, float: float, exception: exception)
+        if stdopts
+          if @program.version?
+            version or raise ArgumentError, "Version not specified"
+            puts version 
+            exit
+          elsif @program.help?
+            if @program[:help].name == "-h"
+              ShellOpts.brief
+            else
+              ShellOpts.help
+            end
+            exit
+          end
+        end
       }
       self
     end
@@ -201,11 +221,12 @@ module ShellOpts
     def brief() Formatter.brief(@grammar) end
 
     # Print help for the given subject or the full documentation if +subject+
-    # is nil 
+    # is nil. Clears the screen beforehand if :clear is true
     #
-    def help(subject = nil)
+    def help(subject = nil, clear: true)
       node = (subject ? @grammar[subject] : @grammar) or
           raise ArgumentError, "No such command: '#{subject&.sub(".", " ")}'"
+      print '' if clear
       Formatter.help(node)
     end
 
@@ -310,6 +331,7 @@ module ShellOpts
   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
 
   forward_self_to :instance, :error, :failure
 

data/main

@@ -7,18 +7,31 @@ require 'shellopts'
 
 include ShellOpts
 
+VERSION = "1.2.3"
 
-SPEC = %(
-  -a,alpha        @ Brief comment for -a and --alpha options
-      Longer and more elaborate description of the --alpha option
+SPEC = "-a"
+opts, args = ShellOpts::process(SPEC, ARGV, version: VERSION)
+#ShellOpts::ShellOpts.help
 
-  -b,beta=ARG
-      @ Alternative style of brief comment
 
-      Longer and more elaborate description of the --beta option
-)
 
-opts, args = ShellOpts.process(SPEC, ARGV)
+
+
+
+__END__
+
+
+#SPEC = %(
+# -a,alpha        @ Brief comment for -a and --alpha options
+#     Longer and more elaborate description of the --alpha option
+#
+# -b,beta=ARG
+#     @ Alternative style of brief comment
+#
+#     Longer and more elaborate description of the --beta option
+#)
+#
+#opts, args = ShellOpts.process(SPEC, ARGV)
 #puts "opts.alpha?: #{opts.alpha?.inspect}"
 #puts "opts.alpha: #{opts.alpha.inspect}"
 #puts "opts.beta?: #{opts.beta?.inspect}"
@@ -266,8 +279,9 @@ SPEC4 = %(
 
 SPEC5 = "cmd! cmd!"
 
-shellopts = ShellOpts::ShellOpts.new(exception: false)
+shellopts = ShellOpts::ShellOpts.new(exception: true)
 #shellopts.compile("cmd! cmd!")
+
 shellopts.compile(SPEC)
 #shellopts.compile(SPEC2)
 #shellopts.compile(SPEC3)
@@ -277,9 +291,9 @@ shellopts.compile(SPEC)
 #shellopts.tokens.each(&:dump)
 #exit
 
-shellopts.usage
+#shellopts.usage
 #shellopts.brief
-#shellopts.help
+shellopts.help
 #shellopts.help("cmd")
 #shellopts.help(ARGV.first)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.5
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forward_to
@@ -187,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Parse command line options and arguments