epitools 0.4.15 → 0.4.16

data/README.rdoc

@@ -3,15 +3,15 @@
 Useful miscellaneous improvements for base Ruby objects, plus some extra
 data structures and handy wrappers.
 
-Base classess: Object, Enumerable, Hash, String, Array, Integer, etc.
+Base classess have been enhanced: {Enumerable}[http://rdoc.info/gems/epitools/Enumerable], {Hash}[http://rdoc.info/gems/epitools/Hash], {String}[http://rdoc.info/gems/epitools/String], {Array}[http://rdoc.info/gems/epitools/Array], {Object}[http://rdoc.info/gems/epitools/Object], {Integer}[http://rdoc.info/gems/epitools/Integer], etc.
 
 Extras:
 
-* Path (a better Pathname)
-* Rash (a hash which can have Regexps as keys, allowing a single (key,value) pair to match many keys.)
-* Progressbar (better than the progressbar gem)
-* Colored (enhanced version of defunkt's colored -- adds ANSI colouring methods to String, eg: #red, #green, #light_blue, etc.)
-* Browser (a fake browser, using mechanize, Progressbar, and CacheDB)
+* {Colored}[http://rdoc.info/gems/epitools/Colored] (enhanced version of defunkt's colored -- adds ANSI colouring methods to String, eg: #red, #green, #light_blue, etc.)
+* {Path}[http://rdoc.info/gems/epitools/Path] (a better Pathname)
+* {Rash}[http://rdoc.info/gems/epitools/Rash] (a hash which can have Regexps as keys, allowing a single (key,value) pair to match many keys.)
+* {Progressbar}[http://rdoc.info/gems/epitools/Progressbar] (better than the progressbar gem)
+* {Browser}[http://rdoc.info/gems/epitools/Browser] (a fake browser, using mechanize, Progressbar, and CacheDB)
   
 == Installing
 

data/VERSION

@@ -1 +1 @@
-0.4.15
+0.4.16

data/epitools.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{epitools}
-  s.version = "0.4.15"
+  s.version = "0.4.16"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["epitron"]
-  s.date = %q{2011-03-14}
+  s.date = %q{2011-03-15}
   s.description = %q{Miscellaneous utility libraries to make my life easier.}
   s.email = %q{chris@ill-logic.com}
   s.extra_rdoc_files = [
@@ -31,7 +31,6 @@ Gem::Specification.new do |s|
     "lib/epitools/clitools.rb",
     "lib/epitools/colored.rb",
     "lib/epitools/hexdump.rb",
-    "lib/epitools/http.rb",
     "lib/epitools/lcs.rb",
     "lib/epitools/metaclass.rb",
     "lib/epitools/niceprint.rb",

data/lib/epitools.rb

@@ -15,6 +15,7 @@ class Object
 end
 
 require_wrapper = proc do |mod|
+  #p [:loading, mod]
   begin
     require File.join(__DIR__, "epitools", mod)
   rescue LoadError => e
@@ -32,6 +33,7 @@ end
   zopen
   colored
   clitools
+  permutations
 ].each do |mod|
   require_wrapper.call mod
 end

data/lib/epitools/basetypes.rb

@@ -29,10 +29,16 @@ class Numeric
 end
 
 class Float
+  #
+  # 'true' if the float is 0.0
+  #
   def blank?; self == 0.0; end
 end
 
 class NilClass
+  #
+  # Always 'true'; nil is considered blank.
+  #
   def blank?; true; end
 end
 
@@ -45,6 +51,9 @@ class String
     strip.match(/^\d+$/) ? true : false
   end
 
+  #
+  # 'true' if the string's length is 0 (after whitespace has been stripped from the ends)
+  #
   def blank?
     strip.size == 0
   end
@@ -91,6 +100,9 @@ end
 
 class Integer
   
+  #
+  # 'true' if the integer is 0
+  #
   def blank?; self == 0; end
 
   def to_hex
@@ -140,6 +152,9 @@ end
 
 class Array
 
+  #
+  # 'true' if the Array is empty
+  #
   def blank?; not self.any?; end
 
   #
@@ -191,6 +206,9 @@ end
 
 module Enumerable
 
+  #
+  # 'true' if the Enumerable has no elements
+  #
   def blank?
     not self.any?
   end
@@ -378,9 +396,10 @@ module Enumerable
       select.with_index{ |e, i| bitmask[i] == 1 }
     end
   end
-
+  
 end
 
+
 class Object
   
   #
@@ -438,14 +457,14 @@ class Object
 
   #
   # A decorator that makes any block-accepting method return an
-  # Enumerable::Enumerator whenever the method is called without a block.
+  # Enumerator whenever the method is called without a block.
   #  
   def self.enumerable *meths
     meths.each do |meth|
       alias_method "#{meth}_without_enumerator", meth
       class_eval %{
         def #{meth}(*args, &block)
-          return Enumerable::Enumerator.new(self, #{meth.inspect}, *args, &block) unless block_given?
+          return Enum.new(self, #{meth.inspect}, *args, &block) unless block_given?
           #{meth}_without_enumerator(*args, &block)
         end
       }
@@ -457,12 +476,15 @@ end
 
 class Hash
 
+  #
+  # 'true' if the Hash has no entries
+  #
   def blank?
     not self.any?
   end
 
   #
-  # Runs remove_blank_lines on self. 
+  # Runs "remove_blank_values" on self.
   #  
   def remove_blank_values!
     delete_if{|k,v| v.blank?}
@@ -470,8 +492,8 @@ class Hash
   end
   
   #
-  # Returns a new Hash where all elements whose values are "blank?" (eg: "", [], nil)
-  # have been eliminated.
+  # Returns a new Hash where blank values have been removed.
+  # (It checks if the value is blank by calling #blank? on it)
   #
   def remove_blank_values
     dup.remove_blank_values!
@@ -489,7 +511,8 @@ class Hash
   end
   
   #
-  # Returns a Hash whsoe values have been transformed by the block.
+  # Transforms the values of the hash by passing them into the supplied
+  # block, and then using the block's result as the new value.
   #
   def map_values(&block)
     dup.map_values!(&block)
@@ -507,15 +530,15 @@ class Hash
   end
   
   #
-  # Returns a new Hash whose keys have been transformed by the block.
+  # Transforms the keys of the hash by passing them into the supplied block,
+  # and then using the blocks result as the new key.
   #
   def map_keys(&block)
     dup.map_keys!(&block)
   end
 
   #
-  # Creates an new Hash whose missing items default to [].
-  # Good for collecting things!
+  # Returns a new Hash whose values default to empty arrays. (Good for collecting things!)
   #
   # eg:
   #   Hash.of_arrays[:yays] << "YAY!"
@@ -525,8 +548,7 @@ class Hash
   end
 
   #
-  # Creates an new Hash whose missing items default to values of 0.
-  # Good for counting things!
+  # Returns a new Hash whose values default to 0. (Good for counting things!)
   #
   # eg:
   #   Hash.of_integers[:yays] += 1
@@ -572,7 +594,7 @@ protected
 end
 
 
-class It < BlankSlate
+class It < BlankSlate # :nodoc:
   #undef_method( *(instance_methods - ["__id__", "__send__"]) )
 
   def initialize
@@ -593,7 +615,7 @@ class It < BlankSlate
   end
 end
 
-class NotWrapper < BlankSlate
+class NotWrapper < BlankSlate # :nodoc:
   def initialize(orig)
     @orig = orig
   end

data/lib/epitools/browser.rb

@@ -8,7 +8,7 @@ require 'epitools/browser/mechanize_progressbar'
 
 # TODO: Make socksify optional (eg: if proxy is specified)
 #require 'socksify'
-class SOCKSError < Exception; end
+class SOCKSError < Exception; end # :nodoc:
 
 # TODO: Put options here.
 =begin

data/lib/epitools/browser/cache.rb

@@ -1,6 +1,9 @@
 require 'mechanize'
 require 'sqlite3'
 
+#
+# Emit a quick debug message (only if $DEBUG is true)
+#
 def dmsg(msg)
   
   if $DEBUG

data/lib/epitools/browser/mechanize_progressbar.rb

@@ -5,7 +5,7 @@ require 'epitools/progressbar'
 #
 # (Displays a progress bar whenever an url is retrieved.)
 #
-class Mechanize
+class Mechanize # :nodoc: all
   class Chain
     class ResponseReader
       include Mechanize::Handler

data/lib/epitools/colored.rb

@@ -1,23 +1,31 @@
 require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /win32/
 require 'set'
 
-##
-# cute.
-# 
-#   >> "this is red".red
+#
+# ANSI Colour-coding for terminals that support it.
+# Originally by defunkt (Chris Wanstrath)
+#
+# It extends String with methods that insert terminal codes.
+#
+# Examples:
+#
+#    >> "this is red".red
 #  
-#   >> "this is red with a blue background (read: ugly)".red_on_blue
+#    >> "this is red with a blue background (read: ugly)".red_on_blue
+#
+#    >> "this is light blue".light_blue
 #
-#   >> "this is red with an underline".red.underline
+#    >> "<yellow>This is using <green>tags</green> to colorize.".colorize
 #
-#   >> "this is really bold and really blue".bold.blue
+#    >> "this is red with an underline".red.underline
+#
+#    >> "this is really bold and really blue".bold.blue
+#
+#    >> Colored.red "This is red" # but this part is mostly untested
 #
-#   >> Colored.red "This is red" # but this part is mostly untested
 module Colored
   extend self
 
-  ###########################################################################
-  
   @@is_tty = STDOUT.isatty
 
   COLORS = { 
@@ -67,8 +75,6 @@ module Colored
     COLORS.map { |k,v| "bold_#{k}"  }
   )
   
-  ###########################################################################
-
   COLORS.each do |color, value|
     define_method(color) do 
       colorize(self, :foreground => color)
@@ -171,7 +177,8 @@ module Colored
   alias_method :is_tty?, :enabled? 
 
   #
-  # Color commands will always produce colored strings.
+  # Color commands will always produce colored strings, regardless
+  # of whether the script is being run in a terminal.
   #
   def enable!
     @@is_tty = true
@@ -262,7 +269,6 @@ module Colored
     result
   end  
 
-
 end unless Object.const_defined? :Colored
 
 String.send(:include, Colored)

data/lib/epitools/hexdump.rb

@@ -1,4 +1,4 @@
-%w[rubygems colorize].each{|r| require r}
+require 'colored'
 
 ASCII_PRINTABLE = (33..126)
 

data/lib/epitools/path.rb

@@ -73,19 +73,26 @@ class Path
 
   
   ## getters
-
-  attr_reader :dirs, :base, :ext
+   
+  # The path's directories as an array. (eg: ['usr', 'src', 'linux'])
+  attr_reader :dirs   
+  
+  # The filename without an extension 
+  attr_reader :base
   
+  # The file extension, including the . (eg: ".mp3") 
+  attr_reader :ext
+
+  # Joins and returns the full path  
   def path
-    d = dir
-    f = filename
-    if d
-      File.join(d, (f || "") )
+    if d = dir
+      File.join(d, (filename || "") )
     else
       ""
     end
   end
   
+  # The current directory (with a trailing /)
   def dir
     if dirs 
       File::SEPARATOR + File.join(*dirs)
@@ -159,7 +166,18 @@ class Path
     self.path <=> other.path
   end
 
-  ## opening/reading
+  
+  ## appending
+  
+  #
+  # Path["/etc"]/"passwd" == Path["/etc/passwd"]
+  #
+  def /(other)
+    Path.new( File.join(self, other) )
+  end  
+  
+  
+  ## opening/reading files
   
   def open(mode="rb", &block)
     if block_given?
@@ -174,3 +192,10 @@ class Path
   end
   
 end
+
+#
+# Path("/some/path") is the same as Path["/some/path"]
+#
+def Path(*args)
+  Path[*args]
+end

data/lib/epitools/permutations.rb

@@ -2,7 +2,7 @@ require 'epitools/basetypes'
 
 class Array
   
-  alias_method :"original_*_for_cartesian_*", :*
+  alias_method :"*_without_permutations", :*
   
   #
   # Overloaded * operator.
@@ -24,7 +24,7 @@ class Array
         end
         result
       else
-        send(:"original_*_for_cartesian_*", other)
+        send(:"*_without_permutations", other)
     end
   end
   
@@ -35,6 +35,17 @@ class Array
     ([self] * exponent).foldl(:*)
   end
   
+  def all_pairs(reflexive=false)
+    (0...size).each do |a|
+      start = reflexive ? a : a+1
+      (start...size).each do |b|
+        yield self[a], self[b]
+      end
+    end
+  end
+  
+  enumerable :all_pairs
+  
 end
 
 

data/lib/epitools/pretty_backtrace.rb

@@ -5,32 +5,7 @@ require 'colorize'
 # TODO: Pick a backtrace format. (Also, add a method to replace default backtracer.)
 # TODO: This chould be in a class.
 
-class Array
-
-  def split_when(&block)
-
-    chunks = []
-    start = 0
-
-    for i in 0...self.size-1
-
-      split_here = yield(self[i], self[i+1])
-      if split_here
-        chunks << self[start..i]
-        start = i+1
-      end
-
-    end
-
-    chunks << self[start..-1]
-    chunks
-
-  end
-
-end
-
-
-class Line
+class Line # :nodoc:
 
   attr_accessor :path, :num, :meth, :dir, :filename
 
@@ -79,7 +54,7 @@ end
 
 
 def color_backtrace_1(lines)
-  groups = lines.split_when { |line,nextline| line.path != nextline.path }
+  groups = lines.split_before { |line,nextline| line.path != nextline.path }
   for group in groups
     dir, filename = File.split(group.first.path)
     puts "#{filename.green} (#{dir.light_white})"

data/lib/epitools/rash.rb

@@ -1,5 +1,11 @@
 #
-# A Regex-queryable Hash
+# A Regex-queryable Hash.
+#
+# Usage:
+#
+#     greeting = Rash.new( /^Mr./ => "Hello sir!", /^Mrs./ => "Evening, madame." )
+#     greeting["Mr. Steve Austin"] #=> "Hello sir!"
+#     greeting["Mrs. Steve Austin"] #=> "Evening, madame."
 #
 class Rash
   
@@ -17,7 +23,7 @@ class Rash
 
   def []=(key, value)
     if key.is_a? Regexp
-      key = normalize_regex(key)
+      #key = normalize_regex(key)  # this used to just do: /#{regexp}/
       @regexes << key
     end
     @hash[key] = value
@@ -83,10 +89,5 @@ private
     end
   end
 
-  def normalize_regex(regex)
-    #/^#{regex}$/
-    regex
-  end
-  
 end
 

data/lib/epitools/sys.rb

@@ -2,7 +2,7 @@
 # Cross-platform operating system functions.
 # Includes: process listing, platform detection, etc.
 #
-require 'metaclass'
+require 'epitools/metaclass'
 
 module Sys
   

data/spec/basetypes_spec.rb

@@ -208,7 +208,7 @@ describe Enumerable do
   it "powersets" do
    [1,2,3].powerset.should == [[], [1], [2], [1, 2], [3], [1, 3], [2, 3], [1, 2, 3]]   
   end    
-
+  
 end
 
 describe Hash do

data/spec/path_spec.rb

@@ -1,3 +1,4 @@
+require 'epitools/permutations'
 require 'epitools/path'
 
 describe Path do
@@ -101,4 +102,19 @@ describe Path do
     s2[15..-1].should == s1    
   end
   
+  it "makes paths THREE WAYS!" do
+    [
+      Path(__FILE__),
+      Path[__FILE__],
+      Path.new(__FILE__),
+    ].all_pairs do |p1, p2|
+      p1.path.should == p2.path
+    end
+  end
+  
+  it "appending to paths with /" do
+    ( Path['/etc']/'passwd' ).should == Path['/etc/passwd']
+    ( Path['/etc']/Path['passwd'] ).should_not == Path['/etc/passwd']
+  end
+  
 end

data/spec/permutations_spec.rb

@@ -11,4 +11,25 @@ describe "Permutations" do
     ([1,2] ** 2).should == [ [1,1], [1,2], [2,1], [2,2] ]
   end    
   
+  it "all_pairses" do
+    [1,2,3,4].all_pairs.to_a.should == [ 
+      [1,2], 
+      [1,3], 
+      [1,4], 
+      [2,3],
+      [2,4],
+      [3,4],
+    ]
+
+    # reflexive    
+    [1,2,3].all_pairs(true).to_a.should == [
+      [1,1],
+      [1,2],
+      [1,3],
+      [2,2],
+      [2,3],
+      [3,3],
+    ]
+  end
+
 end

metadata

@@ -2,7 +2,7 @@
 name: epitools
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.15
+  version: 0.4.16
 platform: ruby
 authors: 
 - epitron
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-14 00:00:00 -04:00
+date: 2011-03-15 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -70,7 +70,6 @@ files:
 - lib/epitools/clitools.rb
 - lib/epitools/colored.rb
 - lib/epitools/hexdump.rb
-- lib/epitools/http.rb
 - lib/epitools/lcs.rb
 - lib/epitools/metaclass.rb
 - lib/epitools/niceprint.rb

data/lib/epitools/http.rb

@@ -1,82 +0,0 @@
-require 'net/http'
-require 'uri'
-
-# TODO: what?? this needs to be a class.
-
-class PartialPage < Exception
-    attr_accessor :data
-end
-
-def read_data_from_response(response, amount)
-  
-  amount_read = 0
-  chunks = []
-  
-  begin
-    response.read_body do |chunk|   # read body now
-      
-      amount_read += chunk.length
-      
-      if amount_read > amount
-        amount_of_overflow = amount_read - amount
-        chunk = chunk[0...-amount_of_overflow]
-      end
-      
-      chunks << chunk
-
-      if amount_read >= amount
-          raise PartialPage.new chunks.join('')
-      end
-      
-    end
-  end
-  
-end
-
-
-def http_get_streaming(url = URI.parse("http://epi.is-a-geek.net/files/Mr.%20Show%20-%20Civil%20War%20Re-enactment.avi"))
-
-  #headers = {'User-Agent' => "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.0.1) Gecko/20060111 Firefox/1.5.0.1"}
-  headers = nil
-  
-  Net::HTTP.start(url.host, url.port) do |http|
-    # using block
-    response = http.request_get(url.path, headers) {|response|
-      puts "Response: #{response.inspect}"
-      puts "to hash: #{response.to_hash.inspect}"
-
-      begin
-        read_data_from_response(response, 500)
-      rescue PartialPage => p
-        puts "GOT THE PARTIAL PAGE!"
-        data = p.data
-      end
-    
-      puts
-      puts "===========first 500 bytes================="
-      puts data
-    }    
-  end
-
-end
-
-
-# TODO: Remove RIO dependancy.
-
-def http_get_cached(url)
-  require 'digest/md5'
-  require 'rio'
-  
-  tempdir = ENV['TEMP']
-  cachefile = rio(tempdir, "cached_url_#{Digest::SHA1.hexdigest(url)}")
-  
-  if cachefile.exist?
-    data = rio(cachefile).read
-  else
-    data = rio(url).read
-    rio(cachefile).binmode < data
-  end
-  
-  data
-end
-