strop 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f104516e3a61250be80d317bb041ab59f8e39fadf0fd2b4aefe18de8af90165
-  data.tar.gz: b55d4717c195ec9373b495b933758435eb764fd4f51073761a45456e2de47784
+  metadata.gz: 225cf6a25d9576df114857aab9e157c4f9d2c666f74e066bd21fc012b9a8f83d
+  data.tar.gz: 2dfc769e16d1dff9db71788250fedeb23973a46fc2e86633bda69d03b3afef5c
 SHA512:
-  metadata.gz: 1e629cc1a18457b54482398d8d1578d787f57ddd182c627a076f2ce7d2be9c639be3c893734422d0a23cd2be5fa2a534c527888f1437d1474a527078f5365a63
-  data.tar.gz: 8ef9f135caede03849470cd17ee470c8440b34838736bc100ef5c41502e41b35d7c99caa18c6f832edeeac72c9c67f6c926b03cc6d393f0679d34609ac8f112f
+  metadata.gz: 57a71386c4e906a3b444da5dabb81a145faef6795639e420917f20386ee75d7c4e8a1442c398ea72db413ee363f5b284ebee113b0e3875b14867c331968c8a99
+  data.tar.gz: a77e623a861b637d2c01e955bf984d556fdd54d4b3c8f9896d22ac8b346fb370702eb04053a1c1a922de51a050e5627e5429ecc1c568bb21f650cf28c7e8f4e5

data/README.md

@@ -58,10 +58,11 @@ puts Strop.parse_help(help_text).to_s(:case)
 ## Result members (Array of Opt, Arg, Sep)
 
 ```ruby
-res.opts     # all Opt objects
-res.args     # all Arg objects
-res.rest     # args after -- separator
-res["flag"]  # find opt by name
+res.opts      # all Opt objects
+res.args      # all Arg objects
+res.rest      # args after -- separator
+res["flag"]   # find opt by name
+res[["flag"]] # find all opts matching name
 
 opt = res.opts.first
 arg = res.args.first
@@ -73,6 +74,7 @@ opt.no?      # true if --no-foo variant used
 opt.yes?     # opposite of `no?`
 arg.value    # positional argument
 arg.arg      # same as .value, useful for pattern matching
+arg.to_s     # implicit string conversion (same as .value)
 Sep          # -- end of options marker; Const, not instantiated
 ```
 
@@ -118,6 +120,7 @@ cmd -fVAL, --foo=VAL                  # attached values
 cmd -f VAL, --foo VAL                 # separate values
 cmd --foo val -- --bar                # --bar becomes positional after --
 cmd --intermixed args and --options   # flexible ordering
+cmd --ver                             # partial matching (--ver matches --verbose if unique)
 ```
 
 ## Manual option declaration building
@@ -141,6 +144,7 @@ Optdecl["foo_bar"]                    # --foo_bar: but not in strings.
 ```ruby
 optlist = Optlist[optdecl1, optdecl2] # combine decls into optlist
 optlist["f"]                          # lookup by name
+optlist["fl"]                         # partial match (finds "flag" if unique)
 ```
 
 ## Argument requirements

data/lib/strop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Strop
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/strop.rb

@@ -6,17 +6,18 @@ require_relative "strop/version"
 # Command-line option parser that builds options from help text
 module Strop
   def self.prefix(name) = (name[1] ? "--" : "-") + name # helper for printing back option names with the right prefix
+  def self.name_from_symbol(name) = Symbol === name ? name.to_s.gsub(?_, ?-) : name
 
   # Option declaration: names, argument requirement, and canonical label (auto-determined)
   # Optdecl[:f, :foo, arg: :may] #=> Optdecl(names: ["f", "foo"], arg: :may, label: "foo")
   Optdecl = Data.define(:names, :arg, :label) do
     def self.[](*names, arg: nil) = new(names:, arg:) # Custom builder: Optdecl[names, ..., arg: ...]
     def initialize(names:, arg: nil)
-      names = [*names].map{ Symbol === it ? it.to_s.gsub(?_, ?-) : it } # :foo_bar to "foo-bar" for symbols
-      names[0] = names[0].sub(/[!?]$/, "") unless arg                   # opt? / opt! to opt, and... (unless arg given)
-      arg ||= { ?? => :may, ?! => :must }[$&] || :shant                 # use ?/! to determine arg (unless arg given)
-      label = names.find{ it.size > 1 } || names.first                  # the canonical name used to search for it
-      %i[must may shant].member? arg or raise "invalid arg"             # validate arg
+      names = [*names].map{ Strop.name_from_symbol it }       # :foo_bar to "foo-bar" for symbols
+      names[0] = names[0].sub(/[!?]$/, "") unless arg         # opt? / opt! to opt, and... (unless arg given)
+      arg ||= { ?? => :may, ?! => :must }[$&] || :shant       # use ?/! to determine arg (unless arg given)
+      label = names.find{ it.size > 1 } || names.first        # the canonical name used to search for it
+      %i[must may shant].member? arg or raise "invalid arg"   # validate arg
       super names:, arg:, label:
     end
 
@@ -30,7 +31,18 @@ module Strop
   # Optlist[decl1, decl2] #=> [Optdecl(...), Optdecl(...)]
   class Optlist < Array # a list of Optdecls
     def self.from_help(doc) = Strop.parse_help(doc) #=> Optlist[decl, ...] # Build from help text
-    def [](k, ...) = [String, Symbol].any?{ it === k } ? self.find{ it.names.member? k.to_s } : super(k, ...)
+
+    def [](k, ...)
+      case k
+      in String | Symbol
+        s = Strop.name_from_symbol k
+        found = find{ it.names.member? s } and return found
+        found, *others = select{ it.names.any?{ it.start_with? s }} if s[1]
+        found if found && others.empty?
+      else super(k, ...)
+      end
+    end
+
     def to_s(as=:plain)
       case as
       when :plain then join("\n")
@@ -58,6 +70,7 @@ module Strop
   Arg = Data.define :value, :arg do
     def initialize(value:) = super(value:, arg: value)
     alias to_s value
+    alias to_str value
   end
 
   # Parsed option with declaration, invocation name, value, and negation state. Used internally. Seen as member of Result.
@@ -73,7 +86,7 @@ module Strop
   end
 
   # Const for parsed `--` end of option markers. Seen as member of Result.
-  Sep = :end_marker
+  Sep = :sep
 
   # Parse result containing options, arguments, and separators; Returned by `parse`
   # Result[opt1, arg1, Sep] #=> [Opt(...), Arg(...), Sep]
@@ -83,7 +96,8 @@ module Strop
     def opts = Result.new(select { Opt === it })
     def [](k, ...)
       case k
-      when String, Symbol then find{ Opt === it && it.decl.names.member?(k.to_s) }
+      in [String | Symbol => name] then opts.select{ it.decl.names.include? Strop.name_from_symbol name }
+      in String | Symbol           then find{ Opt === it && it.decl.names.member?(Strop.name_from_symbol k) }
       else super(k, ...)
       end
     end
@@ -123,7 +137,7 @@ module Strop
     res = Result.new
     ctx = :top
     name, token, opt = nil
-    rx_value = /\A[^-]|\A\z/ # not an opt
+    rx_value = /\A[^-]|\A-?\z/ # not an opt
     loop do
       case ctx
       in :end then return res.concat tokens.map{ Arg[it] } # opt parsing ended, rest is positional args

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strop
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Caio Chassot