sixarm_ruby_ramp 2.1.0

data/lib/sixarm_ruby_ramp/process.rb

@@ -0,0 +1,221 @@
+# -*- coding: utf-8 -*-
+#
+# = Process extensions to help debug Ruby programs.
+#
+# ==Examples
+#
+#   p = Process.ps
+#   puts p
+#   => the results of the 'ps' command for the current process id
+#
+#   p = Process.ps(1234)
+#   puts p
+#   => the results of the 'ps' command for process id 1234
+#
+#   p = Process.pss
+#   p['%cpu'] => percentage of cpu use, as a float
+#   p['%mem'] => percentage of memory use, as a float
+##
+
+module Process
+
+
+  # Get the 'ps' command as one long text string.
+  #
+  # This is typically useful for logging to a text file.
+  #
+  # @example
+  #   pid = 100
+  #   Process.ps(pid)
+  #   => "0.0 bfd86194 21:14:51 ..."
+  #
+  # @return [String] lots of data about the process
+
+  def self.ps(pid=Process.pid)
+    `#{self.ps_command} #{pid.to_i}`
+  end
+
+
+  # Get the 'ps' command as a hash of keys and values.
+  #
+  # @return [Hash<String,String>] the ps command options as keys and values
+  #
+  # @example
+  #   pid = 100
+  #   Process.pss(pid)
+  #   => {"cp"=>0.0, "esp"=>"bfd86194", "etime"=>"21:14:51", ...  }
+  # -
+  # OPTIMIZE: add dates, times
+
+  def self.pss(pid=Process.pid)
+    ps=self.ps(pid)
+    h=Hash[*self.ps_keys.zip(ps.split).flatten]
+    h['c']      =h['c'].to_i
+    h['cp']     =h['cp'].to_f
+    h['egid']   =h['egid'].to_i
+    h['egroup'] =h['egroup'].to_i
+    h['uid']    =h['uid'].to_i
+    h['fgid']   =h['fgid'].to_i
+    h['lwp']    =h['lwp'].to_i
+    h['ni']     =h['ni'].to_i
+    h['nlwp']   =h['nlwp'].to_i
+    h['pcpu']   =h['pcpu'].to_f
+    h['pgid']   =h['pgid'].to_i
+    h['pid']    =h['pid'].to_i
+    h['pmem']   =h['pmem'].to_f
+    h['ppid']   =h['ppid'].to_i
+    h['rgid']   =h['rgid'].to_i
+    h['rss']    =h['rss'].to_i
+    h['ruid']   =h['ruid'].to_i  
+    h['sid']    =h['sid'].to_i  
+    h['sgid']   =h['sgid'].to_i  
+    h['suid']   =h['suid'].to_i  
+    self.ps_aliases.each_pair{|key,val| h[key]=h[val]}
+    return h
+  end
+
+
+  # Get the list of process alias keywords as typically defined by the shell.
+  #
+  # For example, a shell may consider "%cpu" and "pcpu" to be identical.
+  #
+  # @example
+  #   Process::PS_ALIASES_DEFAULT
+  #   => {"%cpu"=>"pcpu", "sigmask"=>"blocked", "cls"=>"policy", ... }
+  #
+  # @return [Hash<String,String>] process keyword aliases
+
+  PS_ALIASES_DEFAULT={
+    '%cpu'=>'pcpu',
+    '%mem'=>'pmem',
+    'sig_block'=>'blocked',
+    'sigmask'=>'blocked',
+    'sig_catch'=>'caught',
+    'sigcatch'=>'caught',
+    'cls'=>'class',
+    'cls'=>'policy',
+    'cputime'=>'time',
+    'gid'=>'egid',
+    'group'=>'egroup',
+    'uid'=>'euid',
+    'uname'=>'euser',
+    'user'=>'euser',
+    'flag'=>'f',
+    'flags'=>'f',
+    'fsuid'=>'fuid',
+    'sig_ignore'=>'ignored',
+    'sigignore'=>'ignored',
+    'spid'=>'lwp',
+    'tid'=>'lwp',
+    'nice'=>'ni',
+    'thcount'=>'nlwp',
+    'sig'=>'pending',
+    'sig_pend'=>'pending',
+    'pgrp'=>'pgid',
+    'rssize'=>'rss',
+    'rsz'=>'rss',
+    'state'=>'s',
+    'sess'=>'sid',
+    'session'=>'sid',
+    'svgid'=>'sgid',
+    'tt'=>'tname',
+    'tty'=>'tname', 
+    'vsz'=>'vsize'
+  }
+
+
+  # Get the list of process alias keywords as typically defined by the shell.
+  #
+  # For example, a shell may consider "%cpu" and "pcpu" to be identical.
+  #
+  # @example                                                                          
+  #   Process.ps_aliases
+  #   => {"%cpu"=>"pcpu", "sigmask"=>"blocked", "cls"=>"policy", ... }                                   
+  #                                                                                                                
+  # @return [Hash<String,String>] process keyword aliases 
+
+  def self.ps_aliases
+    @@ps_aliases||=PS_ALIASES_DEFAULT
+  end
+
+
+  # Set the list of process alias keywords.
+  #
+  # For example, a shell may consider "%cpu" and "pcpu" to be identical.
+  #
+  # @example                                                                          
+  #   Process::ps_aliases={ {"%cpu"=>"pcpu", "sigmask"=>"blocked", "cls"=>"policy" }
+  #   => {"%cpu"=>"pcpu", "sigmask"=>"blocked", "cls"=>"policy"}     
+  #        
+  # @param [Hash<String,String>] aliases                                 
+  # @return [Hash<String,String>] aliases
+
+  def self.ps_aliases=(aliases)
+    @@ps_aliases=aliases
+  end
+
+
+  # The list of process keywords.
+
+  PS_KEYS_DEFAULT=%w'blocked bsdtime c caught class cp egid egroup eip esp etime euid euser f fgid fgroup fuid fuser group ignored label lwp ni nlwp nwchan pending pcpu pgid pid pmem ppid pri psr rgid rgroup rss rtprio ruid ruser s sched sgi_p sgid sgroup sid sig size stackp start_time stat suid suser sz time tname tpgid vsize wchan'
+
+
+  # Get the list of process keywords.
+  #
+  # @example
+  #   Process.ps_keys
+  #   => ["blocked","group","pending","size"]
+  #
+  # @return [Array<String>] the list of process keywords.
+
+
+  def self.ps_keys
+    @@ps_keys||=PS_KEYS_DEFAULT
+  end
+
+ 
+  # Set the list of process keywords.
+  #
+  # @example 
+  #   Process.ps_keys = ["blocked","group","pending","size"]
+  #
+  # @param [Array<String>] keywords
+  # @return [Array<String>] keywords
+
+  def self.ps_keys=(keys)
+    @@ps_keys=keys
+  end
+
+
+  # The process command, i.e. what the sytem will call for the "ps" command.
+
+  PS_COMMAND_DEFAULT='ps h ww -o "'+self.ps_keys.join(',')+'"'
+
+
+  # Get the process command, i.e. what the sytem will call for the "ps" command.
+  #
+  # @example
+  #   Process.ps_command
+  #   => "ps h ww -o blocked,group,pending,size"
+  #
+  # @return [String] the process command
+ 
+  def self.ps_command
+    @@ps_command||=PS_COMMAND_DEFAULT
+  end
+
+
+  # Set the process command, i.e. what the sytem will call for the "ps" command.
+  #
+  # @example
+  #   Process.ps_command = "ps h ww -o blocked,group,pending,size"
+  #
+  # @param [String] the process command
+  # @return [String] the process command 
+
+  def self.ps_command=(command)
+    @@ps_command=command
+  end
+
+
+end

data/lib/sixarm_ruby_ramp/string.rb

@@ -0,0 +1,230 @@
+# -*- coding: utf-8 -*-
+
+# String extensions
+
+class String
+
+
+ # @return [String] self, with words capitalized
+ # @example 
+ #   "foo goo hoo".capitalize_words
+ #    => "Foo Goo Hoo"
+
+ def capitalize_words
+  split(/\b/).map{|word| word.capitalize }.join
+ end
+
+
+ # @return [Array<String>] an array that is the string split into words, i.e. split(\W*\b\*)
+ # @example
+ #   "foo goo hoo".words
+ #   => ["foo", "goo", "hoo"]
+
+ def words
+  split(/\W*\b\W*/)
+ end
+
+
+ # @return [Array<String>] an array that is the string split at tabs, i.e. split(/\t/)
+ # @example
+ #   "foo\tgoo\thoo".split_tab
+ #   => ["foo", "goo", "hoo"]
+
+ def split_tab
+  split(/\t/)
+ end
+
+
+ # This is useful to split a TSV (Tab Separated Values) string
+ # into an array of rows, and each row into an array of fields.
+ #
+ # @return [Array<String>] an array that is the string split at newlines, then tabs.
+ #
+ # @example
+ #   "foo\tgoo\thoo\n"ioo\tjoo\tkoo\nloo\tmoo\tnoo".split_tsv
+ #   => [["foo", "goo", "hoo"], ["ioo", "joo", "koo"], ["loo", "moo", "noo"]]
+
+ def split_tsv
+   split(/\n/).map{|line| line.split(/\t/)}
+ end
+
+
+ # @return [String] self in lowercase,
+ #    with any non-word-characters
+ #    replaced with single underscores (aka low dashes).
+ #
+ # @example
+ #   'Foo Goo Hoo' => 'foo_goo_hoo'
+ #   'Foo***Goo***Hoo' => 'foo_goo_hoo'
+
+ def lowcase
+  downcase.gsub(/[_\W]+/,'_')
+ end
+
+
+ # @return [String] the string as an XML id, which is the same as #lowcase
+ #
+ # @example
+ #   "Foo Hoo Goo" => 'foo_goo_hoo'
+ #   "Foo***Goo***Hoo" => 'foo_goo_hoo'
+
+ def to_xid
+  self.lowcase
+ end
+
+ # Ruby String#to_class method to convert from a String to a class
+ #
+ # From Mirage at http://infovore.org/archives/2006/08/02/getting-a-class-object-in-ruby-from-a-string-containing-that-classes-name/
+ #
+ # @return [Class] the string converted to a class 
+
+ def to_class
+  split('::').inject(Kernel) {|scope, const_name| scope.const_get(const_name)}
+ end
+
+
+ # Increment the rightmost natural number 
+ #
+ # @return [String] the string with an incremented rightmost number
+ #
+ # @example
+ #   'foo5bar'.increment => 'foo4bar'
+ #   'foo5bar'.increment(3) => 'foo8bar'
+ #   'foo9bar'.increment => 'foo10bar'
+ #
+ # @see String#decrement
+
+ def increment(step=1)
+  self=~/\d+/ ? $`+($&.to_i+step).to_s+$' : self
+ end
+
+
+ # Decrement the rightmost natural number
+ # 
+ # @return [String] the string with a decremented rightmost number
+ #
+ # @example
+ #   'foo5bar'.decrement => 'foo4bar'
+ #   'foo5bar'.decrement(3) => 'foo2bar'
+ #   'foo10bar'.derement => 'foo9bar'
+ #
+ # @see String#increment
+
+ def decrement(step=1)
+  self=~/\d+/ ? $`+($&.to_i-step).to_s+$' : self
+ end
+
+
+ # @return [String] the previous character, with a changed flag and carry flag
+ #
+ # @example
+ #   String.prev_char('n') => 'm', true, false   # change 
+ #   String.prev_char('a') => 'z', true, true    # change & carry
+ #   String.prev_char('6') => '5', true, false   # change
+ #   String.prev_char('0') => '9', true, true    # change & carry
+ #   String.prev_char('-') => '-', false, false  # unchanged
+
+ def self.prev_char(chr) #=> prev_char, changed_flag, carry_flag
+  case chr
+  when '1'..'9', 'B'..'Z', 'b'..'z'
+    pos=(chr.respond_to?(:ord) ? chr.ord : chr[0])
+    return (pos-1).chr, true, false
+  when '0'
+    return '9', true, true
+  when 'A'
+    return 'Z', true, true
+  when 'a'
+    return 'z', true, true
+  else
+    return chr, false, false
+  end
+ end
+
+ # @return [String] the previous string
+ #
+ # @see String#next
+ #
+ # @example
+ #   '888'.prev => '887'
+ #   'n'.prev => 'm'
+ #   'N'.prev => 'M'
+ #
+ # @example with carry
+ #   '880'.prev => '879'
+ #   'nna'.prev => 'nmz'
+ #   'NNA'.prev => 'NMZ'
+ #   'nn0aA'.prev => 'nm9zZ'
+ 
+ def prev
+  self.clone.prev!
+ end
+
+
+ # Do String#prev in place
+ #
+ # @return [String] self
+
+ def prev!
+  return self if length==0
+  index=length-1 # rightmost
+  while true do
+   chr=self[index].chr
+   prev_chr,changed_flag,carry_flag=String.prev_char(chr)
+    return self if !changed_flag
+   self[index]=prev_chr
+   return self if !carry_flag
+   index-=1
+   return nil if index<0
+  end
+  return self
+ end
+
+ alias pred  prev   # String#pred : predecessor :: String#succ : successor
+ alias pred! prev!
+ 
+ class << self
+  alias_method :pred_char, :prev_char
+ end
+
+ # Helpful constants
+
+ LOWERCASE_ENGLISH_CHARS = ['a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z']
+ UPPERCASE_ENGLISH_CHARS = ['A','B','C','D','E','F','G','H','I','J','K','L','M','N','O','P','Q','R','S','T','U','V','W','X','Y','Z']
+
+
+ ##
+ #
+ #  Lorem Ipsum random text generator
+ #
+ ##
+ 
+ # @return [Integer[ a random length suitable for a "lorem ipsum" string.
+ #
+ # This method uses 1+rand(10)
+ #
+ # @example
+ #    String.lorem_length => 3
+ #    String.lorem_length => 9
+ #    String.lorem_length => 5
+
+ def self.lorem_length
+  1+rand(10)
+ end
+
+ # @return [String] a random string suitable for "lorem ipsum" text.
+ #
+ # @example
+ #   String.lorem => "galkjadscals"
+ #   String.lorem(4) => "qtgf"
+ #
+ # This method chooses from lowercase letters a-z.
+ #
+ # This method defaults to length = self.lorem_length.
+ 
+ def self.lorem(length=self.lorem_length)
+  ['a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z'].choices(length).join
+ end
+
+
+end
+

data/lib/sixarm_ruby_ramp/symbol.rb

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+
+# Symbol extensions
+
+class Symbol
+
+  # Compare this symbol to another symbol.
+  # 
+  # @example Less than
+  #    :foo <=> :goo 
+  #    => -1
+  #
+  # @example Equal
+  #    :foo <=> :foo
+  #    => 0
+  #
+  # @example Greater than
+  #    :foo <=> :bar 
+  #    => 1
+  #
+  # @return [-1,0,1] -1 if this is < that, 0
+
+  include Comparable
+  def <=>(that)
+    self.to_s<=>that.to_s
+  end
+
+end
+

data/lib/sixarm_ruby_ramp/time.rb

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+
+# Time extensions
+
+class Time
+
+
+  # @return [String] a time stamp string in standard format: "YYYY-MM-DD HH:MM:SSZ"
+  #
+  # This standard format is specified in IETF RFC 3339 and ISO 8601.
+  #
+  # @see http://www.ietf.org/rfc/rfc3339.txt
+  #
+  # @example
+  #   Time.now.stamp 
+  #   => "2010-12-31 12:59:59Z" 
+
+  def stamp
+    getutc.strftime('%Y-%m-%d %H:%M:%SZ')
+  end
+
+
+  # Shorthand for Time.now.stamp
+  #
+  # @example
+  #   Time.stamp
+  #    => "2010-12-31 12:59:59Z" 
+  #
+  # @return [String] Time.now.stamp
+
+  def self.stamp
+    now.stamp
+  end
+
+
+  # @return [String] time packed into a short string: "YYYYMMDDHHMMSS"
+  #
+  # The time is converted to UTC.
+  #
+  # @example
+  #   Time.now.pack
+  #   => "20101231125959" 
+
+  def pack
+    getutc.strftime('%Y%m%d%H%M%S')
+  end
+
+
+  # Shorthand for Time.now.pack
+  #
+  # @example
+  #   Time.pack
+  #   => "20101231125959" 
+  # 
+  # @return [String] Time.now.pack                                                                                 
+
+  def self.pack
+    now.pack
+  end
+
+end