rex 0.0.4

data/README

@@ -0,0 +1,50 @@
+== What
+Ruby Extension Library version 0.0.4
+
+This is a collection of Ruby class monkeypatches. Some of these are by me and
+some have been swiped from other places. I have no shame.
+
+== How
+require 'rubygems'
+require 'rex'
+
+Stuff you get:
+  Array#swap!(a, b)
+  File#random_line(separator="#{$/}", seed=nil)
+  Integer#to_ordinal
+  Integer#from_ordinal(ordinal)
+  Integer#to_roman
+  Integer#from_roman(roman)
+  Kernel#boolean?
+  Kernel#caller_name
+  Kernel#stack_trace(msg=nil)
+  Kernel#Tuple(*ary)
+  String#propercase
+  String#scrub!(allowed=BASIC_MARKUP)
+  String#wrap(columns=78)
+  Symbol#to_proc
+
+You can run the example programs in the examples directory to see what the
+above methods do. You can run the example programs from anywhere, e.g.:
+
+  ruby ~/src/projects/rex/examples/stacktrace.rb
+
+== Install
+To construct a Ruby gem, just type:
+
+  rake gem
+
+To install it, type:
+
+  sudo gem install pkg/rex-0.0.4.gem
+
+== Notes
+I haven't tested this code with YARV, so YMMV.
+
+Symbol#to_proc comes from the blog post:
+http://weblog.raganwald.com/2008/02/1100inject.html
+
+== Contribute
+The source is availble at github: git://github.com/yesmar/rex.git. Feel free
+to clone it and implement your own awesome ideas. You can also send your
+patches by email to yesmar[at]speakeasy[dot]net.

data/lib/rex.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+# rex.rb
+# yesmar@speakeasy.net
+
+module REX
+  REX::NAME = 'rex'
+  REX::VERSION = '0.0.4'
+  REX::COPYRIGHT = 'Copyright (c) 2008 Ramsey Dow'
+  def self.copyright() REX::COPYRIGHT end
+  def self.version() REX::VERSION end
+  def self.libdir() File.expand_path(__FILE__).gsub(%r/\.rb$/, '') end
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__)+'/rex')
+
+require 'array'
+require 'kernel'
+require 'numeric'
+require 'string'
+require 'symbol'
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/array.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# array.rb
+# yesmar@speakeasy.net
+
+require 'modules/swap'
+
+class Array
+  # Array#swap!(a, b)
+  include Swap
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/kernel.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# kernel.rb
+# yesmar@speakeasy.net
+
+require 'modules/boolean'
+require 'modules/caller_name'
+require 'modules/stacktrace'
+require 'modules/tuple'
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/modules/boolean.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# boolean.rb
+# yesmar@speakeasy.net
+
+module Kernel
+  def boolean?
+    raise ArgumentError, 'nil self' if self.nil?
+
+    self.class == TrueClass || self.class == FalseClass
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/modules/caller_name.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# caller_name.rb
+# yesmar@speakeasy.net
+
+module Kernel
+  def caller_name
+    k = caller[0].split(%r{:[\d]*:in})
+    return k[0] if !k.nil? && !k.empty?
+
+    nil
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/modules/ordinal.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+# ordinal.rb
+# yesmar@speakeasy.net
+
+module Ordinal
+  # convert number to ordinal
+  def to_ordinal
+    cardinal = self.to_i.abs
+    if (10...20).include?(cardinal) then
+      cardinal.to_s << 'th'
+    else
+      cardinal.to_s << %w{th st nd rd th th th th th th}[cardinal % 10]
+    end
+  end
+
+  # convert ordinal to number
+  def Integer.from_ordinal(ordinal)
+    raise ArgumentError, 'nil ordinal' if ordinal.nil?
+    raise ArgumentError, 'invalid ordinal class' if ordinal.class != String
+    raise ArgumentError, 'empty ordinal' if ordinal.empty?
+    raise ArgumentError, 'not an ordinal' if ordinal.length < 3
+
+    suffix = ordinal[-2,2]
+    if suffix == 'st' || suffix == 'nd' || suffix == 'rd' || suffix == 'th'
+      value = ordinal[0,ordinal.length-2]
+    else
+      raise 'not an ordinal'
+    end
+
+    value.to_i
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/modules/propercase.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# propercase.rb
+# yesmar@speakeasy.net
+
+module ProperCase
+  # convert string to Proper Case
+  def propercase
+    ary = self.split(' ')
+    ary.each { |e| e.capitalize! }
+    ary.join(' ')
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/modules/roman.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+# roman.rb
+# yesmar@speakeasy.net
+
+module Roman
+  ROMAN_NUMERALS = [ ['M', 1000], ['CM', 900], ['D', 500],
+    ['CD', 400], ['C', 100], ['XC', 90], ['L', 50], ['XL', 40],
+    ['X', 10], ['IX', 9], ['V', 5], ['IV', 4], ['I', 1] ]
+
+  # convert Integer to Roman numeral
+  def to_roman
+    remainder = self
+    roman = ''
+    for sym,sum in ROMAN_NUMERALS
+      while remainder >= sum
+        remainder -= sum
+        roman << sym
+      end
+    end
+
+    roman
+  end
+
+  # convert Roman numeral to Integer
+  def Integer.from_roman(roman)
+    str = roman.upcase
+    sum = 0
+    for entry in ROMAN_NUMERALS
+      sym,num = entry[0], entry[1]
+      while sym == str[0, sym.length]
+        sum += num
+        str.slice!(0, sym.length)
+      end
+    end
+
+    sum
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/modules/scrub.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+# scrub.rb
+# yesmar@speakeasy.net
+
+module Scrub
+  # dictionary of allowable HTML tags and attributes
+  BASIC_MARKUP = {
+    'a' => ['href', 'title'],
+    'img' => ['src', 'alt', 'title'],
+    'br' => [],
+    'i' => nil,
+    'u' => nil,
+    'b' => nil,
+    'pre' => nil,
+    'kbd' => nil,
+    'code' => ['lang'],
+    'cite' => nil,
+    'strong' => nil,
+    'em' => nil,
+    'ins' => nil,
+    'sup' => nil,
+    'del' => nil,
+    'table' => nil,
+    'tr' => nil,
+    'td' => nil,
+    'th' => nil,
+    'ol' => nil,
+    'ul' => nil,
+    'li' => nil,
+    'p' => nil,
+    'h1' => nil,
+    'h2' => nil,
+    'h3' => nil,
+    'h4' => nil,
+    'h5' => nil,
+    'h6' => nil,
+    'blockquote' => ['cite']
+  }
+
+  # TODO: add option to replace scrubbed text with a user-defined tag
+  def scrub!(allowed=BASIC_MARKUP)
+    gsub!(/<(\/*)(\w+)([^>]*)>/) do
+      raw = $~
+      tag = raw[2].downcase
+      if allowed.has_key? tag
+        pcs = [tag]
+        allowed[tag].each do |prop|
+          ['"', "'", ''].each do |q|
+            q2 = (q != '' ? q : '\s')
+            if raw[3] =~ /#{prop}\s*=\s*#{q}([^#{q2}]+)#{q}/i
+              pcs << "#{prop}=\"#{$1.gsub('"', '\\"')}\""
+              break
+            end
+          end
+        end if allowed[tag]
+        "<#{raw[1]}#{pcs.join ' '}>"
+      else
+        ''
+      end
+    end
+  end
+
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/modules/stacktrace.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+# stacktrace.rb
+# yesmar@speakeasy.net
+
+module Kernel
+  SPONSOR = 'yesmar'
+
+  def stacktrace(msg=nil)
+    raise ArgumentError, 'invalid msg class' if msg.class != String if !msg.nil?
+
+    program = File.basename(caller_name) || 'unknown'
+    st = []
+
+    st << "#{msg} " if !msg.nil? && !msg.empty?
+    st << 'Stack Trace:'
+
+    i = 1
+    caller.each do |c|
+      st << "  #{c}"
+      i += 1
+      if i == caller.size-1
+        st << "  #{program}:this stack trace is brought to you by #{SPONSOR}"
+      end
+    end
+
+    st
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/modules/swap.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# swap.rb
+# yesmar@speakeasy.net
+
+module Swap
+  def swap!(a, b)
+    self[a], self[b] = self[b], self[a]
+    self
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/modules/to_proc.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# to_proc.rb
+# yesmar@speakeasy.net
+
+module ToProc
+  # turn symbol into a simple proc
+  def to_proc
+    Proc.new { |*args| args.shift.__send__(self, *args) }
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/modules/tuple.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+# tuple.rb
+# yesmar@speakeasy.net
+
+module Kernel
+  def Tuple(*ary)
+    ary = ary[0] if ary.size == 1 and ary[0].kind_of?(Enumerable)
+    ary = ary.to_a unless ary.kind_of?(Array)
+    ary.extend Comparable
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/modules/wrap.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# wrap.rb
+# yesmar@speakeasy.net
+
+module Wrap
+  DEFAULT_COLUMNS=78
+
+  # variable-length word wrap
+  def wrap(columns=DEFAULT_COLUMNS)
+    self.gsub(/\n/, ' ').gsub(/.{1,#{columns}}(?:\s|\Z)/){$&+"\n"}
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/numeric.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+# numeric.rb
+# yesmar@speakeasy.net
+
+require 'modules/ordinal'
+require 'modules/roman'
+
+class Numeric
+  # Integer#to_ordinal
+  # Integer#from_ordinal(ordinal)
+  include Ordinal
+
+  # Integer#to_roman
+  # Integer#from_roman(roman)
+  include Roman
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/string.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+# string.rb
+# yesmar@speakeasy.net
+
+require 'modules/propercase'
+require 'modules/scrub'
+require 'modules/wrap'
+
+class String
+  # String#propercase
+  include ProperCase
+
+  # String#scrub
+  include Scrub
+
+  # String#wrap(cols=78)
+  include Wrap
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/rex/symbol.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# symbol.rb
+# yesmar@speakeasy.net
+
+require 'modules/to_proc'
+
+class Symbol
+  # Symbol#to_proc
+  include ToProc
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__