formatador 1.1.0 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7691580892da9215dfc4bbe6523203fef95cd0c57a25652af464d208e1a7a64
-  data.tar.gz: 8e99624363cc7a8b76d2cc699664618d184ffdffe16ca4d4b3ce73927aa3e5d0
+  metadata.gz: 5fe34f9dc5c0f7ecda25c5d1a6b486befaed871f0ea3b2d1b2811e82b3c1656b
+  data.tar.gz: 1e2580cb52975afa3a63f34e86a46b4e7c48b4d501cc0b126f21b0d60133fdc9
 SHA512:
-  metadata.gz: 240f470bb912d51efd07d5916ba31ca06694db82058146ad1d5403959966bc8c4c7c409b5d53958ac6232a87d46ff299e9640a7b5b4333bbff527fdf0055f604
-  data.tar.gz: 10800e56b00b910904da64dc8a8b64d01e717ffcc91ec19d4ac4e3c4e94ce903921722707ca16cc675c082bff888e170b1324da5426f7f8e7c1668de64448b37
+  metadata.gz: 37e1cef3d87ee2c5b90f781f526eea22444de15db0f8fa827eeffc790aaae3f5b935314013ebaab9bbd49f605c7057633683e6f606f503f0c978355260a29ca4
+  data.tar.gz: 24566111d7be71a3cbb6cb834f0fe439d34df11fc9e78aca14540ad54e903eabf4691c76d56ae21dab213b836e9cc4b7ad5221ca3aebe938a0a664c8558568bf

data/SECURITY.md

@@ -0,0 +1,6 @@
+## Security contact information
+
+To report a security vulnerability, please contact
+[Tidelift security](https://tidelift.com/security).
+
+Tidelift will coordinate the fix and disclosure.

data/changelog.txt

@@ -1,3 +1,46 @@
+v1.2.3 11/10/25
+===============
+
+add set_title to set terminal title via escape sequences
+
+v1.2.2 10/28/25
+===============
+
+add faint
+
+v1.2.1 09/17/25
+===============
+
+add color output support for github actions
+fix most lints
+
+v1.2.0 08/08/25
+===============
+
+switch to reline for table-width calculations
+
+v1.1.1 07/11/25
+===============
+
+update actions/stale
+update actions/checkout
+improve unicode support
+update ruby versions in test matrix
+add funding info
+move scheduled CI to weekly
+update tested ruby versions
+more consistently use length method in tables
+adjust expected test output for Ruby 3.4+
+
+v1.1.0 01/24/22
+===============
+
+fixes to support ruby 3+
+add options for right justifying numerics
+drop unused gemspec directive
+use https for rubygems.org in gemspec
+drop duplicate bundle install from CI setup
+
 v1.0.0 01/20/21
 ===============
 

data/formatador.gemspec

@@ -7,14 +7,14 @@
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.rubygems_version = '1.3.5'
+  s.rubygems_version = '3.6.9'
 
   ## Leave these as is they will be modified for you by the rake gemspec task.
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'formatador'
-  s.version           = '1.1.0'
-  s.date              = '2022-01-24'
+  s.version           = '1.2.3'
+  s.date              = '2025-11-10'
 
   ## Make sure your summary is short. The description may be as long
   ## as you like.
@@ -49,6 +49,7 @@ Gem::Specification.new do |s|
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
   # s.add_dependency('DEPNAME', [">= 1.1.0", "< 2.0.0"])
+  s.add_dependency('reline')
 
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
@@ -67,6 +68,7 @@ Gem::Specification.new do |s|
     LICENSE.md
     README.md
     Rakefile
+    SECURITY.md
     changelog.txt
     formatador.gemspec
     lib/formatador.rb

data/lib/formatador/table.rb

@@ -14,7 +14,7 @@ class Formatador
     # Calculate Widths
     if hashes.empty? && keys
       keys.each do |key|
-        widths[key] = key.to_s.length
+        widths[key] = length(key)
       end
     else
       hashes.each do |hash|
@@ -24,7 +24,7 @@ class Formatador
           if !keys
             headers << key
           end
-          widths[key] = [ length(key), widths[key] || 0, length(calculate_datum(key, hash)) || 0].max
+          widths[key] = [length(key), widths[key] || 0, length(calculate_datum(key, hash)) || 0].max
         end
         headers = headers.uniq
       end
@@ -52,7 +52,7 @@ class Formatador
     # Display data row
     columns = []
     headers.each do |header|
-      columns << "[bold]#{header}[/]#{' ' * (widths[header] - header.to_s.length)}"
+      columns << "[bold]#{header}[/]#{' ' * (widths[header] - length(header))}"
     end
     display_line("| #{columns.join(' | ')} |")
     display_line(split)
@@ -70,7 +70,7 @@ class Formatador
       else
         if hash == :split
           display_line(split)
-        end 
+        end
       end
       nil
     end
@@ -80,11 +80,7 @@ class Formatador
   private
 
   def length(value)
-    if Module.const_defined?(:Unicode)
-      Unicode.width(value.to_s.gsub(PARSE_REGEX, ''))
-    else
-      value.to_s.gsub(PARSE_REGEX, '').chars.reduce(0) { |sum, char| sum += char.bytesize > 1 ? 2 : 1 }
-    end
+    Reline::Unicode.calculate_width(value.to_s.gsub(PARSE_REGEX, ''))
 
   rescue NotImplementedError
     value.to_s.gsub(PARSE_REGEX, '').chars.reduce(0) { |sum, char| sum += char.bytesize > 1 ? 2 : 1 }

data/lib/formatador.rb

@@ -1,60 +1,64 @@
+# frozen_string_literal: true
+
 require File.join(File.dirname(__FILE__), 'formatador', 'table')
 require File.join(File.dirname(__FILE__), 'formatador', 'progressbar')
 
-class Formatador
+require 'reline' # for table char width calculations
 
-  VERSION = '1.1.0'
+class Formatador
+  VERSION = '1.2.3'
 
   STYLES = {
-    :"\/"             => "0",
-    :reset            => "0",
-    :bold             => "1",
-    :underline        => "4",
-    :blink_slow       => "5",
-    :blink_fast       => "6",
-    :negative         => "7", # invert color/color
-    :normal           => "22",
-    :underline_none   => "24",
-    :blink_off        => "25",
-    :positive         => "27", # revert color/color
-    :_black_          => "40",
-    :_red_            => "41",
-    :_green_          => "42",
-    :_yellow_         => "43",
-    :_blue_           => "44",
-    :_magenta_        => "45",
-    :_purple_         => "45",
-    :_cyan_           => "46",
-    :_white_          => "47",
-    :_light_black_    => "100",
-    :_light_red_      => "101",
-    :_light_green_    => "102",
-    :_light_yellow_   => "103",
-    :_light_blue_     => "104",
-    :_light_magenta_  => "105",
-    :_light_purple_   => "105",
-    :_light_cyan_     => "106",
-    :black            => "30",
-    :red              => "31",
-    :green            => "32",
-    :yellow           => "33",
-    :blue             => "34",
-    :magenta          => "35",
-    :purple           => "35",
-    :cyan             => "36",
-    :white            => "37",
-    :light_black      => "90",
-    :light_red        => "91",
-    :light_green      => "92",
-    :light_yellow     => "93",
-    :light_blue       => "94",
-    :light_magenta    => "95",
-    :light_purple     => "95",
-    :light_cyan       => "96",
-  }
-
-  PARSE_REGEX  = /\[(#{ STYLES.keys.join('|') })\]/ix
-  INDENT_REGEX = /\[indent\]/ix
+    "\/": '0',
+    reset: '0',
+    bold: '1',
+    faint: '2',
+    underline: '4',
+    blink_slow: '5',
+    blink_fast: '6',
+    negative: '7', # invert color/color
+    normal: '22',
+    underline_none: '24',
+    blink_off: '25',
+    positive: '27', # revert color/color
+    _black_: '40',
+    _red_: '41',
+    _green_: '42',
+    _yellow_: '43',
+    _blue_: '44',
+    _magenta_: '45',
+    _purple_: '45',
+    _cyan_: '46',
+    _white_: '47',
+    _light_black_: '100',
+    _light_red_: '101',
+    _light_green_: '102',
+    _light_yellow_: '103',
+    _light_blue_: '104',
+    _light_magenta_: '105',
+    _light_purple_: '105',
+    _light_cyan_: '106',
+    black: '30',
+    red: '31',
+    green: '32',
+    yellow: '33',
+    blue: '34',
+    magenta: '35',
+    purple: '35',
+    cyan: '36',
+    white: '37',
+    light_black: '90',
+    light_red: '91',
+    light_green: '92',
+    light_yellow: '93',
+    light_blue: '94',
+    light_magenta: '95',
+    light_purple: '95',
+    light_cyan: '96'
+  }.freeze
+
+  PARSE_REGEX  = /\[(#{STYLES.keys.join('|')})\]/ix.freeze
+  INDENT_REGEX = /\[indent\]/ix.freeze
 
   def initialize
     @indent = 1
@@ -73,21 +77,21 @@ class Formatador
   end
 
   def display_lines(lines = [])
-    for line in [*lines]
+    [*lines].each do |line|
       display_line(line)
     end
     nil
   end
 
   def parse(string)
-    if $stdout.tty?
-      string.gsub(PARSE_REGEX) { "\e[#{STYLES[$1.to_sym]}m" }.gsub(INDENT_REGEX) { indentation }
+    if color_support
+      string.gsub(PARSE_REGEX) { "\e[#{STYLES[::Regexp.last_match(1).to_sym]}m" }.gsub(INDENT_REGEX) { indentation }
     else
       strip(string)
     end
   end
 
-  def indent(&block)
+  def indent
     @indent += 1
     yield
   ensure
@@ -100,7 +104,7 @@ class Formatador
 
   def redisplay(string = '', width = 120)
     print("\r#{' ' * width}\r")
-    display("#{string}")
+    display(string.to_s)
     nil
   end
 
@@ -115,11 +119,17 @@ class Formatador
     nil
   end
 
+  def set_title(title)
+    print("\033]0;#{title}\007")
+    $stdout.flush
+    nil
+  end
+
   def strip(string)
     string.gsub(PARSE_REGEX, '').gsub(INDENT_REGEX) { indentation }
   end
 
-  %w{display display_line display_lines indent parse redisplay redisplay_line new_line redisplay_progressbar}.each do |method|
+  %w[display display_line display_lines indent parse redisplay redisplay_line new_line redisplay_progressbar set_title].each do |method|
     eval <<-DEF
       def self.#{method}(*args, &block)
         Thread.current[:formatador] ||= new
@@ -128,7 +138,7 @@ class Formatador
     DEF
   end
 
-  %w{display_table display_compact_table}.each do |method|
+  %w[display_table display_compact_table].each do |method|
     eval <<-DEF
       def self.#{method}(*args, **kwargs, &block)
         Thread.current[:formatador] ||= new
@@ -137,4 +147,9 @@ class Formatador
     DEF
   end
 
+  private
+
+  def color_support
+    @color_support ||= $stdout.tty? || ENV['GITHUB_ACTIONS'] == 'true'
+  end
 end

data/tests/table_tests.rb

@@ -64,6 +64,16 @@ output = Formatador.parse(output)
     end
   end
 
+
+if (RUBY_VERSION.split('.').map(&:to_i) <=> [3, 4, 0]).positive?
+output = <<-OUTPUT
+    +---+----------------+
+    | [bold]a[/] | [bold]nested[/]         |
+    +---+----------------+
+    | 1 | {key: "value"} |
+    +---+----------------+
+OUTPUT
+else
 output = <<-OUTPUT
     +---+-----------------+
     | [bold]a[/] | [bold]nested[/]          |
@@ -71,6 +81,7 @@ output = <<-OUTPUT
     | 1 | {:key=>"value"} |
     +---+-----------------+
 OUTPUT
+end
 output = Formatador.parse(output)
 
   tests("#display_table([{:a => 1, :nested => {:key => 'value'}}])").returns(output) do
@@ -142,4 +153,22 @@ OUTPUT
     end
   end
 
+output = <<-OUTPUT
+    +----+
+    | [bold]a[/]  |
+    +----+
+    | 1  |
+    +----+
+    | 🤷 |
+    +----+
+OUTPUT
+  output = Formatador.parse(output)
+
+  tests("#display_table([{:a => 1}, {:a => '🤷'}])").returns(output) do
+    capture_stdout do
+      Formatador.display_table([{:a => 1}, {:a => '🤷'}])
+    end
+  end
+
+
 end

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: formatador
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.3
 platform: ruby
 authors:
 - geemus (Wesley Beary)
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2025-11-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: reline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +78,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- SECURITY.md
 - changelog.txt
 - formatador.gemspec
 - lib/formatador.rb
@@ -77,7 +91,6 @@ homepage: https://github.com/geemus/formatador
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -93,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 2
 summary: Ruby STDOUT text formatting
 test_files: []