rails-erd 1.6.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92187ba08cd1adaa824abac10a7b33b94d5c5659bbc2177e628fac853e28fa4c
-  data.tar.gz: cfde87f41307742ca046d9b6c899f9f71211c13e1a6294ef03aeea082b6a4d8e
+  metadata.gz: 9aa7b34b79755fba7b09da0d9bd34d02496df7813c2a31c58b6b93c5d5575f25
+  data.tar.gz: c85abffb05d82382d8e32593176f4f377d1e9116128caa29b91a8c621bb67620
 SHA512:
-  metadata.gz: df5946aeffa73955192e36dc3a6de6a66f824f6537af8cae9575f9b2f3e14ab5bef28464573b5615a9a12381cf74fe23bc332e5caa5e0774f6cccf42c8739e27
-  data.tar.gz: 34609d17ee199b9c39b92eb87885665d89b1db42a968a6f58cf2c508a8a42e9a4d4a1ac22ab3b2cd60b2ed57c119580211e4514102f5008fce38408dd8527382
+  metadata.gz: 2f16c8591f2997b9e4fa59d1c10a4e677a5f7c4588e5ee04605e7a517b64278caf391778dcd2f3b56aa38d33055e4deaa9a09aad9ebf9571ab809ede2efed47d
+  data.tar.gz: 700a4ada1bdcae0b32d173f9d0e8b70e24f5cabc5c747d6a3580c1c8cf00d403261239b5fbdc544eb0c1b55b510aad407964854beb6ef4a384114a17c235d28a

data/README.md

@@ -32,6 +32,8 @@ See the [installation instructions](https://voormedia.github.io/rails-erd/instal
 
 * Install Graphviz 2.22+ ([how?](https://voormedia.github.io/rails-erd/install.html)). On macOS with Homebrew run `brew install graphviz`.
 
+* on linux - `sudo apt-get install graphviz`
+
 * Add <tt>gem 'rails-erd', group: :development</tt> to your application's Gemfile
 
 * Run <tt>bundle exec erd</tt>
@@ -64,6 +66,10 @@ only_recursion_depth: null
 prepend_primary: false
 cluster: false
 splines: spline
+fonts:
+ normal: "Arial"
+ bold: "Arial Bold"
+ italic: "Arial Italic"
 ```
 
 Auto generation

data/lib/rails_erd/cli.rb

@@ -174,17 +174,25 @@ module RailsERD
 
     def load_application
       $stderr.puts "Loading application in '#{File.basename(path)}'..."
-      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
+      environment_path = "#{path}/config/environment.rb"
+      require environment_path
+
       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 ::LoadError
+      error_message = <<~EOS
+        Tried to load your application environment from '#{environment_path}' but the file was not present.
+        This means that your models might not get loaded fully when the diagram gets buiilt. This can
+        make your entity diagram incomplete.
+
+        However, if you are using ActiveRecord without Rails just make sure your models get
+        loaded eagerly before we generate the ERD (for example, explicitly require your application
+        bootstrap file before calling rails-erd from your Rakefile). We will continue without loading the environment file,
+        and recommend you check your diagram for missing models after it gets generated.
+      EOS
+      puts error_message
     rescue TypeError
     end
 

data/lib/rails_erd/config.rb

@@ -81,6 +81,12 @@ module RailsERD
       when :title
         value.is_a?(String) ? value : !!value
 
+      # nil | <Hash>
+      when :fonts
+        if value
+          Hash(value).transform_keys(&:to_sym)
+        end
+
       else
         value
       end

data/lib/rails_erd/diagram/graphviz.rb

@@ -50,7 +50,7 @@ module RailsERD
 
       NODE_WIDTH = 130 # @private :nodoc:
 
-      FONTS = Config.font_names_based_on_os
+      FONTS = Config.font_names_based_on_os.merge(RailsERD.options[:fonts])
 
       # Default graph attributes.
       GRAPH_ATTRIBUTES = {

data/lib/rails_erd/domain/attribute.rb

@@ -119,7 +119,7 @@ module RailsERD
       # <tt>:decimal, :precision => 5, :scale => 2/tt>:: decimal (5,2)
       # <tt>:boolean, :null => false</tt>:: boolean *
       def type_description
-        type.to_s.tap do |desc|
+        type.to_s.dup.tap do |desc|
           desc << " #{limit_description}" if limit_description
           desc << " ∗" if mandatory? && !primary_key? # Add a hair space + low asterisk (Unicode characters)
           desc << " U" if unique? && !primary_key? && !foreign_key? # Add U if unique but non-key

data/lib/rails_erd/domain/specialization.rb

@@ -30,7 +30,14 @@ module RailsERD
         end
 
         def abstract_from_models(domain, models)
-          models.select(&:abstract_class?).collect(&:direct_descendants).flatten.collect { |model|
+          abstract_classes = models.select(&:abstract_class?)          
+          direct_descendants = if ActiveRecord.version >= Gem::Version.new("7.0.0")
+                                 abstract_classes.collect(&:subclasses)
+                               else
+                                 abstract_classes.collect(&:direct_descendants)
+                               end
+          
+          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/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.

data/lib/rails_erd/tasks.rake

@@ -1,7 +1,9 @@
 require 'graphviz/utils'
 
-def say(message)
-  puts message unless Rake.application.options.silent
+module ErdRakeHelper
+  def say(message)
+    puts message unless Rake.application.options.silent
+  end
 end
 
 namespace :erd do
@@ -31,6 +33,8 @@ namespace :erd do
   end
 
   task :load_models do
+    include ErdRakeHelper
+
     say "Loading application environment..."
     Rake::Task[:environment].invoke
 
@@ -55,12 +59,14 @@ namespace :erd do
   end
 
   task :generate => [:check_dependencies, :options, :load_models] do
+    include ErdRakeHelper
+
     say "Generating Entity-Relationship Diagram for #{ActiveRecord::Base.descendants.length} models..."
 
     require "rails_erd/diagram/graphviz"
     file = RailsERD::Diagram::Graphviz.create
 
-    say "Done! Saved diagram to #{file}."
+    say "Done! Saved diagram to ./#{file}"
   end
 end
 

data/lib/rails_erd/version.rb

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

data/lib/rails_erd.rb

@@ -40,6 +40,7 @@ module RailsERD
         :disconnected, true,
         :filename, "erd",
         :filetype, :pdf,
+        :fonts, {},
         :indirect, true,
         :inheritance, false,
         :markup, true,

data/test/test_helper.rb

@@ -16,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
 
@@ -26,9 +34,11 @@ class ActiveSupport::TestCase
     opts = if pk then { :primary_key => pk } else { :id => false } end
     ActiveRecord::Schema.instance_eval do
       suppress_messages do
-        create_table table, opts do |t|
-          columns.each do |column, type|
-            t.send type, column
+        unless ActiveRecord::Base.connection.table_exists?(table)
+          create_table table, **opts do |t|
+            columns.each do |column, type|
+              t.send type, column
+            end
           end
         end
       end
@@ -39,7 +49,8 @@ class ActiveSupport::TestCase
   def add_column(*args)
     ActiveRecord::Schema.instance_eval do
       suppress_messages do
-        add_column(*args)
+        opts = args.slice!(3) || {}
+        add_column(*args, **opts)
       end
     end
     ActiveRecord::Base.clear_cache!
@@ -74,7 +85,7 @@ class ActiveSupport::TestCase
     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
+      create_table Object.const_get(name.to_sym).table_name, columns, Object.const_get(name.to_sym).primary_key
     end
     klass.class_eval(&block) if block_given?
     Object.const_get(name.to_sym)
@@ -171,6 +182,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)
 
@@ -199,15 +215,18 @@ class ActiveSupport::TestCase
         ActiveRecord::Base.connection.drop_table table
       end
 
-      if ActiveRecord.version >= Gem::Version.new("6.0.0.rc1")
+      if ActiveRecord.version >= Gem::Version.new("7.0.0")
+        ActiveSupport::DescendantsTracker.clear(ActiveRecord::Base.subclasses)
+      elsif 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)
+        ActiveSupport::Dependencies::Reference.clear!
       else
         ActiveRecord::Base.direct_descendants.clear
+        ActiveSupport::Dependencies::Reference.clear!
       end
-
-      ActiveSupport::Dependencies::Reference.clear!
+      
       ActiveRecord::Base.clear_cache!
     end
   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

@@ -115,6 +115,12 @@ class ConfigTest < ActiveSupport::TestCase
     assert_equal [:content, :primary_keys], normalize_value(:attributes, ["content", "primary_keys"])
   end
 
+  test "normalize_value should return hash with symbol keys when key is :fonts and value is a hash." do
+    fonts_value = { "normal" => "Arial", "bold" => "Arial Bold", "italic" => "Arial Italic" }
+    expected = {:normal => "Arial", :bold => "Arial Bold", :italic => "Arial Italic"}
+    assert_equal expected, normalize_value(:fonts, fonts_value)
+  end
+
   def normalize_value(key, value)
     RailsERD::Config.new.send(:normalize_value, key, value)
   end

data/test/unit/graphviz_test.rb

@@ -186,6 +186,16 @@ class GraphvizTest < ActiveSupport::TestCase
     assert_equal '"Domain model\n\n"', diagram.graph.graph[:label].to_s
   end
 
+  test "generate should use default value for fontname attribute" do
+    create_simple_domain
+    assert_equal "\"#{RailsERD::Config.font_names_based_on_os[:bold]}\"", diagram.graph.graph[:fontname].to_s
+  end
+
+  test "generate should add set value for fontname attribute" do
+    create_simple_domain
+    assert_equal '"Arial Bold"', diagram(fonts: {bold: "Arial Bold"}).graph.graph[:fontname].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

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rails-erd
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Rolf Timmermans
 - Kerri Miller
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2022-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -147,7 +147,7 @@ homepage: https://github.com/voormedia/rails-erd
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,9 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.9
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Entity-relationship diagram for your Rails models.
 test_files: