typed_print 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b589c4ef3b3bb0bbc3629c7e6a2a74de7b74a7124bceb46aadc66a7fe957de0
-  data.tar.gz: 557218da71a928e0ed694c03e07bce59c343226642dcdc1f9231290051d02aaf
+  metadata.gz: 4ded9b786c7fc0596377055e783a299fe9eab5558d0d375d978f8186ab72c840
+  data.tar.gz: d6433125b154f6b2deaaf7764b2b02919d72d4e25e53edc1a2af379265289c96
 SHA512:
-  metadata.gz: 28efd87ec5f95353c09ae1c9954ee52f843d3031b0228597cbe9a62e13e88eea41bdb87dbd010ca541e0579af6c40cce4fa1bc8e8a90724480ec57e2b3770bb9
-  data.tar.gz: f9e4a8604633020344fd0b41926eb5b99e9af31075dd7bca0cdcc3ef79871ff0c57643b9a0f24214280ef7a8c84a4ed5ec36a6bae30d36914f0c576b223d5d68
+  metadata.gz: 8d7b5bd554c0e68e5d8846103e2020db279a96f3ce7d075281492a42570f7d055dd58c38a15bfe8d3be8b6af67a1f30c6c3d81d476c5d080d533049ad62a8561
+  data.tar.gz: 27cdf2be6875f4a47f666c5716db1b50b1ffa3136d3ba548a8d8d6f8a123be07ae3f73d8a92c1a6031f75b3fd03011490aea81508bb5140678fbb09faba9b820

data/CHANGELOG.md

@@ -1,13 +1,31 @@
+# Changelog
+
+## [0.3.0] - 2026-04-27
+
+### Added
+- Optional color support via `pastel` gem (runtime optional, dev dependency)
+- `color: true` for automatic type-based coloring (headers cyan, numbers green, booleans green/red, nil gray)
+- `colors: { col: :color }` for manual per-column color mapping
+- Color support for both `:plain` and `:markdown` formats
+
+## [0.2.0] - 2026-04-22
+
+### Added
+- Markdown table output with `format: :markdown` option
+- New `TypedPrint.table` method returns string without printing
+- Support for both plain and markdown formats
+
+### Changed
+- Internal refactoring to support multiple output formats
+
 ## [0.1.0] - 2026-04-21
 
 ### Added
 - Initial release
 - Basic table formatting for Ruby hashes
 - Column alignment options (left, right, center)
-- Column filtering with `:only` option
-- Custom headers with `:headers` option
+- Column filtering with `only:` option
+- Custom headers with `headers:` option
 - Smart type formatting (booleans, nil, strings)
 - Preserves original column order
-- `TypedPrint.print` method for printing to stdout
-- `TypedPrint.table` method for returning formatted string
 - Zero dependencies

data/README.md

@@ -8,29 +8,29 @@ Beautiful, aligned table output for Ruby hashes and objects with zero dependenci
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Gem Downloads](https://img.shields.io/gem/dt/typed_print)](https://rubygems.org/gems/typed_print)
 
+![TypedPrint Demo](assets/demo.gif)
+
 ## Features
 
-- 🚀 Zero dependencies
+- 🚀 Zero runtime dependencies
 - 📊 Automatic column width calculation
 - 🎯 Smart type formatting (booleans, nil, strings)
 - 📐 Column alignment (left, right, center)
 - 🎨 Custom column headers
 - 🔍 Column filtering
 - 📝 Preserves original column order
+- 📄 Markdown table output (v0.2.0+)
+- 🌈 Optional color output via `pastel` gem (v0.3.0+)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'typed_print'
-```
+`gem 'typed_print'`
 
 Or install it yourself:
 
-```bash
-gem install typed_print
-```
+`gem install typed_print`
 
 ## Usage
 
@@ -48,72 +48,78 @@ TypedPrint.print(data)
 ```
 
 Output:
+
 ```
- Name  Score Active 
+Name  Score Active 
 ------+------+-------
 Alice   100 true   
 Bob      42 false  
 ```
 
-### Column Alignment
+### Markdown Format (NEW in v0.2.0)
+```ruby
+TypedPrint.print(data, format: :markdown)
+```
 
-Right-align specific columns:
+Output:
+```
+| Name  | Score | Active |
+|-------|-------|--------|
+| Alice | 100   | true   |
+| Bob   | 42    | false  |
+```
 
+### Column Alignment
 ```ruby
 TypedPrint.print(data, align: { score: :right })
 ```
 
 Output:
 ```
- Name  Score Active 
+Name  Score Active 
 ------+------+-------
 Alice   100 true   
-Bob      42 false  
+Bob      42 false
 ```
 
 ### Filter Columns
 
-Show only specific columns:
-
 ```ruby
 TypedPrint.print(data, only: [:name, :score])
 ```
 
 Output:
 ```
- Name  Score 
+Name  Score 
 ------+------
 Alice   100 
 Bob      42 
 ```
 
 ### Custom Headers
-
-Rename columns for display:
-
 ```ruby
 TypedPrint.print(data, headers: { name: "Username", score: "Points", active: "Status" })
 ```
 
 Output:
 ```
- Username Points Status 
+Username Points Status 
 ---------+------+-------
 Alice       100 true   
 Bob          42 false  
 ```
 
 ### Return String Instead of Printing
-
-Use `table` method to get the formatted string:
-
 ```ruby
 table_string = TypedPrint.table(data)
 puts table_string.upcase
-```
 
-### Working with Different Data Types
+# Markdown format
+markdown_string = TypedPrint.table(data, format: :markdown)
+File.write("table.md", markdown_string)
+````
 
+### Working with Different Data Types
 ```ruby
 mixed_data = [
   { name: "Product A", price: 29.99, in_stock: true, notes: nil },
@@ -125,25 +131,49 @@ TypedPrint.print(mixed_data)
 
 Output:
 ```
-   Name      Price In_stock Notes        
+Name      Price In_stock Notes        
 ----------+-------+---------+-------------
 Product A   29.99 true                  
 Product B   49.99 false    Limited edition
 ```
 
 ## API Reference
-
 `TypedPrint.print(data, options)` Prints the formatted table to stdout and returns `nil`.
 
+
 **Options:**
 - `align: Hash` - Column alignment (`:left`, `:right`, `:center`), defaults to `:left`
 - `only: Array` - Array of column symbols to display
 - `headers: Hash` - Custom headers for columns
+- `format: Symbol` - Output format (`:plain` or `:markdown`), defaults to `:plain`
+- `color: Boolean` - Auto color by type (headers cyan, numbers/true green, false red, nil gray), requires `pastel` gem
+- `colors: Hash` - Manual per-column color map (e.g. `{ name: :cyan, score: :green }`), requires `pastel` gem
 
 `TypedPrint.table(data, options)` returns the formatted table as a string.
 
 Same options as `print`.
 
+### Color Output (v0.3.0+)
+
+Color support is optional and requires the `pastel` gem. Add it to your Gemfile:
+
+```ruby
+gem 'pastel'
+```
+
+**Automatic coloring by type:**
+```ruby
+TypedPrint.print(data, color: true)
+# Headers → cyan, Integer/Float/true → green, false → red, nil → gray
+```
+
+**Manual per-column colors:**
+```ruby
+TypedPrint.print(data, colors: { name: :cyan, score: :green, active: :yellow })
+```
+
+Both `:plain` and `:markdown` formats support color. If `pastel` is not installed, color options are silently ignored and output is plain text.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.

data/assets/demo.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "typed_print"
+
+data = [
+  { name: "Alice",   score: 98,  active: true  },
+  { name: "Bob",     score: 74,  active: false },
+  { name: "Charlie", score: 61,  active: true  },
+  { name: "Diana",   score: 42,  active: false }
+]
+
+puts "# Basic table"
+TypedPrint.print(data)
+sleep 2
+
+puts "\n# Right-align score column"
+TypedPrint.print(data, align: { score: :right })
+sleep 2
+
+puts "\n# Filter columns"
+TypedPrint.print(data, only: [:name, :score])
+sleep 2
+
+puts "\n# Custom headers"
+TypedPrint.print(data, headers: { name: "Player", score: "Points", active: "Status" })
+sleep 2
+
+puts "\n# Markdown format"
+TypedPrint.print(data, format: :markdown)
+sleep 2
+
+puts "\n# Automatic colors"
+TypedPrint.print(data, color: true)
+sleep 2
+
+puts "\n# Manual colors"
+TypedPrint.print(data, colors: { name: :cyan, score: :green, active: :yellow })

data/assets/demo.tape

@@ -0,0 +1,14 @@
+Output assets/demo.gif
+
+Set FontSize 14
+Set Width 800
+Set Height 600
+Set Theme "Dracula"
+Set Shell "bash"
+Set TypingSpeed 40ms
+
+Sleep 1s
+Type "bundle exec ruby assets/demo.rb"
+Sleep 800ms
+Enter
+Sleep 18s

data/lib/typed_print/table.rb

@@ -1,46 +1,95 @@
 # frozen_string_literal: true
 
+begin
+  require "pastel"
+rescue LoadError
+  # Pastel not installed; color output silently disabled
+end
+
 module TypedPrint
   class Table
-    def initialize(data, alignments = {}, only_columns = nil, custom_headers = {})
+    def initialize(data, alignments = {}, only_columns = nil, custom_headers = {}, color: false, colors: nil)
       @data = data
       @alignments = alignments
       @only_columns = only_columns&.map(&:to_sym)
       @custom_headers = custom_headers.transform_keys(&:to_sym)
+      @color_auto = color
+      @colors = colors&.transform_keys(&:to_sym)
 
       @headers = determine_headers
     end
 
-    def render
+    def render(format = :plain)
+      if format == :markdown
+        render_markdown
+      else
+        render_plain
+      end
+    end
+
+    def render_plain
       return "" if @data.empty?
 
-      # Build rows
-      rows = @data.map { |row| @headers.map { |h| format_value(row[h]) } }
+      rows_plain = @data.map { |row| @headers.map { |h| format_value(row[h]) } }
+      header_strings_plain = @headers.map { |h| header_label(h) }
 
-      # Build header strings (with custom headers or capitalized defaults)
-      header_strings = @headers.map do |h|
-        if @custom_headers[h]
-          @custom_headers[h]
-        else
-          # Capitalize each word in the header
-          h.to_s.split('_').map(&:capitalize).join(' ')
+      column_widths = header_strings_plain.map(&:length)
+      rows_plain.each do |row|
+        row.each_with_index do |cell, i|
+          column_widths[i] = [column_widths[i], cell.length].max
         end
       end
 
-      # Calculate column widths
-      column_widths = header_strings.map(&:length)
-      rows.each do |row|
+      if color_mode?
+        header_color = @color_auto ? :cyan : nil
+        header_strings_display = header_strings_plain.map { |h| colorize(h, header_color) }
+        rows_display = @data.map { |row| @headers.map { |h| colorize_cell(h, row[h]) } }
+      else
+        header_strings_display = header_strings_plain
+        rows_display = rows_plain
+      end
+
+      output = []
+      output << format_row(header_strings_display, column_widths, :center, header_strings_plain)
+      output << separator(column_widths)
+      rows_plain.each_with_index do |plain_row, ri|
+        output << format_row(rows_display[ri], column_widths, nil, plain_row)
+      end
+
+      output.join("\n")
+    end
+
+    def render_markdown
+      return "" if @data.empty?
+
+      rows_plain = @data.map { |row| @headers.map { |h| format_value(row[h]) } }
+      header_strings_plain = @headers.map { |h| header_label(h) }
+
+      column_widths = header_strings_plain.map(&:length)
+      rows_plain.each do |row|
         row.each_with_index do |cell, i|
           column_widths[i] = [column_widths[i], cell.length].max
         end
       end
 
-      # Build output
+      if color_mode?
+        header_color = @color_auto ? :cyan : nil
+        header_strings_display = header_strings_plain.map { |h| colorize(h, header_color) }
+        rows_display = @data.map { |row| @headers.map { |h| colorize_cell(h, row[h]) } }
+      else
+        header_strings_display = header_strings_plain
+        rows_display = rows_plain
+      end
+
       output = []
-      output << format_row(header_strings, column_widths, :center)
-      output << separator(column_widths)
-      rows.each do |row|
-        output << format_row(row, column_widths)
+      output << "| " + header_strings_display.each_with_index.map { |h, i|
+        pad_right(h, header_strings_plain[i], column_widths[i])
+      }.join(" | ") + " |"
+      output << "|" + column_widths.map { |w| "-" * (w + 2) }.join("|") + "|"
+      rows_plain.each_with_index do |plain_row, ri|
+        output << "| " + rows_display[ri].each_with_index.map { |cell, i|
+          pad_right(cell, plain_row[i], column_widths[i])
+        }.join(" | ") + " |"
       end
 
       output.join("\n")
@@ -57,25 +106,64 @@ module TypedPrint
       end
     end
 
+    def header_label(h)
+      if @custom_headers[h]
+        @custom_headers[h]
+      else
+        h.to_s.split("_").map(&:capitalize).join(" ")
+      end
+    end
+
+    def color_mode?
+      @color_auto || (@colors && !@colors.empty?)
+    end
+
+    def colorize(text, color)
+      return text unless color && defined?(Pastel)
+      @pastel ||= Pastel.new
+      @pastel.send(color, text)
+    rescue
+      text
+    end
+
+    def colorize_cell(header_key, original_value)
+      plain = format_value(original_value)
+      color = cell_color(header_key, original_value)
+      colorize(plain, color)
+    end
+
+    def cell_color(header_key, value)
+      if @colors
+        @colors[header_key]
+      elsif @color_auto
+        auto_color(value)
+      end
+    end
+
+    def auto_color(value)
+      case value
+      when Integer, Float then :green
+      when true then :green
+      when false then :red
+      when nil then :bright_black
+      end
+    end
+
     def determine_headers
       all_keys = @data.flat_map(&:keys).uniq
 
       if @only_columns
-        # Only include specified columns, in the order specified
         @only_columns.select { |key| all_keys.include?(key) }
       else
-        # Preserve the order from the first hash, but ensure all keys are included
         first_item_keys = @data.first.keys
-        # Then add any additional keys from other items that weren't in the first
         first_item_keys + (all_keys - first_item_keys)
       end
     end
 
-    def format_row(cells, widths, alignment_override = nil)
+    def format_row(cells, widths, alignment_override = nil, plain_cells = nil)
       cells.each_with_index.map do |cell, i|
+        plain_cell = plain_cells ? plain_cells[i] : cell
         width = widths[i]
-
-        # Determine alignment - need to use the header key, not the cell value
         header_key = @headers[i]
 
         align = if alignment_override
@@ -86,17 +174,25 @@ module TypedPrint
           :left
         end
 
+        padding = width - plain_cell.length
+
         case align
         when :right
-          cell.rjust(width)
+          " " * padding + cell
         when :center
-          cell.center(width)
-        else # :left
-          cell.ljust(width)
+          left_pad = padding / 2
+          right_pad = padding - left_pad
+          " " * left_pad + cell + " " * right_pad
+        else
+          cell + " " * padding
         end
       end.join(" ")
     end
 
+    def pad_right(colored_text, plain_text, width)
+      colored_text + " " * (width - plain_text.length)
+    end
+
     def separator(widths)
       widths.map { |w| "-" * w }.join("-+-")
     end

data/lib/typed_print/version.rb

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

data/lib/typed_print.rb

@@ -3,17 +3,14 @@
 require "typed_print/version"
 require "typed_print/table"
 
-require "typed_print/version"
-require "typed_print/table"
-
 module TypedPrint
-  def self.print(data, align: {}, only: nil, headers: {})
-    puts table(data, align: align, only: only, headers: headers)
+  def self.print(data, align: {}, only: nil, headers: {}, format: :plain, color: false, colors: nil)
+    puts table(data, align: align, only: only, headers: headers, format: format, color: color, colors: colors)
     nil
   end
 
-  def self.table(data, align: {}, only: nil, headers: {})
-    table_obj = TypedPrint::Table.new(data, align, only, headers)
-    table_obj.render
+  def self.table(data, align: {}, only: nil, headers: {}, format: :plain, color: false, colors: nil)
+    table_obj = TypedPrint::Table.new(data, align, only, headers, color: color, colors: colors)
+    table_obj.render(format)
   end
 end

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: typed_print
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ender Ahmet Yurt
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: TypedPrint provides zero-dependency, beautifully formatted table output
   for Ruby data structures with automatic column sizing, alignment options, custom
   headers, and column filtering.
@@ -23,6 +37,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/demo.gif
+- assets/demo.rb
+- assets/demo.tape
 - lib/typed_print.rb
 - lib/typed_print/table.rb
 - lib/typed_print/version.rb
@@ -49,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Beautiful, aligned table output for Ruby hashes and objects
 test_files: []