cli-dispatcher 1.2.4 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f480b01f8af6a9af5c131e3e25081edd7e69fff4caf3daa22ea10efbc49b4f4
-  data.tar.gz: 2eea3e4b6791f4babe182b56c15607b7fa5eb532106c00505fb26b8b0ee0f0d9
+  metadata.gz: b1b37219d472cc73b55f56047050b442e634de6b08c649dc617c12c0e812f220
+  data.tar.gz: 1cf08e0e3893984ef5d15c414d87b0889c3073dea6d7a6e8d7a6c6b12889d181
 SHA512:
-  metadata.gz: b4ea432b818502f65c048a0911aef575b42ed17d2cff7e42f97382f5b3f6ce77e8cf52964f9ca43eb85b467c4f3a67bcc957a14d51b82b5fe37ff120524f03a9
-  data.tar.gz: 9e5dbff959cc60f44ebadf445cb3257fea82403c2db4f053a7f241deb0f7a290cc5b5f02e3810e8ca48ba5ea16893765cfbe8e73c8b7f73b12c7462004b56ef7
+  metadata.gz: 593cce73a3bd60c69bcad822f1dcb20579f482eec9454ce86bd9164da88ff0f536cebdd67fbf55695c88622e3c391ece18bff6a12e8ad18f094d2cabee45308c
+  data.tar.gz: da5e84b8318b15d2510ac1a04086a66bd8a53689bb2afb59a9afa4d893f3380554702ecebdc55f88805002a8e81f15377767711cc16f17bb33d386624ea08724

data/lib/cli-dispatcher.rb

@@ -1,5 +1,7 @@
 require 'optparse'
 require 'texttools'
+require 'reline'
+require 'shellwords'
 
 #
 # Constructs a program that can operate a number of user-provided commands. To
@@ -31,12 +33,12 @@ class Dispatcher
   # Reads ARGV and dispatches a command. If no arguments are given, an
   # appropriate warning is issued and the program terminates.
   #
-  def dispatch_argv
+  def dispatch_argv(default_interactive = false)
     @option_parser ||= OptionParser.new
     add_options(@option_parser)
     @option_parser.banner = <<~EOF
-      Usage: #$0 [options] command [arguments...]
-      Run '#$0 help' for a list of commands.
+      Usage: #{File.basename($0)} [options] command [arguments...]
+      Run '#{File.basename($0)} help' for a list of commands.
 
       Options:
     EOF
@@ -48,35 +50,39 @@ class Dispatcher
     end
 
     @option_parser.parse!
-    if ARGV.empty?
+    if !ARGV.empty?
+      exit dispatch(*ARGV) ? 0 : 1
+    elsif default_interactive
+      cmd_interactive
+    else
       STDERR.puts(@option_parser)
       exit 1
     end
-    dispatch(*ARGV)
   end
 
   #
   # Dispatches a single command with given arguments. If the command is not
-  # found, then issues a help warning.
+  # found, then issues a help warning. Returns true or false depending on
+  # whether the command executed successfully.
   #
   def dispatch(cmd, *args)
     cmd_sym = "cmd_#{cmd}".to_sym
     begin
       if respond_to?(cmd_sym)
         send(cmd_sym, *args)
+        return true
       else
-        warn("Usage: #$0 [options] command [arguments...]")
-        warn("Run '#$0 help' for a list of commands.")
-        exit(1)
+        warn("Unknown command #{cmd_sym}. Run 'help' for a list of commands.")
+        return false
       end
     rescue ArgumentError
       if $!.backtrace_locations.first.base_label == cmd_sym.to_s
-        warn("#{cmd}: wrong number of arguments")
+        warn("#{cmd}: wrong number of arguments.")
         warn("Usage: #{signature_string(cmd)}")
-        exit(1)
       else
-        raise $!
+        raise
       end
+      return false
     end
   end
 
@@ -143,12 +149,48 @@ class Dispatcher
     cmds.sort.each do |cmd|
       warn(TextTools.line_break(
         help_string(cmd, all: false),
-        prefix: " " * 11,
-        first_prefix: cmd.ljust(10) + ' ',
+        prefix: " " * 12,
+        first_prefix: cmd.ljust(11) + ' ',
       ))
     end
   end
 
+  def help_interactive
+    return "Start an interactive shell for entering commands."
+  end
+
+  #
+  # Runs the dispatcher in interactive mode, in which command lines are read
+  # from a prompt.
+  #
+  def cmd_interactive
+    stty_save = `stty -g`.chomp
+    loop do
+      begin
+        buf = Reline.readline(interactive_prompt, true)
+        exit unless buf
+        args = buf.shellsplit
+        next if args.empty?
+        exit if args.first == 'exit'
+        dispatch(*args)
+      rescue Interrupt
+        system("stty", stty_save)
+        exit
+      rescue
+        STDERR.puts $!.full_message
+      end
+    end
+  end
+
+  #
+  # Returns the string for the interactive prompt. Subclasses can override this
+  # method to offer more detailed prompts.
+  #
+  def interactive_prompt
+    return "#{File.basename($0)}> "
+  end
+
+
   #
   # Adds commands relevant when this dispatcher uses Structured data inputs.
   #

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cli-dispatcher
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.5
 platform: ruby
 authors:
 - Charles Duan
 bindir: bin
 cert_chain: []
-date: 2025-05-20 00:00:00.000000000 Z
+date: 2025-10-02 00:00:00.000000000 Z
 dependencies: []
 description: |
   Library for creating command-line programs that accept commands. Also
@@ -42,7 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Command-line command dispatcher
 test_files: []