draft code for listing deps in console and plantuml

Author: m.malkin

lib/clean_mixer.ex

@@ -1,2 +1,6 @@
 defmodule CleanMixer do
+  @spec path_to_asset(Path.t()) :: Path.t()
+  def path_to_asset(path) do
+    :code.priv_dir(:clean_mixer) |> Path.join(path)
+  end
 end

lib/clean_mixer/arch_config.ex

@@ -1,9 +1,9 @@
 defmodule CleanMixer.ArchConfig do
   alias CleanMixer.ArchMap.Component
 
-  @type component_map :: %{Component.name() => Path.t()}
+  @type component_map :: [{Component.name(), Path.t()}]
 
-  defstruct component_map: %{}
+  defstruct component_map: []
 
   @type t :: %__MODULE__{
           component_map: component_map

lib/clean_mixer/arch_map.ex

@@ -14,17 +14,22 @@ defmodule CleanMixer.ArchMap do
   def new(components) do
     %__MODULE__{
       components: components,
-      dependencies: find_dependencies(components)
+      dependencies: build_dependencies(components)
     }
   end
 
-  defp find_dependencies(components) do
+  @spec dependencies_for(t(), Component.t()) :: list(Dependency.t())
+  def dependencies_for(%__MODULE__{dependencies: deps}, %Component{} = component) do
+    Enum.filter(deps, &(&1.source == component))
+  end
+
+  defp build_dependencies(components) do
     components
-    |> Enum.flat_map(&dependencies_for(&1, components))
+    |> Enum.flat_map(&build_dependencies_for(&1, components))
     |> Enum.uniq()
   end
 
-  defp dependencies_for(component, all_components) do
+  defp build_dependencies_for(component, all_components) do
     other_components = all_components -- [component]
 
     Enum.flat_map(other_components, fn other_comp ->

lib/clean_mixer/arch_map/component.ex

@@ -1,7 +1,7 @@
 defmodule CleanMixer.ArchMap.Component do
   alias CleanMixer.CodeMap.SourceFile
   alias CleanMixer.CodeMap.FileDependency
-  @type name :: String.t()
+  @type name :: String.t() | atom
 
   defstruct [:name, :files, :file_dependencies]
 
@@ -18,6 +18,8 @@ defmodule CleanMixer.ArchMap.Component do
 
   @spec file_dependencies(t, t) :: list(FileDependency.t())
   def file_dependencies(component, other_component) do
-    component.file_dependencies |> Enum.filter(&(&1.target in other_component.files))
+    component.file_dependencies
+    # TODO test this and refactor
+    |> Enum.filter(&(&1.target in other_component.files && &1.target not in component.files))
   end
 end

lib/clean_mixer/arch_map/dependency.ex

@@ -2,25 +2,20 @@ defmodule CleanMixer.ArchMap.Dependency do
   alias CleanMixer.ArchMap.Component
   alias CleanMixer.CodeMap.FileDependency
 
-  defstruct [:source, :target, :file_dependencies]
+  defstruct [:source, :target, :files]
 
   @type t :: %__MODULE__{
           source: Component.t(),
           target: Component.t(),
-          file_dependencies: list(FileDependency.t())
+          files: list(FileDependency.t())
         }
 
   @spec new(Component.t(), Component.t(), list(FileDependency.t())) :: t
-  def new(source, target, file_dependencies) do
+  def new(source, target, file_deps) do
     %__MODULE__{
       source: source,
       target: target,
-      file_dependencies: file_dependencies
+      files: file_deps
     }
   end
-
-  defimpl String.Chars do
-    def to_string(dep),
-      do: "#{dep.source.name} -> #{dep.target.name}"
-  end
 end

lib/clean_mixer/code_map.ex

@@ -33,6 +33,7 @@ defmodule CleanMixer.CodeMap do
 
       new_dependency(source_file, target, ref_types)
     end)
+    |> Enum.reject(&is_nil/1)
   end
 
   defp source_file_for(module_name, files) do

lib/clean_mixer/code_map/file_dependency.ex

@@ -17,9 +17,4 @@ defmodule CleanMixer.CodeMap.FileDependency do
       ref_types: ref_types |> List.wrap() |> Enum.uniq()
     }
   end
-
-  defimpl String.Chars do
-    def to_string(dep),
-      do: "#{dep.source.path} -> #{dep.target.path} (#{dep.ref_types |> Enum.join(",")})"
-  end
 end

lib/mix/tasks/list.ex

@@ -0,0 +1,22 @@
+defmodule Mix.Tasks.CleanMixer.List do
+  use Mix.Task
+
+  @shortdoc "Lists all project components and their deps"
+
+  alias Mix.Tasks.CleanMixer.UI.Config
+  alias Mix.Tasks.CleanMixer.UI.ArchMapRendering.TextFormat
+  alias CleanMixer.Project
+
+  # TODO test this
+
+  @impl Mix.Task
+  def run(_args, _options \\ []) do
+    Config.load()
+    |> Project.new()
+    |> get_arch_map()
+    |> TextFormat.render()
+    |> IO.puts()
+  end
+
+  defp get_arch_map(%Project{arch_map: arch_map}), do: arch_map
+end

lib/mix/tasks/plant_uml.ex

@@ -0,0 +1,38 @@
+defmodule Mix.Tasks.CleanMixer.PlantUml do
+  use Mix.Task
+
+  @shortdoc "Renders component dependencies with plantuml"
+
+  alias Mix.Tasks.CleanMixer.UI.Config
+  alias Mix.Tasks.CleanMixer.UI.ArchMapRendering.PlantUML
+  alias CleanMixer.Project
+
+  # TODO test this
+  # refactor this
+
+  @file_name "clean_mixer"
+  @plantuml_file_name "#{@file_name}.plantuml"
+  @image_file_name "#{@file_name}.png"
+
+  @impl Mix.Task
+  def run(_args, _options \\ []) do
+    Config.load()
+    |> Project.new()
+    |> get_arch_map()
+    |> PlantUML.render()
+    |> render_image(@plantuml_file_name)
+
+    Mix.Shell.IO.info("image file created at #{@image_file_name}")
+  end
+
+  defp get_arch_map(%Project{arch_map: arch_map}), do: arch_map
+
+  defp render_image(uml_data, filename) do
+    File.write!(filename, uml_data)
+    Mix.Shell.IO.cmd("java -jar #{planutml_jar_path()} #{filename}")
+  end
+
+  defp planutml_jar_path() do
+    CleanMixer.path_to_asset("plantuml.jar")
+  end
+end

lib/ui/arch_map_rendering/plant_uml.ex

@@ -0,0 +1,21 @@
+defmodule Mix.Tasks.CleanMixer.UI.ArchMapRendering.PlantUML do
+  alias CleanMixer.ArchMap
+  alias CleanMixer.ArchMap.Dependency
+
+  # TODO test this
+
+  @spec render(ArchMap.t()) :: String.t()
+  def render(%ArchMap{} = arch_map) do
+    [
+      "@startuml",
+      Enum.map(arch_map.dependencies, &format_dependency/1),
+      "@enduml"
+    ]
+    |> List.flatten()
+    |> Enum.join("\n")
+  end
+
+  defp format_dependency(%Dependency{} = dep) do
+    "[#{dep.source.name}] --> [#{dep.target.name}]"
+  end
+end

lib/ui/arch_map_rendering/text_format.ex

@@ -0,0 +1,42 @@
+defmodule Mix.Tasks.CleanMixer.UI.ArchMapRendering.TextFormat do
+  alias CleanMixer.ArchMap
+  alias CleanMixer.ArchMap.Component
+  alias CleanMixer.ArchMap.Dependency
+  alias CleanMixer.CodeMap.FileDependency
+
+  # TODO test this
+
+  @spec render(ArchMap.t()) :: String.t()
+  def render(%ArchMap{} = arch_map) do
+    arch_map.components
+    |> Enum.map(&{&1, ArchMap.dependencies_for(arch_map, &1)})
+    |> with_dependencies()
+    |> Enum.map_join("\n\n", &format_component/1)
+  end
+
+  defp with_dependencies(components), do: Enum.reject(components, &match?({_, [] = _deps}, &1))
+
+  defp format_component({%Component{}, deps}) do
+    Enum.map_join(deps, "\n", &format_component_dependency/1)
+  end
+
+  defp format_component_dependency(%Dependency{} = dep) do
+    [
+      "===> #{dep.source.name} -> #{dep.target.name}",
+      "\n",
+      dep.files |> Enum.group_by(& &1.source) |> Enum.map_join("\n", &format_file_dependencies/1)
+    ]
+  end
+
+  defp format_file_dependencies({source_file, deps}) do
+    [
+      [" * #{source_file.path}"],
+      "\n",
+      Enum.map_join(deps, "\n", &format_file_dependency/1)
+    ]
+  end
+
+  defp format_file_dependency(%FileDependency{} = dep) do
+    [" |", "---> #{dep.target.path} (#{dep.ref_types |> Enum.join(",")})"]
+  end
+end

lib/ui/config.ex

@@ -0,0 +1,18 @@
+defmodule Mix.Tasks.CleanMixer.UI.Config do
+  alias CleanMixer.ArchConfig
+
+  @default_name ".clean_mixer.exs"
+
+  @spec load :: ArchConfig.t()
+  def load() do
+    @default_name
+    |> File.read!()
+    |> parse()
+  end
+
+  defp parse(data) do
+    # TODO raise a meaningfull exc
+    {params, _} = Code.eval_string(data)
+    params |> Keyword.fetch!(:components) |> ArchConfig.new()
+  end
+end

priv/plantuml.jar

@@ -29,7 +29,7 @@ defmodule CleanMixer.ProjectTest do
   end
 
   test "build arch map from code map" do
-    component_map = %{"component1" => "path1", "component2" => "path2"}
+    component_map = [component1: "path1", component2: "path2"]
 
     project =
       component_map
@@ -38,12 +38,12 @@ defmodule CleanMixer.ProjectTest do
 
     assert [
              Component.new(
-               "component1",
+               :component1,
                [SourceFile.new("path1/file1"), SourceFile.new("path1/file2")],
                [FileDependency.new(SourceFile.new("path1/file1"), SourceFile.new("path2/file1"), [:runtime])]
              ),
              Component.new(
-               "component2",
+               :component2,
                [SourceFile.new("path2/file1")],
                [FileDependency.new(SourceFile.new("path2/file1"), SourceFile.new("path2/file2"), [:runtime])]
              )
@@ -64,16 +64,16 @@ defmodule CleanMixer.ProjectTest do
   end
 
   test "supports nested components" do
-    component_map = %{"component" => "path", "subcomponent" => "path/subpath"}
+    component_map = [component: "path", subcomponent: "path/subpath"]
 
     project =
       component_map
       |> ArchConfig.new()
       |> Project.new(CodeCartographer.new(NestedFakeCodeCartographer))
 
     assert [
-             Component.new("component", [SourceFile.new("path/file"), SourceFile.new("path/subpath/file")]),
-             Component.new("subcomponent", [SourceFile.new("path/subpath/file")])
+             Component.new(:component, [SourceFile.new("path/file"), SourceFile.new("path/subpath/file")]),
+             Component.new(:subcomponent, [SourceFile.new("path/subpath/file")])
            ] == project.arch_map.components
   end
 end