rlps 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d61a68df5edd1909af9aca5cf6c5c1c3219fe6a0
+  data.tar.gz: 6cc743712c12c4948412678658147c29330f7927
+SHA512:
+  metadata.gz: c6e8b7b6341b42f9e43f15aabbd8c6ad193e3c4d7d6793e1b36ac726bb3f100d57d6bcf7de618c38751614838b4e2dbddfe93d45ed13d1a4ff356f79cce5a2ad
+  data.tar.gz: 11efb6930e540d746694c32425bc85e056c976c23dc1636019708ecd5e1e1164fae0b1b945ec04ed90076ad6806996802f8747c727907ec06b598efbbd340ca3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rlps.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ahmed Khaled
+
+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/README.md

@@ -0,0 +1,48 @@
+# RLPS
+
+**RLPS** is a very simple and pure Ruby gem which sole prupose is to get a **list** of the currently **running processes** in a **Linux** system by reading data from Linux /proc/ directory.
+More information read The Linux Documentation Project [topic](http://tldp.org/LDP/Linux-Filesystem-Hierarchy/html/proc.html) on this subject.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rlps'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rlps
+
+## Documentation
+See https://nemoload.github.io/rlps/
+## Usage
+``` ruby
+require 'rlps'
+
+my_processes = RLPS.processes
+
+p my_processes[0]       # => systemd: 1
+p my_processes[0].name  # => systemd
+p my_processes[0].pid   # => 1
+```
+Returns a list of [RLPS::Process](http://www.github.com/nemoload) objects.
+## CLI
+**TL;DR: Don't.** 
+Although this gem wasn't made to be used as a CLI application, it can act as a very bad, ineffecient version of Linux ``` $ ps -e ```:
+          
+    $ rlps
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nemoload/rlps.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rdoc/task'
+
+task default: :spec
+
+RDoc::Task.new :rdoc do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('README.md', 'lib/*.rb',
+                          'lib/rlps/*.rb', 'lib/rlps/helper/*.rb')
+  rdoc.rdoc_dir = 'doc/'
+  rdoc.title = 'RLPS Documentation'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rlps'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rlps

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'rlps'
+RLPS.processes.each { |p| print "#{p.name}\t#{p.pid}\n" }

data/lib/rlps.rb

@@ -0,0 +1,32 @@
+require 'rlps/version'
+require 'rlps/process'
+require 'rlps/string'
+require 'rlps/helper/parser'
+
+module RLPS
+  class << self
+    attr_accessor :processes
+  end
+
+  module_function
+
+  # Get the currently runing processes as a list.
+  def processes
+    @processes ||= parse_processes
+  end
+
+  # Update the already fetched processes list.
+  def update!
+    @process = parse_processes
+  end
+
+  private
+
+  def self.parse_processes
+    processes_arr = []
+    Dir.entries('/proc/').each do |dir|
+      processes_arr << RLPS::Parser.process_from_dir(dir) if dir.int?
+    end
+    processes_arr
+  end
+end

data/lib/rlps/helper/parser.rb

@@ -0,0 +1,22 @@
+require 'rlps/string'
+require 'rlps/process'
+
+module RLPS
+
+  # This class parses Linux's /proc/ directory status file.
+  class Parser
+    # This method gets a /proc/ directory, then it parses
+    # its status file and returns a new RLPS::Process object.
+    def self.process_from_dir(dir)
+      status = {}
+      File.open(File.join(File.join('/proc', dir), 'status'), 'r') do |f|
+        f.each_line do |line|
+          res = line.match(/(^\w+):\s*(\d+|[\w\(\)\-]+)?/).captures
+          res[1] ||= nil
+          status[res[0]] = res[1]
+        end
+      end
+      RLPS::Process.new name: status['Name'], pid: status['Pid'].to_i
+    end
+  end
+end

data/lib/rlps/process.rb

@@ -0,0 +1,54 @@
+module RLPS
+  ##
+  # Represents a process
+  ##
+  class Process
+    attr_reader :name, :pid
+    # Takes two arguments _:name_ and _:pid_
+    # If called without any arguments it calls RLPS::Process.this_process.
+    # ==== Examples
+    # RLPS::Process.new name: "ruby", pid: 2365
+    def initialize(**args)
+      #-- other = args.select { |k, _v| ((k == :name) &&
+      # !args[k].nil?) || ((k == :pid) && !args[k].nil?) }
+      # raise if (other.count == 0) || (args.count != 2)
+      # TODO check if this process actually exists
+      @name = args[:name] || this_process.name
+      @pid = args[:pid] || this_process.pid
+    end
+
+    def to_s
+      "#{@name}: #{@pid}"
+    end
+
+    def to_i
+      @pid
+    end
+
+    # Returns true if the process is still running.
+    def still_running?
+      !RLPS.processes.select do |p|
+        p.pid == @pid &&
+          p.name.casecmp(@name.downcase).zero?
+      end.empty?
+    end
+
+    # Send INT signal to the process as a default behaviour.
+    # It accepts any signal Kernel#Process takes.
+    # More info: Kernel[https://ruby-doc.org/core/Kernel.html]
+    def kill!(signal = 'INT')
+      ::Process.kill(signal, @pid)
+    end
+
+    # Return this process RLPS::Process object.
+    def self.this_process
+      process = RLPS.processes.select { |p| p.pid == ::Process.pid }
+      RLPS::Process.new name: process[0].name, pid: ::Process.pid
+    end
+
+    def self.get(name: nil, pid: nil) #:nodoc:
+      # TODO
+    end
+    alias inspect to_s
+  end
+end

data/lib/rlps/string.rb

@@ -0,0 +1,12 @@
+# Monkey patch the Ruby's core string class
+# to check whether this /proc/ directory
+# represents an actual process or not which
+# always displayed as an integer.
+# More info: {The Linux Documentation Project}[http://tldp.org/LDP/Linux-Filesystem-Hierarchy/html/proc.html]
+class String
+  # Reeturns true if the string represents
+  # an actual integer.
+  def int?
+    to_i.to_s == self
+  end
+end

data/lib/rlps/version.rb

@@ -0,0 +1,4 @@
+module RLPS
+  # The current gem version.
+  VERSION = '0.1.0'.freeze
+end

data/rlps.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rlps/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rlps'
+  spec.version       = RLPS::VERSION
+  spec.authors       = ['Ahmed Khaled']
+  spec.email         = ['nemoload@aol.com']
+
+  spec.summary       = 'Pure Ruby impelementation to walk through Linux\'s proc'
+  spec.description   = 'A pure and intutive way to walk \
+                        through the current running processes \
+                        on Linux machine'
+  spec.homepage      = 'https://nemoload.github.io'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #  if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = 'http://rubygems.org/'
+  #  else
+  #  raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #  'public gem pushes.'
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rdoc', '~> 5.0'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rlps
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ahmed Khaled
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |-
+  A pure and intutive way to walk \
+                          through the current running processes \
+                          on Linux machine
+email:
+- nemoload@aol.com
+executables:
+- rlps
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rlps
+- lib/rlps.rb
+- lib/rlps/helper/parser.rb
+- lib/rlps/process.rb
+- lib/rlps/string.rb
+- lib/rlps/version.rb
+- rlps.gemspec
+homepage: https://nemoload.github.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Pure Ruby impelementation to walk through Linux's proc
+test_files: []