linux_stat 0.3.3 → 0.6.1

data/bin/console

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 $-v = true
-%w(bundler/setup linux_stat irb).each(&method(:require))
+%w(linux_stat irb).each(&method(:require))
 IRB.start(__FILE__)

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/{bin → exe}/linuxstat.rb

@@ -1,18 +1,43 @@
 #!/usr/bin/env ruby
+$-v = true
+
 begin
 	require 'linux_stat'
 rescue LoadError
-	require 'bundler/setup'
-	require 'linux_stat'
+	abort "The Gem needs to be installed before this test can be run!"
 end
 
-$-v = true
+# Check which conflicting argument (e.g., `-md -html` together) is passed last
+# Always use the last argument
+conflicting, hash = [
+	"markdown|html", /^\-(\-markdown|md)$/, /^\-(\-html|html)$/
+].each_slice(3).to_a, {}
+
+conflicting.each do |x, y, z|
+	o1, o2 = *x.split(?|.freeze).map(&:to_sym)
+	m1, m2 = ARGV.any? { |_x| _x[y] }, ARGV.any? { |_x| _x[z] }
+
+	if m1 && m2
+		rev = ARGV.reverse
+
+		if rev.index { |_x| _x[y] } < rev.index { |_x| _x[z] }
+			hash.merge!(o1 => true)
+		else
+			hash.merge!(o2 => true)
+		end
+	elsif m1
+		hash.merge!(o1 => true)
+	elsif m2
+		hash.merge!(o2 => true)
+	end
+end
+
+MARKDOWN, HTML = hash[:markdown], hash[:html]
 
 # Print time each method takes unless --no-time or -nt option is passed
-MARKDOWN = ARGV.any? { |x| x[/^\-\-markdown$/] || x[/^\-md$/] }
-PRINT_TIME = MARKDOWN ? false : !ARGV.any? { |x| x[/^\-\-no-time$/] || x[/^\-nt$/] }
+PRINT_TIME = (MARKDOWN || HTML) ? false : !ARGV.any? { |x| x[/^\-\-no-time$/] || x[/^\-nt$/] }
 
-%w(--markdown -md --no-time -nt).each(&ARGV.method(:delete))
+%w(--markdown -md --no-time -nt --html -html).each(&ARGV.method(:delete))
 
 # Run only desired classes / modules
 constants = LinuxStat.constants
@@ -29,10 +54,13 @@ execute.sort.each do |c|
 	next if e.class != Module && e.class != Class
 
 	meths = e.methods(false).sort
+	next if meths.any? { |a| e.method(a).arity > 0 }
 
 	if meths.length > 0
 		if MARKDOWN
 			puts "### LinuxStat::#{c}\n```"
+		elsif HTML
+			puts "<h3>LinuxStat::#{c}</h3>\n<pre>"
 		else
 			puts "\e[1;4;38;2;255;240;0mLinuxStat::#{c}\e[0m"
 		end
@@ -49,6 +77,8 @@ execute.sort.each do |c|
 
 		if MARKDOWN
 			puts "#{e}.#{meth}\n=> #{dis}"
+		elsif HTML
+			puts "#{e}.#{meth}\n=> #{dis}"
 		else
 			puts "\e[1;38;2;80;80;255m#{e}.#{meth}\e[0m\n=> #{dis}"
 		end
@@ -66,5 +96,11 @@ execute.sort.each do |c|
 		puts
 	end
 
-	puts "```\n\n" if MARKDOWN && meths.length > 0
+	if meths.length > 0
+		if MARKDOWN
+			puts "```\n\n"
+		elsif HTML
+			puts "</pre>"
+		end
+	end
 end

data/ext/fs_stat/fs_stat.c

@@ -1,7 +1,9 @@
 #include <sys/statvfs.h>
 #include "ruby.h"
+
 #pragma GCC optimize ("O3")
 #pragma clang optimize on
+#pragma once
 
 static VALUE statfs(VALUE obj, VALUE dir) {
 	struct statvfs buf ;
@@ -25,6 +27,7 @@ static VALUE statfs(VALUE obj, VALUE dir) {
 }
 
 void Init_fs_stat() {
-	VALUE fs = rb_define_module("FS") ;
+	VALUE _linux_stat = rb_define_module("LinuxStat") ;
+	VALUE fs = rb_define_module_under(_linux_stat, "FS") ;
 	rb_define_module_function(fs, "stat", statfs, 1) ;
 }

data/ext/sysconf/extconf.rb

@@ -0,0 +1,7 @@
+require 'mkmf'
+
+unless (have_header('sys/unistd.h') && have_header('ruby.h'))
+	abort('Missing header')
+end
+
+create_makefile 'linux_stat/sysconf'

data/ext/sysconf/sysconf.c

@@ -0,0 +1,81 @@
+#include <unistd.h>
+#include "ruby.h"
+
+#pragma GCC optimize ("O3")
+#pragma clang optimize on
+#pragma once
+
+static VALUE getTick(VALUE obj) {
+	return INT2FIX(sysconf(_SC_CLK_TCK)) ;
+}
+
+static VALUE getChildMax(VALUE obj) {
+	return INT2FIX(sysconf(_SC_CHILD_MAX)) ;
+}
+
+static VALUE getHostnameMax(VALUE obj) {
+	return INT2FIX(sysconf(_SC_HOST_NAME_MAX)) ;
+}
+
+static VALUE getLoginNameMax(VALUE obj) {
+	return INT2FIX(sysconf(_SC_LOGIN_NAME_MAX)) ;
+}
+
+static VALUE getOpenMax(VALUE obj) {
+	return INT2FIX(sysconf(_SC_OPEN_MAX)) ;
+}
+
+static VALUE getPageSizeMax(VALUE obj) {
+	return INT2FIX(sysconf(_SC_PAGESIZE)) ;
+}
+
+static VALUE getStreamMax(VALUE obj) {
+	return INT2FIX(sysconf(_SC_STREAM_MAX)) ;
+}
+
+static VALUE getTTYNameMax(VALUE obj) {
+	return INT2FIX(sysconf(_SC_TTY_NAME_MAX)) ;
+}
+
+static VALUE getPosixVersion(VALUE obj) {
+	return INT2FIX(sysconf(_SC_VERSION)) ;
+}
+
+static VALUE getUser(VALUE obj) {
+	char *name = getlogin() ;
+	return name ? rb_str_new_cstr(name) : rb_str_new_cstr("") ;
+}
+
+static VALUE getUID(VALUE obj) {
+	return INT2FIX(getuid()) ;
+}
+
+static VALUE getGID(VALUE obj) {
+	return INT2FIX(getgid()) ;
+}
+
+static VALUE getEUID(VALUE obj) {
+	return INT2FIX(geteuid()) ;
+}
+
+void Init_sysconf() {
+	VALUE _linux_stat = rb_define_module("LinuxStat") ;
+	VALUE _sysconf = rb_define_module_under(_linux_stat, "Sysconf") ;
+
+	rb_define_module_function(_sysconf, "sc_clk_tck", getTick, 0) ;
+	rb_define_module_function(_sysconf, "child_max", getChildMax, 0) ;
+	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, "stream_max", getStreamMax, 0) ;
+	rb_define_module_function(_sysconf, "tty_name_max", getTTYNameMax, 0) ;
+	rb_define_module_function(_sysconf, "posix_version", getPosixVersion, 0) ;
+
+	rb_define_module_function(_sysconf, "get_uid", getUID, 0) ;
+	rb_define_module_function(_sysconf, "get_gid", getGID, 0) ;
+	rb_define_module_function(_sysconf, "get_euid", getEUID, 0) ;
+
+	rb_define_module_function(_sysconf, "get_user", getUser, 0) ;
+	rb_define_module_function(_sysconf, "get_login", getUser, 0) ;
+}

data/ext/utsname/utsname.c

@@ -1,7 +1,9 @@
 #include <sys/utsname.h>
 #include "ruby.h"
+
 #pragma GCC optimize ("O3")
 #pragma clang optimize on
+#pragma once
 
 static struct utsname buf ;
 static short status ;
@@ -10,9 +12,9 @@ void init_buf() {
 	status = uname(&buf) ;
 }
 
-static VALUE getMachine(VALUE obj) {
-	VALUE machine = status < 0 ? rb_str_new_cstr("") : rb_str_new_cstr(buf.machine) ;
-	return machine ;
+static VALUE getSysname(VALUE obj) {
+	VALUE sysname = status < 0 ? rb_str_new_cstr("") : rb_str_new_cstr(buf.sysname) ;
+	return sysname ;
 }
 
 static VALUE getNodename(VALUE obj) {
@@ -20,10 +22,30 @@ static VALUE getNodename(VALUE obj) {
 	return nodename ;
 }
 
+static VALUE getRelease(VALUE obj) {
+	VALUE release = status < 0 ? rb_str_new_cstr("") : rb_str_new_cstr(buf.release) ;
+	return release ;
+}
+
+static VALUE getVersion(VALUE obj) {
+	VALUE version = status < 0 ? rb_str_new_cstr("") : rb_str_new_cstr(buf.version) ;
+	return version ;
+}
+
+static VALUE getMachine(VALUE obj) {
+	VALUE machine = status < 0 ? rb_str_new_cstr("") : rb_str_new_cstr(buf.machine) ;
+	return machine ;
+}
+
 void Init_utsname() {
 	init_buf() ;
 
-	VALUE _uname = rb_define_module("Uname") ;
-	rb_define_module_function(_uname, "machine", getMachine, 0) ;
+	VALUE _linux_stat = rb_define_module("LinuxStat") ;
+	VALUE _uname = rb_define_module_under(_linux_stat, "Uname") ;
+
+	rb_define_module_function(_uname, "sysname", getSysname, 0) ;
 	rb_define_module_function(_uname, "nodename", getNodename, 0) ;
+	rb_define_module_function(_uname, "release", getRelease, 0) ;
+	rb_define_module_function(_uname, "version", getVersion, 0) ;
+	rb_define_module_function(_uname, "machine", getMachine, 0) ;
 }

data/lib/linux_stat.rb

@@ -1,17 +1,27 @@
+# Independed and LinuxStat specific unrelated modules
 require "linux_stat/version"
+require 'linux_stat/prettify_bytes'
+
+# Independed and LinuxStat related modules
 require "linux_stat/battery"
 require "linux_stat/bios"
 require "linux_stat/cpu"
-require "linux_stat/kernel"
 require "linux_stat/memory"
 require "linux_stat/net"
+require "linux_stat/process"
+require "linux_stat/swap"
 
+# LinuxStat::Uname dependent modules
 require 'linux_stat/utsname'
 require "linux_stat/os"
 
-require "linux_stat/process"
-require "linux_stat/swap"
-require "linux_stat/mounts"
-
+# LinuxStat::FS dependent modules
 require "linux_stat/fs_stat"
 require "linux_stat/filesystem"
+require "linux_stat/mounts"
+
+# LinuxStat::Sysconf dependent modules
+require "linux_stat/sysconf"
+require "linux_stat/kernel"
+require 'linux_stat/user'
+require "linux_stat/process_info"

data/lib/linux_stat/battery.rb

@@ -9,7 +9,7 @@ module LinuxStat
 			end
 
 			# Returns the details of the battery.
-			#If the battery is not present it will return an empty Hash.
+			# If the battery is not present it will return an empty Hash.
 			def stat
 				st = status.downcase
 				return {} unless present?
@@ -27,7 +27,7 @@ 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.
+			# 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!)

data/lib/linux_stat/bios.rb

@@ -3,9 +3,10 @@ module LinuxStat
 		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 ; as changing the value in runtime is unexpected.
+			#
+			# The output is also cached (memoized) ; as changing the value in runtime is unexpected.
 			def model
-				# Cached ; as changing the value in runtime is unexpected
+				# cached (memoized) ; as changing the value in runtime is unexpected
 				@@model ||= if File.readable?('/sys/devices/virtual/dmi/id/product_name')
 					IO.read('/sys/devices/virtual/dmi/id/product_name').tap(&:strip!)
 				elsif File.readable?('/sys/firmware/devicetree/base/model')
@@ -17,9 +18,10 @@ module LinuxStat
 
 			# Returns the vendor of the BIOS.
 			# If the information is not 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 vendor
-				# Cached ; as changing the value in runtime is unexpected
+				# cached (memoized) ; as changing the value in runtime is unexpected
 				@@vendor ||= if File.readable?('/sys/devices/virtual/dmi/id/bios_vendor')
 					IO.read('/sys/devices/virtual/dmi/id/bios_vendor').tap(&:strip!)
 				else
@@ -29,7 +31,8 @@ module LinuxStat
 
 			# Returns the version of the BIOS.
 			# If the information is not 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
 				@@version ||= if File.readable?('/sys/devices/virtual/dmi/id/bios_version')
 					IO.read('/sys/devices/virtual/dmi/id/bios_version').tap(&:strip!)
@@ -40,7 +43,8 @@ module LinuxStat
 
 			# Returns the date of the BIOS.
 			# If the information is not 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 date
 				@@date ||= if File.readable?('/sys/devices/virtual/dmi/id/bios_date')
 					IO.read('/sys/devices/virtual/dmi/id/bios_date').tap(&:strip!)

data/lib/linux_stat/cpu.rb

@@ -1,8 +1,9 @@
 module LinuxStat
 	module CPU
 		class << self
-			# stat(sleep = 0.075)
+			# 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.
@@ -12,34 +13,45 @@ module LinuxStat
 			# {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 = 0.075)
+			def stat(sleep = ticks_to_ms)
 				return {} unless stat?
 
 				data = IO.readlines('/proc/stat').select! { |x| x[/^cpu\d*/] }.map! { |x| x.split.map!(&:to_f) }
 				sleep(sleep)
 				data2 = IO.readlines('/proc/stat').select! { |x| x[/^cpu\d*/] }.map! { |x| x.split.map!(&:to_f) }
 
-				data.size.times.reduce({}) do |h, x|
+				# On devices like android, the core count can change anytime.
+				# I had crashes on Termux.
+				# So better just count the min number of CPU and iterate over that
+				# If data.length is smaller than data2.length, we don't have enough data to compare.
+				dl, d2l = data.length, data2.length
+				min = dl > d2l ? d2l : dl
+
+				min.times.reduce({}) do |h, x|
 					user, nice, sys, idle, iowait, irq, softirq, steal = *data[x].drop(1)
 					user2, nice2, sys2, idle2, iowait2, irq2, softirq2, steal2 = *data2[x].drop(1)
 
 					idle_then, idle_now  = idle + iowait, idle2 + iowait2
 					totald = idle_now.+(user2 + nice2 + sys2 + irq2 + softirq2 + steal2) - idle_then.+(user + nice + sys + irq + softirq + steal)
 
+					res = totald.-(idle_now - idle_then).fdiv(totald).*(100).round(2).abs
+					res = 0.0 if res.nan?
+
 					h.merge!(
-						x => totald.-(idle_now - idle_then).fdiv(totald).*(100).round(2).abs
+						x => res
 					)
 				end
 			end
 
-			# total_usage(sleep = 0.075)
+			# 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.
 			#
 			# If the information is not available, it will return nil.
-			def total_usage(sleep = 0.075)
+			def total_usage(sleep = ticks_to_ms)
 				return nil unless stat?
 
 				data = IO.foreach('/proc/stat').first.split.tap(&:shift).map!(&:to_f)
@@ -63,7 +75,8 @@ module LinuxStat
 
 			# Returns the model of processor.
 			# If the information isn't available, it will return en 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 model
 				@@name ||= cpuinfo.find { |x| x.start_with?('model name') }.to_s.split(?:)[-1].to_s.strip
 			end
@@ -105,6 +118,10 @@ module LinuxStat
 			def stat?
 				@@stat_readable ||= File.readable?('/proc/stat')
 			end
+
+			def ticks_to_ms
+				@@ms ||= 1.0 / LinuxStat::Sysconf.sc_clk_tck
+			end
 		end
 	end
 end

data/lib/linux_stat/filesystem.rb

@@ -1,7 +1,5 @@
 module LinuxStat
 	module Filesystem
-		prepend FS
-
 		class << self
 			# stat(fs = '/')
 			# Where fs is the directory of the file system (like / or /tmp/ or /run/media/thumbdrive).
@@ -12,7 +10,7 @@ module LinuxStat
 			# 3. used space (in kilobytes)
 			#
 			# In a hash format:
-			# {:total=>119981191168, :free=>43155574784, :used=>76825616384, :available=>43155574784}
+			#    {:total=>119981191168, :free=>43155574784, :used=>76825616384, :available=>43155574784}
 			#
 			# If the stat can't be acquired, this method will return an empty Hash.
 			def stat(fs = ?/.freeze)
@@ -23,7 +21,7 @@ module LinuxStat
 				{
 					total: s[:block_size] * s[:blocks],
 					free: s[:block_size] * s[:block_free],
-					used: s[:blocks].-(s[:block_free]) * s[:block_size],
+					used: s[:blocks].-(s[:block_free]) * s[:block_size]
 				}
 			end
 
@@ -83,11 +81,11 @@ module LinuxStat
 			# 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):
-			# {:block_size=>4096, :fragment_size=>4096, :blocks=>29292283, :block_free=>10535967, :block_avail_unpriv=>10535967, :inodes=>58612160, :free_inodes=>56718550, :filesystem_id=>2050, :mount_flags=>1024, :max_filename_length=>255}
+			#    {:block_size=>4096, :fragment_size=>4096, :blocks=>29292283, :block_free=>10535967, :block_avail_unpriv=>10535967, :inodes=>58612160, :free_inodes=>56718550, :filesystem_id=>2050, :mount_flags=>1024, :max_filename_length=>255}
 			#
 			# If the stat can't be acquired, this method will return an empty Hash.
-			def stat_raw(fs = '/'.freeze)
-				FS.stat(fs)
+			def stat_raw(fs = ?/.freeze)
+				LinuxStat::FS.stat(fs)
 			end
 		end
 	end