table_tennis 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bca2e5c4c1a64c9e8fee14a693e5dc678554c20973f5b1cdc585584623dcc99b
-  data.tar.gz: e2be7d5e448f04488c882bd63ac81a029f6008e43877b7c1112bb5a7a1a7a958
+  metadata.gz: '009a0c9bbb140d308d55441602f96a534e51d989259c70b2e3cc2661213252cb'
+  data.tar.gz: 6422661f90e1e6e15ddb67c0fff92d6d1c1f3d3454e95a57ae79652d83b981ca
 SHA512:
-  metadata.gz: 466b38cbfb6f20eabb66de0e4f125faac7f50cc903406559217ebd38e2b7fc40bc2e3b057c9b6a27c4b8165eaba76ec4cd58e710b5e34987f6ffec9a30230fce
-  data.tar.gz: 873288550ce91efc066d57d6a35b3c4ea56f67a4e464f9916677d61c62041c15f67d0a703694307db1079b49b0d6ad0a6e2113470c08edf154a42302ae89b834
+  metadata.gz: af82ae82579222df273e5244c2dde9137547cce527b4c5e4b900feeb7129beb7d9b5d9ea80ae849f62ac79befd14c38be0f8e8c311a651f8dc63660b1953190a
+  data.tar.gz: 7eae197b20fe45f0b65f9987097e38233dac3ea113fcabbfd27011340a18910f9c8d701a3352cb482819f266391e98a0daaeec0857e966982e6d6ffcf2aa2121

data/README.md

@@ -29,6 +29,7 @@ gem "table_tennis"
 - auto-layout to fit your terminal window
 - auto-format floats and dates
 - auto-color numeric columns
+- auto-link markdown links
 - titles, row numbers, zebra stripes...
 
 ### Themes
@@ -45,7 +46,7 @@ Construct your table with an array of rows. Rows are hashes, ActiveRecord object
 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
 ```
 
@@ -114,6 +115,16 @@ puts TableTennis.new(rows, row_numbers: true, zebra: true)
 | - | - | - |
 | ![droids](./screenshots/droids.png) | ![hope](./screenshots/hope.png) | ![row numbers](./screenshots/row_numbers.png) |
 
+### Links
+
+Modern terminals support **hyperlinks** in the text stream. If your table includes markdown-style links, TableTennis will use [OSC 8](https://github.com/Alhadis/OSC8-Adoption) to render them. For example:
+
+```ruby
+puts TableTennis.new([{site: "[search](https://google.com)"}])
+```
+
+![link](./screenshots/link.png)
+
 ### Advanced Usage
 
 TableTennis can be configured a few different ways:
@@ -152,6 +163,10 @@ We love CSV tools and use them all the time! Here are a few that we rely on:
 
 ### Changelog
 
+#### 0.0.5 (April '25)
+
+- Support for markdown style links in the cells
+
 #### 0.0.4 (April '25)
 
 - Separators can be turned off with `separators: false`.

data/lib/table_tennis/stage/format.rb

@@ -16,14 +16,23 @@ module TableTennis
           fn || :fn_default
         end
 
-        rows.each do |row|
-          row.each_index do
-            value = row[_1]
+        rows.each.with_index do |row, r|
+          row.each_index do |c|
+            value = row[c]
             # Try to format using the column fn. This can return nil. For
             # example, a float column and value is nil, not a float, etc.
-            formatted = send(fns[_1], value)
+            str = send(fns[c], value)
+
             # If the column formatter failed, use the default formatter
-            row[_1] = formatted || fn_default(value) || config.placeholder
+            str ||= fn_default(value) || config.placeholder
+
+            # look for markdown-style links
+            if (link = detect_link(str))
+              str, data.links[[r, c]] = link
+            end
+
+            # done
+            row[c] = str
           end
         end
       end
@@ -61,7 +70,7 @@ module TableTennis
       # default formatting. cleanup whitespace
       def fn_default(value)
         return if value.nil?
-        str = (value.is_a?(String) ? value : value.to_s)
+        str = value.is_a?(String) ? value : value.to_s
         str = str.strip.gsub("\n", "\\n").gsub("\r", "\\r") if str.match?(/\s/)
         return if str.empty?
         str
@@ -91,6 +100,14 @@ module TableTennis
         x
       end
 
+      def detect_link(str)
+        # fail fast, for speed
+        return unless str.length >= 6 && str[0] == "["
+        if str =~ /^\[([^\]]+)\]\(([^\)]+)\)$/
+          [$1, $2]
+        end
+      end
+
       # str to_xxx that are resistant to commas
       def to_f(str) = str.delete(",").to_f
       def to_i(str) = str.delete(",").to_i

data/lib/table_tennis/stage/render.rb

@@ -83,6 +83,11 @@ module TableTennis
         # add ansi codes for search
         value = value.gsub(search) { paint(_1, :search) } if search
 
+        # add ansi codes for links
+        if config.color && (link = data.links[[r, c]])
+          value = theme.link(value, link)
+        end
+
         # pad and paint
         if whitespace > 0
           spaces = " " * whitespace

data/lib/table_tennis/table_data.rb

@@ -21,7 +21,7 @@ module TableTennis
     prepend MemoWise
     include Util::Inspectable
 
-    attr_accessor :config, :input_rows, :styles
+    attr_accessor :config, :input_rows, :links, :styles
 
     def initialize(rows:, config: nil)
       @config, @input_rows = config, rows
@@ -38,6 +38,7 @@ module TableTennis
         raise ArgumentError, "input_rows must be an array of hash-like objects, not #{input_rows.class}"
       end
 
+      @links = {}
       @styles = {}
     end
 

data/lib/table_tennis/theme.rb

@@ -5,6 +5,9 @@ module TableTennis
     prepend MemoWise
 
     RESET = Paint::NOTHING
+    OSC_8 = "\e]8;;"
+    ST = "\e\\"
+
     NHEADER_COLORS = 6
     THEMES = {
       dark: {
@@ -95,6 +98,12 @@ module TableTennis
     end
     memo_wise :paint
 
+    # use osc 8 to create a terminal hyperlink. underline too
+    def link(str, link)
+      linked = "#{OSC_8}#{link}#{ST}#{str}#{OSC_8}#{ST}"
+      Paint[linked, :underline]
+    end
+
     # for debugging, mostly
     def self.info
       sample = if !Config.detect_color?

data/lib/table_tennis/util/strings.rb

@@ -22,6 +22,12 @@ module TableTennis
         simple?(text) ? text.length : Unicode::DisplayWidth.of(text)
       end
 
+      def hyperlink(value)
+        if value =~ /^\[([^\]]*)\]\(([^\)]*)\)$/
+          [$1, $2]
+        end
+      end
+
       # truncate a string based on the display width of the grapheme clusters.
       # Should handle emojis and international characters
       def truncate(text, stop)

data/lib/table_tennis/version.rb

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

data/table_tennis.gemspec

@@ -7,10 +7,11 @@ Gem::Specification.new do |s|
   s.email = "amd@gurge.com"
 
   s.summary = "Stylish tables in your terminal."
-  s.homepage = "http://github.com/gurgeous/table_tennis"
+  s.homepage = "https://github.com/gurgeous/table_tennis"
   s.license = "MIT"
   s.required_ruby_version = ">= 3.0.0"
   s.metadata = {
+    "homepage_uri" => s.homepage,
     "rubygems_mfa_required" => "true",
     "source_code_uri" => s.homepage,
   }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: table_tennis
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Adam Doppelt
@@ -116,16 +116,18 @@ files:
 - screenshots/droids.png
 - screenshots/hope.png
 - screenshots/light.png
+- screenshots/link.png
 - screenshots/row_numbers.png
 - screenshots/scales.png
 - screenshots/themes.png
 - table_tennis.gemspec
-homepage: http://github.com/gurgeous/table_tennis
+homepage: https://github.com/gurgeous/table_tennis
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/gurgeous/table_tennis
   rubygems_mfa_required: 'true'
-  source_code_uri: http://github.com/gurgeous/table_tennis
+  source_code_uri: https://github.com/gurgeous/table_tennis
 rdoc_options: []
 require_paths:
 - lib