linux_stat 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4f9b433758109c632c7b6358b1fd6c5cda1711e1ab6b8f4a3dae0ce6cc02f6d
-  data.tar.gz: c0273b6cf31ae022adfeb4b9e041426de2841899d08be49f3559ab98175be54d
+  metadata.gz: 62a54b165b53e0fe6fddad20ab6b39b8a0d57e1a02186f995fcf0341cc69aae0
+  data.tar.gz: 8bc58cc3c8b72e117892cd8f987c924337d2ab10995d14b3fb7735064e4b3685
 SHA512:
-  metadata.gz: 3e7b971800222420d9156a791de5857331c923149416a7d4b5d025d57bbb7e9d3ccea8ec47d2236f308a8675bfbcf5d0a2ee0380dab92afed29dc0ace8dcb577
-  data.tar.gz: 7583db616fff644f2798fe779b23ed28cc762eac3d6d8aad0e4c907b21813bcaacc058570516378e7cdf495a51b4906bb5a30221ebb60536af72d91b2795a147
+  metadata.gz: a5490c31315132793840e3e849996f0545b08b3b416eadef3ba6979dcbad89d31329b69dad403295f8cc7e17a677f6d8df032c42706162b251b6ed921a3d11e4
+  data.tar.gz: 0100faa162b904042e8143b8dec85b45a3cb82543c693514049df17834890b12034cb1561d8c69ba606e9ebc81fba1550b255ad6d17d70a552011eb9aaf5300f

data/README.md

@@ -1,12 +1,14 @@
 # LinuxStat
 ![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/).
+For reading the eyecandy 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:
@@ -26,6 +28,8 @@ On Debian based systems:
 
 + 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:
@@ -395,6 +399,121 @@ LinuxStat::Uname.version
 => "#1 SMP PREEMPT Wed, 21 Oct 2020 01:11:20 +0000"
 
 ```
+---
+
+## Note 1: Filesystem
+
+Filesystem can take arguments. By default it's '/' or the root of the system...
+
+But for the sake of example, to get the free disk space of /, you do:
+
+```
+$ irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> LinuxStat::Filesystem.free('/').fdiv(1024 ** 3).to_s << " GiB"
+=> "35.666873931884766 GiB"
+```
+
+To see the free and total space of a thumbdrive:
+
+```
+$ irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> LinuxStat::Mounts.list.find { |x| x.include?('/run/media/sourav') }.split[1]
+=> "/run/media/sourav/5c2b7af7-d4c3-4ab4-a035-06d18ffc8e6f"
+
+irb(main):003:0> thumbdrive = _
+=> "/run/media/sourav/5c2b7af7-d4c3-4ab4-a035-06d18ffc8e6f"
+
+irb(main):004:0> LinuxStat::Filesystem.free(thumbdrive).fdiv(1024 ** 3).to_s << " GiB"
+=> "2.504791259765625 GiB"
+
+irb(main):005:0> LinuxStat::Filesystem.total(thumbdrive).fdiv(1024 ** 3).to_s << " GiB"
+=> "29.305004119873047 GiB"
+```
+
+## Note 2: ProcessInfo
+
+All the methods LinuxStat::ProcessInfo can take an argument containing the Process ID of a process.
+By default it's $$ or the PID of the current process, ruby, itself.
+
+Example:
+Say you want to see how much CPU Firefox is consuming, for that you have to do the following (firefox can create a lot of child process though):
+
+1. Get the PID of Firefox:
+```
+LinuxStat::Process.names.find { |x| x[1].include? 'firefox' }[0]
+=> 770 # but this differs all the time
+```
+
+2. Get the CPU usage:
+```
+$ irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> pid = LinuxStat::Process.names.find { |x| x[1].include? 'firefox' }[0]
+=> 770
+
+irb(main):003:0> LinuxStat::ProcessInfo.cpu_usage(pid: pid)
+=> 0.0
+
+irb(main):004:0> LinuxStat::ProcessInfo.cpu_usage(pid: pid)
+=> 15.0
+```
+
+To get the memory usage of Firefox (for example):
+
+```
+$ irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> LinuxStat::ProcessInfo.mem_stat(LinuxStat::Process.names.find { |x| x[1].include? 'firefox'.freeze }[0])
+=> {:memory=>468472, :virtual_memory=>4754080, :resident_memory=>814388}
+```
+
+To get ONLY the memory usage in MiB:
+
+```
+$ irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> LinuxStat::ProcessInfo.memory(LinuxStat::Process.names.find { |x| x[1].include? 'firefox'.freeze }[0]).fdiv(1024).round(2).to_s << " MiB"
+=> "467.51 MiB"
+```
+
+## Note 3: FS
+
+LinuxStat::FS module gives you the raw info in Hash collected from statvfs.
+
+It's not documented above because it's not suggested to run this directly. But it shouldn't cause any issue. `LinuxStat::Filesystem.stat_raw(fs = '/')` does that automatically.
+
+It always requires an argument, and it's very fast. It directly calls the C API without any intermediate Ruby code.
+
+For example, to get the info about '/' or root:
+
+```
+$ irb
+irb(main):001:0> require 'linux_stat'
+=> true
+
+irb(main):002:0> LinuxStat::FS.stat('/')
+=> {:block_size=>4096, :fragment_size=>4096, :blocks=>29292283, :block_free=>9349843, :block_avail_unpriv=>9349843, :inodes=>58612160, :free_inodes=>56708247, :filesystem_id=>2050, :mount_flags=>1024, :max_filename_length=>255}
+
+irb(main):003:0> t = Time.now ; puts LinuxStat::FS.stat('/') ; Time.now - t
+{:block_size=>4096, :fragment_size=>4096, :blocks=>29292283, :block_free=>9349843, :block_avail_unpriv=>9349843, :inodes=>58612160, :free_inodes=>56708247, :filesystem_id=>2050, :mount_flags=>1024, :max_filename_length=>255}
+=> 5.0468e-05
+```
+
+To learn more about them, just run ri and the method name. To see all available methods:
+
+---
 
 ## 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.
@@ -409,6 +528,8 @@ LinuxStat::Uname.version
 
 If some error is *raised* it should be reported as a bug.
 
+---
+
 ## Ruby on Rails
 
 1. Just add `gem linux_stat`:
@@ -421,23 +542,29 @@ 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.
+Note that the CPU count can differ due to hotplugging feature. So if you see the CPU count changes, there's not really nothing to do about that.
 
 ![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.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+---
+
 ## Testing
 Like other gems, this doesn't have a test like RSpec. We suggest using the bin/linuxstat.rb file on various systems.
 If you need to test a specific module, say the CPU, just run it like this:
@@ -459,10 +586,14 @@ $ ruby bin/linuxstat.rb upc
 ```
 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.
 
+---
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/linuxstat.rb

@@ -2,17 +2,45 @@
 begin
 	require 'linux_stat'
 rescue LoadError
-	require 'bundler/setup'
-	require 'linux_stat'
+	puts "The Gem needs to be installed before this test can be run!"
 end
 
 $-v = true
 
 # 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$/] }
+markdown = ARGV.any? { |x| x[/^\-(\-markdown|md)$/] }
+html = ARGV.any? { |x| x[/^\-(\-html|html)$/] }
+
+# 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 = (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
@@ -34,6 +62,8 @@ execute.sort.each do |c|
 	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
@@ -50,6 +80,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
@@ -67,5 +99,10 @@ execute.sort.each do |c|
 		puts
 	end
 
-	puts "```\n\n" if MARKDOWN && meths.length > 0
+	meths.length > 0
+		if MARKDOWN
+			puts "```\n\n"
+		elsif HTML
+			puts "</pre>"
+		end
 end

data/lib/linux_stat/version.rb

@@ -1,3 +1,3 @@
 module LinuxStat
-	VERSION = "0.4.0"
+	VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linux_stat
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Sourav Goswami
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies: []
 description: Efficient linux system reporting gem. Linux Only | Efficient | Reliable
 email:
@@ -48,10 +48,7 @@ files:
 homepage: https://github.com/Souravgoswami/linux_stat/
 licenses:
 - MIT
-metadata:
-  homepage_uri: https://github.com/Souravgoswami/linux_stat/
-  source_code_uri: https://github.com/Souravgoswami/linux_stat
-  changelog_uri: https://github.com/Souravgoswami/linux_stat/commits/master
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths: