linux_stat 0.1.4 → 0.3.1

data/lib/linux_stat/memory.rb

@@ -1,6 +1,11 @@
 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}
+			#
+			# The value is in Kilobyte.
+			# If the statistics is not available, it will return an empty Hash.
 			def stat
 				return {} unless meminfo?
 
@@ -24,31 +29,44 @@ module LinuxStat
 				}
 			end
 
+			# 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 0 unless meminfo?
+				return nil unless meminfo?
 				IO.foreach('/proc/meminfo').first.split[1].to_i
 			end
 
+			# 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 0 unless meminfo?
+				return nil unless meminfo?
 				IO.foreach('/proc/meminfo').first(3)[-1].split[1].to_i
 			end
 
+			# 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 0 unless meminfo?
+				return nil unless meminfo?
 				memory = IO.foreach('/proc/meminfo').first(3)
 				memory[0].split[1].to_i - memory[2].split[1].to_i
 			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 0.0 unless meminfo?
+				return nil unless meminfo?
 				memory = IO.foreach('/proc/meminfo').first(3)
 				total = memory[0].split[1].to_i
 				total.-(memory[2].split[1].to_i).*(100).fdiv(total).round(2)
 			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 0.0 unless meminfo?
+				return nil unless meminfo?
 				memory = IO.foreach('/proc/meminfo').first(3)
 				memory[2].split[1].to_i.*(100).fdiv(memory[0].split[1].to_i).round(2)
 			end

data/lib/linux_stat/mounts.rb

@@ -0,0 +1,64 @@
+module LinuxStat
+	module Mounts
+		class << self
+			# 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
+				mounts
+			end
+
+			# Reads /proc/mounts and returns partition name of the device mounted at /.
+			#
+			# It returns a String.
+			# But if the info isn't available or /proc/mounts is not readable, it will return an empty frozen String.
+			def root
+				find_root[0].to_s
+			end
+
+			# Reads /proc/mounts and returns the file system of the device mounted at /.
+			#
+			# It returns a String.
+			# But if the info isn't available or /proc/mounts is not readable, it will return an empty frozen String.
+			def root_fs
+				find_root[2].to_s
+			end
+
+			# Reads /proc/mounts and returns the options used for mounting /.
+			#
+			# It returns a String.
+			# But if the info isn't available or /proc/mounts is not readable, it will return an empty frozen string.
+			def root_mount_options
+				find_root[3].to_s
+			end
+
+			# Reads /proc/mounts and finds all tmpfs.
+			#
+			# It returns a Hash
+			# But if the info isn't available or /proc/mounts is not readable, it will return an empty Hash.
+			def tmpfs
+				ret = {}
+				mounts.each { |x|
+					ret.merge!({x.split[1] => x}) if x.start_with?('tmpfs '.freeze)
+				}
+				ret
+			end
+
+			private
+			def mount_readable?
+				@@mount_readable ||= File.readable?('/proc/mounts')
+			end
+
+			def mounts
+				return [] unless mount_readable?
+				IO.readlines('/proc/mounts').each(&:strip!)
+			end
+
+			def find_root
+				return [] unless mount_readable?
+				@@root ||= IO.foreach('/proc/mounts').find { |x| x.split[1] == '/'.freeze }.split
+			end
+		end
+	end
+end

data/lib/linux_stat/net.rb

@@ -1,10 +1,12 @@
 module LinuxStat
 	module Net
 		class << self
+			# Returns the local IP address of the system as a String.
+			# If the information isn't available, it will a frozen empty string.
 			def ipv4_private
 				require 'socket'
 				ip = Socket.ip_address_list.find(&:ipv4_private?)
-				ip ? ip.ip? ? ip.ip_unpack[0].freeze : '' : ''
+				ip ? ip.ip? ? ip.ip_unpack[0].freeze : ''.freeze : ''.freeze
 			end
 		end
 	end

data/lib/linux_stat/os.rb

@@ -1,16 +1,38 @@
 module LinuxStat
 	module OS
 		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"}
+			#
+			# If the info isn't available, it will return an empty Hash.
+			#
+			# The amount of data read is 4096 bytes. Any more than that will result in truncated output.
+			#
+			# 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
 				@@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"}
+			#
+			# If the info isn't available, it will return an empty Hash.
+			#
+			# The amount of data read is 4096 bytes. Any more than that will result in truncated output.
+			#
+			# 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
 				@@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
 				@@distribution ||= if os_release.key?(:NAME)
 					os_release[:NAME]
@@ -29,6 +51,9 @@ module LinuxStat
 				end
 			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
 				@@hostname ||= if File.exist?('/etc/hostname')
 					IO.read('/etc/hostname').strip
@@ -37,6 +62,8 @@ module LinuxStat
 				end
 			end
 
+			# Reads ruby configuration and tries to guess if the system is 32 bit or 64 bit.
+			# The return type is Integer.
 			def bits
 				@@bits ||= if RbConfig::CONFIG['host_cpu'].end_with?('64') || RUBY_PLATFORM[/x86_64/]
 					64
@@ -45,8 +72,12 @@ module LinuxStat
 				end
 			end
 
+			# Reads /proc/uptime and returns the system uptime:
+			# {:hour=>10, :minute=>34, :second=>12.59}
+			#
+			# If the stat isn't available, an empty hash is returned.
 			def uptime
-				raise StatUnavailable, 'Cannot read /proc/uptime' unless uptime_readable?
+				return {} unless uptime_readable?
 
 				uptime = IO.read('/proc/uptime').to_f
 				uptime_i = uptime.to_i
@@ -64,7 +95,7 @@ module LinuxStat
 
 			private
 			def release(file)
-				IO.readlines(file, 3000).reduce({}) { |h, x|
+				IO.readlines(file, 4096).reduce({}) { |h, x|
 					x.strip!
 					next h if x.empty?
 

data/lib/linux_stat/process.rb

@@ -1,6 +1,8 @@
 module LinuxStat
 	module Process
 		class << self
+			# Returns the list of processes from /proc/.
+			# The return type is an Array of Integers.
 			def list
 				Dir['/proc/*'].select! { |x|
 					pid = File.split(x)[1]
@@ -8,10 +10,13 @@ module LinuxStat
 				}.map! { |x| File.split(x)[-1].to_i }
 			end
 
+			# Counts and returns the total number of process running on the system.
+			# The return type is Integer.
 			def count
 				list.count
 			end
 
+			# Returns all the id of processes mapped with their names as a Hash.
 			def names
 				list.reduce({}) { |h, x|
 					begin
@@ -22,6 +27,7 @@ module LinuxStat
 				}
 			end
 
+			# Returns all the id of processes mapped with their status as a Hash.
 			def types
 				list.reduce({}) { |h, x|
 					begin
@@ -40,6 +46,8 @@ module LinuxStat
 				}
 			end
 
+			# Returns all the id of processes that are sleeping.
+			# The return type is an Array of Integers.
 			def sleeping
 				list.select { |x|
 					begin
@@ -50,6 +58,8 @@ module LinuxStat
 				}
 			end
 
+			# Returns all the id of processes that are idle.
+			# The return type is an Array of Integers.
 			def idle
 				list.select { |x|
 					begin
@@ -60,6 +70,8 @@ module LinuxStat
 				}
 			end
 
+			# Returns all the id of processes that are zombies.
+			# The return type is an Array of Integers.
 			def zombie
 				list.select { |x|
 					begin
@@ -70,6 +82,8 @@ module LinuxStat
 				}
 			end
 
+			# Returns all the id of processes that are running.
+			# The return type is an Array of Integers.
 			def running
 				list.select { |x|
 					begin

data/lib/linux_stat/swap.rb

@@ -1,8 +1,11 @@
 module LinuxStat
 	module Swap
 		class << self
-			# List all swap devices
+			# List all swap devices and returns a Hash.
+			# If the info isn't available, it will return an empty Hash.
 			def list
+				return {} unless swaps_readable?
+
 				file = IO.readlines('/proc/swaps').drop(1)
 				file.reduce({}) do |h, x|
 					name, *stats = x.strip.split
@@ -10,8 +13,18 @@ module LinuxStat
 				end
 			end
 
-			# Show aggregated used and available swap
+			# Returns true if any swap device is available, else returns false.
+			# If the info isn't available, it will return an empty Hash.
+			def any?
+				!!IO.foreach('/proc/swaps').drop(1).first
+			end
+
+			# Show aggregated used and available swap.
+			# The values are in kilobytes.
+			# The return type is Hash.
+			# If the info isn't available, the return type is an empty Hash.
 			def stat
+				return {} unless swaps_readable?
 				values_t = read_usage
 
 				total, used = values_t[0].sum, values_t[-1].sum
@@ -29,20 +42,35 @@ module LinuxStat
 				}
 			end
 
+			# Show total amount of swap.
+			# The value is in kilobytes.
+			# The return type is a Integer but if the info isn't available, it will return nil.
 			def total
+				return nil unless swaps_readable?
 				read_usage[0].sum
 			end
 
+			# Show total amount of available swap.
+			# The value is in kilobytes.
+			# The return type is a Integer but if the info isn't available, it will return nil.
 			def available
+				return nil unless swaps_readable?
 				values_t = read_usage
 				values_t[0].sum - values_t[1].sum
 			end
 
+			# Show total amount of used swap.
+			# The value is in kilobytes.
+			# The return type is a Integer but if the info isn't available, it will return nil.
 			def used
+				return nil unless swaps_readable?
 				read_usage[-1].sum
 			end
 
+			# Show percentage of swap used.
+			# The return type is a Float but if the info isn't available, it will return nil.
 			def percent_used
+				return nil unless swaps_readable?
 				values_t = read_usage
 
 				total = values_t[0].sum
@@ -51,21 +79,26 @@ module LinuxStat
 				values_t[-1].sum.*(100).fdiv(total).round(2)
 			end
 
+			# Show percentage of swap available.
+			# The return type is a Float but if the info isn't available, it will return nil.
 			def percent_available
+				return nil unless swaps_readable?
 				values_t = read_usage
 
 				total = values_t[0].sum
 				return 0.0 if total == 0
 
 				total.-(values_t[-1].sum).*(100).fdiv(total).round(2)
-
 			end
 
 			private
 			def read_usage
 				return [[], []] unless swaps_readable?
 
-				IO.readlines('/proc/swaps').drop(1).map { |x|
+				val = IO.readlines('/proc/swaps').drop(1)
+				return [[], []] if val.empty?
+
+				val.map { |x|
 					x.strip.split.values_at(2, 3).map!(&:to_i)
 				}.transpose
 			end

data/lib/linux_stat/version.rb

@@ -1,3 +1,3 @@
 module LinuxStat
-	VERSION = "0.1.4"
+	VERSION = "0.3.1"
 end

metadata

@@ -1,46 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: linux_stat
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.1
 platform: ruby
 authors:
 - Sourav Goswami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-23 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies: []
 description: Efficient linux system reporting gem. Linux Only | Efficient | Reliable
 email:
 - souravgoswami@protonmail.com
 executables: []
-extensions: []
-extra_rdoc_files: []
+extensions:
+- ext/fs_stat/extconf.rb
+extra_rdoc_files:
+- README.md
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
 - README.md
-- Rakefile
 - bin/console
+- bin/linuxstat.rb
 - bin/setup
+- ext/fs_stat/extconf.rb
+- ext/fs_stat/fs_stat.c
 - lib/linux_stat.rb
 - lib/linux_stat/battery.rb
 - lib/linux_stat/bios.rb
 - lib/linux_stat/cpu.rb
+- lib/linux_stat/filesystem.rb
 - lib/linux_stat/kernel.rb
 - lib/linux_stat/memory.rb
+- lib/linux_stat/mounts.rb
 - lib/linux_stat/net.rb
 - lib/linux_stat/os.rb
 - lib/linux_stat/process.rb
 - lib/linux_stat/swap.rb
 - lib/linux_stat/version.rb
-- linux_stat.gemspec
-- run_all_methods.rb
 homepage: https://github.com/Souravgoswami/linux_stat/
 licenses:
 - MIT
@@ -63,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Efficient linux system reporting gem