qualitysmith_extensions 0.0.13 → 0.0.17

data/Readme

@@ -22,8 +22,8 @@ Like Facets, this library contains:
 
 == Usage
 
-  require "rubygems"
-  gem "qualitysmith_extensions"
+  require 'rubygems'
+  gem 'qualitysmith_extensions'
 
 And then <b>include as much or as little as you want</b>.
 
@@ -31,15 +31,15 @@ Use the handy <tt>all.rb</tt> files to load everything in a particular directory
 
 To load everything:
 
-  require "qualitysmith_extensions/all"
+  require 'qualitysmith_extensions/all'
 
 To load everything just for one class:
 
-  require "qualitysmith_extensions/string/all"
+  require 'qualitysmith_extensions/string/all'
 
 To load just an individual method:
 
-  require "qualitysmith_extensions/array/average"
+  require 'qualitysmith_extensions/array/average'
 
 
 == Running tests

data/lib/qualitysmith_extensions/exception/inspect_with_backtrace.rb

@@ -0,0 +1,61 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes
+# Developer notes::
+# * Add depth argument to inspect()? 
+#++
+
+require 'rubygems'
+require 'facets/core/module/alias_method_chain'
+
+class Exception
+  # Use this if you want to output an exception with all the details that you'd *normally* see if the exception went unrescued
+  # (since exception.inspect/p exception doesn't provide a backtrace!) 
+  # This is mostly useful if you rescue an exception, want to print or log it and then re-raise it...
+  def inspect_with_backtrace
+    exception.class.name + ": " + exception.message + "\n" +
+      exception.backtrace.map {|v| '  ' + v}.join( "\n" )
+  end
+  alias_method_chain :inspect, :backtrace
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'rubygems'
+require 'facets/core/string/lines'
+
+class TheTest < Test::Unit::TestCase
+  def raise_an_error(arg = nil)
+    raise ArgumentError, "You passed in the wrong argument!" 
+  end
+  def test_1
+    begin
+      raise_an_error
+    rescue ArgumentError => exception
+      #puts exception.inspect
+      assert_equal 'ArgumentError: You passed in the wrong argument!', exception.inspect.lines[0]
+      assert_match /[^:]+:\d+:in `raise_an_error'/, exception.inspect.lines[1]
+      assert exception.inspect.lines.size > 3
+    end
+  end
+
+end
+=end
+
+
+=begin
+Sightings of other exception -> string formatters
+
+log4r/formatter/formatter.rb
+        return "Caught #{obj.class}: #{obj.message}\n\t" +\
+               obj.backtrace[0...@depth].join("\n\t")
+
+=end

data/lib/qualitysmith_extensions/kernel/example_printer.rb

@@ -19,7 +19,7 @@ require 'rubygems'
 # alternative is dirt simple, and it still works.
 module ExamplePrinter
   # Prints the given statement (+code+ -- a string) before evaluating it.
-  def put_statement(code, binding = nil)
+  def put_statement(code, binding = nil, file = __FILE__, line = __LINE__)
     # This didn't work. Still got this error: undefined local variable or method `x' for #<TheTest:0xb7dbc358> (NameError)
 #    Binding.of_caller do |caller_binding|
 #      puts caller_binding
@@ -27,7 +27,7 @@ module ExamplePrinter
 #      eval code, caller_binding
 #    end
     puts code
-    eval code, binding
+    eval code, binding, file, line
   end
   alias_method :stp, :put_statement
 

data/lib/qualitysmith_extensions/kernel/filter_output.rb

@@ -77,7 +77,7 @@ require 'test/unit'
 
 # Metaprogram for decreased duplication...
   ['stdout', 'stderr'].each do |stream_name|
-    eval(%Q{
+    eval <<-End, binding, __FILE__, __LINE__+1
     def noisy_command_#{stream_name}
       $#{stream_name}.puts "Some annoying error message"
       $#{stream_name}.puts "Some error message that we actually care to see"
@@ -103,6 +103,6 @@ require 'test/unit'
         assert_equal "Some error message that we actually care to see\n", $#{stream_name}.string
       end
     end
-    })
+    End
   end
 =end

data/lib/qualitysmith_extensions/module/attr_tester.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'facets/core/module/attr_tester'

data/lib/qualitysmith_extensions/module/attribute_accessors.rb

@@ -5,7 +5,7 @@
 class Module # :nodoc:
   def mattr_reader(*syms)
     syms.each do |sym|
-      class_eval(<<-EOS, __FILE__, __LINE__)
+      class_eval(<<-EOS, __FILE__, __LINE__+1)
         unless defined? @@#{sym}
           @@#{sym} = nil
         end
@@ -23,7 +23,7 @@ class Module # :nodoc:
   
   def mattr_writer(*syms)
     syms.each do |sym|
-      class_eval(<<-EOS, __FILE__, __LINE__)
+      class_eval(<<-EOS, __FILE__, __LINE__+1)
         unless defined? @@#{sym}
           @@#{sym} = nil
         end

data/lib/qualitysmith_extensions/module/guard_method.rb

@@ -0,0 +1,112 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes!
+# Developer notes::
+# * Is it thread-safe?? Probably not, as it stands...
+#   But the whole thing that prompted me to create a guard method in the first place was to try to avoid a deadlock that was caused by recursively calling a method with a synchronize in it. So I'm not even sure if it's possible to make it thread-safe?
+#++
+
+require 'rubygems'
+require 'qualitysmith_extensions/module/attribute_accessors'
+require 'qualitysmith_extensions/module/mattr_tester'
+require 'qualitysmith_extensions/module/attr_tester'
+require 'qualitysmith_extensions/symbol/match'
+
+
+class Module
+  def guard_method(method_name, guard_variable)
+    raise ArgumentError.new("Expected an instance variable name but got #{guard_variable}") if guard_variable !~ /^@([\w_]+)$/
+    guard_variable.to_s =~ /^@([\w_]+)$/    # Why didn't the regexp above set $1 ??
+    class_eval do
+      attr_tester $1.to_sym
+    end
+    module_eval <<-End, __FILE__, __LINE__+1
+      def #{method_name}(&block)
+        old_guard_state, #{guard_variable} = #{guard_variable}, true
+        yield
+        #{guard_variable} = old_guard_state
+      end
+    End
+  end
+
+  def mguard_method(method_name, guard_variable)
+    raise ArgumentError.new("Expected a class variable name but got #{guard_variable}") if guard_variable !~ /^@@[\w_]+$/
+    guard_variable.to_s =~ /^@@([\w_]+)$/
+    class_eval do
+      mattr_tester $1.to_sym
+    end
+    module_eval <<-End, __FILE__, __LINE__+1
+      class << self
+        def #{method_name}(&block)
+          old_guard_state, #{guard_variable} = #{guard_variable}, true
+          yield
+          #{guard_variable} = old_guard_state
+        end
+      end
+    End
+  end
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class GuardMethodTest < Test::Unit::TestCase
+  class A
+    guard_method :guard_the_fruit!, :@guarding_the_fruit
+  end
+  def test_guard_method
+    a = A.new
+    assert_equal nil, a.guarding_the_fruit?
+    a.guard_the_fruit! do
+      # Call it recursively!
+      a.guard_the_fruit! do
+        assert_equal true, a.guarding_the_fruit?
+      end
+      assert_equal true, a.guarding_the_fruit?   # This is the reason why we have to save the 'old_guard_state'. So that we don't stupidly set it back to false if we still haven't exited from the outermost call to the guard black.
+    end
+    assert_equal nil, a.guarding_the_fruit?
+  end
+  def test_guard_method_error
+    assert_raise(ArgumentError) do
+      self.class.class_eval do
+        guard_method :guard_the_fruit!, :@@guarding_the_fruit
+      end
+    end
+  end
+end
+
+class MGuardMethodTest < Test::Unit::TestCase
+  class B
+    mguard_method :guard_the_fruit!, :@@guarding_the_fruit
+  end
+  def test_mguard_method
+    assert_equal nil, B.guarding_the_fruit?
+    B.guard_the_fruit! do
+      # Call it recursively!
+      B.guard_the_fruit! do
+        assert_equal true, B.guarding_the_fruit?
+      end
+      assert_equal true, B.guarding_the_fruit?   # This is the reason why we have to save the 'old_guard_state'. So that we don't stupidly set it back to false if we still haven't exited from the outermost call to the guard black.
+    end
+    assert_equal nil, B.guarding_the_fruit?
+  end
+  def test_mguard_method_error
+    assert_raise(ArgumentError) do
+      self.class.class_eval do
+        mguard_method :guard_the_fruit!, :@guarding_the_fruit
+      end
+    end
+  end
+
+end
+=end
+

data/lib/qualitysmith_extensions/module/mattr_tester.rb

@@ -0,0 +1,120 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes
+# Developer notes::
+# * Based on /usr/lib/ruby/gems/1.8/gems/facets-1.8.54/lib/facets/core/module/attr_tester.rb
+# * Hey Thomas, don't you think Module#attr_tester should only create the read-only a? method and have another method that creates the writer (like there how we have attr_reader, _writer, and _accessor?) ? "tester" does not imply "setter" in my mind...
+#++
+
+class Module
+  # This creates two methods for each given variable name. One is used to test
+  # the attribute and the other is used to set or toggle it.
+  #
+  #   attr_tester :a
+  #
+  # is equivalent to
+  #
+  #   def self.a?
+  #     @@a ? true : @@a
+  #   end
+  #
+  #   def self.a!(switch=Exception)
+  #     if switch == Exception
+  #       @@a = !@@a
+  #     else
+  #       @@a = switch ? true : @@a
+  #       self
+  #     end
+  #   end
+  #
+  # Works for both classes and modules.
+  #
+  def mattr_tester(*args)
+
+    make = {}
+    args.each { |a|
+      # Initialize it first so that we won't have any NameErrors.
+      module_eval %{ @@#{a} = nil if !defined?(@@#{a}) }, __FILE__, __LINE__
+
+      make["#{a}?".to_sym] = %{
+        def self.#{a}?(true_value=true)
+          @@#{a} ? true_value : @@#{a}
+        end
+      }
+      make["#{a}!".to_sym] = %{
+        def self.#{a}!(switch=Exception)
+          if switch == Exception
+            @@#{a} = !@@#{a}
+          else
+            @@#{a} = switch ? true : @@#{a}
+            self
+          end
+        end
+      }
+    }
+    module_eval make.values.join("\n"), __FILE__, __LINE__
+
+    return make.keys
+  end
+end
+
+
+
+
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+require 'rubygems'
+require 'qualitysmith_extensions/object/ignore_access'
+
+
+class TheTest < Test::Unit::TestCase
+  class C
+    mattr_tester :a
+  end
+  module M
+    mattr_tester :a
+  end
+
+  def test_cattr_tester_exclamation
+    C.access.class_variable_set(:@@a, false)
+    assert_equal(false, C.a?)   # otherwise would have been nil
+    C.a!
+    assert_equal(true, C.a?)
+    C.a!
+    assert_equal(false, C.a?)
+  end
+  def test_cattr_tester_return
+    C.a!
+    assert_equal(true, C.a?)
+    C.a!("whatever")
+    assert_equal(true, C.a?)   # Still returns a boolean even though we set it to a string.
+  end
+
+  def test_mattr_tester_exclamation
+    assert_equal(nil, M.a?)
+    M.a!
+    assert_equal(true, M.a?)
+    M.a!
+    assert_equal(false, M.a?)
+  end
+  def test_mattr_tester_return
+    M.a!
+    assert_equal(true, M.a?)
+    M.a!("whatever")
+    assert_equal(true, M.a?)   # Still returns a boolean even though we set it to a string.
+  end
+
+end
+=end
+

data/lib/qualitysmith_extensions/object/mcall.rb

@@ -0,0 +1,92 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Maybe.
+# Developer notes::
+#++
+
+class Object
+  # Calls the method implementation from the module of your choice (+moduule+) on the object of your choice (+self+).
+  #
+  # The only (huge) catch is that +self+ must either be an instance of +moduule+ or have +moduule+ as an ancestor... which severely limits its usefullness. (Compare with singleton_send.)
+  #
+  # It is still useful, though, if you want to call some "original" implementation provided by Kernel (or some other base module) and the people that overrode it didn't play nice and use +alias_method_chain+.
+  #
+  # No matter! If the class of the object you are calling this on has Kernel as an ancestor, then you can call any method from Kernel on this object!
+  #
+  # This implementation is gratefully owed to the folks who wrote PP (/usr/lib/ruby/1.8/pp.rb)
+  def mcall(moduule, message, *args, &block)
+    moduule.instance_method(message).bind(self).call(*args, &block)
+  end
+  alias_method :msend, :mcall
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+require 'rubygems'
+require 'qualitysmith_extensions/test/assert_exception'
+require 'qualitysmith_extensions/test/assert_includes'
+require 'facets/core/module/alias_method_chain'
+
+
+module MyColorizer
+  def colorize(color = nil)
+    self + " (colorized in #{color})"
+  end
+end
+class String
+  def class()
+    'classy'
+  end
+end
+
+class TheTest < Test::Unit::TestCase
+  def test_doesnt_work_like_singleton_send
+    # This doesn't quite work the same as singleton_send ...
+    assert_exception(TypeError, lambda { |exception|
+      assert_equal 'bind argument must be an instance of MyColorizer', exception.message
+    }) do
+      "whatever".mcall(MyColorizer, :colorize, :blue)
+    end
+    # self actually has to *be* a MyColorizer for this to work... which severely limits the usefulness of mcall...
+    # Since the whole reason we want this is because we don't want to simply mix in MyColorizer into the base class...
+  end
+
+  module ClassSystem
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :class, :class_system
+      end
+    end
+    def class_with_class_system()
+      1<2 ? 'lower' : 'middle'
+    end
+  end
+
+  def test_1
+    assert_equal "classy", "me".class
+    # The main use for this would be to call "original" implementations provided by Kernel or some other base module that you can be pretty sure is an ancestor of self...
+    assert_contains String.ancestors, Kernel
+    assert_equal String,  "me".mcall(Kernel, :class)
+  end
+
+  def test_2_after_doing_alias_method_chain
+    String.class_eval do
+      #remove_method :to_s
+      include ClassSystem
+    end
+    assert_equal "lower",  "me".class                       # Version 3
+    assert_equal "classy", "me".class_without_class_system  # Version 2
+    assert_equal String,   "me".mcall(Kernel, :class)       # Version 1
+  end
+
+end
+=end
+

data/lib/qualitysmith_extensions/object/send_if.rb

@@ -0,0 +1,87 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Maybe
+# Developer notes::
+# * The name of this method probably ought to be a little more specific.
+#   * It should say something about the fact that it the message sending is conditional but the block execution is unconditional.
+#   * always_execute_block_but_only_send_message_if ? Hmm... a bit too verbose, perhaps.
+#   * conditional_passthrough ?
+#   * passthrough_unless ?
+#   * use_wrapper_method_if ?
+#++
+
+
+class Object
+  # Unconditionally calls +block_to_always_execute+. But only sends +message+ to +self+ if +condition+ is met.
+  #
+  # This is useful if you want to wrap a block with some method but you only want the method itself to be used some of the time.
+  # For example, if it's for benchmarking, you may only want to enable it during development but disable during production to save on some overhead.
+  #
+  # Note: this cannot be used to call methods that expect blocks (Ruby 1.9 maybe?)
+  #
+  def send_if(condition, message, *args, &block_to_always_execute)
+    if condition
+      self.__send__(message, *args, &block_to_always_execute)
+    else
+      block_to_always_execute.call
+    end
+  end
+
+  # Opposite of send_if
+  def send_unless(condition, *args, &block)
+    self.send_if(!condition, *args, &block)
+  end
+end
+
+
+
+
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class Foo
+  attr_reader :called_benchmark
+  def benchmark(&block)
+    @called_benchmark = true
+    yield
+    sleep 0.1     # Simulate lots of overhead, which we may want to avoid if we can help it
+  end
+end
+
+class TheTest < Test::Unit::TestCase
+  def setup
+    @foo = Foo.new
+  end
+
+  def test_with_true
+    executed_block = false
+    @foo.send_if(true, :benchmark) do
+      executed_block = true
+    end
+    assert executed_block
+    assert @foo.called_benchmark
+  end
+
+  def test_with_false
+    executed_block = false
+    @foo.send_if(false, :benchmark) do
+      executed_block = true
+    end
+    assert executed_block
+    assert !@foo.called_benchmark
+  end
+
+end
+=end
+

data/lib/qualitysmith_extensions/object/singleton_send.rb

@@ -58,9 +58,9 @@ class Object
   #   end
   #   "whatever".my_colorizer.colorize(:blue)
   #
-  def singleton_send(moduule, message, *args)
+  def singleton_send(moduule, message, *args, &block)
     self.extend(moduule)
-    self.send(message, *args)
+    self.send(message, *args, &block)
   end
   alias_method :ss, :singleton_send
 
@@ -93,6 +93,10 @@ end
 #
 =begin test
 require 'test/unit'
+require 'rubygems'
+require 'qualitysmith_extensions/test/assert_exception'
+require 'qualitysmith_extensions/test/assert_includes'
+
 
 module MyColorizer
   def colorize(color = nil)
@@ -100,7 +104,6 @@ module MyColorizer
   end
 end
 
-
 #module PresentationLayer
 #  create_module_method :to_currency do
 #    #...
@@ -108,10 +111,10 @@ end
 #end
 
 
-class TheTest < Test::Unit::TestCase
-  def test_1
-    assert_equal "whatever (colorized in )", "whatever".ss(MyColorizer, :colorize)
-    assert_equal "whatever (colorized in blue)", "whatever".singleton_send(MyColorizer, :colorize, :blue)
+class TheTest1_UsingSingletonSend < Test::Unit::TestCase
+  def test_using_singleton_send
+    assert_equal "whatever (colorized in )",     "whatever".ss(MyColorizer, :colorize)
+    assert_equal "whatever (colorized in blue)", "whatever".ss(MyColorizer, :colorize, :blue)
   end
 
 #  def test_singleton_that_accepts_object

data/lib/qualitysmith_extensions/template.rb

@@ -0,0 +1,32 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?::
+# Developer notes::
+#++
+
+
+
+
+
+
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+  def test_1
+  end
+
+end
+=end
+

data/lib/qualitysmith_extensions/test/assert_exception.rb

@@ -13,6 +13,7 @@ class Test::Unit::TestCase
   #
   # Before:
   #
+  #    exception = nil
   #    assert_raises(ArgumentError) { SomeCommand.execute("foo '''") }
   #    begin
   #      SomeCommand.execute("foo -m '''")

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: qualitysmith_extensions
 version: !ruby/object:Gem::Version 
-  version: 0.0.13
-date: 2007-04-11 00:00:00 -07:00
+  version: 0.0.17
+date: 2007-04-17 00:00:00 -07:00
 summary: A collection of reusable Ruby methods developed by QualitySmith.
 require_paths: 
 - lib
@@ -31,6 +31,7 @@ authors:
 files: 
 - lib/qualitysmith_extensions/global_variable_set.rb
 - lib/qualitysmith_extensions/collection_extensions_for_cgi.rb
+- lib/qualitysmith_extensions/template.rb
 - lib/qualitysmith_extensions/all.rb
 - lib/qualitysmith_extensions/month.rb
 - lib/qualitysmith_extensions/test/assert_exception.rb
@@ -38,6 +39,7 @@ files:
 - lib/qualitysmith_extensions/test/assert_changed.rb
 - lib/qualitysmith_extensions/test/all.rb
 - lib/qualitysmith_extensions/test/assert_includes.rb
+- lib/qualitysmith_extensions/exception/inspect_with_backtrace.rb
 - lib/qualitysmith_extensions/file_test/binary_file.rb
 - lib/qualitysmith_extensions/kernel/require_all.rb
 - lib/qualitysmith_extensions/kernel/simulate_input.rb
@@ -51,10 +53,12 @@ files:
 - 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/mcall.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/object/send_if.rb
 - lib/qualitysmith_extensions/file/exact_match_regexp.rb
 - lib/qualitysmith_extensions/date/iso8601.rb
 - lib/qualitysmith_extensions/date/deprecated.rb
@@ -66,10 +70,13 @@ files:
 - 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
+- lib/qualitysmith_extensions/module/guard_method.rb
 - lib/qualitysmith_extensions/module/alias_method.rb
 - lib/qualitysmith_extensions/module/includable_once.rb
+- lib/qualitysmith_extensions/module/mattr_tester.rb
 - lib/qualitysmith_extensions/module/create_setter.rb
 - lib/qualitysmith_extensions/module/attribute_accessors.rb
+- lib/qualitysmith_extensions/module/attr_tester.rb
 - lib/qualitysmith_extensions/symbol/match.rb
 - lib/qualitysmith_extensions/enumerable/enum.rb
 - lib/qualitysmith_extensions/hash/to_query_string.rb