visualize_packs 0.5.23 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e0cfe73d505dcc80ec3792514b251aa3320c5e7c9703c071202bf1c384ca77a
-  data.tar.gz: 0bff429e62083b1a193ddaeb15c443568363ac5400d22b06e5d220e38aea2b90
+  metadata.gz: 73490ce1f4c30e0ba70c4919eb72cc85412850018d0845ed315adce05d7522f8
+  data.tar.gz: 1cb5f079c59d373a2cc41917fb97fe12b8fa0e39afccb12c16de0ce629278aee
 SHA512:
-  metadata.gz: cd23c6aa9d40fc57d4b0272af1046c7a289062a27c809b78ef121c239b53347f7dee5e3ccd7afbebca49d25697ee01da6de9b92864c83d0524f1f3a394b8f0f3
-  data.tar.gz: d394fdfb12da6cb44fa0401aa33f17e9fcfcb801b201a485c92683260f5bb17be66054d7361bc01c95dea5bcb82e136d1da1c09040a43bf053ddc403521e1738
+  metadata.gz: 9b691a8b28175986e682fb5862e4848868f24f82c8d5e07071c57be5f0a7ebb614a314128c765ea99be090a88798048869342696f8470529f1f13485f6fa5d7f
+  data.tar.gz: '091810fdb3c182d1b7799967300b5795e6834960189e0d663eaba0163e44556a19156606a9039fa211a4ca4b566e583970ecf8da4f4a4e6e19d21070ab763c23'

data/lib/graph.dot.erb

@@ -18,7 +18,7 @@ digraph package_diagram {
     style=filled
     shape=plain
   ]
-  <%- architecture_layers.each_with_index do |layer_name, index| -%>
+  <%- layers.each_with_index do |layer_name, index| -%>
     subgraph <%= layer_name -%> {
       shape=box
       color=darkgrey
@@ -68,7 +68,7 @@ digraph package_diagram {
     <%- grouped_packages[layer_name].each do |package| -%>
       <%- if options.show_layers -%>
         <%- if index > 0 -%>
-          <%- grouped_packages[raw_config['architecture_layers'][index - 1]].each do |upper_layer_node| -%>
+          <%- grouped_packages[raw_config['layers'][index - 1]].each do |upper_layer_node| -%>
             <%- if all_package_names.include?(upper_layer_node.name) && all_package_names.include?(package.name) -%>
               "<%= upper_layer_node.name -%>" -> "<%= package.name -%>" [ style=invis ]
             <%- end -%>
@@ -101,8 +101,8 @@ digraph package_diagram {
               # headlabel="<%= todo_type -%>"
               <%- if todo_type == 'privacy' -%>
                 <%= VisualizePacks::ArrowHead::PrivacyTodo.serialize %>
-              <%- elsif todo_type == 'architecture' -%>
-                <%= VisualizePacks::ArrowHead::ArchitectureTodo.serialize %>
+              <%- elsif todo_type == 'layer' -%>
+                <%= VisualizePacks::ArrowHead::LayerTodo.serialize %>
               <%- elsif todo_type == 'visibility' -%>
                 <%= VisualizePacks::ArrowHead::VisibilityTodo.serialize %>
               <%- elsif todo_type == 'folder_visibility' -%>
@@ -158,10 +158,10 @@ digraph package_diagram {
       D [ fontsize=12 shape=box label="package"]
       C -> D [label="privacy todo" <%= VisualizePacks::ArrowHead::PrivacyTodo.serialize %>]
         <%- end -%>
-        <%- if options.relationship_todo_types.include?(EdgeTodoTypes::Architecture) -%>
+        <%- if options.relationship_todo_types.include?(EdgeTodoTypes::Layer) -%>
       E [ fontsize=12 shape=box label="package"]
       F [ fontsize=12 shape=box label="package"]
-      E -> F [label="architecture todo" <%= VisualizePacks::ArrowHead::ArchitectureTodo.serialize %>]
+      E -> F [label="layer todo" <%= VisualizePacks::ArrowHead::LayerTodo.serialize %>]
         <%- end -%>
         <%- if options.relationship_todo_types.include?(EdgeTodoTypes::Visibility) -%>
       G [ fontsize=12 shape=box label="package"]

data/lib/visualize_packs/options.rb

@@ -5,7 +5,7 @@ class EdgeTodoTypes < T::Enum
   enums do
     Dependency = new
     Privacy = new
-    Architecture = new
+    Layer = new
     Visibility = new
     Folder_Visibility = new
   end
@@ -48,4 +48,4 @@ class Options < T::Struct
   prop :remote_base_url, T.nilable(String)
 
   prop :title, T.nilable(String), default: nil
-end
+end

data/lib/visualize_packs.rb

@@ -16,7 +16,7 @@ module VisualizePacks
     enums do
       DependencyTodo = new('color=darkred style=dashed arrowhead=odiamond')
       PrivacyTodo = new('color=darkred style=dashed arrowhead=crow')
-      ArchitectureTodo = new('color=darkred style=dashed arrowhead=obox')
+      LayerTodo = new('color=darkred style=dashed arrowhead=obox')
       VisibilityTodo = new('color=darkred style=dashed arrowhead=tee')
       FolderVisibilityTodo = new('color=darkred style=dashed arrowhead=odot')
       ConfiguredDependency = new('color=darkgreen')
@@ -40,18 +40,18 @@ module VisualizePacks
 
     title = diagram_title(args, options, max_todo_count)
 
-    architecture_layers = (raw_config['architecture_layers'] || []) + ["NotInLayer"]
-    grouped_packages = architecture_layers.inject({}) do |result, key|
+    layers = (raw_config['layers'] || []) + ["NotInLayer"]
+    grouped_packages = layers.inject({}) do |result, key|
       result[key] = []
       result
     end
 
     all_packages.each do |package|
       key = package.config['layer'] || "NotInLayer"
-      if architecture_layers.include?(key)
+      if layers.include?(key)
         grouped_packages[key] << package
       else
-        raise RuntimeError, "Package #{package.name} has architecture layer key #{key}. Known layers are only #{architecture_layers.join(", ")}"
+        raise RuntimeError, "Package #{package.name} has layer key #{key}. Known layers are only #{layers.join(", ")}"
       end
     end
 
@@ -64,7 +64,7 @@ module VisualizePacks
     template.result(binding)
   end
 
-  private 
+  private
 
   sig { params(package: ParsePackwerk::Package).returns(T.nilable(String)) }
   def self.code_owner(package)
@@ -91,7 +91,7 @@ module VisualizePacks
 
     focus_info = if options.focus_pack
       "Focus on #{limited_sentence(options.focus_pack)} (Edge mode: #{options.show_only_edges_to_focus_pack.serialize})"
-    else 
+    else
       "All packs"
     end
 
@@ -135,8 +135,8 @@ module VisualizePacks
   sig { params(options: Options, all_package_names: T::Array[String]).returns(T.proc.params(arg0: String, arg1: String).returns(T::Boolean)) }
   def self.show_edge_builder(options, all_package_names)
     return lambda do |start_node, end_node|
-      all_package_names.include?(start_node) && 
-      all_package_names.include?(end_node) && 
+      all_package_names.include?(start_node) &&
+      all_package_names.include?(end_node) &&
       (
         case options.show_only_edges_to_focus_pack
         when FocusPackEdgeDirection::All then
@@ -159,11 +159,11 @@ module VisualizePacks
     return lambda do |text|
       return unless text
       hash_value = Digest::SHA256.hexdigest(text.encode('utf-8'))
-      color_code = hash_value[0, 6]
-      r = color_code[0, 2].to_i(16) % 128 + 128
-      g = color_code[2, 2].to_i(16) % 128 + 128
-      b = color_code[4, 2].to_i(16) % 128 + 128
-      hex = "#%02X%02X%02X" % [r, g, b]
+      color_code = T.must(hash_value[0, 6])
+      r = T.must(color_code[0, 2]).to_i(16) % 128 + 128
+      g = T.must(color_code[2, 2]).to_i(16) % 128 + 128
+      b = T.must(color_code[4, 2]).to_i(16) % 128 + 128
+      "#%02X%02X%02X" % [r, g, b]
     end
   end
 
@@ -224,7 +224,7 @@ module VisualizePacks
       res[p.name] = p
       res
     end
- 
+
     result = T.let([], T::Array[T.nilable(String)])
     result = packages.map { |pack| pack.name }
 
@@ -244,7 +244,7 @@ module VisualizePacks
       when FocusPackEdgeDirection::In then
         result += dependents + todos_in
       when FocusPackEdgeDirection::Out then
-        result += dependencies + todos_out 
+        result += dependencies + todos_out
       when FocusPackEdgeDirection::None then
         # nothing to do
       end
@@ -314,9 +314,9 @@ module VisualizePacks
 
         morphed_todos = T.must(package.violations).map do |v|
           ParsePackwerk::Violation.new(
-            type: v.type, 
-            to_package_name: nested_packages[v.to_package_name] || v.to_package_name, 
-            class_name: v.class_name, 
+            type: v.type,
+            to_package_name: nested_packages[v.to_package_name] || v.to_package_name,
+            class_name: v.class_name,
             files: v.files
           )
         end.reject { |v| v.to_package_name == package.name }
@@ -346,7 +346,7 @@ module VisualizePacks
   sig { params(all_packages: T::Array[ParsePackwerk::Package], focus_packs_names: T::Array[String]).returns(T::Array[String]) }
   def self.dependencies_of(all_packages, focus_packs_names)
     focus_packs = all_packages.select { focus_packs_names.include?(_1.name)}
-    
+
     focus_packs.inject([]) do |result, pack|
       result += pack.dependencies
       result
@@ -385,7 +385,7 @@ module VisualizePacks
 
     raise ArgumentError unless ['Packs/ClassMethodsAsPublicApis', 'Packs/DocumentedPublicApis', 'Packs/RootNamespaceIsPackName', 'Packs/TypedPublicApis'].include?(protection)
     return nil unless (rubocop_config.dig(protection)&.dig('Enabled'))
-    
+
     (rubocop_todo.dig(protection)&.dig('Exclude') || []).inject(0) do |result, todo|
       result += 1 if todo.start_with?("#{package_name}/")
       result
@@ -396,9 +396,9 @@ module VisualizePacks
   def self.package_based_todos_text_maker
     ->(package_name) {
       [
-        'Packs/ClassMethodsAsPublicApis', 
-        'Packs/DocumentedPublicApis', 
-        'Packs/RootNamespaceIsPackName', 
+        'Packs/ClassMethodsAsPublicApis',
+        'Packs/DocumentedPublicApis',
+        'Packs/RootNamespaceIsPackName',
         'Packs/TypedPublicApis'
       ].map do |protection|
         rubocop_config = File.exist?("#{package_name}/.rubocop.yml") ? YAML.load_file("#{package_name}/.rubocop.yml") : {}
@@ -406,7 +406,7 @@ module VisualizePacks
 
         todo_value = package_based_todos_for(protection, package_name, rubocop_config,  rubocop_todo)
         abbreviation = T.must(protection.split('/')[1]).chars[0]
-        
+
         "#{abbreviation}: #{todo_value}" if todo_value
       end.compact.join(", ")
     }

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: visualize_packs
 version: !ruby/object:Gem::Version
-  version: 0.5.23
+  version: 0.6.0
 platform: ruby
 authors:
 - Gusto Engineers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2024-10-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -131,7 +145,7 @@ metadata:
   source_code_uri: https://github.com/rubyatscale/visualize_packs
   changelog_uri: https://github.com/rubyatscale/visualize_packs/releases
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -139,15 +153,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.16
+signing_key:
 specification_version: 4
 summary: A gem to visualize connections in a Ruby app that uses packs
 test_files: []