rails-erd 1.7.2 → 2.0.0

data/test/unit/mermaid_test.rb

@@ -0,0 +1,388 @@
+require File.expand_path("../test_helper", File.dirname(__FILE__))
+require "rails_erd/diagram/mermaid"
+
+class MermaidTest < ActiveSupport::TestCase
+  def setup
+    RailsERD.options.filetype = :png
+    RailsERD.options.warn     = false
+    RailsERD.options.mermaid_style = :classdiagram
+  end
+
+  def teardown
+    FileUtils.rm Dir["erd*.*"] rescue nil
+  end
+
+  def diagram(options = {})
+    @diagram ||= Diagram::Mermaid.new(Domain.generate(options), options).tap do |diagram|
+      diagram.generate
+    end
+  end
+
+  def find_dot_nodes(diagram)
+    [].tap do |nodes|
+      diagram.graph.each_node do |name, node|
+        nodes << node
+      end
+    end
+  end
+
+  # Diagram properties =======================================================
+  test "file name should be mmd" do
+    create_simple_domain
+    begin
+      assert_equal "erd.mmd", Diagram::Mermaid.create
+    ensure
+      FileUtils.rm "erd.mmd" rescue nil
+    end
+  end
+
+  test "direction should be top to bottom by default" do
+    create_simple_domain
+
+    assert_equal "\tdirection TB", diagram.graph[1]
+  end
+
+  test "direction should be left to right when orientation is vertical" do
+    create_simple_domain
+
+    d = Diagram::Mermaid.new(Domain.generate, orientation: :vertical).tap { |diag| diag.generate }
+    assert_equal "\tdirection LR", d.graph[1]
+  end
+
+
+  # # Diagram generation =======================================================
+  test "create should create output for domain with attributes" do
+    create_model "Foo", :bar => :references, :column => :string do
+      belongs_to :bar
+    end
+
+    create_model "Bar", :column => :string
+
+    expected = [
+      "classDiagram",
+      "\tdirection TB",
+      "\tclass `Bar`",
+      "\t`Bar` : +string column",
+      "\tclass `Foo`",
+      "\t`Foo` : +string column",
+      "\t`Bar` --> `Foo`"
+    ]
+
+    assert_equal expected, diagram.graph
+  end
+
+  test "create should create output for domain without attributes" do
+    create_simple_domain
+
+    expected = [
+      "classDiagram",
+      "\tdirection TB",
+      "\tclass `Bar`",
+      "\tclass `Beer`",
+      "\t`Bar` --> `Beer`"
+    ]
+
+    assert_equal expected, diagram.graph
+  end
+
+  test "create should abort and complain if there are no connected models" do
+    message = nil
+    begin
+      Diagram::Mermaid.create
+    rescue => e
+      message = e.message
+    end
+    assert_match(/No entities found/, message)
+  end
+
+  test "create should abort and complain if output directory does not exist" do
+    message = nil
+
+    begin
+      create_simple_domain
+      Diagram::Mermaid.create(:filename => "does_not_exist/foo")
+    rescue => e
+      message = e.message
+    end
+
+    assert_match(/Output directory 'does_not_exist' does not exist/, message)
+  end
+
+  test "generate should add attributes to entity" do
+    RailsERD.options.markup = false
+    create_model "Foo", :bar => :references do
+      belongs_to :bar
+    end
+    create_model "Bar", :column => :string, :column_two => :boolean
+
+    expected = [
+      "classDiagram",
+      "\tdirection TB",
+      "\tclass `Bar`",
+      "\t`Bar` : +string column",
+      "\t`Bar` : +boolean column_two",
+      "\tclass `Foo`",
+      "\t`Bar` --> `Foo`"
+    ]
+
+    assert_equal expected, diagram.graph
+  end
+
+  test "generate should not add any attributes if attributes is set to false" do
+    create_model "Jar", :contents => :string
+    create_model "Lid", :jar => :references do
+      belongs_to :jar
+    end
+
+    expected = [
+      "classDiagram",
+      "\tdirection TB",
+      "\tclass `Jar`",
+      "\tclass `Lid`",
+      "\t`Jar` --> `Lid`"
+    ]
+
+    assert_equal expected, diagram(:attributes => false).graph
+  end
+
+  test "generate should create edge to polymorphic entity if polymorphism is true" do
+    create_model "Cannon", :defensible => :references do
+      belongs_to :defensible, :polymorphic => true
+    end
+
+    create_model "Stronghold" do
+      has_many :cannons, :as => :defensible
+    end
+
+    create_model "Galleon" do
+      has_many :cannons, :as => :defensible
+    end
+
+    expected = [
+      "classDiagram",
+      "\tdirection TB",
+      "\tclass `Cannon`",
+      "\tclass `Defensible`",
+      "\tclass `Galleon`",
+      "\tclass `Stronghold`",
+      "\t<<polymorphic>> `Defensible`",
+      "\t Defensible <|-- Galleon",
+      "\t Defensible <|-- Stronghold",
+      "\t`Defensible` --> `Cannon`",
+      "\t`Galleon` --> `Cannon`",
+      "\t`Stronghold` --> `Cannon`"
+    ]
+
+    assert_equal expected, diagram(:polymorphism => true).graph.uniq
+  end
+
+  test "generate should create edge to each child of polymorphic entity if polymorphism is false" do
+    create_model "Cannon", :defensible => :references do
+      belongs_to :defensible, :polymorphic => true
+    end
+
+    create_model "Stronghold" do
+      has_many :cannons, :as => :defensible
+    end
+
+    create_model "Galleon" do
+      has_many :cannons, :as => :defensible
+    end
+
+    expected = [
+      "classDiagram",
+      "\tdirection TB",
+      "\tclass `Cannon`",
+      "\tclass `Galleon`",
+      "\tclass `Stronghold`",
+      "\t`Defensible` --> `Cannon`",
+      "\t`Galleon` --> `Cannon`",
+      "\t`Stronghold` --> `Cannon`"
+    ]
+    assert_equal expected, diagram.graph.uniq
+  end
+
+  test "generate should support one to many relationships" do
+    create_one_to_many_assoc_domain
+
+    expected = [
+      "classDiagram",
+      "\tdirection TB",
+      "\tclass `Many`",
+      "\tclass `One`",
+      "\t`One` --> `Many`"
+    ]
+
+    assert_equal expected, diagram.graph.uniq
+  end
+
+  test "generate should support one to many indirect relationships" do
+    create_model "Foo" do
+      has_many :bazs
+      has_many :bars
+    end
+
+    create_model "Bar", :foo => :references do
+      belongs_to :foo
+      has_many :bazs, :through => :foo
+    end
+
+    create_model "Baz", :foo => :references do
+      belongs_to :foo
+    end
+
+    expected = [
+      "classDiagram",
+      "\tdirection TB",
+      "\tclass `Bar`",
+      "\tclass `Baz`",
+      "\tclass `Foo`",
+      "\t`Foo` --> `Baz`",
+      "\t`Foo` --> `Bar`",
+      "\t`Bar` ..> `Baz`"
+    ]
+
+    assert_equal expected, diagram.graph.uniq
+  end
+
+  test "generate should support many to many relationships" do
+    create_many_to_many_assoc_domain
+
+    expected = [
+      "classDiagram",
+      "\tdirection TB",
+      "\tclass `Many`",
+      "\tclass `More`",
+      "\t`Many` <--> `More`"
+    ]
+
+    assert_equal expected, diagram.graph.uniq
+  end
+
+  test "generate should support one to one relationships" do
+    create_one_to_one_assoc_domain
+
+    expected = [
+      "classDiagram",
+      "\tdirection TB",
+      "\tclass `One`",
+      "\tclass `Other`",
+      "\t`One` -- `Other`"
+    ]
+
+    assert_equal expected, diagram.graph.uniq
+  end
+
+  test "generate should support one to one recursive relationships" do
+    create_model "Emperor" do
+      belongs_to :predecessor, :class_name => "Emperor"
+      has_one :successor, :class_name => "Emperor", :foreign_key => :predecessor_id
+    end
+
+    expected = [
+      "classDiagram",
+      "\tdirection TB",
+      "\tclass `Emperor`",
+      "\t`Emperor` -- `Emperor`"
+    ]
+
+    assert_equal expected, diagram.graph.uniq
+  end
+
+  # erDiagram tests ============================================================
+
+  test "erdiagram style should use erDiagram header" do
+    create_simple_domain
+
+    result = diagram(:mermaid_style => :erdiagram).graph.uniq
+
+    assert_equal "erDiagram", result[0]
+    assert_equal "\tdirection TB", result[1]
+    # Entity blocks are joined with newlines
+    assert result.any? { |line| line.include?("Bar {") }
+    assert result.any? { |line| line.include?("Beer {") }
+    # Relationship uses crow's foot notation
+    assert result.any? { |line| line.include?("Bar") && line.include?("Beer") && line.include?("--") }
+  end
+
+  test "erdiagram style should include attributes with PK/FK markers" do
+    create_model "Foo", :bar => :references, :column => :string do
+      belongs_to :bar
+    end
+
+    create_model "Bar", :column => :string
+
+    result = diagram(:mermaid_style => :erdiagram, :attributes => [:primary_keys, :foreign_keys, :content]).graph.join("\n")
+
+    assert result.include?("erDiagram")
+    assert result.include?("id PK"), "Should include primary key marker"
+    assert result.include?("bar_id FK"), "Should include foreign key marker"
+  end
+
+  test "erdiagram style should use crow's foot notation for one to many" do
+    create_one_to_many_assoc_domain
+
+    result = diagram(:mermaid_style => :erdiagram).graph.uniq
+
+    assert result.include?("erDiagram")
+    # One to many should have }| or }o on the "many" side
+    relationship_line = result.find { |line| line.include?("One") && line.include?("Many") && line.include?("--") }
+    assert relationship_line, "Should have a relationship line between One and Many"
+    assert relationship_line.match?(/\}\||\}o/), "Should use crow's foot notation for many side"
+  end
+
+  test "erdiagram style should use crow's foot notation for many to many" do
+    create_many_to_many_assoc_domain
+
+    result = diagram(:mermaid_style => :erdiagram).graph.uniq
+
+    assert result.include?("erDiagram")
+    # Many to many should have }| or }o on both sides
+    relationship_line = result.find { |line| line.include?("Many") && line.include?("More") && line.include?("--") }
+    assert relationship_line, "Should have a relationship line between Many and More"
+  end
+
+  test "erdiagram style should use crow's foot notation for one to one" do
+    create_one_to_one_assoc_domain
+
+    result = diagram(:mermaid_style => :erdiagram).graph.uniq
+
+    assert result.any? { |line| line.include?("erDiagram") }
+    # One to one should have | on both sides (not })
+    relationship_line = result.find { |line| line.include?("One") && line.include?("Other") && line.include?("--") }
+    assert relationship_line, "Should have a relationship line between One and Other"
+    # Should not have } which indicates "many"
+    refute relationship_line.include?("}"), "One-to-one should not use } (many) notation: #{relationship_line}"
+  end
+
+  test "erdiagram style should use dotted line for indirect relationships" do
+    create_model "Foo" do
+      has_many :bazs
+      has_many :bars
+    end
+
+    create_model "Bar", :foo => :references do
+      belongs_to :foo
+      has_many :bazs, :through => :foo
+    end
+
+    create_model "Baz", :foo => :references do
+      belongs_to :foo
+    end
+
+    result = diagram(:mermaid_style => :erdiagram).graph.uniq
+
+    # Indirect relationship should use .. instead of --
+    indirect_line = result.find { |line| line.include?("Bar") && line.include?("Baz") }
+    assert indirect_line, "Should have a relationship line between Bar and Baz"
+    assert indirect_line.include?(".."), "Indirect relationship should use dotted line"
+  end
+
+  test "er option alias should work same as erdiagram" do
+    create_simple_domain
+
+    result = diagram(:mermaid_style => :er).graph
+
+    assert result.include?("erDiagram")
+  end
+end

data/test/unit/rake_task_test.rb

@@ -1,4 +1,6 @@
 require File.expand_path("../test_helper", File.dirname(__FILE__))
+require "rails_erd/diagram/graphviz"
+require "rails_erd/diagram/mermaid"
 
 class RakeTaskTest < ActiveSupport::TestCase
   include ActiveSupport::Testing::Isolation
@@ -32,10 +34,20 @@ class RakeTaskTest < ActiveSupport::TestCase
   end
 
   # Diagram generation =======================================================
-  test "generate task should create output based on domain model" do
+  test "generate task should create output based on domain model with graphviz by default" do
     create_simple_domain
 
     Diagram.any_instance.expects(:save)
+    Rake::Task["erd:options"].execute
+    Rake::Task["erd:generate"].execute
+  end
+
+  test "generate task should create output based on domain model with mermaid" do
+    create_simple_domain
+
+    ENV["generator"] = "mermaid"
+    RailsERD::Diagram::Mermaid.any_instance.expects(:save)
+    Rake::Task["erd:options"].execute
     Rake::Task["erd:generate"].execute
   end
 
@@ -101,7 +113,7 @@ class RakeTaskTest < ActiveSupport::TestCase
     rescue => e
       message = e.message
     end
-    assert_match(/#{Regexp.escape(<<-MSG.strip).gsub("xxx", ".*?")}/, message
+    assert_match(/#{Regexp.escape(<<-MSG.strip).gsub("`xxx'", "(`|').*?")}/, message
 Loading models failed!
 Error occurred while loading application: FooBar (RuntimeError)
     test/unit/rake_task_test.rb:#{l1}:in `xxx'
@@ -186,6 +198,15 @@ Error occurred while loading application: FooBar (RuntimeError)
     assert_equal :test, RailsERD.options.only_recursion_depth
   end
 
+  test "options task sets generator type" do
+    Rake::Task["erd:options"].execute
+    assert_equal :mermaid, RailsERD.options.generator
+
+    ENV["generator"] = "graphviz"
+    Rake::Task["erd:options"].execute
+    assert_equal :graphviz, RailsERD.options.generator
+  end
+
   test "options task should set single parameter to only as array xxx" do
     ENV["only"] = "model"
     Rake::Task["erd:options"].execute

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-erd
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Rolf Timmermans
 - Kerri Miller
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,56 +16,70 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: ruby-graphviz
+  name: choice
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: choice
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +130,7 @@ files:
 - lib/rails_erd/config.rb
 - lib/rails_erd/diagram.rb
 - lib/rails_erd/diagram/graphviz.rb
+- lib/rails_erd/diagram/mermaid.rb
 - lib/rails_erd/diagram/templates/node.html.erb
 - lib/rails_erd/diagram/templates/node.record.erb
 - lib/rails_erd/domain.rb
@@ -130,16 +144,19 @@ files:
 - lib/rails_erd/version.rb
 - lib/tasks/auto_generate_diagram.rake
 - test/support_files/erdconfig.another_example
+- test/support_files/erdconfig.empty
 - test/support_files/erdconfig.example
 - test/support_files/erdconfig.exclude.example
 - test/test_helper.rb
 - test/unit/attribute_test.rb
 - test/unit/cardinality_test.rb
+- test/unit/cli_test.rb
 - test/unit/config_test.rb
 - test/unit/diagram_test.rb
 - test/unit/domain_test.rb
 - test/unit/entity_test.rb
 - test/unit/graphviz_test.rb
+- test/unit/mermaid_test.rb
 - test/unit/rake_task_test.rb
 - test/unit/relationship_test.rb
 - test/unit/specialization_test.rb
@@ -147,7 +164,6 @@ homepage: https://github.com/voormedia/rails-erd
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -155,29 +171,31 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.15
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Entity-relationship diagram for your Rails models.
 test_files:
 - test/support_files/erdconfig.another_example
+- test/support_files/erdconfig.empty
 - test/support_files/erdconfig.example
 - test/support_files/erdconfig.exclude.example
 - test/test_helper.rb
 - test/unit/attribute_test.rb
 - test/unit/cardinality_test.rb
+- test/unit/cli_test.rb
 - test/unit/config_test.rb
 - test/unit/diagram_test.rb
 - test/unit/domain_test.rb
 - test/unit/entity_test.rb
 - test/unit/graphviz_test.rb
+- test/unit/mermaid_test.rb
 - test/unit/rake_task_test.rb
 - test/unit/relationship_test.rb
 - test/unit/specialization_test.rb