linux_stat 0.1.1 → 0.2.0

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.1"
+	VERSION = "0.2.0"
 end

metadata

@@ -1,32 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: linux_stat
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Sourav Goswami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-22 00:00:00.000000000 Z
+date: 2020-11-25 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: []
+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
 - lib/linux_stat.rb
 - lib/linux_stat/battery.rb
@@ -39,12 +34,13 @@ files:
 - lib/linux_stat/process.rb
 - lib/linux_stat/swap.rb
 - lib/linux_stat/version.rb
-- linux_stat.gemspec
-- run_all_methods.rb
-homepage:
+homepage: https://github.com/Souravgoswami/linux_stat/
 licenses:
 - MIT
-metadata: {}
+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
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -53,7 +49,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at souravgoswami@protonmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile.lock

@@ -1,34 +0,0 @@
-PATH
-  remote: .
-  specs:
-    linux_stat (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.4.4)
-    rake (12.3.3)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  linux_stat!
-  rake (~> 12.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.1.4

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Sourav Goswami
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/linux_stat.gemspec

@@ -1,29 +0,0 @@
-require_relative 'lib/linux_stat/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "linux_stat"
-  spec.version       = LinuxStat::VERSION
-  spec.authors       = ["Sourav Goswami"]
-  spec.email         = ["souravgoswami@protonmail.com"]
-
-  spec.summary       = %q{Efficient linux system reporting gem}
-  spec.description   = %q{Efficient linux system reporting gem. Linux Only | Efficient | Reliable}
-  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-
-  # spec.metadata["homepage_uri"] = spec.homepage
-  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-end

data/run_all_methods.rb

@@ -1,51 +0,0 @@
-#!/usr/bin/env ruby
-require 'bundler/setup'
-require 'linux_stat'
-require 'io/console'
-
-# Print time each method takes unless --no-time or -nt option is passed
-PRINT_TIME = !ARGV.any? { |x| x[/^\-\-no-time$/] || x[/^\-nt$/] }
-
-$-v = true
-
-tt = Time.now
-wait = 3
-anim_delay = wait.fdiv(STDOUT.winsize[1])
-anim = %w(| / - \\)
-
-STDOUT.winsize[1].-(20).times do |x|
-	t = wait - Time.now.-(tt).to_i
-	print "\e[2K#{anim.rotate![0]} Starting test in #{t.clamp(0, wait)} #{?. * x}\r"
-	sleep anim_delay
-end
-
-print "\e[2K"
-
-LinuxStat.constants.sort.each do |c|
-		e = eval("LinuxStat::#{c}")
-
-		next if e.class != Module && e.class != Class
-
-		meths = e.methods(false)
-
-		meths.each do |meth|
-			time = Time.now
-			v = e.send(meth).to_s
-			time = Time.now.-(time).*(1000).round(3)
-
-			dis = v.length > 253 ? v[0..250].strip + '...'.freeze : v
-			puts "\e[1;38;2;80;80;255m#{e}.#{meth}\e[0m", "=> #{dis}"
-
-			puts( "(" +
-				if time > 10
-					"\e[1;38;2;255;80;80m"
-				elsif time > 5
-					"\e[1;38;2;255;170;0m"
-				else
-					"\e[1;38;2;0;170;0m"
-				end + "Time taken: #{time}ms\e[0m)"
-			) if PRINT_TIME
-
-			puts
-		end
-end