qualitysmith_extensions 0.0.20 → 0.0.24

data/lib/qualitysmith_extensions/module/guard_method.rb

@@ -5,7 +5,10 @@
 # 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?
+#   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 (in other words, someone else's attempt at thread-safety
+#   resulted in me getting into a deadlock, which is why I wrote this method to begin with). So I'm not even sure if it's
+#   possible to make it thread-safe?
 #++
 
 require 'rubygems'
@@ -16,23 +19,78 @@ require 'qualitysmith_extensions/symbol/match'
 
 
 class Module
-  def guard_method(method_name, guard_variable)
+  # A guard method (by this definition anyway) is a method that sets a flag, executes a block, and then returns the flag to its
+  # previous value. It ensures that the flag is set during the execution of the block.
+  #
+  # In the simplest case, you'd use it like this:
+  #   class A
+  #     guard_method :disable_stupid_stuff!, :@stupid_stuff_disabled
+  #   end
+  #   a = A.new
+  #   a.disable_stupid_stuff! do   # Causes @stupid_stuff_disabled to be set to true
+  #     # Section of code during which you don't want any stupid stuff to happen
+  #   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
+  #
+  # These calls can be nested however you wish:
+  #   a.guard_the_fruit! do
+  #     a.stop_guarding_the_fruit! 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!
+  # will simply set @guarding_the_fruit to true, and
+  #     a.stop_guarding_the_fruit!
+  # will set @guarding_the_fruit to false.
+  #
+  def guard_method(guard_method_name, guard_variable, unguard_method_name = nil)
     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)
+      def #{guard_method_name}(new_value = nil, &block)
         old_guard_state, #{guard_variable} = #{guard_variable}, true
-        returning = yield
-        #{guard_variable} = old_guard_state
-        returning
+        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
+        end
       end
     End
   end
 
-  def mguard_method(method_name, guard_variable)
+  # See the documentation for guard_method. mguard_method does the same thing, only it creates a _class_ (or _module_) method
+  # rather than an instance method and it uses a _class_ (or _module_) variable rather than an instance variable to store the
+  # guard state.
+  #
+  # Example:
+  #   mguard_method :guard_the_fruit!, :@@guarding_the_fruit
+  def mguard_method(guard_method_name, guard_variable, unguard_method_name = nil)
     raise ArgumentError.new("Expected a class variable name but got #{guard_variable}") if guard_variable !~ /^@@[\w_]+$/
     guard_variable.to_s =~ /^@@([\w_]+)$/
     class_eval do
@@ -40,11 +98,25 @@ class Module
     end
     module_eval <<-End, __FILE__, __LINE__+1
       class << self
-        def #{method_name}(&block)
+        def #{guard_method_name}(new_value = nil, &block)
           old_guard_state, #{guard_variable} = #{guard_variable}, true
-          returning = yield
-          #{guard_variable} = old_guard_state
-          returning
+          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
+          end
         end
       end
     End
@@ -61,7 +133,7 @@ end
 =begin test
 require 'test/unit'
 
-class GuardMethodTest < Test::Unit::TestCase
+class GuardMethodTest_Simple < Test::Unit::TestCase
   class A
     guard_method :guard_the_fruit!, :@guarding_the_fruit
   end
@@ -89,7 +161,70 @@ class GuardMethodTest < Test::Unit::TestCase
   end
 end
 
-class MGuardMethodTest < Test::Unit::TestCase
+class GuardMethodTest_WithUnguard < Test::Unit::TestCase
+  class A
+    guard_method :guard_the_fruit!, :@guarding_the_fruit, :stop_guarding_the_fruit!
+  end
+  def test_guard_method
+    a = A.new
+    assert_equal nil, a.guarding_the_fruit?
+    a.guard_the_fruit! do
+      a.guard_the_fruit! do
+        assert_equal true, a.guarding_the_fruit?
+
+        a.stop_guarding_the_fruit! do
+          assert_equal false, a.guarding_the_fruit?
+          a.guard_the_fruit! do
+            assert_equal true, a.guarding_the_fruit?
+          end
+          assert_equal false, a.guarding_the_fruit?
+        end
+
+        assert_equal true, a.guarding_the_fruit?
+      end
+      assert_equal true, a.guarding_the_fruit?
+    end
+    assert_equal nil, a.guarding_the_fruit?
+  end
+
+  def test_guard_method_with_simple_blockless_toggles
+    a = A.new
+    assert_equal nil, a.guarding_the_fruit?
+    a.guard_the_fruit!
+    assert_equal true, a.guarding_the_fruit?
+
+    a.stop_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!
+        assert_equal false, a.guarding_the_fruit?
+        a.guard_the_fruit!
+        assert_equal true, a.guarding_the_fruit?
+      end
+      assert_equal false, a.guarding_the_fruit?
+    end
+
+    assert_equal true, a.guarding_the_fruit?
+  end
+
+  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' }
+  end
+end
+
+#---------------------------------------------------------------------------------------------------------------------------------
+# Begin duplication
+# The following TestCases are simply duplicates of the previous except that they test mguard_method rather than guard_method
+# The main differenes/substitutions:
+# * @@guarding_the_fruit, rather than @guarding_the_fruit
+# * :'<,'>s/A.new/B/g
+# * :'<,'>s/\<a\>/B/g
+
+class MGuardMethodTest_Simple < Test::Unit::TestCase
   class B
     mguard_method :guard_the_fruit!, :@@guarding_the_fruit
   end
@@ -114,7 +249,61 @@ class MGuardMethodTest < Test::Unit::TestCase
   def test_return_value
     assert_equal 'special return value', B.guard_the_fruit! { 'special return value' }
   end
+end
+
+class MGuardMethodTest_WithUnguard < Test::Unit::TestCase
+  class B
+    mguard_method :guard_the_fruit!, :@@guarding_the_fruit, :stop_guarding_the_fruit!
+  end
+  def test_guard_method
+    assert_equal nil, B.guarding_the_fruit?
+    B.guard_the_fruit! do
+      B.guard_the_fruit! do
+        assert_equal true, B.guarding_the_fruit?
 
+        B.stop_guarding_the_fruit! do
+          assert_equal false, B.guarding_the_fruit?
+          B.guard_the_fruit! do
+            assert_equal true, B.guarding_the_fruit?
+          end
+          assert_equal false, B.guarding_the_fruit?
+        end
+
+        assert_equal true, B.guarding_the_fruit?
+      end
+      assert_equal true, B.guarding_the_fruit?
+    end
+    assert_equal nil, B.guarding_the_fruit?
+  end
+
+  def test_guard_method_with_simple_blockless_toggles
+    assert_equal nil, B.guarding_the_fruit?
+    B.guard_the_fruit!
+    assert_equal true, B.guarding_the_fruit?
+
+    B.stop_guarding_the_fruit! 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!
+        assert_equal false, B.guarding_the_fruit?
+        B.guard_the_fruit!
+        assert_equal true, B.guarding_the_fruit?
+      end
+      assert_equal false, B.guarding_the_fruit?
+    end
+
+    assert_equal true, B.guarding_the_fruit?
+  end
+
+  def test_return_value
+    assert_equal nil, B.guard_the_fruit!
+    assert_equal nil, B.stop_guarding_the_fruit!
+    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' }
+  end
 end
+# End duplication
+#---------------------------------------------------------------------------------------------------------------------------------
 =end
 

data/lib/qualitysmith_extensions/module.bak/alias_method.rb

@@ -0,0 +1,6 @@
+# Idea:
+#   Allow using hashes:
+#     alias_method :code_review => :view_commits 
+#     instead of 
+#     alias_method :code_review, :view_commits
+#   because I always forget which argument becomes the argument for which

data/lib/qualitysmith_extensions/module.bak/attribute_accessors.rb

@@ -0,0 +1,46 @@
+# Copied from ActiveSupport because I couldn't get the ones in Facets to work...
+
+# Extends the module object with module and instance accessors for class attributes, 
+# just like the native attr* accessors for instance attributes.
+class Module # :nodoc:
+  def mattr_reader(*syms)
+    syms.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__+1)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+        
+        def self.#{sym}
+          @@#{sym}
+        end
+
+        def #{sym}
+          @@#{sym}
+        end
+      EOS
+    end
+  end
+  
+  def mattr_writer(*syms)
+    syms.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__+1)
+        unless defined? @@#{sym}
+          @@#{sym} = nil
+        end
+        
+        def self.#{sym}=(obj)
+          @@#{sym} = obj
+        end
+
+        def #{sym}=(obj)
+          @@#{sym} = obj
+        end
+      EOS
+    end
+  end
+  
+  def mattr_accessor(*syms)
+    mattr_reader(*syms)
+    mattr_writer(*syms)
+  end
+end

data/lib/qualitysmith_extensions/module.bak/bool_attr_accessor.rb

@@ -0,0 +1,334 @@
+#--
+# 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.)
+#++
+
+
+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.
+  #
+  #   bool_attr_accessor :a
+  #
+  # is equivalent to
+  #
+  #   def a?
+  #     @a ? true : @a
+  #   end
+  #
+  #   def a!(switch=Exception)
+  #     if switch == Exception
+  #       @a = !@a
+  #     else
+  #       @a = switch ? true : false
+  #       self
+  #     end
+  #   end
+  #
+  # 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_accessor(*args)
+
+    make = {}
+    args.each { |a|
+      make["#{a}?".to_sym] = %{
+        def #{a}?(true_value=true)
+          @#{a} ? true_value : @#{a}
+        end
+      }
+      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
+
+end
+
+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.
+  #
+  #   bool_attr_accessor :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 : false
+  #       self
+  #     end
+  #   end
+  #
+  # Works for both classes and modules.
+  #
+  def mbool_attr_accessor(*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 : false
+            self
+          end
+        end
+      }
+    }
+    module_eval make.values.join("\n"), __FILE__, __LINE__
+
+    make.keys
+  end
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+require 'rubygems'
+require 'qualitysmith_extensions/object/ignore_access'
+require 'set'
+
+# Test that it works for *instances*
+class TestBoolAttr < Test::Unit::TestCase
+  def setup
+    @x = C.new
+  end
+
+  class C
+    bool_attr_accessor :a
+  end
+
+  class C_for_default_is_nil
+    bool_attr_accessor :a
+  end
+
+  def test1_default_is_nil
+    assert_equal nil, C_for_default_is_nil.new.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
+

data/lib/qualitysmith_extensions/module.bak/create_setter.rb

@@ -0,0 +1,9 @@
+#create_setter/constructor :_F, :filename
+#create_setter/constructor :initialize, :filename do
+#  extra constructor stuff
+#end
+#
+#      def _F(filename)
+#        @filename = filename
+#      end
+#