linux_stat 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f91092bf5de209efc7db3b316df5b25643af51e278cbdc72a53ad351e115e4c9
-  data.tar.gz: f559119540ba5ecf2c95e6d683b4d6b85e9de5034569c645c31b189fddd1a284
+  metadata.gz: e4f9b433758109c632c7b6358b1fd6c5cda1711e1ab6b8f4a3dae0ce6cc02f6d
+  data.tar.gz: c0273b6cf31ae022adfeb4b9e041426de2841899d08be49f3559ab98175be54d
 SHA512:
-  metadata.gz: 4e13f72c21481ef052b353cb6ec01b3ee2d2c639fbe1931511083aad40c0ed4e4a5c8dd1daf7f1fef8da51a530cd23b5d32bcc8c4c1cc7fe97204d6175d985a6
-  data.tar.gz: db61cd342c678907aa7071eb2f0b150fed825821c8c124b4a85309506cddcf2095f3526d2e27b78a1e46489f672b3e05021447e1a08c704287f59ef9d8a26dc0
+  metadata.gz: 3e7b971800222420d9156a791de5857331c923149416a7d4b5d025d57bbb7e9d3ccea8ec47d2236f308a8675bfbcf5d0a2ee0380dab92afed29dc0ace8dcb577
+  data.tar.gz: 7583db616fff644f2798fe779b23ed28cc762eac3d6d8aad0e4c907b21813bcaacc058570516378e7cdf495a51b4906bb5a30221ebb60536af72d91b2795a147

data/README.md

@@ -1,10 +1,31 @@
 # LinuxStat
-![logo](https://raw.githubusercontent.com/Souravgoswami/linux_stat/master/logo/logo.jpg)
+![logo](https://raw.githubusercontent.com/Souravgoswami/linux_stat/master/images/logo.jpg)
+
+For reading the HTML version, visit [linux_stat](https://souravgoswami.github.io/linux_stat/).
 
 LinuxStat lets you read status of a Linux system. It can show you cpu stats and usages, memory stats and usages, swap stats and usages, battery usage, bios info,  kernel details, local ip, os details and parse os-release + lsb-release, etc.
 
 It only works for Linux, and detecting the OS is upto the user of this gem.
 
+## Dependencies:
++ You need to have the C compile to be able to compile the C extension.
+On Arch Linux:
+```
+# pacman -S gcc
+```
+
+On Debian based systems:
+```
+# apt install gcc
+```
+
++ You might also require ruby-dev in Debian based systems which provides support for ruby.h header file:
+```
+# apt install ruby-dev
+```
+
++ Once your are done, and you can compile the C file, you can follow the installation!
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -78,7 +99,7 @@ LinuxStat::CPU.count
 => 4
 
 LinuxStat::CPU.cur_freq
-=> [2000001, 1999996, 1999998, 1999997]
+=> [1999998, 2000003, 2000015, 2000009]
 
 LinuxStat::CPU.max_freq
 => [2000000, 2000000, 2000000, 2000000]
@@ -87,16 +108,38 @@ LinuxStat::CPU.model
 => "Intel(R) Core(TM) i3-6006U CPU @ 2.00GHz"
 
 LinuxStat::CPU.stat
-=> {0=>30.0, 1=>50.0, 2=>28.57, 3=>16.67, 4=>28.57}
+=> {0=>14.29, 1=>25.0, 2=>0.0, 3=>25.0, 4=>14.29}
 
 LinuxStat::CPU.total_usage
-=> 26.67
+=> 18.75
 
 LinuxStat::CPU.usage
-=> 25.0
+=> 14.29
 
 LinuxStat::CPU.usages
-=> {0=>33.33, 1=>50.0, 2=>28.57, 3=>28.57, 4=>16.67}
+=> {0=>16.67, 1=>14.29, 2=>28.57, 3=>0.0, 4=>25.0}
+
+```
+
+### LinuxStat::Filesystem
+```
+LinuxStat::Filesystem.available
+=> 42144575488
+
+LinuxStat::Filesystem.free
+=> 42144575488
+
+LinuxStat::Filesystem.stat
+=> {:total=>119981191168, :free=>42144575488, :used=>77836615680}
+
+LinuxStat::Filesystem.stat_raw
+=> {:block_size=>4096, :fragment_size=>4096, :blocks=>29292283, :block_free=>10289203, :block_avail_unpriv=>10289203, :inodes=>58612160, :free_inodes=>56716465, :filesystem_id=>2050, :mount_flags=>1024, :max_filename_length=>255}
+
+LinuxStat::Filesystem.total
+=> 119981191168
+
+LinuxStat::Filesystem.used
+=> 77836615680
 
 ```
 
@@ -111,15 +154,24 @@ LinuxStat::Kernel.build_date_string
 LinuxStat::Kernel.build_user
 => "souravgoswami@archlinux"
 
+LinuxStat::Kernel.clk_tck
+=> 100
+
 LinuxStat::Kernel.compiler
 => [:gcc, "10.2.0"]
 
 LinuxStat::Kernel.compiler_version
 => "10.2.0"
 
+LinuxStat::Kernel.release
+=> "5.9.1-xanmod1-1"
+
 LinuxStat::Kernel.string
 => "Linux version 5.9.1-xanmod1-1 (souravgoswami@archlinux) (gcc (GCC) 10.2.0, GNU ld (GNU Binutils) 2.35.1) #1 SMP PREEMPT Wed, 21 Oct 2020 01:11:20 +0000"
 
+LinuxStat::Kernel.ticks
+=> 100
+
 LinuxStat::Kernel.version
 => "5.9.1-xanmod1-1"
 
@@ -128,29 +180,48 @@ LinuxStat::Kernel.version
 ### LinuxStat::Memory
 ```
 LinuxStat::Memory.available
-=> 405020
+=> 606548
 
 LinuxStat::Memory.percent_available
-=> 10.56
+=> 15.81
 
 LinuxStat::Memory.percent_used
-=> 89.44
+=> 84.19
 
 LinuxStat::Memory.stat
-=> {:total=>3836264, :used=>3431244, :available=>405020, :percent_used=>89.44, :percent_available=>10.56}
+=> {:total=>3836256, :used=>3229708, :available=>606548, :percent_used=>84.19, :percent_available=>15.81}
 
 LinuxStat::Memory.total
-=> 3836264
+=> 3836256
 
 LinuxStat::Memory.used
-=> 3431244
+=> 3229708
+
+```
+
+### LinuxStat::Mounts
+```
+LinuxStat::Mounts.list
+=> ["proc /proc proc rw,nosuid,nodev,noexec,relatime 0 0", "sys /sys sysfs rw,nosuid,nodev,noexec,relatime 0 0", "dev /dev devtmpfs rw,nosuid,relatime,size=1891804k,nr_inodes=472951,mode=755 0 0", "run /run tmpfs rw,nosuid,nodev,relatime,mode=755 0 0", "...
+
+LinuxStat::Mounts.root
+=> "/dev/sda2"
+
+LinuxStat::Mounts.root_fs
+=> "xfs"
+
+LinuxStat::Mounts.root_mount_options
+=> "rw,noatime,attr2,inode64,logbufs=8,logbsize=32k,noquota"
+
+LinuxStat::Mounts.tmpfs
+=> {"/dev/shm"=>"tmpfs /dev/shm tmpfs rw,nosuid,nodev 0 0", "/sys/fs/cgroup"=>"tmpfs /sys/fs/cgroup tmpfs ro,nosuid,nodev,noexec,size=4096k,nr_inodes=1024,mode=755 0 0", "/cache"=>"tmpfs /cache tmpfs rw,nosuid,nodev,relatime,size=2097152k 0 0", "/ramdisk...
 
 ```
 
 ### LinuxStat::Net
 ```
 LinuxStat::Net.ipv4_private
-=> "192.168.0.106"
+=> "192.168.0.101"
 
 ```
 
@@ -168,33 +239,39 @@ LinuxStat::OS.hostname
 LinuxStat::OS.lsb_release
 => {:LSB_VERSION=>"1.4", :DISTRIB_ID=>"Arch", :DISTRIB_RELEASE=>"rolling", :DISTRIB_DESCRIPTION=>"Arch Linux"}
 
+LinuxStat::OS.machine
+=> "x86_64"
+
+LinuxStat::OS.nodename
+=> "archlinux"
+
 LinuxStat::OS.os_release
 => {: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/"...
 
 LinuxStat::OS.uptime
-=> {:hour=>40, :minute=>46, :second=>19.75}
+=> {:hour=>9, :minute=>10, :second=>19.41}
 
 ```
 
 ### LinuxStat::Process
 ```
 LinuxStat::Process.count
-=> 223
+=> 221
 
 LinuxStat::Process.idle
-=> [3, 4, 6, 9, 12, 23, 30, 37, 39, 49, 102, 103, 104, 106, 107, 108, 109, 110, 117, 118, 120, 122, 131, 134, 140, 152, 153, 166, 168, 170, 171, 174, 180, 181, 182, 183, 184, 185, 187, 224, 272, 320, 327, 328, 2238, 2239, 2240, 2241, 2242, 2243, 89437, 9...
+=> [3, 4, 6, 9, 12, 23, 30, 37, 39, 49, 102, 103, 104, 106, 107, 108, 109, 110, 117, 118, 120, 122, 131, 134, 140, 152, 153, 168, 170, 173, 174, 182, 183, 184, 185, 186, 187, 214, 224, 268, 308, 313, 314, 330, 2357, 2358, 2359, 2360, 2361, 2362, 25094, 2...
 
 LinuxStat::Process.list
-=> [1, 2, 3, 4, 6, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 27, 28, 30, 31, 32, 33, 34, 35, 37, 38, 39, 40, 41, 42, 46, 47, 48, 49, 50, 51, 52, 102, 103, 104, 106, 107, 108, 109, 110, 111, 114, 115, 117, 118, 120, 122, 131, 134,...
+=> [1, 2, 3, 4, 6, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 24, 25, 26, 27, 28, 30, 31, 32, 33, 34, 35, 37, 38, 39, 40, 41, 42, 46, 47, 48, 49, 50, 51, 52, 102, 103, 104, 106, 107, 108, 109, 110, 112, 114, 115, 117, 118, 120, 122, 131, 134,...
 
 LinuxStat::Process.names
-=> {1=>"systemd", 2=>"kthreadd", 3=>"rcu_gp", 4=>"rcu_par_gp", 6=>"kworker/0:0H", 9=>"mm_percpu_wq", 10=>"ksoftirqd/0", 11=>"rcuc/0", 12=>"rcu_preempt", 13=>"rcub/0", 14=>"migration/0", 15=>"idle_inject/0", 16=>"cpuhp/0", 17=>"cpuhp/1", 18=>"idle_inject/...
+=> {1=>"systemd", 2=>"kthreadd", 3=>"rcu_gp", 4=>"rcu_par_gp", 6=>"kworker/0:0H-kblockd", 9=>"mm_percpu_wq", 10=>"ksoftirqd/0", 11=>"rcuc/0", 12=>"rcu_preempt", 13=>"rcub/0", 14=>"migration/0", 15=>"idle_inject/0", 16=>"cpuhp/0", 17=>"cpuhp/1", 18=>"idle...
 
 LinuxStat::Process.running
-=> [525, 91940, 91971, 91993, 92020, 95119]
+=> [30804]
 
 LinuxStat::Process.sleeping
-=> [1, 2, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 27, 28, 31, 32, 33, 34, 35, 38, 40, 41, 42, 46, 47, 48, 50, 51, 52, 111, 114, 115, 165, 167, 186, 214, 227, 302, 313, 319, 321, 333, 334, 335, 352, 353, 354, 355, 362, 366, 367, 369, 382,...
+=> [1, 2, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 25, 26, 27, 28, 31, 32, 33, 34, 35, 38, 40, 41, 42, 46, 47, 48, 50, 51, 52, 112, 114, 115, 167, 169, 188, 215, 228, 307, 309, 311, 316, 317, 319, 320, 354, 355, 356, 357, 364, 368, 370, 384, 397,...
 
 LinuxStat::Process.types
 => {1=>:sleeping, 2=>:sleeping, 3=>:idle, 4=>:idle, 6=>:idle, 9=>:idle, 10=>:sleeping, 11=>:sleeping, 12=>:idle, 13=>:sleeping, 14=>:sleeping, 15=>:sleeping, 16=>:sleeping, 17=>:sleeping, 18=>:sleeping, 19=>:sleeping, 20=>:sleeping, 21=>:sleeping, 23=>:i...
@@ -204,45 +281,157 @@ LinuxStat::Process.zombie
 
 ```
 
+### LinuxStat::ProcessInfo
+```
+LinuxStat::ProcessInfo.cmdline
+=> "ruby bin/linuxstat.rb -md"
+
+LinuxStat::ProcessInfo.command_name
+=> "ruby"
+
+LinuxStat::ProcessInfo.cpu_stat
+=> {:cpu_usage=>0.0, :threads=>1, :last_executed_cpu=>2}
+
+LinuxStat::ProcessInfo.cpu_usage
+=> 0.0
+
+LinuxStat::ProcessInfo.last_executed_cpu
+=> 2
+
+LinuxStat::ProcessInfo.mem_stat
+=> {:memory=>9644, :virtual_memory=>79568, :resident_memory=>15764}
+
+LinuxStat::ProcessInfo.memory
+=> 9644
+
+LinuxStat::ProcessInfo.resident_memory
+=> 15764
+
+LinuxStat::ProcessInfo.threads
+=> 1
+
+LinuxStat::ProcessInfo.total_io
+=> {:read_bytes=>0, :write_bytes=>0}
+
+LinuxStat::ProcessInfo.virtual_memory
+=> 79568
+
+```
+
 ### LinuxStat::Swap
 ```
 LinuxStat::Swap.any?
 => true
 
 LinuxStat::Swap.available
-=> 2292252
+=> 2256212
 
 LinuxStat::Swap.list
-=> {"/dev/zram0"=>[:partition, 4194300, 1902048, -2]}
+=> {"/dev/zram0"=>[:partition, 4194300, 1938088, -2]}
 
 LinuxStat::Swap.percent_available
-=> 54.65
+=> 53.79
 
 LinuxStat::Swap.percent_used
-=> 45.35
+=> 46.21
 
 LinuxStat::Swap.stat
-=> {:total=>4194300, :used=>1902048, :available=>2292252, :percent_used=>45.35, :percent_available=>54.65}
+=> {:total=>4194300, :used=>1938088, :available=>2256212, :percent_used=>46.21, :percent_available=>53.79}
 
 LinuxStat::Swap.total
 => 4194300
 
 LinuxStat::Swap.used
-=> 1902048
+=> 1938088
+
+```
+
+### LinuxStat::Sysconf
+```
+LinuxStat::Sysconf.child_max
+=> 2000000
+
+LinuxStat::Sysconf.hostname_max
+=> 64
+
+LinuxStat::Sysconf.login_name_max
+=> 256
+
+LinuxStat::Sysconf.open_max
+=> 8192
+
+LinuxStat::Sysconf.page_size_max
+=> 4096
+
+LinuxStat::Sysconf.posix_version
+=> 200809
+
+LinuxStat::Sysconf.sc_clk_tck
+=> 100
+
+LinuxStat::Sysconf.stream_max
+=> 16
+
+LinuxStat::Sysconf.tty_name_max
+=> 32
+
+```
+
+### LinuxStat::Uname
+```
+LinuxStat::Uname.machine
+=> "x86_64"
+
+LinuxStat::Uname.nodename
+=> "archlinux"
+
+LinuxStat::Uname.release
+=> "5.9.1-xanmod1-1"
+
+LinuxStat::Uname.sysname
+=> "Linux"
+
+LinuxStat::Uname.version
+=> "#1 SMP PREEMPT Wed, 21 Oct 2020 01:11:20 +0000"
 
 ```
 
-### Return Types:
-In general, if a method returns either a Float or a Integer or a Time, it will return float. But if the status isn't available, it will return nil.
-If the method returns a Hash / Array, it will return return Hash. If the status isn't available, it will return an empty Hash / Array.
-If the method returns a String, it will return return Hash. If the status isn't available, it will return an empty *frozen* String.
+## Return Types
++ In general, if a method returns either a Float or a Integer or a Time, it will return a Float or Integer or Time in all cases. But if the status isn't available, it will return nil.
+
++ If the method returns a Hash / Array, it will return return Hash / Array in all cases. If the status isn't available, it will return an empty Hash / Array.
+
++ If the method returns a String, it will return return String in all cases. If the status isn't available, it will return an empty *frozen* String.
+
++ It doesn't have implementation of any Error that gets raised in runtime for the ease of use.
 
-It doesn't have implementation of any Error that gets raised in runtime for the ease of use.
-If you need to check some stat that returns an integer or float, and you get nil, you know it's not available, so you can work accordingly.
-But if you need the integer or float value in 0 to whatever format, you can use the .to_i or .to_f method on the object, nil will get converted to number then.
++ If you need to check some stat that returns an integer or float, and you get nil, you know it's not available, so you can work accordingly. But if you need the integer or float value in 0 to whatever format, you can use the .to_i or .to_f method on the object, nil will get converted to number then.
 
 If some error is *raised* it should be reported as a bug.
 
+## Ruby on Rails
+
+1. Just add `gem linux_stat`:
+
+```
+$ bundle add linux_stat
+```
+
+You can use LinuxStat directly in rails.
+
+![RailsApp](https://raw.githubusercontent.com/Souravgoswami/linux_stat/master/images/rails.gif)
+
+
+## Android
+
+LinuxStat does support Android OS. But it's not rigorously tested on all device like android apps.
+
+But in Termux you can just run LinuxStat without facing issues.
+
+![termux](https://raw.githubusercontent.com/Souravgoswami/linux_stat/master/images/termux.webp)
+
+Issues regarding running LinuxStat on termux are also welcomed.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -254,34 +443,26 @@ Like other gems, this doesn't have a test like RSpec. We suggest using the bin/l
 If you need to test a specific module, say the CPU, just run it like this:
 
 ```
-ruby bin/linuxstat.rb CPU
+$ ruby bin/linuxstat.rb CPU
 ```
 
 Or:
 ```
-ruby bin/linuxstat.rb cpu
+$ ruby bin/linuxstat.rb cpu
 ```
 
 That is, the argument passed is not case-sensitive.
-But if the method passed isn't available and outright wrong, it will run all the module methods. For example, you can't do:
+But if the argument passed isn't available and outright wrong, it will run all the module methods. For example, you can't do:
 
 ```
-ruby bin/linuxstat.rb upc
+$ ruby bin/linuxstat.rb upc
 ```
-
-You can run `rake` to test all the modules.
-You can also use `rake cpu` to test the CPU module or `rake memory` to test the memory module. But this is case-sensitive.
-
 This is not a valid module and can't be run.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/Souravgoswami/linux_stat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Souravgoswami/linux_stat/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/Souravgoswami/linux_stat.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the LinuxStat project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Souravgoswami/linux_stat/blob/master/CODE_OF_CONDUCT.md).

data/bin/linuxstat.rb

@@ -29,6 +29,7 @@ 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
@@ -41,7 +42,8 @@ execute.sort.each do |c|
 	meths.each do |meth|
 		time = Time.now
 		v = e.send(meth)
-		time = Time.now.-(time).*(1_000_000).round(3)
+		time2 = Time.now
+		time = time2.-(time).*(1_000_000).round(3)
 
 		v = v.inspect
 		dis = v.length > 253 ? v[0..250].strip + '...'.freeze : v

data/ext/fs_stat/extconf.rb

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