Initial commit

Author: gilest

.formatter.exs

@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]

.gitignore

@@ -0,0 +1,27 @@
+# The directory Mix will write compiled artifacts to.
+/_build/
+
+# If you run "mix test --cover", coverage assets end up here.
+/cover/
+
+# The directory Mix downloads your dependencies sources to.
+/deps/
+
+# Where third-party dependencies like ExDoc output generated docs.
+/doc/
+
+# Ignore .fetch files in case you like to edit your project deps locally.
+/.fetch
+
+# If the VM crashes, it generates a dump, let's ignore it too.
+erl_crash.dump
+
+# Also ignore archive artifacts (built via "mix archive.build").
+*.ez
+
+# Ignore package tarball (built via "mix hex.build").
+phoenix_importmap-*.tar
+
+# Temporary files, for example, from tests.
+/tmp/
+/priv/static/assets

README.md

@@ -0,0 +1,21 @@
+# PhoenixImportmap
+
+**TODO: Add description**
+
+## Installation
+
+If [available in Hex](https://hex.pm/docs/publish), the package can be installed
+by adding `phoenix_importmap` to your list of dependencies in `mix.exs`:
+
+```elixir
+def deps do
+  [
+    {:phoenix_importmap, "~> 0.1.0"}
+  ]
+end
+```
+
+Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
+and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
+be found at <https://hexdocs.pm/phoenix_importmap>.
+

assets/js/app.js

@@ -0,0 +1 @@
+// Fixture for testing purposes

lib/phoenix_importmap.ex

@@ -0,0 +1,60 @@
+defmodule PhoenixImportmap do
+  @moduledoc """
+  Documentation for `PhoenixImportmap`.
+  """
+
+  @copy_destination_path "/priv/static/assets"
+  @public_asset_path_prefix "/priv/static"
+
+  def copy(importmap = %{}) do
+    importmap
+    |> Map.values()
+    |> Enum.map(fn source_path ->
+      full_source_path = "#{File.cwd!()}#{source_path}"
+      dest_path = dest_path_for_asset(source_path)
+      maybe_copy_asset(full_source_path, dest_path)
+    end)
+
+    :ok
+  end
+
+  def importmap_json(importmap = %{}) do
+    %{
+      imports:
+        importmap
+        |> Enum.reduce(%{}, fn {name, path}, acc ->
+          Map.put(
+            acc,
+            name,
+            dest_path_for_asset(path) |> String.replace(@public_asset_path_prefix, "")
+          )
+        end)
+    }
+    |> Jason.encode!()
+    |> Phoenix.HTML.raw()
+  end
+
+  def dest_path_for_asset("//:" <> _), do: nil
+  def dest_path_for_asset("http://" <> _), do: nil
+  def dest_path_for_asset("https://" <> _), do: nil
+
+  def dest_path_for_asset("/assets" <> _ = full_path) do
+    "#{@copy_destination_path}/#{filename(full_path)}"
+  end
+
+  def dest_path_for_asset("/deps" <> _ = full_path) do
+    "#{@copy_destination_path}/#{filename(full_path)}"
+  end
+
+  defp maybe_copy_asset(_source, nil), do: {:ok, 0}
+
+  defp maybe_copy_asset(source, dest) do
+    source
+    |> File.copy!(File.cwd!() <> dest)
+  end
+
+  defp filename(full_path) do
+    String.split(full_path, "/")
+    |> Enum.take(-1)
+  end
+end

mix.exs

@@ -0,0 +1,28 @@
+defmodule PhoenixImportmap.MixProject do
+  use Mix.Project
+
+  def project do
+    [
+      app: :phoenix_importmap,
+      version: "0.1.0",
+      elixir: "~> 1.17",
+      start_permanent: Mix.env() == :prod,
+      deps: deps()
+    ]
+  end
+
+  # Run "mix help compile.app" to learn about applications.
+  def application do
+    [
+      extra_applications: [:logger]
+    ]
+  end
+
+  # Run "mix help deps" to learn about dependencies.
+  defp deps do
+    [
+      {:jason, "~> 1.4.4"},
+      {:phoenix_html, "~> 4.1.1"}
+    ]
+  end
+end

mix.lock

@@ -0,0 +1,4 @@
+%{
+  "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
+  "phoenix_html": {:hex, :phoenix_html, "4.1.1", "4c064fd3873d12ebb1388425a8f2a19348cef56e7289e1998e2d2fa758aa982e", [:mix], [], "hexpm", "f2f2df5a72bc9a2f510b21497fd7d2b86d932ec0598f0210fed4114adc546c6f"},
+}

test/phoenix_importmap_test.exs

@@ -0,0 +1,43 @@
+defmodule PhoenixImportmapTest do
+  use ExUnit.Case
+  doctest PhoenixImportmap
+
+  @example_importmap %{
+    app: "/assets/js/app.js",
+    phoenix_html: "/deps/phoenix_html/priv/static/phoenix_html.js"
+  }
+
+  @example_missing_file_importmap %{
+    app: "/assets/js/missing.js"
+  }
+
+  test "copy succeeds" do
+    %{app: app_js_path, phoenix_html: dep_js_path} = @example_importmap
+
+    app_js_full_path = File.cwd!() <> PhoenixImportmap.dest_path_for_asset(app_js_path)
+    dep_js_full_path = File.cwd!() <> PhoenixImportmap.dest_path_for_asset(dep_js_path)
+
+    assert File.exists?(app_js_full_path) == false
+    assert File.exists?(dep_js_full_path) == false
+
+    assert PhoenixImportmap.copy(@example_importmap) == :ok
+
+    assert File.exists?(app_js_full_path)
+    assert File.exists?(dep_js_full_path)
+
+    File.rm!(app_js_full_path)
+    File.rm!(dep_js_full_path)
+  end
+
+  test "copy fails on missing file" do
+    assert_raise(File.CopyError, fn ->
+      PhoenixImportmap.copy(@example_missing_file_importmap)
+    end)
+  end
+
+  test "importmap_json" do
+    assert PhoenixImportmap.importmap_json(@example_importmap) ==
+             {:safe,
+              "{\"imports\":{\"app\":\"/assets/app.js\",\"phoenix_html\":\"/assets/phoenix_html.js\"}}"}
+  end
+end

test/test_helper.exs

@@ -0,0 +1,3 @@
+File.rm_rf!(File.cwd!() <> "/priv/static/assets")
+File.mkdir_p!(File.cwd!() <> "/priv/static/assets")
+ExUnit.start()