command_line_reporter 4.0.3 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45033e15c64d70a42cbce28626c93f8764c8aee33f0ea937473070e3c105f009
-  data.tar.gz: 5fd552cd966085a4c25ecb67f56eed0bc45697870ecc3409e33649420d0747d2
+  metadata.gz: cafca0188c1a52d2b617fed16ad2d87614871c868b520c9a59aad259d5470bc5
+  data.tar.gz: 15ac742903e4e3e1f1ebf4259603a761ce8414bdbb35c223113b38891b3a4d5f
 SHA512:
-  metadata.gz: 6b94f007a1e78924166cebeb8753c3dcd077a261f9fe8a8b3df4c72f355f1d7cf93aa3d39e5dbce0d904080e603e7688bd9fc761ccf098f2b01964e239125c94
-  data.tar.gz: ce5c1e38a91e4649a3d5ec8ec31dbbc0bbeb9136a371ef021dd4ad49bf301e72bdd9148f6de15b6e5d2fcf3694805acc46e19efec53baa1058173e9c98d6e218
+  metadata.gz: 790b13f4b33f7db239e785b28e96dfdd99357c0d1adfebdbf031ed865ce497373cbb4733d721f217d4c93f502b4427a8f354bfb00c120cb5b00c5ffa04d0bb8d
+  data.tar.gz: cdf0cc92fe84f449df6e8244f713f72afe242c6754b47f4bf61ccf95a86da4e9b14e2d4b1c290fe78625fe20e283fe790e939c08507e3b1511a9efa3d456f741

data/lib/command_line_reporter/column.rb

@@ -1,11 +1,11 @@
-require 'colored'
+require 'colorize'
 
 module CommandLineReporter
   class Column
     include OptionsValidator
 
     VALID_OPTIONS = %i[width padding align color bold underline reversed span wrap].freeze
-    attr_accessor :text, :size, *VALID_OPTIONS
+    attr_accessor :text, *VALID_OPTIONS
 
     def initialize(text = nil, options = {})
       validate_options(options, *VALID_OPTIONS)
@@ -14,8 +14,8 @@ module CommandLineReporter
 
       self.text = text.to_s
 
-      self.wrap = (options.fetch(:wrap, :character).to_s)
-      raise(ArgumentError, ":wrap must be word or character (got #{options[:wrap].inspect})") unless %w(word character).include?(self.wrap)
+      self.wrap = options.fetch(:wrap, :character).to_s
+      raise(ArgumentError, ":wrap must be word or character (got #{options[:wrap].inspect})") unless %w[word character].include?(wrap)
     end
 
     def size
@@ -23,7 +23,7 @@ module CommandLineReporter
     end
 
     def required_width
-      text.to_s.size + 2 * padding
+      text.to_s.size + (2 * padding)
     end
 
     def screen_rows
@@ -36,10 +36,11 @@ module CommandLineReporter
 
     private
 
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def reformat_wrapped(text)
       lines = []
       text.lines.each do |line|
-        line_words = (wrap == 'word') ? line.split(/\s+/) : [line]
+        line_words = wrap == 'word' ? line.split(/\s+/) : [line]
         line_words.each do |word|
           current_line = lines.last
           if current_line.nil? || current_line.size + word.size >= size
@@ -55,7 +56,9 @@ module CommandLineReporter
       end
       lines[0..-2]
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
+    # rubocop:disable Metrics/AbcSize
     def assign_alignment_defaults(options)
       self.span = options[:span] || 1
 
@@ -68,6 +71,7 @@ module CommandLineReporter
       self.padding = options[:padding] || 0
       self.padding = Integer(padding)
     end
+    # rubocop:enable Metrics/AbcSize
 
     def assign_color_defaults(options)
       self.color = options[:color] || nil
@@ -80,7 +84,7 @@ module CommandLineReporter
       # NOTE: For making underline and reversed work Change so that based on the
       # unformatted text it determines how much spacing to add left and right
       # then colorize the cell text
-      cell =  str.empty? ? blank_cell : aligned_cell(str)
+      cell = str.empty? ? blank_cell : aligned_cell(str)
       padding_str = ' ' * padding
       padding_str + colorize(cell) + padding_str
     end
@@ -96,7 +100,7 @@ module CommandLineReporter
       when 'right'
         str.rjust(size)
       when 'center'
-        str.ljust((size - str.size) / 2.0 + str.size).rjust(size)
+        str.ljust(((size - str.size) / 2.0) + str.size).rjust(size)
       end
     end
 

data/lib/command_line_reporter/formatter/nested.rb

@@ -1,5 +1,5 @@
 require 'singleton'
-require 'colored'
+require 'colorize'
 
 module CommandLineReporter
   class NestedFormatter
@@ -7,8 +7,10 @@ module CommandLineReporter
     include OptionsValidator
 
     VALID_OPTIONS = %i[message type complete indent_size color bold].freeze
-    attr_accessor :indent_size, :complete_string, :message_string, :color, :bold
+    attr_accessor :color, :bold
+    attr_writer :indent_size, :complete_string, :message_string
 
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def format(options, block)
       validate_options(options, *VALID_OPTIONS)
 
@@ -32,6 +34,7 @@ module CommandLineReporter
 
       indent_level :decr
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def message_string
       @message_string ||= 'working'

data/lib/command_line_reporter/formatter/progress.rb

@@ -1,5 +1,5 @@
 require 'singleton'
-require 'colored'
+require 'colorize'
 
 module CommandLineReporter
   class ProgressFormatter
@@ -7,7 +7,7 @@ module CommandLineReporter
     include OptionsValidator
 
     VALID_OPTIONS = %i[indicator color bold].freeze
-    attr_accessor *VALID_OPTIONS
+    attr_accessor(*VALID_OPTIONS)
 
     def format(options, block)
       validate_options(options, *VALID_OPTIONS)

data/lib/command_line_reporter/row.rb

@@ -22,6 +22,7 @@ module CommandLineReporter
       columns << column
     end
 
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def output
       screen_count.times do |sr|
         border_char = use_utf8? ? "\u2503" : '|'
@@ -50,7 +51,7 @@ module CommandLineReporter
           # | xxxxxxxxxxx |            | (4)
           # +-------------+------------+
           if col.screen_rows[sr].nil?
-            line << ' ' * col.width << ' '
+            line << (' ' * col.width) << ' '
           else
             line << columns[mc].screen_rows[sr] << ' '
           end
@@ -64,11 +65,12 @@ module CommandLineReporter
         puts line
       end
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     private
 
     def screen_count
-      @sc ||= columns.inject(0) { |a, e| e.screen_rows.size > a ? e.screen_rows.size : a }
+      @screen_count ||= columns.map { |column| column.screen_rows.size }.max.to_i
     end
 
     def use_utf8?

data/lib/command_line_reporter/table.rb

@@ -29,9 +29,9 @@ module CommandLineReporter
 
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity
-    # rubocop:disable Metrics/MethodLength
     def output
       return if rows.empty? # we got here with nothing to print to the screen
+
       auto_adjust_widths if width == :auto
 
       puts separator('first') if border
@@ -43,23 +43,28 @@ module CommandLineReporter
 
       puts separator('last') if border
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity
 
     # TODO: This doesn't appear to be used and if it is, it will not handle span appropriately
+    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def auto_adjust_widths
       column_widths = []
 
       rows.each do |row|
         row.columns.each_with_index do |col, i|
-          column_widths[i] = [col.required_width, (column_widths[i] || 0)].max
+          column_widths[i] = [col.required_width, column_widths[i] || 0].max
         end
       end
 
+      # rubocop:disable Style/CombinableLoops
       rows.each do |row|
         row.columns.each_with_index do |col, i|
           col.width = column_widths[i]
         end
       end
+      # rubocop:enable Style/CombinableLoops
     end
+    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     private
 
@@ -82,34 +87,32 @@ module CommandLineReporter
     def utf8_separator(type)
       bar = "\u2501"
 
-      left, center, right = case type
-                            when 'first'
-                              ["\u250F", "\u2533", "\u2513"]
-                            when 'middle'
-                              ["\u2523", "\u254A", "\u252B"]
-                            when 'last'
-                              ["\u2517", "\u253B", "\u251B"]
-                            end
+      parts = {
+        'first' => ["\u250F", "\u2533", "\u2513"],
+        'middle' => ["\u2523", "\u254A", "\u252B"],
+        'last' => ["\u2517", "\u253B", "\u251B"]
+      }
+      left, center, right = parts.fetch(type)
 
       [left, center, right, bar]
     end
 
     def inherit_column_attrs(row)
-      row.columns.each_with_index do |c, i|
-        use_positional_attrs(c, i)
-        use_color(row, c, i)
-        use_bold(row, c, i)
+      row.columns.each_with_index do |column, index|
+        use_positional_attrs(column, index)
+        use_color(row, column, index)
+        use_bold(row, column, index)
       end
     end
 
-    def use_positional_attrs(c, i)
-      return if c.span > 1
+    def use_positional_attrs(column, index)
+      return if column.span > 1
 
       # The positional attributes are always required to inherit to make sure the table
       # displays properly
       %w[align padding width].each do |attr|
-        val = rows[0].columns[i].send(attr)
-        c.send(attr + '=', val)
+        val = rows[0].columns[index].send(attr)
+        column.public_send("#{attr}=", val)
       end
 
       # spanning columns overrides inheritance for width
@@ -121,21 +124,21 @@ module CommandLineReporter
       rows[0].header ? 1 : 0
     end
 
-    def use_color(row, c, i)
-      if c.color
+    def use_color(row, column, index)
+      if column.color
         # keep default
       elsif row.color
-        c.color = row.color
+        column.color = row.color
       elsif inherit_from != 1
-        c.color = rows[inherit_from].columns[i].color
+        column.color = rows[inherit_from].columns[index].color
       end
     end
 
-    def use_bold(row, c, i)
+    def use_bold(row, column, index)
       if row.bold
-        c.bold = row.bold
+        column.bold = row.bold
       elsif inherit_from != 1
-        c.bold = rows[inherit_from].columns[i].bold
+        column.bold = rows[inherit_from].columns[index].bold
       end
     end
   end

data/lib/command_line_reporter/version.rb

@@ -1,3 +1,3 @@
 module CommandLineReporter
-  VERSION = '4.0.3'.freeze
+  VERSION = '5.0.0'.freeze
 end

data/lib/command_line_reporter.rb

@@ -37,13 +37,17 @@ module CommandLineReporter
   end
 
   def formatter=(type = 'nested')
-    return type if type.class != String
-    name = type.capitalize + 'Formatter'
+    unless type.is_a?(String)
+      @formatter = type
+      return
+    end
+
+    name = "#{type.capitalize}Formatter"
     klass = %W[CommandLineReporter #{name}].inject(Kernel) { |a, e| a.const_get(e) }
 
     # Each formatter is a singleton that responds to #instance
     @formatter = klass.instance
-  rescue
+  rescue StandardError
     raise ArgumentError, 'Invalid formatter specified'
   end
 
@@ -103,7 +107,7 @@ module CommandLineReporter
     options[:width] = default_options_width(options[:width])
     options[:bold] = default_options_bold(options[:bold])
 
-    raise Exception if text.size > options[:width]
+    raise ArgumentError, 'Text is wider than the available width' if text.size > options[:width]
 
     line = align_line(text, options)
 
@@ -137,7 +141,7 @@ module CommandLineReporter
     when 'right'
       text.rjust(options[:width])
     when 'center'
-      text.rjust((options[:width] - text.size) / 2 + text.size)
+      text.rjust(((options[:width] - text.size) / 2) + text.size)
     end
   end
 
@@ -170,6 +174,7 @@ module CommandLineReporter
 
   def print_header(type, options)
     return unless type == :header
+
     vertical_spacing(options[:lines])
     horizontal_rule(char: options[:rule], width: options[:width], color: options[:color], bold: options[:bold]) if options[:rule]
   end
@@ -181,6 +186,7 @@ module CommandLineReporter
 
   def print_footer(type, options)
     return unless type == :footer
+
     horizontal_rule(char: options[:rule], width: options[:width], color: options[:color], bold: options[:bold]) if options[:rule]
     vertical_spacing(options[:lines])
   end
@@ -225,3 +231,4 @@ module CommandLineReporter
     raise ArgumentError unless %i[left center right].include?(align.to_sym)
   end
 end
+# rubocop:enable Metrics/ModuleLength

metadata

@@ -1,44 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: command_line_reporter
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 5.0.0
 platform: ruby
 authors:
 - Wes
 - Bailey
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: colored
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.1'
 description: This gem makes it easy to provide a report while your ruby script is
   executing
 email: baywes@gmail.com
@@ -56,20 +41,11 @@ files:
 - lib/command_line_reporter/row.rb
 - lib/command_line_reporter/table.rb
 - lib/command_line_reporter/version.rb
-- spec/column_spec.rb
-- spec/command_line_reporter_spec.rb
-- spec/nested_formatter_spec.rb
-- spec/options_validator_spec.rb
-- spec/progress_formatter_spec.rb
-- spec/row_spec.rb
-- spec/spec_helper.rb
-- spec/support/helpers/stdout.rb
-- spec/support/matchers/argument.rb
-- spec/table_spec.rb
-homepage: http://github.com/wbailey/command_line_reporter
-licenses: []
-metadata: {}
-post_install_message:
+homepage: https://github.com/wbailey/command_line_reporter
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -77,25 +53,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A tool for providing interactive command line applications
-test_files:
-- spec/column_spec.rb
-- spec/command_line_reporter_spec.rb
-- spec/nested_formatter_spec.rb
-- spec/options_validator_spec.rb
-- spec/progress_formatter_spec.rb
-- spec/row_spec.rb
-- spec/spec_helper.rb
-- spec/support/helpers/stdout.rb
-- spec/support/matchers/argument.rb
-- spec/table_spec.rb
+test_files: []