packwerk_mermaid 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d5fc2720c27d3ef40d87efaa581629539ca1d5e50216fb912f4c83bdd0505b3
-  data.tar.gz: 186f3583d0c2292740fa888674c47f949709e9406423fdbfd55854d15182faec
+  metadata.gz: 7f9d51ff22380dff4d6501057614acee4629f2b47fed7f01c5333f8bb0b9b7b7
+  data.tar.gz: 32ed71f954a9607746c4ce1a47e89d38d93542956bcea7fe3e5e5776b730513f
 SHA512:
-  metadata.gz: ac63ab51ec034b0dd259edfe5eb9a7f51b23500d38c30e7207521ebfd481fe590d0070c58fd4b96bc1271ed34d5bccc26a4d6949e536b616592dd7135a9c28be
-  data.tar.gz: 373a1e0616850c5172c4debff7a183dc2aec5771119a6817bac091f28038acdb82675af4a140d6cf65c68e5a82c3d4f61d04462525d9ef0478b634a5b803e13e
+  metadata.gz: 6fdd24fe73d35388c92c7012018a53a1d5a2f2226b430e231f81793e3dc33a735b8e3bdadc9605cd1441de725ddd89529779dae1abddc28766286079ed0b68c7
+  data.tar.gz: 7a477014e51d95de669975153e4b7c060c43ae2aa9bb4759bf0514e2ae6d523f6787eb83a4142264b682cb0b5cb6c7aaaea9b9ec4c486594a35ed46a7248c9d9

data/README.md

@@ -1,6 +1,29 @@
 # Packwerk Mermaid
 
-This is a simple gem for a project using [packwerk](https://github.com/Shopify/packwerk) to generate a [Mermaid](https://mermaid.js.org/) diagram.
+This is a simple gem for a project using [packwerk](https://github.com/Shopify/packwerk) to generate a [Mermaid](https://mermaid.js.org/) diagram. When you generate the output, you can get a diagram that looks like this:
+
+```mermaid
+---
+title: App Name
+---
+flowchart TD
+    0("Nelson Hamill") --> 1("Msgr. Cynthia Dickens");
+    0 --> 2("Adell Friesen MD");
+    2 --> 3("Cortez Purdy");
+    2 --> 4("Renaldo Collier");
+    2 --> 5("Titus Schamberger");
+    2 --> 6("Efren Kuhlman");
+    2 --> 7("Osvaldo Legros Esq.");
+    2 --> 8("Byron Hammes");
+    6 --> 9("Carlo Nolan DDS");
+    3 --> 9;
+    1 --> 2;
+    10("Mayola Kovacek") --> 2;
+    10 --> 1;
+    10 --> 5;
+    10 --> 6;
+
+```
 
 ## Installation
 
@@ -49,11 +72,14 @@ configuration = PackwerkMermaid.configure do |config|
   # Flexible way to rename packages
   config.packwerk_package_name_callback = lambda { |name| name.gsub('packs/', '') }
 
-  # Hide packages from the diagram
+  # Simple static mapping of packages to hide
   config.packwerk_packages_hidden = [
     'packs/utilities',
     'packs/legacy_service',
   ]
+  
+  # Flexible way to show/hide packages
+  config.packwerk_package_name_callback = lambda { |node_name, parent_node_name| should_show?(node_name) }
 end
 
 PackwerkMermaid::PackwerkFlowchart.new(configuration).generate
@@ -69,4 +95,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Packs::Mermaid project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/packs-mermaid/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the PackwerkMermaid project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bwillis/packwerk_mermaid/blob/master/CODE_OF_CONDUCT.md).

data/lib/packwerk_mermaid/configuration.rb

@@ -6,6 +6,7 @@ module PackwerkMermaid
       :packwerk_package_name_mapping,
       :packwerk_loader,
       :packwerk_package_name_callback,
+      :packwerk_package_visibility_callback,
       :packwerk_packages_hidden,
       :mermaid_title,
       :mermaid_text_type,
@@ -16,6 +17,7 @@ module PackwerkMermaid
       @packwerk_package_name_mapping = {}
       @packwerk_loader = Proc.new { |dir| Packwerk::PackageSet.load_all_from(dir) }
       @packwerk_packages_hidden = []
+      @packwerk_package_visibility_callback = Proc.new { |_node_name, _parent_node_name| true }
       @mermaid_title = nil
       @mermaid_text_type = MermaidFlowchartBuilder::TEXT
       @mermaid_shape_style = MermaidFlowchartBuilder::RECTANGLE_ROUNDED

data/lib/packwerk_mermaid/packwerk_flowchart.rb

@@ -23,6 +23,7 @@ module PackwerkMermaid
 
         package.dependencies.each do |dependency_name|
           next if @configuration.packwerk_packages_hidden.include? dependency_name
+          next unless @configuration.packwerk_package_visibility_callback.call(dependency_name, package.name)
 
           builder.add_edge(
             rename_package(package.name),

data/lib/packwerk_mermaid/version.rb

@@ -2,6 +2,6 @@
 
 module PackwerkMermaid
   class Version
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk_mermaid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Willis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-17 00:00:00.000000000 Z
+date: 2023-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: packwerk