hawktui 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07fe25870ab381af56a2690f6b7befd22933dea333cb63f2d4d9e96b6801af5e
-  data.tar.gz: 8d7e1ce5dc90cfcc1d07e7adcb2b9f0c99949f612616c5ab64b7a3e34529f7c3
+  metadata.gz: 56702f773b1ff7da828d1a7e9dfc838b83e1167036ed707ad72525b34c8f0738
+  data.tar.gz: 7d056d53a33107647ffaa5164c9d6d7b1d6013a3d3c4263ef338e7ef014108e6
 SHA512:
-  metadata.gz: 25ead068f0039099acabceba170d120aaa8c674cae0b607df496a7de60fdc9a722c827376bf2bb6929522d5405861e515e4e8b3713d9b4bcce964bd855d51061
-  data.tar.gz: 5c6b1112d3519712730b7c84dccd153d0ae6062afd5c325beea6ad70cd13f6da8d6bed61f5f94ce9b0c20a0d03325117416326413b76301994cdf3698becb297
+  metadata.gz: 0df227c1bfb4eb2c31baf4ce2e60c486c657b4d567c16a1384b878f94bef021d5c827fde1c20d9300cae91400e9a13eb204490be2c2875f387479564620fdcf5
+  data.tar.gz: 7f6086a30a2df0cb42da9ab8097ac662994593492f30dbaae42f2d8ccc1bea0f7fac41ade120a10a3ee65897a38accfd0149084b7a88a83f5f154aafe17d2671

data/README.md

@@ -3,3 +3,42 @@
 Hawktui is a simple and easy to use TUI (Terminal User Interface) library for Ruby. It is built on the [curses](https://github.com/ruby/curses) library.
 
 ![hawktui](https://github.com/jonmagic/hawktui/blob/main/hawktui.jpeg)
+
+So far it includes a `StreamingTable` API and more APIs are planned.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "hawktui"
+```
+
+Run the following command to install it:
+
+```bash
+bundle install
+```
+
+## StreamingTable
+
+The `Hawktui::StreamingTable` API can be used to create a full screen table in your terminal that can be updated in real time. This is useful for displaying data that is constantly changing.
+
+```bash
+git clone https://github.com/jonmagic/hawktui
+cd hawktui
+bin/setup
+bin/demo
+```
+
+https://github.com/user-attachments/assets/9085352f-9f6a-47ae-90c7-cc23946f2d30
+
+See [bin/demo](https://github.com/jonmagic/hawktui/blob/main/bin/demo) for an example of how to use `Hawktui::StreamingTable` and the implementation in [lib/hawktui/streaming_table.rb](https://github.com/jonmagic/hawktui/blob/main/lib/hawktui/streaming_table.rb) for documentation.
+
+## Roadmap
+
+- Add functionality to StreamingTable for selecting and acting on rows.
+
+## Contributors
+
+- [@jonmagic](https://github.com/jonmagic)

data/lib/hawktui/streaming_table/cell.rb

@@ -7,11 +7,11 @@ module Hawktui
     #
     # Examples
     #
-    #   cell = Tui::Cell.new("Hello")
+    #   cell = Hawktui::StreamingTable::Cell.new("Hello")
     #   cell.value  # => "Hello"
     #   cell.color  # => nil
     #
-    #   colored_cell = Tui::Cell.new(value: "Error", color: :red)
+    #   colored_cell = Hawktui::StreamingTable::Cell.new(value: "Error", color: :red)
     #   colored_cell.value  # => "Error"
     #   colored_cell.color  # => :red
     #

data/lib/hawktui/streaming_table/column.rb

@@ -7,7 +7,7 @@ module Hawktui
     #
     # Examples
     #
-    #   column = Tui::Column.new(name: :message, width: 50)
+    #   column = Hawktui::StreamingTable::Column.new(name: :message, width: 50)
     #
     class Column
       attr_reader :name, :width
@@ -19,7 +19,7 @@ module Hawktui
       #
       # Examples
       #
-      #   column = Tui::Column.new(name: :message, width: 50)
+      #   column = Hawktui::StreamingTable::Column.new(name: :message, width: 50)
       #
       # Returns a new Column instance.
       def initialize(name:, width:)
@@ -31,11 +31,11 @@ module Hawktui
       # If the text is longer than `width`, it will be truncated with an ellipsis ("…").
       # Otherwise, it’s left-padded with spaces to fill the width.
       #
-      # cell - A Tui::Cell containing the raw value and color.
+      # cell - A Hawktui::StreamingTable::Cell containing the raw value and color.
       #
       # Examples
       #
-      #   cell = Tui::Cell.new("Some message")
+      #   cell = Hawktui::StreamingTable::Cell.new("Some message")
       #   column.format_cell(cell)
       #   # => ["Some message        ", nil] # => example if width is bigger
       #

data/lib/hawktui/streaming_table/layout.rb

@@ -12,7 +12,7 @@ module Hawktui
     #     { name: :timestamp, width: 20 },
     #     { name: :message,   width: 50 },
     #   ]
-    #   layout = Tui::TableLayout.new(columns: columns, header_color: :white)
+    #   layout = Hawktui::StreamingTable::Layout.new(columns: columns, header_color: :white)
     #
     #   header_cells = layout.build_header_row   # => [Cell(...), Cell(...)]
     #
@@ -21,13 +21,13 @@ module Hawktui
 
       # Public: Create a new TableLayout.
       #
-      # columns      - An Array of Hashes or Tui::Column objects. Each element must
+      # columns      - An Array of Hashes or Hawktui::StreamingTable::Column objects. Each element must
       #                have a `:name` and `:width`.
       # header_color - A Symbol representing the color used in the header (defaults to :white).
       #
       # Examples
       #
-      #   layout = Tui::TableLayout.new(
+      #   layout = Hawktui::StreamingTable::Layout.new(
       #     columns: [
       #       { name: :time, width: 10 },
       #       { name: :level, width: 5 },
@@ -52,7 +52,7 @@ module Hawktui
       #   layout.build_header_row
       #   # => [Cell(value="time", color=:white), Cell(value="level", color=:white)]
       #
-      # Returns an Array of Tui::Cell objects.
+      # Returns an Array of Hawktui::StreamingTable::Cell objects.
       def build_header_row
         columns.map do |col|
           # Use the stored @header_color for all headers
@@ -71,7 +71,7 @@ module Hawktui
       #   layout.build_cells_for_row(row_hash)
       #   # => [Cell(value="12:00", color=nil), Cell(value="INFO", color=:green)]
       #
-      # Returns an Array of Tui::Cell objects.
+      # Returns an Array of Hawktui::StreamingTable::Cell objects.
       def build_cells_for_row(row_hash)
         columns.map do |col|
           value_or_hash = row_hash[col.name] || ""

data/lib/hawktui/streaming_table.rb

@@ -17,7 +17,7 @@ module Hawktui
   #     { name: :timestamp, width: 20 },
   #     { name: :message,   width: 50 },
   #   ]
-  #   table = Tui::StreamingTable.new(columns: columns, max_rows: 1000)
+  #   table = Hawktui::StreamingTable.new(columns: columns, max_rows: 1000)
   #   table.start
   #
   #   # In a separate thread or async process:
@@ -31,16 +31,16 @@ module Hawktui
   class StreamingTable
     # Public: Create a new StreamingTable.
     #
-    # columns - An Array of Hashes or Tui::Column objects that define the table’s
+    # columns - An Array of Hashes or Hawktui::StreamingTable::Column objects that define the table’s
     #           columns. Each element should at least contain `:name` and `:width`.
     # max_rows - The maximum number of rows to keep in the table. Defaults to 100000.
     #
     # Examples
     #
-    #   table = Tui::StreamingTable.new(columns: [{ name: :time, width: 10 }], max_rows: 500)
+    #   table = Hawktui::StreamingTable.new(columns: [{ name: :time, width: 10 }], max_rows: 500)
     #
     # Returns a new StreamingTable instance.
-    def initialize(columns:, max_rows: 100_000)
+    def initialize(columns: {}, max_rows: 100_000)
       @layout = Layout.new(columns: columns)
       @max_rows = max_rows
       @rows = [] # Store rows newest-first
@@ -53,6 +53,21 @@ module Hawktui
     attr_reader :layout, :max_rows, :rows, :paused, :should_exit
     attr_accessor :win
 
+    # Public: Set the layout for the table. This will redraw the table with the new layout.
+    #
+    # new_layout - A Hawktui::StreamingTable::Layout object.
+    #
+    # Examples
+    #
+    #   new_layout = Hawktui::StreamingTable::Layout.new(columns: [{ name: :id, width: 10 }])
+    #   table.layout = new_layout
+    #
+    # Returns nothing.
+    def layout=(new_layout)
+      @layout = new_layout
+      draw if win # Ensure the window is initialized before attempting to draw
+    end
+
     # Public: Start the table UI. Initializes curses, sets up input handling,
     # and draws the initial screen.
     #

data/lib/hawktui/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hawktui
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hawktui
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jonathan Hoyt
@@ -69,6 +69,6 @@ requirements: []
 rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
-summary: HawkTui is a simple and easy to use TUI (Terminal User Interface) library
+summary: Hawktui is a simple and easy to use TUI (Terminal User Interface) library
   for Ruby.
 test_files: []