shellopts 2.0.15 → 2.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 253954c7f2de836c89e511dffabf3217719e778d47f74740a51c3b1099dcd07f
-  data.tar.gz: 4a5579e3c56674d09ba380d392e600028e6c353728994e8b2445629b772cb450
+  metadata.gz: 43a4d96ef2927b72add380e17e0dad25b2004659491a5dc4adb36f3c9965c8c9
+  data.tar.gz: 507780f5ea40771db0ffbc4d0247b9f8f5d08044953dc0c387e92432c42879df
 SHA512:
-  metadata.gz: d0f0f0418361c69037a944c1e99021c32d578ed41dc239e7f9dc9f1ce94e578a137efdea3a9b96848fc0fb0b9aa1a8114153485b6ce21ceea7a3f34ceacdd197
-  data.tar.gz: f70644b23103d244fe06164a337839c042d6e65e1aa3dba59fa6b028cf7b0032fd694121c582142f2f3cdfbdaa12cba17464b74114bc5caf5b2aa489cde94f9a
+  metadata.gz: d57c4a7245f5c22b74c762d986b8a80ca331643a3f32f63421f08f412da01e3f6e21c76e0fe1921fa8337ad2cbc168e00bb9f722f3ebfc1fdb7468619169658d
+  data.tar.gz: 4ab7b06dd787db06af9ca0d70f6d44a26e251707badef5beecdb3bb719a3fc1bebf5357f00df2702589f4ea6960ebc6af83329adadc3e65bd2746e3dbb536fca

data/PROBLEMS

@@ -0,0 +1,52 @@
+
+# Subcommand options are not recognized unless there exists an option on the
+# program level (try to remove -a below)
+
+SPEC = %(
+  Foreign data wrapper maintenance tool
+
+  -a,an-option
+    Gryf
+
+  list.servers! -- DATABASE
+    List foreign servers
+
+  create.server! -- DATABASE FDW-SERVER MSSQL-DATABASE [MSSQL-HOST [MSSQL-PORT]]
+    Create a new FDW server
+
+    -c,credentials=EFILE
+      Credentials file. The credentials file is a YAML formatted file that can
+      define the fields 'user', 'password', 'host', and 'port'
+
+  drop.server! -- DATABASE FDW-SERVER
+    Drop a FDW server. This cascades to FDW users too
+
+  list.users! -- DATABASE
+    List FDW users. 'users' in this context is postgres users that have an
+    associated FDW user mapping
+
+    --servers @ Also list the user's FDW servers
+
+  create.user! -- DATABASE FDW-SERVER [FDW-USER [FDW-PASSWORD]]
+    Create a FDW user. The user has to exist beforehand, this command only adds
+    a user mapping to the user and grants the usage privilege
+
+    -c,credentials=EFILE
+      Credentials file
+
+  drop.user! -- DATABASE FDW-USER
+    Drops a FDW user. The postgres user is not dropped but the user's user
+    mapping and grants are
+)
+
+###########################
+
+# If option is only defined on a subcommand, it doesn't flow before the subcommand. This should be legal:
+ 
+cmd -c sub
+
+# Only this is legal today
+
+cmd sub -c
+
+

data/lib/ext/follow.rb

@@ -0,0 +1,26 @@
+
+module Algorithm
+  class FollowEnumerator < Enumerator
+    def initialize(object, method = nil, &block)
+      closure = method ? lambda { |object| object.__send__(method) } : block
+      super() { |yielder|
+        while object
+          yielder << object
+          object = closure.call(object)
+        end
+      }
+    end
+  end
+
+  def follow(object, method = nil, &block)
+    !method.nil? || block_given? or raise ArgumentError, "Needs either a method or a block"
+    method.nil? == block_given? or raise ArgumentError, "Can't use both method and block"
+    FollowEnumerator.new(object, method, &block)
+  end
+
+  module_function :follow
+end
+
+
+
+

data/lib/shellopts/grammar.rb

@@ -30,7 +30,7 @@ module ShellOpts
       def ancestors() parents.reverse end
 
       def inspect
-        "#{self.class}"
+        self.class.to_s
       end
 
     protected
@@ -241,7 +241,7 @@ module ShellOpts
       def [](key)
         case key
           when String; lookup(key.split("."))
-          when Symbol; lookup(key.to_s.sub(".", "!.").split(".").map(&:to_sym))
+          when Symbol; lookup(key.to_s.gsub(".", "!.").split(".").map(&:to_sym))
           when Array; lookup(key)
         else
           nil

data/lib/shellopts/program.rb

@@ -52,7 +52,7 @@ module ShellOpts
     # These methods can be overridden by an option or a command (this constant
     # is not used - it is just for informational purposes)
     OVERRIDEABLE_METHOD_NAMES = %w(
-        subcommand subcommand! supercommand!
+        subcommand subcommand! subcommands subcommands! supercommand!
     )
 
     # Redefine ::new to call #__initialize__
@@ -62,49 +62,37 @@ module ShellOpts
       object
     end
 
-    # Return command or option object if present, otherwise nil. Returns a
-    # possibly empty array of option objects if the option is repeatable
+    # Returns the command or option object identified by the UID if present and
+    # otherwise nil. Returns a possibly empty array of option objects if the
+    # option is repeatable. Raise an ArgumentError if the key doesn't exists
     #
-    # 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
+    # The +key+ is the symbolic UID of the object. Eg. :command.option or
+    # :command.subcommand!
     #
-    def [](key)
-      case object = __grammar__[key]
-        when ::ShellOpts::Grammar::Command
-          object.ident == __subcommand__!.__ident__ ? __subcommand__! : nil
-        when ::ShellOpts::Grammar::Option
-          if object.repeatable?
-            __option_hash__[object.ident] || []
+    def [](uid)
+      __grammar__.key?(uid) or ::Kernel.raise ::ArgumentError, "'#{uid}' is not a valid UID"
+      idents = uid.to_s.gsub(/\./, "!.").split(/\./).map(&:to_sym)
+      idents.inject(self) { |cmd, ident|
+        case ident.to_s
+          when /!$/
+            return nil if cmd.__subcommand__ != ident
+            cmd = cmd.__subcommand__!
           else
-            __option_hash__[object.ident]
-          end
-        else
-          ::Kernel.raise ::ArgumentError, "Unknown command or option: '#{key}'"
-      end
+            opt = cmd.__option_hash__[ident]
+            opt.nil? && cmd.__grammar__[ident].repeatable? ? [] : opt
+        end
+      }
     end
 
-    # Return true if the given command or option is present
-    def key?(key)
-      case object = __grammar__[key]
-        when ::ShellOpts::Grammar::Command
-          object.ident == __subcommand__
-        when ::ShellOpts::Grammar::Option
-          __option_hash__.key?(object.ident)
-        else
-          ::Kernel.raise ::ArgumentError, "Unknown command or option: '#{key}'"
-      end
-    end
-      
     # Returns a hash of the given options if defined. Returns all options if no
     # options are given
     def to_h(*keys)
       keys = ::Kernel::Array(keys).flatten
       if keys.empty?
-        @__option_values__
+        self.to_h(@__grammar__.options.map(&:ident))
       else
         keys.map { |key|
-          @__option_values__.key?(key) ? [key, @__option_values__[key]] : nil
+          self.__send__("#{key}?".to_sym) ? [key, self.__send__(key)] : nil
         }.compact.to_h
       end
     end
@@ -133,6 +121,13 @@ module ShellOpts
     #
     def subcommand!() __subcommand__! end
 
+    # Returns the concatenated identifier of subcommands (eg. :cmd.subcmd!)
+    def subcommands() __subcommands__ end
+
+    # Returns the subcommands in an array. This doesn't include the top-level
+    # program object
+    def subcommands!() __subcommands__! end
+
     # The parent command or nil. Initialized by #add_command
     #
     # Note: Can be overridden by a subcommand declaration (but not an
@@ -141,7 +136,7 @@ module ShellOpts
     #
     def supercommand!() __supercommand__ end
 
-    # UID of command/program
+    # UID of command/program (String)
     def __uid__() @__grammar__.uid end
 
     # Identfier including the exclamation mark (Symbol)
@@ -155,8 +150,8 @@ module ShellOpts
 
     # Hash from identifier to value. Can be Integer, Float, or String depending
     # on the option's type. Repeated options options without arguments have the
-    # number of occurences as value and with arguments the value is an array of
-    # the given values
+    # number of occurences as value, repeated option with arguments have the
+    # array of values as value
     attr_reader :__option_values__
 
     # List of Option objects for the subcommand in the same order as
@@ -180,6 +175,16 @@ module ShellOpts
     # The actual subcommand object or nil if not present
     def __subcommand__!() @__subcommand__ end
 
+    # Implementation of the #subcommands method
+    def __subcommands__()
+      __subcommands__!.last&.__uid__&.to_sym
+    end
+
+    # Implementation of the #subcommands! method
+    def __subcommands__!()
+      ::Algorithm.follow(self.__subcommand__!, :__subcommand__!).to_a
+    end
+
   private
     def __initialize__(grammar)
       @__grammar__ = grammar

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.0.15"
+  VERSION = "2.0.18"
 end

data/lib/shellopts.rb

@@ -5,6 +5,7 @@ require 'constrain'
 include Constrain
 
 require 'ext/array.rb'
+require 'ext/follow.rb'
 require 'ext/forward_to.rb'
 require 'ext/lcs.rb'
 include ForwardTo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.0.15
+  version: 2.0.18
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
+date: 2022-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forward_to
@@ -135,6 +135,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - Gemfile
+- PROBLEMS
 - README.md
 - Rakefile
 - TODO
@@ -147,6 +148,7 @@ files:
 - doc/syntax.rb
 - doc/syntax.txt
 - lib/ext/array.rb
+- lib/ext/follow.rb
 - lib/ext/forward_to.rb
 - lib/ext/lcs.rb
 - lib/shellopts.rb