graphina 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9ce4b89d643c5eed5ce37e1efde518486ebcef9a7149909a15d835fe57f929e
-  data.tar.gz: 500a021e64247ab1058c6b1e69c09ae5575c23b7a703a8665213c652cfc64a38
+  metadata.gz: f80b47eb1b37298a4d0af81ff87040dfbedfc763d83de640875c4fce56e9d599
+  data.tar.gz: 13a399a5f87f2ec2b0b19c36411eaf8799f2b1013a40e4a63f82a9ef33cb6e0d
 SHA512:
-  metadata.gz: 7e8551f96ff1ee7a223ebc04183944a947afe402fd6d56c6d488504465510495c974eae9697af0a683539f384b5ea7de86d915a40a1837495aed1a8f36a9c994
-  data.tar.gz: 84af355ecdb883121f8d7c66c7cecc16ff87fcc1bc6eb694565a252ecc610f5816e5f006a7e535437a84cbc5381a1db9238872af9f8b0efdd5cff1425128617b
+  metadata.gz: 8eb5ebef9f82cfc6b2321ea4e288bd41703cd4a69fee37e7d1ffc27271e5af65d0698ee4862a17027fc1a5adfa0cd6249704effe656f39ec3f25fa3e997bf5ee
+  data.tar.gz: bb3513cdd086d4eb07ebf4f3999e4380522c92f533f0fc17319010127d6f8c847cf309271d6e936112c613a6aabb6e472e62cb01ebe8ee180be8a201e3bc01c4

data/README.md

@@ -54,12 +54,47 @@ Or install the gem directly:
 gem install graphina
 ```
 
+## Panel Configuration Setup
+
+Graphina now supports predefined panel configurations. You can create a
+`panels.yml` file in your configuration directory
+(`"$XDG_CONFIG_HOME/graphina"`, usually `~/.config/graphina/panels.yml`) to
+define reusable panel setups.
+
+To install one of the included defaults you can try
+```bash
+graphina -S default
+```
+
+which attempts to infer a default config for your platform and install it.
+
+Currently these platforms are included:
+
+  - MacOS x86 64 see [x86_64-darwin](lib/graphina/panel/defaults/x86_64-darwin.yml).
+  - MacOS ARM 64 see [arm64-darwin](lib/graphina/panel/defaults/arm64-darwin.yml).
+  - Linux x86 64 see [x86_64-linux](lib/graphina/panel/defaults/x86_64-linux.yml).
+
+These can be installed eplicitly via:
+```bash
+graphina -S x86_64-darwin
+```
+
+Then to use a specific panel:
+```bash
+graphina -P cpu_usage_percentage
+```
+
+To see all available panels:
+```bash
+graphina
+```
+
 ## Usage
 
 ### 1. Basic Usage with Random Data
 
 ```bash
-# Simple usage with random data
+# Simple usage with random data or interactive panel selection
 graphina
 ```
 
@@ -74,19 +109,22 @@ graphina -t "CPU Usage (faked)" -f blue -b black
 
 ```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/%//'"
+graphina -t 'CPU Usage' -n 1 -F as_percent -e "top -l 1 -n 0 | awk '/^CPU usage/ {print \$3 + \$5}'"
 ```
 
 ### 4. Using Predefined Panels
 
 ```bash
 # Use a predefined panel configuration
-graphina -P cpu
+graphina -P cpu_usage_percentage
 
 # Interactive panel selection
 graphina
 ```
 
+See below under **Panel Configuration** how to setup these panel configurations
+on your system.
+
 ### 5. Custom Data Source
 
 ```ruby
@@ -109,84 +147,13 @@ graph.start
 # Using external command for data
 graph = Graphina::Graph.new(
   title: 'Temperature',
-  value: ->(i) { `sensors | grep 'Tctl' | awk '{print \$2}'`.to_f },
+  value: ->(i) { `sensors | awk '/^Tctl/ {print \$2}'`.to_f },
   format_value: :as_celsius,
   sleep: 2
 )
 graph.start
 ```
 
-## Panel Configuration
-
-Graphina now supports predefined panel configurations. Create a `panels.yml`
-file in your configuration directory (`"$XDG_CONFIG_HOME/graphina"`, usually
-`~/.config/graphina/panels.yml`) to define reusable panel setups.
-
-Example for MacOS:
-
-```yaml
-cpu_usage_percentage:
-  title: "CPU Usage (%)"
-  interval: 1
-  command: "top -l 1 -n 0 | awk '/^CPU usage:/ { printf \"%.1f\", $3 + $5 }'"
-  format_value: as_percent
-  color: '#ff5f00'
-memory_usage:
-  title: "Memory Usage"
-  interval: 1
-  command: "free -b | awk '/^Mem:/ { print $4 }'"
-  format_value: as_bytes
-  color: '#00d787'
-  color_secondary: '#00ffd7'
-memory_usage_percentage:
-  title: "Memory Usage (%)"
-  interval: 1
-  command: "free -b | awk '/^Mem:/ { printf \"%.1f\", 100 * $4 / $2 }'"
-  format_value: as_percent
-  color: '#87d700'
-  color_secondary: '#d7ff00'
-cpu_temperature:
-  title: "CPU Temperature ℃ "
-  interval: 1
-  command: "osx-cpu-temp -C | tr -dc '0-9.'"
-  format_value: as_celsius
-  color: '#aa0000'
-```
-
-Example for Linux:
-
-```yaml
-cpu:
-  title: "CPU Usage (%)"
-  interval: 1
-  command: "top -b -n 1 | awk '/^%Cpu\\(s\\)/ { print $2 + $4 + $6 }'"
-  format_value: as_percent
-  color: '#ff5f00'
-memory:
-  title: "Memory Usage"
-  interval: 1
-  command: "free -b | awk '/^Mem:/ { print $3 }'"
-  format_value: as_bytes
-  color: '#87d700'
-  color_secondary: '#d7ff00'
-temperature:
-  title: "CPU Temperature ℃ "
-  interval: 1
-  command: "sensors | awk '/^Tctl:/ { print $2 }' | tr -dc '0-9.'"
-  format_value: as_celsius
-  color: '#ff0000'
-```
-
-To use a specific panel:
-```bash
-graphina -P cpu
-```
-
-To see all available panels:
-```bash
-graphina
-```
-
 ## Command Line Options
 
 ```
@@ -202,8 +169,9 @@ Usage: graphina [OPTIONS]
     -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)
+    -P PANEL      Use predefined panel configuration (default: interactive selection)
+    -S CONFIG     Setup panel config (default infers from OS)
     -e COMMAND    External command to execute for data values (default: random data)
-    -P PANEL      Panel name to use from configuration (default: interactive selection)
     -h            this help
 ```
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.3.0

data/bin/graphina

@@ -20,6 +20,7 @@ def usage
       -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)
       -P PANEL      Use predefined panel configuration (default: interactive selection)
+      -S CONFIG     Setup panel config (default infers from OS)
       -e COMMAND    External command to execute for data values (default: random data)
       -h            this help
 
@@ -37,9 +38,14 @@ def usage
   0
 end
 
-$opts = go 't:n:r:f:b:c:C:F:e:P:h'
+$opts = go 't:n:r:f:b:c:C:F:e:P:S:h'
 
 $opts[?h] and exit usage
+if $opts[?S]
+  setup = Graphina::Setup.new(default_panels_name: $opts[?S])
+  setup.install_default_panels
+  exit
+end
 
 panel = Graphina::Panel.new
 case

data/graphina.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: graphina 0.1.1 ruby lib
+# stub: graphina 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "graphina".freeze
-  s.version = "0.1.1".freeze
+  s.version = "0.3.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   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/graphina_config.rb".freeze, "lib/graphina/panel.rb".freeze, "lib/graphina/panel/chooser.rb".freeze, "lib/graphina/version.rb".freeze]
-  s.files = [".utilsrc".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/graphina".freeze, "graphina.gemspec".freeze, "img/graphina.png".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/graphina_config.rb".freeze, "lib/graphina/panel.rb".freeze, "lib/graphina/panel/chooser.rb".freeze, "lib/graphina/version.rb".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/graphina_config.rb".freeze, "lib/graphina/panel.rb".freeze, "lib/graphina/panel/chooser.rb".freeze, "lib/graphina/setup.rb".freeze, "lib/graphina/version.rb".freeze]
+  s.files = [".utilsrc".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/graphina".freeze, "graphina.gemspec".freeze, "img/graphina.png".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/graphina_config.rb".freeze, "lib/graphina/panel.rb".freeze, "lib/graphina/panel/chooser.rb".freeze, "lib/graphina/panel/defaults/arm64-darwin.yml".freeze, "lib/graphina/panel/defaults/x86_64-darwin.yml".freeze, "lib/graphina/panel/defaults/x86_64-linux.yml".freeze, "lib/graphina/setup.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]

data/lib/graphina/graph/formatters.rb

@@ -50,7 +50,10 @@ class Graphina::Graph
     #
     # @return [ String ] the formatted frequency representation with unit suffix
     def as_hertz(value)
-      Tins::Unit.format(value, prefix: :uc, format: '%.3f%U', unit: 'Hz')
+      prefix = [
+        '', 'K', 'M', 'G', 'T', 'P', 'E', 'Z', 'Y',
+      ].each_with_index.map { |n, i| Tins::Unit::Prefix.new(n.freeze, 1000, 1000 ** i, false) }.freeze
+      Tins::Unit.format(value, prefix:, format: '%.3f%U', unit: 'Hz')
     end
 
     # The as_celsius method formats a temperature value with a degree symbol

data/lib/graphina/panel/defaults/arm64-darwin.yml

@@ -0,0 +1,35 @@
+cpu_usage_percentage:
+  title: "CPU Usage %"
+  interval: 1
+  command: |
+    top -l 1 -n 0 | awk '/^CPU usage:/ { printf "%.1f", $3 + $5 }'
+  format_value: as_percent
+  color: '#fe8019'
+cpu_temperature:
+  title: "CPU Temperature ℃ "
+  interval: 1
+  command: |
+    smctemp -c
+  format_value: as_celsius
+  color: '#fb4934'
+cpu_clock_average:
+  title: "CPU Clock Speed Hz"
+  interval: 1
+  command: |
+    sudo powermetrics --show-usage-summary -s cpu_power -i 100 -n 9 | awk '/CPU [0-9]+ frequency: / { count++; sum += $4 } END { if (count > 0) { print 1000000 * sum / count } else { print 0 } }'
+  format_value: as_hertz
+  color: '#b8bb26'
+memory_usage:
+  title: "Memory Usage"
+  interval: 1
+  command: |
+    free -b | awk '/^Mem:/ { print $4 }'
+  format_value: as_bytes
+  color: '#689d6a'
+memory_usage_percentage:
+  title: "Memory Usage %"
+  interval: 1
+  command: |
+    free -b | awk '/^Mem:/ { printf "%.1f", 100 * $4 / $2 }'
+  format_value: as_percent
+  color: '#689d6a'

data/lib/graphina/panel/defaults/x86_64-darwin.yml

@@ -0,0 +1,35 @@
+cpu_usage_percentage:
+  title: "CPU Usage %"
+  interval: 1
+  command: |
+    top -l 1 -n 0 | awk '/^CPU usage:/ { printf "%.1f", $3 + $5 }'
+  format_value: as_percent
+  color: '#fe8019'
+cpu_temperature:
+  title: "CPU Temperature ℃ "
+  interval: 1
+  command: |
+    osx-cpu-temp -C | tr -dc '0-9.'
+  format_value: as_celsius
+  color: '#fb4934'
+cpu_clock_average:
+  title: "CPU Clock Speed Hz"
+  interval: 1
+  command: |
+    sudo powermetrics --show-usage-summary -s cpu_power -i 100 -n 9 | awk '/CPU Average frequency as fraction of nominal: / { count++; gsub(/[^0-9.]/, "", $9); sum += $9 } END { if (count > 0) { print 1000000 * sum / count } else { print 0 } }'
+  format_value: as_hertz
+  color: '#b8bb26'
+memory_usage:
+  title: "Memory Usage"
+  interval: 1
+  command: |
+    free -b | awk '/^Mem:/ { print $4 }'
+  format_value: as_bytes
+  color: '#689d6a'
+memory_usage_percentage:
+  title: "Memory Usage %"
+  interval: 1
+  command: |
+    free -b | awk '/^Mem:/ { printf "%.1f", 100 * $4 / $2 }'
+  format_value: as_percent
+  color: '#689d6a'

data/lib/graphina/panel/defaults/x86_64-linux.yml

@@ -0,0 +1,35 @@
+cpu_usage_percentage:
+  title: "CPU Usage %"
+  interval: 1
+  command: |
+    top -b -n 1 | awk '/^%Cpu\(s\)/ { print $2 + $4 + $6 }'
+  format_value: as_percent
+  color: '#fe8019'
+cpu_temperature:
+  title: "CPU Temperature ℃ "
+  interval: 1
+  command: |
+    sensors | awk '/^Tctl:/ { print $2 }' | tr -dc '0-9.'
+  format_value: as_celsius
+  color: '#fb4934'
+cpu_clock_average:
+  title: "CPU Clock Speed Hz"
+  interval: 1
+  command: |
+    awk '/cpu MHz/ {sum += $4; count++} END {if (count > 0) print 1000000 * sum/count}' /proc/cpuinfo
+  format_value: as_hertz
+  color: '#b8bb26'
+memory_usage:
+  title: "Memory Usage"
+  interval: 1
+  command: |
+    free -b | awk '/^Mem:/ { print $3 }'
+  format_value: as_bytes
+  color: '#689d6a'
+memory_usage_percentage:
+  title: "Memory Usage %"
+  interval: 1
+  command: |
+    free -b | awk '/^Mem:/ { printf "%.1f", 100 * $3 / $2 }'
+  format_value: as_percent
+  color: '#689d6a'

data/lib/graphina/setup.rb

@@ -0,0 +1,112 @@
+require 'fileutils'
+
+# A class that handles the setup and configuration of Graphina
+#
+# The Setup class provides functionality for installing default panel
+# configurations into the user's configuration directory. It manages the
+# detection of platform-specific default configurations and facilitates the
+# copying of these configurations to the appropriate location for use with the
+# Graphina application
+#
+# @example
+#   setup = Graphina::Setup.new(default_panels_name: 'c64-linux')
+#   setup.install_default_panels
+class Graphina::Setup
+  include FileUtils::Verbose
+
+  # The initialize method sets up a Setup instance with the specified default
+  # panel name
+  #
+  # This method configures a new setup object with a default panel name,
+  # handling the special case where the name is 'default' by setting it to nil
+  # instead
+  #
+  # @param default_panels_name [ String ] the name of the default panels to use
+  #
+  # @return [ Graphina::Setup ] returns the initialized Setup instance
+  def initialize(default_panels_name:)
+    default_panels_name == 'default' and default_panels_name = nil
+    @default_panels_name = default_panels_name
+  end
+
+  # The infer_default_panels_path_from_platform method attempts to determine
+  # the appropriate default panel configuration file path based on the current
+  # platform
+  #
+  # This method checks the RUBY_PLATFORM environment variable to identify
+  # whether the system is running on an x86_64 Darwin (macOS) or x86_64 Linux
+  # platform
+  #
+  # @return [ Pathname, nil ] returns a Pathname object pointing to the
+  #   detected default panels configuration file if the platform is supported and
+  #   the file exists, or nil if the platform is not supported or the file does
+  #   not exist
+  def infer_default_panels_path_from_platform
+    case RUBY_PLATFORM
+    when /\A(x86_64|arm64)-darwin/, /\Ax86_64-linux/
+      path = default_panels_path($&)
+      if path.exist?
+        path
+      end
+    else
+      STDERR.puts "Default panel configuration cannot be inferred for platform!"
+      nil
+    end
+  end
+
+  # The default_panels_path method constructs and returns a Pathname object
+  # for a default panels configuration file
+  #
+  # This method takes a panel name parameter and uses it to build a file path
+  # pointing to a default panels configuration file
+  # located in the panel defaults directory. It checks if the constructed path
+  # exists and returns it if so, or nil if the file doesn't exist
+  #
+  # @param panels_name [ String ] the name of the panels configuration to look up
+  #
+  # @return [ Pathname, nil ] a Pathname object pointing to the default panels
+  #   configuration file if it exists, or nil if it doesn't exist
+  def default_panels_path(panels_name)
+    path = Pathname.new(__FILE__).dirname + 'panel' + 'defaults' + (panels_name + '.yml')
+    if path.exist?
+      path
+    end
+  end
+
+  # The panels_path_exist? method checks whether the panel configuration file
+  # path exists in the user's configuration directory
+  #
+  # This method verifies the existence of the panels configuration file by
+  # querying the predefined path in the Graphina configuration module
+  #
+  # @return [ Boolean ] true if the panels configuration file exists at the
+  #   expected location, false otherwise
+  def panels_path_exist?
+    Graphina::GraphinaConfig::PANELS_PATH.exist?
+  end
+
+  # The install_default_panels method installs default panel configurations
+  # into the user's configuration directory
+  #
+  # This method checks if a panel configuration file already exists in the
+  # user's configuration directory and, if not, attempts to determine the
+  # appropriate default panel configuration based on the platform or the
+  # specified default panel name, then copies the default configuration file to
+  # the user's configuration directory
+  def install_default_panels
+    if panels_path_exist?
+      STDOUT.print "#{Graphina::GraphinaConfig::PANELS_PATH.to_s.inspect} exists. Overwrite (y/n)? "
+      STDIN.gets !~ /\Ay/i and return
+    end
+    default_path = @default_panels_name ?
+      default_panels_path(@default_panels_name) :
+      infer_default_panels_path_from_platform
+    if default_path
+      mkdir_p Graphina::GraphinaConfig::CONFIG_DIR
+      cp default_path, Graphina::GraphinaConfig::PANELS_PATH
+      STDOUT.puts "Default panels from #{default_path.to_s.inspect} have been installed."
+    else
+      STDERR.puts "Default panels for #{@default_panels_name.inspect} could not be installed."
+    end
+  end
+end

data/lib/graphina/version.rb

@@ -1,6 +1,6 @@
 module Graphina
   # Graphina version
-  VERSION         = '0.1.1'
+  VERSION         = '0.3.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/graphina.rb

@@ -13,6 +13,7 @@ require 'tins'
 module Graphina
 end
 require 'graphina/version'
+require 'graphina/setup'
 require 'graphina/graphina_config'
 require 'graphina/panel'
 require 'graphina/graph'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphina
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Florian Frank
@@ -132,6 +132,7 @@ extra_rdoc_files:
 - lib/graphina/graphina_config.rb
 - lib/graphina/panel.rb
 - lib/graphina/panel/chooser.rb
+- lib/graphina/setup.rb
 - lib/graphina/version.rb
 files:
 - ".utilsrc"
@@ -151,6 +152,10 @@ files:
 - lib/graphina/graphina_config.rb
 - lib/graphina/panel.rb
 - lib/graphina/panel/chooser.rb
+- lib/graphina/panel/defaults/arm64-darwin.yml
+- lib/graphina/panel/defaults/x86_64-darwin.yml
+- lib/graphina/panel/defaults/x86_64-linux.yml
+- lib/graphina/setup.rb
 - lib/graphina/version.rb
 homepage: https://github.com/flori/graphina
 licenses: