rails-erd 1.5.2 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33b2df60c7db63f567ecf08e5e221d7e47dc0234
-  data.tar.gz: 85fd38a21b0bb31cdbe1e19c20d0fbdd56e5d617
+  metadata.gz: 16bfef1b79087e3017df7723bef8cf286df5a812
+  data.tar.gz: 7162f90b6dce224a0ec89693e7d307fbc15a9b45
 SHA512:
-  metadata.gz: 0f10ee2e13c4d6e25c5bd3e4bc1e0df346a44f874e61f7f38ff0503639d046623a28bab1883cc49ff9fee1da3f5ecd1455a301b066eaa516c61ed04efe2fbe3b
-  data.tar.gz: 6b4ddb644d1966ff5f5a3d34a016ea5668f5ddfcc3914eeb539f10760e7eda79ecc5fca593e84a141f23b420919aab783811e99c9d7ba76cc28110aeb86b365a
+  metadata.gz: 34e2582512bfe6313f626d4de969eebc328415c97456b1cd151df3e19d75e55cc0b65a9ded7ba0c363d3708072d001266d96657e2a8669ee6a7c4ca7b0cc3ee0
+  data.tar.gz: 16ddf4ba4c7d640a4c139905fe6f238f76c70cf20712c467ebb9bf9075f0ee6603c0c532114b86bd0e66f7d275f5ae0200802e91c8978a469c6e39208dd3c709

data/README.md

@@ -30,9 +30,9 @@ Getting started
 
 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?](https://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>
 
@@ -69,8 +69,8 @@ splines: spline
 Auto generation
 ---------------
 
-* Run <tt>rails generate erd:install</tt>
-* Run <tt>rails db:migrate</tt>, then the diagram is generated
+* Run <tt>bundle exec rails g erd:install</tt>
+* Run <tt>bundle exec rails db:migrate</tt>, then the diagram is generated
 
 Learn more
 ----------

data/lib/rails_erd/cli.rb

@@ -1,3 +1,4 @@
+require "rails_erd"
 require "choice"
 
 Choice.options do
@@ -125,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
@@ -143,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

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

data/lib/rails_erd/diagram/graphviz.rb

@@ -86,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|
@@ -216,8 +221,10 @@ module RailsERD
       each_entity do |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, label: entity.namespace)
+                    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)
@@ -303,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.rb

@@ -125,7 +125,7 @@ module RailsERD
     def generate
       instance_eval(&callbacks[:setup])
       if options.only_recursion_depth.present?
-        depth = options.only_recursion_depth.to_i
+        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
@@ -177,7 +177,7 @@ 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.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

data/lib/rails_erd/domain/entity.rb

@@ -93,7 +93,7 @@ module RailsERD
       end
 
       def namespace
-        $1 if name.match /(.*)::.*/
+        $1 if name.match(/(.*)::.*/)
       end
 
       def to_s # @private :nodoc:

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.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/tasks.rake

@@ -19,7 +19,13 @@ namespace :erd do
       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

data/lib/rails_erd/version.rb

@@ -1,4 +1,4 @@
 module RailsERD
-  VERSION = "1.5.2"
+  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
 
@@ -75,6 +80,7 @@ class ActiveSupport::TestCase
     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
@@ -173,6 +179,11 @@ class ActiveSupport::TestCase
 
     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)
 
@@ -196,10 +207,19 @@ class ActiveSupport::TestCase
         model.reset_column_information
         remove_fully_qualified_constant(model.name)
       end
+
       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

data/test/unit/attribute_test.rb

@@ -3,9 +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
+    ActiveRecord::Base.connection.singleton_class.class_eval do
       undef :native_database_types
-      define_method :native_database_types do
+      define_method(:native_database_types) do
         super().tap do |types|
           types[type][:limit] = new_limit
         end
@@ -13,9 +13,9 @@ class AttributeTest < ActiveSupport::TestCase
     end
     yield
   ensure
-    ActiveRecord::Base.connection.class_eval do
+    ActiveRecord::Base.connection.singleton_class.class_eval do
       undef :native_database_types
-      define_method :native_database_types do
+      define_method(:native_database_types) do
         super()
       end
     end
@@ -266,14 +266,14 @@ class AttributeTest < ActiveSupport::TestCase
   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
+
+    attribute = create_attribute(Business, "location")
     assert_nil attribute.limit
   end
 
@@ -306,13 +306,12 @@ class AttributeTest < ActiveSupport::TestCase
   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
+    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

data/test/unit/graphviz_test.rb

@@ -304,13 +304,21 @@ class GraphvizTest < ActiveSupport::TestCase
   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

@@ -173,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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rails-erd
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.1
 platform: ruby
 authors:
 - Rolf Timmermans
 - Kerri Miller
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,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
@@ -67,6 +67,34 @@ 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:
@@ -119,7 +147,7 @@ homepage: https://github.com/voormedia/rails-erd
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,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.6.10
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.6.14
+signing_key:
 specification_version: 4
 summary: Entity-relationship diagram for your Rails models.
 test_files: