cli-dispatcher 1.2.3 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f11805cc9ecff05fe987fe958cb4b6bf6a3a49d2a56596ff0eee761936b3ce3
-  data.tar.gz: aac95196261ffb6835e1ca0220c5786f260f71bd8f9e904eaa7a824943cacd04
+  metadata.gz: b1b37219d472cc73b55f56047050b442e634de6b08c649dc617c12c0e812f220
+  data.tar.gz: 1cf08e0e3893984ef5d15c414d87b0889c3073dea6d7a6e8d7a6c6b12889d181
 SHA512:
-  metadata.gz: d2a65276ba20ff7532ea71aff7219ade85ec908a317a8753740b42f1531283269e78df415ac6dbb607bfd009800e6e94cdd3692f01c2344b0c4653791455658b
-  data.tar.gz: f2ec39cb1df8e03763a8b7b1a70fc01efa696d16df14f593abd8f80acdbd1c54359d05b99104837245be76d9b665896fa24665928ef025bc1bb149110b19c92a
+  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.
   #

data/lib/structured.rb

@@ -779,7 +779,7 @@ module Structured
     # @param indent The indent string before new lines.
     # @param sp Spacing after the colon, if any.
     def template_type(type, indent, sp = ' ')
-      res = ''
+      res = String.new('')
       case type
       when :boolean
         res << " true/false\n"

data/lib/texttools.rb

@@ -11,17 +11,41 @@ module TextTools
   def line_break(
     text, len: 80, prefix: '', first_prefix: nil, preserve_lines: false
   )
-    res = ''
+    res = String.new('')
+
+    #
+    # Remove single paragraph breaks (unless preserve_lines is on). After this,
+    # every paragraph break should be preserved. Also remove trailing
+    # whitespace, which causes problems.
+    #
     text = text.split(/\s*\n\s*\n\s*/).map { |para|
       preserve_lines ? para : para.gsub(/\s*\n\s*/, " ")
-    }.join("\n\n")
+    }.join("\n\n").rstrip
 
     cur_prefix = first_prefix || prefix
+
+    # Process each individual line separately.
+    while (line_match = /\s*\n\s*/.match(text))
+      res << one_line_break(line_match.pre_match, len, cur_prefix, prefix)
+      res << line_match[0].gsub(/[^\n]/, '')
+      cur_prefix = prefix
+      text = line_match.post_match
+    end
+    res << one_line_break(text, len, cur_prefix, prefix)
+    return res
+
+  end
+
+  #
+  # Line break a text that is guaranteed not to have any line breaks within it.
+  #
+  def one_line_break(text, len, first_prefix, prefix)
+    res = String.new('')
+    cur_prefix = first_prefix
     strlen = len - cur_prefix.length
     while text.length > strlen
-      if (m = /\A([^\n]{0,#{strlen}})(\s+)/.match(text))
-        res << cur_prefix + m[1]
-        res << (m[2].include?("\n") ? m[2].gsub(/[^\n]/, '') : "\n")
+      if (m = /\A(.{0,#{strlen}})(\s+)/.match(text))
+        res << cur_prefix + m[1] + "\n"
         text = m.post_match
       else
         res << cur_prefix + text[0, strlen] + "\n"
@@ -31,8 +55,6 @@ module TextTools
       strlen = len - cur_prefix.length
     end
 
-    # If there's no text left, then there were trailing spaces and the final \n
-    # is superfluous.
     if text.length > 0
       res << cur_prefix + text
     else

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cli-dispatcher
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.5
 platform: ruby
 authors:
 - Charles Duan
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-14 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
@@ -29,7 +28,6 @@ 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
@@ -44,8 +42,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Command-line command dispatcher
 test_files: []