rails-erd 1.6.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 16bfef1b79087e3017df7723bef8cf286df5a812
-  data.tar.gz: 7162f90b6dce224a0ec89693e7d307fbc15a9b45
+SHA256:
+  metadata.gz: 8b58372ac1652af1b21bd00ea88b434bb2d303247eca241f57efd84210bc9367
+  data.tar.gz: aecdcd4cfdb25ed3ef1713da019b456512d2b7bc965ebe0d7acea86e56b4f586
 SHA512:
-  metadata.gz: 34e2582512bfe6313f626d4de969eebc328415c97456b1cd151df3e19d75e55cc0b65a9ded7ba0c363d3708072d001266d96657e2a8669ee6a7c4ca7b0cc3ee0
-  data.tar.gz: 16ddf4ba4c7d640a4c139905fe6f238f76c70cf20712c467ebb9bf9075f0ee6603c0c532114b86bd0e66f7d275f5ae0200802e91c8978a469c6e39208dd3c709
+  metadata.gz: 1d8c7c596bf41d7753c0c34a468c142021ed66e7b7168dab70f68e57cf587640b5d5c35693b14c4a4c7778cf55b30f5740393454773901720f29c71f16e91c73
+  data.tar.gz: 733fe6e3c637a1f31f750621af09b9803102663b8d5cb611f978c600bc0940856e491a853325f57b4c126cf6e1ec50d55a4d0425ed573f1b722f144333ff4cf9

data/README.md

@@ -1,6 +1,6 @@
 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)
+[![Tests](https://github.com/voormedia/rails-erd/actions/workflows/test.yml/badge.svg)](https://github.com/voormedia/rails-erd/actions/workflows/test.yml) [![Code Climate](https://codeclimate.com/github/voormedia/rails-erd/badges/gpa.svg)](https://codeclimate.com/github/voormedia/rails-erd)
 
 [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.
 
@@ -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>
@@ -44,7 +46,7 @@ Rails ERD has the ability to be configured via the command line or through the u
 ```yaml
 attributes:
   - content
-  - foreign_key
+  - foreign_keys
   - inheritance
 disconnected: true
 filename: erd
@@ -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 built. 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

@@ -78,8 +78,8 @@ module RailsERD
       # relationship.
       def foreign_key?
         @domain.relationships_by_entity_name(@model.name).map(&:associations).flatten.map { |associaton|
-          associaton.send(Domain.foreign_key_method_name)
-        }.include?(name)
+          associaton.send(Domain.foreign_key_method_name).to_sym
+        }.include?(name.to_sym)
       end
 
       # Returns +true+ if this attribute is used for single table inheritance.
@@ -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

@@ -120,7 +120,32 @@ module RailsERD
     end
 
     def models
-      @models ||= @source_models.select { |model| check_model_validity(model) }.reject { |model| check_habtm_model(model) }
+      @models ||= @source_models
+                    .reject { |model| tableless_rails_models.include?(model) }
+                    .select { |model| check_model_validity(model) }
+                    .reject { |model| check_habtm_model(model) }
+    end
+
+    # Returns Rails model classes defined in the app
+    def rails_models
+      %w(
+        ActionMailbox::InboundEmail
+        ActiveStorage::Attachment
+        ActiveStorage::Blob
+        ActiveStorage::VariantRecord
+        ActionText::RichText
+        ActionText::EncryptedRichText
+      ).map{ |model| Object.const_get(model) rescue nil }.compact
+    end
+
+    def tableless_rails_models
+      @tableless_rails_models ||= begin
+        if defined? Rails
+          rails_models.reject{ |model| model.table_exists? }
+        else
+          []
+        end
+      end
     end
 
     def associations

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.1"
+  VERSION = "1.7.2"
   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

@@ -34,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
@@ -47,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!
@@ -82,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)
@@ -212,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/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/domain_test.rb

@@ -283,4 +283,14 @@ class DomainTest < ActiveSupport::TestCase
     end
     assert_match(/Ignoring invalid model Foo \(table foos does not exist\)/, output)
   end
+
+  test "entities should not output a warning when a Rails model table does not exist" do
+    module ActionMailbox; end
+
+    Object.const_set :InboundEmail, ActionMailbox
+    output = collect_stdout do
+      Domain.generate.entities
+    end
+    assert_equal "", output
+  end
 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-erd
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Rolf Timmermans
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -162,8 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.14
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: Entity-relationship diagram for your Rails models.