process-metrics 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06e77d37339d28a6405332440e7049065b61defd68fb69c9b1e794f79aba8ac7
-  data.tar.gz: 6ac90b5a274be90958fb497fe2859807b21700dbd5a7a336278b5c7b2858e2d0
+  metadata.gz: fbf463af0812bd192ef672f02852cc6142e4ec07ce54e9101561e236848a9339
+  data.tar.gz: debc60440d79a2a745ea287e129f22b4a72fbf4b608a8903aafb95a3204b9b38
 SHA512:
-  metadata.gz: 04a5adc405715e2406a8601a58a65885f9026d0c5009822e23eb4c739e727265787eb5ed32218c1316f75a50eba4ac6e3dc6518176d539028bf00a18f9ccbbb9
-  data.tar.gz: dd436625c1ee3a6b3a8cb6424fb05ad35e5243adc961477632acd3ab9e006cd54435c7b662cc2698b06b6e5f4a61c4082c6957d67cb84306ae62d9f075f743c2
+  metadata.gz: f5b9a378cb31b094f83e180696df41dc7c1cc46f7df1e7af782e9883b07ef1e4d4e0007eab9a90a4526e55f794a9d697a5a5033024ea165392ba2ad6af4face0
+  data.tar.gz: '0281fd18c13ccc1d5a1bc4092b242209185ef38239b227b350dca21d780b912ca5fcacbc81a30ae819bfe4e37972494c7fb432e899887a1c0453973fed6fed87'

data/bake/process/metrics.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025-2026, by Samuel Williams.
+
+def capture(pid: nil, ppid: nil)
+	require "process/metrics/general"
+	
+	Process::Metrics::General.capture(pid: pid, ppid: ppid)
+end
+
+# Print metrics for a process or processes.
+#
+# @parameter pid [Integer] The process ID to capture.
+# @parameter ppid [Integer] The parent process ID to capture.
+def metrics(pid: nil, ppid: nil)
+	require "process/metrics/general"
+	require "process/metrics/host"
+	
+	terminal = self.terminal
+	format_memory = self.method(:format_memory).curry
+	
+	# Host name (uname -a) as first line
+	if host_name = Process::Metrics::Host.name
+		terminal.print_line(host_name, :reset)
+	end
+	
+	host = Process::Metrics::Host::Memory.capture
+	terminal.print_line(
+		:key, "Total Memory: ".rjust(20), :reset,
+		format_size(host.total_size).rjust(9)
+	)
+	
+	terminal.print_line(
+		:key, "Used Memory: ".rjust(20), :reset,
+		format_memory[host.used_size, host.total_size]
+	)
+	
+	summary = Process::Metrics::General.capture(pid: pid, ppid: ppid)
+	
+	shared_memory = 0
+	private_memory = 0
+	total_memory = host.total_size
+	
+	proportional = true
+	
+	summary.each do |pid, general|
+		terminal.print_line(:pid, pid, :reset, " ", :command, general[:command])
+		
+		terminal.print(:key, "Processor Usage: ".rjust(20), :reset)
+		format_processor_utilization(general.processor_utilization, terminal)
+		terminal.print_line
+		
+		if memory = general.memory
+			shared_memory += memory.proportional_size
+			private_memory += memory.unique_size
+			
+			terminal.print_line(
+				:key, "Memory: ".rjust(20), :reset,
+				format_memory[memory.proportional_size, total_memory]
+			)
+			
+			terminal.print_line(
+				:key, "Private Memory: ".rjust(20), :reset,
+				format_memory[memory.unique_size, total_memory]
+			)
+		else
+			shared_memory += general.resident_size
+			proportional = false
+			
+			terminal.print_line(
+				:key, "Memory: ".rjust(20), :reset,
+				format_memory[general.resident_size, total_memory]
+			)
+		end
+	end
+	
+	terminal.print_line("Summary")
+	
+	if proportional
+		terminal.print_line(
+			:key, "Memory: ".rjust(20), :reset,
+			format_memory[shared_memory, total_memory]
+		)
+		
+		terminal.print_line(
+			:key, "Private Memory: ".rjust(20), :reset,
+			format_memory[private_memory, total_memory]
+		)
+	else
+		terminal.print_line(
+			:key, "Memory: ".rjust(20), :reset,
+			format_memory[shared_memory, total_memory]
+		)
+	end
+	
+	terminal.print_line(
+		:key, "Memory (Total): ".rjust(20), :reset,
+		format_memory[shared_memory + private_memory, total_memory]
+	)
+end
+
+protected
+
+# Helper module for rendering horizontal progress bars using Unicode block characters.
+module Bar
+	BLOCK = [
+		" ",
+		"▏",
+		"▎",
+		"▍",
+		"▌",
+		"▋",
+		"▊",
+		"▉",
+		"█",
+	]
+	
+	# Format a fractional value as a horizontal bar.
+	# @parameter value [Float] A value between 0.0 and 1.0 representing the fill level.
+	# @parameter width [Integer] The width of the bar in characters.
+	# @returns [String] A string of Unicode block characters representing the filled bar.
+	def self.format(value, width)
+		blocks = width * value
+		full_blocks = blocks.floor
+		partial_block = ((blocks - full_blocks) * BLOCK.size).floor
+		
+		if partial_block.zero?
+			BLOCK.last * full_blocks
+		else
+			"#{BLOCK.last * full_blocks}#{BLOCK[partial_block]}"
+		end.ljust(width)
+	end
+end
+
+# Get the configured terminal for styled output.
+# @returns [Console::Terminal] A terminal object with color/style definitions.
+def terminal
+	terminal = Console::Terminal.for($stdout)
+	
+	# terminal[:pid] = terminal.style(:blue)
+	terminal[:command] = terminal.style(nil, nil, :bold)
+	terminal[:key] = terminal.style(:cyan)
+	
+	terminal[:low] = terminal.style(:green)
+	terminal[:medium] = terminal.style(:yellow)
+	terminal[:high] = terminal.style(:red)
+	
+	return terminal
+end
+
+# Width in characters for progress bars (label + value + " []" ≈ 33 chars).
+DEFAULT_BAR_WIDTH = 60
+
+def bar_width(terminal, prefix_width: 33)
+	if width = terminal.width
+		return width - prefix_width if width > prefix_width
+	end
+	
+	return DEFAULT_BAR_WIDTH
+end
+
+# Format a processor utilization percentage with color-coded bar.
+# @parameter value [Float] The CPU utilization percentage (0.0-100.0).
+# @parameter terminal [Console::Terminal] The terminal to output styled text.
+def format_processor_utilization(value, terminal)
+	if value > 80.0
+		intensity = :high
+	elsif value > 50.0
+		intensity = :medium
+	else
+		intensity = :low
+	end
+	
+	formatted = "%5.1f%% " % value
+	
+	terminal.print(formatted.rjust(10), intensity, "[", Bar.format(value / 100.0, bar_width(terminal)), "]", :reset)
+end
+
+UNITS = ["KiB", "MiB", "GiB"]
+
+# Format a memory size value in human-readable units.
+# @parameter value [Numeric] The size value in bytes.
+# @parameter units [Array(String)] The unit labels to use for scaling.
+# @returns [String] A formatted string with value and unit (e.g., "512KiB", "1.5MiB").
+def format_size(value, units: UNITS)
+	unit = -1
+	
+	while value >= 1024.0 && unit < units.size - 1
+		value /= 1024.0
+		unit += 1
+	end
+	
+	if unit < 0
+		# Value is less than 1 KiB, show in bytes
+		return "#{value.round(0)}B"
+	else
+		return "#{value.round(unit)}#{units[unit]}"
+	end
+end
+
+# Format a memory value with a horizontal bar showing utilization relative to total.
+# @parameter value [Numeric] The memory value in bytes.
+# @parameter total [Numeric] The total memory available in bytes.
+# @parameter terminal [Console::Terminal] The terminal to output styled text.
+def format_memory(value, total, terminal)
+	if value > (total * 0.8)
+		intensity = :high
+	elsif value > (total * 0.5)
+		intensity = :medium
+	else
+		intensity = :low
+	end
+	
+	formatted = (format_size(value) + " ").rjust(10)
+	
+	terminal.print(formatted, intensity, "[", Bar.format(value / total.to_f, bar_width(terminal)), "]", :reset)
+end

data/lib/process/metrics/general/linux.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2026, by Samuel Williams.
+# Copyright, 2026, by Samuel Williams.
 
 require "etc"
 

data/lib/process/metrics/general/process_status.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2026, by Samuel Williams.
+# Copyright, 2026, by Samuel Williams.
 
 module Process
 	module Metrics

data/lib/process/metrics/host/memory/darwin.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2025-2026, by Samuel Williams.
+# Copyright, 2026, by Samuel Williams.
 
 module Process
 	module Metrics

data/lib/process/metrics/host/memory/linux/cgroup_v1.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2025-2026, by Samuel Williams.
+# Copyright, 2026, by Samuel Williams.
 
 module Process
 	module Metrics

data/lib/process/metrics/host/memory/linux/cgroup_v2.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2025-2026, by Samuel Williams.
+# Copyright, 2026, by Samuel Williams.
 
 module Process
 	module Metrics

data/lib/process/metrics/host/memory/linux/meminfo.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2025-2026, by Samuel Williams.
+# Copyright, 2026, by Samuel Williams.
 
 module Process
 	module Metrics

data/lib/process/metrics/host/memory/linux.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2025-2026, by Samuel Williams.
+# Copyright, 2026, by Samuel Williams.
 
 module Process
 	module Metrics

data/lib/process/metrics/host/memory.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2025-2026, by Samuel Williams.
+# Copyright, 2026, by Samuel Williams.
 
 module Process
 	module Metrics

data/lib/process/metrics/host.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2025-2026, by Samuel Williams.
+# Copyright, 2020-2026, by Samuel Williams.
 
 require_relative "host/memory"
 

data/lib/process/metrics/version.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2025, by Samuel Williams.
+# Copyright, 2019-2026, by Samuel Williams.
 
 # @namespace
 module Process
 	# @namespace
 	module Metrics
-		VERSION = "0.11.0"
+		VERSION = "0.11.1"
 	end
 end

data/readme.md

@@ -70,6 +70,22 @@ We welcome contributions to this project.
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
 
+### Running Tests
+
+To run the test suite:
+
+``` shell
+bundle exec sus
+```
+
+### Making Releases
+
+To make a new release:
+
+``` shell
+bundle exec bake gem:release:patch # or minor or major
+```
+
 ### Developer Certificate of Origin
 
 In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: process-metrics
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -71,6 +71,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- bake/process/metrics.rb
 - context/getting-started.md
 - context/index.yaml
 - lib/process/metrics.rb
@@ -105,14 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Provide detailed OS-specific process metrics.
 test_files: []