linux_stat 1.1.0 → 1.2.3

data/ext/sysconf/sysconf.c

@@ -119,6 +119,15 @@ static VALUE getEUID(VALUE obj) {
 	return INT2FIX(geteuid()) ;
 }
 
+static VALUE getHostname(VALUE obj) {
+	int h_max = sysconf(_SC_HOST_NAME_MAX) + 1 ;
+	char hostname[h_max] ;
+
+	short int status = gethostname(hostname, h_max) ;
+
+	return (status < 0) ? rb_str_new_cstr("") : rb_str_new_cstr(hostname) ;
+}
+
 void Init_sysconf() {
 	VALUE _linux_stat = rb_define_module("LinuxStat") ;
 	VALUE _sysconf = rb_define_module_under(_linux_stat, "Sysconf") ;
@@ -144,4 +153,6 @@ void Init_sysconf() {
 
 	rb_define_module_function(_sysconf, "get_user", getUser, 0) ;
 	rb_define_module_function(_sysconf, "get_login", getUser, 0) ;
+
+	rb_define_module_function(_sysconf, "hostname", getHostname, 0) ;
 }

data/lib/linux_stat.rb

@@ -15,8 +15,8 @@
 
 # Miscellaneous Modules
 # Independed and LinuxStat's miscellaneous modules
-require "linux_stat/version"
 require 'linux_stat/prettify_bytes'
+require "linux_stat/version"
 
 # Independed Modules
 # Modules that doesn't have any dependency on its own

data/lib/linux_stat/memory.rb

@@ -11,7 +11,7 @@ module LinuxStat
 			def stat
 				return {} unless meminfo?
 
-				memory = IO.foreach('/proc/meminfo').first(3)
+				memory = IO.foreach('/proc/meminfo'.freeze).first(3)
 
 				total = memory[0].split[1].to_i
 				available = memory[2].split[1].to_i
@@ -39,7 +39,7 @@ module LinuxStat
 			# It retuns an Integer but if the info is not available, it will return nil.
 			def total
 				return nil unless meminfo?
-				IO.foreach('/proc/meminfo').first.split[1].to_i
+				IO.foreach('/proc/meminfo'.freeze).first.split[1].to_i
 			end
 
 			##
@@ -49,7 +49,7 @@ module LinuxStat
 			# It retuns an Integer but if the info is not available, it will return nil
 			def available
 				return nil unless meminfo?
-				IO.foreach('/proc/meminfo').first(3)[-1].split[1].to_i
+				IO.foreach('/proc/meminfo'.freeze).first(3)[-1].split[1].to_i
 			end
 
 			##
@@ -59,7 +59,7 @@ module LinuxStat
 			# It retuns an Integer but if the info is not available, it will return nil.
 			def used
 				return nil unless meminfo?
-				memory = IO.foreach('/proc/meminfo').first(3)
+				memory = IO.foreach('/proc/meminfo'.freeze).first(3)
 				memory[0].split[1].to_i - memory[2].split[1].to_i
 			end
 
@@ -69,7 +69,7 @@ module LinuxStat
 			# It retuns an Integer but if the info is not available, it will return nil
 			def percent_used
 				return nil unless meminfo?
-				memory = IO.foreach('/proc/meminfo').first(3)
+				memory = IO.foreach('/proc/meminfo'.freeze).first(3)
 				total = memory[0].split[1].to_i
 				total.-(memory[2].split[1].to_i).*(100).fdiv(total).round(2)
 			end
@@ -80,13 +80,13 @@ module LinuxStat
 			# It retuns an Integer but if the info is not available,  it will return nil
 			def percent_available
 				return nil unless meminfo?
-				memory = IO.foreach('/proc/meminfo').first(3)
+				memory = IO.foreach('/proc/meminfo'.freeze).first(3)
 				memory[2].split[1].to_i.*(100).fdiv(memory[0].split[1].to_i).round(2)
 			end
 
 			private
 			def meminfo?
-				@@readable ||= File.readable?('/proc/meminfo')
+				@@readable ||= File.readable?('/proc/meminfo'.freeze)
 			end
 		end
 	end

data/lib/linux_stat/mounts.rb

@@ -209,17 +209,17 @@ module LinuxStat
 
 			private
 			def mount_readable?
-				@@mount_readable ||= File.readable?('/proc/mounts')
+				@@mount_readable ||= File.readable?('/proc/mounts'.freeze)
 			end
 
 			def mounts
 				return [] unless mount_readable?
-				IO.readlines('/proc/mounts').each(&:strip!)
+				IO.readlines('/proc/mounts'.freeze).each(&:strip!)
 			end
 
 			def find_root
 				return [] unless mount_readable?
-				@@root ||= IO.foreach('/proc/mounts').find { |x| x.split[1] == '/'.freeze }.split
+				@@root ||= IO.foreach('/proc/mounts'.freeze).find { |x| x.split[1] == '/'.freeze }.split
 			end
 
 			def fs_info(dev)

data/lib/linux_stat/net.rb

@@ -86,13 +86,13 @@ module LinuxStat
 
 				data = IO.readlines(DEV).drop(2)
 				indices = find_index_of_bytes
-				data.reject! { |x| x.strip.start_with?('lo:') }
+				data.reject! { |x| x.strip.start_with?('lo:'.freeze) }
 				r, t = data.map { |x| x.split.values_at(*indices).map(&:to_i) }.transpose.map(&:sum)
 
 				sleep(interval)
 
 				data2 = IO.readlines(DEV).drop(2)
-				data2.reject! { |x| x.strip.start_with?('lo:') }
+				data2.reject! { |x| x.strip.start_with?('lo:'.freeze) }
 				r2, t2 = data2.map { |x| x.split.values_at(*indices).map(&:to_i) }.transpose.map(&:sum)
 
 				# Measure the difference
@@ -118,8 +118,8 @@ module LinuxStat
 
 					r.each_with_index { |x, i|
 						downcased = x.downcase
-						h.merge!(:r => i) if downcased.start_with?('receive')
-						h.merge!(:t => i) if downcased.start_with?('transmit')
+						h.merge!(:r => i) if downcased.start_with?('receive'.freeze)
+						h.merge!(:t => i) if downcased.start_with?('transmit'.freeze)
 					}
 
 					data_0 = data.next.gsub(?|.freeze, ' %'.freeze)

data/lib/linux_stat/os.rb

@@ -51,14 +51,46 @@ module LinuxStat
 						v[:DISTRIB_DESCRIPTION]
 					elsif v.key?(:DISTRIB_ID)
 						v[:DISTRIB_ID]
-					elsif File.readable?('/etc/issue')
-						IO.read('/etc/issue').strip
+					elsif File.readable?('/etc/issue'.freeze)
+						IO.read('/etc/issue'.freeze, encoding: 'ASCII-8bit'.freeze).strip
 					else
 						'Unknown'.freeze
 					end
 				end
 			end
 
+			##
+			# Gives you the version of the OS you are using.
+			#
+			# On ArchLinux for example:
+			#    LinuxStat::OS.version
+			#
+			#    => "rolling"
+			#
+			# On Ubuntu 20.04:
+			#    LinuxStat::OS.version
+			#
+			#    => "20.04"
+			#
+			# On CentOS 26:
+			#    LinuxStat::OS.version
+			#
+			#    => "26"
+			#
+			# The return type is String.
+			# But if the information isn't available, it will return an empty frozen String.
+			def version
+				@@distrib_version ||= if os_release.key?(:VERSION_ID)
+					os_release[:VERSION_ID]
+				elsif lsb_release.key?(:DISTRIB_RELEASE)
+					lsb_release[:DISTRIB_RELEASE]
+				elsif os_release.key?(:VERSION)
+					os_release[:VERSION]
+				else
+					''.freeze
+				end
+			end
+
 			##
 			# Uses utsname.h to determine the machine
 			#
@@ -70,22 +102,18 @@ module LinuxStat
 			##
 			# Uses utsname.h to determine the system nodename
 			#
-			# It returns String but if the info isn't available, it will return an empty String
+			# It returns String but if the info isn't available, it will return an empty String.
 			def nodename
-				@@nodename ||= LinuxStat::Uname.nodename
+				LinuxStat::Uname.nodename
 			end
 
 			##
-			# Reads /etc/hostname and returns the hostname.
+			# Returns the hostname from LinuxStat::Sysconf.hostname.
 			#
 			# The return type is String.
-			# If the info info isn't available, it will return 'localhost'.
+			# If the info info isn't available, it will return an empty String.
 			def hostname
-				@@hostname ||= if File.exist?('/etc/hostname')
-					IO.read('/etc/hostname').strip
-				else
-					'localhost'
-				end
+				LinuxStat::Sysconf.hostname
 			end
 
 			##
@@ -114,7 +142,7 @@ module LinuxStat
 			def uptime
 				return {} unless uptime_readable?
 
-				uptime = IO.read('/proc/uptime').to_f
+				uptime = IO.read('/proc/uptime'.freeze).to_f
 				uptime_i = uptime.to_i
 
 				h = uptime_i / 3600
@@ -128,16 +156,21 @@ module LinuxStat
 				}.freeze
 			end
 
+			alias distrib_version version
+
 			private
 			def release(file)
 				IO.readlines(file, 4096).reduce({}) { |h, x|
 					x.strip!
 					next h if x.empty?
 
-					splitted = x.split(?=)
+					splitted = x.split(?=.freeze)
+
+					key = splitted[0].to_s
+					key.strip!
 
-					key = splitted[0].to_s.strip
-					value = splitted[1..-1].join(?=).to_s.strip
+					value = splitted[1..-1].join(?=.freeze).to_s
+					value.strip!
 
 					value[0] = ''.freeze if value[0] == ?".freeze
 					value[-1] = ''.freeze if value[-1] == ?".freeze

data/lib/linux_stat/pci.rb

@@ -6,11 +6,11 @@ module LinuxStat
 			#
 			# [ Not to be confused with devices_stat ]
 			#
-			# Take a look at system_stat for more results.
+			# Take a look at LinuxStat::PCI.devices_stat for more info.
 			#
 			# Returns details about the devices found in /proc/bus/pci/devices file.
 			#
-			# The details doesn't contain a lot of details, it's short and opens just one file once.
+			# The details doesn't contain a lot of details, it opens just one file.
 			#
 			# The return value is an Array of multiple Hashes. If there's no info available,
 			# it will rather return an empty Array.
@@ -130,70 +130,73 @@ module LinuxStat
 				return devices_info(hwdata: hwdata) unless @@sys_pci_readable
 
 				Dir['/sys/bus/pci/devices/*/'.freeze].sort!.map! { |x|
-					_vendor_file = File.join(x, 'vendor'.freeze)
-					next unless File.readable?(_vendor_file)
-					vendor = IO.read(_vendor_file).to_i(16).to_s(16)
-					prepend_0(vendor)
-
-					_device_file = File.join(x, 'device'.freeze)
-					next unless File.readable?(_device_file)
-					device = IO.read(_device_file).to_i(16).to_s(16)
-					prepend_0(device)
-
-					_sub_vendor_file = File.join(x, 'subsystem_vendor'.freeze)
-					sub_vendor = File.readable?(_sub_vendor_file) ? IO.read(_sub_vendor_file).to_i(16).to_s(16) : nil
-					prepend_0(sub_vendor) if sub_vendor
-
-					_sub_device_file = File.join(x, 'subsystem_device'.freeze)
-					sub_device = File.readable?(_sub_device_file) ? IO.read(_sub_device_file).to_i(16).to_s(16) : nil
-					prepend_0(sub_device) if sub_device
-
-					_uevent = File.join(x, 'uevent'.freeze)
-					uevent = File.readable?(_uevent) ? IO.foreach(_uevent) : nil
-
-					kernel_driver = if uevent
-						uevent.find { |_x|
-							_x.split(?=.freeze)[0].to_s.tap(&:strip!) == 'DRIVER'.freeze
-						} &.split(?=) &.[](1) &.tap(&:strip!)
-					else
-						nil
-					end
+					begin
+						_vendor_file = File.join(x, 'vendor'.freeze)
+						next unless File.readable?(_vendor_file)
+						vendor = IO.read(_vendor_file).to_i(16).to_s(16)
+						prepend_0(vendor)
+
+						_device_file = File.join(x, 'device'.freeze)
+						next unless File.readable?(_device_file)
+						device = IO.read(_device_file).to_i(16).to_s(16)
+						prepend_0(device)
+
+						_sub_vendor_file = File.join(x, 'subsystem_vendor'.freeze)
+						sub_vendor = File.readable?(_sub_vendor_file) ? IO.read(_sub_vendor_file).to_i(16).to_s(16) : nil
+						prepend_0(sub_vendor) if sub_vendor
+
+						_sub_device_file = File.join(x, 'subsystem_device'.freeze)
+						sub_device = File.readable?(_sub_device_file) ? IO.read(_sub_device_file).to_i(16).to_s(16) : nil
+						prepend_0(sub_device) if sub_device
+
+						_uevent = File.join(x, 'uevent'.freeze)
+						uevent = File.readable?(_uevent) ? IO.foreach(_uevent) : nil
+
+						kernel_driver = if uevent
+							uevent.find { |_x|
+								_x.split(?=.freeze)[0].to_s.tap(&:strip!) == 'DRIVER'.freeze
+							} &.split(?=) &.[](1) &.tap(&:strip!)
+						else
+							nil
+						end
 
-					_revision_file = File.join(x, 'revision'.freeze)
-					revision = File.readable?(_revision_file) ? IO.read(_revision_file).tap(&:strip!) : ''.freeze
+						_revision_file = File.join(x, 'revision'.freeze)
+						revision = File.readable?(_revision_file) ? IO.read(_revision_file).tap(&:strip!) : ''.freeze
 
-					_irq_file = File.join(x, 'irq'.freeze)
-					irq = File.readable?(_irq_file) ? IO.read(_irq_file).to_i : nil
+						_irq_file = File.join(x, 'irq'.freeze)
+						irq = File.readable?(_irq_file) ? IO.read(_irq_file).to_i : nil
 
-					_enable_file = File.join(x, 'enable'.freeze)
-					enable = File.readable?(_enable_file) ? IO.read(_enable_file).to_i  == 1 : nil
+						_enable_file = File.join(x, 'enable'.freeze)
+						enable = File.readable?(_enable_file) ? IO.read(_enable_file).to_i  == 1 : nil
 
-					query = if hwdata && sub_vendor && sub_device
-						query_hwdata(vendor, device, sub_vendor, sub_device)
-					elsif hwdata && sub_vendor
-						query_hwdata(vendor, device, sub_vendor)
-					elsif hwdata
-						query_hwdata(vendor, device)
-					else
-						{}
-					end
+						query = if hwdata && sub_vendor && sub_device
+							query_hwdata(vendor, device, sub_vendor, sub_device)
+						elsif hwdata && sub_vendor
+							query_hwdata(vendor, device, sub_vendor)
+						elsif hwdata
+							query_hwdata(vendor, device)
+						else
+							{}
+						end
 
-					ret = {
-						path: x, id: "#{vendor}:#{device}",
-						vendor: vendor, device: device
-					}
+						ret = {
+							path: x, id: "#{vendor}:#{device}",
+							vendor: vendor, device: device
+						}
 
-					ret.merge!(sub_vendor: sub_vendor) if sub_vendor
-					ret.merge!(sub_device: sub_device) if sub_device
+						ret.merge!(sub_vendor: sub_vendor) if sub_vendor
+						ret.merge!(sub_device: sub_device) if sub_device
 
-					ret.merge!(kernel_driver: kernel_driver) if kernel_driver
-					ret.merge!(revision: revision) unless revision.empty?
-					ret.merge!(irq: irq) if irq
-					ret.merge!(enable: enable) unless enable.nil?
-					ret.merge!(hwdata: query) unless query.empty?
+						ret.merge!(kernel_driver: kernel_driver) if kernel_driver
+						ret.merge!(revision: revision) unless revision.empty?
+						ret.merge!(irq: irq) if irq
+						ret.merge!(enable: enable) unless enable.nil?
+						ret.merge!(hwdata: query) unless query.empty?
 
-					ret
-				}
+						ret
+					rescue StandardError
+					end
+				}.tap(&:compact!)
 			end
 
 			##
@@ -227,11 +230,63 @@ module LinuxStat
 				end
 			end
 
+			##
+			# hwdata_file = file
+			#
+			# Lets you set the hwdata_file about pci.ids.
+			#
+			# The hwdata file about pci.ids contains vendor name and product name information about
+			# devices. This is then mapped by the other methods that utilizes hwdata/pci.ids.
+			#
+			# Do note that this method is intended to run only once, at the beginning.
+			# If you use any other method that utilizes hwdata/pci.ids, before
+			# calling this method, this method will not work.
+			def hwdata_file=(file)
+				@@hwdata_file ||= file.freeze
+			end
+
+			##
+			# Checks if hwdata_file is already initialized or not.
+			# Once it's initialized, calling hwdata_file = 'something/pci.ids' is futile.
+			def hwdata_file_set?
+				@@hwdata_file ||= false
+				!!@@hwdata_file
+			end
+
+			##
+			# Returns the hwdata_file as string.
+			#
+			# If hwdata_file isn't set, it will return an empty frozen string.
+			#
+			# Once it's set, it can't be changed.
+			def hwdata_file
+				@@hwdata_file ||= nil
+				@@hwdata_file ? @@hwdata_file : ''.freeze
+			end
+
+			##
+			# Initializes hwdata
+			#
+			# hwdata can take upto 0.1 to 0.2 seconds to get initialized.
+			#
+			# Calling this method will load hwdata for future use.
+			#
+			# Once it's initialized, hwdata_file can't be changed.
+			#
+			# If this method initializes hwdata, it will return true
+			# Othewise this method will return false.
+			def initialize_hwdata
+				@@hwdata ||= nil
+				init = !@@hwdata
+				hwdata
+				init
+			end
+
 			alias count_devices count
 
 			private
 			def hwdata
-				@@hwdata_file ||= "/usr/share/hwdata/pci.ids"
+				@@hwdata_file ||= "/usr/share/hwdata/pci.ids".freeze
 
 				@@hwdata ||= if File.readable?(@@hwdata_file)
 					ret, vendor_id, device_id, device = {}, nil, nil, nil