procps-rb 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ea0f9d5b89c78686d361fa00b86aa3cb7b13c2e
-  data.tar.gz: 9a589588aacb19ea074f429d9410d52acbd1f24f
+  metadata.gz: c976117d306543a0b1edc526541e00095305a4be
+  data.tar.gz: 3374e2058c9a1b07c867945bef45daaeb02d4173
 SHA512:
-  metadata.gz: 8fdde5f8c2d50c6a8b719f16197c941a2fa9fbd851124008ee228bc8bb29f8d1def36c4ed6db1ca5287638415cc585eb55b3453db5db24143f7b9b9e741b3285
-  data.tar.gz: bb29ed35cfc8e7133f75e6845e2978c5dbed4b7c75a021fce8206cf6b502596081086445541a654cc11a75b49c62565822f75137608cb95e7971358e5f1fed11
+  metadata.gz: d7845dbf401dd46514182ecf18e3b7b7b5ff76ad32a2db33456a8cff96d60b5012bd29532c1179cdc9a49b2344894b36aafa8eb631ae0b16d7b381c9725f66b7
+  data.tar.gz: 310656840e0238caf054e823959f5249b242ff1f406581b663a9ca97411bc384c1d3fb00da939c24dad9e242ca664285ae37e23f1e2498e54686fb829ddb0530

data/lib/procps/column.rb

@@ -1,4 +1,5 @@
 module Procps
+  # Creates a column object with a typecasting for ps results.
   class Column
     attr_reader :header
     alias :to_s :header
@@ -10,6 +11,7 @@ module Procps
       freeze
     end
 
+    # Typecasts a raw value
     def call(value)
       @cast.nil? ? value : @cast.call(value)
     rescue => e
@@ -17,6 +19,7 @@ module Procps
       value
     end
 
+    # The abstract class for complex column objects.
     class Type
       attr_reader :original
       alias :to_s :original

data/lib/procps/column_types/command.rb

@@ -1,6 +1,7 @@
 require 'procps/column'
 
 module Procps
+  # The column type for a +command+ column.
   class Command < Column::Type
     attr_reader :name, :arguments, :title
     alias :to_s :name

data/lib/procps/column_types/memsize.rb

@@ -1,6 +1,7 @@
 require 'procps/column'
 
 module Procps
+  # The column type for a +memsize+ column.
   class Memsize < DelegateClass(Integer)
     def self.call(value)
       new(value)

data/lib/procps/column_types/scheduling_policy.rb

@@ -1,6 +1,7 @@
 require 'procps/column'
 
 module Procps
+  # The column type for a +policy+ column.
   class SchedulingPolicy < Column::Type
     attr_reader :value
     alias :to_sym :value

data/lib/procps/ps.rb

@@ -8,22 +8,37 @@ module Procps
 
     attr_accessor :bin_path, :options, :modifiers
 
+    # Creates a Procps::PS object. Takes an argument with a bin path to ps command.
     def initialize(bin_path = nil)
       @bin_path  = bin_path || DEFAULT_BIN_PATH
       @options   = { o: [] }
       @modifiers = Set.new
     end
 
-    def sum
-      @modifiers << "S"
-      self
-    end
-
+    # Select columns to list with ps command
     def select(*columns)
-      @options[:o].concat(columns)
+      columns.each do |col|
+        unless @@columns.include?(col)
+          raise ArgumentError, "unknown column :#{col}, please add it manually to Procps::PS.columns."
+        end
+
+        @options[:o] << col
+      end
       self
     end
 
+    # Filter processes list with conditions
+    #
+    # Available options:
+    # * <tt>:command</tt>
+    # * <tt>:group</tt>
+    # * <tt>:user</tt>
+    # * <tt>:pid</tt>
+    # * <tt>:ppid</tt>
+    # * <tt>:sid</tt>
+    # * <tt>:tty</tt>
+    # * <tt>:real_group</tt>
+    # * <tt>:real_user</tt>
     def where(
         command: nil,
         group: nil,
@@ -47,36 +62,56 @@ module Procps
       self
     end
 
+    # Sum a CPU time for parent proccesses
+    def sum
+      @modifiers << "S"
+      self
+    end
+
+    # Limit processes list size
     def limit(n)
       @limit = n
       self
     end
 
+    # Limit processes list size & get result
     def take(n = 1)
       limit(n).to_a
     end
 
+    # Takes a hash of options to set custom ps arguments.
+    #
+    # Example:
+    #     Procps::PS.new.select(:pid, :rss).with_args(m: true).to_a
     def with_args(**args)
       @options.merge!(args)
       self
     end
 
+    # Set sorting option. Doesn't supported by an original OSX ps (use with_args() method instead).
+    #
+    # Example:
+    #     Procps::PS.new.select(:pid, :rss).sort("ppid", "-rss").to_a
     def sort(*orders)
       (@options[:sort] ||= []).concat(orders)
       self
     end
 
+    # Reset a result
     def reset
       @result = nil
       self
     end
 
-    def load
+    # Executes a ps command & sets a result.
+    def load(force = false)
+      reset if force
       @result ||= exec_command
     end
 
     alias :to_a :load
 
+    # List requested column objects with a typecast.
     def columns
       @columns ||= @options[:o].map(&@@columns)
     end

data/lib/procps/ps/columns.rb

@@ -8,7 +8,6 @@ module Procps
     Address    = -> (base = 10, null: "-".freeze) { -> (v) { v.is_a?(String) ? v == null ? nil : v.to_i(base) : v } }
     Address_10 = Address[]
     Address_16 = Address[16]
-    # KiB        = -> (v) { v.to_i * 1024 }
 
     @@columns = {
       :blocked    => Column.new("BLOCKED"),

data/lib/procps/ps/command_builder.rb

@@ -2,6 +2,7 @@ require 'shellwords'
 
 module Procps
   class PS
+    # Builds complete +ps+ shell command before execution.
     class CommandBuilder
       def initialize(ps)
         @ps = ps

data/lib/procps/version.rb

@@ -1,3 +1,3 @@
 module Procps
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: procps-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Anton Semenov