linux_stat 0.3.3 → 0.6.1

data/lib/linux_stat/kernel.rb

@@ -3,7 +3,7 @@ module LinuxStat
 		class << self
 			# Returns the Linux Kernel version.
 			# If the information isn't available, it will return a frozen empty string.
-			# The output is also cached ; as changing the value in runtime is unexpected.
+			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
 			def version
 				return ''.freeze if string.empty?
 				@@version ||= splitted[2]
@@ -11,7 +11,7 @@ module LinuxStat
 
 			# Returns the name of the user who built the kernel using KBUILD_FLAGS.
 			# If the information isn't available, it will return a frozen empty string.
-			# The output is also cached ; as changing the value in runtime is unexpected.
+			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
 			def build_user
 				@@build_user ||= string.split(/(\(.+\))/).each(&:strip!)
 					.reject(&:empty?).find { |x| x[/^\(.+\)$/] }.to_s
@@ -20,7 +20,7 @@ module LinuxStat
 
 			# Returns the compiler used to compile the Linux Kernel.
 			# If the information isn't available, it will return a frozen empty string.
-			# The output is also cached ; as changing the value in runtime is unexpected.
+			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
 			def compiler
 				return ''.freeze if string.empty?
 
@@ -39,7 +39,7 @@ module LinuxStat
 
 			# Returns the compiler version used to compile the Linux Kernel.
 			# If the information isn't available, it will return a frozen empty string.
-			# The output is also cached ; as changing the value in runtime is unexpected.
+			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
 			def compiler_version
 				@@compiler_version ||= string.split(/(\(.+?\))/).each(&:strip!)
 					.reject(&:empty?)[2..4].to_a
@@ -62,7 +62,7 @@ module LinuxStat
 			# You have to use regexp yourself to get the proper zone.
 			# Use LinuxStat::Kernel.build_date_string to get the original string if you need that.
 			#
-			# The output is also cached ; as changing the value in runtime is unexpected.
+			# The output is also cached  (memoized) ; as changing the value in runtime is unexpected.
 			def build_date
 				return nil if splitted.empty?
 
@@ -107,7 +107,7 @@ module LinuxStat
 			# You have to use regexp yourself to get the proper zone.
 			# Use LinuxStat::Kernel.build_date_string to get the original string if you need that.
 			#
-			# The output is also cached ; as changing the value in runtime is unexpected.
+			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
 			def build_date_string
 				return nil if splitted.empty?
 
@@ -133,14 +133,22 @@ module LinuxStat
 				end
 			end
 
-			alias release version
-
 			# Reads maximum 1024 bytes from /proc/version and returns the string.
 			# The output is also cached ; as changing the value in runtime is unexpected.
 			def string
 				@@string ||= File.readable?('/proc/version') ? IO.read('/proc/version', 1024).tap(&:strip!) : ''
 			end
 
+			# Returns the sc_clk_tck or the same output from command `getconf CLK_TCK`.
+			# Also, clk_tck is an alias of this method.
+			# The output is also cached ; as changing the value in runtime is unexpected.
+			def ticks
+				@@tick ||= LinuxStat::Sysconf.sc_clk_tck
+			end
+
+			alias release version
+			alias clk_tck ticks
+
 			private
 			def splitted
 				@@string_splitted ||= string.split

data/lib/linux_stat/memory.rb

@@ -2,9 +2,10 @@ module LinuxStat
 	module Memory
 		class << self
 			# Returns the memory details reported by /proc/meminfo. In this format:
-			# {:total=>3836264, :used=>3097952, :available=>738312, :percent_used=>80.75, :percent_available=>19.25}
+			#    {:total=>3836264, :used=>3097952, :available=>738312, :percent_used=>80.75, :percent_available=>19.25}
+			#
+			# The values are in Kilobyte.
 			#
-			# The value is in Kilobyte.
 			# If the statistics is not available, it will return an empty Hash.
 			def stat
 				return {} unless meminfo?
@@ -31,6 +32,7 @@ module LinuxStat
 
 			# Returns the total memory details reported by /proc/meminfo.
 			# The value is in Kilobyte.
+			#
 			# It retuns an Integer but if the info is not available, it will return nil.
 			def total
 				return nil unless meminfo?
@@ -39,6 +41,7 @@ module LinuxStat
 
 			# Returns the total memory details reported by /proc/meminfo.
 			# The value is in Kilobyte.
+			#
 			# It retuns an Integer but if the info is not available, it will return nil
 			def available
 				return nil unless meminfo?
@@ -47,6 +50,7 @@ module LinuxStat
 
 			# Returns the amount of memory used reported by /proc/meminfo.
 			# The value is in Kilobyte.
+			#
 			# It retuns an Integer but if the info is not available, it will return nil.
 			def used
 				return nil unless meminfo?
@@ -55,6 +59,7 @@ module LinuxStat
 			end
 
 			# Returns the percentage of memory used reported by /proc/meminfo.
+			#
 			# It retuns an Integer but if the info is not available, it will return nil
 			def percent_used
 				return nil unless meminfo?
@@ -64,6 +69,7 @@ module LinuxStat
 			end
 
 			# Returns the percentage of memory used reported by /proc/meminfo.
+			#
 			# It retuns an Integer but if the info is not available,  it will return nil
 			def percent_available
 				return nil unless meminfo?

data/lib/linux_stat/mounts.rb

@@ -1,7 +1,8 @@
 module LinuxStat
 	module Mounts
 		class << self
-			# Reads /proc/mounts and returns list of devices.
+			# Reads /proc/mounts and returns the output splitted with \n.
+			# In other words, it's same as running IO.readlines('/proc/mounts').each(&:strip!)
 			#
 			# It returns an Array.
 			# If the info isn't available or /proc/mounts is not readable, it will return an empty Array.
@@ -9,6 +10,14 @@ module LinuxStat
 				mounts
 			end
 
+			# Reads /proc/mounts and returns list of devices.
+			#
+			# It returns an Array.
+			# If the info isn't available or /proc/mounts is not readable, it will return an empty Array.
+			def list_devices
+				mounts.map { |x| x.split(?\s.freeze).first }
+			end
+
 			# Reads /proc/mounts and returns partition name of the device mounted at /.
 			#
 			# It returns a String.
@@ -45,6 +54,135 @@ module LinuxStat
 				ret
 			end
 
+			# mount_point(dev = root)
+			# Where device = block device.
+			# The default argument is the root block device.
+			#
+			# It helps you find the mountpoint of a block device.
+			# For example:
+			#    LinuxStat::Mounts.mount_point('/dev/sdb1')
+			#    => "/run/media/sourav/5c2b7af7-d4c3-4ab4-a035-06d18ffc8e6f"
+			#
+			# The return type is String.
+			# But if the status isn't available or the device isn't mounted, it will return an empty String.
+			def mount_point(dev = root)
+				m = ''
+				mounts.each do |x|
+					x.strip!
+
+					unless x.empty?
+						_x = x.split
+						if _x[0] == dev
+							m.replace(_x[1])
+							break
+						end
+					end
+				end
+				m
+			end
+
+			# list_devices_mount_point()
+			#
+			# It shows all the block devices corresponding to mount points.
+			#
+			# For example:
+			#    LinuxStat::Mounts.list_devices_mount_point
+			#    => {"proc"=>"/proc", "sys"=>"/sys", "dev"=>"/dev", "run"=>"/run", "/dev/sda2"=>"/", "securityfs"=>"/sys/kernel/security", "tmpfs"=>"/run/user/1000", "devpts"=>"/dev/pts", "cgroup2"=>"/sys/fs/cgroup/unified", "cgroup"=>"/sys/fs/cgroup/perf_event", "pstore"=>"/sys/fs/pstore", "none"=>"/sys/fs/bpf", "systemd-1"=>"/proc/sys/fs/binfmt_misc", "debugfs"=>"/sys/kernel/debug", "mqueue"=>"/dev/mqueue", "hugetlbfs"=>"/dev/hugepages", "tracefs"=>"/sys/kernel/tracing", "configfs"=>"/sys/kernel/config", "fusectl"=>"/sys/fs/fuse/connections", "gvfsd-fuse"=>"/run/user/1000/gvfs", "/dev/sdb1"=>"/run/media/sourav/5c2b7af7-d4c3-4ab4-a035-06d18ffc8e6f", "binfmt_misc"=>"/proc/sys/fs/binfmt_misc"}
+			#
+			# The return type is Hash.
+			# But if the status isn't available or the device isn't mounted, it will return an empty String.
+			def list_devices_mount_point
+				m = {}
+				mounts.each do |x|
+					x.strip!
+
+					unless x.empty?
+						_x = x.split
+						m.merge!(_x[0] => _x[1])
+					end
+				end
+				m
+			end
+
+			# devices_stat
+			# [ Not to confuse this method with device_stat(dev) which shows only one device's info ]
+			#
+			# It shows all the block devices corresponding to mount points and data from LinuxStat::FS.stat(arg)
+			#
+			# For example:
+			#    LinuxStat::Mounts.devices_stat
+			#    => {"proc"=>{:mountpoint=>"/proc", :total=>0, :free=>0, :available=>0, :used=>0, :percent_used=>NaN, :percent_free=>NaN, :percent_available=>NaN}, "/dev/sdb1"=>{:mountpoint=>"/run/media/sourav/5c2b7af7-d4c3-4ab4-a035-06d18ffc8e6f", :total=>31466008576, :free=>2693931008, :available=>2693931008, :used=>28772077568, :percent_used=>91.44, :percent_free=>8.56, :percent_available=>8.56}}
+			#
+			# The return type is Hash.
+			# But if the status isn't available, it will return an empty Hash.
+			def devices_stat
+				# Code duplication is fine if it gives maximum performance
+				m = {}
+				mounts.each do |x|
+					x.strip!
+
+					unless x.empty?
+						_x = x.split
+						total, free, available, used = fs_info(_x[1])
+
+						m.merge!(_x[0] => {
+							mountpoint: _x[1],
+
+							total: total,
+							free: free,
+							available: available,
+							used: used,
+
+							percent_used: used.*(100).fdiv(total).round(2),
+							percent_free: free.*(100).fdiv(total).round(2),
+							percent_available: available.*(100).fdiv(total).round(2),
+						})
+					end
+				end
+				m
+			end
+
+			# device_stat(dev = root)
+			# [ Not to confuse this method with devices_stat() which shows all devices ]
+			# It shows all the block devices corresponding to mount points and data from LinuxStat::FS.stat(arg)
+			#
+			# For example:
+			#    LinuxStat::Mounts.device_stat('/dev/sda2')
+			#    => {"/dev/sda2"=>{:mountpoint=>"/", :total=>119981191168, :free=>35298562048, :available=>35298562048, :used=>84682629120, :percent_used=>70.58, :percent_free=>29.42, :percent_available=>29.42}}
+			#
+			# The return type is Hash.
+			# But if the status isn't available, it will return an empty Hash.
+			def device_stat(dev = root)
+				# Code duplication is fine if it gives maximum performance
+				m = {}
+				mounts.each do |x|
+					x.strip!
+
+					unless x.empty?
+						_x = x.split
+						next if _x[0] != dev
+
+						total, free, available, used = fs_info(_x[1])
+
+						m.merge!({
+							mountpoint: _x[1],
+
+							total: total,
+							free: free,
+							available: available,
+							used: used,
+
+							percent_used: used.*(100).fdiv(total).round(2),
+							percent_free: free.*(100).fdiv(total).round(2),
+							percent_available: available.*(100).fdiv(total).round(2),
+						})
+
+						break
+					end
+				end
+				m
+			end
+
 			private
 			def mount_readable?
 				@@mount_readable ||= File.readable?('/proc/mounts')
@@ -59,6 +197,19 @@ module LinuxStat
 				return [] unless mount_readable?
 				@@root ||= IO.foreach('/proc/mounts').find { |x| x.split[1] == '/'.freeze }.split
 			end
+
+			def fs_info(dev)
+				# => [total, free, available, used]
+				s = LinuxStat::FS.stat(dev)
+				s.default = 0
+
+				[
+					s[:block_size] * s[:blocks],
+					s[:block_size] * s[:block_free],
+					s[:block_size] * s[:block_avail_unpriv],
+					s[:blocks].-(s[:block_free]) * s[:block_size]
+				]
+			end
 		end
 	end
 end

data/lib/linux_stat/os.rb

@@ -1,10 +1,8 @@
 module LinuxStat
 	module OS
-		prepend Uname
-
 		class << self
 			# Reads /etc/os-release and returns a Hash. For example:
-			# {:NAME=>"Arch Linux", :PRETTY_NAME=>"Arch Linux", :ID=>"arch", :BUILD_ID=>"rolling", :ANSI_COLOR=>"38;2;23;147;209", :HOME_URL=>"https://www.archlinux.org/", :DOCUMENTATION_URL=>"https://wiki.archlinux.org/", :SUPPORT_URL=>"https://bbs.archlinux.org/", :BUG_REPORT_URL=>"https://bugs.archlinux.org/", :LOGO=>"archlinux"}
+			#    {:NAME=>"Arch Linux", :PRETTY_NAME=>"Arch Linux", :ID=>"arch", :BUILD_ID=>"rolling", :ANSI_COLOR=>"38;2;23;147;209", :HOME_URL=>"https://www.archlinux.org/", :DOCUMENTATION_URL=>"https://wiki.archlinux.org/", :SUPPORT_URL=>"https://bbs.archlinux.org/", :BUG_REPORT_URL=>"https://bugs.archlinux.org/", :LOGO=>"archlinux"}
 			#
 			# If the info isn't available, it will return an empty Hash.
 			#
@@ -13,12 +11,12 @@ module LinuxStat
 			# The information is also cached, and once loaded, won't change in runtime. Because changing the /etc/lsb-release
 			# isn't expected in runtime.
 			def os_release
-				# Cached ; as changing the value in runtime is unexpected
+				# cached (memoized) ; as changing the value in runtime is unexpected
 				@@os_release ||= File.readable?('/etc/os-release') ? release('/etc/os-release') : {}
 			end
 
 			# Reads /etc/lsb-release and returns a Hash. For example:
-			# {:LSB_VERSION=>"1.4", :DISTRIB_ID=>"Arch", :DISTRIB_RELEASE=>"rolling", :DISTRIB_DESCRIPTION=>"Arch Linux"}
+			#    {:LSB_VERSION=>"1.4", :DISTRIB_ID=>"Arch", :DISTRIB_RELEASE=>"rolling", :DISTRIB_DESCRIPTION=>"Arch Linux"}
 			#
 			# If the info isn't available, it will return an empty Hash.
 			#
@@ -27,12 +25,13 @@ module LinuxStat
 			# The information is also cached, and once loaded, won't change in runtime. Because changing the /etc/lsb-release
 			# isn't expected in runtime.
 			def lsb_release
-				# Cached ; as changing the value in runtime is unexpected
+				# cached (memoized) ; as changing the value in runtime is unexpected
 				@@lsb_release ||= File.readable?('/etc/lsb-release') ? release('/etc/lsb-release') : {}
 			end
 
 			# Reads /etc/lsb-release or /etc/os-release tries to get information about the distribution.
 			# If the information isn't available, it will read and return /etc/issue.
+			#
 			# The return type is String.
 			# If none of the info is available, it will return an empty frozen String.
 			def distribution
@@ -54,18 +53,21 @@ module LinuxStat
 			end
 
 			# Uses utsname.h to determine the machine
+			#
 			# It returns a String but if the info isn't available, it will return an empty String
 			def machine
-				@@machine ||= Uname.machine
+				@@machine ||= LinuxStat::Uname.machine
 			end
 
 			# Uses utsname.h to determine the system nodename
+			#
 			# It returns String but if the info isn't available, it will return an empty String
 			def nodename
-				@@nodename ||= Uname.nodename
+				@@nodename ||= LinuxStat::Uname.nodename
 			end
 
 			# Reads /etc/hostname and returns the hostname.
+			#
 			# The return type is String.
 			# If the info info isn't available, it will return 'localhost'.
 			def hostname
@@ -90,7 +92,7 @@ module LinuxStat
 			end
 
 			# Reads /proc/uptime and returns the system uptime:
-			# {:hour=>10, :minute=>34, :second=>12.59}
+			#    {:hour=>10, :minute=>34, :second=>12.59}
 			#
 			# If the stat isn't available, an empty hash is returned.
 			def uptime

data/lib/linux_stat/prettify_bytes.rb

@@ -0,0 +1,75 @@
+module LinuxStat
+	module PrettifyBytes
+		class << self
+			# Converts a number to decimal byte units and outputs with the metric prefix
+			# For example,
+			#
+			# LinuxStat::PrettifyBytes.convert_decimal(1000)    # => "1.0 kilobyte"
+			# LinuxStat::PrettifyBytes.convert_decimal(1000 ** 3)    # => "1.0 gigabyte"
+			# LinuxStat::PrettifyBytes.convert_decimal(1024 ** 3)   # => "1.07 gigabytes"
+			def convert_decimal(n)
+				@@d_units ||= %W(#{''} kilo mega giga tera peta exa zetta)
+					.map.with_index { |x, i| [x, 1000.**(i + 1)] }
+				unit = @@d_units.find { |x| n < x[1] } || ['yotta'.freeze, 10 ** 27]
+
+				converted = n.fdiv(unit[1] / 1000).round(2)
+				"#{pad_left(converted)} #{unit[0]}byte#{?s.freeze if converted != 1}"
+			end
+
+			# Converts a number to binary byte units and outputs with the IEC prefix
+			# For example,
+			#
+			# LinuxStat::PrettifyBytes.convert_binary(1000)    # => "1000.0 bytes"
+			# LinuxStat::PrettifyBytes.convert_binary(1000 ** 3)    # => "953.67 mebibytes"
+			# LinuxStat::PrettifyBytes.convert_binary(1024 ** 3)   # => "1.0 gibibyte"
+			def convert_binary(n)
+				@@b_units ||= %W(#{''} kibi mebi gibi tebi pebi exbi zebi)
+					.map.with_index { |x, i| [x, 1024.**(i + 1)] }
+				unit = @@b_units.find { |x| n < x[1] } || ['yobi'.freeze, 10 ** 27]
+
+				converted = n.fdiv(unit[1] / 1024).round(2)
+				"#{pad_left(converted)} #{unit[0]}byte#{?s.freeze if converted != 1}"
+			end
+
+			# Converts a number to decimal byte units
+			# For example,
+			#
+			# LinuxStat::PrettifyBytes.convert_short_decimal(1000)    # => "1.0 kB"
+			# LinuxStat::PrettifyBytes.convert_short_decimal(1000 ** 3)   # => "1.0 GB"
+			# LinuxStat::PrettifyBytes.convert_short_decimal(1024 ** 3)    # => "1.07 GB"
+			def convert_short_decimal(n)
+				@@sd_units ||= %W(#{''} k M G T P E Z)
+					.map.with_index { |x, i| [x, 1000.**(i + 1)] }
+				unit = @@sd_units.find { |x| n < x[1] } || [?Y.freeze, 10 ** 27]
+
+				converted = n.fdiv(unit[1] / 1000).round(2)
+				"#{pad_left(converted)} #{unit[0]}B"
+			end
+
+			# Converts a number to binary byte units
+			# For example,
+			#
+			# LinuxStat::PrettifyBytes.convert_short_binary(1000)    # => "1000 B"
+			# LinuxStat::PrettifyBytes.convert_short_binary(1000 ** 3)   # => "953.67 MiB"
+			# LinuxStat::PrettifyBytes.convert_short_binary(1024 ** 3)    # => "1.0 GiB"
+			def convert_short_binary(n)
+				return "#{n} B" if n < 1024
+
+				@@sb_units ||= %W(#{''} K M G T P E Z)
+					.map.with_index { |x, i| [x, 1024.**(i + 1)] }
+				unit = @@sb_units.find { |x| n < x[1] } || [?Y.freeze, 1024 ** 9]
+
+				converted = n.fdiv(unit[1] / 1024).round(2)
+				"#{pad_left(converted)} #{unit[0]}iB"
+			end
+
+			private
+			def pad_left(n, mantissa_length = 2)
+				n = n.round(mantissa_length)
+				exp, mant = n.to_s.split(?..freeze)
+				m = mant.length < mantissa_length ? mant + ?0.freeze * (mantissa_length - mant.length) : mant
+				exp + ?..freeze + m
+			end
+		end
+	end
+end