shellopts 2.0.10 → 2.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 812078e64c677a6aff78081e25a04b81be3b3a1fe9496709838e2abb80573b4a
-  data.tar.gz: 92c14741c409697f543820d656683b9552d4c6c7ce5c29b01a30677a174549c2
+  metadata.gz: 485e81c58a890240d2a77e24a5f3a7a291551da968f395f3aaa4f5b2dac3cc9b
+  data.tar.gz: 2d6c92ca01ce1207f6311cf9b0e9bab3e555e309142ba6916d589396f215afb8
 SHA512:
-  metadata.gz: 3b1ac7453a534a50cf250e489688aa82ad1928220a615b9e4f7076c27b588d19a7b355e866f3e3cc789fd2259bb2e5de14ac92e905b7b033528c11be26564356
-  data.tar.gz: d50433ec49a4bf67fd9947d2028ed81be9c8310e7410d93c691e2cd59ed36ef622937c861ef1f4608e7ef5869804cd0f1a4197abf03fd4c2d96cef4985d5dab4
+  metadata.gz: 31f3801b98585bed378ff77ae6632d18951ef37a49b3cfde843df9718dc5b46da40e777dff3f7b29e01bf8b32f2ebe0e1e7ab76ddb66744a461acf0061f75b1f
+  data.tar.gz: d72bcf1d58e9afdf4f92477af1f2824e01031a46b4cacf5283878ce1045ad91dd930c1c1a15cd588a2552a4ad90fe5ac3add6019b50e099693aa184b7747153f

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/version.rb

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

metadata

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