jw-rails-erd 1.4.5

data/test/unit/domain_test.rb

@@ -0,0 +1,258 @@
+require File.expand_path("../test_helper", File.dirname(__FILE__))
+
+class DomainTest < ActiveSupport::TestCase
+  # Domain ===================================================================
+  test "generate should return domain" do
+    assert_kind_of Domain, Domain.generate
+  end
+
+  test "name should return rails application name" do
+    begin
+      Object::Quux = Module.new
+      Object::Quux::Application = Class.new
+      Object::Rails = Struct.new(:application).new(Object::Quux::Application.new)
+      assert_equal "Quux", Domain.generate.name
+    ensure
+      Object::Quux.send :remove_const, :Application
+      Object.send :remove_const, :Quux
+      Object.send :remove_const, :Rails
+    end
+  end
+
+  test "name should return nil outside rails" do
+    assert_nil Domain.generate.name
+  end
+
+  test "inspect should display object id only" do
+    create_model "Foo", :bar => :references do
+      belongs_to :bar
+    end
+    create_model "Bar"
+    assert_match %r{#<RailsERD::Domain:.*>}, Domain.generate.inspect
+  end
+
+  # Entity processing ========================================================
+  test "entity_by_name should return associated entity for given name" do
+    create_model "Foo"
+    assert_equal Foo, Domain.generate.entity_by_name("Foo").model
+  end
+
+  test "entities should return domain entities" do
+    create_models "Foo", "Bar"
+    assert_equal [Domain::Entity] * 2, Domain.generate.entities.collect(&:class)
+  end
+
+  test "entities should return all domain entities sorted by name" do
+    create_models "Foo", "Bar", "Baz", "Qux"
+    assert_equal [Bar, Baz, Foo, Qux], Domain.generate.entities.collect(&:model)
+  end
+
+  test "entities should include abstract entities" do
+    create_model "Stronghold" do
+      has_many :cannons, :as => :defensible
+    end
+    assert_equal ["Defensible", "Stronghold"], Domain.generate.entities.collect(&:name)
+  end
+
+  test "entities should include abstract entities only once" do
+    create_model "Stronghold" do
+      has_many :cannons, :as => :defensible
+    end
+    create_model "Galleon" do
+      has_many :cannons, :as => :defensible
+    end
+    assert_equal ["Defensible", "Galleon", "Stronghold"], Domain.generate.entities.collect(&:name)
+  end
+
+  test "entities should include abstract models" do
+    create_model "Structure" do
+      self.abstract_class = true
+    end
+    create_model "Palace", Structure
+    assert_equal ["Palace", "Structure"], Domain.generate.entities.collect(&:name)
+  end
+
+  # Relationship processing ==================================================
+  test "relationships should return empty array for empty domain" do
+    assert_equal [], Domain.generate.relationships
+  end
+
+  test "relationships should return relationships in domain model" do
+    create_models "Baz", "Qux"
+    create_model "Foo", :bar => :references, :qux => :references do
+      belongs_to :bar
+      belongs_to :qux
+    end
+    create_model "Bar", :baz => :references do
+      belongs_to :baz
+    end
+    assert_equal [Domain::Relationship] * 3, Domain.generate.relationships.collect(&:class)
+  end
+
+  test "relationships should count mutual relationship as one" do
+    create_model "Foo", :bar => :references do
+      belongs_to :bar
+    end
+    create_model "Bar" do
+      has_many :foos
+    end
+    assert_equal [Domain::Relationship], Domain.generate.relationships.collect(&:class)
+  end
+
+  test "relationships should count mutual indirect relationship as one" do
+    create_model "Wizard" do
+      has_many :spell_masteries
+      has_many :spells, :through => :spell_masteries
+    end
+    create_model "Spell" do
+      has_many :spell_masteries
+      has_many :wizards, :through => :spell_masteries
+    end
+    create_model "SpellMastery", :wizard => :references, :spell => :references do
+      belongs_to :wizard
+      belongs_to :spell
+    end
+    assert_equal [Domain::Relationship], Domain.generate.relationships.select(&:indirect?).collect(&:class)
+  end
+
+  test "relationships should count relationship between same models with distinct foreign key seperately" do
+    create_model "Foo", :bar => :references, :special_bar => :references do
+      belongs_to :bar
+    end
+    create_model "Bar" do
+      has_many :foos, :foreign_key => :special_bar_id
+    end
+    assert_equal [Domain::Relationship] * 2, Domain.generate.relationships.collect(&:class)
+  end
+
+  test "relationships should use model name first in alphabet as source for many to many relationships" do
+    create_table "many_more", :many_id => :integer, :more_id => :integer
+    create_model "Many" do
+      has_and_belongs_to_many :more
+    end
+    create_model "More" do
+      has_and_belongs_to_many :many
+    end
+    relationship = Domain.generate.relationships.first
+    assert_equal ["Many", "More"], [relationship.source.name, relationship.destination.name]
+  end
+
+  # Specialization processing ================================================
+  test "specializations should return empty array for empty domain" do
+    assert_equal [], Domain.generate.specializations
+  end
+
+  test "specializations should return empty array for domain without single table inheritance" do
+    create_simple_domain
+    assert_equal [], Domain.generate.specializations
+  end
+
+  test "specializations should return specializations in domain model" do
+    create_specialization
+    assert_equal [Domain::Specialization], Domain.generate.specializations.collect(&:class)
+  end
+
+  test "specializations should return specializations of specializations in domain model" do
+    create_specialization
+    Object.const_set :BelgianBeer, Class.new(Beer)
+    assert_equal [Domain::Specialization] * 2, Domain.generate.specializations.collect(&:class)
+  end
+
+  test "specializations should return polymorphic generalizations in domain model" do
+    create_polymorphic_generalization
+    assert_equal [Domain::Specialization], Domain.generate.specializations.collect(&:class)
+  end
+
+  test "specializations should return abstract generalizations in domain model" do
+    create_abstract_generalization
+    assert_equal [Domain::Specialization], Domain.generate.specializations.collect(&:class)
+  end
+
+  test "specializations should return polymorphic and abstract generalizations and specializations in domain model" do
+    create_specialization
+    create_polymorphic_generalization
+    create_abstract_generalization
+    assert_equal [Domain::Specialization] * 3, Domain.generate.specializations.collect(&:class)
+  end
+
+  # Erroneous associations ===================================================
+  test "relationships should omit bad has_many associations" do
+    create_model "Foo" do
+      has_many :flabs
+    end
+    assert_equal [], Domain.generate(:warn => false).relationships
+  end
+
+  test "relationships should omit bad has_many through association" do
+    create_model "Foo" do
+      has_many :flabs, :through => :bars
+    end
+    assert_equal [], Domain.generate(:warn => false).relationships
+  end
+
+  test "relationships should omit association to model outside domain" do
+    create_model "Foo" do
+      has_many :bars
+    end
+    create_model "Bar", :foo => :references
+    assert_equal [], Domain.new([Foo], :warn => false).relationships
+  end
+
+  test "relationships should output a warning when a bad association is encountered" do
+    create_model "Foo" do
+      has_many :flabs
+    end
+    output = collect_stdout do
+      Domain.generate.relationships
+    end
+    assert_match /Ignoring invalid association :flabs on Foo/, output
+  end
+
+  test "relationships should output a warning when an association to model outside domain is encountered" do
+    create_model "Foo" do
+      has_many :bars
+    end
+    create_model "Bar", :foo => :references
+    output = collect_stdout do
+      Domain.new([Foo]).relationships
+    end
+    assert_match /model Bar exists, but is not included in domain/, output
+  end
+
+  test "relationships should output a warning when an association to a non existent generalization is encountered" do
+    create_model "Foo" do
+      has_many :bars, :as => :foo
+    end
+    create_model "Bar", :foobar => :references do
+      belongs_to :foo_bar, :polymorphic => true
+    end
+    output = collect_stdout do
+      Domain.generate.relationships
+    end
+    assert_match /polymorphic interface FooBar does not exist/, output
+  end
+
+  test "relationships should not warn when a bad association is encountered if warnings are disabled" do
+    create_model "Foo" do
+      has_many :flabs
+    end
+    output = collect_stdout do
+      Domain.generate(:warn => false).relationships
+    end
+    assert_equal "", output
+  end
+
+  # Erroneous models =========================================================
+  test "entities should omit bad models" do
+    Object.const_set :Foo, Class.new(ActiveRecord::Base)
+    assert_equal [], Domain.generate(:warn => false).entities
+  end
+
+  test "entities should output a warning when a model table does not exist" do
+    Object.const_set :Foo, Class.new(ActiveRecord::Base)
+    output = collect_stdout do
+      Domain.generate.entities
+    end
+    assert_match /Ignoring invalid model Foo \(table foos does not exist\)/, output
+  end
+end

data/test/unit/entity_test.rb

@@ -0,0 +1,252 @@
+require File.expand_path("../test_helper", File.dirname(__FILE__))
+
+class EntityTest < ActiveSupport::TestCase
+  def create_entity(model)
+    Domain::Entity.new(Domain.new, model.name, model)
+  end
+
+  def create_generalized_entity(name)
+    Domain::Entity.new(Domain.new, name)
+  end
+
+  def create_abstract_entity(name)
+    model = create_model(name) { self.abstract_class = true }
+    create_entity(model)
+  end
+
+  # Entity ===================================================================
+  test "model should return active record model" do
+    create_models "Foo"
+    assert_equal Foo, create_entity(Foo).model
+  end
+
+  test "name should return model name" do
+    create_models "Foo"
+    assert_equal "Foo", create_entity(Foo).name
+  end
+
+  test "spaceship should sort entities by name" do
+    create_models "Foo", "Bar"
+    foo, bar = create_entity(Foo), create_entity(Bar)
+    assert_equal [bar, foo], [foo, bar].sort
+  end
+
+  test "to_s should equal name" do
+    create_models "Foo"
+    assert_equal "Foo", create_entity(Foo).to_s
+  end
+
+  test "inspect should show name" do
+    create_models "Foo"
+    assert_match %r{#<RailsERD::Domain::Entity:.* @model=Foo>}, create_entity(Foo).inspect
+  end
+
+  test "relationships should return relationships for this model" do
+    create_model "Foo", :bar => :references do
+      belongs_to :bar
+    end
+    create_model "Bar", :baz => :references do
+      belongs_to :baz
+    end
+    create_model "Baz"
+
+    domain = Domain.generate
+    foo = domain.entity_by_name("Foo")
+    assert_equal domain.relationships.select { |r| r.destination == foo }, foo.relationships
+  end
+
+  test "relationships should return relationships that connect to this model" do
+    create_model "Foo", :bar => :references
+    create_model "Bar", :baz => :references do
+      belongs_to :baz
+      has_many :foos
+    end
+    create_model "Baz"
+
+    domain = Domain.generate
+    foo = domain.entity_by_name("Foo")
+    assert_equal domain.relationships.select { |r| r.destination == foo }, foo.relationships
+  end
+
+  # Entity properties ========================================================
+  test "connected should return false for unconnected entities" do
+    create_models "Foo", "Bar"
+    assert_equal [false, false], Domain.generate.entities.map(&:connected?)
+  end
+
+  test "connected should return true for connected entities" do
+    create_model "Foo", :bar => :references do
+      belongs_to :bar
+    end
+    create_model "Bar"
+    assert_equal [true, true], Domain.generate.entities.map(&:connected?)
+  end
+
+  test "disconnected should return true for unconnected entities" do
+    create_models "Foo", "Bar"
+    assert_equal [true, true], Domain.generate.entities.map(&:disconnected?)
+  end
+
+  test "disconnected should return false for connected entities" do
+    create_model "Foo", :bar => :references do
+      belongs_to :bar
+    end
+    create_model "Bar"
+    assert_equal [false, false], Domain.generate.entities.map(&:disconnected?)
+  end
+
+  test "specialized should return false for regular entities" do
+    create_model "Foo"
+    assert_equal false, create_entity(Foo).specialized?
+  end
+
+  test "specialized should return false for child entities with distinct tables" do
+    create_model "Foo", :type => :string
+    Object.const_set :SpecialFoo, Class.new(Foo)
+    SpecialFoo.class_eval do
+      self.table_name = "special_foo"
+    end
+    create_table "special_foo", {}, true
+    assert_equal false, create_entity(SpecialFoo).specialized?
+  end
+
+  test "specialized should return true for specialized entities" do
+    create_model "Foo", :type => :string
+    Object.const_set :SpecialFoo, Class.new(Foo)
+    assert_equal true, create_entity(SpecialFoo).specialized?
+  end
+
+  test "specialized should return true for specialations of specialized entities" do
+    create_model "Foo", :type => :string
+    Object.const_set :SpecialFoo, Class.new(Foo)
+    Object.const_set :VerySpecialFoo, Class.new(SpecialFoo)
+    assert_equal true, create_entity(VerySpecialFoo).specialized?
+  end
+
+  test "virtual should return true for specialized entity" do
+    create_model "Foo", :type => :string
+    Object.const_set :SpecialFoo, Class.new(Foo)
+    assert_equal true, create_entity(SpecialFoo).virtual?
+  end
+
+  test "generalized should return false for regular entity" do
+    create_model "Concrete"
+    assert_equal false, create_entity(Concrete).generalized?
+  end
+
+  test "virtual should return false for regular entity" do
+    create_model "Concrete"
+    assert_equal false, create_entity(Concrete).virtual?
+  end
+
+  # Attribute processing =====================================================
+  test "attributes should return list of attributes" do
+    create_model "Bar", :some_column => :integer, :another_column => :string
+    assert_equal [Domain::Attribute] * 3, create_entity(Bar).attributes.collect(&:class)
+  end
+
+  test "attributes should return attributes sorted by name" do
+    create_model "Bar", :some_column => :integer, :another_column => :string
+    assert_equal ["another_column", "id", "some_column"], create_entity(Bar).attributes.collect(&:name)
+  end
+
+  # Generalized entity =======================================================
+  test "model should return nil for generalized entity" do
+    assert_nil create_generalized_entity("MyAbstractModel").model
+  end
+
+  test "name should return given name for generalized entity" do
+    assert_equal "MyAbstractModel", create_generalized_entity("MyAbstractModel").name
+  end
+
+  test "attributes should return empty array for generalized entity" do
+    assert_equal [], create_generalized_entity("MyAbstractModel").attributes
+  end
+
+  test "generalized should return true for generalized entity" do
+    assert_equal true, create_generalized_entity("MyAbstractModel").generalized?
+  end
+
+  test "specialized should return false for generalized entity" do
+    assert_equal false, create_generalized_entity("MyAbstractModel").specialized?
+  end
+
+  test "virtual should return true for generalized entity" do
+    assert_equal true, create_generalized_entity("MyAbstractModel").virtual?
+  end
+
+  test "relationships should return relationships for generalized entity" do
+    create_model "Stronghold" do
+      has_many :cannons, :as => :defensible
+    end
+    create_model "Cannon", :defensible => :references do
+      belongs_to :defensible, :polymorphic => true
+    end
+
+    domain = Domain.generate
+    defensible = domain.entity_by_name("Defensible")
+    assert_equal domain.relationships, defensible.relationships
+  end
+
+  # Abstract generalized entity ==============================================
+  test "name should return given name for abstract generalized entity" do
+    assert_equal "MyAbstractModel", create_abstract_entity("MyAbstractModel").name
+  end
+
+  test "attributes should return empty array for abstract generalized entity" do
+    assert_equal [], create_abstract_entity("MyAbstractModel").attributes
+  end
+
+  test "generalized should return true for abstract generalized entity" do
+    assert_equal true, create_abstract_entity("MyAbstractModel").generalized?
+  end
+
+  test "specialized should return false for abstract generalized entity" do
+    assert_equal false, create_abstract_entity("MyAbstractModel").specialized?
+  end
+
+  test "virtual should return true for abstract generalized entity" do
+    assert_equal true, create_abstract_entity("MyAbstractModel").virtual?
+  end
+
+  test "relationships should return relationships for abstract generalized entity" do
+    create_model "Kingdom"
+    create_model "Structure" do
+      self.abstract_class = true
+      belongs_to :kingdom
+    end
+    create_model "Palace", Structure, :kingdom => :references
+
+    domain = Domain.generate
+    assert_equal domain.relationships, domain.entity_by_name("Structure").relationships
+  end
+
+  # Children =================================================================
+  test "children should return empty array for regular entities" do
+    create_model "Foo"
+    assert_equal [], create_entity(Foo).children
+  end
+
+  test "children should return inherited entities for regular entities with single table inheritance" do
+    create_model "Beverage", :type => :string
+    create_model "Whisky", Beverage
+    create_model "Beer", Beverage
+    domain = Domain.generate
+    assert_equal [domain.entity_by_name("Beer"), domain.entity_by_name("Whisky")], domain.entity_by_name("Beverage").children
+  end
+
+  test "children should return inherited entities for generalized entities" do
+    create_model "Stronghold" do
+      has_many :cannons, :as => :defensible
+    end
+    create_model "Galleon" do
+      has_many :cannons, :as => :defensible
+    end
+    create_model "Cannon", :defensible => :references do
+      belongs_to :defensible, :polymorphic => true
+    end
+    domain = Domain.generate
+    assert_equal [domain.entity_by_name("Galleon"), domain.entity_by_name("Stronghold")],
+      domain.entity_by_name("Defensible").children
+  end
+end