cli-dispatcher 1.2.4 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f480b01f8af6a9af5c131e3e25081edd7e69fff4caf3daa22ea10efbc49b4f4
-  data.tar.gz: 2eea3e4b6791f4babe182b56c15607b7fa5eb532106c00505fb26b8b0ee0f0d9
+  metadata.gz: be7440d7ccb3b1dfd9b90eae4b32d62597a864e4dd6676deaf9dc36e08d08470
+  data.tar.gz: 3338fab7655d4074368786f822ffac62c9b12d3e74ea98ef7bc554f44b248e93
 SHA512:
-  metadata.gz: b4ea432b818502f65c048a0911aef575b42ed17d2cff7e42f97382f5b3f6ce77e8cf52964f9ca43eb85b467c4f3a67bcc957a14d51b82b5fe37ff120524f03a9
-  data.tar.gz: 9e5dbff959cc60f44ebadf445cb3257fea82403c2db4f053a7f241deb0f7a290cc5b5f02e3810e8ca48ba5ea16893765cfbe8e73c8b7f73b12c7462004b56ef7
+  metadata.gz: 16e45a2046ebbd9679789549b53e15afb4b4cd556bf1857feb25e61c4d90f55a4bb4d555f242fc66af926550566aa4e75fcf5bd693133475c00070ffbc102b91
+  data.tar.gz: 2f09de799fcca6242233880aa6452abf600e3d179f6ddd7b9b3d03747980d327e68e56cb8609264c3ac7b29397f5285d2264c4b96ef55c5d1eb4c74e05a26cb0

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.
   #
@@ -185,12 +227,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|
@@ -199,10 +245,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.rb

@@ -461,7 +461,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
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cli-dispatcher
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.6
 platform: ruby
 authors:
 - Charles Duan
 bindir: bin
 cert_chain: []
-date: 2025-05-20 00:00:00.000000000 Z
+date: 2025-12-04 00:00:00.000000000 Z
 dependencies: []
 description: |
   Library for creating command-line programs that accept commands. Also