cli-dispatcher 1.2.5 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1b37219d472cc73b55f56047050b442e634de6b08c649dc617c12c0e812f220
-  data.tar.gz: 1cf08e0e3893984ef5d15c414d87b0889c3073dea6d7a6e8d7a6c6b12889d181
+  metadata.gz: a74c717519d1436132b56f8785fbd3b8b8038f1be9066580c8b4f961945ee4f6
+  data.tar.gz: c2484c21170248bba3f244a395321ee7e500b99881a89060b8da6ac2aed56b6d
 SHA512:
-  metadata.gz: 593cce73a3bd60c69bcad822f1dcb20579f482eec9454ce86bd9164da88ff0f536cebdd67fbf55695c88622e3c391ece18bff6a12e8ad18f094d2cabee45308c
-  data.tar.gz: da5e84b8318b15d2510ac1a04086a66bd8a53689bb2afb59a9afa4d893f3380554702ecebdc55f88805002a8e81f15377767711cc16f17bb33d386624ea08724
+  metadata.gz: e255a21bf5fd03c2431c51daabc933e7e18debe6f7bd6178146bf2b23c5069eb41ce681d7700b325a8cc01c46b4a5df5c1d8a9b9c3f221c14a848d6645814684
+  data.tar.gz: 5148804c936128ba58c545d935cefdc7f6b1c063acddd98227e18149e1ef19e993ba9ed35e5783f703d925ec4877de9dbbbfbc1f1af8b5148b674ede88202fa0

data/lib/cli-dispatcher.rb

@@ -193,22 +193,58 @@ class Dispatcher
 
   #
   # Adds commands relevant when this dispatcher uses Structured data inputs.
+  # This method allows for generating documentation on Structured classes.
+  #
+  # The calling class should implement a method explain_classes that lists at
+  # least one Structured class that can be explained.
   #
   def self.add_structured_commands
     def help_explain
       return <<~EOF
         Displays an explanation of a Structured class.
 
-        Use this to assist in generating or checking a Rubric file.
+        This will produce documentation on the elements permitted within the
+        class. If no class is given, then a listing of known Structured classes
+        is produced.
       EOF
     end
 
-    def cmd_explain(class_name)
+    def cmd_explain(class_name = nil)
+      if class_name.nil?
+        cache = {}
+        puts "The following are Structured classes known to this program. Run"
+        puts "the command \"explain [class]\" for documentation on any of them."
+        puts
+        explain_classes.each do |c|
+          list_classes(c, cache)
+        end
+        return
+      end
+
       c = Object.const_get(class_name)
-      unless c.is_a?(Class) && c.include?(Structured)
+      if c.is_a?(Class) && c.include?(Structured)
+        c.explain
+      else
         raise "Invalid class #{class_name}"
       end
-      c.explain
+    end
+
+    unless defined? explain_classes
+      def explain_classes
+        return []
+      end
+    end
+
+    def list_classes(c, cache, level = 0)
+      unless c.include?(Structured)
+        raise "Cannot list classes of a non-Structured class"
+      end
+      puts(("  " * level) + c.to_s)
+      return if cache.include?(c)
+      cache[c] = true
+      c.subtypes.each do |sc|
+        list_classes(sc, cache, level + 1)
+      end
     end
 
     def help_template
@@ -227,12 +263,16 @@ class Dispatcher
   end
 
 
-  # Receives options, passing them to OptionParser. The options are processed
-  # when dispatch_argv is called. The usage of this method is that after the
-  # Dispatcher object is created, this method is called to instantiate the
-  # options for the class. See #add_options for another way of doing this.
   #
-  # The banner and -h/--help options will be added automatically.
+  # Creates an OptionParser object for this Dispatcher. The options for the
+  # OptionParser are defined in a block passed to this method. The block
+  # receives one argument, which is the OptionParser object being created.
+  #
+  # The banner and -h/--help options will be added automatically to the created
+  # OptionParser object.
+  #
+  # For a slightly simpler way to set up options for this Dispatcher object, see
+  # the add_options method.
   #
   def setup_options
     @option_parser = OptionParser.new do |opts|
@@ -241,10 +281,14 @@ class Dispatcher
   end
 
   #
-  # Given an OptionParser object, add options. By default, this method does
-  # nothing. The usage of this method, in contrast to #setup_options, is to
-  # override this method, invoking calls to the +opts+ argument to add options.
-  # The method will be called automatically when the Dispatcher is invoked.
+  # Adds command-line options for this class. By default, this method does
+  # nothing. Subclasses may override this method to add options. The method will
+  # be automatically invoked during a dispatch_argv call, thereby constructing
+  # an OptionParser object to handle the command-line arguments.
+  #
+  # The argument to this method is an OptionParser object, to which the desired
+  # options may be added. The banner and -h/--help options will be added
+  # automatically to the OptionParser object.
   #
   def add_options(opts)
   end

data/lib/structured-poly.rb

@@ -111,6 +111,10 @@ module StructuredPolymorphic
       end
     end
 
+    def subtypes
+      return @subclasses.values
+    end
+
     def template(indent: '')
       res = "#{indent}# #{name}\n"
       if @class_description

data/lib/structured.rb

@@ -1,5 +1,6 @@
 require_relative 'texttools'
 require 'yaml'
+require 'date'
 
 #
 # Sets up a class to receive an initializing hash and to populate information
@@ -461,7 +462,7 @@ module Structured
         Structured.trace(key.to_s) do
           val = hash[key] || hash[key.to_s]
           cval = process_value(obj, val, data)
-          apply_val(obj, key, cval) if cval
+          apply_val(obj, key, cval) unless cval.nil?
         end
       end
 
@@ -649,21 +650,27 @@ module Structured
     #
     def try_autoconvert(type, item)
 
-      if type == String && item.is_a?(Symbol)
+      case { item.class => type }
+
+      when { Symbol => String }
         return item.to_s
-      end
 
-      if type == Symbol && item.is_a?(String)
+      when { String => Symbol }
         return item.to_sym
-      end
 
-      # Special case in which strings will be converted to Regexps
-      if type == Regexp && item.is_a?(String)
+      when { String => Regexp }
         begin
           return Regexp.new(item)
         rescue RegexpError
           input_err("#{item} is not a valid regular expression")
         end
+
+      when { String => Date }
+        begin
+          return Date.parse(item)
+        rescue Date::Error
+          input_err("#{item} is not a valid date")
+        end
       end
 
       return item
@@ -744,6 +751,18 @@ module Structured
       end
     end
 
+    #
+    # Returns a list of all Structured types that are in elements of this class.
+    #
+    def subtypes
+      datas = @elements.values
+      datas << @default_element if @default_element
+      return datas.map { |data|
+        data[:type].is_a?(Hash) ? data[:type].first : data[:type]
+      }.flatten.select { |c| c.is_a?(Class) && c.include?(Structured) }.uniq
+    end
+
+
     #
     # Produces a template YAML file for this Structured object.
     def template(indent: '')

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli-dispatcher
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.8
 platform: ruby
 authors:
 - Charles Duan
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-10-02 00:00:00.000000000 Z
+date: 2026-02-20 00:00:00.000000000 Z
 dependencies: []
 description: |
   Library for creating command-line programs that accept commands. Also
@@ -28,6 +29,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/charlesduan/cli-dispatcher
   documentation_uri: https://rubydoc.info/gems/cli-dispatcher/
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -42,7 +44,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.3.5
+signing_key: 
 specification_version: 4
 summary: Command-line command dispatcher
 test_files: []