qualitysmith_extensions 0.0.7 → 0.0.13

data/lib/qualitysmith_extensions/all.rb

@@ -1,2 +1,4 @@
 require File.dirname(__FILE__) + "/kernel/require_all"
-require_all File.dirname(__FILE__), :exclude => /[^|\/]test\//, :exclude_files => 'all.rb'
+require_all File.dirname(__FILE__), 
+  :exclude => /(^|\/)test\//,         # Don't include anything in test/ because those files will include test/unit, which causes tests to automatically be run (an unfortunate side-effect)!
+  :exclude_files => 'all.rb'

data/lib/qualitysmith_extensions/dir/each_child.rb

@@ -0,0 +1,58 @@
+#--
+# Author::    Nolan Cafferky
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes.
+#++
+
+
+class Dir
+  # Much like each(), except the "." and ".." special files
+  # are ignored.
+  def each_child
+    each do |file|
+      yield file if file != "." and file != ".."
+    end
+  end
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+require 'fileutils'
+
+class TheTest < Test::Unit::TestCase
+  def setup
+    @base_path = "dir_extensions_test_test_each_child"
+    make_test_files @base_path
+  end
+  def teardown
+    FileUtils.remove_entry_secure @base_path
+  end
+
+  def test_each_child
+    Dir.open(@base_path) do |d|
+      results = []
+      d.each_child { |file| results << file }
+      assert_equal 3, results.size
+      assert results.include?("foo")
+      assert results.include?("bar")
+      assert results.include?("foobar")
+    end
+  end
+
+  def make_test_files base_path
+    Dir.mkdir(      base_path)
+    FileUtils.touch(base_path + "/foo")
+    FileUtils.touch(base_path + "/bar")
+    Dir.mkdir(      base_path + "/foobar")
+    FileUtils.touch(base_path + "/foobar/baz")
+  end
+end
+=end

data/lib/qualitysmith_extensions/kernel/require_all.rb

@@ -46,14 +46,15 @@ end
 =begin test
 require 'tmpdir'
 require 'fileutils'
+require 'English'
 
 class TheTest < Test::Unit::TestCase
   def setup
-    @main_subdir = 'require_all_test'
-    @base_dir = "#{Dir.tmpdir}/#{@main_subdir}"
+    @base_dir = "#{Dir.tmpdir}/require_all_test"
     FileUtils.mkdir              @base_dir
-    FileUtils.mkdir_p @deep_dir = @base_dir + "/really/really/deep/subdir"
-    $loaded = Array.new(2)
+    @deep_dir = "really/really/deep/subdir"
+    $loaded = []
+
   end
   def teardown
     FileUtils.rm_rf @base_dir
@@ -61,46 +62,54 @@ class TheTest < Test::Unit::TestCase
 
 
   def test_repeat_requires
-    $loaded[0] = 0
-    File.open("#{@base_dir}/moo.rb", "w") {|f| f.puts "$loaded[0] += 1"}
+    create_ruby_file 'moo.rb'
+
     require_all File.dirname(@base_dir)
-    assert_equal [1, nil], $loaded
+    assert_equal ['moo.rb'], $loaded
 
     require "#{@base_dir}/moo.rb"
-    assert_equal [1, nil], $loaded
+    assert_equal ['moo.rb'], $loaded
 
     # Good! It refuses to load it again, even if we drop the ".rb" part!
     require "#{@base_dir}/moo"
-    assert_equal [1, nil], $loaded
+    assert_equal ['moo.rb'], $loaded
 
     # But, we can still trick it!
     $LOAD_PATH << @base_dir
     require "moo"
-    assert_equal [2, nil], $loaded
+    assert_equal ['moo.rb', 'moo.rb'], $loaded
 
     load "moo.rb"
-    assert_equal [3, nil], $loaded
+    assert_equal ['moo.rb', 'moo.rb', 'moo.rb'], $loaded
   end
 
   def test_deep_subdir
-    File.open("#{@base_dir}/flip.rb", "w") {|f| f.puts "$loaded[0] = true"}
-    File.open("#{@deep_dir}/flop.rb", "w") {|f| f.puts "$loaded[1] = true"}
+    create_ruby_file 'flip.rb'
+    create_ruby_file @deep_dir + "/flop.rb"
 
     require_all File.dirname(@base_dir)
-    assert_equal [true, true], $loaded
+    assert_equal ['flip.rb', @deep_dir + "/flop.rb"], $loaded
   end
 
   def test_exclude_pattern
-    File.open("#{@base_dir}/require_me.rb", "w")       {|f| f.puts "$loaded[0] = true"}
-    File.open("#{@base_dir}/please_ignore_me.rb", "w") {|f| f.puts "$loaded[1] = true"}
+    create_ruby_file 'require_me.rb'
+    create_ruby_file 'please_ignore_me.rb'
 
     require_all File.dirname(@base_dir), :exclude => [/ignore/]
-    assert_equal [true, nil], $loaded
+    assert_equal ['require_me.rb'], $loaded
+  end
+
+  def test_exclude_pattern_with_directory
+    create_ruby_file 'subdir/test/assert_even.rb'
+    create_ruby_file 'subdir/test/assert_odd.rb'
+
+    require_all File.dirname(@base_dir), :exclude => [/[^|\/]test/]
+    assert_equal [], $loaded
   end
 
   def test_exclude_filename
-    File.open("#{@base_dir}/yes.rb", "w") {|f| f.puts "$loaded[0] = true"}
-    File.open("#{@base_dir}/all.rb", "w") {|f| f.puts "$loaded[1] = true"}
+    create_ruby_file 'yes.rb'
+    create_ruby_file 'all.rb'
 
     # :todo: Interesting how none of these patterns work. I would have expected them to. Is there a bug in FileList? Find out...
     #   /usr/lib/ruby/gems/1.8/gems/facets-1.8.51/lib/facets/more/filelist.rb
@@ -113,7 +122,14 @@ class TheTest < Test::Unit::TestCase
     # So...... I added an :exclude_files option so that people wouldn't have to!
     require_all File.dirname(@base_dir), :exclude_files => ['all.rb']
 
-    assert_equal [true, nil], $loaded
+    assert_equal ['yes.rb'], $loaded
+  end
+
+  def create_ruby_file(file_name)
+    if file_name =~ /(.*)\//
+      FileUtils.mkdir_p @base_dir + '/' + $1
+    end
+    File.open(@base_dir + '/' + file_name, "w") {|f| f.puts "$loaded << '#{file_name}'"}
   end
 
 end

data/lib/qualitysmith_extensions/kernel/trap_chain.rb

@@ -0,0 +1,61 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes!
+#++
+
+module Kernel
+  # Calling <tt>Kernel#trap()</tt> by itself will _replace_ any previously registered handler code.
+  # <tt>Kernel#trap_chain()</tt>, on the other hand, will _add_ the block you supply to the existing "list" of registered handler blocks.
+  # Similar to the way <tt>Kernel#at_exit()</tt> works, <tt>Kernel#trap_chain()</tt> will _prepend_ the given +block+ to the call chain for the given +signal_name+.
+  # When the signal occurs, your block will be executed first and then the previously registered handler will be invoked. This can be called repeatedly to create a "chain" of handlers.
+  def trap_chain(signal_name, *args, &block)
+    previous_interrupt_handler = trap(signal_name, *args) {}
+    trap(signal_name, *args) do
+      block.call
+      previous_interrupt_handler.call unless previous_interrupt_handler == "DEFAULT"
+    end
+  end
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'rubygems'
+require 'qualitysmith_extensions/kernel/capture_output'
+require 'fileutils'
+
+class TheTest < Test::Unit::TestCase
+  def setup
+    FileUtils.touch('trap_chain_test_output')
+  end
+  def teardown
+    FileUtils.remove_entry_secure 'trap_chain_test_output'
+  end
+
+  def test_1
+    output = capture_output do    # For some reason, this wasn't capturing the output from the child process when I did plain puts, so I changed it to write to a file instead...
+
+      pid = fork do
+        trap_chain("INT") { File.open('trap_chain_test_output', 'a') {|file| file.puts "Handler 1" } }
+        trap_chain("INT") { File.open('trap_chain_test_output', 'a') {|file| file.puts "Handler 2"; file.puts "Exiting..."; }; exit }
+        trap_chain("INT") { File.open('trap_chain_test_output', 'a') {|file| file.puts "Handler 3" } }
+        puts 'Hello world'
+        sleep 5
+      end
+      Process.kill "INT", pid
+      Process.wait
+
+    end
+
+    assert_equal "Handler 3\nHandler 2\nExiting...\n", File.read('trap_chain_test_output')
+  end
+
+end
+=end
+

data/lib/qualitysmith_extensions/mutex/if_available.rb

@@ -0,0 +1,75 @@
+#--
+# Author::    Nolan Cafferky
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes.
+#++
+
+require 'thread'
+class Mutex
+  # Acts like synchronize, except that if the lock cannot be acquired immediately,
+  # the program continues without executing the given block.
+  #
+  # ==Example:
+  #
+  #   mutex = Mutex.new
+  #   # ...
+  #   mutex.if_available do
+  #     # Some process that we only want one thread to be running at a time,
+  #     # and we don't mind skipping if some other thread is already doing it.
+  #     loop do
+  #       notify_mechanics if danger_to_teh_manifold!
+  #       sleep 60
+  #     end
+  #   end
+  def if_available
+    if try_lock
+      begin
+        yield
+      ensure
+        unlock
+      end
+    end
+  end
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+class TheTest < Test::Unit::TestCase
+  def setup
+    @semaphore = Mutex.new
+  end
+
+  def teardown
+  end
+
+  def test_executes_if_lock_is_available
+    i_ran = nil
+
+    @semaphore.if_available do
+      i_ran = true
+    end
+
+    assert i_ran
+  end
+
+  def test_continues_if_lock_is_unavailable
+    i_ran = nil
+
+    @semaphore.lock
+    @semaphore.if_available do
+      i_ran = true
+    end
+    @semaphore.unlock
+
+    assert_nil i_ran
+  end
+end
+=end

data/lib/qualitysmith_extensions/object/ignore_access.rb

@@ -0,0 +1,79 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes!
+# Developer notes:
+# * Come up with a shorter/better name than ignore_access?
+# * Other name ideas:
+#   * ignore_private
+#   * access_everything
+#   * access
+#   * sneaky
+#   * rude
+#   * all_public
+#   * public!
+#   * all (like rdoc's --all -- it's too generic for a method name though)
+#   * promiscuous (like rdoc's --promiscuous -- different semantics though)
+#++
+
+require 'rubygems'
+require 'facets/more/functor'
+
+class Object
+
+  # Sends all messages to receiver, bypassing access restrictions, allowing you to call private methods (like class_variable_get) without having to write ugly send() calls.
+  #
+  #   o.class.ignore_access.class_variable_set(:@@v, 'old value')
+  # is equivalent to:
+  #   o.class.send(:class_variable_set, :@@v, 'new value')
+  #
+  def ignore_access
+    @_ignore_access_functor ||= Functor.new do |op,*args|
+      self.send(op,*args)
+    end
+  end
+  alias_method :access, :ignore_access
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+
+  # It's not identical to Kernel#meta, as this test proves! (Must run it singly, without other tests.)
+#  def test_meta
+#    require 'rubygems'; require 'facets/core/kernel/meta'
+#    o = Object.new
+#    o.class.meta.class_variable_set(:@@v, 'old value')
+#    assert_equal 'old value', o.class.meta.class_variable_get(:@@v)
+#
+#    #assert_nothing_raised { o.class.send(:class_variable_get, :@@v) }    # Fails!
+#
+#    assert_equal Object, o.class
+#    o.class.send(:class_variable_set, :@@v, 'new value')
+#    assert_equal 'new value', o.class.send(:class_variable_get, :@@v)
+#    assert_equal 'new value', o.class.meta.class_variable_get(:@@v)       # Fails! Still has 'old value'!
+#  end
+
+  def test_1
+    o = Object.new
+    o.class.ignore_access.class_variable_set(:@@v, 'old value')
+    assert_nothing_raised { o.class.send(:class_variable_get, :@@v) }
+    o.class.send(:class_variable_set, :@@v, 'new value')
+    assert_equal 'new value', o.class.ignore_access.class_variable_get(:@@v)
+    assert_equal 'new value', o.class.send(:class_variable_get, :@@v) 
+  end
+
+end
+
+=end
+

data/lib/qualitysmith_extensions/object/methods.rb

@@ -2,7 +2,7 @@
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
-# Submit to Facets?:: Yes
+# Submit to Facets?:: Yes. Actually, Facets already has one, which takes a symbol (:inherited, :local, :public, etc.). Possibly merge with that one. Accept symbol *or* boolean as arg?
 # Developer notes::
 #++
 

data/lib/qualitysmith_extensions/object/send_if_not_nil.rb

@@ -0,0 +1,35 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Maybe.
+# Developer notes::
+#++
+
+class Object
+  def send_if_not_nil(message, *args)
+    if message
+      send(message, *args) 
+    else
+      self
+    end
+  end
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+  def test_1
+    assert_equal 'a', 'a'.send_if_not_nil(nil)
+    assert_equal 'A', 'a'.send_if_not_nil(:upcase)
+  end
+end
+=end

data/lib/qualitysmith_extensions/object/singleton_send.rb

@@ -2,7 +2,7 @@
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
-# Submit to Facets?:: Yes
+# Submit to Facets?:: Maybe.
 # Developer notes::
 # * Method name too long? Imagine if we wanted to string multiple calls together.
 #   * Ideas:
@@ -23,6 +23,9 @@ class Object
   #
   # More specificaly, it <tt>extend</tt>s +self+ with the methods from +moduule+ and then sends the supplied +message+ and +args+ (if any).
   #
+  # Examples:
+  #   "whatever".ss(MyColorizer, :colorize, :blue)
+  #
   # Advantages:
   # * Keeps things object-oriented. Better than having global/class methods.
   #   * (<tt>"whatever".ss(MyColorizer, :colorize).ss(SomeOtherClass, :another_class_method)</tt> instead of 
@@ -37,8 +40,23 @@ class Object
   #   * Can't just call .sigleton_send(self, :some_method) if you want to use +some_method+ that's defined in +self+.
   #   * So what do we call the module containing the "singleton method"? String::MyColorizer? MyColorizer::String? MyStringColorizer?
   #
-  # Examples:
-  #   "whatever".ss(MyColorizer, :colorize, :blue)
+  # Adding methods to the base class using Facets' own *namespacing* facilities (Module#namespace and Module#include_as)
+  # might actually be a more sensible alternative a lot of the time than bothering to create singleton methods for single objects!
+  # That would look somethig like:
+  #
+  #   class String
+  #     namespace :my_colorizer do
+  #       def colorize(...); ...; end
+  #     end
+  #   end
+  #   "whatever".my_colorizer.colorize(:blue)
+  #
+  # or
+  #
+  #   class String
+  #     include_as :my_colorizer => MyColorizer
+  #   end
+  #   "whatever".my_colorizer.colorize(:blue)
   #
   def singleton_send(moduule, message, *args)
     self.extend(moduule)

data/lib/qualitysmith_extensions/string/with_knowledge_of_color.rb

@@ -0,0 +1,64 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Maybe
+#++
+
+module WithKnowledgeOfColor
+  Color_regexp = /\e\[[^m]+m/
+
+  def strip_color
+    gsub(Color_regexp, '')
+  end
+
+  # This version of +length+ takes into account the fact that the ANSI color codes themselves don't take up any space to display on the screen.
+  # So this returns the number of characters wide the string is when it is actually printed to the screen.
+  def length_without_color
+    strip_color.length
+  end
+
+  def nonprinting_characters_used_for_color
+    self.scan(Color_regexp).join
+  end
+
+  def ljust_without_color(width)
+    ljust(width + nonprinting_characters_used_for_color.length)
+  end
+end
+
+class String
+  include WithKnowledgeOfColor
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'rubygems'
+gem 'colored'
+require 'colored'
+
+class TheTest < Test::Unit::TestCase
+  def test_strip_color
+    assert       "abc" != "abc".blue
+    assert_equal "abc",   "abc".blue.strip_color
+  end
+  def test_length_without_color
+    assert_equal 12, "abc".blue.length
+    assert_equal 3,  "abc".blue.length_without_color
+  end
+  def test_nonprinting_characters_used_for_color
+    assert_equal "\e[34m\e[0m", 'abc'.blue.nonprinting_characters_used_for_color
+  end
+  def test_ljust_without_color
+    assert_equal "abc  ", 'abc'.     ljust(              5)
+    assert_equal "abc  ", 'abc'.blue.ljust_without_color(5).strip_color
+    assert_equal "\e[34mabc\e[0m  ", 'abc'.blue.ljust_without_color(5)
+  end
+
+end
+=end

data/lib/qualitysmith_extensions/symbol/match.rb

@@ -0,0 +1,36 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes! I can't believe Facets has Regexp#chomp, capitalize, downcase, etc., but not match/=~ !
+# Developer notes::
+#++
+
+class Symbol
+  def match(regexp)
+    to_s.match(regexp)
+  end
+  def =~(regexp)
+    to_s =~ regexp
+  end
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+  def test_equal_tilde
+    assert_equal 1, :chopper =~ /hopper/
+  end
+  def test_match
+    assert :chopper.match(/hopper/).is_a?(MatchData)
+    assert_equal 'hopper', :chopper.match(/hopper/).to_s
+  end
+end
+=end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: qualitysmith_extensions
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
-date: 2007-04-03 00:00:00 -07:00
+  version: 0.0.13
+date: 2007-04-11 00:00:00 -07:00
 summary: A collection of reusable Ruby methods developed by QualitySmith.
 require_paths: 
 - lib
@@ -48,7 +48,11 @@ files:
 - lib/qualitysmith_extensions/kernel/filter_output.rb
 - lib/qualitysmith_extensions/kernel/backtrace.rb
 - lib/qualitysmith_extensions/kernel/capture_output.rb
+- lib/qualitysmith_extensions/kernel/trap_chain.rb
+- lib/qualitysmith_extensions/dir/each_child.rb
 - lib/qualitysmith_extensions/object/singleton_send.rb
+- lib/qualitysmith_extensions/object/send_if_not_nil.rb
+- lib/qualitysmith_extensions/object/ignore_access.rb
 - lib/qualitysmith_extensions/object/methods.rb
 - lib/qualitysmith_extensions/object/default.rb
 - lib/qualitysmith_extensions/file/exact_match_regexp.rb
@@ -58,6 +62,7 @@ files:
 - lib/qualitysmith_extensions/date/month_ranges.rb
 - lib/qualitysmith_extensions/time/deprecated.rb
 - lib/qualitysmith_extensions/time/all.rb
+- lib/qualitysmith_extensions/mutex/if_available.rb
 - lib/qualitysmith_extensions/console/command.rb
 - lib/qualitysmith_extensions/console/command.facets.1.8.54.rb
 - lib/qualitysmith_extensions/console/command.facets.1.8.51.rb
@@ -65,6 +70,7 @@ files:
 - lib/qualitysmith_extensions/module/includable_once.rb
 - lib/qualitysmith_extensions/module/create_setter.rb
 - lib/qualitysmith_extensions/module/attribute_accessors.rb
+- lib/qualitysmith_extensions/symbol/match.rb
 - lib/qualitysmith_extensions/enumerable/enum.rb
 - lib/qualitysmith_extensions/hash/to_query_string.rb
 - lib/qualitysmith_extensions/hash/all.rb
@@ -79,6 +85,7 @@ files:
 - lib/qualitysmith_extensions/array/group_by.rb
 - lib/qualitysmith_extensions/string/digits_only.rb
 - lib/qualitysmith_extensions/string/shell_escape.rb
+- lib/qualitysmith_extensions/string/with_knowledge_of_color.rb
 - lib/qualitysmith_extensions/string/md5.rb
 - lib/qualitysmith_extensions/string/to_underscored_label.rb
 - lib/qualitysmith_extensions/string/all.rb