hackmac 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3965cb839d08ac229629f87ffe259ff8b0ac39a084b25ce2530b2a0eedfab10
-  data.tar.gz: ff2e1a574431fc027ae09fabf3c31eb41b0c16df1f9f5825995cca48123c8b6e
+  metadata.gz: 5d8b91e07ca88dc28f574608697201338b76a9c33bce86c6c92e49bfea49716b
+  data.tar.gz: 38fbeec1739607ce09da13ce4f200a7c484479d0ed859bd5db2e8d4fb06b52ff
 SHA512:
-  metadata.gz: '018e26bd422ca4405ff37e00719f1238251bb993dbd323cb34351cee6397f378ce3f4972596b26e3987f01ac5fa199f1e8381a2cb24f2fb6cfc29a87254830af'
-  data.tar.gz: d805a9175d7667ff349883b55d120e1d78f0b039af493afd829906e2cc15ac65e0fc153df4eb1454c0d1745f20ce0f05eaa91246a9dcfbe21dec3089555309f6
+  metadata.gz: c2c4528dbf84320e01fdc90380bcb7eec65f38b28e885c499c2c7594eca0ddabe53a7ea70d47e983195d660936fb2c638f0203a2f23054b132e10dcf0c955395
+  data.tar.gz: 2499348bd0baa5d217a77f6c4959f2a78a6693e52d93975cf305713203dc4c647c9d9c286b0f2a01bab75f8694d298d8ecbdd165ca87e126ff984ea9037b6c97

data/CHANGES.md

@@ -1,5 +1,53 @@
 # Changes
 
+## 2025-10-25 v1.10.0
+
+- Added `-C` command line option to specify secondary color for terminal
+      graphs, accepting color values between **0** - **255**
+    - Updated `Hackmac::Graph.new` call to include `color_secondary:` parameter
+    - Modified `usage` method to document the new `-C` option
+    - Maintained backward compatibility with existing `-c` color option
+- Added support for `color_secondary`, `adjust_brightness`, and `adjust_brightness_percentage` parameters in `Hackmac::Graph#initialize`
+- Introduced `pick_secondary_color` method to calculate secondary colors based on brightness adjustments
+- Updated `draw_graph` to use secondary colors for improved visual contrast
+- Modified `Hackmac::Graph::Display#initialize` to accept `color` and `on_color` parameters
+- Configured `@display` and `@old_display` with default color settings in `Hackmac::Graph#reset_display`
+- Default `adjust_brightness` to **:lighten** with **15%** brightness adjustment
+- Default `foreground_color` to **:white** and `background_color` to **:black**
+- Added conditional check `if @plist` before extending with `Hashie::Extensions::DeepFind` to prevent `NoMethodError` when `@plist` is nil or undefined
+
+## 2025-10-25 v1.9.1
+
+- Addresses display issues in tmux panes where background colors bled through
+  due to changed character rendering
+- Updated `ps` method to return an empty hash `{}` instead of raising an error
+  when `PerformanceStatistics` key doesn't exist in IORegistry
+- Added `exist?` method to the `Hackmac` module to check if plist data is
+  loaded, returning `@plist` instance variable or `nil` if no data is available
+- Ensured the returned value is always a hash in the `ps` method
+- Modified `ps` method to handle nil values from `ps[metric]` by defaulting to
+  **0** to prevent potential errors when metric data is missing from the
+  process snapshot
+
+## 2025-10-23 v1.9.0
+
+- Added `draw_graph` method to render data using Unicode block characters (`▀`)
+- Introduced `data_range` helper to calculate data value range as `Float`
+- Refactored `start_loop` to use `draw_graph` instead of inline rendering logic
+- Moved color calculation and `y_width` logic into `draw_graph` method
+- Replaced direct graph drawing in `start_loop` with call to `draw_graph`
+- Implemented `data_range.zero?` check to handle flat data scenarios
+- Added fractional pixel blending for visual appeal
+- Used `color.to_rgb_triple.to_hsl_triple.lighten(15)` for background shading
+- Added fallback handling for color conversion errors with `rescue color`
+- Supported terminal graphics with 2px vertical resolution using Unicode characters
+- Updated `@display.at(iy, x)` calls with color styling for graph rendering
+- Removed duplicate `pick_color` method
+- Added YARD documentation for `Hackmac::Config::DEFAULT`, `Hackmac::GithubSource::GITHUB_API_URL`, and `Hackmac::Graph::Display::ANSI` constants
+- Updated module documentation with project description and features
+- Refactored Graph formatters into separate `Hackmac::Graph::Formatters` module
+- Refactored `Hackmac::Graph::Display::Cell` class into separate file `lib/hackmac/graph/display/cell.rb`
+
 ## 2025-10-15 v1.8.8
 
 ### Features

data/VERSION

@@ -1 +1 @@
-1.9.0
+1.10.0

data/bin/gfxmon

@@ -19,8 +19,6 @@
 #   gfxmon -n 3                # Update every 3 seconds
 #   gfxmon -m "Temperature(C)" # Show specific metric
 
-require 'tins'
-include Tins::GO
 require 'term/ansicolor'
 Term::ANSIColor.true_coloring = ENV['COLORTERM'] =~ /\A(truecolor|24bit)\z/
 include Term::ANSIColor
@@ -29,11 +27,12 @@ class String
 end
 require 'hackmac'
 include Hackmac
+include Tins::GO
 require 'amatch'
 require 'search_ui'
 include SearchUI
 
-$opts = go 'c:m:n:jlh', defaults: { ?s => true, ?n => 5 }
+$opts = go 'c:C:m:n:jlh', defaults: { ?s => true, ?n => 5 }
 
 # The usage method displays command-line usage information and options
 #
@@ -54,6 +53,7 @@ def usage
       -n SECONDS  measure every SECONDS
       -m METRIC   output graph for performance METRIC
       -c COLOR    output graph in this terminal COLOR (between 0 - 255)
+      -C COLOR    output graph using secondary color COLOR
 
   EOT
   0
@@ -67,7 +67,12 @@ end
 # @return [ Hash ] a hash containing the performance statistics data from the
 #   IORegistry
 def ps
-  Hackmac::IOReg.new(key: 'PerformanceStatistics').as_hash
+  ioreg = Hackmac::IOReg.new(key: 'PerformanceStatistics')
+  if ioreg.exist?
+    ioreg.as_hash
+  else
+    {}
+  end
 end
 
 # The list method displays a formatted key-value pair listing with colored
@@ -172,10 +177,11 @@ def display_graph
     sleep_duration = [ 1, ($opts[?n] || 10).to_i ].max
     format_value = derive_formatter(metric)
     graph = Hackmac::Graph.new(
-      title: metric,
-      sleep: sleep_duration,
-      value: -> _ { ps[metric] },
-      color: $opts[?c],
+      title:           metric,
+      sleep:           sleep_duration,
+      value:           -> _ { ps[metric] || 0 },
+      color:           $opts[?c],
+      color_secondary: $opts[?C],
       format_value:
     )
     graph.start

data/hackmac.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: hackmac 1.9.0 ruby lib
+# stub: hackmac 1.10.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "hackmac".freeze
-  s.version = "1.9.0".freeze
+  s.version = "1.10.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

data/lib/hackmac/graph/display.rb

@@ -27,9 +27,13 @@ class Hackmac::Graph
     # @param lines [ Integer ] the number of lines (rows) in the display grid
     # @param columns [ Integer ] the number of columns (characters per line) in
     #   the display grid
-    def initialize(lines, columns)
+    # @param color [ Symbol ] the default text color for the display
+    # @param on_color [ Symbol ] the default background color for the display
+    def initialize(lines, columns, color: :white, on_color: :black)
       @lines_range   = 1..lines
       @columns_range = 1..columns
+      @orig_color    = color
+      @orig_on_color = on_color
       clear
     end
 
@@ -42,13 +46,16 @@ class Hackmac::Graph
     # array of Cell objects that represent the display grid, filling each cell
     # with a space character and default styling attributes
     #
+    # @param color [ Symbol ] the default text color for the display
+    # @param on_color [ Symbol ] the default background color for the display
+    #
     # @return [ Hackmac::Graph::Display ] returns the Display instance to allow
     #   for method chaining
     def clear
       @x        = 1
       @y        = 1
-      @color    = 15
-      @on_color = 0
+      @color    = @orig_color
+      @on_color = @orig_on_color
       @styles   = []
       @cells    =
         Array.new(lines) {
@@ -70,8 +77,8 @@ class Hackmac::Graph
     # @return [ Hackmac::Graph::Display ] returns the Display instance to allow
     #   for method chaining
     def reset
-      @color    = 15
-      @on_color = 0
+      @color    = @orig_color
+      @on_color = @orig_on_color
       @styles   = []
       self
     end

data/lib/hackmac/graph.rb

@@ -41,7 +41,7 @@ class Hackmac::Graph
   include Hackmac::Graph::Formatters
 
   # The initialize method sets up a Graph instance by configuring its display
-  # parameters and internal state
+  # parameters and internal state.
   #
   # This method configures the graph visualization with title, value provider,
   # formatting options, update interval, and color settings. It initializes
@@ -49,28 +49,50 @@ class Hackmac::Graph
   # synchronization through a mutex for thread-safe operations.
   #
   # @param title [ String ] the title to display at the bottom of the graph
-  # @param value [ Proc ] a proc that takes an index and returns a numeric value for plotting
-  # @param format_value [ Proc, Symbol, nil ] formatting strategy for displaying values
+  # @param value [ Proc ] a proc that takes an index and returns a numeric
+  #   value for plotting
+  # @param format_value [ Proc, Symbol, nil ] formatting strategy for
+  #   displaying values
   # @param sleep [ Numeric ] time in seconds between updates
-  # @param color [ Integer, Proc, nil ] color index or proc to determine color dynamically
+  # @param color [ Integer, Proc, nil ] color index or proc to determine color
+  #   dynamically
+  # @param color_secondary [ Integer, Proc, nil ] secondary color index or proc
+  #   for enhanced visuals
+  # @param adjust_brightness [ Symbol ] the method to call on the color for
+  #   brightness adjustment
+  # @param adjust_brightness_percentage [ Integer ] the percentage value to use
+  #   for the brightness adjustment
+  # @param foreground_color [ Symbol ] the default text color for the display
+  # @param background_color [ Symbol ] the default background color for the
+  #   display
   #
   # @raise [ ArgumentError ] if the sleep parameter is negative
   def initialize(
     title:,
-    value: -> i { 0 },
-    format_value: nil,
-    sleep: nil,
-    color: nil
+    value:                        -> i { 0 },
+    format_value:                 nil,
+    sleep:                        nil,
+    color:                        nil,
+    color_secondary:              nil,
+    adjust_brightness:            :lighten,
+    adjust_brightness_percentage: 15,
+    foreground_color:             :white,
+    background_color:             :black
   )
     sleep >= 0 or raise ArgumentError, 'sleep has to be >= 0'
-    @title        = title
-    @value        = value
-    @format_value = format_value
-    @sleep        = sleep
-    @continue     = false
-    @data         = []
-    @color        = color
-    @mutex        = Mutex.new
+    @title                        = title
+    @value                        = value
+    @format_value                 = format_value
+    @sleep                        = sleep
+    @continue                     = false
+    @data                         = []
+    @color                        = color
+    @color_secondary              = color_secondary
+    @adjust_brightness            = adjust_brightness
+    @adjust_brightness_percentage = adjust_brightness_percentage
+    @foreground_color             = foreground_color
+    @background_color             = background_color
+    @mutex                        = Mutex.new
   end
 
   # The start method initiates the graphical display process by setting up
@@ -108,23 +130,27 @@ class Hackmac::Graph
   # to achieve 2px vertical resolution in terminal graphics. Each data point is
   # plotted with appropriate color blending for visual appeal.
   def draw_graph
-    y_width     = data_range
-    color       = pick_color
-    color_light = color.to_rgb_triple.to_hsl_triple.lighten(15) rescue color
+    y_width         = data_range
+    color           = pick_color
+    color_secondary = pick_secondary_color(
+      color,
+      adjust_brightness:            @adjust_brightness,
+      adjust_brightness_percentage: @adjust_brightness_percentage
+    )
     data.each_with_index do |value, i|
       x  = 1 + i + columns - data.size
       y0 = ((value - data.min) * lines / y_width.to_f)
       y  = lines - y0.round + 1
       y.upto(lines) do |iy|
         if iy > y
-          @display.at(iy, x).on_color(color_light).write(' ')
+          @display.at(iy, x).on_color(color_secondary).write(' ')
         else
           fract = 1 - (y0 - y0.floor).abs
           case
           when (0...0.5) === fract
-            @display.at(iy, x).color(0).on_color(color).write(?▀)
+            @display.at(iy, x).on_color(0).color(color).write(?▄)
           else
-            @display.at(iy, x).color(color).on_color(color_light).write(?▀)
+            @display.at(iy, x).on_color(color).color(color_secondary).write(?▄)
           end
         end
       end
@@ -277,6 +303,25 @@ class Hackmac::Graph
     ]
   end
 
+  # The pick_secondary_color method determines a secondary color based on a
+  # primary color and brightness adjustment parameters It returns the
+  # pre-configured secondary color if one exists, otherwise
+  # calculates a new color by adjusting the brightness of the primary color
+  #
+  # @param color [ Term::ANSIColor::Attribute ] the primary color attribute to
+  #   be used as a base for calculation
+  # @param adjust_brightness [ Symbol ] the method to call on the color for
+  #   brightness adjustment
+  # @param adjust_brightness_percentage [ Integer ] the percentage value to use
+  #   for the brightness adjustment
+  # @return [ Term::ANSIColor::Attribute ] the secondary color attribute,
+  #   either pre-configured or calculated from the primary color
+  def pick_secondary_color(color, adjust_brightness:, adjust_brightness_percentage:)
+    @color_secondary and return @color_secondary
+    color_primary = color.to_rgb_triple.to_hsl_triple
+    color_primary.send(adjust_brightness, adjust_brightness_percentage) rescue color
+  end
+
   # The sleep_now method calculates and executes a sleep duration based on the
   # configured sleep time and elapsed time since start
   #
@@ -365,8 +410,12 @@ class Hackmac::Graph
     @mutex.synchronize do
       perform reset, clear_screen, move_home, show_cursor
       winsize = Tins::Terminal.winsize
-      @display     = Hackmac::Graph::Display.new(*winsize)
-      @old_display = Hackmac::Graph::Display.new(*winsize)
+      opts = {
+           color: @foreground_color,
+        on_color: @background_color,
+      }
+      @display     = Hackmac::Graph::Display.new(*winsize, **opts)
+      @old_display = Hackmac::Graph::Display.new(*winsize, **opts)
       perform @display
       @full_reset = false
     end

data/lib/hackmac/ioreg.rb

@@ -28,8 +28,10 @@ module Hackmac
     #   IOService tree
     def initialize(key:)
       plist(*(%w[ioreg -a -p IOService -r -k ] << key))
-      @plist.extend Hashie::Extensions::DeepFind
-      @plist = @plist.deep_find_all(key).max_by(&:size)
+      if @plist
+        @plist.extend Hashie::Extensions::DeepFind
+        @plist = @plist.deep_find_all(key).max_by(&:size)
+      end
     end
   end
 end

data/lib/hackmac/plist.rb

@@ -32,6 +32,17 @@ module Hackmac
       @plist = ::Plist.parse_xml(`#{Shellwords.join(cmd)}`)
     end
 
+    # The exist? method checks whether plist data has been loaded
+    #
+    # This method returns a truthy value if plist data has been successfully
+    # parsed and stored in the instance variable, or nil if no plist data is
+    # available.
+    #
+    # @return [ Object, nil ] returns the plist data if present, nil otherwise
+    def exist?
+      @plist
+    end
+
     # Returns a duplicate of the internal plist hash
     #
     # This method provides access to the parsed plist data by returning a shallow copy
@@ -40,7 +51,7 @@ module Hackmac
     #
     # @return [ Hash ] a duplicate of the plist hash containing the parsed XML data
     def as_hash(*a)
-      @plist.dup
+      @plist.dup.to_h
     end
 
     # The each method iterates over the parsed plist data

data/lib/hackmac/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hackmac
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Florian Frank