graphina 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 81e19cd89c158ccc817c1f9100ddd3b6d61e2b9b30b16cec62b5a59390d9bf62
+  data.tar.gz: 567f7d0ddb56e0de0b3393eb9361d17f64c4fc68f468034a83b34a29c0d1f69a
+SHA512:
+  metadata.gz: 5f7b448e74eea737afd046b14286bcb14ef1a7b4aa7ff7123082ebb5593144fcfa71db6dff0aad8dacbe5351bd4b06c827befc8f7f031e93ab43fe9c93119051
+  data.tar.gz: 76d20ada5fb7d8e00f2317c51e21d25dedd31e74893d50d6601e9539239836d75296d390e745664dcf7c439360e98cb86c1ac93e376c9d09798eda504a17afd1

data/Gemfile

@@ -0,0 +1,5 @@
+# vim: set filetype=ruby et sw=2 ts=2:
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,8 @@
+Copyright Florian Frank
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,128 @@
+# Graphina 📊📈
+
+## Description
+
+A Ruby gem for creating terminal-based data visualizations with real-time
+graphical displays using Unicode characters and ANSI styling 🎨📊
+
+## Documentation
+
+Complete API documentation is available at: [GitHub.io](https://flori.github.io/graphina/)
+
+
+## Features
+
+- **Real-time Data Visualization**: Create dynamic, continuously updating
+  graphs in terminal environments
+- **Unicode Graphics**: Utilize Unicode block characters for high-resolution
+  terminal graphics (2px vertical resolution)
+- **ANSI Color Support**: Full color management with 256-color and true-color
+  (24-bit) support
+- **Multiple Display Modes**: Single and double resolution modes for different
+  terminal capabilities
+- **Flexible Data Sources**: Support for custom data providers via Proc objects
+- **Multiple Formatting Options**: Built-in formatters for bytes, hertz,
+  celsius, and percentage values
+- **Efficient Rendering**: Delta-based updates to minimize terminal I/O
+  overhead
+- **Signal Handling**: Graceful shutdown and terminal resize handling
+- **String-based Color Derivation**: Automatically derive consistent colors
+  from titles and labels
+
+## Installation
+
+Add this gem to your Gemfile:
+
+```ruby
+gem 'graphina'
+```
+
+And install it using Bundler:
+
+```bash
+bundle install
+```
+
+Or install the gem directly:
+
+```bash
+gem install graphina
+```
+
+## Usage
+
+### 1. Basic Usage with Random Data
+
+```bash
+# Simple usage with random data
+graphina
+```
+
+### 2. Custom Title and Text Colors
+
+```bash
+# Custom title with specific colors
+graphina -t "CPU Usage (faked)" -f blue -b black
+```
+
+### 3. More complex CPU Usage Monitoring example
+
+```bash
+# Monitor CPU usage in real-time
+graphina -t 'CPU Usage' -n 1 -F as_percent -e "top -l 1 -n 0 | grep 'CPU usage' | awk '{print \$3+\$5}' | sed 's/%//'"
+```
+
+### 4. Custom Data Source
+
+```ruby
+# Using the library directly in Ruby code
+require 'graphina'
+
+graph = Graphina::Graph.new(
+  title: 'CPU Usage',
+  value: ->(i) { rand(100) },
+  format_value: :as_percent,
+  sleep: 1,
+  color: 33
+)
+graph.start
+```
+
+### 5. Custom Command with External Data
+
+```ruby
+# Using external command for data
+graph = Graphina::Graph.new(
+  title: 'Temperature',
+  value: ->(i) { `sensors | grep 'Tctl' | awk '{print \$2}'`.to_f },
+  format_value: :as_celsius,
+  sleep: 2
+)
+graph.start
+```
+
+## Command Line Options
+
+```
+Usage: graphina [OPTIONS]
+
+  OPTIONS are
+
+    -t TITLE      Title for the graph (default: 'Data')
+    -n SECONDS    Update interval in seconds (default: 5)
+    -r MODE       Resolution mode (:single or :double, default: :double)
+    -f COLOR      Foreground color (default: :white)
+    -b COLOR      Background color (default: :black)
+    -c COLOR      Primary color (default: derived from title)
+    -C COLOR      Secondary color (default: derived from primary)
+    -F FORMAT     Format function (:as_bytes, :as_hertz, :as_celsius, :as_percent, :as_default, default: :as_default)
+    -h            this help
+```
+
+## Author
+
+[Florian Frank](mailto:flori@ping.de) 🧑‍💻
+
+## License
+
+[MIT License](./LICENSE) 📄

data/Rakefile

@@ -0,0 +1,41 @@
+# vim: set filetype=ruby et sw=2 ts=2:
+
+require 'gem_hadar'
+
+GemHadar do
+  name        'graphina'
+  module_type :module
+  author      'Florian Frank'
+  email       'flori@ping.de'
+  homepage    "https://github.com/flori/#{name}"
+  summary <<~EOT
+    Gem for creating terminal-based data visualizations with real-time
+    graphical displays using Unicode characters and ANSI styling.
+  EOT
+  description <<~EOT
+    Gem that provides terminal-based data visualization capabilities, enabling
+    developers to create dynamic, real-time graphical displays of numerical data
+    directly within terminal environments using Unicode characters and ANSI
+    styling.
+  EOT
+  test_dir    'spec'
+  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.AppleDouble', '.bundle',
+    '.yardoc', 'tags', 'doc'
+  package_ignore '.gitignore', '.contexts', '.github'
+
+  readme      'README.md'
+
+  github_workflows(
+    'static.yml' => {}
+  )
+
+  required_ruby_version  '>= 3.1'
+
+  executables << 'graphina'
+
+  dependency  'tins',             '~> 1.45'
+  dependency  'term-ansicolor',   '~> 1.11'
+  development_dependency 'debug', '~> 1.0'
+
+  licenses << 'MIT'
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/graphina

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'graphina'
+require 'term/ansicolor'
+include Tins::GO
+require 'shellwords'
+
+def usage
+  puts <<~EOT
+  Usage: #{File.basename($0)} [OPTIONS]
+
+    OPTIONS are
+
+      -t TITLE      Title for the graph (default: 'Data')
+      -n SECONDS    Update interval in seconds (default: 5)
+      -r MODE       Resolution mode (:single or :double, default: :double)
+      -f COLOR      Foreground color (default: :white)
+      -b COLOR      Background color (default: :black)
+      -c COLOR      Primary color (default: derived from title)
+      -C COLOR      Secondary color (default: derived from primary)
+      -F FORMAT     Format function (:as_bytes, :as_hertz, :as_celsius, :as_percent, :as_default, default: :as_default)
+      -h            this help
+
+    Examples:
+
+      graphina                              # Basic usage with random data
+      graphina -t "CPU Usage"               # Custom title
+      graphina -t "Memory" -f blue -b black # Custom colors
+      graphina -t "Network" -r single -n 2  # Single resolution, 2 second updates
+      # Full example
+      graphina -t 'CPU Usage' -n 1 -F as_percent -e "top -l 1 -n 0 | grep 'CPU usage' | awk '{print \\$3+\\$5}' | sed 's/%//'"
+
+  EOT
+  0
+end
+
+$opts = go 't:n:r:f:b:c:C:F:e:h', defaults: {
+  ?t => 'Data',
+  ?n => 5,
+  ?r => :double,
+  ?f => :white,
+  ?b => :black,
+  ?F => :as_default,
+}
+
+$opts[?h] and exit usage
+
+sleep_duration = [ 0.01, $opts[?n].to_f ].max
+format_value   = $opts[?F].to_sym
+value = if $opts[?e]
+          -> _ { `#{$opts[?e]}`.to_f }
+        else
+          -> _ { rand(100) }
+        end
+graph = Graphina::Graph.new(
+  title:            $opts[?t],
+  sleep:            sleep_duration,
+  value:,
+  true_coloring:    ENV['COLORTERM'] =~ /\A(truecolor|24bit)\z/,
+  color:            $opts[?c],
+  color_secondary:  $opts[?C],
+  foreground_color: $opts[?f],
+  background_color: $opts[?b],
+  resolution:       $opts[?r],
+  format_value:
+)
+graph.start

data/graphina.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+# stub: graphina 0.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "graphina".freeze
+  s.version = "0.0.0".freeze
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Florian Frank".freeze]
+  s.date = "1980-01-02"
+  s.description = "Gem that provides terminal-based data visualization capabilities, enabling\ndevelopers to create dynamic, real-time graphical displays of numerical data\ndirectly within terminal environments using Unicode characters and ANSI\nstyling.\n".freeze
+  s.email = "flori@ping.de".freeze
+  s.executables = ["graphina".freeze]
+  s.extra_rdoc_files = ["README.md".freeze, "lib/graphina.rb".freeze, "lib/graphina/graph.rb".freeze, "lib/graphina/graph/display.rb".freeze, "lib/graphina/graph/display/cell.rb".freeze, "lib/graphina/graph/formatters.rb".freeze, "lib/graphina/version.rb".freeze]
+  s.files = ["Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/graphina".freeze, "graphina.gemspec".freeze, "lib/graphina.rb".freeze, "lib/graphina/graph.rb".freeze, "lib/graphina/graph/display.rb".freeze, "lib/graphina/graph/display/cell.rb".freeze, "lib/graphina/graph/formatters.rb".freeze, "lib/graphina/version.rb".freeze]
+  s.homepage = "https://github.com/flori/graphina".freeze
+  s.licenses = ["MIT".freeze]
+  s.rdoc_options = ["--title".freeze, "Graphina - Gem for creating terminal-based data visualizations with real-time\ngraphical displays using Unicode characters and ANSI styling.\n".freeze, "--main".freeze, "README.md".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 3.1".freeze)
+  s.rubygems_version = "3.7.2".freeze
+  s.summary = "Gem for creating terminal-based data visualizations with real-time graphical displays using Unicode characters and ANSI styling.".freeze
+
+  s.specification_version = 4
+
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.8".freeze])
+  s.add_development_dependency(%q<debug>.freeze, ["~> 1.0".freeze])
+  s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.45".freeze])
+  s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.11".freeze])
+end

data/lib/graphina/graph/display/cell.rb

@@ -0,0 +1,48 @@
+class Graphina::Graph::Display
+  # A cell representation for terminal display with character, color,
+  # background color, and styling attributes
+  #
+  # The Cell class encapsulates the properties of a single character cell in
+  # a terminal display, including its visual characteristics such as the
+  # displayed character, text color, background color, and styling
+  # attributes. It provides methods to compare cells and convert them to
+  # their string representation with ANSI escape codes for terminal
+  # rendering.
+  class Cell < Struct.new(:char, :color, :on_color, :styles)
+    # The == method compares two Cell objects for equality by their internal
+    # array representation
+    #
+    # This method checks if the current Cell instance is equal to another
+    # Cell instance by comparing their underlying array representations
+    # returned by to_a
+    #
+    # @param other [ Graphina::Graph::Display::Cell ] the other Cell object to
+    #   compare against
+    #
+    # @return [ Boolean ] true if both cells have identical char, color,
+    #   on_color, and styles values, false otherwise
+    def ==(other)
+      to_a == other.to_a
+    end
+
+    # The to_s method converts a Cell object into its string representation
+    # with ANSI styling
+    #
+    # This method constructs a formatted string that includes the cell's
+    # character along with its color, background color, and text style
+    # attributes using ANSI escape sequences. The resulting string is
+    # suitable for display in terminal environments that support ANSI colors.
+    #
+    # @return [ String ] a formatted string containing the cell's visual
+    #   representation with appropriate ANSI styling codes for terminal
+    #   rendering
+    def to_s
+      result = +''
+      result << ANSI.color(color)
+      result << ANSI.on_color(on_color)
+      styles.each { |s| result << ANSI.send(s) }
+      result << char
+      result << ANSI.reset
+    end
+  end
+end