hackmac 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d8b91e07ca88dc28f574608697201338b76a9c33bce86c6c92e49bfea49716b
-  data.tar.gz: 38fbeec1739607ce09da13ce4f200a7c484479d0ed859bd5db2e8d4fb06b52ff
+  metadata.gz: f08f36e8e85de7ebec84d0e2f98334ae3f644ef48411852c0299c6b439d19702
+  data.tar.gz: f2659f7f42f980013730bf9efc6830ee98c3a99d7d1f3a92da5d3505aabf7312
 SHA512:
-  metadata.gz: c2c4528dbf84320e01fdc90380bcb7eec65f38b28e885c499c2c7594eca0ddabe53a7ea70d47e983195d660936fb2c638f0203a2f23054b132e10dcf0c955395
-  data.tar.gz: 2499348bd0baa5d217a77f6c4959f2a78a6693e52d93975cf305713203dc4c647c9d9c286b0f2a01bab75f8694d298d8ecbdd165ca87e126ff984ea9037b6c97
+  metadata.gz: 8fbb05e777bcf29ef66888ee69eb84bbdcc6f741400038e80b20eeff98d54bc6b41e8ab5360619535ac82f3ad58e06568cfb6fae879576c7d00a6e839a9f95f4
+  data.tar.gz: 143eda42ce454475b6d1f3e3a4a1e0fca43b220ddab12ad029d3a916261913ce4731da9c5ad48bde29de814b4a44a925764ead523b8b12c1d27f54638acf4056

data/CHANGES.md

@@ -1,5 +1,39 @@
 # 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

data/VERSION

@@ -1 +1 @@
-1.10.0
+1.11.0

data/bin/gfxmon

@@ -32,7 +32,13 @@ require 'amatch'
 require 'search_ui'
 include SearchUI
 
-$opts = go 'c: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,13 +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)
-      -C COLOR    output graph using secondary color COLOR
+      -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
@@ -174,14 +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],
-      color_secondary: $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.10.0 ruby lib
+# stub: hackmac 1.11.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "hackmac".freeze
-  s.version = "1.10.0".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.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
@@ -54,44 +53,61 @@ class Hackmac::Graph
   # @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_secondary [ Integer, Proc, nil ] secondary color index or proc
-  #   for enhanced visuals
+  # @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
-  # @param adjust_brightness_percentage [ Integer ] the percentage value to use
+  #   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,
+    sleep:                        5,
     color:                        nil,
     color_secondary:              nil,
     adjust_brightness:            :lighten,
     adjust_brightness_percentage: 15,
     foreground_color:             :white,
-    background_color:             :black
+    background_color:             :black,
+    resolution:                   :double
   )
-    sleep >= 0 or raise ArgumentError, 'sleep has to be >= 0'
     @title                        = title
     @value                        = value
     @format_value                 = format_value
+    sleep = Float(sleep)
+    sleep >= 0 or raise ArgumentError, 'sleep has to be >= 0'
     @sleep                        = sleep
     @continue                     = false
     @data                         = []
     @color                        = color
     @color_secondary              = color_secondary
-    @adjust_brightness            = adjust_brightness
-    @adjust_brightness_percentage = adjust_brightness_percentage
+    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
 
@@ -145,12 +161,17 @@ class Hackmac::Graph
         if iy > y
           @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_secondary).write(?▄)
+            @display.at(iy, x).on_color(color).color(color_secondary).write(' ')
           end
         end
       end
@@ -352,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

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.10.0'
+  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.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Florian Frank