hackmac 1.9.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a8737823bd35d4307645c94d45e0232b29e9bd174a173959d083bddf20635e8
-  data.tar.gz: eb8e1c697851e2c55b48dd568f222e9b6355c6d3ca957456239b0721999b8351
+  metadata.gz: f08f36e8e85de7ebec84d0e2f98334ae3f644ef48411852c0299c6b439d19702
+  data.tar.gz: f2659f7f42f980013730bf9efc6830ee98c3a99d7d1f3a92da5d3505aabf7312
 SHA512:
-  metadata.gz: bb1c5bee6a66eaba86b7cf8bc085bd46c46b19aca8e87590f2e8741d3c41d24f8b18a8d539473cc0f2ce359a79d58ad9456f1b68a2ba803b1c4ce07cacd031c3
-  data.tar.gz: a17a0d413c60c1dfd82535c4a179902f80fb4f5e860e46fb60750d89b139694d962b2af07fbe8d1986a331701e16929b91a0586283fa521d6a0a6a4c00094dc4
+  metadata.gz: 8fbb05e777bcf29ef66888ee69eb84bbdcc6f741400038e80b20eeff98d54bc6b41e8ab5360619535ac82f3ad58e06568cfb6fae879576c7d00a6e839a9f95f4
+  data.tar.gz: 143eda42ce454475b6d1f3e3a4a1e0fca43b220ddab12ad029d3a916261913ce4731da9c5ad48bde29de814b4a44a925764ead523b8b12c1d27f54638acf4056

data/CHANGES.md

@@ -1,5 +1,55 @@
 # Changes
 
+## 2025-10-26 v1.11.0
+
+- Reduced minimum sleep duration in gfxmon from **1** second to **0.01**
+  seconds
+- Changed sleep duration calculation in gfxmon to use `.to_f` instead of
+  `.to_i` for sub-second precision
+- Updated `Hackmac::Graph` parameter handling:
+  - Clarified documentation for `color` and `color_secondary` parameters to
+    indicate `nil` values derive colors from the title
+  - Set default value for `sleep` parameter to **5** seconds
+  - Added `@raise [TypeError]` documentation for `sleep` parameter
+  - Converted `sleep` parameter to `Float` and validated it's non-negative
+- Added validation and normalization for graph constructor parameters:
+  - Validated `adjust_brightness` to be either `:lighten` or `:darken`
+  - Converted `adjust_brightness` to symbol using `to_sym`
+  - Ensured `adjust_brightness_percentage` is a `Float`
+  - Fixed typo in error message for `resolution` parameter
+- Added `-f` and `-b` command-line options to `gfxmon` for foreground and
+  background colors
+  - Default foreground color is `:white` and background color is `:black`
+  - Updated `Hackmac::Graph` class to accept `foreground_color` and
+    `background_color` parameters
+  - Modified rendering logic to use `@background_color` instead of hardcoded
+    `0` for background color
+  - Updated help text to document the new `-f` and `-b` options
+- Added `-r` command-line option to `gfxmon` with values `single` or `double`
+  - Default resolution is `:double`
+  - Updated `Hackmac::Graph` class to accept and validate `resolution`
+    parameter
+  - Used spaces (`' '`) for `:single` resolution to display lower resolution
+  - Added `ArgumentError` validation for invalid resolution values
+  - Updated help text to document the new `-r` option
+- Removed redundant `@return` tags from documentation
+
+## 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

data/VERSION

@@ -1 +1 @@
-1.9.1
+1.11.0

data/bin/gfxmon

@@ -32,7 +32,13 @@ require 'amatch'
 require 'search_ui'
 include SearchUI
 
-$opts = go 'c:m:n:jlh', defaults: { ?s => true, ?n => 5 }
+$opts = go 'c:C:m:n:f:b:r:jlh', defaults: {
+  ?s => true,
+  ?n => 5,
+  ?r => :double,
+  ?f => :white,
+  ?b => :black,
+}
 
 # The usage method displays command-line usage information and options
 #
@@ -47,12 +53,16 @@ def usage
 
     OPTIONS are
 
-      -h          this help
-      -l          output GPU performance data as list
-      -j          output GPU performance data as json
-      -n SECONDS  measure every SECONDS
-      -m METRIC   output graph for performance METRIC
-      -c COLOR    output graph in this terminal COLOR (between 0 - 255)
+      -h            this help
+      -l            output GPU performance data as list
+      -j            output GPU performance data as json
+      -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
+      -f COLOR      foreground color (used for text)
+      -b COLOR      background color (used for background)
+      -r RESOLUTION is either single or double (uses half blocks)
 
   EOT
   0
@@ -173,13 +183,17 @@ end
 # @see derive_formatter
 def display_graph
   if metric = choose_metric(ps)
-    sleep_duration = [ 1, ($opts[?n] || 10).to_i ].max
+    sleep_duration = [ 0.01, ($opts[?n] || 10).to_f ].max
     format_value = derive_formatter(metric)
     graph = Hackmac::Graph.new(
-      title: metric,
-      sleep: sleep_duration,
-      value: -> _ { ps[metric] || 0 },
-      color: $opts[?c],
+      title:            metric,
+      sleep:            sleep_duration,
+      value:            -> _ { ps[metric] || 0 },
+      color:            $opts[?c],
+      color_secondary:  $opts[?C],
+      foreground_color: $opts[?f],
+      background_color: $opts[?b],
+      resolution:       $opts[?r],
       format_value:
     )
     graph.start

data/hackmac.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: hackmac 1.9.1 ruby lib
+# stub: hackmac 1.11.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "hackmac".freeze
-  s.version = "1.9.1".freeze
+  s.version = "1.11.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/asset_tools.rb

@@ -48,8 +48,6 @@ module Hackmac
     #
     # @param name [ String ] the path to the compressed file to be decompressed
     #
-    # @return [ void ] Returns nothing, but performs system decompression operations
-    #
     # @raise [ RuntimeError ] raised when the file extension is not supported or
     #                         decompression commands fail
     def decompress(name)

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

@@ -40,8 +40,7 @@ class Hackmac::Graph
   include Term::ANSIColor
   include Hackmac::Graph::Formatters
 
-  # The initialize method sets up a Graph instance by configuring its display
-  # parameters and internal state
+  # The initialize method sets up a Graph instance by configuring its display 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 +48,67 @@ 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 [ Object, Proc, nil ] color or proc or nil. nil
+  #   determineicolor dynamically from the title
+  # @param color_secondary [ Object, nil ] secondary color or nil
+  #   for enhanced visuals, nil derives secondary color from (primary) color
+  # @param adjust_brightness [ Symbol ] the method to call on the color for
+  #   brightness adjustment (:lighten or :darken), defaults to :lighten
+  # @param adjust_brightness_percentage [ Float ] 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
+  # @param resolution [ Symbol ] the resolution mode (:single or :double) for
+  #   the graph display, defaults to :double.
   #
   # @raise [ ArgumentError ] if the sleep parameter is negative
+  # @raise [ TypeError ] if the sleep parameter is not numeric
+  # @raise [ ArgumentError ] if the resolution parameter is not :single or :double
   def initialize(
     title:,
-    value: -> i { 0 },
-    format_value: nil,
-    sleep: nil,
-    color: nil
+    value:                        -> i { 0 },
+    format_value:                 nil,
+    sleep:                        5,
+    color:                        nil,
+    color_secondary:              nil,
+    adjust_brightness:            :lighten,
+    adjust_brightness_percentage: 15,
+    foreground_color:             :white,
+    background_color:             :black,
+    resolution:                   :double
   )
+    @title                        = title
+    @value                        = value
+    @format_value                 = format_value
+    sleep = Float(sleep)
     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
+    @sleep                        = sleep
+    @continue                     = false
+    @data                         = []
+    @color                        = color
+    @color_secondary              = color_secondary
+    adjust_brightness             = adjust_brightness.to_sym
+    if %i[ lighten darken ].include? adjust_brightness
+      @adjust_brightness          = adjust_brightness
+    else
+      raise ArgumentError, 'adjust_brightness required to be either :lighten or :darken'
+    end
+    @adjust_brightness_percentage = Float(adjust_brightness_percentage)
+    @foreground_color             = foreground_color
+    @background_color             = background_color
+    resolution                    = resolution.to_sym
+    if %i[ single double ].include? resolution
+      @resolution                 = resolution
+    else
+      raise ArgumentError, 'resolution required to be either :single or :double'
+    end
+    @mutex                        = Mutex.new
   end
 
   # The start method initiates the graphical display process by setting up
@@ -108,23 +146,32 @@ 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).on_color(0).color(color).write(?▄)
+          case @resolution
+          when :double
+            fract = 1 - (y0 - y0.floor).abs
+            case
+            when (0...0.5) === fract
+              @display.at(iy, x).on_color(@background_color).color(color).write(?▄)
+            else
+              @display.at(iy, x).on_color(color).color(color_secondary).write(?▄)
+            end
           else
-            @display.at(iy, x).on_color(color).color(color_light).write(?▄)
+            @display.at(iy, x).on_color(color).color(color_secondary).write(' ')
           end
         end
       end
@@ -277,6 +324,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
   #
@@ -307,9 +373,6 @@ class Hackmac::Graph
   # When the DEBUG_BYTESIZE environment variable is set, it also outputs
   # debugging information about the size of the diff and the time elapsed since
   # the last debug output
-  #
-  # @return [ void ] Returns nothing but performs terminal output operations
-  #   and updates internal display state
   def perform_display_diff
     @mutex.synchronize do
       unless @old_display && @old_display.dimensions == @display.dimensions
@@ -365,8 +428,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/kext_upgrader.rb

@@ -47,8 +47,6 @@ module Hackmac
     # installation paths, and performing the actual file replacement after user
     # confirmation
     #
-    # @return [ void ] Returns nothing but performs file system operations and
-    #   user interaction
     # @raise [ RuntimeError ] raised when a remote download fails or when no
     #   source is defined for the kext
     def perform

data/lib/hackmac/oc_upgrader.rb

@@ -28,8 +28,6 @@ module Hackmac
     #
     # @param mdev [ String ] the mount device identifier for the EFI partition
     # @param config [ Object ] the configuration object containing OpenCore settings including the EFI path
-    #
-    # @return [ void ] Returns nothing but initializes instance variables for the upgrade process
     def initialize(mdev:, config:)
       @config      = config
       mount_path   = Pathname.new('/Volumes').join(mdev)
@@ -45,8 +43,6 @@ module Hackmac
     # operations to replace existing EFI files after ensuring
     # the installation directory is properly configured
     #
-    # @return [ void ] Returns nothing but performs file system operations and
-    #   user interaction
     # @raise [ RuntimeError ] raised when a remote download fails or when no
     #   source is defined for the OpenCore upgrade
     def perform

data/lib/hackmac/plist.rb

@@ -26,8 +26,6 @@ module Hackmac
     # \@plist instance variable for later access through other methods.
     #
     # @param cmd [Array<String>] command and arguments to execute
-    #
-    # @return [void] Returns nothing, but sets the @plist instance variable
     def plist(*cmd)
       @plist = ::Plist.parse_xml(`#{Shellwords.join(cmd)}`)
     end

data/lib/hackmac/version.rb

@@ -1,6 +1,6 @@
 module Hackmac
   # Hackmac version
-  VERSION         = '1.9.1'
+  VERSION         = '1.11.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.1
+  version: 1.11.0
 platform: ruby
 authors:
 - Florian Frank