visual_array 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd21265c03d6ce6703f568a354c3138f64d497c72193f73562f873ccdfa49cf1
+  data.tar.gz: 5665bf958cc7e1d0ea7f7d7e0d36ad79b561c69719c64d496bec2712c79b819d
+SHA512:
+  metadata.gz: 1a76ecda7711c46fb1bcdc837313ac5844b4d77c250f2b79a9631e5c5fc9d680c38fe15da23fb1410b30c61d7eabf83b76ee20bd860859df209744a6e0c786ee
+  data.tar.gz: 19981713790f9e9f4c6fef2e3926b10d64183c514f60621a89bb98a58f7361ed6110ee75f9e47274ca52a1bcb07515a94e60f28170e15a531363c74ff8260ba5

data/README.md

@@ -0,0 +1,121 @@
+# VisualArray
+
+## Description
+
+**VisualArray** is a Ruby gem that displays arrays in a structured, visually appealing tabular format. It supports **1D, 2D, and multi-dimensional arrays** with options for customizing text **color**.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```bash
+bundle add visual_array
+```
+
+Or install it manually:
+
+```bash
+gem install visual_array
+```
+
+## Usage
+
+### Basic Example
+
+```ruby
+require 'visual_array'
+
+VisualArray.display([1, 2, 3, 4])
+```
+
+**Output:**
+```
++---+---+---+---+
+| 1 | 2 | 3 | 4 |
++---+---+---+---+
+```
+
+### 2D Array Example
+
+```ruby
+VisualArray.display([
+  [1, 2],
+  [3, 4]
+])
+```
+
+**Output:**
+```
++-----+-----+
+|  1  |  2  |
+|  3  |  4  |
++-----+-----+
+```
+
+### Multi-Dimensional Array Example
+
+```ruby
+VisualArray.display([[[1, 2], [3, 4]], [[5, 6], [7, 8]]])
+```
+
+**Output:**
+```
+Dimension 1, Index 0:
++-----+-----+
+|  1  |  2  |
+|  3  |  4  |
++-----+-----+
+
+Dimension 1, Index 1:
++-----+-----+
+|  5  |  6  |
+|  7  |  8  |
++-----+-----+
+```
+
+### Customizing Color
+
+You can pass optional `color` parameter:
+
+```ruby
+VisualArray.display(
+  [[[1, 2], [3, 4]], [[5, 6], [7, 8]]],
+  color: 'blue'
+)
+```
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+bin/setup
+```
+
+to install dependencies. Use `bin/console` for an interactive session.
+
+To install this gem locally:
+
+```bash
+bundle exec rake install
+```
+
+To release a new version:
+
+1. Update the version in `version.rb`.
+2. Run:
+
+```bash
+bundle exec rake release
+```
+
+This will create a git tag, push commits, and publish the gem to [RubyGems](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome at [GitHub](https://github.com/chandu89/visual_array).
+
+## License
+
+This project is available under the [MIT License](LICENSE.txt).
+

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/visual_array/version.rb

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

data/lib/visual_array.rb

@@ -0,0 +1,57 @@
+require 'terminal-table'
+require 'rainbow'
+
+module VisualArray
+  class Error < StandardError; end
+
+  class << self
+    def display(array, color: "green")
+      raise Error, "Input must be an array" unless array.is_a?(Array)
+
+      dimensions = array_dimensions(array)
+
+      case dimensions
+      when 1
+        display_1d(array, color)
+      when 2
+        display_2d(array, color)
+      else
+        display_multi_d(array, color)
+      end
+    end
+
+    private
+
+    def array_dimensions(array)
+      return 0 unless array.is_a?(Array)
+      1 + array.map { |sub| array_dimensions(sub) }.max.to_i
+    end
+
+    def display_1d(array, color)
+      table = Terminal::Table.new do |t|
+        t.headings = [Rainbow("Index").cyan, Rainbow("Value").yellow]
+        array.each_with_index { |val, i| t.add_row([i, Rainbow(val).send(color)]) }
+      end
+      puts table
+    end
+
+    def display_2d(array, color)
+      table = Terminal::Table.new do |t|
+        column_headers = [" "] + (0...array.first.size).map { |i| Rainbow("Col #{i}").cyan }
+        t.add_row(column_headers)
+        t.add_separator
+        array.each_with_index do |row, i|
+          t.add_row([Rainbow("Row #{i}").yellow] + row.map { |val| Rainbow(val).send(color) })
+        end
+      end
+      puts table
+    end
+
+    def display_multi_d(array, color, depth = 0)
+      array.each_with_index do |sub_array, index|
+        puts Rainbow("\nDimension #{depth + 1}, Index #{index}:\n").magenta.bright
+        display(sub_array, color: color)
+      end
+    end
+  end
+end

data/sig/visual_array.rbs

@@ -0,0 +1,4 @@
+module VisualArray
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: visual_array
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- chandanchoubey
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-01 00:00:00.000000000 Z
+dependencies: []
+description: VisualArray provides an easy way to represent and display multi-dimensional
+  arrays in a visually appealing tabular format, making data analysis and debugging
+  more intuitive.
+email:
+- vibhatsu.choubey@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/visual_array.rb
+- lib/visual_array/version.rb
+- sig/visual_array.rbs
+homepage: https://github.com/chandu89/visual_array
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/chandu89/visual_array
+  source_code_uri: https://github.com/chandu89/visual_array
+  changelog_uri: https://github.com/chandu89/visual_array/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: A Ruby gem for visualizing multi-dimensional arrays in a structured tabular
+  format.
+test_files: []