usps-imis-api 0.13.4 → 0.13.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f34a885284d3ccfeced54ef7b76cda38b69922d80c61ba22d4950945ee4bc1ea
-  data.tar.gz: fe1a7952665d65adabddf3f13eed3720b267b20ee2d5029715df096bbc82d52f
+  metadata.gz: 6f533f6f1c46a836c57ed615db3e4ed3a960e1cf6e280d258cc59ee72bbe735d
+  data.tar.gz: b2877c785c60738326dc96e7aa50da21eff214e21b961a30773dc2f0f843e195
 SHA512:
-  metadata.gz: f99eb59125c90b6e1c7dc11b2e32c6b3eea327825785614629919b9548aa429ed30458d68f59943557e07e37c3faef6c22deddc9b5e5da127c05d26f674912d3
-  data.tar.gz: 0dd03c7791e6d1e68a0365aa87c741a44fb5b145aec6002c264e2931c6fa14f35554321ec1cb6d59dfcd36c012ccfcd2f4e0adae514886f48a31ba87a484930a
+  metadata.gz: 1c032d83d0b9c87de3d0e705e330e840cf159dc252837b54b138b5ee7a791d587b21630050b05427a59d81a5c2c605331b514dbed339634a199c2fc67f61b35c
+  data.tar.gz: 6f6a335d752b0aacef359d5fb79a499e7f6224a9c884acc42730beb44ab595d4a88659545fb7ec8ae612d84c3ba16159cc568a8993a1101bbf7bca74bd399e48

data/lib/usps/imis/command_line/help.rb

@@ -8,9 +8,24 @@ module Usps
       # @private
       #
       module Help
-        TERMINAL_WIDTH = 120
+        # Width of the terminal window
+        #
+        # :nocov:
+        TERMINAL_WIDTH = IO.console&.winsize&.at(1) || 80
+        # :nocov:
+
+        # Extra padding between columns
+        #
         GAP = 4
 
+        # Adjust the underlying command padding to account for non-printing characters
+        #
+        # Bold and gray each add 14:
+        #   '-'.bold.length == 15
+        #   '-'.gray.length == 15
+        #
+        ESCAPE_PADDING = 14
+
         def banner_header(version)
           <<~BANNER
             #{version.bold.blue}
@@ -19,6 +34,12 @@ module Usps
         end
 
         def banner_contents
+          wiki = word_wrap(
+            'For an explanation of how to provide API configuration, ' \
+            'more details on the options, and usage examples, please refer to the wiki:',
+            TERMINAL_WIDTH - indent(1).length
+          ).join("\n#{indent(1)}")
+
           <<~BANNER
             #{'Usage'.underline}
 
@@ -27,8 +48,7 @@ module Usps
 
             #{'Further Help'.underline}
 
-              For an explanation of how to provide API configuration, more details on the options,
-              and usage examples, please refer to the wiki:
+              #{wiki}
 
               https://github.com/unitedstatespowersquadrons/imis-api-ruby/wiki/Command-Line
 
@@ -64,29 +84,21 @@ module Usps
       private
 
         def help_commands(lines)
-          # Adjust the underlying command padding to account for non-printing characters
-          #
-          # Bold and gray each add 14:
-          #   '-'.bold.length == 15
-          #   '-'.gray.length == 15
-          #
-          escape_padding = 14
-
-          command_lengths = subcommands.map { |name, details| name.length + details[:value].to_s.length }
-          command_width = command_lengths.max + GAP + escape_padding
-
           lines << "#{'Commands'.underline}\n"
           subcommands.each do |name, details|
             combined_name = details[:value] ? "#{name.bold} #{"<#{details[:value]}>".gray}" : name.bold
-            lines << [
-              indent(1),
-              combined_name.ljust(command_width + (details[:value] ? escape_padding : 0)),
-              details[:description]
-            ].join
+            command = combined_name.ljust(command_width + (details[:value] ? ESCAPE_PADDING : 0))
+            left_width = indent(1).length + command_width
+            lines << "#{indent(1)}#{command}#{wrap_description(details[:description], left_width)}"
           end
           lines << "\n"
         end
 
+        def command_width
+          command_lengths = subcommands.map { |name, details| name.length + details[:value].to_s.length }
+          command_lengths.max + GAP + ESCAPE_PADDING
+        end
+
         def help_options(lines)
           lines << "#{'Options'.underline}\n"
           option_groups.each do |group_name, option_keys|
@@ -98,9 +110,16 @@ module Usps
 
         def help_legacy_flags(lines)
           lines << "#{indent(1)}#{'Legacy Flags'.underline}\n"
-          lines << "#{indent(2)}The following options are still supported, but have been replaced by subcommands:\n"
+          explanation = word_wrap(
+            'The following options are still supported, but have been replaced by subcommands:',
+            TERMINAL_WIDTH - indent(2).length
+          ).join("\n#{indent(2)}")
+          lines << "#{indent(2)}#{explanation}\n"
+
           legacy_flags.each do |flags, replacement|
-            lines << "#{indent(2)}#{flags.ljust(option_column_width)}use:  #{replacement}"
+            left_width = indent(2).length + option_column_width
+            description = wrap_description("use:  #{replacement}", left_width)
+            lines << "#{indent(2)}#{flags.ljust(option_column_width)}#{description}"
           end
           lines << "\n"
         end

data/lib/usps/imis/command_line/{options.yml.erb → options.yml}

@@ -27,10 +27,10 @@ Subcommands:
       - Interact with mapped fields
       - short: M
   map:
-    description: "Shorthand for `<%= 'mapper -f'.green %>` to access a single mapped field"
+    description: Shorthand for `%{green:mapper -f}` to access a single mapped field
     value: field
     option:
-      - "Shorthand for <%= '-Mf'.green %> to access a single mapped field"
+      - Shorthand for %{green:-Mf} to access a single mapped field
       - type: string
         short: m
   business-objects:
@@ -65,13 +65,13 @@ Options:
 
   Business Object or Panel:
     create:
-      - "Send a <%= 'POST'.cyan %> request"
+      - Send a %{cyan:POST} request
       - short: C
     delete:
-      - "Send a <%= 'DELETE'.cyan %> request"
+      - Send a %{cyan:DELETE} request
       - short: D
     all:
-      - "Send a <%= 'GET'.cyan %> request for all records for a member"
+      - Send a %{cyan:GET} request for all records for a member
       - short: A
 
   Panel:
@@ -106,7 +106,7 @@ Options:
       - type: strings
         short: F
     data:
-      - "JSON string input -- <%= 'STDIN'.red %> takes priority"
+      - JSON string input -- %{red:STDIN} takes priority
       - type: string
         short: d
 
@@ -126,21 +126,20 @@ Options:
 
   Configuration:
     config:
-      - "Path to the JSON/YAML config file to use, or one of the following preset options:\
-        \n`<%= 'local_dot'.yellow %>`, \
-        `<%= 'local'.yellow %>`, \
-        `<%= 'local_dot_config'.yellow %>`, \
-        `<%= 'local_config'.yellow %>`, \
-        `<%= 'user'.yellow %>`, \
-        `<%= 'system'.yellow %>`\
-        \nIf no option is provided, the first matching preset option will be automatically used."
+      - >-
+        Path to the JSON/YAML config file to use, or one of the following preset options:
+
+        `%{yellow:local_dot}`, `%{yellow:local}`, `%{yellow:local_dot_config}`,
+        `%{yellow:local_config}`, `%{yellow:user}`, `%{yellow:system}`
+
+        If no option is provided, the first matching preset option will be automatically used.
       - type: string
         short: Y
     show_config:
       - Return the active config file path
       - short: X
     include_ids:
-      - "Include any <%= 'iMIS ID'.yellow %> and <%= 'Ordinal'.yellow %> properties in returned data"
+      - Include any %{yellow:iMIS ID} and %{yellow:Ordinal} properties in returned data
       - short: N
     token:
       - Provide an existing auth token
@@ -149,10 +148,10 @@ Options:
 
   Logging:
     quiet:
-      - "Suppress logging to <%= 'STDERR'.red %>"
+      - Suppress logging to %{red:STDERR}
       - short: q
     log:
-      - "Redirect logging to <%= 'STDOUT'.red %>"
+      - Redirect logging to %{red:STDOUT}
       - short: l
     log_level:
       - Set the logging level

data/lib/usps/imis/command_line/options_parser_config.rb

@@ -8,8 +8,15 @@ module Usps
       # @private
       #
       module OptionsParserConfig
+        STYLE_NAMES = (String.colors + String.modes).map(&:to_s).freeze
+        STYLE_PATTERN = /%\{(#{Regexp.union(STYLE_NAMES)}(?:\.#{Regexp.union(STYLE_NAMES)})*):(.*?)\}/
+
         def subcommands
-          @subcommands ||= yaml['Subcommands'].transform_values { it.transform_keys(&:to_sym) }
+          @subcommands ||= yaml['Subcommands'].transform_values do |details|
+            details.transform_keys(&:to_sym).tap do |h|
+              h[:description] = colorize_text(h[:description]) if h[:description]
+            end
+          end
         end
 
         def option_groups
@@ -19,7 +26,7 @@ module Usps
         def options
           @options ||= merged_options.transform_keys(&:to_sym).transform_values do |description, details|
             [
-              description,
+              colorize_text(description),
               details.transform_keys(&:to_sym).each_with_object({}) do |(key, value), hash|
                 hash[key] = %i[type short].include?(key) ? value.to_sym : value
               end
@@ -51,11 +58,18 @@ module Usps
       private
 
         def yaml
-          return @yaml if @yaml
+          @yaml ||= YAML.safe_load_file("#{File.dirname(__FILE__)}/options.yml")
+        end
 
-          raw_yaml_erb = File.read("#{File.dirname(__FILE__)}/options.yml.erb")
-          rendered_yaml = ERB.new(raw_yaml_erb).result.gsub("\x1b", '\u001b')
-          @yaml = YAML.safe_load(rendered_yaml)
+        def colorize_text(text)
+          text.gsub(STYLE_PATTERN) { Regexp.last_match(2).colorize(style_args(Regexp.last_match(1))) }
+        end
+
+        def style_args(styles)
+          styles.split('.').each_with_object({}) do |name, args|
+            key = String.colors.include?(name.to_sym) ? :color : :mode
+            args[key] = name.to_sym
+          end
         end
 
         def merged_options

data/lib/usps/imis/command_line.rb

@@ -2,8 +2,8 @@
 
 require 'optimist'
 require 'colorize'
-require 'erb'
 require 'csv'
+require 'io/console'
 
 module Usps
   module Imis

data/lib/usps/imis/version.rb

@@ -2,6 +2,6 @@
 
 module Usps
   module Imis
-    VERSION = '0.13.4'
+    VERSION = '0.13.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: usps-imis-api
 version: !ruby/object:Gem::Version
-  version: 0.13.4
+  version: 0.13.5
 platform: ruby
 authors:
 - Julian Fiander
@@ -97,7 +97,7 @@ files:
 - lib/usps/imis/command_line/formatters.rb
 - lib/usps/imis/command_line/help.rb
 - lib/usps/imis/command_line/interface.rb
-- lib/usps/imis/command_line/options.yml.erb
+- lib/usps/imis/command_line/options.yml
 - lib/usps/imis/command_line/options_parser.rb
 - lib/usps/imis/command_line/options_parser_config.rb
 - lib/usps/imis/command_line/performers.rb