aquarium 0.4.2 → 0.4.3

data/CHANGES

@@ -1,3 +1,30 @@
+== Version 0.4.3
+
+V0.4.3 adds a few bug fixes and enhancements, and several internal refactorings to improve 
+performance, etc.
+
+Bug fixes:
+[none]
+
+Enhancements:
+14165	Support Ruby 1.8.2, 1.8.5, 1.8.6, 1.9.X and 2.0 releases and snapshots
+21283	Allow "_of" suffix at end of "*_and_descendents", "*_and_ancestors", and "*_nested_types"
+21924	Should be able to turn off contract-testing aspects globally in the Design by Contract extra module
+21993	By default, don't advise "system" methods that being with "_", but provide an option to do so
+
+14165: I closed this one because it's too broad. Aquarium currently runs with 1.8.6. I will open a
+ new enhancement specifically for 1.9.
+21283: Sometimes appending "_of" makes the specification read more smoothly, so it's now an option.
+21924: To class-level methods in DesignByContract, enable_all and disable_all, globally turn contracts
+on or off. See their documentation for details.
+21993: Now, by default, MethodFinder won't match any method that starts with two underscores ("__"), so
+you don't have to :exclude_ancestors as much just to avoid matching methods like "__id__" and 
+"__send__". There is also a new :method_options called :include_system_methods that will not suppress
+matching these methods. So, I'm calling these special methods "system methods". I don't yet provide a
+way to configure this list (RSpec methods would be good additions...). The list is currently defined
+as an array of regex's, MethodFinder::IGNORED_SYSTEM_METHODS. NOTE: This is effectively a behavior
+change, although it's not likely to affect anyone.
+
 == Version 0.4.2
 
 V0.4.2 adds a few bug fixes and enhancements, greatly improved RDoc output, and internal 

data/Rakefile

@@ -65,7 +65,7 @@ desc 'Generate RDoc'
 rd = Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = '../doc/output/rdoc'
   rdoc.options << '--title' << 'Aquarium' << '--line-numbers' << '--inline-source' << '--main' << 'README'
-  rdoc.rdoc_files.include('README', 'CHANGES', 'MIT-LICENSE', 'examples/**/*.rb', 'UPGRADE', 'lib/**/*.rb') # 'EXAMPLES.rd'
+  rdoc.rdoc_files.include('README', 'CHANGES', 'MIT_LICENSE', 'examples/**/*.rb', 'UPGRADE', 'lib/**/*.rb') # 'EXAMPLES.rd'
 end
 
 # desc "Generate EXAMPLES.rb"

data/examples/introductions_example_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../spec/aquarium/spec_helper'
 require 'aquarium'
 
-# Example demonstrating how to use the TypeFinder class to convenient "introduce" new
+# Example demonstrating how to use the TypeFinder class to conveniently "introduce" new
 # methods and attributes in a set of types, like you might do with AspectJ in Java.
 # Of course, in Ruby, you can simply use Object#extend(module). However, if you want to
 # do this in a cross-cutting way, TypeFinder. is convenient.

data/lib/aquarium.rb

@@ -1,4 +1,5 @@
 # Does not include 'aquarium/extras'. Users have to include it explicitly if they want it.
+$LOAD_PATH <<  File.expand_path(File.dirname(__FILE__) + '/..')
 require 'aquarium/utils'
 require 'aquarium/extensions'
 require 'aquarium/finders'

data/lib/aquarium/extras/design_by_contract.rb

@@ -9,6 +9,9 @@ module Aquarium
     # a block passes. Note that it doesn't attempt to handle the correct behavior under contract 
     # inheritance. A usage example is included in the Examples as part of the distribution and it is also
     # shown on the web site.
+    # Normally, you want to disable the contracts in production runs, so you avoid the overhead. To do this
+    # effectively, call DesignByContract.disable_all before any contracts are created. That will prevent
+    # all of the aspects from being created along with their overhead.
     # *Warning*: This module automatically includes Aquarium::DSL into the class with 
     # the contract and it adds the :precondition, :postcondition, and the :invariant methods to Object! 
     module DesignByContract
@@ -20,17 +23,34 @@ module Aquarium
         end
       end
       
+      @@enabled = true
+
+      # Enable creation and execution of contracts
+      def self.enable_all
+        @@enabled = true
+      end
+      
+      # Disable creation of any subsequent contracts and disable execution of
+      # existing contracts. That is, while contracts are disabled, it no existing
+      # contracts will be executed and any attempts to define new contracts will be ignored.
+      def self.disable_all
+        @@enabled = false
+      end
+      
       def precondition *args, &contract_block
+        return unless @@enabled
         message = handle_message_arg args
         add_advice :before, "precondition", message, *args, &contract_block
       end
 
       def postcondition *args, &contract_block
+        return unless @@enabled
         message = handle_message_arg args
         add_advice :after_returning, "postcondition", message, *args, &contract_block
       end
 
       def invariant *args, &contract_block
+        return unless @@enabled
         message = handle_message_arg args
         Aspect.new make_args(:around, *args) do |jp, obj, *params|
           DesignByContract.test_condition "invariant failure (before invocation): #{message}", jp, obj, *params, &contract_block
@@ -43,7 +63,7 @@ module Aquarium
       private
 
       def self.test_condition message, jp, obj, *args
-        unless yield(jp, obj, *args)
+        if @@enabled and yield(jp, obj, *args) == false
           raise ContractError.new(message)
         end
       end

data/lib/aquarium/finders/method_finder.rb

@@ -1,10 +1,10 @@
 require 'set'
-require File.dirname(__FILE__) + '/../utils/array_utils'
-require File.dirname(__FILE__) + '/../utils/invalid_options'
-require File.dirname(__FILE__) + '/../utils/set_utils'
-require File.dirname(__FILE__) + '/../utils/type_utils'
-require File.dirname(__FILE__) + '/../utils/options_utils'
-require File.dirname(__FILE__) + '/finder_result'
+require 'aquarium/utils/array_utils'
+require 'aquarium/utils/set_utils'
+require 'aquarium/utils/type_utils'
+require 'aquarium/utils/options_utils'
+require 'aquarium/utils/invalid_options'
+require 'aquarium/finders/finder_result'
 
 # Find methods and types and objects.
 module Aquarium
@@ -74,6 +74,7 @@ module Aquarium
       # <tt>:instance</tt> or <tt>:instance_methods</tt>::   Search for instance methods.
       # <tt>:class</tt> or <tt>:class_methods</tt>::         Search for class methods.
       # <tt>:singleton</tt> or <tt>:singleton_methods</tt>:: Search for singleton methods. 
+      # <tt>:include_system_methods</tt>:: Also search for "system" methods like __id__ that are normally ignored (See IGNORED_SYSTEM_MEHTODS). 
       # 
       # Note: specifying <tt>:class</tt> when objects are specified won't work. 
       # Also, <tt>:class</tt>, <tt>:public</tt>, <tt>:protected</tt>, and <tt>:private</tt>
@@ -139,9 +140,14 @@ module Aquarium
         "instance"  => %w[instance_methods],
         "class"     => %w[class_methods],
         "singleton" => %w[singleton_methods],
-        "exclude_ancestor_methods" => %w[exclude_ancestors exclude_ancestors_methods suppress_ancestors suppress_ancestor_methods suppress_ancestors_methods]
+        "exclude_ancestor_methods" => %w[exclude_ancestors exclude_ancestors_methods suppress_ancestors suppress_ancestor_methods suppress_ancestors_methods],
+        "include_system_methods" => %w[include_all_system_methods]
       }
-        
+
+      # Methods we ignore by default, because users rarely want to advice them and so it makes
+      # finding what you want easier.
+      IGNORED_SYSTEM_METHODS = [/^__/]
+      
       def self.init_method_options scope_options_set
         return Set.new([]) if scope_options_set.nil?
         options = []
@@ -196,6 +202,8 @@ module Aquarium
             end
             found_methods += method_array
           end
+          filter_ignored_methods(found_methods) unless include_system_methods?
+          
           if found_methods.empty?
             types_and_objects_not_matched[type_or_object] = method_names_or_regexps
           else
@@ -205,6 +213,14 @@ module Aquarium
         Aquarium::Finders::FinderResult.new types_and_objects_to_matched_methods.merge(:not_matched => types_and_objects_not_matched)
       end
   
+      def filter_ignored_methods found_methods
+        IGNORED_SYSTEM_METHODS.each do |ism|
+          found_methods.reject! do |m| 
+            m.match(ism)
+          end
+        end
+      end
+
       def finish_specification_initialization
         @specification[:method_options] = MethodFinder.init_method_options(@specification[:method_options]) if @specification[:method_options]
         extra_validation
@@ -318,6 +334,10 @@ module Aquarium
         end
       end
   
+      def include_system_methods?
+        @specification[:method_options].include?(:include_system_methods)
+      end
+      
       def extra_validation 
         method_options = @specification[:method_options]
         return if method_options.nil?

data/lib/aquarium/finders/type_finder.rb

@@ -1,11 +1,11 @@
 require 'set'
-require File.dirname(__FILE__) + '/../utils/array_utils'
-require File.dirname(__FILE__) + '/../utils/type_utils'
-require File.dirname(__FILE__) + '/../utils/invalid_options'
-require File.dirname(__FILE__) + '/../extensions/hash'
-require File.dirname(__FILE__) + '/../extensions/regexp'
-require File.dirname(__FILE__) + '/../extensions/symbol'
-require File.dirname(__FILE__) + '/finder_result'
+require 'aquarium/utils/array_utils'
+require 'aquarium/utils/type_utils'
+require 'aquarium/utils/invalid_options'
+require 'aquarium/extensions/hash'
+require 'aquarium/extensions/regexp'
+require 'aquarium/extensions/symbol'
+require 'aquarium/finders/finder_result'
 
 # Finds types known to the runtime environment.
 module Aquarium
@@ -26,10 +26,12 @@ module Aquarium
       
       def self.add_ancestors_descendents_and_nested_option_variants_for option, options_hash
         all_variants = options_hash[option].dup
-        options_hash["#{option}_and_descendents"] = all_variants.map {|x| "#{x}_and_descendents"}
-        options_hash["#{option}_and_ancestors"]   = all_variants.map {|x| "#{x}_and_ancestors"}
-        options_hash["#{option}_and_nested_types"] = 
-          all_variants.map {|x| "#{x}_and_nested_types"} + all_variants.map {|x| "#{x}_and_nested"}
+        %w[descendents ancestors nested_types].each do |suffix|
+          options_hash["#{option}_and_#{suffix}"] = all_variants.inject([]) do |memo, x|
+            memo << "#{x}_and_#{suffix}" << "#{x}_and_#{suffix}_of"
+          end
+        end
+        options_hash["#{option}_and_nested_types"] += all_variants.map {|x| "#{x}_and_nested"}
       end
       
       TYPE_FINDER_CANONICAL_OPTIONS = {
@@ -73,6 +75,7 @@ module Aquarium
       # * <tt>:names_and_descendents => types_and_type_names_and_regexps</tt>
       # * <tt>:type_and_descendents  => types_and_type_names_and_regexps</tt>
       # * <tt>:name_and_descendents  => types_and_type_names_and_regexps</tt>
+      # You can also append the suffix "_of" on any of these keys.
       #
       # ==== Types and Ancestors
       # A single type, type name, name regular expression, or an array of the same. (Mixed allowed.)
@@ -81,6 +84,7 @@ module Aquarium
       # * <tt>:names_and_ancestors => types_and_type_names_and_regexps</tt>
       # * <tt>:type_and_ancestors  => types_and_type_names_and_regexps</tt>
       # * <tt>:name_and_ancestors  => types_and_type_names_and_regexps</tt>
+      # You can also append the suffix "_of" on any of these keys.
       #
       # ==== Types and Nested Types
       # A single type, type name, name regular expression, or an array of the same. (Mixed allowed.)
@@ -93,6 +97,7 @@ module Aquarium
       # * <tt>:names_and_nested => types_and_type_names_and_regexps</tt>
       # * <tt>:type_and_nested  => types_and_type_names_and_regexps</tt>
       # * <tt>:name_and_nested  => types_and_type_names_and_regexps</tt>
+      # You can also append the suffix "_of" on any of the "*_types" keys.
       #
       # Note: This option will also match <tt>Class</tt>, <tt>Module</tt>, <i>etc.</>, 
       # so use with caution!
@@ -123,6 +128,8 @@ module Aquarium
       # * <tt>:exclude_names_and_nested => types_and_type_names_and_regexps</tt>
       # * <tt>:exclude_type_and_nested  => types_and_type_names_and_regexps</tt>
       # * <tt>:exclude_name_and_nested  => types_and_type_names_and_regexps</tt>
+      # You can also append the suffix "_of" on any of the "*_descendents", "*_ancestors",
+      # and "*_types" keys.
       #
       # ==== Namespaces (Modules) and Regular Expressions
       # Because of the special sigificance of the module ("namespace") separator "::", 

data/lib/aquarium/version.rb

@@ -9,7 +9,7 @@ module Aquarium
     unless defined? MAJOR
       MAJOR  = 0
       MINOR  = 4
-      TINY   = 2
+      TINY   = 3
       RELEASE_CANDIDATE = nil
       
       # RANDOM_TOKEN: 0.598704893979657

data/spec/aquarium/aspects/advice_chain_node_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium'
 
 include Aquarium::Aspects::Advice

data/spec/aquarium/aspects/advice_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/aspects/advice'
 require 'aquarium/aspects/aspect'
 include Aquarium::Aspects

data/spec/aquarium/aspects/aspect_invocation_spec.rb

@@ -1,10 +1,10 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
-require File.dirname(__FILE__) + '/../utils/type_utils_sample_nested_types'
+require 'aquarium/spec_example_types'
+require 'aquarium/utils/type_utils_sample_nested_types'
 require 'aquarium/aspects/aspect'
 require 'aquarium/dsl'
 require 'aquarium/utils/array_utils'
-require File.dirname(__FILE__) + '/../finders/pointcut_finder_spec_test_classes'
+require 'aquarium/finders/pointcut_finder_spec_test_classes'
 
 require 'profiler'
 

data/spec/aquarium/aspects/aspect_spec.rb

@@ -1,6 +1,5 @@
-
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/aspects'
 require 'logger'
 

data/spec/aquarium/aspects/aspect_with_nested_types_spec.rb

@@ -1,6 +1,6 @@
 
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/aspects'
 
 include Aquarium::Aspects

data/spec/aquarium/aspects/aspect_with_subtypes_spec.rb

@@ -1,6 +1,6 @@
 
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/aspects'
 
 include Aquarium::Aspects

data/spec/aquarium/aspects/concurrent_aspects_spec.rb

@@ -1,8 +1,8 @@
 # Specifically tests behavior when two or more advices apply to the same join point(s).
 
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
-require File.dirname(__FILE__) + '/concurrently_accessed'
+require 'aquarium/spec_example_types'
+require 'aquarium/aspects/concurrently_accessed'
 require 'aquarium/aspects'
 
 include Aquarium::Aspects

data/spec/aquarium/aspects/concurrent_aspects_with_objects_and_types_spec.rb

@@ -2,8 +2,8 @@
 # where one advice is for the type and the other is for an object of the type.
 
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
-require File.dirname(__FILE__) + '/concurrently_accessed'
+require 'aquarium/spec_example_types'
+require 'aquarium/aspects/concurrently_accessed'
 require 'aquarium/aspects'
 
 include Aquarium::Aspects

data/spec/aquarium/aspects/join_point_spec.rb

@@ -1,6 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
-
+require 'aquarium/spec_example_types'
 require 'aquarium/extensions/hash'
 require 'aquarium/utils/nil_object'
 require 'aquarium/aspects/join_point'

data/spec/aquarium/aspects/pointcut_and_composition_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/utils'
 require 'aquarium/extensions'
 require 'aquarium/aspects/pointcut'

data/spec/aquarium/aspects/pointcut_or_composition_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/utils'
 require 'aquarium/extensions'
 require 'aquarium/aspects/pointcut'

data/spec/aquarium/aspects/pointcut_spec.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
-require File.dirname(__FILE__) + '/../utils/type_utils_sample_nested_types'
+require 'aquarium/spec_example_types'
+require 'aquarium/utils/type_utils_sample_nested_types'
 require 'aquarium/utils/invalid_options'
 require 'aquarium/extensions/hash'
 require 'aquarium/aspects/join_point'

data/spec/aquarium/dsl/aspect_dsl_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/dsl/aspect_dsl'
 
 class DSLClass

data/spec/aquarium/extensions/hash_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/extensions/hash'
 require 'aquarium/utils/array_utils'
 require 'aquarium/utils/hash_utils'

data/spec/aquarium/extensions/set_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/extensions/set'
 
 class Foo

data/spec/aquarium/extras/design_by_contract_spec.rb

@@ -75,3 +75,29 @@ describe Aquarium::Extras::DesignByContract, "invariant" do
     InvarCond.new.good_action.should == "good"
   end
 end
+
+describe Aquarium::Extras::DesignByContract, "global enable/disable option" do
+  class ContractEnablement
+    include Aquarium::Extras::DesignByContract   
+    def action *args
+    end
+    
+    precondition :method => :action, :message => "Must pass more than one argument." do |jp, obj, *args|
+      args.size > 0
+    end
+  end
+  
+  it "should disable creation of the contract aspects when the contracts are disabled" do
+    begin
+      Aquarium::Extras::DesignByContract.disable_all
+      lambda { ContractEnablement.new.action }.should_not raise_error(Aquarium::Extras::DesignByContract::ContractError)
+    ensure
+      Aquarium::Extras::DesignByContract.enable_all
+    end
+  end
+  
+  it "should enable creation of the contract aspects when the contracts are enabled" do
+    Aquarium::Extras::DesignByContract.enable_all
+    lambda { ContractEnablement.new.action }.should raise_error(Aquarium::Extras::DesignByContract::ContractError)
+  end
+end

data/spec/aquarium/finders/finder_result_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 
 require 'aquarium/finders/finder_result'
 require 'aquarium/extensions/set'

data/spec/aquarium/finders/method_finder_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/finders/method_finder'
 
 # :stopdoc:
@@ -327,6 +327,8 @@ end
 describe Aquarium::Finders::MethodFinder, "#find (searching for class methods)" do
   before(:each) do
     before_method_finder_spec
+    @expected_ClassWithPUblicClassMethod = Set.new(ClassWithPublicClassMethod.public_methods.reject{|m| m =~ /^__/}.sort.map{|m| m.intern})
+    @expected_ClassWithPrivateClassMethod = Set.new(ClassWithPrivateClassMethod.public_methods.reject{|m| m =~ /^__/}.sort.map{|m| m.intern})
   end
   
   it "should find all class methods specified by regular expression for types when :class is used." do
@@ -344,20 +346,36 @@ describe Aquarium::Finders::MethodFinder, "#find (searching for class methods)"
     end
   end
   
+  it "should ignore any methods that start with double underscores '__' by default when searching with the :all method specification and the :class option." do
+    actual = Aquarium::Finders::MethodFinder.new.find :types => [ClassWithPublicClassMethod, ClassWithPrivateClassMethod], :methods => :all, :method_options => :class
+    actual.matched.size.should == 2
+    actual.not_matched.size.should == 0
+    actual.matched[ClassWithPublicClassMethod].should == @expected_ClassWithPUblicClassMethod
+    actual.matched[ClassWithPrivateClassMethod].should == @expected_ClassWithPrivateClassMethod 
+  end
+  
+  it "should find any methods that start with double underscores '__' with the :include_system_methods option." do
+    class WithUnderScores
+      def self.__foo__; end
+    end
+    actual = Aquarium::Finders::MethodFinder.new.find :types => [WithUnderScores], :methods => :all, :method_options => [:class, :include_system_methods]
+    actual.matched[WithUnderScores].include?(:__foo__).should be_true
+  end
+  
   it "should find all public class methods in types when searching with the :all method specification and the :class option." do
     actual = Aquarium::Finders::MethodFinder.new.find :types => [ClassWithPublicClassMethod, ClassWithPrivateClassMethod], :methods => :all, :method_options => :class
     actual.matched.size.should == 2
     actual.not_matched.size.should == 0
-    actual.matched[ClassWithPublicClassMethod].should == Set.new(ClassWithPublicClassMethod.public_methods.sort.map{|m| m.intern})
-    actual.matched[ClassWithPrivateClassMethod].should == Set.new(ClassWithPrivateClassMethod.public_methods.sort.map{|m| m.intern})
+    actual.matched[ClassWithPublicClassMethod].should == @expected_ClassWithPUblicClassMethod
+    actual.matched[ClassWithPrivateClassMethod].should == @expected_ClassWithPrivateClassMethod 
   end
   
   it "should accept :all_methods as a synonym for :all." do
     actual = Aquarium::Finders::MethodFinder.new.find :types => [ClassWithPublicClassMethod, ClassWithPrivateClassMethod], :methods => :all_methods, :method_options => :class
     actual.matched.size.should == 2
     actual.not_matched.size.should == 0
-    actual.matched[ClassWithPublicClassMethod].should == Set.new(ClassWithPublicClassMethod.public_methods.sort.map{|m| m.intern})
-    actual.matched[ClassWithPrivateClassMethod].should == Set.new(ClassWithPrivateClassMethod.public_methods.sort.map{|m| m.intern})
+    actual.matched[ClassWithPublicClassMethod].should == @expected_ClassWithPUblicClassMethod
+    actual.matched[ClassWithPrivateClassMethod].should == @expected_ClassWithPrivateClassMethod 
   end
   
   it "should find all public class methods in types, but not ancestors, when searching with the :all method specification and the :class and :exclude_ancestor_methods options." do
@@ -400,8 +418,8 @@ describe Aquarium::Finders::MethodFinder, "#find (searching for class methods de
   it "should find all public class methods in types when searching with the :all method specification and the :class option." do
     actual = Aquarium::Finders::MethodFinder.new.find :type => [M, M2], :methods => :all, :method_options => [:class]
     actual.matched.size.should == 2
-    actual.matched[M].should  == Set.new(M.public_methods.sort.map{|m| m.intern})
-    actual.matched[M2].should == Set.new(M2.public_methods.sort.map{|m| m.intern})
+    actual.matched[M].should  == Set.new(M.public_methods.reject{|m| m =~ /^__/}.sort.map{|m| m.intern})
+    actual.matched[M2].should == Set.new(M2.public_methods.reject{|m| m =~ /^__/}.sort.map{|m| m.intern})
   end
   
   it "should not find any module-defined class methods in classes that include the modules." do
@@ -422,11 +440,27 @@ describe Aquarium::Finders::MethodFinder, "#find (searching for instance methods
     before_method_finder_spec
   end
   
+  it "should ignore any methods that start with double underscores '__' by default when searching with the :all method specification and the :class option." do
+    actual = Aquarium::Finders::MethodFinder.new.find :types => [ClassWithPublicInstanceMethod, ClassWithProtectedInstanceMethod, ClassWithPrivateInstanceMethod], :methods => :all
+    actual.matched.size.should == 3
+    [ClassWithPublicInstanceMethod, ClassWithProtectedInstanceMethod, ClassWithPrivateInstanceMethod].each do |c|
+      actual.matched[c].each {|m| m.to_s.match('^__').should be_nil}
+    end
+  end
+  
+  it "should find any methods that start with double underscores '__' with the :include_system_methods option." do
+    class WithUnderScores
+      def __foo__; end
+    end
+    actual = Aquarium::Finders::MethodFinder.new.find :types => [WithUnderScores], :methods => :all, :method_options => [:include_system_methods]
+    actual.matched[WithUnderScores].include?(:__foo__).should be_true
+  end
+  
   it "should find all public instance methods in classes when searching with the :all method specification." do
     actual = Aquarium::Finders::MethodFinder.new.find :types => [ClassWithPublicInstanceMethod, ClassWithProtectedInstanceMethod, ClassWithPrivateInstanceMethod], :methods => :all
     actual.matched.size.should == 3
     [ClassWithPublicInstanceMethod, ClassWithProtectedInstanceMethod, ClassWithPrivateInstanceMethod].each do |c|
-      actual.matched[c].should == Set.new(c.public_instance_methods.sort.map {|m| m.intern})
+      actual.matched[c].should == Set.new(c.public_instance_methods.reject{|m| m =~ /^__/}.sort.map {|m| m.intern})
     end
   end
   
@@ -444,7 +478,7 @@ describe Aquarium::Finders::MethodFinder, "#find (searching for instance methods
     actual = Aquarium::Finders::MethodFinder.new.find :objects => [pub, pro, pri], :methods => :all
     actual.matched.size.should == 3
     [pub, pro, pri].each do |c|
-      actual.matched[c].should == Set.new(c.public_methods.sort.map {|m| m.intern})
+      actual.matched[c].should == Set.new(c.public_methods.reject{|m| m =~ /^__/}.sort.map {|m| m.intern})
     end
   end
   
@@ -1078,6 +1112,28 @@ describe Aquarium::Finders::MethodFinder, "#find (using :method_options => [:pub
   end
 end
 
+describe Aquarium::Finders::MethodFinder, "#find (using :method_options => [:include_system_methods])" do
+  before(:each) do
+    before_method_finder_spec
+  end
+  
+  it "should find instance methods otherwise excluded by the MethodFinder::IGNORED_SYSTEM_METHODS list of regex's" do
+    class WithIgnored
+      def __foo__; end
+    end
+    actual = Aquarium::Finders::MethodFinder.new.find :class => WithIgnored, :methods => :all, :method_options => [:include_system_methods, :exclude_ancestor_methods]
+    actual.matched[WithIgnored].should include(:__foo__)    
+  end
+
+  it "should find class methods otherwise excluded by the MethodFinder::IGNORED_SYSTEM_METHODS list of regex's" do
+    class WithSelfIgnored
+      def self.__self_foo__; end
+    end
+    actual = Aquarium::Finders::MethodFinder.new.find :class => WithSelfIgnored, :methods => :all, :method_options => [:include_system_methods, :class, :exclude_ancestor_methods]
+    actual.matched[WithSelfIgnored].should include(:__self_foo__)        
+  end
+end
+
 describe "Aquarium::Finders::MethodFinder#find (looking for singleton methods)" do
   before(:each) do
     class Empty

data/spec/aquarium/finders/type_finder_with_descendents_and_ancestors_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../utils/type_utils_sample_classes'
+require 'aquarium/utils/type_utils_sample_classes'
 require 'aquarium/finders/type_finder'
 
 include Aquarium::Utils

data/spec/aquarium/finders/{type_finder_with_nested_types.rb → type_finder_with_nested_types_spec.rb}

@@ -1,11 +1,11 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../utils/type_utils_sample_classes'
-require File.dirname(__FILE__) + '/../utils/type_utils_sample_nested_types'
+require 'aquarium/utils/type_utils_sample_classes'
+require 'aquarium/utils/type_utils_sample_nested_types'
 require 'aquarium/finders/type_finder'
 
 include Aquarium::Utils
   
-def purge_actuals actuals
+def purge_uninteresting actuals
   # Remove extra stuff inserted by RSpec, Aquarium, and "pretty printer" (rake?), possibly in other specs! 
   actuals.matched_keys.reject do |t2| 
     t2.name.include?("Spec::") or t2.name =~ /Aquarium::(Utils|Extras|Examples|Aspects|PointcutFinderTestClasses)/ or t2.name =~ /^PP/
@@ -16,7 +16,7 @@ describe TypeUtils, "#find types and their nested types, using :types_and_nested
   it "should find the matching types and their nested types." do
     Aquarium::NestedTestTypes.nested_in_NestedTestTypes.keys.each do |t|
       actual = Aquarium::Finders::TypeFinder.new.find :types_and_nested_types => (t.name)
-      actual_keys = purge_actuals actual
+      actual_keys = purge_uninteresting actual
       actual_keys.sort{|x,y| x.name <=> y.name}.should == Aquarium::NestedTestTypes.nested_in_NestedTestTypes[t].sort{|x,y| x.name <=> y.name}
       actual.not_matched_keys.should == []
     end
@@ -34,7 +34,7 @@ describe TypeUtils, "#find nested types subtracting out excluded types and desce
     actual = Aquarium::Finders::TypeFinder.new.find :types_and_nested_types => Aquarium::NestedTestTypes, 
       :exclude_types_and_nested_types => Aquarium::NestedTestTypes::TopModule
     expected = [Aquarium::NestedTestTypes] + Aquarium::NestedTestTypes.nested_in_NestedTestTypes[Aquarium::NestedTestTypes::TopClass]
-    actual_keys = purge_actuals actual
+    actual_keys = purge_uninteresting actual
     actual_keys.sort{|x,y| x.name <=> y.name}.should == expected.sort{|x,y| x.name <=> y.name}
     actual.not_matched_keys.should == []
   end

data/spec/aquarium/spec_helper.rb

@@ -1,3 +1,4 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../../lib')
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/..')
 require 'rubygems'
 require 'spec'

data/spec/aquarium/utils/hash_utils_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/utils/hash_utils'
 
 describe Aquarium::Utils::HashUtils, "#make_hash" do

data/spec/aquarium/utils/logic_error_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/utils/logic_error'
 
 # This doesn't do much..., except make rcov happy, since this exception is essentially for catching bugs.

data/spec/aquarium/utils/name_utils_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/utils/name_utils'
 
 describe Aquarium::Utils::NameUtils, ".make_valid_attr_name_from_method_name" do

data/spec/aquarium/utils/nil_object_spec.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/utils/nil_object'
 
 describe Aquarium::Utils::NilObject, "#eql?" do

data/spec/aquarium/utils/set_utils_spec.rb

@@ -1,9 +1,10 @@
 require File.dirname(__FILE__) + '/../spec_helper'
-require File.dirname(__FILE__) + '/../spec_example_types'
+require 'aquarium/spec_example_types'
 require 'aquarium/utils/set_utils'
 
 describe Aquarium::Utils::SetUtils, "make_set" do
-  
+  include Aquarium::Utils::SetUtils
+
   before :each do
     @empty_set = Set.new
   end
@@ -60,6 +61,8 @@ describe Aquarium::Utils::SetUtils, "make_set" do
 end
 
 describe Aquarium::Utils::SetUtils, "strip_set_nils" do
+  include Aquarium::Utils::SetUtils
+
   it "should return an empty set if an empty set is specified" do
     strip_set_nils(Set.new([])).should == Set.new([])
   end

data/spec/aquarium/utils/type_utils_spec.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/../spec_helper'
 require 'aquarium/utils/type_utils'
-require File.dirname(__FILE__) + '/../utils/type_utils_sample_classes'
-require File.dirname(__FILE__) + '/../utils/type_utils_sample_nested_types'
+require 'aquarium/utils/type_utils_sample_classes'
+require 'aquarium/utils/type_utils_sample_nested_types'
 
 include Aquarium::Utils
 
@@ -40,8 +40,8 @@ describe TypeUtils, ".descendents called with a class" do
     TypeUtils.descendents(Aquarium::ForDescendents::NestedD31ForDescendents).should  eql([Aquarium::ForDescendents::NestedD31ForDescendents])
   end
 
-  it "should return all classes and their descendents that derive from a class" do
-    TypeUtils.sample_classes.each do |t|
+  TypeUtils.sample_classes.each do |t|
+    it "should return all classes and their descendents that derive from #{t}" do
       check_descendent_array t, TypeUtils.sample_classes_descendents[t]
     end 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aquarium
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors: 
 - Aquarium Development Team
@@ -9,7 +9,7 @@ autorequire: aquarium
 bindir: bin
 cert_chain: []
 
-date: 2008-05-25 00:00:00 -05:00
+date: 2008-10-26 00:00:00 -05:00
 default_executable: ""
 dependencies: []
 
@@ -22,7 +22,7 @@ extensions: []
 extra_rdoc_files: 
 - README
 - CHANGES
-- MIT-LICENSE
+- MIT_LICENSE
 - UPGRADE
 files: 
 - Aquarium-IDEA.ipr
@@ -31,7 +31,7 @@ files:
 - Aquarium.iws
 - CHANGES
 - EXAMPLES.rd
-- MIT-LICENSE
+- MIT_LICENSE
 - ParseTreePlay.rb
 - Rakefile
 - README
@@ -104,7 +104,7 @@ files:
 - spec/aquarium/finders/pointcut_finder_spec_test_classes.rb
 - spec/aquarium/finders/type_finder_spec.rb
 - spec/aquarium/finders/type_finder_with_descendents_and_ancestors_spec.rb
-- spec/aquarium/finders/type_finder_with_nested_types.rb
+- spec/aquarium/finders/type_finder_with_nested_types_spec.rb
 - spec/aquarium/spec_example_types.rb
 - spec/aquarium/spec_helper.rb
 - spec/aquarium/utils/array_utils_spec.rb
@@ -165,9 +165,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: aquarium
-rubygems_version: 1.0.1
+rubygems_version: 1.3.0
 signing_key: 
 specification_version: 2
-summary: Aquarium-0.4.2 (r7) - Aspect-Oriented Programming toolkit for Ruby http://aquarium.rubyforge.org
+summary: Aquarium-0.4.3 (r7) - Aspect-Oriented Programming toolkit for Ruby http://aquarium.rubyforge.org
 test_files: []