qualitysmith_extensions 0.0.20 → 0.0.24

data/lib/qualitysmith_extensions/array/classify.rb

@@ -0,0 +1,97 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes!
+# Developer notes:
+# * This is the analog in Array to Set#classify (core).
+# * Compare to Array#group_by (qualitysmith_extensions), which assumes all elements are arrays (making a "table") and only
+#   allows you to do simple classification by the value of a "column". On the other hand, it adds the option to delete that
+#   column from the array, which can be nice, since the classification key in the hash makes it somewhat redundant.
+#++
+
+require 'rubygems'
+gem 'facets'
+require 'facet/array/to_hash'
+class Array
+
+=begin rdoc
+   Classifies the array by the return value of the given block and returns a hash of {value => array of elements} pairs.
+   The block is called once for each element of the array, passing the element as parameter.
+
+   Breaks an array into a hash of smaller arrays, making a new group for each unique value returned by the block. Each unique value becomes a key in the hash.
+
+   Example:
+      [
+        ['a', 1],
+        ['a', 2],
+        ['b', 3],
+        ['b', 4],
+      ].classify {|o| o[0]}
+    =>  
+      {
+        "a" => [['a', 1], ['a', 2]], 
+        "b" => [['b', 3], ['b', 4]]
+      }
+=end
+  def classify(&block)
+    hash = {}
+    each do |element|
+      classification = yield(element)
+      (hash[classification] ||= []) << element
+    end
+    hash
+  end
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'set'
+
+class TheTest < Test::Unit::TestCase
+  def test_classify
+    input = [
+      ['a', 1],
+      ['a', 2],
+      ['b', 3],
+      ['b', 4],
+    ]
+    assert_equal({
+        "a" => [['a', 1], ['a', 2]], 
+        "b" => [['b', 3], ['b', 4]]
+      }, input.classify {|o| o[0]}
+    )
+    # For comparison:
+    assert_equal({
+        "a" => Set[['a', 1], ['a', 2]], 
+        "b" => Set[['b', 3], ['b', 4]]
+      }, input.to_set.classify {|o| o[0]}
+    )
+
+
+    input = [
+      ['Bob', "Bottle of water", 1.00],
+      ['Bob', "Expensive stapler", 50.00],
+      ['Alice', "Dinner for 2", 100.00],
+      ['Alice', "Bus ride to RubyConf", 50.00],
+    ]
+    assert_equal({
+        "Alice" => [['Alice',"Dinner for 2", 100.0], ['Alice', "Bus ride to RubyConf", 50.0]],
+        "Bob"   => [['Bob', "Bottle of water", 1.0], ['Bob', "Expensive stapler", 50.0]]
+      }, input.classify {|o| o[0]}
+    )
+    assert_equal({
+        50.0  => [["Bob", "Expensive stapler", 50.00], ["Alice", "Bus ride to RubyConf", 50.00]],
+        100.0 => [["Alice", "Dinner for 2", 100.00]],
+        1.0   => [["Bob", "Bottle of water", 1.00]]
+      }, input.classify {|o| o[2]}
+    )
+  end
+end
+=end
+

data/lib/qualitysmith_extensions/array/group_by.rb

@@ -2,19 +2,22 @@
 # Author::    Tyler Rick
 # Copyright:: Copyright (c) 2007 QualitySmith, Inc.
 # License::   Ruby License
-# Submit to Facets?:: Yes
+# Submit to Facets?:: Maybe. 
 # Developer notes:
 # * Name is too general? Name it something to do with 'tables'?
+#   * group_table_by ?
+# * Compare to Array#classify (qualitysmith_extensions), which aims to be more general, letting you classify arrays that are
+#   *not* in "table" form (whose elements are *not* all arrays of equal size and might not even be *arrays*).
 #++
 
 require 'rubygems'
 gem 'facets'
 require 'facet/array/delete_values_at'
-require 'facet/array/to_hash'
 class Array
 
 =begin rdoc
-   Breaks an array into a hash of smaller arrays, making a new group for each unique value in the specified column. Each unique value becomes a key in the hash.
+   Breaks an array into a hash of smaller arrays, making a new group for each unique value in the specified column.
+   Each unique value becomes a key in the hash.
 
    Example:
         [
@@ -42,7 +45,8 @@ class Array
         "b"=>[['b', 3], ['b', 4]]
    
    *Notes*:
-   * <tt>self</tt> must be in the shape of a "table" (a non-sparse, rectangular, two-dimensional array).
+   * <tt>self</tt> must be in the shape of a "table" (that is, a rectangular-shaped, two-dimensional array = an array of arrays,
+     each member array being of the same size (the "width" of the table)).
    * This is different from the GROUP BY in SQL in that it doesn't apply an aggregate (like sum or average) to each group -- it just returns each group unmodified.
 
 =end
@@ -67,6 +71,8 @@ end
 #   |_|\___||___/\__|
 #
 =begin test
+require 'set'
+
 class TheTest < Test::Unit::TestCase
   def test_group_by
     assert_equal({ }, [ ].group_by(column_index = 0))
@@ -81,6 +87,9 @@ class TheTest < Test::Unit::TestCase
         ['b', 4],
       ].group_by(column_index = 0)
     )
+
+
+
     assert_equal({
         "a"=>[['a', 1], ['a', 2]], 
         "b"=>[['b', 3], ['b', 4]]
@@ -91,6 +100,17 @@ class TheTest < Test::Unit::TestCase
         ['b', 4],
       ].group_by(column_index = 0, :delete_key => false)
     )
+    assert_equal({
+        "a" => Set[['a', 1], ['a', 2]], 
+        "b" => Set[['b', 3], ['b', 4]]
+      }, [
+        ['a', 1],
+        ['a', 2],
+        ['b', 3],
+        ['b', 4],
+      ].to_set.classify {|o| o[0]}
+    )
+
 
     input = [
       ['Bob', "Bottle of water", 1.00],

data/lib/qualitysmith_extensions/colored/toggleability.rb

@@ -0,0 +1,61 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?::
+# Developer notes::
+#++
+
+require 'rubygems'
+gem 'colored'
+require 'colored'
+gem 'facets'
+require 'facets/core/module/alias_method_chain'
+gem 'qualitysmith_extensions'
+require 'qualitysmith_extensions/module/guard_method'
+
+class String
+  def colorize_with_toggleability(string, options = {})
+    if @@colorize_enabled
+      colorize_without_toggleability(string, options)
+    else
+      string
+    end
+  end
+  alias_method_chain :colorize, :toggleability
+  mguard_method :color_on!, :@@colorize_enabled, :color_off!
+
+end unless String.instance_methods.include?('colorize_with_toggleability')
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+  def test_color_on!
+    String.color_on!
+    assert_equal "\e[31mfoo\e[0m", 'foo'.red
+  end
+  def test_color_off!
+    String.color_off!
+    assert_equal "foo", 'foo'.red
+  end
+  def test_color_off_with_block
+    String.color_on!
+    assert_equal "\e[31mfoo\e[0m", 'foo'.red
+    String.color_off! do
+      assert_equal "foo", 'foo'.red
+    end
+    assert_equal "\e[31mfoo\e[0m", 'foo'.red
+  end
+
+end
+=end
+
+

data/lib/qualitysmith_extensions/module/bool_attr_accessor.rb

@@ -0,0 +1,414 @@
+#--
+# Author::    Thomas Sawyer, Tyler Rick
+# Copyright:: Copyright (c) Thomas Sawyer, probably, since this is a derivative work
+# 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...
+# * I'm going to rename this one to bool_attr_accessor, which calls both bool_attr_reader and bool_attr_writer
+# * Then you also have the option to use bool_attr_reader and bool_attr_writer separately if you so desire.
+# * Other changes made:
+#   * Changed it so that if you call a!(false) it would actually set @a to false rather than leaving it unchanged. (I assume that was a bug.)
+#++
+
+# bool_attr_accessor
+
+class Module
+  # This creates a reader method for a boolean (flag) attribute (instance variable).
+  #
+  #   bool_attr_reader :a
+  #
+  # is equivalent to
+  #
+  #   def a?
+  #     @a ? true : @a
+  #   end
+  #
+  # Example:
+  #   class Foo
+  #     def set_it
+  #       @a = true
+  #     end
+  #   end
+  #   x = Foo.new
+  #   x.a?        # => false
+  #   x.set_it
+  #   x.a?        # => true
+  #
+  def bool_attr_reader(*args)
+    make = {}
+    args.each { |a|
+      make["#{a}?".to_sym] = %{
+        def #{a}?(true_value=true)
+          @#{a} ? true_value : @#{a}
+        end
+      }
+    }
+    module_eval make.values.join("\n"), __FILE__, __LINE__
+
+    make.keys
+  end
+
+  # This creates a setter method for a boolean (flag) attribute (instance variable).
+  #
+  #   bool_attr_setter :a
+  #
+  # is equivalent to
+  #
+  #   def a!(switch=Exception)
+  #     if switch == Exception
+  #       @a = !@a
+  #     else
+  #       @a = switch ? true : false
+  #       self
+  #     end
+  #   end
+  #
+  # This setter method can either be used to set it directly to true or false or to toggle it.
+  #
+  # Examples:
+  #   x = Klass.new
+  #   x.a! true   # sets @a to true
+  #   x.a!        # toggles @a, so that it ends up being false
+  #   x.a!        # toggles @a, so that it ends up being true
+  #   x.a! false  # sets @a to false
+  #
+  def bool_attr_setter(*args)
+    make = {}
+    args.each { |a|
+      make["#{a}!".to_sym] = %{
+        def #{a}!(switch=Exception)
+          if switch == Exception
+            @#{a} = !@#{a}
+          else
+            @#{a} = switch ? true : false
+                    # used to be @#{a} instead of false in Facets version
+            self
+          end
+        end
+      }
+    }
+    module_eval make.values.join("\n"), __FILE__, __LINE__
+    make.keys
+  end
+
+
+  # This creates both a reader and a setter for a boolean (flag) attribute (instance variable).
+  #
+  #   bool_attr_accessor :a
+  #
+  # is equivalent to
+  #
+  #   bool_attr_reader :a
+  #   bool_attr_setter :a
+  #
+  # Examples:
+  #   x = Klass.new
+  #   x.a! true   # sets @a to true
+  #   x.a?        # => true
+  #   x.a!        # toggles @a, so that it ends up being false
+  #   x.a!        # toggles @a, so that it ends up being true
+  #   x.a! false  # sets @a to false
+  #
+  def bool_attr_accessor(*args)
+    bool_attr_reader *args
+    bool_attr_setter *args
+  end
+
+end
+
+# mbool_attr_accessor
+
+class Module
+  # This creates a reader method for a boolean (flag) class/module variable.
+  #
+  #   mbool_attr_reader :a
+  #
+  # is equivalent to
+  #
+  #   def self.a?
+  #     @@a ? true : @@a
+  #   end
+  #
+  # Works for both classes and modules.
+  #
+  def mbool_attr_reader(*args)
+    make = {}
+    args.each { |a|
+      make["#{a}?".to_sym] = %{
+        def self.#{a}?(true_value=true)
+          @@#{a} ? true_value : @@#{a}
+        end
+      }
+    }
+    module_eval make.values.join("\n"), __FILE__, __LINE__
+    make.keys
+  end
+
+  # This creates a setter method for a boolean (flag) class/module variable.
+  #
+  #   mbool_attr_setter :a
+  #
+  # is equivalent to
+  #
+  #   def self.a!(switch=Exception)
+  #     if switch == Exception
+  #       @@a = !@@a
+  #     else
+  #       @@a = switch ? true : false
+  #       self
+  #     end
+  #   end
+  #
+  # Works for both classes and modules.
+  #
+  def mbool_attr_setter(*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}!(switch=Exception)
+          if switch == Exception
+            @@#{a} = !@@#{a}
+          else
+            @@#{a} = switch ? true : false
+            self
+          end
+        end
+      }
+    }
+    module_eval make.values.join("\n"), __FILE__, __LINE__
+    make.keys
+  end
+
+  # This creates both a reader and a setter for a boolean (flag) class/module variable.
+  #
+  #   mbool_attr_accessor :a
+  #
+  # is equivalent to
+  #
+  #   mbool_attr_reader :a
+  #   mbool_attr_setter :a
+  #
+  # Works for both classes and modules.
+  #
+  def mbool_attr_accessor(*args)
+    mbool_attr_reader :a
+    mbool_attr_setter :a
+  end
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+require 'rubygems'
+require 'qualitysmith_extensions/object/ignore_access'
+
+# Test that it works for *instances*
+class TestBoolAttr < Test::Unit::TestCase
+  def setup
+    @x = C.new
+  end
+
+  class C_for_default_is_nil
+    bool_attr_accessor :a, :b
+  end
+
+  # Also tests that it can create multiple accessors at once.
+  def test1_default_is_nil
+    assert_equal nil, C_for_default_is_nil.new.a? 
+    assert_equal nil, C_for_default_is_nil.new.b? 
+  end
+
+  class C
+    bool_attr_accessor :a
+  end
+
+  def test2_toggle
+    assert_equal nil, @x.a? 
+    @x.a!
+    assert_equal true, @x.a? 
+    @x.a!
+    assert_equal false, @x.a? 
+  end
+
+  def test3_setter
+    @x.a! true
+    @x.a! true
+    assert_equal true, @x.a? 
+
+    @x.a! false 
+    assert_equal false, @x.a? 
+  end
+  def test4_sets_to_boolean_even_if_try_to_set_to_other_type
+    @x.a! "whatever" 
+    assert_equal true, @x.a?     # Still returns a boolean even though we tried to set it to a string.
+
+    @x.a! nil
+    assert_equal false, @x.a?    # Still returns a boolean even though we tried to set it to nil.
+  end
+end
+
+# Test that it works for *modules*
+class TestForModules < Test::Unit::TestCase
+
+  class M_for_default_is_nil
+    mbool_attr_accessor :a
+  end
+  def test1_default_is_nil
+    assert_equal nil, M_for_default_is_nil.a? 
+  end
+
+  module M
+    mbool_attr_accessor :a
+  end
+  def test2_toggle
+    assert_equal nil, M.a? 
+    M.a!
+    assert_equal true, M.a? 
+    M.a!
+    assert_equal false, M.a? 
+  end
+  def test3_setter
+    M.a! true
+    M.a! true
+    assert_equal true, M.a? 
+
+    M.a! false 
+    assert_equal false, M.a? 
+  end
+  def test4_sets_to_boolean_even_if_try_to_set_to_other_type
+    M.a! "whatever" 
+    assert_equal true, M.a?     # Still returns a boolean even though we tried to set it to a string.
+
+    M.a! nil
+    assert_equal false, M.a?    # Still returns a boolean even though we tried to set it to nil.
+  end
+end
+
+# Test that it also works for *classes*
+class TestForClasses < Test::Unit::TestCase
+
+  class C_for_default_is_nil
+    mbool_attr_accessor :a
+  end
+  def test1_default_is_nil
+    assert_equal nil, C_for_default_is_nil.a? 
+  end
+
+  class C
+    mbool_attr_accessor :a
+  end
+
+  def test2_toggle
+    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? 
+
+    assert_equal ["@_ignore_access_functor"], C.instance_variables
+    assert_equal ["@@a"], C.class_variables
+  end
+
+  def test3_setter
+    C.a! true
+    C.a! true
+    assert_equal true, C.a? 
+
+    C.a! false 
+    assert_equal false, C.a? 
+  end
+  def test4_sets_to_boolean_even_if_try_to_set_to_other_type
+    C.a! "whatever" 
+    assert_equal true, C.a?     # Still returns a boolean even though we tried to set it to a string.
+
+    C.a! nil
+    assert_equal false, C.a?    # Still returns a boolean even though we tried to set it to nil.
+  end
+end
+
+
+# Observation: You can also the normal bool_attr_accessor in conjunction with class << self.
+# The methods generated seem to *behave* in the same way. Both techniques allow you to query the class, C.a?
+# The only difference is in which *variables* are use to store the state:
+# * class << self and the normal bool_attr_accessor:
+#   Stores the state in an instance variable for the *class*: @a
+# * mbool_attr_accessor:
+#   Stores the state in a *class* variable: @@a
+#
+# Can someone explain to me the difference between class variables and instance variables of a class?
+# It seems silly (confusing even!) to have both of them!
+#
+# My best explanation is that the fact that we can even *have* instance variables of a class does *not* mean it's a good idea
+# to use them. It simply means that Matz made the language with as few arbitrary restrictions as possible. He made it
+# technically *possible* to do a lot of things that it is probably not good practice to do... And one of those things is
+# using instance variables of classes to store state information for that class.
+#
+# What do you think class variables are for? Exactly that! There's a *reason* we have both @a and @@a variables -- to
+# *differentiate* between the two kinds of variables and keep programmers sane. So please don't blur the distinction and
+# use the @a-type variable to do the job that @@a-type variables are for.
+#
+# Or am I missing something here?
+#
+class TestWith_class_self_and_plain_bool_attr_accessor < Test::Unit::TestCase
+
+  class C_for_default_is_nil
+    class << self
+      bool_attr_accessor :a
+    end
+  end
+  def test1_default_is_nil
+    assert_equal nil, C_for_default_is_nil.a? 
+  end
+
+  class C
+    class << self
+      bool_attr_accessor :a
+    end
+  end
+  # This is where I spotted a class that uses this technique:
+  # * Test::Unit::Assertions::AssertionMessage
+
+  def test_2_toggle
+    assert_equal false, C.a?  # Why isn't it nil like it is for the instance use case of bool_attr_accessor?
+    C.a!
+    assert_equal true, C.a? 
+    C.a!
+    assert_equal false, C.a? 
+
+    assert_equal ["@a"], C.instance_variables
+    assert_equal [], C.new.instance_variables  # @a is an instance variable of the *class*  *not* objects of the class  -- weird!
+    assert_equal [], C.class_variables
+  end
+
+  def test3_setter
+    C.a! true
+    C.a! true
+    assert_equal true, C.a? 
+
+    C.a! false 
+    assert_equal false, C.a? 
+  end
+  def test4_sets_to_boolean_even_if_try_to_set_to_other_type
+    C.a! "whatever" 
+    assert_equal true, C.a?     # Still returns a boolean even though we tried to set it to a string.
+
+    C.a! nil
+    assert_equal false, C.a?    # Still returns a boolean even though we tried to set it to nil.
+  end
+
+end
+=end
+