rails-erd 2.0.2 → 2.1.0

data/test/unit/domain_test.rb

@@ -151,6 +151,23 @@ class DomainTest < ActiveSupport::TestCase
     assert_equal ["Many", "More"], [relationship.source.name, relationship.destination.name]
   end
 
+  test "relationships should be deterministic regardless of model order" do
+    create_model "Author"
+    create_model "Book", :author => :references do
+      belongs_to :author
+      has_many :reviews
+    end
+    create_model "Review", :book => :references do
+      belongs_to :book
+    end
+    pairs = lambda do |models|
+      Domain.new(models).relationships.collect { |r| [r.source.name, r.destination.name] }
+    end
+    models = [Author, Book, Review]
+    # Order and source/destination direction must not depend on the input model order.
+    assert_equal pairs.call(models), pairs.call(models.reverse)
+  end
+
   # Specialization processing ================================================
   test "specializations should return empty array for empty domain" do
     assert_equal [], Domain.generate.specializations
@@ -301,4 +318,91 @@ class DomainTest < ActiveSupport::TestCase
     end
     assert_equal "", output
   end
+
+  # Pattern matching for exclude/only ==========================================
+  test "matches_pattern? should match exact string" do
+    domain = Domain.new([])
+    assert domain.send(:matches_pattern?, "Foo", "Foo")
+    refute domain.send(:matches_pattern?, "Foo", "Bar")
+  end
+
+  test "matches_pattern? should match glob pattern with asterisk" do
+    domain = Domain.new([])
+    assert domain.send(:matches_pattern?, "SolidQueue::*", "SolidQueue::Job")
+    assert domain.send(:matches_pattern?, "SolidQueue::*", "SolidQueue::Process")
+    refute domain.send(:matches_pattern?, "SolidQueue::*", "SolidCache::Entry")
+  end
+
+  test "matches_pattern? should match glob pattern without namespace separator" do
+    domain = Domain.new([])
+    assert domain.send(:matches_pattern?, "ActiveStorage*", "ActiveStorageBlob")
+    assert domain.send(:matches_pattern?, "ActiveStorage*", "ActiveStorage::Blob")
+    refute domain.send(:matches_pattern?, "ActiveStorage*", "ActionMailbox::InboundEmail")
+  end
+
+  test "matches_pattern? should match regex pattern" do
+    domain = Domain.new([])
+    assert domain.send(:matches_pattern?, "/^Active/", "ActiveRecord")
+    assert domain.send(:matches_pattern?, "/^Active/", "ActiveStorage::Blob")
+    refute domain.send(:matches_pattern?, "/^Active/", "SolidQueue::Job")
+  end
+
+  test "matches_pattern? should match regex pattern with flags" do
+    domain = Domain.new([])
+    assert domain.send(:matches_pattern?, "/queue/i", "SolidQueue::Job")
+    refute domain.send(:matches_pattern?, "/queue/", "SolidQueue::Job")
+  end
+
+  test "excluded_model? should match glob patterns" do
+    create_module_model "SolidQueue::Job"
+    create_module_model "SolidQueue::Process"
+    create_model "User"
+
+    domain = Domain.generate(:exclude => ["SolidQueue::*"])
+
+    # excluded_model? returns true for matching patterns
+    assert domain.send(:excluded_model?, SolidQueue::Job)
+    assert domain.send(:excluded_model?, SolidQueue::Process)
+    refute domain.send(:excluded_model?, User)
+  end
+
+  test "excluded_model? should match regex patterns" do
+    create_module_model "SolidQueue::Job"
+    create_model "User"
+
+    domain = Domain.generate(:exclude => ["/^Solid/"])
+    assert domain.send(:excluded_model?, SolidQueue::Job)
+    refute domain.send(:excluded_model?, User)
+  end
+
+  test "excluded_model? should still match exact names for backward compatibility" do
+    create_model "Foo"
+    create_model "Bar"
+
+    domain = Domain.generate(:exclude => ["Foo"])
+    assert domain.send(:excluded_model?, Foo)
+    refute domain.send(:excluded_model?, Bar)
+  end
+
+  test "excluded_association? should match glob patterns for source model" do
+    create_module_model "SolidQueue::Job" do
+      has_many :executions
+    end
+    create_model "User"
+
+    domain = Domain.generate(:exclude => ["SolidQueue::*"], :warn => false)
+    association = SolidQueue::Job.reflect_on_association(:executions)
+    assert domain.send(:excluded_association?, association)
+  end
+
+  test "excluded_association? should match glob patterns for target model" do
+    create_module_model "SolidQueue::Execution"
+    create_model "Task" do
+      has_many :executions, :class_name => "SolidQueue::Execution"
+    end
+
+    domain = Domain.generate(:exclude => ["SolidQueue::*"], :warn => false)
+    association = Task.reflect_on_association(:executions)
+    assert domain.send(:excluded_association?, association)
+  end
 end

data/test/unit/mermaid_test.rb

@@ -230,9 +230,9 @@ class MermaidTest < ActiveSupport::TestCase
       "\tclass `Bar`",
       "\tclass `Baz`",
       "\tclass `Foo`",
-      "\t`Foo` --> `Baz`",
       "\t`Foo` --> `Bar`",
-      "\t`Bar` ..> `Baz`"
+      "\t`Bar` ..> `Baz`",
+      "\t`Foo` --> `Baz`"
     ]
 
     assert_equal expected, diagram.graph.uniq
@@ -437,4 +437,126 @@ class MermaidTest < ActiveSupport::TestCase
     # Verify the specialization relationship line also quotes it
     assert result.match?(/Vehicle.*--.*"Transport::Car"/), "Specialization relationship should quote namespaced entity"
   end
+
+  # Namespace clustering tests (Issue #479) =====================================
+
+  test "classDiagram with cluster should group entities by namespace" do
+    create_model "Post"
+    create_module_model "Admin::Author", :post => :references do
+      belongs_to :post
+    end
+    create_module_model "Admin::Role"
+
+    result = diagram(:cluster => true).graph.join("\n")
+
+    assert result.include?("classDiagram")
+    # Should have namespace block for Admin
+    assert result.include?("namespace Admin {"), "Should have namespace block for Admin"
+    # Author and Role should be inside the Admin namespace
+    assert result.match?(/namespace Admin \{[^}]*class `Author`/m), "Author should be inside Admin namespace"
+    assert result.match?(/namespace Admin \{[^}]*class `Role`/m), "Role should be inside Admin namespace"
+  end
+
+  test "classDiagram with cluster should place entities without namespace outside blocks" do
+    create_model "Post"
+    create_module_model "Admin::Author", :post => :references do
+      belongs_to :post
+    end
+
+    result = diagram(:cluster => true).graph.join("\n")
+
+    # Post should appear before any namespace block
+    post_index = result.index("class `Post`")
+    namespace_index = result.index("namespace Admin {")
+    assert post_index < namespace_index, "Entities without namespace should appear before namespace blocks"
+  end
+
+  test "classDiagram with cluster should handle nested namespaces" do
+    create_model "Post"
+    create_module_model "Admin::Users::Role", :post => :references do
+      belongs_to :post
+    end
+
+    result = diagram(:cluster => true).graph.join("\n")
+
+    # Nested namespace should use dot notation (Admin.Users)
+    assert result.include?("namespace Admin.Users {"), "Should convert :: to . in namespace names"
+    assert result.match?(/namespace Admin\.Users \{[^}]*class `Role`/m), "Role should be inside Admin.Users namespace"
+  end
+
+  test "classDiagram with cluster should render relationships outside namespace blocks" do
+    create_model "Post"
+    create_module_model "Admin::Author", :post => :references do
+      belongs_to :post
+    end
+
+    result = diagram(:cluster => true).graph.join("\n")
+
+    # Relationship should appear after the namespace block closes
+    namespace_close_index = result.index("}")
+    relationship_index = result.index("`Post` --> `Admin::Author`")
+    assert relationship_index > namespace_close_index, "Relationships should appear after namespace blocks"
+  end
+
+  test "erDiagram with cluster should emit warning and render flat" do
+    create_model "Post"
+    create_module_model "Admin::Author", :post => :references do
+      belongs_to :post
+    end
+
+    test_diagram = nil
+
+    warning_output = collect_stdout do
+      domain = Domain.generate
+      test_diagram = Diagram::Mermaid.new(domain, :cluster => true, :mermaid_style => :erdiagram, :warn => true)
+      test_diagram.generate
+    end
+
+    result = test_diagram.graph.join("\n")
+
+    # Should emit warning about clustering not supported
+    assert warning_output.include?("Clustering is not supported"), "Should warn about clustering not supported in erDiagram"
+    # Should still render the diagram (flat, no namespace blocks)
+    assert result.include?("erDiagram")
+    refute result.include?("namespace"), "erDiagram should not have namespace blocks"
+  end
+
+  test "classDiagram with cluster false should not group entities" do
+    create_model "Post"
+    create_module_model "Admin::Author", :post => :references do
+      belongs_to :post
+    end
+
+    result = diagram(:cluster => false).graph.join("\n")
+
+    assert result.include?("classDiagram")
+    # Should NOT have namespace blocks
+    refute result.include?("namespace"), "cluster: false should not create namespace blocks"
+    # Should use full entity names
+    assert result.include?("class `Admin::Author`"), "Should use full entity name without clustering"
+  end
+
+  test "classDiagram with cluster and inheritance should emit entities before specializations" do
+    create_model "Vehicle", :type => :string
+    create_module_model "Transport::Car", Vehicle
+
+    result = diagram(:cluster => true, :inheritance => true).graph.join("\n")
+
+    # Entity class definitions should appear BEFORE specialization lines
+    vehicle_class_index = result.index("class `Vehicle`")
+    polymorphic_index = result.index("<<polymorphic>>")
+    inheritance_index = result.index("<|--")
+
+    assert vehicle_class_index, "Should have Vehicle class definition.\nGot:\n#{result}"
+    assert polymorphic_index, "Should have polymorphic marker.\nGot:\n#{result}"
+    assert inheritance_index, "Should have inheritance relationship.\nGot:\n#{result}"
+
+    # The key assertion: class definitions must come BEFORE specializations
+    assert vehicle_class_index < polymorphic_index,
+      "Class definitions should appear before polymorphic markers.\n" \
+      "Got:\n#{result}"
+    assert vehicle_class_index < inheritance_index,
+      "Class definitions should appear before inheritance relationships.\n" \
+      "Got:\n#{result}"
+  end
 end

data/test/unit/tbls_test.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require File.expand_path("../test_helper", File.dirname(__FILE__))
+require "rails_erd/diagram/tbls"
+require "json"
+
+class TblsTest < ActiveSupport::TestCase
+  def setup
+    RailsERD.options.warn = false
+  end
+
+  def diagram(options = {})
+    Diagram::Tbls.new(Domain.generate(options), options).tap(&:generate)
+  end
+
+  def payload(options = {})
+    diagram(options).send(:schema_payload)
+  end
+
+  def table(payload, name)
+    payload[:tables].find { |t| t[:name] == name }
+  end
+
+  def constraint(table, type)
+    table[:constraints].find { |c| c[:type] == type }
+  end
+
+  # File output ==============================================================
+  test "filename has json extension" do
+    create_simple_domain
+    result = Diagram::Tbls.create
+    assert result.end_with?(".json"), "Expected .json, got #{result}"
+  end
+
+  test "written file is valid JSON parseable by tbls schema shape" do
+    create_simple_domain
+    file = Diagram::Tbls.create
+    parsed = JSON.parse(File.read(file))
+
+    assert parsed.key?("tables")
+    assert parsed["tables"].is_a?(Array)
+    assert parsed["tables"].all? { |t| t.key?("name") && t.key?("columns") }
+  end
+
+  # Tables ===================================================================
+  test "emits one table per concrete entity using db table name" do
+    create_simple_domain
+    p = payload
+
+    names = p[:tables].map { |t| t[:name] }.sort
+    assert_equal %w[bars beers], names
+  end
+
+  test "columns carry name, type, nullable; default and comment only when set" do
+    create_model "Widget", name: :string, qty: :integer do
+      belongs_to :gizmo, optional: true
+    end
+    create_model "Gizmo"
+
+    widgets = table(payload, "widgets")
+    name_col = widgets[:columns].find { |c| c[:name] == "name" }
+
+    assert name_col[:type].start_with?("varchar"), "Expected varchar type, got #{name_col[:type]}"
+    assert_equal true, name_col[:nullable]
+    # tbls schema rejects null comments/defaults — they must be omitted, not nulled.
+    refute_includes name_col.keys, :default
+    refute_includes name_col.keys, :comment
+  end
+
+  # Primary keys =============================================================
+  test "every table gets a PRIMARY KEY constraint" do
+    create_simple_domain
+
+    table(payload, "beers")[:constraints].tap do |constraints|
+      pk = constraints.find { |c| c[:type] == "PRIMARY KEY" }
+      assert pk, "expected a PRIMARY KEY constraint"
+      assert_equal ["id"], pk[:columns]
+      assert_equal "beers_pkey", pk[:name]
+    end
+  end
+
+  # Foreign keys =============================================================
+  test "belongs_to becomes a FOREIGN KEY constraint on the owning table" do
+    create_simple_domain  # Beer belongs_to :bar
+
+    beers = table(payload, "beers")
+    fk = constraint(beers, "FOREIGN KEY")
+
+    assert fk, "expected a FOREIGN KEY constraint on beers"
+    assert_equal ["bar_id"], fk[:columns]
+    assert_equal "bars", fk[:referenced_table]
+    assert_equal ["id"], fk[:referenced_columns]
+  end
+
+  test "FK def string is parseable by tbls parser" do
+    create_simple_domain
+    fk = constraint(table(payload, "beers"), "FOREIGN KEY")
+
+    assert_equal "FOREIGN KEY (bar_id) REFERENCES bars(id)", fk[:def]
+  end
+
+  test "has_many side does not get an FK; only the belongs_to side does" do
+    create_one_to_many_assoc_domain  # One has_many :many; Many belongs_to :one
+
+    ones = table(payload, "ones")
+    manies = table(payload, "manies")
+
+    assert_nil constraint(ones, "FOREIGN KEY"), "owner side must not have an FK"
+    assert constraint(manies, "FOREIGN KEY"), "belongs_to side must have an FK"
+  end
+
+  test "polymorphic associations are skipped (no synthetic FK)" do
+    create_polymorphic_generalization  # Cannon belongs_to :defensible, polymorphic; Galleon has_many :cannons, as: :defensible
+
+    cannons = table(payload(polymorphism: true), "cannons")
+    assert_nil constraint(cannons, "FOREIGN KEY"),
+      "polymorphic belongs_to has no concrete target — must not emit FK"
+  end
+
+  test "indirect (has_many :through) relationships do not produce extra constraints" do
+    create_model "Author" do
+      has_many :authorships
+      has_many :books, through: :authorships
+    end
+    create_model "Book" do
+      has_many :authorships
+      has_many :authors, through: :authorships
+    end
+    create_model "Authorship", author: :references, book: :references do
+      belongs_to :author
+      belongs_to :book
+    end
+
+    authorships = table(payload, "authorships")
+    fk_targets = authorships[:constraints]
+      .select { |c| c[:type] == "FOREIGN KEY" }
+      .map { |c| c[:referenced_table] }
+      .sort
+
+    # Exactly two FKs — author + book — not duplicated by the indirect relationship.
+    assert_equal %w[authors books], fk_targets
+  end
+
+  # Schema-level payload =====================================================
+  test "top-level payload has a name and a tables array" do
+    create_simple_domain
+    p = payload
+
+    assert p[:name].is_a?(String) && !p[:name].empty?
+    assert p[:tables].is_a?(Array)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-erd
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Rolf Timmermans
@@ -118,6 +118,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGES.md
+- LICENSE.md
 - README.md
 - Rakefile
 - bin/erd
@@ -131,6 +133,7 @@ files:
 - lib/rails_erd/diagram.rb
 - lib/rails_erd/diagram/graphviz.rb
 - lib/rails_erd/diagram/mermaid.rb
+- lib/rails_erd/diagram/tbls.rb
 - lib/rails_erd/diagram/templates/node.html.erb
 - lib/rails_erd/diagram/templates/node.record.erb
 - lib/rails_erd/domain.rb
@@ -160,6 +163,7 @@ files:
 - test/unit/rake_task_test.rb
 - test/unit/relationship_test.rb
 - test/unit/specialization_test.rb
+- test/unit/tbls_test.rb
 homepage: https://github.com/voormedia/rails-erd
 licenses:
 - MIT
@@ -178,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.13
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Entity-relationship diagram for your Rails models.
 test_files:
@@ -199,3 +203,4 @@ test_files:
 - test/unit/rake_task_test.rb
 - test/unit/relationship_test.rb
 - test/unit/specialization_test.rb
+- test/unit/tbls_test.rb