aquarium 0.1.8 → 0.2.0

data/spec/aquarium/finders/type_finder_with_descendents_and_ancestors_spec.rb

@@ -0,0 +1,206 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require File.dirname(__FILE__) + '/../utils/type_utils_sample_classes'
+require 'aquarium/finders/type_finder'
+
+# TODO Mock out type_utils to speed it up!
+  
+def purge_actuals actuals
+  # Remove extra stuff inserted by RSpec, Aquarium, and "pretty printer" (rake?), possibly in other specs! (TODO undo those when finished...)
+  actuals.matched_keys.reject do |t2| 
+    t2.name.include?("Spec::") or t2.name =~ /Aquarium::(Utils|Extras|Examples|Aspects)/  or t2.name =~ /^PP/
+  end
+end
+
+variant = ''
+describe "#find with types, including descendents", :shared => true do
+  it "should find the matching types and their descendent subclasses, even in different nested modules." do
+    option = "#{variant}_and_descendents".intern
+    Aquarium::Utils::TypeUtils.sample_types.each do |t|
+      actual = Aquarium::Finders::TypeFinder.new.find option => (t.name)
+      actual_keys = purge_actuals actual
+      actual_keys.sort{|x,y| x.name <=> y.name}.should == Aquarium::Utils::TypeUtils.sample_types_descendents[t].sort{|x,y| x.name <=> y.name}
+      actual.not_matched_keys.should == []
+    end
+  end
+end
+
+%w[type types name names].each do |n|
+  instance_eval <<-EOF
+    describe Aquarium::Finders::TypeFinder, "#find with :#{n}_and_descendents used to specify one or more names" do
+      variant = "#{n}"
+      it_should_behave_like "#find with types, including descendents"
+    end
+  EOF
+end
+
+describe "#find with excluded types, including descendents", :shared => true do
+  it "should find the matching types and their descendent subclasses, minus the excluded type hierarchies." do
+    option = "#{variant}_and_descendents".intern
+    exclude_option = "exclude_#{variant}_and_descendents".intern
+    actual = Aquarium::Finders::TypeFinder.new.find option => ModuleForDescendents, exclude_option => D1ForDescendents
+    actual_keys = purge_actuals actual
+    expected = Aquarium::Utils::TypeUtils.sample_types_descendents[ModuleForDescendents].reject do |c|
+      Aquarium::Utils::TypeUtils.sample_types_descendents[D1ForDescendents].include? c
+    end
+    actual.not_matched_keys.should == []
+  end
+end
+
+%w[type types name names].each do |n|
+  instance_eval <<-EOF
+    describe Aquarium::Finders::TypeFinder, "#find with :exclude_#{n}_and_descendents used to specify one or more names" do
+      variant = "#{n}"
+      it_should_behave_like "#find with excluded types, including descendents"
+    end
+  EOF
+end
+
+
+describe "#find with types, including ancestors", :shared => true do
+  it "should find the matching types and their ancestors, even in different nested modules." do
+    option = "#{variant}_and_ancestors".intern
+    Aquarium::Utils::TypeUtils.sample_types.each do |t|
+      actual = Aquarium::Finders::TypeFinder.new.find option => (t.name)
+      actual_keys = purge_actuals actual
+      actual_keys.sort{|x,y| x.name <=> y.name}.should == Aquarium::Utils::TypeUtils.sample_types_ancestors[t].sort{|x,y| x.name <=> y.name}
+      actual.not_matched_keys.should == []
+    end
+  end
+end
+
+%w[type types name names].each do |n|
+  instance_eval <<-EOF
+    describe Aquarium::Finders::TypeFinder, "#find with :#{n}_and_ancestors used to specify one or more names" do
+      variant = "#{n}"
+      it_should_behave_like "#find with types, including ancestors"
+    end
+  EOF
+end
+
+
+describe "#find with excluded types, including ancestors", :shared => true do
+  it "should find the matching types and their ancestors, minus the excluded types and ancestors." do
+    option = "#{variant}_and_ancestors".intern
+    exclude_option = "exclude_#{variant}_and_ancestors".intern
+    actual = Aquarium::Finders::TypeFinder.new.find option => D1ForDescendents, exclude_option => ModuleForDescendents
+    actual_keys = purge_actuals actual
+    expected = Aquarium::Utils::TypeUtils.sample_types_ancestors[D1ForDescendents].reject do |c|
+      Aquarium::Utils::TypeUtils.sample_types_ancestors[ModuleForDescendents].include? c
+    end
+    actual.not_matched_keys.should == []
+  end
+end
+
+%w[type types name names].each do |n|
+  instance_eval <<-EOF
+    describe Aquarium::Finders::TypeFinder, "#find with :exclude_#{n}_and_ancestors used to specify one or more names" do
+      variant = "#{n}"
+      it_should_behave_like "#find with excluded types, including ancestors"
+    end
+  EOF
+end
+
+
+describe "#find with types, including descendents and ancestors", :shared => true do
+  it "should find the matching types, including their descendents and ancestors, even in different nested modules." do
+    doption = "#{variant}_and_descendents".intern
+    aoption = "#{variant}_and_ancestors".intern
+    Aquarium::Utils::TypeUtils.sample_types.each do |t|
+      actual = Aquarium::Finders::TypeFinder.new.find aoption => (t.name), doption => (t.name)
+      actual_keys = purge_actuals actual
+      expected = Aquarium::Utils::TypeUtils.sample_types_ancestors[t] + Aquarium::Utils::TypeUtils.sample_types_descendents[t]
+      actual_keys.sort{|x,y| x.name <=> y.name}.should == expected.sort{|x,y| x.name <=> y.name}.uniq
+      actual.not_matched_keys.should == []
+    end
+  end
+end
+
+%w[type types name names].each do |n|
+  instance_eval <<-EOF
+    describe Aquarium::Finders::TypeFinder, "#find with :#{n}_and_ancestors and :#{n}_and_descendents used to specify one or more names" do
+      variant = "#{n}"
+      it_should_behave_like "#find with types, including descendents and ancestors"
+    end
+  EOF
+end
+
+describe "#find with excluded types, including descendents and ancestors", :shared => true do
+  it "should find the matching types, their descendents and ancestors, minus the excluded types, descendents and ancestors." do
+    doption = "#{variant}_and_descendents".intern
+    aoption = "#{variant}_and_ancestors".intern
+    exclude_doption = "exclude_#{variant}_and_descendents".intern
+    exclude_aoption = "exclude_#{variant}_and_ancestors".intern
+    actual = Aquarium::Finders::TypeFinder.new.find aoption => Aquarium::ForDescendents::NestedD1ForDescendents, 
+      doption => Aquarium::ForDescendents::NestedD1ForDescendents, 
+      exclude_aoption => Aquarium::ForDescendents::NestedD2ForDescendents, 
+      exclude_doption => Aquarium::ForDescendents::NestedD2ForDescendents
+    actual_keys = purge_actuals actual
+    expected = Aquarium::Utils::TypeUtils.sample_types_ancestors[D1ForDescendents].reject do |c|
+      Aquarium::Utils::TypeUtils.sample_types_ancestors[ModuleForDescendents].include? c
+    end
+    actual.not_matched_keys.should == []
+  end
+end
+
+%w[type types name names].each do |n|
+  instance_eval <<-EOF
+    describe Aquarium::Finders::TypeFinder, "#find with :exclude_#{n}_and_ancestors and :exclude_#{n}_and_descendents used to specify one or more names" do
+      variant = "#{n}"
+      it_should_behave_like "#find with excluded types, including descendents and ancestors"
+    end
+  EOF
+end
+
+
+describe "#find with regular expressions, including descendents and ancestors", :shared => true do
+  it "should find the matching types, including their descendents and ancestors, even in different nested modules." do
+    doption = "#{variant}_and_descendents".intern
+    aoption = "#{variant}_and_ancestors".intern
+    regexs = [/ForDescendents$/, /Aquarium::ForDescendents::.*ForDescendents/]
+    actual = Aquarium::Finders::TypeFinder.new.find aoption => regexs, doption => regexs
+    actual_keys = purge_actuals actual
+    expected = Aquarium::Utils::TypeUtils.sample_types_descendents_and_ancestors.keys + [Kernel, Object]
+    actual_keys.size.should == expected.size
+    expected.each do |t|
+      actual_keys.should include(t)
+    end
+    actual.not_matched_keys.should == []
+  end
+end
+
+%w[type types name names].each do |n|
+  instance_eval <<-EOF
+    describe Aquarium::Finders::TypeFinder, "#find regexps with :#{n}_and_ancestors and :#{n}_and_descendents used to specify one or more names" do
+      variant = "#{n}"
+      it_should_behave_like "#find with regular expressions, including descendents and ancestors"
+    end
+  EOF
+end
+
+
+describe "#find with excluded regular expressions, including descendents and ancestors", :shared => true do
+  it "should find the matching types, their descendents and ancestors, minus the excluded types, descendents and ancestors." do
+    doption = "#{variant}_and_descendents".intern
+    aoption = "#{variant}_and_ancestors".intern
+    exclude_doption = "exclude_#{variant}_and_descendents".intern
+    exclude_aoption = "exclude_#{variant}_and_ancestors".intern
+    actual = Aquarium::Finders::TypeFinder.new.find aoption => /Aquarium::ForDescendents::.*D1ForDescendents/, 
+      doption => /Aquarium::ForDescendents::.*D1ForDescendents/, 
+      exclude_aoption => /Aquarium::ForDescendents::.*D2ForDescendents/, 
+      exclude_doption => /Aquarium::ForDescendents::.*D2ForDescendents/
+    actual_keys = purge_actuals actual
+    expected = Aquarium::Utils::TypeUtils.sample_types_ancestors[D1ForDescendents].reject do |c|
+      Aquarium::Utils::TypeUtils.sample_types_ancestors[ModuleForDescendents].include? c
+    end
+    actual.not_matched_keys.should == []
+  end
+end
+
+%w[type types name names].each do |n|
+  instance_eval <<-EOF
+    describe Aquarium::Finders::TypeFinder, "#find regexps with :exclude_#{n}_and_ancestors and :exclude_#{n}_and_descendents used to specify one or more names" do
+      variant = "#{n}"
+      it_should_behave_like "#find with excluded regular expressions, including descendents and ancestors"
+    end
+  EOF
+end

data/spec/aquarium/spec_example_classes.rb

@@ -11,39 +11,87 @@ class ExampleParentClass
 end
 
 class ClassWithPublicInstanceMethod < ExampleParentClass
-  def public_instance_test_method
-  end
+  def public_instance_test_method; end
 end
 class ClassWithPublicInstanceMethod2 < ExampleParentClass
-  def public_instance_test_method2
-  end
+  def public_instance_test_method2; end
 end
 class ClassWithProtectedInstanceMethod < ExampleParentClass
   protected
-  def protected_instance_test_method
-  end
+  def protected_instance_test_method; end
 end
 class ClassWithPrivateInstanceMethod < ExampleParentClass
   private
-  def private_instance_test_method
-  end
+  def private_instance_test_method; end
 end
 
 class ClassWithPublicClassMethod < ExampleParentClass
-  def self.public_class_test_method
-  end
+  def self.public_class_test_method; end
 end
 class ClassWithPrivateClassMethod < ExampleParentClass
-  def self.private_class_test_method
-  end
+  def self.private_class_test_method; end
   private_class_method :private_class_test_method
 end
 
+module ModuleWithPublicInstanceMethod
+  def public_instance_module_test_method; end
+end
+module ModuleWithProtectedInstanceMethod
+  protected
+  def protected_instance_module_test_method; end
+end
+module ModuleWithPrivateInstanceMethod
+  private
+  def private_instance_module_test_method; end
+end
+
+module ModuleWithPublicClassMethod
+  def self.public_class_module_test_method; end
+end
+module ModuleWithPrivateClassMethod
+  def self.private_class_module_test_method; end
+  private_class_method :private_class_module_test_method
+end
+
+class ClassIncludingModuleWithPublicInstanceMethod
+  include ModuleWithPublicInstanceMethod
+  def public_instance_class_including_module_test_method; end
+end
+class ClassIncludingModuleWithProtectedInstanceMethod
+  include ModuleWithProtectedInstanceMethod
+  protected
+  def protected_instance_class_including_module_test_method; end
+end
+class ClassIncludingModuleWithPrivateInstanceMethod
+  include ModuleWithPrivateInstanceMethod
+  private
+  def private_instance_class_including_module_test_method; end
+end
+class ClassIncludingModuleWithPublicClassMethod
+  include ModuleWithPublicClassMethod
+  def self.public_class_class_including_module_test_method; end
+end
+class ClassIncludingModuleWithPrivateClassMethod
+  include ModuleWithPrivateClassMethod
+  def self.private_class_class_including_module_test_method; end
+  private_class_method :private_class_class_including_module_test_method
+end
+
+module ModuleIncludingModuleWithPublicInstanceMethod
+  include ModuleWithPublicInstanceMethod
+  def public_instance_module_including_module_test_method; end
+end
+class ClassDerivedFromClassIncludingModuleWithPublicInstanceMethod < ClassIncludingModuleWithPublicInstanceMethod
+  include ModuleIncludingModuleWithPublicInstanceMethod
+  def public_instance_class_derived_from_class_including_module_test_method; end
+end
+
 class ClassWithAttribs < ExampleParentClass
   attr_accessor :attrRW_ClassWithAttribs, :name
   attr_reader   :attrR_ClassWithAttribs
   attr_writer   :attrW_ClassWithAttribs
   def initialize
+    super
     @name = "Name"
   end
   def eql? other
@@ -57,6 +105,7 @@ class Watchful
   class WatchfulError < Exception
     def initialize message = nil
       super
+      @message = message
     end
   end
   
@@ -136,3 +185,17 @@ class ExcludeTestThree
   def method33; end
 end
 
+module TestableModule1
+  def module_method1; end
+  def module_method2; end
+end
+
+module TestableModule2
+  include TestableModule1
+  def module_method3; end
+end
+
+class TestableClassIncludingTestableModule1
+  include TestableModule1
+  def instance_method1; end
+end

data/spec/aquarium/utils/logic_error_spec.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+require File.dirname(__FILE__) + '/../spec_example_classes'
+require 'aquarium/utils/logic_error'
+
+# This doesn't do much..., except make rcov happy, since this exception is essentially for catching bugs.
+describe Aquarium::Utils::LogicError, ".new" do
+  it "should return an exception object" do
+    Aquarium::Utils::LogicError.new.kind_of?(Exception).should be_true 
+  end
+end

data/spec/aquarium/utils/type_utils_sample_classes.rb

@@ -0,0 +1,203 @@
+class BaseForDescendents; end
+module ModuleForDescendents; end
+class D1ForDescendents  < BaseForDescendents
+  include ModuleForDescendents
+end
+class D2ForDescendents  < BaseForDescendents; end
+class D11ForDescendents < D1ForDescendents; end
+
+module Aquarium
+  module ForDescendents
+    class NestedBaseForDescendents; end
+    module NestedModuleForDescendents; end
+    class NestedD1ForDescendents  < NestedBaseForDescendents
+      include NestedModuleForDescendents
+    end
+    class NestedD2ForDescendents  < NestedBaseForDescendents; end
+    class NestedD11ForDescendents < NestedD1ForDescendents; end
+    
+    class NestedD3ForDescendents < BaseForDescendents
+      include ModuleForDescendents
+    end
+    class NestedD4ForDescendents  < BaseForDescendents; end
+    class NestedD31ForDescendents < D1ForDescendents; end
+    
+    module Nested2ModuleForDescendents
+      include ModuleForDescendents
+    end
+  end
+end
+
+module Aquarium
+  module Utils
+    module TypeUtils
+      @@sample_modules = [
+        ModuleForDescendents,
+        Aquarium::ForDescendents::NestedModuleForDescendents,
+        Aquarium::ForDescendents::Nested2ModuleForDescendents]
+
+      @@sample_classes = [
+        BaseForDescendents,
+        D1ForDescendents,
+        D2ForDescendents,
+        D11ForDescendents,
+        Aquarium::ForDescendents::NestedBaseForDescendents,
+        Aquarium::ForDescendents::NestedD1ForDescendents,
+        Aquarium::ForDescendents::NestedD2ForDescendents,
+        Aquarium::ForDescendents::NestedD11ForDescendents,
+        Aquarium::ForDescendents::NestedD3ForDescendents,
+        Aquarium::ForDescendents::NestedD4ForDescendents,
+        Aquarium::ForDescendents::NestedD31ForDescendents]
+
+      @@sample_types = @@sample_modules + @@sample_classes
+
+      def self.sample_types;   @@sample_types;   end
+      def self.sample_modules; @@sample_modules; end
+      def self.sample_classes; @@sample_classes; end
+      
+      
+      @@sample_modules_descendents = {
+        ModuleForDescendents => [
+          Aquarium::ForDescendents::Nested2ModuleForDescendents,
+          Aquarium::ForDescendents::NestedD31ForDescendents,
+          Aquarium::ForDescendents::NestedD3ForDescendents,
+          D11ForDescendents,
+          D1ForDescendents,
+          ModuleForDescendents],
+        Aquarium::ForDescendents::NestedModuleForDescendents => [
+          Aquarium::ForDescendents::NestedD11ForDescendents,
+          Aquarium::ForDescendents::NestedD1ForDescendents,
+          Aquarium::ForDescendents::NestedModuleForDescendents],
+        Aquarium::ForDescendents::Nested2ModuleForDescendents => [
+          Aquarium::ForDescendents::Nested2ModuleForDescendents]}
+
+      @@sample_classes_descendents = {
+        BaseForDescendents => [
+          Aquarium::ForDescendents::NestedD31ForDescendents,
+          Aquarium::ForDescendents::NestedD3ForDescendents,
+          Aquarium::ForDescendents::NestedD4ForDescendents,
+          BaseForDescendents,
+          D11ForDescendents,
+          D1ForDescendents,
+          D2ForDescendents],
+        D1ForDescendents => [
+          Aquarium::ForDescendents::NestedD31ForDescendents,
+          D11ForDescendents,
+          D1ForDescendents],
+        D2ForDescendents => [D2ForDescendents],
+        D11ForDescendents => [D11ForDescendents],
+        Aquarium::ForDescendents::NestedBaseForDescendents => [
+          Aquarium::ForDescendents::NestedBaseForDescendents,
+          Aquarium::ForDescendents::NestedD11ForDescendents,
+          Aquarium::ForDescendents::NestedD1ForDescendents,
+          Aquarium::ForDescendents::NestedD2ForDescendents],
+        Aquarium::ForDescendents::NestedD1ForDescendents => [
+          Aquarium::ForDescendents::NestedD11ForDescendents,
+          Aquarium::ForDescendents::NestedD1ForDescendents],
+        Aquarium::ForDescendents::NestedD2ForDescendents => [
+          Aquarium::ForDescendents::NestedD2ForDescendents],
+        Aquarium::ForDescendents::NestedD11ForDescendents => [
+          Aquarium::ForDescendents::NestedD11ForDescendents],
+        Aquarium::ForDescendents::NestedD3ForDescendents => [
+          Aquarium::ForDescendents::NestedD3ForDescendents],
+        Aquarium::ForDescendents::NestedD4ForDescendents => [
+          Aquarium::ForDescendents::NestedD4ForDescendents],
+        Aquarium::ForDescendents::NestedD31ForDescendents => [
+          Aquarium::ForDescendents::NestedD31ForDescendents]}
+  
+      @@sample_types_descendents = @@sample_classes_descendents.merge @@sample_modules_descendents
+
+
+      @@sample_modules_ancestors = {
+        ModuleForDescendents => [ModuleForDescendents],
+        Aquarium::ForDescendents::NestedModuleForDescendents => [Aquarium::ForDescendents::NestedModuleForDescendents],
+        Aquarium::ForDescendents::Nested2ModuleForDescendents => [
+          Aquarium::ForDescendents::Nested2ModuleForDescendents,
+          ModuleForDescendents]}
+
+      @@sample_classes_ancestors = {
+        BaseForDescendents => [
+          BaseForDescendents,
+          Object,
+          Kernel],
+        D1ForDescendents => [
+          D1ForDescendents,
+          ModuleForDescendents,
+          BaseForDescendents,
+          Object,
+          Kernel],
+        D2ForDescendents => [
+          D2ForDescendents,
+          BaseForDescendents,
+          Object,
+          Kernel],
+        D11ForDescendents => [
+          D11ForDescendents,
+          D1ForDescendents,
+          ModuleForDescendents,
+          BaseForDescendents,
+          Object,
+          Kernel],
+        Aquarium::ForDescendents::NestedBaseForDescendents => [
+          Aquarium::ForDescendents::NestedBaseForDescendents,
+          Object,
+          Kernel],
+        Aquarium::ForDescendents::NestedD1ForDescendents => [
+          Aquarium::ForDescendents::NestedD1ForDescendents,
+          Aquarium::ForDescendents::NestedModuleForDescendents,
+          Aquarium::ForDescendents::NestedBaseForDescendents,
+          Object,
+          Kernel],
+        Aquarium::ForDescendents::NestedD2ForDescendents => [
+          Aquarium::ForDescendents::NestedD2ForDescendents,
+          Aquarium::ForDescendents::NestedBaseForDescendents,
+          Object,
+          Kernel],
+        Aquarium::ForDescendents::NestedD11ForDescendents => [
+          Aquarium::ForDescendents::NestedD11ForDescendents,
+          Aquarium::ForDescendents::NestedD1ForDescendents,
+          Aquarium::ForDescendents::NestedModuleForDescendents,
+          Aquarium::ForDescendents::NestedBaseForDescendents,
+          Object,
+          Kernel],
+        Aquarium::ForDescendents::NestedD3ForDescendents => [
+          Aquarium::ForDescendents::NestedD3ForDescendents,
+          ModuleForDescendents,
+          BaseForDescendents,
+          Object,
+          Kernel],
+        Aquarium::ForDescendents::NestedD4ForDescendents => [
+          Aquarium::ForDescendents::NestedD4ForDescendents,
+          BaseForDescendents,
+          Object,
+          Kernel],
+        Aquarium::ForDescendents::NestedD31ForDescendents => [
+          Aquarium::ForDescendents::NestedD31ForDescendents,
+          D1ForDescendents,
+          ModuleForDescendents,
+          BaseForDescendents,
+          Object,
+          Kernel]}
+          
+        @@sample_types_ancestors = @@sample_classes_ancestors.merge @@sample_modules_ancestors 
+          
+
+        %w[types modules classes].each do |x|
+          class_eval <<-EOF
+            def self.sample_#{x}_descendents
+              @@sample_#{x}_descendents
+            end
+            def self.sample_#{x}_ancestors
+              @@sample_#{x}_ancestors
+            end
+            def self.sample_#{x}_descendents_and_ancestors
+              self.sample_#{x}_descendents & sample_#{x}_ancestors
+            end
+          EOF
+        end
+          
+    end
+  end
+end
+    
+