cli-dispatcher 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e946454a75a033c55b82ca4814654e27e75f8635ea02b42ad5fbd95a6cc7b4c8
-  data.tar.gz: f964e67077a8e2077a44db8b033d5a82be7fcbe10e9f2cad11504b6116e8397e
+  metadata.gz: 1601becbe908448760f6f02f45ce374db04a7b6926304cb381d5193748121a76
+  data.tar.gz: b51470fabe4535e155f8d1d7b82de56b5a5c50471aca95db3aec278fc0abd588
 SHA512:
-  metadata.gz: d93f6c815a777f40501094b84bc386178f8a45b20b6dccb4809667d3c7f855b2899a1aa48df04e9cc71eee43353b4105dd911ad1c422f187e276193aa75e8446
-  data.tar.gz: 6d81ee52b9cac75a9446b221b7b8c8edf767b5998146a87a14bfe0e9353e80ebfbb4b57ce639c3d2d7c1b7f5fb29c1bc809197b3d07aa71a7cfd7c355295eb99
+  metadata.gz: 0a7b5ad86d5decfd5486f26b0c618e5f6301399493da66731eeb745340f423194e01923261c1ae8766d0bae4ae0494195f82af301e8d769c98dffe937fc49c75
+  data.tar.gz: 7f565106772b1d79b7839bdedf48181eb654a2d440c83b0bbdd474feade662529dbee2615824316fc950e914ccf929a30f7c43506f9082005d080995bb536fc1

data/lib/cli-dispatcher.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'texttools'
 
 #
 # Constructs a program that can operate a number of user-provided commands. To
@@ -6,18 +7,23 @@ require 'optparse'
 #
 #   def cmd_name(args...)
 #
-# Then create an instance of the class and call one of the dispatch methods.
+# Then create an instance of the class and call one of the dispatch methods,
+# typically:
 #
-# To provide help for a command, define a method:
+#   [DispatcherSubclass].new.dispatch_argv
 #
-#   def help_name
+# To provide help and/or a category for a command, define the methods
 #
-# The first line should be a short description of the command, which will be
-# used in a summary table describing the command.
+#   def help_name; [string] end
+#   def cat_name;  [string] end
+#
+# For the help command, the first line should be a short description of the
+# command, which will be used in a summary table describing the command. For the
+# category, all commands with the same category will be grouped together in the
+# help summary display.
 #
 # This class incorporates optparse, providing the commands setup_options and
-# add_options to pass
-# through options specifications.
+# add_options to pass through options specifications.
 #
 class Dispatcher
 
@@ -118,11 +124,28 @@ class Dispatcher
     warn("Run 'help [command]' for further help on that command.")
     warn("")
 
-    methods.map { |m|
+    grouped_methods = methods.map { |m|
       s = m.to_s
       s.start_with?("cmd_") ? s.delete_prefix("cmd_") : nil
-    }.compact.sort.each do |cmd|
-      warn("%-10s %s" % [ cmd, help_string(cmd, all: false) ])
+    }.compact.group_by { |m|
+      cat_m = "cat_#{m}".to_sym
+      respond_to?(cat_m) ? send(cat_m) : nil
+    }
+    help_cmds(grouped_methods.delete(nil)) if grouped_methods.include?(nil)
+
+    grouped_methods.sort.each do |cat, cmds|
+      warn("\n#{cat}\n\n")
+      help_cmds(cmds)
+    end
+  end
+
+  def help_cmds(cmds)
+    cmds.sort.each do |cmd|
+      warn(TextTools.line_break(
+        help_string(cmd, all: false),
+        prefix: " " * 11,
+        first_prefix: cmd.ljust(10) + ' ',
+      ))
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli-dispatcher
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Charles Duan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-02 00:00:00.000000000 Z
+date: 2024-12-22 00:00:00.000000000 Z
 dependencies: []
 description: |
   Library for creating command-line programs that accept commands. Also
@@ -44,7 +44,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Command-line command dispatcher