Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions lib/mix/tasks/docs.ex
Original file line number Diff line number Diff line change
Expand Up @@ -298,13 +298,32 @@ defmodule Mix.Tasks.Docs do
end

defp get_deps do
for {key, _} <- Mix.Project.deps_paths(),
_ = Application.load(key),
vsn = Application.spec(key, :vsn) do
{key, "https://#{String.replace("#{key}", "_", "-")}.hexdocs.pm/#{vsn}/"}
private_deps = private_hex_deps()

for {app, _} <- Mix.Project.deps_paths(),
_ = Application.load(app),
vsn = Application.spec(app, :vsn) do
{app, dependency_url(app, vsn, private_deps[app])}
end
end

defp private_hex_deps do
for %Mix.Dep{app: app, scm: Hex.SCM, opts: opts} <- Mix.Dep.cached(),
package = opts[:hex] || app,
"hexpm:" <> organization <- [opts[:repo]],
organization != "",
into: %{},
do: {app, {package, organization}}
end

defp dependency_url(_app, vsn, {package, organization}) do
"https://#{organization}.hexorgs.pm/#{package}/#{vsn}/"
end

defp dependency_url(app, vsn, _dep) do
"https://#{String.replace("#{app}", "_", "-")}.hexdocs.pm/#{vsn}/"
end

defp put_package(options, config) do
if package = config[:package] do
Keyword.put(options, :package, package[:name] || config[:app])
Expand Down
65 changes: 65 additions & 0 deletions test/mix/tasks/docs_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,71 @@ defmodule Mix.Tasks.DocsTest do
{:earmark_parser, "foo"}
end

test "includes private dependency URLs from cached deps", context do
cache_key = {:cached_deps, Mix.Project.get()}
deps = Mix.Dep.cached()
previous = Mix.State.read_cache(cache_key)

put_deps = fn updates ->
updated =
Enum.map(deps, fn %Mix.Dep{app: app, opts: opts} = dep ->
case updates[app] do
{scm, extra} -> %{dep | scm: scm, opts: Keyword.merge(opts, extra)}
nil -> dep
end
end)

Mix.State.write_cache(cache_key, {{Mix.env(), Mix.target()}, updated})
end

try do
put_deps.(%{
earmark_parser: {Hex.SCM, hex: "private_parser", repo: "hexpm:my-org"},
makeup: {Hex.SCM, hex: "private-makeup", repo: "hexpm:my-org"}
})

assert [{_, _, _, options}] = run(context, [], app: :ex_doc)

assert options[:deps][:earmark_parser] ==
"https://my-org.hexorgs.pm/private_parser/#{Application.spec(:earmark_parser, :vsn)}/"

assert options[:deps][:makeup] ==
"https://my-org.hexorgs.pm/private-makeup/#{Application.spec(:makeup, :vsn)}/"

refute Keyword.has_key?(options[:deps], :missing_docs_app)

assert [{_, _, _, options}] =
run(context, [],
app: :ex_doc,
docs: [deps: [earmark_parser: "foo", missing_docs_app: "bar"]]
)

assert options[:deps][:earmark_parser] == "foo"
refute Keyword.has_key?(options[:deps], :missing_docs_app)

for update <- [
{Hex.SCM, hex: "private_parser", repo: "hexpm"},
{Hex.SCM, hex: "private_parser", repo: "custom-repo"},
{Hex.SCM, hex: "private_parser", repo: "hexpm:"},
{Hex.SCM, hex: "private_parser", repo: nil},
{Mix.SCM.Git, hex: "private_parser", repo: "hexpm:my-org"}
] do
put_deps.(%{earmark_parser: update})

assert [{_, _, _, options}] = run(context, [], app: :ex_doc)

assert options[:deps][:earmark_parser] ==
"https://earmark-parser.hexdocs.pm/#{Application.spec(:earmark_parser, :vsn)}/"
end
after
if previous do
Mix.State.write_cache(cache_key, previous)
else
Mix.State.delete_cache(cache_key)
end
end
end

test "accepts lazy docs", context do
assert [
{"ex_doc", "dev", _,
Expand Down
Loading