shellopts 2.0.10 → 2.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 812078e64c677a6aff78081e25a04b81be3b3a1fe9496709838e2abb80573b4a
-  data.tar.gz: 92c14741c409697f543820d656683b9552d4c6c7ce5c29b01a30677a174549c2
+  metadata.gz: 8dd7a731b489dbf650e15549d9768469ae9d6c47c6dba3ae79f4d956fea069ab
+  data.tar.gz: 4b71aff7ba350d4616a136580857a6acd840141ed0b7463034518dcf4ae4dada
 SHA512:
-  metadata.gz: 3b1ac7453a534a50cf250e489688aa82ad1928220a615b9e4f7076c27b588d19a7b355e866f3e3cc789fd2259bb2e5de14ac92e905b7b033528c11be26564356
-  data.tar.gz: d50433ec49a4bf67fd9947d2028ed81be9c8310e7410d93c691e2cd59ed36ef622937c861ef1f4608e7ef5869804cd0f1a4197abf03fd4c2d96cef4985d5dab4
+  metadata.gz: bb5792606dd91f46b95fe786b509fd079697c87fd603c667e49740b365cafafa0cdc7b49a0a86c72cd014f9c2d88cdf74f096422e6099403042d8c34d35044b3
+  data.tar.gz: d7f2637649b474741b70dd9334e25107586fe52eb4e4f9a289453699f334488fed60322a676ad20fcab2f0c993785ccdef89be4397055028e75d79795766b972

data/lib/ext/array.rb

@@ -41,7 +41,9 @@ module Ext
 
     module Wrap
       refine ::Array do
-        # Concatenate strings into lines that are at most +width+ characters wide
+        # Concatenate array of words into lines that are at most +width+
+        # characters wide. +curr+ is the initial number of characters already
+        # used on the first line
         def wrap(width, curr = 0)
           lines = [[]]
           curr -= 1 # Simplifies conditions below

data/lib/shellopts/formatter.rb

@@ -1,12 +1,5 @@
 require 'terminfo'
 
-# TODO: Move to ext/indented_io.rb
-module IndentedIO
-  class IndentedIO
-    def margin() combined_indent.size end
-  end
-end
-
 module ShellOpts
   module Grammar
     class Node
@@ -216,7 +209,10 @@ module ShellOpts
     BRIEF_COL1_MAX_WIDTH = 40
 
     # Minimum width of second column in brief option and command lists
-    BRIEF_COL2_MAX_WIDTH = 50
+    BRIEF_COL2_MIN_WIDTH = 30
+
+    # Maximum width of second column in brief option and command lists
+    BRIEF_COL2_MAX_WIDTH = 70
 
     # Indent to use in help output
     HELP_INDENT = 4
@@ -226,29 +222,21 @@ module ShellOpts
 
     # Usage string in error messages
     def self.usage(subject)
-      subject = Grammar::Command.command(subject)
-      @command_prefix = subject.ancestors.map { |node| node.name + " " }.join
+      command = Grammar::Command.command(subject)
+      @command_prefix = command.ancestors.map { |node| node.name + " " }.join
       setup_indent(1) {
         print lead = "#{USAGE_STRING}: "
-        indent(lead.size, ' ', bol: false) { subject.puts_usage }
+        indent(lead.size, ' ', bol: false) { command.puts_usage }
       }
     end
 
-#   # TODO
-#   def self.usage=(usage_lambda)
-#   end
-
     # When the user gives a -h option
-    def self.brief(command)
-      command = Grammar::Command.command(command)
+    def self.brief(subject)
+      command = Grammar::Command.command(subject)
       @command_prefix = command.ancestors.map { |node| node.name + " " }.join
       setup_indent(BRIEF_INDENT) { command.puts_brief }
     end
 
-#   # TODO
-#   def self.brief=(brief_lambda)
-#   end
-
     # When the user gives a --help option
     def self.help(subject)
       subject = Grammar::Command.command(subject)
@@ -262,18 +250,6 @@ module ShellOpts
       obj.is_a?(Grammar::Command) ? obj : obj.__grammar__
     end
 
-#   # TODO
-#   def self.help_w_lambda(program)
-#     if @help_lambda
-#       #
-#     else
-#       program = Grammar::Command.command(program)
-#       setup_indent(HELP_INDENT) { program.puts_descr }
-#     end
-#   end
-#
-#   def self.help=(help_lambda) @help_lambda end
-
     def self.puts_columns(widths, fields)
       l = []
       first_width, second_width = *widths
@@ -284,40 +260,47 @@ module ShellOpts
           puts first
           indent(first_width + BRIEF_COL_SEP, ' ') { puts second.wrap(second_width) } if second
         elsif second
-          printf "%-#{first_width + BRIEF_COL_SEP}s", first
-          indent(first_width, bol: false) { puts second.wrap(second_width) }
+          indent_size = first_width + BRIEF_COL_SEP
+          printf "%-#{indent_size}s", first
+          indent(indent_size, ' ', bol: false) { puts second.wrap(second_width) }
         else
           puts first
         end
       end
     end
 
+    # Returns a tuple of [first-column-width, second-column-width]. +width+ is
+    # the maximum width of the colunms and the BRIEF_COL_SEP separator.
+    # +fields+ is an array of [subject-string, descr-text] tuples where the
+    # descr is an array of words
     def self.compute_columns(width, fields)
-      first_max = [
-        (fields.map { |first, _| first.size } + [BRIEF_COL1_MIN_WIDTH]).max, 
-        BRIEF_COL1_MAX_WIDTH
-      ].min
-      second_max = fields.map { |_, second| second ? second&.map(&:size).sum + second.size - 1: 0 }.max
-
-      if first_max + BRIEF_COL_SEP + second_max <= width
-        first_width = first_max
-        second_width = second_max
-      elsif first_max + BRIEF_COL_SEP + BRIEF_COL2_MAX_WIDTH <= width
-        first_width = first_max
-        second_width = width - first_width - BRIEF_COL_SEP
+      first_max = 
+          fields.map { |first, _| first.size }.select { |size| size <= BRIEF_COL1_MAX_WIDTH }.max ||
+          BRIEF_COL1_MIN_WIDTH
+      second_max = fields.map { |_, second| second ? second&.map(&:size).sum + second.size - 1 : 0 }.max
+      first_width = [[first_max, BRIEF_COL1_MIN_WIDTH].max, BRIEF_COL1_MAX_WIDTH].min
+      rest = width - first_width - BRIEF_COL_SEP
+      second_min = [BRIEF_COL2_MIN_WIDTH, second_max].min
+      if rest < second_min
+        first_width = [first_max, width - second_min - BRIEF_COL_SEP].max
+        second_width = [width - first_width - BRIEF_COL_SEP, BRIEF_COL2_MIN_WIDTH].max
       else
-        first_width = [width - BRIEF_COL_SEP - BRIEF_COL2_MAX_WIDTH, BRIEF_COL1_MAX_WIDTH].min
-        second_width = BRIEF_COL2_MAX_WIDTH
+        second_width = [[rest, BRIEF_COL2_MIN_WIDTH].max, BRIEF_COL2_MAX_WIDTH].min
       end
-
       [first_width, second_width]
     end
 
     def self.width()
       @width ||= TermInfo.screen_width - MARGIN_RIGHT
+      @width
+    end
+
+    # Used in rspec
+    def self.width=(width)
+      @width = width
     end
 
-    def self.rest() width - $stdout.margin end
+    def self.rest() width - $stdout.tab end
 
   private
     # TODO Get rid of?

data/lib/shellopts/program.rb

@@ -45,12 +45,12 @@ module ShellOpts
 
     # These names can't be used as option or command names
     RESERVED_OPTION_NAMES = %w(
-        is_a instance_eval instance_exec method_missing singleton_method_added
+        is_a to_h instance_eval instance_exec method_missing singleton_method_added
         singleton_method_removed singleton_method_undefined
     )
 
-    # These methods can be overridden by an option or a command (the value is not used -
-    # this is just for informational purposes)
+    # These methods can be overridden by an option or a command (this constant
+    # is not used - it is just for informational purposes)
     OVERRIDEABLE_METHOD_NAMES = %w(
         subcommand subcommand! supercommand!
     )
@@ -96,6 +96,19 @@ module ShellOpts
       end
     end
       
+    # Returns a hash of the given options if defined. Returns all options if no
+    # options are given
+    def to_h(*keys)
+      keys = ::Kernel::Array(keys).flatten
+      if keys.empty?
+        @__option_values__
+      else
+        keys.map { |key|
+          @__option_values__.key?(key) ? [key, @__option_values__[key]] : nil
+        }.compact.to_h
+      end
+    end
+
     # Subcommand identifier or nil if not present. #subcommand is often used in
     # case statement to branch out to code that handles the given subcommand:
     #

data/lib/shellopts/version.rb

@@ -1,3 +1,3 @@
 module ShellOpts
-  VERSION = "2.0.10"
+  VERSION = "2.0.13"
 end

data/lib/shellopts.rb

@@ -192,23 +192,23 @@ module ShellOpts
     #
     # #error is supposed to be used when the user made an error and the usage
     # is written to help correcting the error
-    #
     def error(subject = nil, message)
-      saved = $stdout
-      $stdout = $stderr
       $stderr.puts "#{name}: #{message}"
-      Formatter.usage(grammar)
-      exit 1
-    ensure
-      $stdout = saved
+      saved = $stdout
+      begin
+        $stdout = $stderr
+        Formatter.usage(grammar)
+        exit 1
+      ensure
+        $stdout = saved
+      end
     end
 
     # Write error message to standard error and terminate program with status 1
     #
-    # #failure is supposed to be used the used specified the correct arguments
-    # but something went wrong during processing. Since the used didn't cause
-    # the problem, only the error message is written
-    #
+    # #failure doesn't print the program usage because is supposed to be used
+    # when the user specified the correct arguments but something else went
+    # wrong during processing
     def failure(message)
       $stderr.puts "#{name}: #{message}"
       exit 1
@@ -222,7 +222,6 @@ module ShellOpts
 
     # Print help for the given subject or the full documentation if +subject+
     # is nil. Clears the screen beforehand if :clear is true
-    #
     def help(subject = nil, clear: true)
       node = (subject ? @grammar[subject] : @grammar) or
           raise ArgumentError, "No such command: '#{subject&.sub(".", " ")}'"
@@ -333,7 +332,17 @@ module ShellOpts
   def self.instance=(instance) @instance = instance end
   def self.shellopts() instance end
 
-  forward_self_to :instance, :error, :failure
+  def self.error(subject = nil, message)
+    instance.error(subject, message) if instance? # Never returns
+    $stderr.puts "#{File.basename($PROGRAM_NAME)}: #{message}"
+    exit 1
+  end
+
+  def self.failure(message)
+    instance.failure(message) if instance?
+    $stderr.puts "#{File.basename($PROGRAM_NAME)}: #{message}"
+    exit 1
+  end
 
   # The Include module brings the reporting methods into the namespace when
   # included

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shellopts
 version: !ruby/object:Gem::Version
-  version: 2.0.10
+  version: 2.0.13
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-08 00:00:00.000000000 Z
+date: 2022-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forward_to