rails_model_viz 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d7286f0c8faf1b1a2110ddd83d629e60da4c30066e4628a9f4c7ef225735f63
-  data.tar.gz: 9a523bf923177660563d8fb3ae3bdaebba962a3e8bd34f845eda598066659d92
+  metadata.gz: 555d1be09e597009a4331ff9f6ffc36f0fc2653c0c70308f0327f521cf98ced6
+  data.tar.gz: 5c345818a3d34674a1169ba538edbd22205c911a6820f58b3053da45ce92b046
 SHA512:
-  metadata.gz: 9681fb9367802103df78dcc80e273644a5b900a55cbaf2f9aee2764589c0240e2382b54d01c1fe459f823ca6b55729eb21f5c210af8ae065fca81091bce733c3
-  data.tar.gz: 69da66c4d72f8a891067b5eb1632e6984e7fc2027fd9ea4e478b8d51cd7c71fff5db3e51e128547c12c0397bf7d2fcccda2932afa84adf96c1b7d12fbfc3b995
+  metadata.gz: 4bd9f1de678047d167a147a77b29f6ac09e023013b7f4c95f6ea79a0adca34663d5cbd7d93d77d62d5e3cf845f9e76223aaf3e148a58ae8089f31db5a708e3cb
+  data.tar.gz: 6f15e86bf00f35bba4e497207837cf03c805fcbfaad2ba8eea0a9f9ab63279f53031eb961d7bd0c3a9da6de463fd4743881db3503b94dfa25df426ee34fab8b1

data/app/controllers/rails_model_viz/graph_controller.rb

@@ -6,7 +6,6 @@ module RailsModelViz
       @mode = params[:mode] || 'relations'
       models = ApplicationRecord.descendants
 
-      # Generate text for Mermaid's ER diagram
       @mermaid_text = build_mermaid_text(models, @mode)
     end
 
@@ -18,78 +17,64 @@ module RailsModelViz
     end
 
     def build_graph_data(models, mode)
-      # For erDiagram, we assemble the list of columns each model has
-      # and information about their associations
       nodes = []
-      edges = []
+      edges = Set.new  # Use a Set to avoid duplicates
 
       models.each do |model|
-        # Retrieve columns only when mode=='columns' to include details
+        sanitized_model_name = sanitize_model_name(model.name)
+
+        # Get columns if mode == 'columns'
         columns = []
         if mode == 'columns'
           model.load_schema
           columns = model.columns.map { |col| [col.name, col.type.to_s] }
         end
 
-        # Node (table) information
+        # Node info
         nodes << {
-          id: model.name,   # e.g., "User"
-          columns: columns  # e.g., [ ["id","integer"], ["name","string"], ... ]
+          id: sanitized_model_name,  # e.g. "User" or "PaperTrail_Version"
+          columns: columns
         }
 
-        # Gather associations as edges
+        # Build edges for each association
         model.reflect_on_all_associations.each do |assoc|
-          # Polymorphic associations do not have a single definite class,
-          # so we treat them separately
-          if assoc.polymorphic?
-            edges << { from: model.name, to: "Polymorphic(#{assoc.name})", type: assoc.macro.to_s }
-          else
-            edges << { from: model.name, to: assoc.klass.name, type: assoc.macro.to_s }
+          from_name = sanitized_model_name
+          to_class  = assoc.polymorphic? ? "Polymorphic(#{assoc.name})" : assoc.klass.name
+          to_name   = sanitize_model_name(to_class)
+          rel_type  = assoc.macro.to_s  # "has_many", "belongs_to", etc.
+
+          # OPTIONAL: Skip self-referencing if not desired
+          # next if from_name == to_name
+
+          # Build a unique key so we don't add duplicates
+          edge_key = [from_name, to_name, rel_type]
+          unless edges.include?(edge_key)
+            edges << edge_key
           end
         end
       end
 
-      { nodes: nodes, edges: edges }
+      { nodes: nodes, edges: edges.to_a }  # convert Set back to an Array for rendering
     end
 
-    # ===========================================================================
-    # Build a Mermaid erDiagram notation string
-    # https://mermaid.js.org/syntax/entityRelationshipDiagram.html
-    #
-    #   erDiagram
-    #     TABLE_NAME {
-    #       column_name data_type
-    #       column_name data_type
-    #     }
-    #
-    #     TABLE_NAME ||--|{ OTHER_TABLE : "relationship"
-    # ===========================================================================
+    # ------------------------------------------------------
+    # Convert our graph data into Mermaid 'erDiagram' format
+    # ------------------------------------------------------
     def to_mermaid_er_diagram(graph_data)
       mermaid = "erDiagram\n"
 
       # (1) Define each table (entity)
       graph_data[:nodes].each do |node|
         mermaid << "  #{node[:id]} {\n"
-
-        # Output field definitions only if node[:columns] is present
-        node[:columns].each do |(col_name, col_type)|
-          # For example: "id integer", "name string", etc.
+        node[:columns].each do |col_name, col_type|
           mermaid << "    #{col_name} #{col_type}\n"
         end
-
         mermaid << "  }\n\n"
       end
 
-      # (2) Define relationships
-      #    ER notation like "||--||" indicates multiplicity (1, n, etc.)
-      graph_data[:edges].each do |edge|
-        from = edge[:from]
-        to   = edge[:to]
-        rel_type = edge[:type]  # e.g. "has_many", "belongs_to"
-
-        # Convert association type to an ER diagram multiplicity symbol
+      # (2) Define relationships (edges)
+      graph_data[:edges].each do |(from, to, rel_type)|
         cardinality = map_assoc_to_er_cardinality(rel_type)
-
         # Example: User ||--|{ Post : "has_many"
         mermaid << "  #{from} #{cardinality} #{to} : \"#{rel_type}\"\n"
       end
@@ -97,13 +82,11 @@ module RailsModelViz
       mermaid
     end
 
-    # Map association types to ER diagram cardinality symbols:
-    #  - belongs_to → 1-to-many from the other side, often "||--|{"
-    #  - has_many   → 1-to-many
-    #  - has_one    → 1-to-1
-    #  - has_and_belongs_to_many → many-to-many
+    # ------------------------------------------------------
+    # Map Rails association to Mermaid ER cardinality symbol
+    # ------------------------------------------------------
     def map_assoc_to_er_cardinality(rel_type)
-      case rel_type.to_s
+      case rel_type
       when "belongs_to"
         "||--|{"
       when "has_many"
@@ -113,8 +96,16 @@ module RailsModelViz
       when "has_and_belongs_to_many"
         "}o--o{"
       else
-        "||--||"  # Default to 1-to-1
+        "||--||"  # default to 1-to-1
       end
     end
+
+    # ------------------------------------------------
+    # Sanitize model/association names for Mermaid
+    # Replace :: with _ to prevent syntax errors
+    # ------------------------------------------------
+    def sanitize_model_name(name)
+      name.gsub("::", "_")
+    end
   end
 end

data/lib/rails_model_viz/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsModelViz
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_model_viz
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Peter Takahashi