uniform

defmodule Uniform.Modifiers do
  @moduledoc """
  Utilities for building code transformations with
  `Uniform.Blueprint.modify/2`.
  """

  #
  # Eject Fences
  #

  @doc """
  Apply [Eject Fences](code-transformations.html#eject-fences) to extra
  languages with this function.

  Uniform already applies Eject Fences to Elixir (`.ex/.exs`) and JavaScript
  (`.js/.jsx/.ts/.tsx`) files automatically.

  `use Uniform.Blueprint` imports `eject_fences`.

  ## Examples

      # code fences for SQL files
      modify ~r/\.sql$/, &eject_fences(&1, &2, "--")

      # code fences for Rust files
      modify ~r/\.rs$/, fn file, app ->
        eject_fences(file, app, "//")
      end

  """
  @spec eject_fences(String.t(), Uniform.App.t(), String.t()) :: String.t()
  def eject_fences(file_contents, app, comment_prefix) do
    remove_regex =
      Regex.compile!(
        "\n *#{comment_prefix} uniform:remove.+?#{comment_prefix} \/uniform:remove",
        "s"
      )

    # A regex that detects code fences
    "\n *#{comment_prefix} uniform:(lib|mix|app):([a-z0-9_]+)(.+?)#{comment_prefix} \/uniform:\\1:\\2"
    |> Regex.compile!("s")
    |> Regex.replace(
      file_contents,
      fn _, category, dep, code ->
        dep = String.to_existing_atom(dep)
        eject_fence_replacement(app, category, dep, code)
      end,
      global: true
    )
    |> String.replace(remove_regex, "")
  rescue
    e in ArgumentError ->
      if String.contains?(e.message, "not an already existing atom") do
        {:erlang, :binary_to_existing_atom, [dependency_name, :utf8], _} =
          List.first(__STACKTRACE__)

        reraise "Code fence references a lib dependency `#{dependency_name}` that isn't a directory in lib/",
                __STACKTRACE__
      else
        reraise e, __STACKTRACE__
      end
  end

  defp eject_fence_replacement(app, "lib", dep_name, inner_match) do
    if dep_name in app.internal.deps.all.lib do
      if dep_name in app.internal.deps.included.lib do
        String.trim_trailing(inner_match)
      else
        ""
      end
    else
      raise "Code fence '# uniform:lib:#{dep_name} references a lib dependency that isn't a directory in lib/"
    end
  end

  defp eject_fence_replacement(app, "mix", dep_name, inner_match) do
    if dep_name in app.internal.deps.all.mix do
      if dep_name in app.internal.deps.included.mix do
        String.trim_trailing(inner_match)
      else
        ""
      end
    else
      raise "Code fence '# uniform:mix:#{dep_name} references a mix dependency that isn't in `deps` in mix.exs"
    end
  end

  defp eject_fence_replacement(app, "app", app_name, inner_match) do
    if to_string(app_name) == app.name.underscore do
      inner_match
    else
      ""
    end
  end

  @doc """
       Code fences are in this format:

           some_code()

           # uniform:lib:foo_bar
           #
           # ... code that will be removed if the lib called foo_bar isn't included
           #
           # /uniform:lib:foo_bar

           more_code()

           # uniform:mix:foo_bar
           #
           # ... code that will be removed if the mix dep called foo_bar isn't included
           #
           # /uniform:mix:foo_bar

           more_code()

           # uniform:app:foo_bar
           #
           # ... code that will be removed if the current app isn't called foo_bar
           #
           # /uniform:app:foo_bar

           more_code()

           # uniform:remove
           #
           # ... code that will always be removed upon ejection
           #
           # /uniform:remove

       """ && false
  def elixir_eject_fences(file_contents, app) do
    eject_fences(file_contents, app, "#")
  end

  @doc false
  def js_eject_fences(file_contents, app) do
    eject_fences(file_contents, app, "//")
  end

  #
  # mix.exs Dependency Removal
  #

  @doc """
       Given the contents of a mix.exs file and an `%App{}`, look for the `defp
       deps` function and filter out the deps that should not be included in
       this app.
       """ && false
  def remove_unused_mix_deps(file_contents, app) do
    quoted_deps_function = quoted_deps_function(file_contents)
    start_line = Sourceror.get_line(quoted_deps_function)
    end_line = Sourceror.get_end_line(quoted_deps_function)
    lines = String.split(file_contents, "\n")
    prelude = Enum.slice(lines, 0..(start_line - 2))
    postlude = Enum.slice(lines, end_line..-1)
    quoted_deps = quoted_deps(quoted_deps_function)
    included_dep_names = app.internal.deps.included.mix
    filtered_deps = for dep <- quoted_deps, dep_name(dep) in included_dep_names, do: dep

    IO.iodata_to_binary([
      Enum.intersperse(prelude, "\n"),
      "\n",
      "  defp deps do\n",
      Sourceror.to_string(filtered_deps),
      "  end\n",
      Enum.intersperse(postlude, "\n")
    ])
  end

  # returns the `defp deps` function from a `mix.exs` as Elixir AST
  @spec quoted_deps_function(String.t()) :: Macro.t()
  defp quoted_deps_function(file_contents) do
    zipper =
      file_contents
      |> Sourceror.parse_string()
      |> Sourceror.Zipper.zip()
      |> Sourceror.Zipper.find(:next, fn
        {:defp, _, [{:deps, _, nil}, [_deps]]} -> true
        _ -> false
      end)

    if zipper do
      zipper
      |> Sourceror.Zipper.node()
      |> Sourceror.Comments.extract_comments()
      |> elem(0)
    else
      raise_invalid_deps_exception()
    end
  end

  # extracts the AST for the deps themselves from the full `defp deps` AST
  @spec quoted_deps(Macro.t()) :: Macro.t()
  defp quoted_deps(
         {:defp, _, [{:deps, _, nil}, [{{_, _, [:do]}, {:__block__, _, [quoted_deps]}}]]}
       ) do
    quoted_deps
  end

  defp quoted_deps(_), do: raise_invalid_deps_exception()

  defp raise_invalid_deps_exception do
    raise """
    mix.exs is not set up properly.

    Uniform expects your mix.exs file to have the default structure generated
    by standard tools like `mix new` and `mix phx.new`.

    It should have a private `deps` function which immediately returns a list
    of deps.

        defp deps do
          [
            {:gettext, "~> 0.20"},
            {:phoenix, "~> 1.6"},
            ...
          ]
        end

    The `project` function should use deps() like this.

        def project do
          [
            deps: deps(),
            ...
          ]
        end

    """
  end

  # extracts the name of a dep from its AST form
  @spec dep_name(Macro.t()) :: atom
  defp dep_name(quoted) do
    case Code.eval_quoted(quoted) do
      {{name, _}, _} -> name
      {{name, _, _}, _} -> name
    end
  end

  #
  # Base Project Name Replacement
  #

  @doc "Replace the base project name with the ejected app name." && false
  def replace_base_project_name(file_contents, app) do
    underscore = to_string(app.internal.config.mix_project_app)

    file_contents
    # replace `base_project_name` with `ejected_app_name`
    |> String.replace(underscore, app.name.underscore)
    # replace `base-project-name` with `ejected-app-name`
    |> String.replace(String.replace(underscore, "_", "-"), app.name.hyphen)
    # replace `BaseProjectName` with `EjectedAppName`
    |> String.replace(Macro.camelize(underscore), app.name.camel)
  end
end