rails-mermaid_erd_markdown 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfe4cfb73051e0344b160e2e9287e90f7d889df66b7d3b6e9079b7e88ecb10d7
-  data.tar.gz: a1294a4857655459f3ec8645d2244e55baed98af7e2cb35f34b875938f49a728
+  metadata.gz: a1334a132131725a23b89678a03b5a74ce0d8eb1feda6f737d0aff4d25534001
+  data.tar.gz: 77267051ff9f9e18a73ba908be5ba477b29688b94f9714463f032ad2208e41de
 SHA512:
-  metadata.gz: 91b221902d1427114ac9952f27a6e2cef2b77bf3bba43c993196831044df51a61a0b5dac80e2e08ccb5bab4ff6f8786bcf2c8ae4c44548e1012efda3c49bbf63
-  data.tar.gz: e9d74b83778f23b076313a19df14c970fd439e9507d6cc5e82fe83cb29501f5de33e73806390b4f792f9ebef3ab9f57849e212b1184f4ec926863632b77943af
+  metadata.gz: ddf34c03bde1e6377faab02252e48c677a23b49f54cb01e66d6cc68edfdca9a1b9de95b2bd20fb40e5244c83e055736da54208669e31f1dfd0acaf15cd5e17d5
+  data.tar.gz: 9da5893f0c23fca841e638c7886716e06f44156b5bf4cf54661806cddd039896227fddfa2c44f822dd04dd88db9dee7df58a8f4697b7bd58992791c3bdd4d6a3

data/CHANGELOG.md

@@ -17,4 +17,7 @@
 - Change rails-mermaid_erd version dependency to at least 0.4.2
 
 ## [0.3.2] - 2024-08-10
-- (HOTFIX) Fix bundler + lockfile out-of-sync issues
+- (HOTFIX) Fix bundler + lockfile out-of-sync issues
+
+## [0.4.0] - 2024-08-31
+- [Feature] Filter out specified models from ERDs

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails-mermaid_erd_markdown (0.3.2)
+    rails-mermaid_erd_markdown (0.4.0)
       rails (>= 5.2)
       rails-mermaid_erd (>= 0.4.2)
 

data/README.md

@@ -1,8 +1,8 @@
 # rails-mermaid_erd_markdown
 
-A Ruby on Rails gem that extends rails-mermaid_erd to generate mermaid Entity-Relationship Diagrams (ERD) for ActiveRecord Models. When combined with Continuous Integration (CI) pipelines, it enables one to generate living, self-updating documentation of their data. 
+A Ruby on Rails gem that extends [rails-mermaid_erd](https://github.com/koedame/rails-mermaid_erd) to generate mermaid Entity-Relationship Diagrams (ERD) for ActiveRecord Models in markdown. When combined with Continuous Integration (CI) pipelines, it enables one to generate living, self-updating documentation of their data. 
 
-## Example ERD
+## Example Entity-Relationship Diagram
 
 ```mermaid
 erDiagram
@@ -67,11 +67,16 @@ erd:
     output_path: 'app/ERD.md' # Set output path of ERDs, default: 'app/ERD.md'
     split_output: false, # Generates individual ERDs for each model with a specified depth, default: false
     relationship_depth: 1 # Configured depth of individual ERD model generation, default: 1
+    ignored_models: # Models to be filtered out of all ERDs (case-sensitive), default: []
+        - Article 
+        - Comment
 
 ```
 
 If your entity diagram is too large to be displayed you can set a `split_output` configuration to `true` to generate multiple ERD files based on each model in your project. 
 
+Or you can specify the models to be filtered out of the ERDs using `ignored_models`
+
 You can also set a `relationship_depth` configuration to include more than 1 level (the default) of associations in each document.
 
 

data/docs/examples/erd.yml

@@ -2,3 +2,6 @@ erd:
     output_path: 'app/ERD.md' # Set output path of ERDs, default: 'app/ERD.md'
     split_output: false, # Generates individual ERDs for each model with a specified depth, default: false
     relationship_depth: 1 # Configured depth of individual ERD model generation, default: 1
+    ignored_models: # Models to be filtered out of all ERDs (case-sensitive)
+        - Article
+        - Comment

data/lib/rails-mermaid_erd_markdown/configuration.rb

@@ -4,13 +4,14 @@ require "yaml"
 
 module MermaidErdMarkdown
   class Configuration
-    attr_accessor :output_path, :split_output, :relationship_depth
+    attr_accessor :output_path, :split_output, :relationship_depth, :ignored_models
 
     def initialize
       config = {
         output_path: "app/models/ERD.md",
         split_output: false,
-        relationship_depth: 1
+        relationship_depth: 1,
+        ignored_models: []
       }
       erd_config_path = "erd.yml"
 
@@ -19,10 +20,12 @@ module MermaidErdMarkdown
         @output_path = erd_yml["erd"]["output_path"] || config[:output_path]
         @split_output = erd_yml["erd"]["split_output"] || config[:split_output]
         @relationship_depth = erd_yml["erd"]["relationship_depth"] || config[:relationship_depth]
+        @ignored_models = erd_yml["erd"]["ignored_models"] || config[:ignored_models]
       rescue StandardError
         @output_path = config[:output_path]
         @split_output = config[:split_output]
         @relationship_depth = config[:relationship_depth]
+        @ignored_models = config[:ignored_models]
       end
     end
   end

data/lib/rails-mermaid_erd_markdown/source_data.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
 require "rails-mermaid_erd"
+require "active_support"
+require "active_support/core_ext/enumerable"
+require "active_support/core_ext/object"
 
 module MermaidErdMarkdown
   class SourceData
     def data
-      @data ||= RailsMermaidErd::Builder.model_data
+      @data ||= generate_model_data
     end
 
     def split_output(depth = 1)
@@ -41,6 +44,37 @@ module MermaidErdMarkdown
 
     private
 
+    def configuration
+      @configuration ||= MermaidErdMarkdown::Configuration.new
+    end
+
+    def generate_model_data
+      raw_data = RailsMermaidErd::Builder.model_data
+
+      return raw_data unless filter_model_data?
+
+      filter_model_data(raw_data)
+    end
+
+    def filter_model_data?
+      configuration.ignored_models.present?
+    end
+
+    def filter_model_data(raw_data)
+      filtered_data = {}
+      filtered_data[:Models] = raw_data[:Models].select do |model_hash|
+        not_filtered?(model_hash[:ModelName])
+      end
+      filtered_data[:Relations] = raw_data[:Relations].select do |relation_hash|
+        not_filtered?(relation_hash[:LeftModelName]) && not_filtered?(relation_hash[:RightModelName])
+      end
+      filtered_data
+    end
+
+    def not_filtered?(model_name)
+      configuration.ignored_models.exclude?(model_name)
+    end
+
     def models(model_names, source_models)
       model_names.map do |model_name|
         source_models.find { |m| m[:ModelName] == model_name }

data/lib/rails-mermaid_erd_markdown/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MermaidErdMarkdown
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/test/mock_data/models.rb

@@ -54,7 +54,7 @@ module MockData
       }
     end
 
-    def article_relation
+    def article_user_relation
       {
         LeftModelName: "Article",
         LeftValue: "}o",
@@ -65,7 +65,7 @@ module MockData
       }
     end
 
-    def profile_relation
+    def profile_user_relation
       {
         LeftModelName: "Profile",
         LeftValue: "}o",
@@ -76,7 +76,7 @@ module MockData
       }
     end
 
-    def comment_relation
+    def comment_article_relation
       {
         LeftModelName: "Comment",
         LeftValue: "}o",
@@ -95,9 +95,9 @@ module MockData
           article_model,
           comment_model
         ], Relations: [
-          article_relation,
-          profile_relation,
-          comment_relation
+          article_user_relation,
+          profile_user_relation,
+          comment_article_relation
         ]
       }
     end

data/test/test_rails/rails-mermaid_erd_markdown/test_generator.rb

@@ -32,7 +32,7 @@ class MermaidErdMarkdown::GeneratorTest < Minitest::Test
 
     source = {
       Models: [user_model, article_model, profile_model],
-      Relations: [article_relation, profile_relation]
+      Relations: [article_user_relation, profile_user_relation]
     }
 
     result = MermaidErdMarkdown::Generator.new.model_markdown(source)

data/test/test_rails/rails-mermaid_erd_markdown/test_source_data.rb

@@ -9,19 +9,19 @@ class MermaidErdMarkdown::SourceDataTest < Minitest::Test
   def test_split_output
     expected_user = {
       Models: [user_model, article_model, profile_model],
-      Relations: [article_relation, profile_relation]
+      Relations: [article_user_relation, profile_user_relation]
     }
     expected_profile = {
       Models: [profile_model, user_model],
-      Relations: [profile_relation]
+      Relations: [profile_user_relation]
     }
     expected_article = {
       Models: [article_model, user_model, comment_model],
-      Relations: [article_relation, comment_relation]
+      Relations: [article_user_relation, comment_article_relation]
     }
     expected_comment = {
       Models: [comment_model, article_model],
-      Relations: [comment_relation]
+      Relations: [comment_article_relation]
     }
     expected = [
       expected_user,
@@ -40,19 +40,19 @@ class MermaidErdMarkdown::SourceDataTest < Minitest::Test
   def test_split_output_with_depth
     expected_user = {
       Models: [user_model, article_model, profile_model, comment_model],
-      Relations: [article_relation, profile_relation, comment_relation]
+      Relations: [article_user_relation, profile_user_relation, comment_article_relation]
     }
     expected_profile = {
       Models: [profile_model, user_model, article_model],
-      Relations: [profile_relation, article_relation]
+      Relations: [profile_user_relation, article_user_relation]
     }
     expected_article = {
       Models: [article_model, user_model, comment_model, profile_model],
-      Relations: [article_relation, comment_relation, profile_relation]
+      Relations: [article_user_relation, comment_article_relation, profile_user_relation]
     }
     expected_comment = {
       Models: [comment_model, article_model, user_model],
-      Relations: [comment_relation, article_relation]
+      Relations: [comment_article_relation, article_user_relation]
     }
     expected = [
       expected_user,
@@ -67,4 +67,31 @@ class MermaidErdMarkdown::SourceDataTest < Minitest::Test
       assert_equal expected, result
     end
   end
+
+  def test_data_filtered
+    stub_config = Minitest::Mock.new
+
+    def stub_config.output_path; "app/models/ERD.md"; end
+    def stub_config.split_output; false; end
+    def stub_config.relationship_depth; 1; end
+    def stub_config.ignored_models; ['User']; end
+
+    expected = {
+      Models: [
+        profile_model,
+        article_model,
+        comment_model
+      ], Relations: [
+        comment_article_relation
+      ]
+    }
+
+    RailsMermaidErd::Builder.stub :model_data, stubbed_model_data do
+      MermaidErdMarkdown::Configuration.stub :new, stub_config do
+        result = MermaidErdMarkdown::SourceData.new.data
+
+        assert_equal expected, result
+      end 
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-mermaid_erd_markdown
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - humzahkiani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-10 00:00:00.000000000 Z
+date: 2024-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails