table_tennis 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d899b2742e12311a8f7e7b80cf4f6aad23eaeb45962c175740793bc1ef3e195
-  data.tar.gz: 0ffd8dedbfd54dda07db0cf3bd3a171bc869a21779e43828dc7e7e6b0dcfc929
+  metadata.gz: bca2e5c4c1a64c9e8fee14a693e5dc678554c20973f5b1cdc585584623dcc99b
+  data.tar.gz: e2be7d5e448f04488c882bd63ac81a029f6008e43877b7c1112bb5a7a1a7a958
 SHA512:
-  metadata.gz: b2f3a271ad8075d5ee6e590a580df33128124e3f3f97a8d9fae9e5d3fff1ef31dcb36ba4363bfd4d269c47c8a7fffeda79dbc2d4d6e5d5db755f9f2173f5dd25
-  data.tar.gz: 78c83e5ecfad29dcc4e998426f798e11a023f74b02e9a4c46c4425925bc133556f2f5d0aea9416a313ab1513b9e9bba0605729e3cc391c47ec6e5abfa113f8e6
+  metadata.gz: 466b38cbfb6f20eabb66de0e4f125faac7f50cc903406559217ebd38e2b7fc40bc2e3b057c9b6a27c4b8165eaba76ec4cd58e710b5e34987f6ffec9a30230fce
+  data.tar.gz: 873288550ce91efc066d57d6a35b3c4ea56f67a4e464f9916677d61c62041c15f67d0a703694307db1079b49b0d6ad0a6e2113470c08edf154a42302ae89b834

data/.gitignore

@@ -1,5 +1,7 @@
 .envrc
 .tool-versions
 .vscode
-*.gem
-terminals/
+pkg/
+
+# gems don't need to include this since the gemspec is enough
+Gemfile.lock

data/Gemfile

@@ -3,6 +3,8 @@ gemspec
 
 group :development, :test do
   gem "amazing_print"
+  gem "image_optim"
+  gem "image_optim_pack"
   gem "minitest"
   gem "minitest-hooks"
   gem "mocha"
@@ -10,5 +12,5 @@ group :development, :test do
   gem "pry"
   gem "rake"
   gem "simplecov", require: false
-  gem "standard", require: false
+  gem "standard", require: false, platform: :mri
 end

data/README.md

@@ -42,10 +42,10 @@ TableTennis examines the background color of your terminal to pick either the da
 Construct your table with an array of rows. Rows are hashes, ActiveRecord objects, structs, Data records, or anything that responds to `to_h`. It also supports oddballs like arrays (as rows) or even a single hash.
 
 ```ruby
-puts TableTennis.new([{a: "hello", b: "world"}, {a: "foo", b: "bar"})
+puts TableTennis.new([{a: "hello", b: "world"}, {a: "foo", b: "bar"}])
 puts TableTennis.new(Recipe.all.to_a)  # activerecord
 puts TableTennis.new(array_of_structs) # these use to_h
-puts TableTennis.new([[1,2],[3,4]]])   # array of arrays
+puts TableTennis.new([[1,2],[3,4]])   # array of arrays
 puts TableTennis.new(authors[0])       # single hash
 ```
 
@@ -79,6 +79,7 @@ options = {
 | `row_numbers` | `false` | Show row numbers in the table. |
 | `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. |
 | `search` | ─ | string/regex to highlight in output |
+| `separators` | `true` | Include column and header separators in output. |
 | `strftime` | see → | strftime string for formatting Date/Time objects. The default is `"%Y-%m-%d"`, which looks like `2025-04-21`  |
 | `theme` | nil | 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.|
 | `title` | ─ | Add a title line to the table. |
@@ -149,8 +150,17 @@ We love CSV tools and use them all the time! Here are a few that we rely on:
 - [Terminal::Table](https://github.com/tj/terminal-table) - wonderful rubygem for pretty printing tables, great for non-hash data like confusion matrices
 - [visidata](https://www.visidata.org) - the best for poking around large files, it does everything
 
+### Changelog
+
+#### 0.0.4 (April '25)
+
+- Separators can be turned off with `separators: false`.
+- Headers are in color now. Tweaked a few of the dark colors as well.
+- Tricky math to better protect narrow columns with auto-layout.
+
 ### Special Thanks
 
 - [termbg](https://github.com/dalance/termbg) and [termenv](https://github.com/muesli/termenv) for showing how to safely detect the terminal background color. These libraries are widely used for Rust/Go, but as far as I know nothing similar exists for Ruby.
 - The [Paint gem](https://github.com/janlelis/paint) for help with ansi colors.
+- I copied the header color themes from [tabiew](https://github.com/shshemi/tabiew). Great project!
 - Google Sheets for providing nice color scales

data/Rakefile

@@ -1,5 +1,7 @@
 require "bundler/setup"
 require "rake/testtask"
+require "bundler"
+Bundler::GemHelper.install_tasks
 
 Rake::TestTask.new do
   # let the user pass *.rb on the command line

data/demo.tape

@@ -0,0 +1,23 @@
+#
+# script for vhs (https://github.com/charmbracelet/vhs)
+#
+
+# vhs settings
+Output "/tmp/demo.gif"
+Set FontFamily Menlo
+Set FontSize 28
+Set Width 1520
+Set Height 1100
+Set Margin 0
+Set Padding 0
+
+# fire up the app
+Hide
+  Type@1ms "tennis --clear --demo 3 --title 'Star Wars People' --zebra --columns name,height,homeworld,species,films --color-scale height"
+  Enter
+  Wait+Screen /Star/
+Show
+
+# now take the screenshot
+Sleep 0.5
+Screenshot "/tmp/dark.png"

data/justfile

@@ -1,79 +1,71 @@
+default: test
 
-# read gem version
-gemver := `grep -Eo "[0-9]+\.[0-9]+\.[0-9]+" lib/table_tennis/version.rb`
-
-#
-# dev
-#
+# check repo - lint & test
+check: lint test
 
-default:
-  @just --list
+# for ci. don't bother linting on windows
+ci:
+  @if [[ "{{os()}}" != "windows" ]]; then just lint ; fi
+  @just test
 
-check: lint test
+# check test coverage
+coverage:
+  COVERAGE=1 just test
+  open /tmp/coverage/index.html
 
-ci: check
+# format with rubocop
+format: (lint "-a")
 
+gem-local:
+  @just _banner rake install:local...
+  bundle exec rake install:local
 
-format:
-  @just banner format...
-  bundle exec rubocop -a
+# this will tag, build and push to rubygems
+gem-push: check
+  @just _banner rake release...
+  rake release
 
+# optimize images
 image_optim:
-  @bundle exec image_optim --allow-lossy --svgo-precision=1 -r .
+  @# advpng/pngout are slow. consider --verbose as well
+  @bundle exec image_optim --allow-lossy --svgo-precision=1 --no-advpng --no-pngout -r .
 
-lint:
-  @just banner lint...
-  bundle exec rubocop
+# lint with rubocop
+lint *ARGS:
+  @just _banner lint...
+  bundle exec rubocop {{ARGS}}
 
+# start pry with the lib loaded
 pry:
   bundle exec pry -I lib -r table_tennis.rb
 
+# run tennis repeatedly
 tennis-watch *ARGS:
   @watchexec --stop-timeout=0 --clear clear tennis {{ARGS}}
 
+# run tests
 test *ARGS:
-  @just banner rake test {{ARGS}}
+  @just _banner rake test {{ARGS}}
   @bundle exec rake test {{ARGS}}
 
+# run tests repeatedly
 test-watch *ARGS:
-  @watchexec --stop-timeout=0 --clear clear just test "{{ARGS}}"
+  watchexec --stop-timeout=0 --clear clear just test "{{ARGS}}"
 
-#
-# coverage/profiling
-#
-
-coverage:
-  COVERAGE=1 just test
-  open /tmp/coverage/index.html
-
-#
-# gem tasks
-#
-
-# you can test locally from another project by dropping gem file into vendor/cache
-gem-push:
-  @just banner bundle install and verify git...
-  bundle install
-  #@just check-git-status
-  @just banner gem build...
-  gem build table_tennis.gemspec
-  @just banner tag...
-  git tag -a "v{{gemver}}" -m "Tagging {{gemver}}"
-  git push --tags
-  @just banner gem push...
-  gem push "table_tennis-{{gemver}}.gem"
+# create sceenshot using vhs
+vhs:
+  @just _banner "running vhs..."
+  vhs demo.tape
+  magick /tmp/dark.png -crop 1448x1004+18+16 screenshots/dark.png
 
 #
 # util
 #
 
-banner *ARGS: (_banner BG_GREEN ARGS)
-warning *ARGS: (_banner BG_YELLOW ARGS)
-fatal *ARGS: (_banner BG_RED ARGS)
+_banner *ARGS: (_message BG_GREEN ARGS)
+_warning *ARGS: (_message BG_YELLOW ARGS)
+_fatal *ARGS: (_message BG_RED ARGS)
   @exit 1
-_banner color *ARGS:
+_message color *ARGS:
   @msg=$(printf "[%s] %s" $(date +%H:%M:%S) "{{ARGS}}") ; \
   printf "{{color+BOLD+WHITE}}%-72s{{ NORMAL }}\n" "$msg"
-
-check-git-status:
-  @if [ ! -z "$(git status --porcelain)" ]; then just fatal "git status is dirty, bailing."; fi

data/lib/table_tennis/config.rb

@@ -18,6 +18,7 @@ module TableTennis
       row_numbers: false, # show line numbers?
       save: nil, # csv file path to save the table when created
       search: nil, # string/regex to highlight in output
+      separators: true, # if true, show separators between columns
       strftime: nil, # string for formatting dates
       theme: nil,  # :dark, :light or :ansi. :dark is the default
       title: nil, # string for table title, if any
@@ -51,6 +52,7 @@ module TableTennis
       placeholder: :str,
       row_numbers: :bool,
       save: :str,
+      separators: :bool,
       strftime: :str,
       title: :str,
       titleize: :bool,

data/lib/table_tennis/stage/layout.rb

@@ -28,8 +28,7 @@ module TableTennis
       # some math
       #
 
-      AUTOLAYOUT_MIN_COLUMN_WIDTH = 2
-      AUTOLAYOUT_FUDGE = 2
+      FUDGE = 2
 
       # Fit columns into terminal width. This is copied from the very simple HTML
       # table column algorithm. Returns a hash of column name to width.
@@ -37,30 +36,35 @@ module TableTennis
         # set provisional widths
         columns.each { _1.width = _1.measure }
 
-        # how much space is available, and do we already fit?
+        # How much space is available, and do we already fit?
         screen_width = IO.console.winsize[1]
-        available = screen_width - chrome_width - AUTOLAYOUT_FUDGE
+        available = screen_width - chrome_width - FUDGE
         return if available >= data_width
 
-        # min/max column widths, which we use below
-        min = columns.map { [_1.width, AUTOLAYOUT_MIN_COLUMN_WIDTH].min }
-        max = columns.map(&:width)
+        # We don't fit, so we are going to shrink (truncate) some columns.
+        # Potentially all the way down to a lower bound. But what is the lower
+        # bound? It's nice to have a generous value so that narrow columns have
+        # a shot at avoiding truncation. That isn't always possible, though.
+        lower_bound = (available / columns.length).clamp(2, 10)
 
-        # W = difference between the available space and the minimum table width
-        # D = difference between maximum and minimum width of the table
-        w = available - min.sum
-        d = max.sum - min.sum
+        # Calculate a "min" and a "max" for each column, then allocate available
+        # space proportionally to each column. This is similar to the algorithm
+        # for HTML tables.
+        min = max = columns.map(&:width)
+        min = min.map { [_1, lower_bound].min }
 
-        # edge case if we don't even have enough room for min
-        if w <= 0
+        # W = difference between the available space and the minimum table width
+        # D = difference between maximum and minimum table width
+        # ratio = W / D
+        # col.width = col.min + ((col.max - col.min) * ratio)
+        ratio = (available - min.sum).to_f / (max.sum - min.sum)
+        if ratio <= 0
+          # even min doesn't fit, we gotta overflow
           columns.each.with_index { _1.width = min[_2] }
           return
         end
-
-        # expand min to fit available space
-        columns.each.with_index do
-          # width = min + (delta * W / D)
-          _1.width = min[_2] + ((max[_2] - min[_2]) * w / d.to_f).to_i
+        columns.zip(min, max).each do |column, min, max|
+          column.width = min + ((max - min) * ratio).to_i
         end
 
         # because we always round down, there might be some extra space to distribute

data/lib/table_tennis/stage/painter.rb

@@ -16,6 +16,7 @@ module TableTennis
       def run
         return if !config.color
         paint_title if config.title
+        paint_headers
         paint_row_numbers if config.row_numbers
         paint_rows if config.mark || config.zebra
         paint_columns if config.color_scales
@@ -32,6 +33,14 @@ module TableTennis
         set_style(r: :title, style: :title)
       end
 
+      NHEADER_COLORS = 6
+
+      def paint_headers
+        columns.each.with_index do |column, c|
+          set_style(r: :header, c:, style: :"header#{c % Theme::NHEADER_COLORS}")
+        end
+      end
+
       def paint_row_numbers
         set_style(c: 0, style: :chrome)
       end
@@ -127,8 +136,12 @@ module TableTennis
 
       def mark_style(user_mark)
         case user_mark
-        when String, Symbol then [nil, user_mark] # assume bg color
-        when Array then user_mark # a Paint array
+        when String, Symbol
+          # pick a nice fg color
+          [Util::Colors.contrast(user_mark), user_mark]
+        when Array
+          # a Paint array
+          user_mark
         else; :mark # default
         end
       end

data/lib/table_tennis/stage/render.rb

@@ -32,12 +32,12 @@ module TableTennis
         if config.title
           io.puts render_separator(NW, BAR, NE)
           io.puts render_title
-          io.puts render_separator(W, N, E)
+          io.puts render_separator(W, N, E) if config.separators
         else
           io.puts render_separator(NW, N, NE)
         end
         io.puts render_row(:header)
-        io.puts render_separator(W, C, E)
+        io.puts render_separator(W, C, E) if config.separators
         rows.each_index { io.puts render_row(_1) }
         io.puts render_separator(SW, S, SE)
       end
@@ -59,9 +59,10 @@ module TableTennis
 
         # assemble line by rendering cells
         enum = (r != :header) ? rows[r].each : columns.map(&:header)
+        joiner = config.separators ? " #{pipe} " : "  "
         line = enum.map.with_index do |value, c|
           render_cell(value, r, c, row_style)
-        end.join(" #{pipe} ")
+        end.join(joiner)
         line = "#{pipe} #{line} #{pipe}"
 
         # afterward, apply row color
@@ -95,6 +96,7 @@ module TableTennis
       end
 
       def render_separator(l, m, r)
+        m = "" if !config.separators
         line = [].tap do |buf|
           columns.each.with_index do |column, c|
             buf << ((c == 0) ? l : m)

data/lib/table_tennis/table_data.rb

@@ -44,9 +44,13 @@ module TableTennis
     # Lazily calculate the list of columns.
     def columns
       names = config&.columns
-      names ||= {}.tap do |memo|
-        fat_rows.each { |row| row.each_key { memo[_1] = 1 } }
-      end.keys
+      if !fat_rows.empty?
+        names ||= {}.tap do |memo|
+          fat_rows.each { |row| row.each_key { memo[_1] = 1 } }
+        end.keys
+      else
+        names = []
+      end
       names.each do |name|
         if !fat_rows.any? { _1.key?(name) }
           raise ArgumentError, "specified column `#{name}` not found in any row of input data"
@@ -88,13 +92,22 @@ module TableTennis
 
     # layout math
     #
-    # |•xxxx•|•xxxx•|•xxxx•|•xxxx•||•xxxx•|•xxxx•|•xxxx•|•xxxx•|
-    # ↑↑    ↑                                                  ↑
-    # 12    3    <-   three chrome chars per column            │
-    #                                                          │
-    #                                            extra chrome char at the end
-    #
-    def chrome_width = columns.length * 3 + 1
+    # with separators
+    # |•xxxx•|•xxxx•|•xxxx•|•xxxx•|•xxxx•|•xxxx•|•xxxx•|•xxxx•|
+    # ↑↑    ↑                                                 ↑
+    # 12    3    <-   three chrome chars per column           │
+    #                                                         │
+    #                                           extra chrome char at the end
+    # without
+    # |•xxxx••xxxx••xxxx••xxxx••xxxx••xxxx••xxxx••xxxx•|
+    #  ↑    ↑                                          ↑
+    #  1    2    <-   two chrome chars per column      │
+    #                                                  │
+    #                             extra chrome char at beginning and end
+    def chrome_width
+      config.separators ? (columns.length * 3 + 1) : (columns.length * 2 + 2)
+    end
+    memo_wise :chrome_width
 
     # for debugging
     def debug(str)

data/lib/table_tennis/theme.rb

@@ -5,27 +5,46 @@ module TableTennis
     prepend MemoWise
 
     RESET = Paint::NOTHING
+    NHEADER_COLORS = 6
     THEMES = {
       dark: {
-        title: "#7f0",
+        title: ["blue-400", :bold],
         chrome: "gray-500",
         cell: "gray-200",
+        header0: ["#ff6188", :bold],
+        header1: ["#fc9867", :bold],
+        header2: ["#ffd866", :bold],
+        header3: ["#a9dc76", :bold],
+        header4: ["#78dce8", :bold],
+        header5: ["#ab9df2", :bold],
         mark: %w[white blue-500],
         search: %w[black yellow-300],
-        zebra: %w[white #333],
+        zebra: %w[white #222],
       },
       light: {
-        title: "blue-600",
+        title: ["blue-600", :bold],
         chrome: "#bbb",
         cell: "gray-800",
+        header0: ["#ee4066", :bold],
+        header1: ["#da7645", :bold],
+        header2: ["#ddb644", :bold],
+        header3: ["#87ba54", :bold],
+        header4: ["#56bac6", :bold],
+        header5: ["#897bd0", :bold],
         mark: %w[white blue-500],
         search: %w[black yellow-300],
         zebra: %w[black gray-200],
       },
       ansi: {
-        title: :green,
+        title: %i[green bold],
         chrome: %i[faint default],
         cell: :default,
+        header0: nil, # not supported
+        header1: nil, # not supported
+        header2: nil, # not supported
+        header3: nil, # not supported
+        header4: nil, # not supported
+        header5: nil, # not supported
         mark: %i[white blue],
         search: %i[white magenta],
         zebra: nil, # not supported
@@ -50,6 +69,7 @@ module TableTennis
       if value.is_a?(Symbol) && THEME_KEYS.include?(value)
         value = THEMES[name][value]
       end
+
       # turn value(s) into colors
       colors = Array(value).map { Util::Colors.get(_1) }
       return if colors == [] || colors == [nil]

data/lib/table_tennis/util/colors.rb

@@ -439,6 +439,14 @@ module TableTennis
 
       # is this color dark?
       def dark?(color)
+        color = get(color)
+        return true if !color
+
+        # take a guess at symbols too
+        if color.is_a?(Symbol)
+          return !%i[white gray].include?(color)
+        end
+
         luma = luma(color)
         !luma || luma < DARK_LUMA
       end

data/lib/table_tennis/version.rb

@@ -1,3 +1,3 @@
 module TableTennis
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: table_tennis
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Adam Doppelt
 bindir: bin
 cert_chain: []
-date: 2025-04-20 00:00:00.000000000 Z
+date: 2025-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: csv
@@ -88,10 +88,10 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- demo.tape
 - justfile
 - lib/table_tennis.rb
 - lib/table_tennis/column.rb

data/Gemfile.lock

@@ -1,122 +0,0 @@
-PATH
-  remote: .
-  specs:
-    table_tennis (0.0.3)
-      csv (~> 3.3)
-      ffi (~> 1.17)
-      memo_wise (~> 1.11)
-      paint (~> 2.3)
-      unicode-display_width (~> 3.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    amazing_print (1.7.2)
-    ast (2.4.3)
-    coderay (1.1.3)
-    csv (3.3.2)
-    docile (1.4.1)
-    ffi (1.17.1)
-    ffi (1.17.1-aarch64-linux-gnu)
-    ffi (1.17.1-aarch64-linux-musl)
-    ffi (1.17.1-arm-linux-gnu)
-    ffi (1.17.1-arm-linux-musl)
-    ffi (1.17.1-arm64-darwin)
-    ffi (1.17.1-x86-linux-gnu)
-    ffi (1.17.1-x86-linux-musl)
-    ffi (1.17.1-x86_64-darwin)
-    ffi (1.17.1-x86_64-linux-gnu)
-    ffi (1.17.1-x86_64-linux-musl)
-    json (2.10.2)
-    language_server-protocol (3.17.0.4)
-    lint_roller (1.1.0)
-    memo_wise (1.11.0)
-    method_source (1.1.0)
-    minitest (5.25.5)
-    minitest-hooks (1.5.2)
-      minitest (> 5.3)
-    mocha (2.7.1)
-      ruby2_keywords (>= 0.0.5)
-    ostruct (0.6.1)
-    paint (2.3.0)
-    parallel (1.26.3)
-    parser (3.3.7.4)
-      ast (~> 2.4.1)
-      racc
-    prism (1.4.0)
-    pry (0.15.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    racc (1.8.1)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    regexp_parser (2.10.0)
-    rubocop (1.73.2)
-      json (~> 2.3)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.43.0)
-      parser (>= 3.3.7.2)
-      prism (~> 1.4)
-    rubocop-performance (1.24.0)
-      lint_roller (~> 1.1)
-      rubocop (>= 1.72.1, < 2.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
-    ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.1)
-    simplecov_json_formatter (0.1.4)
-    standard (1.47.0)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.73.0)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.7)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.7.0)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.24.0)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-
-PLATFORMS
-  aarch64-linux-gnu
-  aarch64-linux-musl
-  arm-linux-gnu
-  arm-linux-musl
-  arm64-darwin
-  ruby
-  x86-linux-gnu
-  x86-linux-musl
-  x86_64-darwin
-  x86_64-linux-gnu
-  x86_64-linux-musl
-
-DEPENDENCIES
-  amazing_print
-  minitest
-  minitest-hooks
-  mocha
-  ostruct
-  pry
-  rake
-  simplecov
-  standard
-  table_tennis!
-
-BUNDLED WITH
-   2.6.5