table_tennis 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b141b15004b90e5acaf6f4ed92d7f71a49fbb8376875fd50cf5ed1d8e555c365
-  data.tar.gz: f9dd1e36fa97767addcce2abbfca0eb721137d6c87f0556f0ed79ca8677fa15c
+  metadata.gz: 85ab2cbb42c928e7231529feaa15416f752b3efa3ca13d0ba54331b79cb41cc0
+  data.tar.gz: bbd1d0477437ab63c0302a8796ca058eb94a5084595a190032695188680214ef
 SHA512:
-  metadata.gz: eba4146e9b2953bef53d958b7d3bab8d65f25be9c0011309cc511f3ecc254385dc3193f9f84c12c6d768010a9d7b4ae35d49530c6a2756906eb50aeb756d72db
-  data.tar.gz: f7d7262f3afb54a563a73d5e7279052e6dd2f4fb39a4e916994ee35f966b1f36ff7a45e22eb18619db43fe6cc516f0f34a714bb17614fcd03d1562a20fcd0ede
+  metadata.gz: 7729436cacaa34103047f9d039e1a81626ad8b9f86b33062e3e8ab58067aa69bc56242d19e7861ec44284c6e277b3daf32966129c0d41da7b389dce591371ee0
+  data.tar.gz: 97165044e352b52af3b31870b1999624a4a3b3f6dd8624cd69a9935d594461a1842568973fb8a101438d4a26b6ddc2df754ff6b88fcc5f61a982894fb33c329c

data/.github/workflows/test.yml

@@ -16,7 +16,7 @@ jobs:
         ruby-version: [3.0, 3.4]
     runs-on: ${{ matrix.os }}-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: taiki-e/install-action@just
       - uses: ruby/setup-ruby@v1
         with:

data/README.md

@@ -69,32 +69,32 @@ options = {
 
 #### Popular Options
 
-| option | default | details |
-| ------ | ------- | ------- |
-| `color_scales` | ─ | Color code a column of floats, similar to the "conditional formatting" feature in Google Sheets. See [docs below](#color-scales). |
-| `columns` | ─ | Manually set which columns to include. Leave unset to show all columns.
-| `headers` | ─ | Specify some or all column headers. For example, `{user_id: "Customer"}`. When unset, headers are inferred. |
-| `mark` | ─ | `mark` is a way to highlight specific columns with a nice color. For example, use `mark: ->(row) { row[:planet] == "tatooine" }` to highlight those rows. Your lambda can also return a specific bg color or Paint color array.
-| `row_numbers` | `false` | Show row numbers in the table. |
-| `search` | ─ | String/regex to highlight in output. |
-| `separators` | `true` | Include column and header separators in output. |
-| `title` | ─ | Add a title line to the table. |
-| `titleize` | ─ | Titleize column headers, so `person_id` becomes `Person`. |
-| `zebra` | `false` | Turn on zebra stripes. |
+| option         | default | details                                                                                                                                                                                                                         |
+| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `color_scales` | ─       | Color code a column of floats, similar to the "conditional formatting" feature in Google Sheets. See [docs below](#color-scales).                                                                                               |
+| `columns`      | ─       | Manually set which columns to include. Leave unset to show all columns.                                                                                                                                                         |
+| `headers`      | ─       | Specify some or all column headers. For example, `{user_id: "Customer"}`. When unset, headers are inferred.                                                                                                                     |
+| `mark`         | ─       | `mark` is a way to highlight specific columns with a nice color. For example, use `mark: ->(row) { row[:planet] == "tatooine" }` to highlight those rows. Your lambda can also return a specific bg color or Paint color array. |
+| `row_numbers`  | `false` | Show row numbers in the table.                                                                                                                                                                                                  |
+| `search`       | ─       | String/regex to highlight in output.                                                                                                                                                                                            |
+| `separators`   | `true`  | Include column and header separators in output.                                                                                                                                                                                 |
+| `title`        | ─       | Add a title line to the table.                                                                                                                                                                                                  |
+| `titleize`     | ─       | Titleize column headers, so `person_id` becomes `Person`.                                                                                                                                                                       |
+| `zebra`        | `false` | Turn on zebra stripes.                                                                                                                                                                                                          |
 
 #### More Advanced Options
 
-| option | default | details |
-| ------ | ------- | ------- |
-| `coerce` | `true`  | if true, try to coerce strings into numbers where possible so we can format with `digits`. You may want to disable this if you already have nicely formatted ints/floats and you don't want TableTennis to mess with them. |
-| `color` | ─ | Are ANSI colors enabled? Specify `true` or `false`, or leave it as nil to autodetect. Autodetect will turn on color unless redirecting to a file. When using autodetect, you can force it on by setting `ENV["FORCE_COLOR"]`, or off with `ENV["NO_COLOR"]`. |
-| `delims` | `true` | Format ints & floats with comma delimiter, like 123,456. |
-| `digits` | `3` | Format floats to this number of digits. TableTennis will look for either `Float` cells or string floats. |
-| `layout` | `true` | This controls column widths. Leave unset or use `true` for autolayout. Autolayout will shrink the table to fit inside the terminal. `false` turns off layout and columns will be full width. Use an int to fix all columns to a certain width, or a hash to just set a few. |
-| `placeholder` | `"—"` | Put this into empty cells. |
-| `save` | ─ | If you set this to a file path, TableTennis will save your table as a CSV file too. Useful if you want to do something else with the data. |
-| `strftime` | see → | strftime string for formatting Date/Time objects. The default is `"%Y-%m-%d"`, which looks like `2025-04-21`  |
-| `theme` | ─ | When unset, will be autodetected based on terminal background color. If autodetect fails the theme defaults to :dark. You can also manually specify `:dark`, `:light` or `:ansi`. If colors are turned off this setting has no effect.|
+| option        | default | details                                                                                                                                                                                                                                                                     |
+| ------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `coerce`      | `true`  | if true, try to coerce strings into numbers where possible so we can format with `digits`. You may want to disable this if you already have nicely formatted ints/floats and you don't want TableTennis to mess with them.                                                  |
+| `color`       | ─       | Are ANSI colors enabled? Specify `true` or `false`, or leave it as nil to autodetect. Autodetect will turn on color unless redirecting to a file. When using autodetect, you can force it on by setting `ENV["FORCE_COLOR"]`, or off with `ENV["NO_COLOR"]`.                |
+| `delims`      | `true`  | Format ints & floats with comma delimiter, like 123,456.                                                                                                                                                                                                                    |
+| `digits`      | `3`     | Format floats to this number of digits. TableTennis will look for either `Float` cells or string floats.                                                                                                                                                                    |
+| `layout`      | `true`  | This controls column widths. Leave unset or use `true` for autolayout. Autolayout will shrink the table to fit inside the terminal. `false` turns off layout and columns will be full width. Use an int to fix all columns to a certain width, or a hash to just set a few. |
+| `placeholder` | `"—"`   | Put this into empty cells.                                                                                                                                                                                                                                                  |
+| `save`        | ─       | If you set this to a file path, TableTennis will save your table as a CSV file too. Useful if you want to do something else with the data.                                                                                                                                  |
+| `strftime`    | see →   | strftime string for formatting Date/Time objects. The default is `"%Y-%m-%d"`, which looks like `2025-04-21`                                                                                                                                                                |
+| `theme`       | ─       | When unset, will be autodetected based on terminal background color. If autodetect fails the theme defaults to :dark. You can also manually specify `:dark`, `:light` or `:ansi`. If colors are turned off this setting has no effect.                                      |
 
 ### Color Scales
 
@@ -120,8 +120,8 @@ puts TableTennis.new(rows, search: /hope.*empire/i })
 puts TableTennis.new(rows, row_numbers: true, zebra: true)
 ```
 
-| `:mark` | `:search` | `:row_numbers` and `:zebra` |
-| - | - | - |
+| `:mark`                             | `:search`                       | `:row_numbers` and `:zebra`                   |
+| ----------------------------------- | ------------------------------- | --------------------------------------------- |
 | ![droids](./screenshots/droids.png) | ![hope](./screenshots/hope.png) | ![row numbers](./screenshots/row_numbers.png) |
 
 ### Links
@@ -172,6 +172,11 @@ We love CSV tools and use them all the time! Here are a few that we rely on:
 
 ### Changelog
 
+#### 0.0.7 (Aug '25)
+
+- handle data that already contains ANSI colors (thx @ronaldtse, #12)
+- don't crash if IO.console is nil (thx @ronaldtse, #14)
+
 #### 0.0.6 (May '25)
 
 - added `coerce:` option to disable string => numeric coercion

data/justfile

@@ -24,7 +24,7 @@ gem-local:
 gem-push: check
   @if rg -g '!justfile' "\bREMIND\b" ; then just _fatal "REMIND found, bailing" ; fi
   @just _banner rake release...
-  rake release
+  bundle exec rake release
 
 # optimize images
 image_optim:

data/lib/table_tennis/config.rb

@@ -30,11 +30,10 @@ module TableTennis
 
     SCHEMA = {
       coerce: :bool,
-      color_scales: ->(value) do
-        if (error = Config.magic_validate(value, {Symbol => Symbol}))
-          error
-        elsif value.values.any? { !Util::Scale::SCALES.include?(_1) }
-          "values must be the name of a color scale"
+      color_scales: -> do
+        Config.magic_validate!(:color_scales, _1, {Symbol => Symbol})
+        if !(invalid = _1.values - Util::Scale::SCALES.keys).empty?
+          raise ArgumentError, "invalid color scale(s): #{invalid.inspect}"
         end
       end,
       color: :bool,
@@ -45,7 +44,7 @@ module TableTennis
       headers: {sym: :str},
       layout: -> do
         return if _1 == true || _1 == false || _1.is_a?(Integer)
-        Config.magic_validate(_1, {Symbol => Integer})
+        Config.magic_validate!(:layout, _1, {Symbol => Integer})
       end,
       mark: :proc,
       placeholder: :str,
@@ -53,7 +52,7 @@ module TableTennis
       save: :str,
       search: -> do
         if !(_1.is_a?(String) || _1.is_a?(Regexp))
-          "expected string/regex"
+          raise ArgumentError, "expected string/regex"
         end
       end,
       separators: :bool,
@@ -83,6 +82,7 @@ module TableTennis
       end
       self[:color_scales] = value
     end
+    alias_method :color_scale=, :color_scales=
 
     def placeholder=(value)
       value = "" if value.nil?

data/lib/table_tennis/stage/layout.rb

@@ -37,7 +37,7 @@ module TableTennis
         columns.each { _1.width = _1.measure }
 
         # How much space is available, and do we already fit?
-        screen_width = IO.console.winsize[1]
+        screen_width = Util::Console.winsize[1]
         available = screen_width - chrome_width - FUDGE
         return if available >= data_width
 

data/lib/table_tennis/stage/render.rb

@@ -50,7 +50,7 @@ module TableTennis
         title_width = data.table_width - 4
         title = Util::Strings.truncate(config.title, title_width)
         title_style = data.get_style(r: :title) || :cell
-        line = paint(title.center(title_width), title_style || :cell)
+        line = paint(Util::Strings.center(title, title_width), title_style || :cell)
         paint("#{pipe} #{line} #{pipe}", Theme::BG)
       end
 
@@ -81,7 +81,7 @@ module TableTennis
         style ||= :cell
 
         # add ansi codes for search
-        value = value.gsub(search) { paint(_1, :search) } if search
+        value = search_cell(value) if search
 
         # add ansi codes for links
         if config.color && (link = data.links[[r, c]])
@@ -155,6 +155,14 @@ module TableTennis
         end
       end
       memo_wise :search
+
+      # add ansi codes for search
+      def search_cell(value)
+        return value if !value.match?(search)
+        # edge case - we can't gsub a painted cell, it can mess up the escaping
+        value = Util::Strings.unpaint(value)
+        value.gsub(search) { paint(_1, :search) }
+      end
     end
   end
 end

data/lib/table_tennis/table_data.rb

@@ -114,7 +114,7 @@ module TableTennis
     def debug(str)
       return if !config&.debug
       str = "[#{Time.now.strftime("%H:%M:%S")}] #{str}"
-      str = str.ljust(@debug_width ||= IO.console.winsize[1])
+      str = str.ljust(@debug_width ||= Util::Console.winsize[1])
       puts Paint[str, :white, :green]
     end
 

data/lib/table_tennis/util/console.rb

@@ -0,0 +1,23 @@
+module TableTennis
+  module Util
+    # static wrapper around IO.console to handle the case where IO.console is nil
+    module Console
+      module_function
+
+      # supported when IO.console is nil
+      def winsize(...)
+        IO.console&.winsize(...) || [48, 80]
+      end
+
+      # not supported, don't call these
+      %i[fileno getbyte raw syswrite].each do |name|
+        define_method(name) do |*args, **kwargs, &block|
+          if !IO.console
+            raise "IO.console.#{name} not supported when IO.console is nil"
+          end
+          IO.console.send(name, *args, **kwargs, &block)
+        end
+      end
+    end
+  end
+end

data/lib/table_tennis/util/magic_options.rb

@@ -32,7 +32,8 @@
 # (1) A simple type like :bool, :int, :num, :float, :str or :sym.
 # (2) An array type like :bools, :ints, :nums, :floats, :strs, or :syms.
 # (3) A range, regexp or Class.
-# (4) A lambda which should return an error string or nil.
+# (4) A custom validation lambda. The lambda should raise an ArgumentError if
+#     the value is invalid.
 # (5) An array of possible values (typically numbers, strings, or symbols). The
 #     value must be one of those possibilities.
 # (6) A hash with one element { class => class }. This specifies the hash
@@ -135,15 +136,7 @@ module TableTennis
 
       def magic_set(name, value)
         raise ArgumentError, "unknown #{self.class}.#{name}=" if !magic_attributes.key?(name)
-        type = magic_attributes[name]
-        value = self.class.magic_coerce(value, type)
-        if !value.nil? && (error = MagicOptions.magic_validate(value, type))
-          if !type.is_a?(Proc)
-            error = "#{error}, got #{value.inspect}"
-          end
-          raise ArgumentError, "#{self.class}.#{name}= #{error}"
-        end
-        magic_values[name] = value
+        magic_values[name] = self.class.magic_validate!(name, value, magic_attributes[name])
       end
 
       # these are part of the public api
@@ -151,39 +144,76 @@ module TableTennis
       alias_method :[]=, :magic_set
 
       #
-      # magic_validate and static helpers
+      # magic_validate! and static helpers
       #
 
-      def self.magic_validate(value, type)
+      # validate name=value against type, raise on failure
+      def self.magic_validate!(name, value, type)
+        # we validate against coerced values, but squirrel away the original
+        # uncoerced in case we need to use it inside an error message
+        original, value = value, magic_coerce(value, type)
+        return if value.nil?
+
         case type
-        when Array
-          "expected one of #{type.inspect}" if !type.include?(value)
-        when Class, :bool
-          "expected #{magic_pretty(type)}" if !magic_is_a?(value, type)
-        when Hash
-          name_klass, value_klass = type.first
-          valid = value.is_a?(Hash) && value.all? { magic_is_a?(_1, name_klass) && magic_is_a?(_2, value_klass) }
-          "expected hash of #{magic_pretty(name_klass)} => #{magic_pretty(value_klass)}" if !valid
-        when Proc
-          ret = type.call(value)
-          case ret
-          when String, false, nil then ret
-          else
-            puts "warning: MagicOptions.proc should ONLY return error string or nil/false, not #{ret.inspect}"
-            ret.to_s
-          end
-        when Range
-          if !value.is_a?(Numeric) || !type.include?(value)
-            "expected to be in range #{type.inspect}"
-          end
-        when Regexp
-          if !value.is_a?(String) || !value.match?(type)
-            "expected to be a string matching #{type.inspect}"
-          end
-        when :bools, :floats, :ints, :nums, :strs, :syms
-          klass = magic_resolve(type.to_s[..-2].to_sym)
-          valid = value.is_a?(Array) && value.all? { magic_is_a?(_1, klass) }
-          "expected array of #{type}" if !valid
+        when Array then validate_any_of(value, type)
+        when Class, :bool then validate_class(value, type)
+        when Hash then validate_hash(value, type)
+        when Proc then type.call(value)
+        when Range then validate_range(value, type)
+        when Regexp then validate_regexp(value, type)
+        when :bools, :floats, :ints, :nums, :strs, :syms then validate_array(value, type)
+        else
+          raise "impossible"
+        end
+        value
+      rescue ArgumentError => ex
+        # add context to msg if necessary
+        msg = ex.message
+        if !msg.include?("#{name} = #{original.inspect}")
+          msg = "#{self}.#{name} = #{original.inspect} failed, #{msg}"
+        end
+        raise ArgumentError, msg
+      end
+
+      #
+      # validators
+      #
+
+      def self.validate_any_of(value, possibilities)
+        if !possibilities.include?(value)
+          raise ArgumentError, "expected one of #{possibilities.inspect}"
+        end
+      end
+
+      def self.validate_class(value, klass)
+        if !magic_is_a?(value, klass)
+          raise ArgumentError, "expected #{magic_pretty(klass)}"
+        end
+      end
+
+      def self.validate_hash(value, hash_type)
+        kk, vk = hash_type.first
+        if !(value.is_a?(Hash) && value.all? { magic_is_a?(_1, kk) && magic_is_a?(_2, vk) })
+          raise ArgumentError, "expected hash of #{magic_pretty(kk)} => #{magic_pretty(vk)}"
+        end
+      end
+
+      def self.validate_range(value, range)
+        if !value.is_a?(Numeric) || !range.include?(value)
+          raise ArgumentError, "expected to be in range #{range.inspect}"
+        end
+      end
+
+      def self.validate_regexp(value, regexp)
+        if !value.is_a?(String) || !value.match?(regexp)
+          raise ArgumentError, "expected to be a string matching #{regexp}"
+        end
+      end
+
+      def self.validate_array(value, array_type)
+        klass = magic_resolve(array_type.to_s[..-2].to_sym)
+        if !(value.is_a?(Array) && value.all? { magic_is_a?(_1, klass) })
+          raise ArgumentError, "expected array of #{array_type}"
         end
       end
 

data/lib/table_tennis/util/strings.rb

@@ -6,6 +6,9 @@ module TableTennis
 
       module_function
 
+      # does this string contain ansi codes?
+      def painted?(str) = str.match?(/\e/)
+
       # strip ansi codes
       def unpaint(str) = str.gsub(/\e\[[0-9;]*m/, "")
 
@@ -18,8 +21,24 @@ module TableTennis
         str
       end
 
-      def width(text)
-        simple?(text) ? text.length : Unicode::DisplayWidth.of(text)
+      # measure width of text, with support for emojis, painted/ansi strings, etc
+      def width(str)
+        if simple?(str)
+          str.length
+        elsif painted?(str)
+          unpaint(str).length
+        else
+          Unicode::DisplayWidth.of(str)
+        end
+      end
+
+      # center text, like String#center but works with painted strings
+      def center(str, width)
+        # artificially inflate width to include escape codes
+        if painted?(str)
+          width += str.length - unpaint(str).length
+        end
+        str.center(width)
       end
 
       def hyperlink(str)
@@ -31,12 +50,26 @@ module TableTennis
       end
 
       # truncate a string based on the display width of the grapheme clusters.
-      # Should handle emojis and international characters
-      def truncate(text, stop)
-        if simple?(text)
-          return (text.length > stop) ? "#{text[0, stop - 1]}…" : text
+      # Should handle emojis and international characters. Painted strings too.
+      def truncate(str, stop)
+        if simple?(str)
+          (str.length > stop) ? "#{str[0, stop - 1]}…" : str
+        elsif painted?(str)
+          # generate truncated plain version
+          plain = truncate0(unpaint(str), stop)
+          # make a best effort to apply the colors
+          if (opening_codes = str[/\e\[(?:[0-9];?)+m/])
+            "#{opening_codes}#{plain}#{Paint::NOTHING}"
+          else
+            plain
+          end
+        else
+          truncate0(str, stop)
         end
+      end
 
+      # slow, but handles graphemes
+      def truncate0(text, stop)
         # get grapheme clusters, and attach zero width graphemes to the previous grapheme
         list = [].tap do |accum|
           text.grapheme_clusters.each do
@@ -61,8 +94,10 @@ module TableTennis
 
         text
       end
+      private_class_method :truncate0
 
-      SIMPLE = /\A[\x00-\x7F–—…·‘’“”•áéíñóúÓ]*\Z/
+      # note that escape \e (0x1b) is excluded
+      SIMPLE = /\A[\x00-\x1a\x1c-\x7F–—…·‘’“”•áéíñóúÓ]*\Z/
 
       # Is this a "simple" string? (no emojis, etc). Caches results for small
       # strings for performance reasons.

data/lib/table_tennis/util/termbg.rb

@@ -54,6 +54,8 @@ module TableTennis
           "bad TERM"
         elsif ENV["ZELLIJ"]
           "zellij"
+        elsif !IO.console
+          "no console"
         end
         if error
           debug("osc_supported? #{{host:, platform:, term:}} => #{error}")
@@ -75,7 +77,7 @@ module TableTennis
 
         debug("osc_query(#{attr})")
         begin
-          IO.console.raw do
+          Util::Console.raw do
             logs << "  IO.console.raw"
 
             # we send two messages - the cursor query is widely supported, so we
@@ -89,7 +91,7 @@ module TableTennis
             end.join
 
             logs << "  syswrite #{msg.inspect}"
-            IO.console.syswrite(msg)
+            Util::Console.syswrite(msg)
 
             # there should always be at least one response. If this is a response to
             # the cursor message, the first message didn't work
@@ -116,18 +118,18 @@ module TableTennis
       def read_term_response
         # fast forward to ESC
         loop do
-          return if !(ch = IO.console.getbyte&.chr)
+          return if !(ch = Util::Console.getbyte&.chr)
           break ch if ch == ESC
         end
         # next char should be either [ or ]
-        return if !(type = IO.console.getbyte&.chr)
+        return if !(type = Util::Console.getbyte&.chr)
         return if !(type == "[" || type == "]")
 
         # now read the response. note that the response can end in different ways
         # and we have to check for all of them
         buf = "#{ESC}#{type}"
         loop do
-          return if !(ch = IO.console.getbyte&.chr)
+          return if !(ch = Util::Console.getbyte&.chr)
           buf << ch
           break if type == "[" && buf.end_with?("R")
           break if type == "]" && buf.end_with?(BEL, ST)
@@ -162,7 +164,7 @@ module TableTennis
           return if !respond_to?(:tcgetpgrp)
         end
 
-        io = IO.console
+        io = Util::Console
         if (ttypgrp = tcgetpgrp(io.fileno)) <= 0
           debug("tcpgrp(#{io.fileno}) => #{ttypgrp}, errno=#{FFI.errno}")
           return

data/lib/table_tennis/version.rb

@@ -1,3 +1,3 @@
 module TableTennis
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/table_tennis.rb

@@ -25,6 +25,7 @@ require "table_tennis/stage/painter"
 require "table_tennis/stage/render"
 
 require "table_tennis/util/colors"
+require "table_tennis/util/console"
 require "table_tennis/util/identify"
 require "table_tennis/util/scale"
 require "table_tennis/util/strings"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: table_tennis
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Adam Doppelt
 bindir: bin
 cert_chain: []
-date: 2025-05-01 00:00:00.000000000 Z
+date: 2025-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv
@@ -106,6 +106,7 @@ files:
 - lib/table_tennis/table_data.rb
 - lib/table_tennis/theme.rb
 - lib/table_tennis/util/colors.rb
+- lib/table_tennis/util/console.rb
 - lib/table_tennis/util/identify.rb
 - lib/table_tennis/util/inspectable.rb
 - lib/table_tennis/util/magic_options.rb