rails-erd 0.3.0 → 0.4.0

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Rolf Timmermans
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-03 00:00:00 +02:00
+date: 2010-10-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,8 +28,7 @@ dependencies:
         segments: 
         - 3
         - 0
-        - 0
-        version: 3.0.0
+        version: "3.0"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -57,8 +56,8 @@ dependencies:
         segments: 
         - 0
         - 9
-        - 17
-        version: 0.9.17
+        - 18
+        version: 0.9.18
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -82,27 +81,28 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .gitignore
 - CHANGES.rdoc
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/rails-erd.rb
 - lib/rails_erd.rb
-- lib/rails_erd/attribute.rb
 - lib/rails_erd/diagram.rb
 - lib/rails_erd/diagram/graphviz.rb
 - lib/rails_erd/diagram/templates/node.erb
 - lib/rails_erd/domain.rb
-- lib/rails_erd/entity.rb
+- lib/rails_erd/domain/attribute.rb
+- lib/rails_erd/domain/entity.rb
+- lib/rails_erd/domain/relationship.rb
+- lib/rails_erd/domain/relationship/cardinality.rb
+- lib/rails_erd/domain/specialization.rb
 - lib/rails_erd/railtie.rb
-- lib/rails_erd/relationship.rb
-- lib/rails_erd/relationship/cardinality.rb
 - lib/rails_erd/tasks.rake
 - rails-erd.gemspec
 - test/test_helper.rb
@@ -114,6 +114,7 @@ files:
 - test/unit/graphviz_test.rb
 - test/unit/rake_task_test.rb
 - test/unit/relationship_test.rb
+- test/unit/specialization_test.rb
 has_rdoc: true
 homepage: http://rails-erd.rubyforge.org/
 licenses: []
@@ -156,3 +157,4 @@ test_files:
 - test/unit/graphviz_test.rb
 - test/unit/rake_task_test.rb
 - test/unit/relationship_test.rb
+- test/unit/specialization_test.rb

data/README.rdoc

@@ -1,51 +0,0 @@
-= Rails ERD - Generate Entity-Relationship Diagrams for Rails applications
-
-{Rails ERD}[http://rails-erd.rubyforge.org/] is a Rails plugin that allows
-you to easily generate a diagram based on your Active Record models. The
-diagram gives an overview of how your models are related. Having a diagram
-that describes your models is perfect documentation for your application.
-
-The second goal of Rails ERD is to provide you with a tool to inspect your
-application's domain model. If you don't like the default output, it is very
-easy to use the API to build your own diagrams.
-
-Rails ERD was created specifically for Rails 3. It uses Active Record's
-built-in reflection capabilities to figure out how your models are associated.
-
-== Preview
-
-Here's an example entity-relationship diagram that was generated by Rails ERD:
-
-http://rails-erd.rubyforge.org/examples/event-forms.png
-
-== Learn more
-
-Homepage:
-http://rails-erd.rubyforge.org/
-
-Diagram gallery:
-http://rails-erd.rubyforge.org/gallery.html
-
-Installation instructions:
-http://rails-erd.rubyforge.org/install.html
-
-Internal API documentation:
-http://rails-erd.rubyforge.org/doc/
-
-Source code at Github:
-http://github.com/voormedia/rails-erd
-
-== About Rails ERD
-
-Author: Rolf Timmermans (r.timmermans <i>at</i> voormedia.com)
-
-Copyright 2010 Voormedia B.V.
-
-== License
-
-Rails ERD is released under the MIT license. See the LICENSE.
-
-== Credits
-
-Rails ERD depends on the Ruby-Graphviz library to generate diagrams:
-http://github.com/glejeune/Ruby-Graphviz/

data/lib/rails_erd/attribute.rb

@@ -1,95 +0,0 @@
-# -*- encoding: utf-8
-module RailsERD
-  # Describes an entity's attribute. Attributes correspond directly to
-  # database columns.
-  class Attribute
-    TIMESTAMP_NAMES = %w{created_at created_on updated_at updated_on} # @private :nodoc:
-
-    class << self
-      def from_model(domain, model) # @private :nodoc:
-        model.arel_table.columns.collect { |column| Attribute.new(domain, model, column) }.sort
-      end
-    end
-
-    attr_reader :column # @private :nodoc:
-  
-    def initialize(domain, model, column) # @private :nodoc:
-      @domain, @model, @column = domain, model, column
-    end
-    
-    # The name of the attribute, equal to the column name.
-    def name
-      column.name
-    end
-    
-    # The type of the attribute, equal to the Rails migration type. Can be any
-    # of +:string+, +:integer+, +:boolean+, +:text+, etc.
-    def type
-      column.type
-    end
-    
-    # Returns +true+ if this attribute has no special meaning, that is, if it
-    # is not a primary key, foreign key, or timestamp.
-    def regular?
-      !primary_key? and !foreign_key? and !timestamp?
-    end
-    
-    # Returns +true+ if this attribute is mandatory. Mandatory attributes
-    # either have a presence validation (+validates_presence_of+), or have a
-    # <tt>NOT NULL</tt> database constraint.
-    def mandatory?
-      !column.null or @model.validators_on(name).map(&:kind).include?(:presence)
-    end
-    
-    # Returns +true+ if this attribute is the primary key of the entity.
-    def primary_key?
-      @model.arel_table.primary_key == name
-    end
-  
-    # Returns +true+ if this attribute is used as a foreign key for any
-    # relationship.
-    def foreign_key?
-      @domain.relationships_for(@model).map(&:associations).flatten.map(&:primary_key_name).include?(name)
-    end
-    
-    # Returns +true+ if this attribute is one of the standard 'magic' Rails
-    # timestamp columns, being +created_at+, +updated_at+, +created_on+ or
-    # +updated_on+.
-    def timestamp?
-      TIMESTAMP_NAMES.include? name
-    end
-    
-    def <=>(other) # @private :nodoc:
-      name <=> other.name
-    end
-    
-    def inspect # @private :nodoc:
-      "#<#{self.class.name}:0x%.14x @column=#{name.inspect} @type=#{type.inspect}>" % (object_id << 1)
-    end
-  
-    def to_s # @private :nodoc:
-      name
-    end
-  
-    # Returns a description of the attribute type. If the attribute has
-    # a non-standard limit or if it is mandatory, this information is included.
-    #
-    # Example output:
-    # <tt>:integer</tt>:: integer
-    # <tt>:string, :limit => 255</tt>:: string
-    # <tt>:string, :limit => 128</tt>:: string (128)
-    # <tt>:boolean, :null => false</tt>:: boolean *
-    def type_description
-      type.to_s.tap do |desc|
-        desc << " (#{limit})" if limit
-        desc << " ∗" if mandatory? # Add a hair space + low asterisk (Unicode characters).
-      end
-    end
-    
-    # Returns any non-standard limit for this attribute. If a column has no
-    # limit or uses a default database limit, this method returns +nil+.
-    def limit
-      column.limit if column.limit != @model.connection.native_database_types[type][:limit]
-    end
-  end
-end

data/lib/rails_erd/entity.rb

@@ -1,73 +0,0 @@
-module RailsERD
-  # Entities represent your Active Record models. Entities may be connected
-  # to other entities.
-  class Entity
-    class << self
-      def from_models(domain, models) # @private :nodoc:
-        models.collect { |model| new domain, model }.sort
-      end
-    end
-    
-    # The domain in which this entity resides.
-    attr_reader :domain
-    
-    # The Active Record model that this entity corresponds to.
-    attr_reader :model
-
-    def initialize(domain, model) # @private :nodoc:
-      @domain, @model = domain, model
-    end
-    
-    # Returns an array of attributes for this entity.
-    def attributes
-      @attributes ||= Attribute.from_model @domain, @model
-    end
-    
-    # Returns an array of all relationships that this entity has with other
-    # entities in the domain model.
-    def relationships
-      @domain.relationships_for(@model)
-    end
-    
-    # Returns the parent entity, if this entity is a descendant.
-    def parent
-      @domain.entity_for(@model.superclass) if descendant?
-    end
-    
-    # Returns +true+ if this entity has any relationships with other models,
-    # +false+ otherwise.
-    def connected?
-      relationships.any?
-    end
-
-    # Returns +true+ if this entity has no relationships with any other models,
-    # +false+ otherwise. Opposite of +connected?+.
-    def disconnected?
-      relationships.none?
-    end
-    
-    # Returns +true+ if this entity descends from another entity, and is
-    # represented in the same table as its parent.
-    def descendant?
-      !@model.descends_from_active_record?
-    end
-  
-    # Returns the name of this entity, which is the class name of the
-    # corresponding model.
-    def name
-      model.name
-    end
-  
-    def inspect # @private :nodoc:
-      "#<#{self.class}:0x%.14x @model=#{name}>" % (object_id << 1)
-    end
-    
-    def to_s # @private :nodoc:
-      name
-    end
-  
-    def <=>(other) # @private :nodoc:
-      self.name <=> other.name
-    end
-  end
-end

data/lib/rails_erd/relationship.rb

@@ -1,177 +0,0 @@
-require "rails_erd/relationship/cardinality"
-
-module RailsERD
-  # Describes a relationship between two entities. A relationship is detected
-  # based on Active Record associations. One relationship may represent more
-  # than one association, however. Related associations are grouped together.
-  # Associations are related if they share the same foreign key, or the same
-  # join table in the case of many-to-many associations.
-  class Relationship
-    N = Cardinality::N
-    
-    class << self
-      def from_associations(domain, associations) # @private :nodoc:
-        assoc_groups = associations.group_by { |assoc| association_identity(assoc) }
-        assoc_groups.collect { |_, assoc_group| Relationship.new(domain, assoc_group.to_a) }
-      end
-      
-      private
-      
-      def association_identity(assoc)
-        identifier = assoc.options[:join_table] || assoc.primary_key_name.to_s
-        Set[identifier, assoc.active_record, assoc.klass]
-      end
-    end
-
-    # The domain in which this relationship is defined.
-    attr_reader :domain
-
-    # The source entity. It corresponds to the model that has defined a
-    # +has_one+ or +has_many+ association with the other model.
-    attr_reader :source
-    
-    # The destination entity. It corresponds to the model that has defined
-    # a +belongs_to+ association with the other model.
-    attr_reader :destination
-    
-    delegate :one_to_one?, :one_to_many?, :many_to_many?, :source_optional?,
-      :destination_optional?, :to => :cardinality
-  
-    def initialize(domain, associations) # @private :nodoc:
-      @domain = domain
-      @reverse_associations, @forward_associations = *unless any_habtm?(associations)
-        associations.partition(&:belongs_to?)
-      else
-        # Many-to-many associations don't have a clearly defined direction.
-        # We sort by name and use the first model as the source.
-        source = associations.first.active_record
-        associations.partition { |association| association.active_record == source }
-      end
-      
-      assoc = @forward_associations.first || @reverse_associations.first
-      @source, @destination = @domain.entity_for(assoc.active_record), @domain.entity_for(assoc.klass)
-      @source, @destination = @destination, @source if assoc.belongs_to?
-    end
-    
-    # Returns all Active Record association objects that describe this
-    # relationship.
-    def associations
-      @forward_associations + @reverse_associations
-    end
-    
-    # Returns the cardinality of this relationship.
-    def cardinality
-      @cardinality ||= begin
-        reverse_max = any_habtm?(associations) ? N : 1
-        forward_range = associations_range(@source.model, @forward_associations, N)
-        reverse_range = associations_range(@destination.model, @reverse_associations, reverse_max)
-        Cardinality.new(reverse_range, forward_range)
-      end
-    end
-    
-    # Indicates if a relationship is indirect, that is, if it is defined
-    # through other relationships. Indirect relationships are created in
-    # Rails with <tt>has_many :through</tt> or <tt>has_one :through</tt>
-    # association macros.
-    def indirect?
-      !@forward_associations.empty? and @forward_associations.all?(&:through_reflection)
-    end
-    
-    # Indicates whether or not the relationship is defined by two inverse
-    # associations (e.g. a +has_many+ and a corresponding +belongs_to+
-    # association).
-    def mutual?
-      @forward_associations.any? and @reverse_associations.any?
-    end
-    
-    # Indicates whether or not this relationship connects an entity with itself.
-    def recursive?
-      @source == @destination
-    end
-    
-    # Indicates whether the destination cardinality class of this relationship
-    # is equal to one. This is +true+ for one-to-one relationships only.
-    def to_one?
-      cardinality.cardinality_class[1] == 1
-    end
-    
-    # Indicates whether the destination cardinality class of this relationship
-    # is equal to infinity. This is +true+ for one-to-many or
-    # many-to-many relationships only.
-    def to_many?
-      cardinality.cardinality_class[1] != 1
-    end
-    
-    # Indicates whether the source cardinality class of this relationship
-    # is equal to one. This is +true+ for one-to-one or
-    # one-to-many relationships only.
-    def one_to?
-      cardinality.cardinality_class[0] == 1
-    end
-    
-    # Indicates whether the source cardinality class of this relationship
-    # is equal to infinity. This is +true+ for many-to-many relationships only.
-    def many_to?
-      cardinality.cardinality_class[0] != 1
-    end
-    
-    # The strength of a relationship is equal to the number of associations
-    # that describe it.
-    def strength
-      associations.size
-    end
-
-    def inspect # @private :nodoc:
-      "#<#{self.class}:0x%.14x @source=#{source} @destination=#{destination}>" % (object_id << 1)
-    end
-  
-    def <=>(other) # @private :nodoc:
-      (source.name <=> other.source.name).nonzero? or (destination.name <=> other.destination.name)
-    end
-    
-    private
-
-    def associations_range(model, associations, absolute_max)
-      # The minimum of the range is the maximum value of each association
-      # minimum. If there is none, it is zero by definition. The reasoning is
-      # that from all associations, if only one has a required minimum, then
-      # this side of the relationship has a cardinality of at least one.
-      min = associations.map { |assoc| association_minimum(model, assoc) }.max || 0
-
-      # The maximum of the range is the maximum value of each association
-      # maximum. If there is none, it is equal to the absolute maximum. If
-      # only one association has a high cardinality on this side, the
-      # relationship itself has the same maximum cardinality.
-      max = associations.map { |assoc| association_maximum(model, assoc) }.max || absolute_max
-
-      min..max
-    end
-    
-    def association_minimum(model, association)
-      minimum = association_validators(:presence, model, association).any? ||
-        foreign_key_required?(model, association) ? 1 : 0
-      length_validators = association_validators(:length, model, association)
-      length_validators.map { |v| v.options[:minimum] }.compact.max or minimum
-    end
-
-    def association_maximum(model, association)
-      maximum = association.collection? ? N : 1      
-      length_validators = association_validators(:length, model, association)
-      length_validators.map { |v| v.options[:maximum] }.compact.min or maximum
-    end
-    
-    def association_validators(kind, model, association)
-      model.validators_on(association.name).select { |v| v.kind == kind }
-    end
-    
-    def any_habtm?(associations)
-      associations.any? { |association| association.macro == :has_and_belongs_to_many }
-    end
-    
-    def foreign_key_required?(model, association)
-      if association.belongs_to?
-        key = model.arel_table.columns.find { |column| column.name == association.primary_key_name } and !key.null
-      end
-    end
-  end
-end