qualitysmith_extensions 0.0.24 → 0.0.29

data/lib/qualitysmith_extensions/colored/toggleability.rb

@@ -23,7 +23,7 @@ class String
     end
   end
   alias_method_chain :colorize, :toggleability
-  mguard_method :color_on!, :@@colorize_enabled, :color_off!
+  mguard_method :color_on!, :@@colorize_enabled
 
 end unless String.instance_methods.include?('colorize_with_toggleability')
 
@@ -38,18 +38,18 @@ end unless String.instance_methods.include?('colorize_with_toggleability')
 require 'test/unit'
 
 class TheTest < Test::Unit::TestCase
-  def test_color_on!
+  def test_color_on
     String.color_on!
     assert_equal "\e[31mfoo\e[0m", 'foo'.red
   end
-  def test_color_off!
-    String.color_off!
+  def test_color_off
+    String.color_on! false
     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
+    String.color_on! false do
       assert_equal "foo", 'foo'.red
     end
     assert_equal "\e[31mfoo\e[0m", 'foo'.red

data/lib/qualitysmith_extensions/module/bool_attr_accessor.rb

@@ -37,6 +37,8 @@ class Module
   #   x.a?        # => true
   #
   def bool_attr_reader(*args)
+    options = (if args.last.is_a?(Hash) then args.pop else {} end)    # These options aren't used here, per se, but it allows us to have bool_attr_accessor pass along same args to both bool_attr_reader and bool_attr_setter.
+
     make = {}
     args.each { |a|
       make["#{a}?".to_sym] = %{
@@ -74,7 +76,13 @@ class Module
   #   x.a!        # toggles @a, so that it ends up being true
   #   x.a! false  # sets @a to false
   #
+  # Use <tt>:allow_nil</tt> if you want it to be a tri-state flag -- that is, if you need to be able to set it to +nil+ as well as true and false.
+  #   bool_attr_setter :a, :b, :allow_nil => true
+  #   x.a! nil  # sets @a to nil
+  #
   def bool_attr_setter(*args)
+    options = (if args.last.is_a?(Hash) then args.pop else {} end)
+
     make = {}
     args.each { |a|
       make["#{a}!".to_sym] = %{
@@ -82,8 +90,11 @@ class Module
           if switch == Exception
             @#{a} = !@#{a}
           else
-            @#{a} = switch ? true : false
-                    # used to be @#{a} instead of false in Facets version
+            #{
+              options[:allow_nil] ?
+                "@#{a} = switch ? true : switch" :
+                "@#{a} = switch ? true : false"
+            }
             self
           end
         end
@@ -134,6 +145,8 @@ class Module
   # Works for both classes and modules.
   #
   def mbool_attr_reader(*args)
+    options = (if args.last.is_a?(Hash) then args.pop else {} end)    # These options aren't used here, per se, but it allows us to have bool_attr_accessor pass along same args to both bool_attr_reader and bool_attr_setter.
+
     make = {}
     args.each { |a|
       make["#{a}?".to_sym] = %{
@@ -163,7 +176,13 @@ class Module
   #
   # Works for both classes and modules.
   #
+  # Use <tt>:allow_nil</tt> if you want it to be a tri-state flag -- that is, if you need to be able to set it to +nil+ as well as true and false.
+  #   mbool_attr_setter :a, :b, :allow_nil => true
+  #   C.a! nil  # sets @@a to nil
+  #
   def mbool_attr_setter(*args)
+    options = (if args.last.is_a?(Hash) then args.pop else {} end)
+
     make = {}
     args.each { |a|
       # Initialize it first so that we won't have any NameErrors.
@@ -174,7 +193,11 @@ class Module
           if switch == Exception
             @@#{a} = !@@#{a}
           else
-            @@#{a} = switch ? true : false
+            #{
+              options[:allow_nil] ?
+                "@@#{a} = switch ? true : switch" :
+                "@@#{a} = switch ? true : false"
+            }
             self
           end
         end
@@ -196,8 +219,8 @@ class Module
   # Works for both classes and modules.
   #
   def mbool_attr_accessor(*args)
-    mbool_attr_reader :a
-    mbool_attr_setter :a
+    mbool_attr_reader *args
+    mbool_attr_setter *args
   end
 end
 
@@ -214,24 +237,22 @@ 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
+  class C
     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? 
+  def setup
+    @x = C.new
   end
 
-  class C
-    bool_attr_accessor :a
+  # Also tests that it can create multiple accessors at once.
+  def test1_default_is_nil
+    assert_equal nil, C.new.a? 
+    assert_equal nil, C.new.b? 
   end
 
   def test2_toggle
@@ -257,8 +278,43 @@ class TestBoolAttr < Test::Unit::TestCase
     @x.a! nil
     assert_equal false, @x.a?    # Still returns a boolean even though we tried to set it to nil.
   end
+
 end
 
+class TestBoolAttr_AllowNil < Test::Unit::TestCase
+
+  class C
+    bool_attr_accessor :a, :b, :allow_nil => true
+  end
+
+  def setup
+    @x = C.new
+  end
+
+  def test1_default_is_nil
+    assert_equal nil, C.new.a? 
+    assert_equal nil, C.new.b? 
+  end
+
+  def test2_for_nilability
+    @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 nil, @x.a?           # Lets us set it to nil!
+    #assert_equal true, @x.a?(nil)     # Testing the "is it nil?" question.
+    assert_equal true, @x.a?.nil?     # Testing the "is it nil?" question.
+
+
+    @x.a! false
+    assert_equal false, @x.a?         # Lets us set it to false!
+    assert_equal true, @x.a? == false   # Testing the "is it false?" question.
+  end
+end
+
+
+
+#---------------------------------------------------------------------------------------------------
 # Test that it works for *modules*
 class TestForModules < Test::Unit::TestCase
 
@@ -295,7 +351,34 @@ class TestForModules < Test::Unit::TestCase
     assert_equal false, M.a?    # Still returns a boolean even though we tried to set it to nil.
   end
 end
+class TestForModules_AllowNil < Test::Unit::TestCase
+
+  module M
+    mbool_attr_accessor :a, :b, :allow_nil => true
+  end
+
+  def test1_default_is_nil
+    assert_equal nil, M.a? 
+    assert_equal nil, M.b? 
+  end
+
+  def test2_for_nilability
+    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 nil, M.a?           # Lets us set it to nil!
+    #assert_equal true, M.a?(nil)     # Testing the "is it nil?" question.
+    assert_equal true, M.a?.nil?     # Testing the "is it nil?" question.
+
+
+    M.a! false
+    assert_equal false, M.a?         # Lets us set it to false!
+    assert_equal true, M.a? == false   # Testing the "is it false?" question.
+  end
+end
 
+#---------------------------------------------------------------------------------------------------
 # Test that it also works for *classes*
 class TestForClasses < Test::Unit::TestCase
 
@@ -341,7 +424,7 @@ 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 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

data/lib/qualitysmith_extensions/module/guard_method.rb

@@ -13,9 +13,11 @@
 
 require 'rubygems'
 require 'qualitysmith_extensions/module/attribute_accessors'
-require 'qualitysmith_extensions/module/mattr_tester'
-require 'qualitysmith_extensions/module/attr_tester'
+require 'facets/core/kernel/require_local'
+require_local 'bool_attr_accessor'
+#require 'qualitysmith_extensions/module/bool_attr_accessor'
 require 'qualitysmith_extensions/symbol/match'
+require 'qualitysmith_extensions/class/class_methods'
 
 
 class Module
@@ -32,53 +34,38 @@ class Module
   #   end                          # Causes @stupid_stuff_disabled to be set back to false
   #   # Okay, a, you can resume doing stupid stuff again...
   #   
-  # If you also want a guard method that *disables* the flag rather than *enabling* it, simply pass in the desired name of this
-  # "unguard" method as the value of the +unguard_method_name+ argument.
-  #   class A
-  #     guard_method :guard_the_fruit!, :@guarding_the_fruit, :stop_guarding_the_fruit!
-  #   end
-  #
-  # Examples of unguard methods:
-  #   mguard_method :color_on!, :@@color_enabled, :color_off!
-  #   mguard_method :without_benchmarking, :@@benchmarking_disabled, :with_benchmarking
+  # If you want your guard method to *disable* the flag rather than *enable* it, simply pass false to the guard method.
   #
   # These calls can be nested however you wish:
   #   a.guard_the_fruit! do
-  #     a.stop_guarding_the_fruit! do
+  #     a.guard_the_fruit!(false) do
   #       assert_equal false, a.guarding_the_fruit?
   #     end
   #     assert_equal true, a.guarding_the_fruit?
   #   end
   #
   # You can also use the guard methods as normal flag setter/clearer methods by simply not passing a block to it. Hence
-  #     a.guard_the_fruit!
+  #   a.guard_the_fruit!
   # will simply set @guarding_the_fruit to true, and
-  #     a.stop_guarding_the_fruit!
+  #   a.guard_the_fruit!(false)
   # will set @guarding_the_fruit to false.
   #
-  def guard_method(guard_method_name, guard_variable, unguard_method_name = nil)
+  def guard_method(guard_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
+      bool_attr_accessor $1.to_sym
     end
     module_eval <<-End, __FILE__, __LINE__+1
-      def #{guard_method_name}(new_value = nil, &block)
-        old_guard_state, #{guard_variable} = #{guard_variable}, true
+      def #{guard_method_name}(new_value = true, &block)
+        old_guard_state, #{guard_variable} = #{guard_variable}, new_value
         if block_given?
-          returning = yield
-          #{guard_variable} = old_guard_state
-          returning
-        end
-      end
-    End
-    module_eval <<-End, __FILE__, __LINE__+1 unless unguard_method_name.nil?
-      def #{unguard_method_name}(new_value = nil, &block)
-        old_guard_state, #{guard_variable} = #{guard_variable}, false
-        if block_given?
-          returning = yield
-          #{guard_variable} = old_guard_state
-          returning
+          begin
+            returning = yield
+          ensure
+            #{guard_variable} = old_guard_state
+            returning
+          end
         end
       end
     End
@@ -90,32 +77,24 @@ class Module
   #
   # Example:
   #   mguard_method :guard_the_fruit!, :@@guarding_the_fruit
-  def mguard_method(guard_method_name, guard_variable, unguard_method_name = nil)
+  #   mguard_method :use_assert_equal_with_highlight!, :@@always_use_assert_equal_with_highlight
+  def mguard_method(guard_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
+      mbool_attr_accessor $1.to_sym
     end
     module_eval <<-End, __FILE__, __LINE__+1
       class << self
-        def #{guard_method_name}(new_value = nil, &block)
-          old_guard_state, #{guard_variable} = #{guard_variable}, true
+        def #{guard_method_name}(new_value = true, &block)
+          old_guard_state, #{guard_variable} = #{guard_variable}, new_value
           if block_given?
-            returning = yield
-            #{guard_variable} = old_guard_state
-            returning
-          end
-        end
-      end
-    End
-    module_eval <<-End, __FILE__, __LINE__+1 unless unguard_method_name.nil?
-      class << self
-        def #{unguard_method_name}(new_value = nil, &block)
-          old_guard_state, #{guard_variable} = #{guard_variable}, false
-          if block_given?
-            returning = yield
-            #{guard_variable} = old_guard_state
-            returning
+            begin
+              returning = yield
+            ensure
+              #{guard_variable} = old_guard_state
+              returning
+            end
           end
         end
       end
@@ -159,11 +138,24 @@ class GuardMethodTest_Simple < Test::Unit::TestCase
   def test_return_value
     assert_equal 'special return value', A.new.guard_the_fruit! { 'special return value' }
   end
+
+  def try_to_return_prematurely(a)
+    a.guard_the_fruit! do
+      assert_equal true, a.guarding_the_fruit?
+      return 'prematurely'
+    end
+  end
+  def test_guard_method_for_block_that_tries_to_return_prematurely
+    a = A.new
+    assert_equal nil, a.guarding_the_fruit?
+    try_to_return_prematurely(a)
+    assert_equal nil, a.guarding_the_fruit?
+  end
 end
 
-class GuardMethodTest_WithUnguard < Test::Unit::TestCase
+class GuardMethodTest_WithUnguard < Test::Unit::TestCase    # (By "unguard" here I mean passing false to the guard method...)
   class A
-    guard_method :guard_the_fruit!, :@guarding_the_fruit, :stop_guarding_the_fruit!
+    guard_method :guard_the_fruit!, :@guarding_the_fruit
   end
   def test_guard_method
     a = A.new
@@ -172,7 +164,7 @@ class GuardMethodTest_WithUnguard < Test::Unit::TestCase
       a.guard_the_fruit! do
         assert_equal true, a.guarding_the_fruit?
 
-        a.stop_guarding_the_fruit! do
+        a.guard_the_fruit! false do
           assert_equal false, a.guarding_the_fruit?
           a.guard_the_fruit! do
             assert_equal true, a.guarding_the_fruit?
@@ -193,11 +185,11 @@ class GuardMethodTest_WithUnguard < Test::Unit::TestCase
     a.guard_the_fruit!
     assert_equal true, a.guarding_the_fruit?
 
-    a.stop_guarding_the_fruit! do
+    a.guarding_the_fruit? do
       assert_equal false, a.guarding_the_fruit?
       a.guard_the_fruit! do
         assert_equal true, a.guarding_the_fruit?
-        a.stop_guarding_the_fruit!
+        a.guard_the_fruit! false
         assert_equal false, a.guarding_the_fruit?
         a.guard_the_fruit!
         assert_equal true, a.guarding_the_fruit?
@@ -210,9 +202,9 @@ class GuardMethodTest_WithUnguard < Test::Unit::TestCase
 
   def test_return_value
     assert_equal nil, A.new.guard_the_fruit!
-    assert_equal nil, A.new.stop_guarding_the_fruit!
-    assert_equal 'special return value', A.new.guard_the_fruit!         { 'special return value' }
-    assert_equal 'special return value', A.new.stop_guarding_the_fruit! { 'special return value' }
+    assert_equal nil, A.new.guard_the_fruit!(false)
+    assert_equal 'special return value', A.new.guard_the_fruit!        { 'special return value' }
+    assert_equal 'special return value', A.new.guard_the_fruit!(false) { 'special return value' }
   end
 end
 
@@ -249,11 +241,23 @@ class MGuardMethodTest_Simple < Test::Unit::TestCase
   def test_return_value
     assert_equal 'special return value', B.guard_the_fruit! { 'special return value' }
   end
+
+  def try_to_return_prematurely
+    B.guard_the_fruit! do
+      assert_equal true, B.guarding_the_fruit?
+      return 'prematurely'
+    end
+  end
+  def test_guard_method_for_block_that_tries_to_return_prematurely
+    assert_equal nil, B.guarding_the_fruit?
+    try_to_return_prematurely
+    assert_equal nil, B.guarding_the_fruit?
+  end
 end
 
 class MGuardMethodTest_WithUnguard < Test::Unit::TestCase
   class B
-    mguard_method :guard_the_fruit!, :@@guarding_the_fruit, :stop_guarding_the_fruit!
+    mguard_method :guard_the_fruit!, :@@guarding_the_fruit
   end
   def test_guard_method
     assert_equal nil, B.guarding_the_fruit?
@@ -261,7 +265,7 @@ class MGuardMethodTest_WithUnguard < Test::Unit::TestCase
       B.guard_the_fruit! do
         assert_equal true, B.guarding_the_fruit?
 
-        B.stop_guarding_the_fruit! do
+        B.guard_the_fruit!(false) do
           assert_equal false, B.guarding_the_fruit?
           B.guard_the_fruit! do
             assert_equal true, B.guarding_the_fruit?
@@ -281,11 +285,11 @@ class MGuardMethodTest_WithUnguard < Test::Unit::TestCase
     B.guard_the_fruit!
     assert_equal true, B.guarding_the_fruit?
 
-    B.stop_guarding_the_fruit! do
+    B.guard_the_fruit!(false) do
       assert_equal false, B.guarding_the_fruit?
       B.guard_the_fruit! do
         assert_equal true, B.guarding_the_fruit?
-        B.stop_guarding_the_fruit!
+        B.guard_the_fruit!(false)
         assert_equal false, B.guarding_the_fruit?
         B.guard_the_fruit!
         assert_equal true, B.guarding_the_fruit?
@@ -298,9 +302,9 @@ class MGuardMethodTest_WithUnguard < Test::Unit::TestCase
 
   def test_return_value
     assert_equal nil, B.guard_the_fruit!
-    assert_equal nil, B.stop_guarding_the_fruit!
+    assert_equal nil, B.guard_the_fruit!(false)
     assert_equal 'special return value', B.guard_the_fruit!         { 'special return value' }
-    assert_equal 'special return value', B.stop_guarding_the_fruit! { 'special return value' }
+    assert_equal 'special return value', B.guard_the_fruit!(false) { 'special return value' }
   end
 end
 # End duplication