rails_graph 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f0e310d51090d130b13e29719da0379cbc968b6a6438f3d412059286d70c1b7
-  data.tar.gz: a8e0b5adfb146a711cd8377581a653a747d6c78084b92242f99f2962e0c02471
+  metadata.gz: 2aa9e5821416a34e7eca9ba18199bea6007190821c50cabb84147db6232b06e2
+  data.tar.gz: f54cb43940dba30d7ddc5915cb8669601d0e05b9b5eb4582c18a504859101ed0
 SHA512:
-  metadata.gz: c964bc4dfd48309e1602fad6acdd68cccf6cd7276424b863e56b2058c4a10b4ce2a280017f316c160402507bb86bdc3d9665ae0de9c2876b039e2ab858e49c29
-  data.tar.gz: 04e5f5a29a22c4fda077844de345e8feb6ca7d04b502b1f62209f3c3f310f7eace577906e7e56dd5aa330fd3d4679fcf7d97da08b5597c0a471b26117032c15c
+  metadata.gz: 714e4e3d097f8fda7958665d9f4f8ee0ca78978ecab77be2a59ad84fa1921c3204ae93d111072882068ce33ee3966786a3d7473d787e275077d61785f105815a
+  data.tar.gz: f3889f7437868743a38971f1808e2b3e9d6ac8445a8567f3e96ebb7722d35a24795830f220bdf7eeb1940bfefe472c1cc33f2539a4bd380358af006ad4c62035

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_graph (0.2.0)
+    rails_graph (0.3.0)
       activerecord (>= 6.0, < 7.1)
       neo4j-ruby-driver (>= 4.4.0.alpha.8)
       railties (>= 6.0, < 7.1)
@@ -9,25 +9,25 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.0.4.3)
-      actionview (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-      rack (~> 2.0, >= 2.2.0)
+    actionpack (7.0.5)
+      actionview (= 7.0.5)
+      activesupport (= 7.0.5)
+      rack (~> 2.0, >= 2.2.4)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (7.0.4.3)
-      activesupport (= 7.0.4.3)
+    actionview (7.0.5)
+      activesupport (= 7.0.5)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activerecord (7.0.4.3)
-      activemodel (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
-    activesupport (7.0.4.3)
+    activemodel (7.0.5)
+      activesupport (= 7.0.5)
+    activerecord (7.0.5)
+      activemodel (= 7.0.5)
+      activesupport (= 7.0.5)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -63,12 +63,12 @@ GEM
       async-io
       connection_pool
       zeitwerk (>= 2.1.10)
-    nokogiri (1.15.1)
+    nokogiri (1.15.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.15.1-arm64-darwin)
+    nokogiri (1.15.2-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.15.1-x86_64-linux)
+    nokogiri (1.15.2-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.2.1)
@@ -80,11 +80,12 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4.3)
-      actionpack (= 7.0.4.3)
-      activesupport (= 7.0.4.3)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.5)
+      actionpack (= 7.0.5)
+      activesupport (= 7.0.5)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)

data/lib/rails_graph/commands/build_graph.rb

@@ -21,6 +21,7 @@ require_relative "../graph/relationships/pack_model"
 require_relative "../helpers/associations"
 require_relative "../helpers/models"
 
+require_relative "./builders/associations"
 require_relative "./builders/models"
 require_relative "./builders/packs"
 require_relative "./builders/databases"
@@ -36,7 +37,8 @@ module RailsGraph
         setup_generic_nodes
 
         RailsGraph::Commands::Builders::Databases.enrich(graph: graph) if configuration.databases?
-        RailsGraph::Commands::Builders::Models.enrich(graph: graph, classes: classes, configuration: configuration)
+        RailsGraph::Commands::Builders::Models.enrich(inspector: inspector, graph: graph, classes: classes,
+                                                      configuration: configuration)
         RailsGraph::Commands::Builders::Packs.enrich(graph: graph) if configuration.include_packwerk?
 
         graph
@@ -44,12 +46,13 @@ module RailsGraph
 
       private
 
-      attr_reader :configuration, :classes, :graph
+      attr_reader :configuration, :classes, :graph, :inspector
 
       def initialize(configuration:)
         @configuration = configuration
         @classes = ActiveRecord::Base.descendants + configuration.include_classes
         @graph = RailsGraph::Graph::Graph.new
+        @inspector = RailsGraph::Inspector.new
       end
 
       def setup_generic_nodes

data/lib/rails_graph/commands/builders/associations.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module RailsGraph
+  module Commands
+    module Builders
+      class Associations
+        attr_reader :graph, :inspector
+
+        def self.enrich(...)
+          new(...).enrich
+        end
+
+        def enrich
+          build_associations_relationships
+        end
+
+        private
+
+        attr_reader :classes
+
+        def initialize(inspector:, graph:, classes:)
+          @inspector = inspector
+          @graph = graph
+          @classes = classes
+        end
+
+        def build_associations_relationships
+          classes.each do |model|
+            model.reflect_on_all_associations.each do |association|
+              association.check_validity!
+
+              source_node, target_node = fetch_association_nodes(graph, association)
+              next report_invalid_class(model) if source_node.nil? || target_node.nil?
+
+              add_relationship(association, source_node, target_node)
+            rescue ActiveRecord::ActiveRecordError => _e
+              report_invalid_association(association)
+            end
+          end
+        end
+
+        def fetch_association_nodes(graph, association)
+          source_node = RailsGraph::Helpers::Associations.source_node(graph, association)
+          target_node = RailsGraph::Helpers::Associations.target_node(graph, association)
+          [source_node, target_node]
+        end
+
+        def add_relationship(association, source_node, target_node)
+          relationship = RailsGraph::Graph::Relationships::Association.new(association, source_node, target_node)
+          graph.add_relationship(relationship)
+        end
+
+        def report_invalid_association(association)
+          inspector.add_association(association)
+        end
+
+        def report_invalid_class(klass)
+          inspector.add_class(klass)
+        end
+      end
+    end
+  end
+end

data/lib/rails_graph/commands/builders/models.rb

@@ -4,25 +4,29 @@ module RailsGraph
   module Commands
     module Builders
       class Models
-        def self.enrich(graph:, classes:, configuration:)
-          new(graph: graph, classes: classes, configuration: configuration).enrich
+        attr_reader :graph, :inspector
 
-          graph
+        def self.enrich(...)
+          new(...).enrich
         end
 
         def enrich
           build_model_nodes
-          build_associations_relationships
+          build_associations
           build_column_nodes if configuration.columns?
           build_model_table_relationships if configuration.databases?
           build_inheritance_relationships if configuration.inheritance?
+
+          inspector.log
+          graph
         end
 
         private
 
-        attr_reader :graph, :classes, :configuration
+        attr_reader :classes, :configuration
 
-        def initialize(graph:, classes:, configuration:)
+        def initialize(inspector:, graph:, classes:, configuration:)
+          @inspector = inspector
           @graph = graph
           @configuration = configuration
           @classes = classes
@@ -41,16 +45,8 @@ module RailsGraph
           end
         end
 
-        def build_associations_relationships
-          classes.each do |model|
-            model.reflect_on_all_associations.each do |association|
-              source_node = RailsGraph::Helpers::Associations.source_node(graph, association)
-              target_node = RailsGraph::Helpers::Associations.target_node(graph, association)
-
-              relationship = RailsGraph::Graph::Relationships::Association.new(association, source_node, target_node)
-              graph.add_relationship(relationship)
-            end
-          end
+        def build_associations
+          Builders::Associations.enrich(inspector: inspector, graph: graph, classes: classes)
         end
 
         def build_column_nodes
@@ -91,6 +87,7 @@ module RailsGraph
 
             identifier = RailsGraph::Helpers::Models.identifier(model)
             node = graph.node(identifier)
+
             relationship = build_represents_table_relationship(node, table_node)
             graph.add_relationship(relationship)
           end

data/lib/rails_graph/helpers/models.rb

@@ -6,6 +6,8 @@ module RailsGraph
       module_function
 
       def identifier(model)
+        return unless model
+
         model.to_s.delete_prefix("::")
       end
     end

data/lib/rails_graph/inspector.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "set"
+
+module RailsGraph
+  class Inspector
+    def initialize
+      @classes = Set.new
+      @associations = Set.new
+    end
+
+    def add_class(klass)
+      @classes.add(klass)
+    end
+
+    def add_association(association)
+      @associations.add(association)
+    end
+
+    def log
+      @classes.each do |klass|
+        puts "[WARN][RailsGraph]: Invalid class configuration: #{klass}"
+      end
+
+      @associations.each do |association|
+        puts "[WARN][RailsGraph]: #{association.name} association defined " \
+             "under #{association.active_record.name} class has invalid configurations!"
+      end
+    end
+  end
+end

data/lib/rails_graph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsGraph
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/rails_graph.rb

@@ -7,6 +7,7 @@ require "rails_graph/railtie"
 
 require "rails_graph/commands/build_graph"
 require "rails_graph/commands/export_graph"
+require "rails_graph/inspector"
 
 module RailsGraph
   module_function

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_graph
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ahmad Elassuty
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-22 00:00:00.000000000 Z
+date: 2023-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -85,6 +85,7 @@ files:
 - graph.svg
 - lib/rails_graph.rb
 - lib/rails_graph/commands/build_graph.rb
+- lib/rails_graph/commands/builders/associations.rb
 - lib/rails_graph/commands/builders/databases.rb
 - lib/rails_graph/commands/builders/models.rb
 - lib/rails_graph/commands/builders/packs.rb
@@ -114,6 +115,7 @@ files:
 - lib/rails_graph/helpers/associations.rb
 - lib/rails_graph/helpers/models.rb
 - lib/rails_graph/helpers/options_parser.rb
+- lib/rails_graph/inspector.rb
 - lib/rails_graph/railtie.rb
 - lib/rails_graph/tasks/rails_graph.rake
 - lib/rails_graph/version.rb