rails-erd 1.4.7 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e10c973dc76bbb05773bc6920678cc060878c740
-  data.tar.gz: 42af4a884c51e266b993d255a49e2647c2d4e368
+  metadata.gz: 624c7ed61b6bbe81a043bae64969f6bb1b6dd6f5
+  data.tar.gz: e3bf81680b796b264ac3d761d8ca8f13a0f4b9f9
 SHA512:
-  metadata.gz: 9dbb498dd6dbfb15a243d3957e5172ab0fb6ffb54c39ba5ba4aac13ea7fb8a38d2272e07fd6b8b67651e39ed842620757b387c23cd77f4325d1736e3e5706efe
-  data.tar.gz: ca3b2a15e3db16434341e6d8c2b439b0a97fcfd9ed0304b5eaf07d1e571b11d82ff44a0ffc6fbd352d0dbae8eb7c380b98beaef57d3ffe16ced26a7f4cbf4b81
+  metadata.gz: f4ec67e46803ac4c48801278c2f96e148c6f076d494ca0c16411f3a45f2fd517989ceacc42518315c22a34bb3e235ccfc4a841051d5022688f4f87897fe7b1fc
+  data.tar.gz: 9d7fdca071d98d557a0217659bee5a4550b6edb60a6850267050f9c591ae4b8eae2df3b787693cd78985aafd182f9b87a3de8f14262543596e037fd5c7f942e9

data/README.md

@@ -6,7 +6,7 @@ Rails ERD - Generate Entity-Relationship Diagrams for Rails applications
 
 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
@@ -60,7 +60,9 @@ warn: true
 title: sample title
 exclude: null
 only: null
+only_recursion_depth: null
 prepend_primary: false
+cluster: false
 ```
 
 

data/lib/rails_erd.rb

@@ -51,7 +51,9 @@ module RailsERD
         :title, true,
         :exclude, nil,
         :only, nil,
-        :prepend_primary, false
+        :only_recursion_depth, nil,
+        :prepend_primary, false,
+        :cluster, false,
       ]
     end
   end

data/lib/rails_erd/cli.rb

@@ -49,6 +49,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 +69,11 @@ 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
+
   separator ""
   separator "Output options:"
 
@@ -149,9 +159,14 @@ 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
+      Rails.application.eager_load! if defined? Rails
     rescue TypeError
     end
 

data/lib/rails_erd/config.rb

@@ -63,8 +63,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

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

data/lib/rails_erd/diagram/graphviz.rb

@@ -210,7 +210,14 @@ 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 = graph.get_graph(cluster_name) ||
+                    graph.add_graph(cluster_name, label: entity.namespace)
+          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 +240,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)

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
+        name.scan(/(.*)::.*/).dig(0,0)
+      end
+
       def to_s # @private :nodoc:
         name
       end

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/version.rb

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

data/test/test_helper.rb

@@ -146,6 +146,7 @@ class ActiveSupport::TestCase
   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
       end

data/test/unit/attribute_test.rb

@@ -4,6 +4,7 @@ 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
+      undef :native_database_types
       define_method :native_database_types do
         super().tap do |types|
           types[type][:limit] = new_limit
@@ -13,6 +14,7 @@ class AttributeTest < ActiveSupport::TestCase
     yield
   ensure
     ActiveRecord::Base.connection.class_eval do
+      undef :native_database_types
       define_method :native_database_types do
         super()
       end

data/test/unit/domain_test.rb

@@ -186,6 +186,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

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

data/test/unit/rake_task_test.rb

@@ -40,7 +40,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-erd
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.5.0
 platform: ruby
 authors:
 - Rolf Timmermans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-19 00:00:00.000000000 Z
+date: 2016-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Entity-relationship diagram for your Rails models.