linux_stat 1.1.1 → 1.3.0

data/lib/linux_stat/prettify_bytes.rb

@@ -1,4 +1,11 @@
 module LinuxStat
+	# Helps you convert bytes to a unit like:
+	#
+	# 1. kilobyte, megabyte, gigabyte, terabyte, petabyte, exabyte, zettabyte, yottabyte
+	# 2. kibibyte, mebibyte, gibibyte, tebibyte, pebibyte, exbibyte, zebibyte, yobibyte
+	# 3. kB, MB, GB, TB, PB, EB, ZB, YB
+	# 4. kiB, MiB, GiB, TiB, PiB, EiB, ZiB, YiB
+
 	module PrettifyBytes
 		class << self
 			##

data/lib/linux_stat/process.rb

@@ -1,4 +1,7 @@
 module LinuxStat
+	# Shows various information about a process that is either
+	# running, sleeping, idle or a zombie.
+
 	module Process
 		class << self
 			##
@@ -6,10 +9,17 @@ module LinuxStat
 			#
 			# The return type is an Array of Integers.
 			def list
-				Dir['/proc/*'].select { |x|
-					pid = File.split(x)[1]
-					pid.to_i.to_s == pid
-				}.map! { |x| File.split(x)[-1].to_i }
+				d = Dir['/proc/*'.freeze]
+				ret, i = [], -1
+				count = d.length
+
+				while(i += 1) < count
+					pid = File.split(d[i])[1]
+					pid_i = pid.to_i
+					ret << pid_i if pid_i.to_s == pid
+				end
+
+				ret
 			end
 
 			##
@@ -17,28 +27,42 @@ module LinuxStat
 			#
 			# The return type is Integer.
 			def count
-				list.count
+				list.length
 			end
 
 			##
 			# Returns all the id of processes mapped with their names as a Hash.
 			def names
-				list.reduce({}) { |h, x|
+				h, i = {}, -1
+
+				l = list
+				count = l.length
+
+				while(i += 1) < count
+					x = l[i]
+
 					begin
-						h.merge!( x => IO.foreach(File.join('/proc', x.to_s, 'status')).first.split[1] )
-					rescue Exception
-						h
+						h.merge!( x => IO.foreach("/proc/#{x}/status").first.split[1])
+					rescue StandardError
 					end
-				}
+				end
+				h
 			end
 
 			##
 			# Returns all the id of processes mapped with their status as a Hash.
 			def types
-				list.reduce({}) { |h, x|
+				h, i = {}, -1
+
+				l = list
+				count = l.length
+
+				while(i += 1) < count
+					x = l[i]
+
 					begin
 						h.merge!(x =>
-							case IO.read(File.join('/proc', x.to_s, 'stat')).split[2]
+							case IO.foreach("/proc/#{x}/stat", ' '.freeze).first(3)[-1][0]
 								when ?S.freeze then :sleeping
 								when ?I.freeze then :idle
 								when ?Z.freeze then :zombie
@@ -46,10 +70,11 @@ module LinuxStat
 								else :unknown
 							end
 						)
-					rescue Exception
-						h
+					rescue StandardError
 					end
-				}
+				end
+
+				h
 			end
 
 			##
@@ -58,8 +83,8 @@ module LinuxStat
 			def sleeping
 				list.select { |x|
 					begin
-						IO.read(File.join('/proc', x.to_s, 'stat')).split[2] == ?S
-					rescue Exception
+						IO.foreach("/proc/#{x}/stat", ' '.freeze).first(3)[-1][0] == ?S.freeze
+					rescue StandardError
 						nil
 					end
 				}
@@ -71,8 +96,8 @@ module LinuxStat
 			def idle
 				list.select { |x|
 					begin
-						IO.read(File.join('/proc', x.to_s, 'stat')).split[2] == ?I
-					rescue Exception
+						IO.foreach("/proc/#{x}/stat", ' '.freeze).first(3)[-1][0] == ?I.freeze
+					rescue StandardError
 						nil
 					end
 				}
@@ -84,8 +109,8 @@ module LinuxStat
 			def zombie
 				list.select { |x|
 					begin
-						IO.read(File.join('/proc', x.to_s, 'stat')).split[2] == ?Z
-					rescue Exception
+						IO.foreach("/proc/#{x}/stat", ' '.freeze).first(3)[-1][0] == ?Z.freeze
+					rescue StandardError
 						nil
 					end
 				}
@@ -97,8 +122,8 @@ module LinuxStat
 			def running
 				list.select { |x|
 					begin
-						IO.read(File.join('/proc', x.to_s, 'stat')).split[2] == ?R
-					rescue Exception
+						IO.foreach("/proc/#{x}/stat", ' '.freeze).first(3)[-1][0] == ?R.freeze
+					rescue StandardError
 						nil
 					end
 				}

data/lib/linux_stat/process_info.rb

@@ -1,4 +1,11 @@
 module LinuxStat
+	# Shows various information about a process that is either
+	# running, sleeping, idle or a zombie.
+	# Most methods can take a PID, but some uses polling to calculate
+	# something, they can accept options instead of arguments.
+	# Consult the documentation on the specific methods
+	# for more details on that.
+
 	module ProcessInfo
 		class << self
 			##

data/lib/linux_stat/swap.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various Swap devices related information of the current system.
+
 	module Swap
 		class << self
 			##
@@ -8,7 +10,7 @@ module LinuxStat
 			def list
 				return {} unless swaps_readable?
 
-				file = IO.readlines('/proc/swaps').drop(1)
+				file = IO.readlines('/proc/swaps'.freeze).drop(1)
 				file.reduce({}) do |h, x|
 					name, *stats = x.strip.split
 					h.merge!(name => stats.map! { |v| v.to_i.to_s == v ? v.to_i : v.to_sym })
@@ -20,7 +22,7 @@ module LinuxStat
 			#
 			# If the info isn't available, it will return an empty Hash.
 			def any?
-				!!IO.foreach('/proc/swaps').drop(1).first
+				!!IO.foreach('/proc/swaps'.freeze).first(2)[1]
 			end
 
 			# Show aggregated used and available swap.
@@ -114,7 +116,7 @@ module LinuxStat
 			def read_usage
 				return [[], []] unless swaps_readable?
 
-				val = IO.readlines('/proc/swaps').drop(1)
+				val = IO.readlines('/proc/swaps'.freeze).drop(1)
 				return [[], []] if val.empty?
 
 				val.map! { |x|
@@ -123,7 +125,7 @@ module LinuxStat
 			end
 
 			def swaps_readable?
-				@@swaps_readable ||= File.readable?('/proc/swaps')
+				@@swaps_readable ||= File.readable?('/proc/swaps'.freeze)
 			end
 		end
 	end

data/lib/linux_stat/thermal.rb

@@ -0,0 +1,122 @@
+module LinuxStat
+	# Sensors are available to /sys/class/hwmon
+	# This module just reads the files inside them to get the sensor information.
+	#
+	# https://www.kernel.org/doc/Documentation/thermal/sysfs-api.txt
+
+	module Thermal
+		class << self
+			##
+			# Get temperatures from all sensors.
+			#
+			# The return value is an Array of Hashes.
+			#
+			# It opens various files from /sys/, and it should be
+			# considered very slow.
+			#
+			# Each hash may contain information including:
+			#
+			# path, name, label
+			# temperature, temp_crit, temp_max
+			#
+			# But if the info isn't available, it will return an empty Array.
+			def temperatures
+				query_hwmon('temp'.freeze, :temperature, true)
+			end
+
+			##
+			# Get RPM from all fans.
+			#
+			# The return value is an Array of Hashes.
+			#
+			# It opens various files from /sys/, and it should be
+			# considered very slow.
+			#
+			# Each hash may contain information including:
+			#
+			# path, name, label
+			# rpm, temp_crit, temp_max
+			#
+			# But if the info isn't available, it will return an empty Array.
+			def fans
+				query_hwmon('fan'.freeze, :rpm)
+			end
+
+			##
+			# Counts the number of sensors (fans are not counted)
+			#
+			# The return type is an Integer.
+			def count_sensors
+				return 0 unless hwmon_readable?
+
+				Dir["/sys/class/hwmon/hwmon[0-9]*/temp[0-9]*_input".freeze].size
+			end
+
+			##
+			# Counts the number of fans (sensors are not counted)
+			#
+			# The return type is an Integer.
+			def count_fans
+				return 0 unless hwmon_readable?
+
+				Dir["/sys/class/hwmon/hwmon[0-9]*/fan[0-9]*_input".freeze].size
+			end
+
+			private
+			def hwmon_readable?
+				@@hwmon_readable ||= File.readable?("/sys/class/hwmon/")
+			end
+
+			def query_hwmon(mon, key, div = false)
+				return [] unless hwmon_readable?
+
+				name = dir = ''.freeze
+
+				files = Dir["/sys/class/hwmon/hwmon[0-9]*/#{mon}[0-9]*_input".freeze]
+				i = -1
+				ret = []
+
+				while x = files[i += 1]
+					splitted = File.split(x)
+					path = File.join(splitted[0..-2])
+
+					n = splitted[-1][/.*_/]
+
+					label_f = "#{path}/#{n}label"
+					label = File.readable?(label_f) ? IO.read(label_f, encoding: 'ASCII-8BIT'.freeze).strip : nil
+
+					temp_crit_f = "#{path}/#{n}crit"
+					temp_crit = File.readable?(temp_crit_f) ? IO.read(temp_crit_f, encoding: 'ASCII-8BIT'.freeze).to_i : nil
+
+					temp_max_f = "#{path}/#{n}max"
+					temp_max = File.readable?(temp_max_f) ? IO.read(temp_max_f, encoding: 'ASCII-8BIT'.freeze).to_i : nil
+
+					value = File.readable?(x) ? IO.read(x).to_i : nil
+
+					if dir != path
+						dir = path
+						name_f = "#{path}/name"
+						name = File.readable?(name_f) ? IO.read(name_f, encoding: 'ASCII-8BIT'.freeze).tap(&:strip!) : ''.freeze
+					end
+
+					if div
+						value /= 1000.0
+						temp_max /= 1000.0 if temp_max
+						temp_crit /= 1000.0 if temp_crit
+					end
+
+					h = {path: path, name: name}
+
+					h.merge!(label: label) if label
+					h.merge!(key => value)
+					h.merge!(temp_crit: temp_crit) if temp_crit
+					h.merge!(temp_crit: temp_max) if temp_max
+
+					ret.push(h)
+				end
+
+				ret
+			end
+		end
+	end
+end

data/lib/linux_stat/usb.rb

@@ -1,4 +1,6 @@
 module LinuxStat
+	# Shows various USB device related information of the current system.
+
 	module USB
 		class << self
 			##
@@ -49,73 +51,75 @@ module LinuxStat
 				return [] unless @@sys_usb_readable
 
 				Dir['/sys/bus/usb/devices/*/'.freeze].sort!.map! { |x|
-					id_vendor_file = File.join(x, 'idVendor'.freeze)
-					next unless File.readable?(id_vendor_file)
-					id_vendor = IO.read(id_vendor_file).strip
+					begin
+						id_vendor_file = File.join(x, 'idVendor'.freeze)
+						next unless File.readable?(id_vendor_file)
+						id_vendor = IO.read(id_vendor_file).strip
 
-					id_product_file = File.join(x, 'idProduct'.freeze)
-					next unless File.readable?(id_vendor_file)
-					id_product = IO.read(id_product_file).strip
+						id_product_file = File.join(x, 'idProduct'.freeze)
+						next unless File.readable?(id_vendor_file)
+						id_product = IO.read(id_product_file).strip
 
-					bus_num_file = File.join(x, 'busnum'.freeze)
-					bus_num = File.readable?(bus_num_file) ? IO.read(bus_num_file).strip : ''.freeze
+						bus_num_file = File.join(x, 'busnum'.freeze)
+						bus_num = File.readable?(bus_num_file) ? IO.read(bus_num_file).strip : ''.freeze
 
-					dev_num_file = File.join(x, 'devnum'.freeze)
-					dev_num = File.readable?(dev_num_file) ? IO.read(dev_num_file).strip : ''.freeze
+						dev_num_file = File.join(x, 'devnum'.freeze)
+						dev_num = File.readable?(dev_num_file) ? IO.read(dev_num_file).strip : ''.freeze
 
-					serial_file = File.join(x, 'serial'.freeze)
-					serial = File.readable?(serial_file) ? IO.read(serial_file).strip : ''.freeze
+						serial_file = File.join(x, 'serial'.freeze)
+						serial = File.readable?(serial_file) ? IO.read(serial_file).strip : ''.freeze
 
-					product_file = File.join(x, 'product'.freeze)
-					product = File.readable?(product_file) ? IO.read(product_file).strip : ''.freeze
+						product_file = File.join(x, 'product'.freeze)
+						product = File.readable?(product_file) ? IO.read(product_file).strip : ''.freeze
 
-					manufacturer_file = File.join(x, 'manufacturer'.freeze)
-					manufacturer = File.readable?(manufacturer_file) ? IO.read(manufacturer_file).strip : ''.freeze
+						manufacturer_file = File.join(x, 'manufacturer'.freeze)
+						manufacturer = File.readable?(manufacturer_file) ? IO.read(manufacturer_file).strip : ''.freeze
 
-					removable_file = File.join(x, 'removable'.freeze)
-					removable = File.readable?(removable_file) ? IO.read(removable_file).strip : ''.freeze
+						removable_file = File.join(x, 'removable'.freeze)
+						removable = File.readable?(removable_file) ? IO.read(removable_file).strip.downcase : ''.freeze
 
-					authorized_file = File.join(x, 'authorized'.freeze)
-					authorized = File.readable?(authorized_file) ? IO.read(authorized_file).to_i : ''.freeze
+						authorized_file = File.join(x, 'authorized'.freeze)
+						authorized = File.readable?(authorized_file) ? IO.read(authorized_file).to_i : ''.freeze
 
-					b_max_power_file = File.join(x, 'bMaxPower'.freeze)
-					b_max_power = File.readable?(b_max_power_file) ? IO.read(b_max_power_file).strip : ''.freeze
+						b_max_power_file = File.join(x, 'bMaxPower'.freeze)
+						b_max_power = File.readable?(b_max_power_file) ? IO.read(b_max_power_file).strip : ''.freeze
 
-					b_max_packet_size0_file = File.join(x, 'bMaxPacketSize0'.freeze)
-					b_max_packet_size0 = File.readable?(b_max_packet_size0_file) ? IO.read(b_max_packet_size0_file).to_i : ''.freeze
+						b_max_packet_size0_file = File.join(x, 'bMaxPacketSize0'.freeze)
+						b_max_packet_size0 = File.readable?(b_max_packet_size0_file) ? IO.read(b_max_packet_size0_file).to_i : ''.freeze
 
-					query = hwdata ? query_hwdata(id_vendor, id_product) : {}
+						query = hwdata ? query_hwdata(id_vendor, id_product) : {}
 
-					removable.downcase!
-					is_removable = if removable == 'removable'.freeze
-						true
-					elsif removable == 'unknown'.freeze
-						nil
-					else
-						false
-					end
+						is_removable = if removable == 'removable'.freeze
+							true
+						elsif removable == 'unknown'.freeze
+							nil
+						else
+							false
+						end
 
-					ret = {
-						path: x, id: "#{id_vendor}:#{id_product}",
-						vendor_id: id_vendor, product_id: id_product
-					}
+						ret = {
+							path: x, id: "#{id_vendor}:#{id_product}",
+							vendor_id: id_vendor, product_id: id_product
+						}
 
-					ret.merge!(bus_num: bus_num.to_i) unless bus_num.empty?
-					ret.merge!(dev_num: dev_num.to_i) unless dev_num.empty?
+						ret.merge!(bus_num: bus_num.to_i) unless bus_num.empty?
+						ret.merge!(dev_num: dev_num.to_i) unless dev_num.empty?
 
-					ret.merge!(serial: serial) unless serial.empty?
+						ret.merge!(serial: serial) unless serial.empty?
 
-					ret.merge!(hwdata: query) unless query.empty?
-					ret.merge!(product: product) unless product.empty?
-					ret.merge!(manufacturer: manufacturer) unless manufacturer.empty?
+						ret.merge!(hwdata: query) unless query.empty?
+						ret.merge!(product: product) unless product.empty?
+						ret.merge!(manufacturer: manufacturer) unless manufacturer.empty?
 
-					ret.merge!(removable: is_removable) unless is_removable.nil?
-					ret.merge!(authorized: authorized == 1)
+						ret.merge!(removable: is_removable) unless is_removable.nil?
+						ret.merge!(authorized: authorized == 1)
 
-					ret.merge!(b_max_power: b_max_power) unless b_max_power.empty?
-					ret.merge!(b_max_packet_size0: b_max_packet_size0) if b_max_packet_size0
+						ret.merge!(b_max_power: b_max_power) unless b_max_power.empty?
+						ret.merge!(b_max_packet_size0: b_max_packet_size0) if b_max_packet_size0
 
-					ret
+						ret
+					rescue StandardError
+					end
 				}.tap(&:compact!)
 			end