rails-erd 1.4.7 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e10c973dc76bbb05773bc6920678cc060878c740
-  data.tar.gz: 42af4a884c51e266b993d255a49e2647c2d4e368
+  metadata.gz: 16bfef1b79087e3017df7723bef8cf286df5a812
+  data.tar.gz: 7162f90b6dce224a0ec89693e7d307fbc15a9b45
 SHA512:
-  metadata.gz: 9dbb498dd6dbfb15a243d3957e5172ab0fb6ffb54c39ba5ba4aac13ea7fb8a38d2272e07fd6b8b67651e39ed842620757b387c23cd77f4325d1736e3e5706efe
-  data.tar.gz: ca3b2a15e3db16434341e6d8c2b439b0a97fcfd9ed0304b5eaf07d1e571b11d82ff44a0ffc6fbd352d0dbae8eb7c380b98beaef57d3ffe16ced26a7f4cbf4b81
+  metadata.gz: 34e2582512bfe6313f626d4de969eebc328415c97456b1cd151df3e19d75e55cc0b65a9ded7ba0c363d3708072d001266d96657e2a8669ee6a7c4ca7b0cc3ee0
+  data.tar.gz: 16ddf4ba4c7d640a4c139905fe6f238f76c70cf20712c467ebb9bf9075f0ee6603c0c532114b86bd0e66f7d275f5ae0200802e91c8978a469c6e39208dd3c709

data/README.md

@@ -2,11 +2,11 @@ Rails ERD - Generate Entity-Relationship Diagrams for Rails applications
 ========================================================================
 [![Build Status](https://travis-ci.org/voormedia/rails-erd.svg?branch=master)](https://travis-ci.org/voormedia/rails-erd) [![Code Climate](https://codeclimate.com/github/voormedia/rails-erd/badges/gpa.svg)](https://codeclimate.com/github/voormedia/rails-erd)
 
-[Rails ERD](http://voormedia.github.io/rails-erd/) is a gem that allows you to easily generate a diagram based on your application's 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.
+[Rails ERD](https://voormedia.github.io/rails-erd/) is a gem that allows you to easily generate a diagram based on your application's 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 and works on versions 3.0-4.2. It uses Active Record's built-in reflection capabilities to figure out how your models are associated.
+Rails ERD was created specifically for Rails and works on versions 3.0-5.0. It uses Active Record's built-in reflection capabilities to figure out how your models are associated.
 
 
 Preview
@@ -14,34 +14,34 @@ Preview
 
 Here's an example entity-relationship diagram that was generated by Rails ERD:
 
-![Entity-Relationship Diagram](http://voormedia.github.io/rails-erd/images/entity-relationship-diagram.png)
+![Entity-Relationship Diagram](https://voormedia.github.io/rails-erd/images/entity-relationship-diagram.png)
 
-Browse the [gallery](http://voormedia.github.io/rails-erd/gallery.html) for more example diagrams.
+Browse the [gallery](https://voormedia.github.io/rails-erd/gallery.html) for more example diagrams.
 
 
 Requirements
 ---------------
 
 * Ruby 1.9.3+
-* ActiveRecord 3.x
+* ActiveRecord 3.x - 5.0.x
 
 Getting started
 ---------------
 
-See the [installation instructions](http://voormedia.github.io/rails-erd/install.html) for a complete description of how to install Rails ERD. Here's a summary:
+See the [installation instructions](https://voormedia.github.io/rails-erd/install.html) for a complete description of how to install Rails ERD. Here's a summary:
 
-* Install Graphviz 2.22+ ([how?](http://voormedia.github.io/rails-erd/install.html))
+* Install Graphviz 2.22+ ([how?](https://voormedia.github.io/rails-erd/install.html)). On macOS with Homebrew run `brew install graphviz`.
 
-* Add <tt>gem "rails-erd"</tt> to your application's Gemfile
+* Add <tt>gem 'rails-erd', group: :development</tt> to your application's Gemfile
 
 * Run <tt>bundle exec erd</tt>
 
 ### Configuration
 
 
-Rails ERD has the ability to be configured via the command line or through the use of a YAML file with configuration options set. It will look for this file first at `~/.erdconfig` and then `./.erdconfig` (which will override any settings in `~/.erdconfig`). The format of the file is as follows (shown here with the default settings used if no `.erdconfig` is found). More information on [customization options](http://voormedia.github.io/rails-erd/customise.html) can be found in Rails ERD's project documentation.
+Rails ERD has the ability to be configured via the command line or through the use of a YAML file with configuration options set. It will look for this file first at `~/.erdconfig` and then `./.erdconfig` (which will override any settings in `~/.erdconfig`). The format of the file is as follows (shown here with the default settings used if no `.erdconfig` is found). More information on [customization options](https://voormedia.github.io/rails-erd/customise.html) can be found in Rails ERD's project documentation.
 
-```
+```yaml
 attributes:
   - content
   - foreign_key
@@ -60,14 +60,22 @@ warn: true
 title: sample title
 exclude: null
 only: null
+only_recursion_depth: null
 prepend_primary: false
+cluster: false
+splines: spline
 ```
 
+Auto generation
+---------------
+
+* Run <tt>bundle exec rails g erd:install</tt>
+* Run <tt>bundle exec rails db:migrate</tt>, then the diagram is generated
 
 Learn more
 ----------
 
-More information can be found on [Rails ERD's project homepage](http://voormedia.github.io/rails-erd/).
+More information can be found on [Rails ERD's project homepage](https://voormedia.github.io/rails-erd/).
 
 If you wish to extend or customise Rails ERD, take a look at the [API documentation](http://rubydoc.info/github/voormedia/rails-erd/frames).
 

data/lib/generators/erd/templates/auto_generate_diagram.rake

@@ -2,5 +2,5 @@
 # NOTE: are sensitive to local FS writes, and besides -- it's just not proper
 # NOTE: to have a dev-mode tool do its thing in production.
 if Rails.env.development?
-  Erd.load_tasks
+  RailsERD.load_tasks
 end

data/lib/rails_erd.rb

@@ -51,9 +51,21 @@ module RailsERD
         :title, true,
         :exclude, nil,
         :only, nil,
-        :prepend_primary, false
+        :only_recursion_depth, nil,
+        :prepend_primary, false,
+        :cluster, false,
       ]
     end
+
+    def loaded_tasks=(val); @loaded_tasks = val; end
+    def loaded_tasks; return @loaded_tasks; end
+
+    def load_tasks
+      return if(self.loaded_tasks)
+      self.loaded_tasks = true
+
+      Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each { |rake| load rake }
+    end
   end
 
   module Inspectable # @private :nodoc:

data/lib/rails_erd/cli.rb

@@ -1,3 +1,4 @@
+require "rails_erd"
 require "choice"
 
 Choice.options do
@@ -49,6 +50,11 @@ Choice.options do
     desc "Filter to only include listed models in diagram."
   end
 
+  option :only_recursion_depth do
+    long "--only_recursion_depth=INTEGER"
+    desc "Recurses into relations specified by --only upto a depth N."
+  end
+
   option :exclude do
     long "--exclude"
     desc "Filter to exclude listed models in diagram."
@@ -64,6 +70,16 @@ Choice.options do
     desc "Ensure primary key is at start of attribute list"
   end
 
+  option :cluster do
+    long "--cluster"
+    desc "Display models in subgraphs based on their namespace."
+  end
+
+  option :splines do
+    long "--splines=SPLINE_TYPE"
+    desc "Control how edges are represented. See http://www.graphviz.org/doc/info/attrs.html#d:splines for values."
+  end
+
   separator ""
   separator "Output options:"
 
@@ -110,6 +126,12 @@ Choice.options do
       exit
     end
   end
+
+  option :config_file do
+    short "-c"
+    long "--config=FILENAME"
+    desc "Configuration file to use"
+  end
 end
 
 module RailsERD
@@ -128,6 +150,9 @@ module RailsERD
             opts[key.to_sym] = value
           end
         end
+        if options[:config_file] && options[:config_file] != ''
+          RailsERD.options = RailsERD.default_options.merge(Config.load(options[:config_file]))
+        end
         new(path, options).start
       end
     end
@@ -149,9 +174,17 @@ module RailsERD
 
     def load_application
       $stderr.puts "Loading application in '#{File.basename(path)}'..."
-      # TODO: Add support for different kinds of environment.
-      require "#{path}/config/environment"
-      Rails.application.eager_load!
+      begin
+        environment_path = "#{path}/config/environment.rb"
+        require environment_path
+      rescue ::LoadError
+        puts "Please create a file in '#{environment_path}' that loads your application environment."
+        raise
+      end
+      if defined? Rails
+        Rails.application.eager_load!
+        Rails.application.config.eager_load_namespaces.each(&:eager_load!) if Rails.application.config.respond_to?(:eager_load_namespaces)
+      end
     rescue TypeError
     end
 

data/lib/rails_erd/config.rb

@@ -7,17 +7,21 @@ module RailsERD
 
     attr_reader :options
 
-    def self.load
-      new.load
+    def self.load(extra_config_file=nil)
+      new.load extra_config_file
     end
 
     def initialize
       @options = {}
     end
 
-    def load
+    def load(extra_config_file=nil)
       load_file(USER_WIDE_CONFIG_FILE)
       load_file(CURRENT_CONFIG_FILE)
+      if extra_config_file
+        extra_config_path = File.expand_path(extra_config_file, Dir.pwd)
+        load_file(extra_config_path) if File.exist?(extra_config_path)
+      end
 
       @options
     end
@@ -63,8 +67,10 @@ module RailsERD
       # [<string>]
       when :only, :exclude
         Array(value).join(",").split(",").map { |v| v.strip }
+
       # true | false
-      when :disconnected, :indirect, :inheritance, :markup, :polymorphism, :warn
+      when :disconnected, :indirect, :inheritance, :markup, :polymorphism,
+           :warn, :cluster
         !!value
 
       # nil | <string>

data/lib/rails_erd/diagram.rb

@@ -7,7 +7,7 @@ module RailsERD
   # and (optionally) +save+.
   #
   # As an example, a diagram class that generates code that can be used with
-  # yUML (http://yuml.me) can be as simple as:
+  # yUML (https://yuml.me) can be as simple as:
   #
   #   require "rails_erd/diagram"
   #
@@ -124,6 +124,13 @@ module RailsERD
     # internally by Diagram#create.
     def generate
       instance_eval(&callbacks[:setup])
+      if options.only_recursion_depth.present?
+        depth = options.only_recursion_depth.to_s.to_i
+        options[:only].dup.each do |class_name|
+          options[:only]+= recurse_into_relationships(@domain.entity_by_name(class_name), depth)
+        end
+        options[:only].uniq!
+      end
 
       filtered_entities.each do |entity|
         instance_exec entity, filtered_attributes(entity), &callbacks[:each_entity]
@@ -138,6 +145,26 @@ module RailsERD
       end
     end
 
+    def recurse_into_relationships(entity, max_level, current_level = 0)
+      return [] unless entity
+      return [] if max_level == current_level
+
+      relationships = entity.relationships.reject{|r| r.indirect? || r.recursive?}
+
+      relationships.map do |relationship|
+        other_entitiy = if relationship.source == entity
+                          relationship.destination
+                        else
+                          relationship.source
+                        end
+        if other_entitiy and !other_entitiy.generalized?
+          [other_entitiy.name] + recurse_into_relationships(other_entitiy, max_level, current_level + 1)
+        else
+          []
+        end
+      end.flatten.uniq
+    end
+
     def save
       instance_eval(&callbacks[:save])
     end
@@ -150,8 +177,8 @@ module RailsERD
 
     def filtered_entities
       @domain.entities.reject { |entity|
-        options.exclude.present? && entity.model && [options.exclude].flatten.map(&:to_sym).include?(entity.name.to_sym) or
-        options.only.present? && entity.model && ![options.only].flatten.map(&:to_sym).include?(entity.name.to_sym) or
+        options.exclude.present? && [options.exclude].flatten.map(&:to_sym).include?(entity.name.to_sym) or
+        options[:only].present? && entity.model && ![options[:only]].flatten.map(&:to_sym).include?(entity.name.to_sym) or
         !options.inheritance && entity.specialized? or
         !options.polymorphism && entity.generalized? or
         !options.disconnected && entity.disconnected?

data/lib/rails_erd/diagram/graphviz.rb

@@ -62,7 +62,8 @@ module RailsERD
         concentrate: true,
         labelloc:    :t,
         fontsize:    13,
-        fontname:    FONTS[:bold]
+        fontname:    FONTS[:bold],
+        splines:     'spline'
       }
 
       # Default node attributes.
@@ -85,6 +86,11 @@ module RailsERD
         labeldistance: 1.8,
       }
 
+      # Default cluster attributes.
+      CLUSTER_ATTRIBUTES = {
+        margin: "10,10"
+      }
+
       module Simple
         def entity_style(entity, attributes)
           {}.tap do |options|
@@ -188,6 +194,9 @@ module RailsERD
         # Title of the graph itself.
         graph[:label] = "#{title}\\n\\n" if title
 
+        # Style of splines
+        graph[:splines] = options.splines unless options.splines.nil?
+
         # Setup notation options.
         extend self.class.const_get(options.notation.to_s.capitalize.to_sym)
       end
@@ -210,7 +219,16 @@ module RailsERD
       end
 
       each_entity do |entity, attributes|
-        draw_node entity.name, entity_options(entity, attributes)
+        if options[:cluster] && entity.namespace
+          cluster_name = "cluster_#{entity.namespace}"
+          cluster_options = CLUSTER_ATTRIBUTES.merge(label: entity.namespace)
+          cluster = graph.get_graph(cluster_name) ||
+                    graph.add_graph(cluster_name, cluster_options)
+
+          draw_cluster_node cluster, entity.name, entity_options(entity, attributes)
+        else
+          draw_node entity.name, entity_options(entity, attributes)
+        end
       end
 
       each_specialization do |specialization|
@@ -233,15 +251,19 @@ module RailsERD
       private
 
       def node_exists?(name)
-        !!graph.get_node(escape_name(name))
+        !!graph.search_node(escape_name(name))
       end
 
       def draw_node(name, options)
         graph.add_nodes escape_name(name), options
       end
 
+      def draw_cluster_node(cluster, name, options)
+        cluster.add_nodes escape_name(name), options
+      end
+
       def draw_edge(from, to, options)
-        graph.add_edges graph.get_node(escape_name(from)), graph.get_node(escape_name(to)), options if node_exists?(from) and node_exists?(to)
+        graph.add_edges graph.search_node(escape_name(from)), graph.search_node(escape_name(to)), options if node_exists?(from) and node_exists?(to)
       end
 
       def escape_name(name)
@@ -288,7 +310,12 @@ module RailsERD
       end
 
       def read_template(type)
-        ERB.new(File.read(File.expand_path("templates/#{NODE_LABEL_TEMPLATES[type]}", File.dirname(__FILE__))), nil, "<>")
+        template_text = File.read(File.expand_path("templates/#{NODE_LABEL_TEMPLATES[type]}", File.dirname(__FILE__)))
+        if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
+          ERB.new(template_text, trim_mode: "<>")
+        else
+          ERB.new(template_text, nil, "<>")
+        end
       end
     end
   end

data/lib/rails_erd/diagram/templates/node.html.erb

@@ -1,4 +1,4 @@
-<% if options.orientation == :vertical %>{<% end %>
+<% if options.orientation == :horizontal %>{<% end %>
 <table border="0" align="center" cellspacing="0.5" cellpadding="0" width="<%= NODE_WIDTH + 4 %>">
   <tr><td align="center" valign="bottom" width="<%= NODE_WIDTH %>"><font face="<%= FONTS[:bold] %>" point-size="11"><%= entity.name %></font></td></tr>
 </table>
@@ -11,4 +11,4 @@
 </table>
 <% else %>
 <% end %>
-<% if options.orientation == :vertical %>}<% end %>
+<% if options.orientation == :horizontal %>}<% end %>

data/lib/rails_erd/diagram/templates/node.record.erb

@@ -1,4 +1,4 @@
-<% if options.orientation == :vertical %>{<% end %><%= entity.name %><% if attributes.any? %>
+<% if options.orientation == :horizontal %>{<% end %><%= entity.name %><% if attributes.any? %>
 |<%  attributes.each do |attribute| %><%=
        attribute %> (<%= attribute.type_description %>)
-<%   end %><% end %><% if options.orientation == :vertical %>}<% end %>
+<%   end %><% end %><% if options.orientation == :horizontal %>}<% end %>

data/lib/rails_erd/domain.rb

@@ -49,7 +49,13 @@ module RailsERD
     # Returns the domain model name, which is the name of your Rails
     # application or +nil+ outside of Rails.
     def name
-      defined? Rails and Rails.application and Rails.application.class.parent.name
+      return unless defined?(Rails) && Rails.application
+
+      if Rails.application.class.respond_to?(:module_parent)
+        Rails.application.class.module_parent.name
+      else
+        Rails.application.class.parent.name
+      end
     end
 
     # Returns all entities of your domain model.
@@ -140,8 +146,7 @@ module RailsERD
       association.check_validity!
 
       if association.options[:polymorphic]
-        entity_name = association.class_name
-        entity_by_name(entity_name) or raise "polymorphic interface #{entity_name} does not exist"
+        check_polymorphic_association_validity(association)
       else
         entity_name = association.klass.name # Raises NameError if the associated class cannot be found.
         entity_by_name(entity_name) or raise "model #{entity_name} exists, but is not included in domain"
@@ -150,6 +155,17 @@ module RailsERD
       warn "Ignoring invalid association #{association_description(association)} (#{e.message})"
     end
 
+    def check_polymorphic_association_validity(association)
+      entity_name = association.class_name
+      entity = entity_by_name(entity_name)
+
+      if entity || (entity && entity.generalized?)
+        return entity
+      else
+        raise("polymorphic interface #{entity_name} does not exist")
+      end
+    end
+
     def association_description(association)
       "#{association.name.inspect} on #{association.active_record}"
     end

data/lib/rails_erd/domain/entity.rb

@@ -92,6 +92,10 @@ module RailsERD
         @children ||= domain.specializations_by_entity_name(name).map(&:specialized)
       end
 
+      def namespace
+        $1 if name.match(/(.*)::.*/)
+      end
+
       def to_s # @private :nodoc:
         name
       end

data/lib/rails_erd/domain/relationship.rb

@@ -21,8 +21,7 @@ module RailsERD
         private
 
         def association_identity(association)
-          identifier = association_identifier(association).to_s
-          Set[identifier, association_owner(association), association_target(association)]
+          Set[association_owner(association), association_target(association)]
         end
 
         def association_identifier(association)

data/lib/rails_erd/domain/specialization.rb

@@ -30,7 +30,7 @@ module RailsERD
         end
 
         def abstract_from_models(domain, models)
-          models.select(&:abstract_class?).collect(&:descendants).flatten.collect { |model|
+          models.select(&:abstract_class?).collect(&:direct_descendants).flatten.collect { |model|
             new(domain, domain.entity_by_name(model.superclass.name), domain.entity_by_name(model.name))
           }
         end

data/lib/rails_erd/tasks.rake

@@ -1,15 +1,31 @@
+require 'graphviz/utils'
+
 def say(message)
   puts message unless Rake.application.options.silent
 end
 
 namespace :erd do
+  task :check_dependencies do
+    include GraphViz::Utils
+    unless find_executable("dot", nil)
+      raise "Unable to find GraphViz's \"dot\" executable. Please " \
+            "visit https://voormedia.github.io/rails-erd/install.html for installation instructions."
+    end
+  end
+
   task :options do
     (RailsERD.options.keys.map(&:to_s) & ENV.keys).each do |option|
       RailsERD.options[option.to_sym] = case ENV[option]
       when "true", "yes" then true
       when "false", "no" then false
       when /,/ then ENV[option].split(/\s*,\s*/)
-      else ENV[option].to_sym
+      when /^\d+$/ then ENV[option].to_i
+      else
+        if option == 'only'
+          [ENV[option]]
+        else
+          ENV[option].to_sym
+        end
       end
     end
   end
@@ -21,6 +37,10 @@ namespace :erd do
     say "Loading code in search of Active Record models..."
     begin
       Rails.application.eager_load!
+
+      if Rails.application.respond_to?(:config) && !Rails.application.config.nil?
+        Rails.application.config.eager_load_namespaces.each(&:eager_load!) if Rails.application.config.respond_to?(:eager_load_namespaces)
+      end
     rescue Exception => err
       if Rake.application.options.trace
         raise
@@ -34,7 +54,7 @@ namespace :erd do
     raise "Active Record was not loaded." unless defined? ActiveRecord
   end
 
-  task :generate => [:options, :load_models] do
+  task :generate => [:check_dependencies, :options, :load_models] do
     say "Generating Entity-Relationship Diagram for #{ActiveRecord::Base.descendants.length} models..."
 
     require "rails_erd/diagram/graphviz"

data/lib/rails_erd/version.rb

@@ -1,4 +1,4 @@
 module RailsERD
-  VERSION = "1.4.7"
+  VERSION = "1.6.1"
   BANNER  = "RailsERD #{VERSION}"
 end

data/test/test_helper.rb

@@ -1,15 +1,12 @@
 require "rubygems"
 require "bundler/setup"
+require 'pry'
+require 'pry-nav'
 
 require "active_record"
 
-if ActiveSupport::VERSION::MAJOR >= 4
-  require "minitest/autorun"
-  require 'mocha/mini_test'
-else
-  require "test/unit"
-  require 'mocha/test_unit'
-end
+require "minitest/autorun"
+require 'mocha/minitest'
 
 require "rails_erd/domain"
 
@@ -19,6 +16,14 @@ if ActiveSupport::TestCase.respond_to?(:test_order=)
   ActiveSupport::TestCase.test_order = :random
 end
 
+# Patch to make Rails 6.1 work.
+module Kernel
+  # class_eval on an object acts like singleton_class.class_eval.
+  def class_eval(*args, &block)
+    singleton_class.class_eval(*args, &block)
+  end
+end
+
 class ActiveSupport::TestCase
   include RailsERD
 
@@ -48,10 +53,34 @@ class ActiveSupport::TestCase
     ActiveRecord::Base.clear_cache!
   end
 
+  def create_module_model(full_name,*args,&block)
+    superklass = args.first.kind_of?(Class) ? args.shift : ActiveRecord::Base
+
+    names = full_name.split('::')
+
+    parent_module = names[0..-1].inject(Object) do |parent,child|
+      parent = parent.const_set(child.to_sym, Module.new)
+    end
+
+    parent_module ||= Object
+    name = names.last
+
+    columns = args.first || {}
+    klass = parent_module.const_set name.to_sym, Class.new(superklass)
+    konstant = parent_module.const_get(name.to_sym)
+
+    if superklass == ActiveRecord::Base || superklass.abstract_class?
+      create_table konstant.table_name, columns, konstant.primary_key rescue nil
+    end
+    klass.class_eval(&block) if block_given?
+    konstant
+  end
+
   def create_model(name, *args, &block)
     superklass = args.first.kind_of?(Class) ? args.shift : ActiveRecord::Base
     columns = args.first || {}
     klass = Object.const_set name.to_sym, Class.new(superklass)
+
     if superklass == ActiveRecord::Base || superklass.abstract_class?
       create_table Object.const_get(name.to_sym).table_name, columns, Object.const_get(name.to_sym).primary_key rescue nil
     end
@@ -143,18 +172,64 @@ class ActiveSupport::TestCase
     RailsERD.options = RailsERD.default_options.merge(Config.load)
   end
 
+  def name_to_object_symbol_pairs(name)
+    parts = name.to_s.split('::')
+
+    return [] if parts.first == '' || parts.count == 0
+
+    parts[1..-1].inject([[Object, parts.first.to_sym]]) do |pairs,string|
+      last_parent, last_child = pairs.last
+      # Fixes for Rails 6. No idea if this is actually correct as I can't decipher what the heck is going on in this
+      # code.
+      if last_child == :ActiveRecord || last_child == :primary
+        break []
+      end
+
+      break pairs unless last_parent.const_defined?(last_child)
+
+      next_parent = last_parent.const_get(last_child)
+      next_child = string.to_sym
+      pairs << [next_parent, next_child]
+    end
+  end
+
+  def remove_fully_qualified_constant(name)
+    pairs = name_to_object_symbol_pairs(name)
+    pairs.reverse.each do |parent, child|
+      parent.send(:remove_const,child) if parent.const_defined?(child)
+    end
+  end
+
   def reset_domain
     if defined? ActiveRecord
       ActiveRecord::Base.descendants.each do |model|
+        next if model.name == "ActiveRecord::InternalMetadata"
         model.reset_column_information
-        Object.send :remove_const, model.name.to_sym if Object.const_defined? model.name.to_sym
+        remove_fully_qualified_constant(model.name)
       end
-      ActiveRecord::Base.connection.tables.each do |table|
+
+      tables_and_views.each do |table|
         ActiveRecord::Base.connection.drop_table table
       end
-      ActiveRecord::Base.direct_descendants.clear
+
+      if ActiveRecord.version >= Gem::Version.new("6.0.0.rc1")
+        cv = ActiveSupport::DescendantsTracker.class_variable_get(:@@direct_descendants)
+        cv.delete(ActiveRecord::Base)
+        ActiveSupport::DescendantsTracker.class_variable_set(:@@direct_descendants, cv)
+      else
+        ActiveRecord::Base.direct_descendants.clear
+      end
+
       ActiveSupport::Dependencies::Reference.clear!
       ActiveRecord::Base.clear_cache!
     end
   end
+
+  def tables_and_views
+    if ActiveRecord::VERSION::MAJOR >= 5
+      ActiveRecord::Base.connection.data_sources
+    else
+      ActiveRecord::Base.connection.tables
+    end
+  end
 end

data/test/unit/attribute_test.rb

@@ -3,8 +3,9 @@ require File.expand_path("../test_helper", File.dirname(__FILE__))
 
 class AttributeTest < ActiveSupport::TestCase
   def with_native_limit(type, new_limit)
-    ActiveRecord::Base.connection.class_eval do
-      define_method :native_database_types do
+    ActiveRecord::Base.connection.singleton_class.class_eval do
+      undef :native_database_types
+      define_method(:native_database_types) do
         super().tap do |types|
           types[type][:limit] = new_limit
         end
@@ -12,8 +13,9 @@ class AttributeTest < ActiveSupport::TestCase
     end
     yield
   ensure
-    ActiveRecord::Base.connection.class_eval do
-      define_method :native_database_types do
+    ActiveRecord::Base.connection.singleton_class.class_eval do
+      undef :native_database_types
+      define_method(:native_database_types) do
         super()
       end
     end
@@ -222,14 +224,14 @@ class AttributeTest < ActiveSupport::TestCase
   test "limit should return nil if there is no limit" do
     create_model "Foo"
     add_column :foos, :my_txt, :text
-    assert_equal nil, create_attribute(Foo, "my_txt").limit
+    assert_nil create_attribute(Foo, "my_txt").limit
   end
 
   test "limit should return nil if equal to standard database limit" do
     with_native_limit :string, 456 do
       create_model "Foo"
       add_column :foos, :my_str, :string, :limit => 456
-      assert_equal nil, create_attribute(Foo, "my_str").limit
+      assert_nil create_attribute(Foo, "my_str").limit
     end
   end
 
@@ -250,7 +252,7 @@ class AttributeTest < ActiveSupport::TestCase
   test "limit should return nil for decimal columns if equal to standard database limit" do
     create_model "Foo"
     add_column :foos, :num, :decimal
-    assert_equal nil, create_attribute(Foo, "num").limit
+    assert_nil create_attribute(Foo, "num").limit
   end
 
   test "limit should return nil if type is unsupported by rails" do
@@ -260,19 +262,19 @@ class AttributeTest < ActiveSupport::TestCase
         add_column "foos", "a", "REAL"
       end
     end
-    assert_equal nil, create_attribute(Foo, "a").limit
+    assert_nil create_attribute(Foo, "a").limit
   end
 
   test "limit should return nil for oddball column types that misuse the limit attribute" do
-    create_model "Business", :location => :integer
-    attribute = create_attribute(Business, "location")
-    attribute.column.class_eval do
-      define_method :limit do
+    create_model "Business", :location => :integer do
+      define_singleton_method :limit do
         # https://github.com/voormedia/rails-erd/issues/21
         { :srid => 4326, :type => "point", :geographic => true }
       end
     end
-    assert_equal nil, attribute.limit
+
+    attribute = create_attribute(Business, "location")
+    assert_nil attribute.limit
   end
 
   test "scale should return scale for decimal columns if nonstandard" do
@@ -284,7 +286,7 @@ class AttributeTest < ActiveSupport::TestCase
   test "scale should return nil for decimal columns if equal to standard database limit" do
     create_model "Foo"
     add_column :foos, :num, :decimal
-    assert_equal nil, create_attribute(Foo, "num").scale
+    assert_nil create_attribute(Foo, "num").scale
   end
 
   test "scale should return zero for decimal columns if left to default setting when specifying precision" do
@@ -300,17 +302,16 @@ class AttributeTest < ActiveSupport::TestCase
         add_column "foos", "a", "REAL"
       end
     end
-    assert_equal nil, create_attribute(Foo, "a").scale
+    assert_nil create_attribute(Foo, "a").scale
   end
 
   test "scale should return nil for oddball column types that misuse the scale attribute" do
-    create_model "Kobold", :size => :integer
-    attribute = create_attribute(Kobold, "size")
-    attribute.column.class_eval do
+    create_model "Kobold", :size => :integer do
       define_method :scale do
         1..5
       end
     end
-    assert_equal nil, attribute.scale
+    attribute = create_attribute(Kobold, "size")
+    assert_nil attribute.scale
   end
 end

data/test/unit/config_test.rb

@@ -61,6 +61,29 @@ class ConfigTest < ActiveSupport::TestCase
     assert_equal expected_hash, RailsERD::Config.load
   end
 
+  test "load_config_file should return a hash from the configured config file when a new config file is given as an argument" do
+    set_local_config_file_to("erdconfig.another_example")
+
+    expected_hash = {
+      attributes:   [:content, :foreign_key, :inheritance, :false],
+      disconnected: true,
+      filename:     "erd",
+      filetype:     :pdf,
+      indirect:     true,
+      inheritance:  false,
+      markup:       true,
+      notation:     :simple,
+      orientation:  "horizontal",
+      polymorphism: false,
+      warn:         true,
+      title:        "sample title",
+      exclude:      [],
+      only:         []
+    }
+
+    assert_equal expected_hash, RailsERD::Config.load("test/support_files/erdconfig.example")
+  end
+
   test "load_config_gile should return a hash from CURRENT_CONFIG_FILE overriding USER_WIDE_CONFIG_FILE when both of them exist." do
     set_user_config_file_to("erdconfig.example")
     set_local_config_file_to("erdconfig.another_example")

data/test/unit/diagram_test.rb

@@ -136,6 +136,15 @@ class DiagramTest < ActiveSupport::TestCase
     assert_equal [Book], retrieve_entities(:exclude => [:Author, :Editor]).map(&:model)
   end
 
+  test "generate should filter excluded polymorphic entities" do
+    create_model "Cannon"
+    create_model "Galleon" do
+      has_many :cannons, as: :defensible
+    end
+    assert_equal ["Cannon", "Galleon"], retrieve_entities(polymorphism: true, exclude: :Defensible).map(&:name)
+  end
+
+
   test "generate should include only specified entity" do
     create_model "Book"
     create_model "Author"

data/test/unit/domain_test.rb

@@ -127,13 +127,21 @@ class DomainTest < ActiveSupport::TestCase
   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
+    # TODO: Once we drop Rails 3.2 support, we _should_ be able to drop the
+    #   :respond_to? check
+    #
+    if respond_to? :skip
+      skip("multiple edges between the same objects can cause segfaults in some versions of Graphviz")
+
+      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
-    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
@@ -186,6 +194,15 @@ class DomainTest < ActiveSupport::TestCase
     assert_equal [Domain::Specialization] * 3, Domain.generate.specializations.collect(&:class)
   end
 
+  test "specializations should return specializations in domain model once for descendants of abstract class" do
+    create_model "Thing" do
+      self.abstract_class = true
+    end
+    create_model "Beverage", Thing, :type => :string
+    create_model "Beer", Beverage
+    assert_equal [Domain::Specialization], Domain.generate.specializations.collect(&:class)
+  end
+
   # Erroneous associations ===================================================
   test "relationships should omit bad has_many associations" do
     create_model "Foo" do
@@ -216,7 +233,7 @@ class DomainTest < ActiveSupport::TestCase
     output = collect_stdout do
       Domain.generate.relationships
     end
-    assert_match /Ignoring invalid association :flabs on Foo/, output
+    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
@@ -227,7 +244,7 @@ class DomainTest < ActiveSupport::TestCase
     output = collect_stdout do
       Domain.new([Foo]).relationships
     end
-    assert_match /model Bar exists, but is not included in domain/, output
+    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
@@ -240,7 +257,7 @@ class DomainTest < ActiveSupport::TestCase
     output = collect_stdout do
       Domain.generate.relationships
     end
-    assert_match /polymorphic interface FooBar does not exist/, output
+    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
@@ -264,6 +281,6 @@ class DomainTest < ActiveSupport::TestCase
     output = collect_stdout do
       Domain.generate.entities
     end
-    assert_match /Ignoring invalid model Foo \(table foos does not exist\)/, output
+    assert_match(/Ignoring invalid model Foo \(table foos does not exist\)/, output)
   end
 end

data/test/unit/entity_test.rb

@@ -249,4 +249,30 @@ class EntityTest < ActiveSupport::TestCase
     assert_equal [domain.entity_by_name("Galleon"), domain.entity_by_name("Stronghold")],
       domain.entity_by_name("Defensible").children
   end
+
+  # Namespace ===================================================================
+  test "namespace should return nil for models outside modules" do
+    create_module_model "Plane"
+    assert_nil create_entity(Plane).namespace
+  end
+
+  test "namespace should return the module name for single-module models" do
+    create_module_model "Saw::Plane"
+    assert_equal "Saw", create_entity(Saw::Plane).namespace
+  end
+
+  test "namespace should return the module path if more than one module" do
+    create_module_model "Augur::Chisel::Saw::Plane"
+    assert_equal "Augur::Chisel::Saw", create_entity(Augur::Chisel::Saw::Plane).namespace
+  end
+  
+  test "namespace defaults to nil" do
+    create_model "Foo"
+    assert_nil create_entity(Foo).namespace
+  end
+
+  test "namespace returns appropriate modules" do
+    entity = Domain::Entity.new(Domain.new, "Foo::Bar::Qux")
+    assert_equal "Foo::Bar", entity.namespace
+  end
 end

data/test/unit/graphviz_test.rb

@@ -106,6 +106,7 @@ class GraphvizTest < ActiveSupport::TestCase
     begin
       GraphViz.class_eval do
         alias_method :old_output_and_errors_from_command, :output_and_errors_from_command
+        undef :output_and_errors_from_command
         def output_and_errors_from_command(*args); raise end
       end
       assert_nothing_raised do
@@ -113,6 +114,7 @@ class GraphvizTest < ActiveSupport::TestCase
       end
     ensure
       GraphViz.class_eval do
+        undef :output_and_errors_from_command
         alias_method :output_and_errors_from_command, :old_output_and_errors_from_command
       end
     end
@@ -137,7 +139,7 @@ class GraphvizTest < ActiveSupport::TestCase
 
   test "create should not create output if there are no connected models" do
     Diagram::Graphviz.create rescue nil
-    assert !File.exists?("erd.png")
+    assert !File.exist?("erd.png")
   end
 
   test "create should abort and complain if there are no connected models" do
@@ -147,7 +149,7 @@ class GraphvizTest < ActiveSupport::TestCase
     rescue => e
       message = e.message
     end
-    assert_match /No entities found/, message
+    assert_match(/No entities found/, message)
   end
 
   test "create should abort and complain if output directory does not exist" do
@@ -160,7 +162,7 @@ class GraphvizTest < ActiveSupport::TestCase
       message = e.message
     end
 
-    assert_match /Output directory 'does_not_exist' does not exist/, message
+    assert_match(/Output directory 'does_not_exist' does not exist/, message)
   end
 
   test "create should not fail when reserved words are used as node names" do
@@ -184,6 +186,16 @@ class GraphvizTest < ActiveSupport::TestCase
     assert_equal '"Domain model\n\n"', diagram.graph.graph[:label].to_s
   end
 
+  test "generate should add default value for splines attribute" do
+    create_simple_domain
+    assert_equal '"spline"', diagram.graph.graph[:splines].to_s
+  end
+
+  test "generate should add set value for splines attribute" do
+    create_simple_domain
+    assert_equal '"ortho"', diagram(splines: 'ortho').graph.graph[:splines].to_s
+  end
+
   test "generate should add title with application name to graph" do
     begin
       Object::Quux = Module.new
@@ -226,7 +238,7 @@ class GraphvizTest < ActiveSupport::TestCase
       belongs_to :bar
     end
     create_model "Bar"
-    assert_equal %Q("Bar"), find_dot_node(diagram, "m_Bar")[:label].to_gv
+    assert_equal %Q("{Bar}"), find_dot_node(diagram, "m_Bar")[:label].to_gv
   end
 
   test "generate should add attributes to entity html labels" do
@@ -244,7 +256,7 @@ class GraphvizTest < ActiveSupport::TestCase
       belongs_to :bar
     end
     create_model "Bar", :column => :string, :column_two => :boolean
-    assert_equal %Q("Bar|column (string)\\ncolumn_two (boolean)\\n"), find_dot_node(diagram, "m_Bar")[:label].to_gv
+    assert_equal %Q("{Bar|column (string)\\ncolumn_two (boolean)\\n}"), find_dot_node(diagram, "m_Bar")[:label].to_gv
   end
 
   test "generate should not add any attributes to entity labels if attributes is set to false" do
@@ -255,50 +267,58 @@ class GraphvizTest < ActiveSupport::TestCase
     assert_no_match %r{contents}, find_dot_node(diagram(:attributes => false), "m_Jar")[:label].to_gv
   end
 
-  test "node html labels should have direction reversing braces for vertical orientation" do
+  test "node html labels should have direction reversing braces for horizontal orientation" do
     RailsERD.options.markup = true
     create_model "Book", :author => :references do
       belongs_to :author
     end
     create_model "Author", :name => :string
-    assert_match %r(\A<\{\s*<.*\|.*>\s*\}>\Z)m, find_dot_node(diagram(:orientation => :vertical), "m_Author")[:label].to_gv
+    assert_match %r(\A<\{\s*<.*\|.*>\s*\}>\Z)m, find_dot_node(diagram(:orientation => :horizontal), "m_Author")[:label].to_gv
   end
 
-  test "node html labels should not have direction reversing braces for horizontal orientation" do
+  test "node html labels should not have direction reversing braces for vertical orientation" do
     RailsERD.options.markup = true
     create_model "Book", :author => :references do
       belongs_to :author
     end
     create_model "Author", :name => :string
-    assert_match %r(\A<\s*<.*\|.*>\s*>\Z)m, find_dot_node(diagram(:orientation => :horizontal), "m_Author")[:label].to_gv
+    assert_match %r(\A<\s*<.*\|.*>\s*>\Z)m, find_dot_node(diagram(:orientation => :vertical), "m_Author")[:label].to_gv
   end
 
-  test "node record labels should have direction reversing braces for vertical orientation" do
+  test "node record labels should have direction reversing braces for horizontal orientation" do
     RailsERD.options.markup = false
     create_model "Book", :author => :references do
       belongs_to :author
     end
     create_model "Author", :name => :string
-    assert_match %r(\A"\{\w+|.*\}"\Z)m, find_dot_node(diagram(:orientation => :vertical), "m_Author")[:label].to_gv
+    assert_match %r(\A"\{\w+\|.*\}"\Z)m, find_dot_node(diagram(:orientation => :horizontal), "m_Author")[:label].to_gv
   end
 
-  test "node record labels should not have direction reversing braces for horizontal orientation" do
+  test "node record labels should not have direction reversing braces for vertical orientation" do
     RailsERD.options.markup = false
     create_model "Book", :author => :references do
       belongs_to :author
     end
     create_model "Author", :name => :string
-    assert_match %r(\A"\w+|.*"\Z)m, find_dot_node(diagram(:orientation => :horizontal), "m_Author")[:label].to_gv
+    assert_match %r(\A"\w+\|.*"\Z)m, find_dot_node(diagram(:orientation => :vertical), "m_Author")[:label].to_gv
   end
 
   test "generate should create edge for each relationship" do
-    create_model "Foo", :bar => :references do
-      belongs_to :bar
-    end
-    create_model "Bar", :foo => :references do
-      belongs_to :foo
+    # TODO: Once we drop Rails 3.2 support, we _should_ be able to drop the
+    #   :respond_to? check
+    #
+    if respond_to? :skip
+      skip("multiple edges between the same objects can cause segfaults in some versions of Graphviz")
+
+      create_model "Foo", :bar => :references do
+        belongs_to :bar
+      end
+      create_model "Bar", :foo => :references do
+        belongs_to :foo
+      end
+
+      assert_equal [["m_Bar", "m_Foo"], ["m_Foo", "m_Bar"]], find_dot_node_pairs(diagram).sort
     end
-    assert_equal [["m_Bar", "m_Foo"], ["m_Foo", "m_Bar"]], find_dot_node_pairs(diagram).sort
   end
 
   test "generate should create edge to polymorphic entity if polymorphism is true" do

data/test/unit/rake_task_test.rb

@@ -20,6 +20,7 @@ class RakeTaskTest < ActiveSupport::TestCase
     Object::Quux = Module.new
     Object::Quux::Application = Class.new
     Object::Rails = Struct.new(:application).new(Object::Quux::Application.new)
+
     Rails.class_eval do
       define_method :backtrace_cleaner do
         ActiveSupport::BacktraceCleaner.new.tap do |cleaner|
@@ -40,7 +41,7 @@ class RakeTaskTest < ActiveSupport::TestCase
 
   test "generate task should not create output if there are no connected models" do
     Rake::Task["erd:generate"].execute rescue nil
-    assert !File.exists?("erd.dot")
+    assert !File.exist?("erd.dot")
   end
 
   test "generate task should eager load application environment" do
@@ -100,12 +101,13 @@ class RakeTaskTest < ActiveSupport::TestCase
     rescue => e
       message = e.message
     end
-    assert_match /#{Regexp.escape(<<-MSG.strip).gsub("xxx", ".*?")}/, message
+    assert_match(/#{Regexp.escape(<<-MSG.strip).gsub("xxx", ".*?")}/, message
 Loading models failed!
 Error occurred while loading application: FooBar (RuntimeError)
     test/unit/rake_task_test.rb:#{l1}:in `xxx'
     test/unit/rake_task_test.rb:#{l2}:in `xxx'
     MSG
+    )
   end
 
   test "generate task should reraise if application could not be loaded and trace option is enabled" do
@@ -171,4 +173,22 @@ Error occurred while loading application: FooBar (RuntimeError)
     Rake::Task["erd:options"].execute
     assert_equal %w[content timestamps], RailsERD.options.attributes
   end
+
+  test "options task should set known integer command line options when value is only digits" do
+    ENV["only_recursion_depth"] = "2"
+    Rake::Task["erd:options"].execute
+    assert_equal 2, RailsERD.options.only_recursion_depth
+  end
+
+  test "options task sets known command line options as symbols when not boolean or numeric" do
+    ENV["only_recursion_depth"] = "test"
+    Rake::Task["erd:options"].execute
+    assert_equal :test, RailsERD.options.only_recursion_depth
+  end
+
+  test "options task should set single parameter to only as array xxx" do
+    ENV["only"] = "model"
+    Rake::Task["erd:options"].execute
+    assert_equal ["model"], RailsERD.options.only
+  end
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rails-erd
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.6.1
 platform: ruby
 authors:
 - Rolf Timmermans
-autorequire: 
+- Kerri Miller
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-19 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
@@ -66,10 +67,39 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Automatically generate an entity-relationship diagram (ERD) for your
   Rails models.
 email:
 - r.timmermans@voormedia.com
+- kerrizor@kerrizor.com
 executables:
 - erd
 extensions: []
@@ -117,7 +147,7 @@ homepage: https://github.com/voormedia/rails-erd
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,16 +155,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.14
+signing_key:
 specification_version: 4
 summary: Entity-relationship diagram for your Rails models.
 test_files:
@@ -152,4 +182,3 @@ test_files:
 - test/unit/rake_task_test.rb
 - test/unit/relationship_test.rb
 - test/unit/specialization_test.rb
-has_rdoc: