linux_stat 0.6.1 → 0.7.0

data/exe/linuxstat.rb

@@ -2,7 +2,7 @@
 $-v = true
 
 begin
-	require 'linux_stat'
+	require 'linux_stat' unless defined?(LinuxStat)
 rescue LoadError
 	abort "The Gem needs to be installed before this test can be run!"
 end

data/ext/fs_stat/extconf.rb

@@ -1,6 +1,10 @@
 require 'mkmf'
 
-unless (have_header('sys/statvfs.h') && have_header('ruby.h'))
+unless have_const('linux') || RbConfig::CONFIG['arch'].to_s[/linux/]
+	abort('Platform is not linux')
+end
+
+unless have_header('sys/statvfs.h') && have_header('ruby.h')
 	abort('Missing header')
 end
 

data/ext/fs_stat/fs_stat.c

@@ -3,7 +3,6 @@
 
 #pragma GCC optimize ("O3")
 #pragma clang optimize on
-#pragma once
 
 static VALUE statfs(VALUE obj, VALUE dir) {
 	struct statvfs buf ;

data/ext/sysconf/extconf.rb

@@ -1,6 +1,10 @@
 require 'mkmf'
 
-unless (have_header('sys/unistd.h') && have_header('ruby.h'))
+unless have_const('linux') || RbConfig::CONFIG['arch'].to_s[/linux/]
+	abort('Platform is not linux')
+end
+
+unless have_header('sys/unistd.h') && have_header('ruby.h')
 	abort('Missing header')
 end
 

data/ext/sysconf/sysconf.c

@@ -3,7 +3,6 @@
 
 #pragma GCC optimize ("O3")
 #pragma clang optimize on
-#pragma once
 
 static VALUE getTick(VALUE obj) {
 	return INT2FIX(sysconf(_SC_CLK_TCK)) ;
@@ -25,7 +24,7 @@ static VALUE getOpenMax(VALUE obj) {
 	return INT2FIX(sysconf(_SC_OPEN_MAX)) ;
 }
 
-static VALUE getPageSizeMax(VALUE obj) {
+static VALUE getPageSize(VALUE obj) {
 	return INT2FIX(sysconf(_SC_PAGESIZE)) ;
 }
 
@@ -67,7 +66,7 @@ void Init_sysconf() {
 	rb_define_module_function(_sysconf, "hostname_max", getHostnameMax, 0) ;
 	rb_define_module_function(_sysconf, "login_name_max", getLoginNameMax, 0) ;
 	rb_define_module_function(_sysconf, "open_max", getOpenMax, 0) ;
-	rb_define_module_function(_sysconf, "page_size_max", getPageSizeMax, 0) ;
+	rb_define_module_function(_sysconf, "pagesize", getPageSize, 0) ;
 	rb_define_module_function(_sysconf, "stream_max", getStreamMax, 0) ;
 	rb_define_module_function(_sysconf, "tty_name_max", getTTYNameMax, 0) ;
 	rb_define_module_function(_sysconf, "posix_version", getPosixVersion, 0) ;

data/ext/utsname/extconf.rb

@@ -1,6 +1,10 @@
 require 'mkmf'
 
-unless (have_header('sys/utsname.h') && have_header('ruby.h'))
+unless have_const('linux') || RbConfig::CONFIG['arch'].to_s[/linux/]
+	abort('Platform is not linux')
+end
+
+unless have_header('sys/utsname.h') && have_header('ruby.h')
 	abort('Missing header')
 end
 

data/ext/utsname/utsname.c

@@ -3,7 +3,6 @@
 
 #pragma GCC optimize ("O3")
 #pragma clang optimize on
-#pragma once
 
 static struct utsname buf ;
 static short status ;

data/lib/linux_stat.rb

@@ -1,8 +1,26 @@
-# Independed and LinuxStat specific unrelated modules
+# ----------------------------------------------------------------------------------------------------- #
+# Don't edit this file unless you know what you are doing.                                               #
+#                                                                                                                                  #
+#  A file can have reverse dependency.                                                                         #
+# For example, linux_stat/utsname is required before                                                    #
+# linux_stat/os, which means utsname can be used by LinuxStat::OS and the files below.  #
+#                                                                                                                                  #
+# Once wrongly edited, you need to go through each method to know what                     #
+# file is required by the module functions. Which can be very time consuming.                 #
+#                                                                                                                                   #
+# If you are writng an independent module, just add them under "Independent" section   #
+# If you are writing a dependent module, just append that to the end of the file.             #
+# If you are writing something that is miscellaneous, just add it to miscellaneous section #
+# ------------------------------------------------------------------------------------------------------ #
+
+# Miscellaneous Modules
+# Independed and LinuxStat's miscellaneous modules
 require "linux_stat/version"
 require 'linux_stat/prettify_bytes'
 
-# Independed and LinuxStat related modules
+# Independed Modules
+# Modules that doesn't have any dependency on its own
+# But might be required by other module functions in "Dependent Modules" section
 require "linux_stat/battery"
 require "linux_stat/bios"
 require "linux_stat/cpu"
@@ -11,6 +29,9 @@ require "linux_stat/net"
 require "linux_stat/process"
 require "linux_stat/swap"
 
+# Dependent Modules
+# Modules that can have reverse dependency
+
 # LinuxStat::Uname dependent modules
 require 'linux_stat/utsname'
 require "linux_stat/os"

data/lib/linux_stat/battery.rb

@@ -3,12 +3,15 @@ module LinuxStat
 		PATH = "/sys/class/power_supply/BAT0"
 
 		class << self
+			##
 			# Returns true or false based on the presence of the battery.
 			def present?
 				@@present ||= Dir.exist?(PATH)
 			end
 
+			##
 			# Returns the details of the battery.
+			#
 			# If the battery is not present it will return an empty Hash.
 			def stat
 				st = status.downcase
@@ -26,57 +29,73 @@ module LinuxStat
 				}
 			end
 
+			##
 			# Returns the model of the battery.
+			#
 			# If the battery is not present or the information isn't available it will return an empty String.
 			def model
 				return ''.freeze unless model_readable?
 				IO.read(File.join(PATH, 'model_name')).tap(&:strip!)
 			end
 
+			##
 			# Returns the manufacturer of the battery.
+			#
 			# If the battery is not present or the information is not available, it will return an empty String.
 			def manufacturer
 				return ''.freeze unless manufacturer_readable?
 				IO.read(File.join(PATH, 'manufacturer')).tap(&:strip!)
 			end
 
+			##
 			# Returns the technology of the battery.
+			#
 			# If the battery is not present or the information is not available, it will return an empty String.
 			def technology
 				return ''.freeze unless tech_readable?
 				IO.read(File.join(PATH, 'technology')).tap(&:strip!)
 			end
 
+			##
 			# Returns the status of the battery.
-			# If the battery is not present or the information is not available, it will return an empty String.
 			# The status generally includes either of the full, charging, discharging and unknown states in most cases.
+			#
+			# If the battery is not present or the information is not available, it will return an empty frozen String.
 			def status
 				return ''.freeze unless status_readable?
 				IO.read(File.join(PATH, 'status')).tap(&:strip!)
 			end
 
+			##
 			# Returns true if the battery is charging, false if the battery is not charging.
+			#
 			# If the battery is not present or the information is not available, it will return nil.
 			def charging?
 				return nil if status.empty?
 				%w(full charging unknown).each(&:freeze).include?(status.downcase)
 			end
 
+			##
 			# Returns true if the battery is discharging, false if the battery is not discharging.
+			#
 			# If the battery is not present or the information is not available, it will return nil.
 			def discharging?
 				return nil if status.empty?
 				status.downcase == 'discharging'
 			end
 
+			##
 			# Returns true if the battery status if full, false if the battery status is not full.
+			#
 			# If the battery is not present or the information is not available, it will return nil.
 			def full?
 				return nil if status.empty?
 				status.downcase == 'full'
 			end
 
+			##
 			# Returns the charge of the battery.
+			#
 			# If the battery is not present or the information is not available, it will return nil.
 			def charge
 				return nil unless charge_now_readable?

data/lib/linux_stat/bios.rb

@@ -1,7 +1,9 @@
 module LinuxStat
 	module BIOS
 		class << self
+			##
 			# Returns the model of the BIOS.
+			#
 			# If the information is not available it will return a frozen empty string.
 			#
 			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
@@ -16,7 +18,9 @@ module LinuxStat
 				end
 			end
 
+			##
 			# Returns the vendor of the BIOS.
+			#
 			# If the information is not available it will return a frozen empty string.
 			#
 			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
@@ -29,7 +33,9 @@ module LinuxStat
 				end
 			end
 
+			##
 			# Returns the version of the BIOS.
+			#
 			# If the information is not available it will return a frozen empty string.
 			#
 			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
@@ -41,7 +47,9 @@ module LinuxStat
 				end
 			end
 
+			##
 			# Returns the date of the BIOS.
+			#
 			# If the information is not available it will return a frozen empty string.
 			#
 			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.

data/lib/linux_stat/cpu.rb

@@ -1,16 +1,21 @@
 module LinuxStat
 	module CPU
 		class << self
-			# stat(sleep = 1.0 / LinuxStat::Sysconf.sc_clk_tck)
+			##
+			# = stat(sleep = 1.0 / LinuxStat::Sysconf.sc_clk_tck)
+			#
 			# Where sleep is the delay to gather the data.
+			#
 			# The minimum possible value at anytime is 1.0 / LinuxStat::Sysconf.sc_clk_tck
+			#
 			# This method returns the cpu usage of all threads.
 			#
 			# The first one is aggregated CPU usage reported by the Linux kernel.
+			#
 			# And the consecutive ones are the real core usages.
 			#
 			# On a system with 4 threads, the output will be like::
-			# {0=>84.38, 1=>100.0, 2=>50.0, 3=>87.5, 4=>87.5}
+			#    {0=>84.38, 1=>100.0, 2=>50.0, 3=>87.5, 4=>87.5}
 			#
 			# If the information is not available, it will return an empty Hash
 			def stat(sleep = ticks_to_ms)
@@ -43,9 +48,13 @@ module LinuxStat
 				end
 			end
 
-			# total_usage(sleep = 1.0 / LinuxStat::Sysconf.sc_clk_tck)
+			##
+			# = total_usage(sleep = 1.0 / LinuxStat::Sysconf.sc_clk_tck)
+			#
 			# Where sleep is the delay to gather the data.
+			#
 			# The minimum possible value at anytime is 1.0 / LinuxStat::Sysconf.sc_clk_tck
+			#
 			# This method returns the cpu usage of all threads.
 			#
 			# It's like running LinuxStat::CPU.stat[0] but it's much more efficient and calculates just the aggregated usage which is available at the top of the /proc/stat file.
@@ -66,14 +75,18 @@ module LinuxStat
 				totald.-(idle_now - idle_then).fdiv(totald).*(100).round(2).abs
 			end
 
+			##
 			# Returns the total number of CPU threads.
+			#
 			# If the information isn't available, it will return 0.
 			def count
 				# CPU count can change during the program runtime
 				cpuinfo.count { |x| x.start_with?('processor') }
 			end
 
+			##
 			# Returns the model of processor.
+			#
 			# If the information isn't available, it will return en empty string.
 			#
 			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
@@ -81,7 +94,9 @@ module LinuxStat
 				@@name ||= cpuinfo.find { |x| x.start_with?('model name') }.to_s.split(?:)[-1].to_s.strip
 			end
 
+			##
 			# Returns an array with current core frequencies corresponding to the usages.
+			#
 			# If the information isn't available, it will return an empty array.
 			def cur_freq
 				@@cpu_freqs ||= Dir["/sys/devices/system/cpu/cpu[0-9]*/cpufreq/scaling_cur_freq"]
@@ -94,7 +109,9 @@ module LinuxStat
 				end
 			end
 
+			##
 			# Returns an array with max core frequencies corresponding to the usages.
+			#
 			# If the information isn't available, it will return an empty array.
 			def max_freq
 				@@max_freqs ||= Dir["/sys/devices/system/cpu/cpu[0-9]*/cpufreq/scaling_max_freq"]

data/lib/linux_stat/filesystem.rb

@@ -1,13 +1,16 @@
 module LinuxStat
 	module Filesystem
 		class << self
-			# stat(fs = '/')
+			##
+			# = stat(fs = '/')
+			#
 			# Where fs is the directory of the file system (like / or /tmp/ or /run/media/thumbdrive).
 			#
-			# It returns a Hash with the following info:
-			# 1. total size of the device (in bytes)
-			# 2. free space (in kilobytes)
-			# 3. used space (in kilobytes)
+			# * It returns a Hash with the following info:
+			#
+			#   1. total size of the device (in bytes)
+			#   2. free space (in kilobytes)
+			#   3. used space (in kilobytes)
 			#
 			# In a hash format:
 			#    {:total=>119981191168, :free=>43155574784, :used=>76825616384, :available=>43155574784}
@@ -25,8 +28,11 @@ module LinuxStat
 				}
 			end
 
-			# total(fs = '/')
+			##
+			# = total(fs = '/')
+			#
 			# Where fs is the directory of the file system (like / or /tmp/ or /run/media/thumbdrive).
+			#
 			# It returns the total size of a given disk in bytes.
 			#
 			# If the stat can't be acquired, this method will return nil.
@@ -37,10 +43,15 @@ module LinuxStat
 				s[:block_size] * s[:blocks]
 			end
 
-			# free(fs = '/')
+			##
+			# = free(fs = '/')
+			#
 			# Where fs is the directory of the file system (like / or /tmp/ or /run/media/thumbdrive).
+			#
 			# It returns the total free space in a disk in bytes.
+			#
 			# It is to be noted that free is not same as available.
+			#
 			# Free returns the size of free blocks.
 			#
 			# If the stat can't be acquired, this method will return an empty Hash.
@@ -51,8 +62,11 @@ module LinuxStat
 				s[:block_size] * s[:block_free]
 			end
 
-			# used(fs = '/')
+			##
+			# = used(fs = '/')
+			#
 			# Where fs is the directory of the file system (like / or /tmp/ or /run/media/thumbdrive).
+			#
 			# It returns the used space of a given disk in bytes.
 			#
 			# If the stat can't be acquired, this method will return nil.
@@ -63,10 +77,15 @@ module LinuxStat
 				s[:blocks].-(s[:block_free]) * s[:block_size]
 			end
 
-			# available(fs = '/')
+			##
+			# = available(fs = '/')
+			#
 			# Where fs is the directory of the file system (like / or /tmp/ or /run/media/thumbdrive).
+			#
 			# It returns the total free space in a disk in bytes.
+			#
 			# It is to be noted that free is not same as available.
+			#
 			# Available returns the size of free blocks for unpriviledged users.
 			#
 			# If the stat can't be acquired, this method will return an empty Hash.
@@ -77,7 +96,9 @@ module LinuxStat
 				s[:block_size] * s[:block_avail_unpriv]
 			end
 
-			# stat_raw(fs = '/')
+			##
+			# = stat_raw(fs = '/')
+			#
 			# Where fs is the directory of the file system (like / or /tmp/ or /run/media/thumbdrive).
 			#
 			# It returns a Hash with the following data (for example):

data/lib/linux_stat/kernel.rb

@@ -1,16 +1,22 @@
 module LinuxStat
 	module Kernel
 		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 (memoized) ; as changing the value in runtime is unexpected.
 			def version
 				return ''.freeze if string.empty?
 				@@version ||= splitted[2]
 			end
 
+			##
 			# 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 (memoized) ; as changing the value in runtime is unexpected.
 			def build_user
 				@@build_user ||= string.split(/(\(.+\))/).each(&:strip!)
@@ -18,8 +24,11 @@ module LinuxStat
 					.split[0].to_s[1..-2].to_s.freeze
 			end
 
+			##
 			# 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 (memoized) ; as changing the value in runtime is unexpected.
 			def compiler
 				return ''.freeze if string.empty?
@@ -37,8 +46,11 @@ module LinuxStat
 				end << compiler_version
 			end
 
+			##
 			# 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 (memoized) ; as changing the value in runtime is unexpected.
 			def compiler_version
 				@@compiler_version ||= string.split(/(\(.+?\))/).each(&:strip!)
@@ -46,20 +58,28 @@ module LinuxStat
 					.find { |x| x[/[\d.]+/] }.to_s[/[\d.]+/].to_s.freeze
 			end
 
+			##
 			# Returns the time when the kernel was compiled.
+			#
 			# The return value is a Time object.
+			#
 			# If the information isn't available, it will return nil
 			#
 			# The time will be searched in specific order.
-			# It will match any date matching any of these formats:
+			#
+			# * It will match any date matching any of these formats:
 			# 1. %b %d %H:%M:%S %z %Y
 			# 2. %d %b %Y %H:%M:%S %z
 			# 3. %Y-%m-%d
+			#
 			# Most kernels have date in them in this format.
 			#
 			# Do note that Ruby sometimes fails to work with timezones like BST for example.
+			#
 			# In such case, the timezone is unrealiable and often returns the local timezone.
+			#
 			# 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  (memoized) ; as changing the value in runtime is unexpected.
@@ -91,20 +111,29 @@ module LinuxStat
 				end
 			end
 
+			##
 			# Returns the time when the kernel was compiled.
+			#
 			# The return value is a String.
+			#
 			# If the information isn't available, it will return nil
 			#
 			# The time will be searched in specific order.
-			# It will match any date matching any of these formats:
+			#
+			# * It will match any date matching any of these formats:
+			#
 			# 1. %b %d %H:%M:%S %z %Y
 			# 2. %d %b %Y %H:%M:%S %z
 			# 3. %Y-%m-%d
+			#
 			# Most kernels have date in them in this format.
 			#
 			# Do note that Ruby sometimes fails to work with timezones like BST for example.
+			#
 			# In such case, the timezone is unrealiable and often returns the local timezone.
+			#
 			# 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 (memoized) ; as changing the value in runtime is unexpected.
@@ -133,14 +162,19 @@ module LinuxStat
 				end
 			end
 
+			##
 			# 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