From 5d475eefa27ddbb7876d74a9a3f6f45267333d57 Mon Sep 17 00:00:00 2001
From: Fred Hebert <mononcqc@ferd.ca>
Date: Thu, 25 Aug 2016 08:56:44 -0400
Subject: [PATCH 1/2] Make Edoc carry paths of pre-built libraries

Given the topological sort applied to top-level apps, we should be able
to carry the edoc values for paths configured when more than one app
exists.

This allows multiple disjoint app to have defined cross-linking in the
documentation.

Tests pending.
---
 src/rebar_prv_edoc.erl | 35 ++++++++++++++++++++++++++---------
 1 file changed, 26 insertions(+), 9 deletions(-)

diff --git a/src/rebar_prv_edoc.erl b/src/rebar_prv_edoc.erl
index 6cefe14e..465fc346 100644
--- a/src/rebar_prv_edoc.erl
+++ b/src/rebar_prv_edoc.erl
@@ -33,17 +33,25 @@ do(State) ->
     code:add_pathsa(rebar_state:code_paths(State, all_deps)),
     ProjectApps = rebar_state:project_apps(State),
     Providers = rebar_state:providers(State),
-    EDocOpts = rebar_state:get(State, edoc_opts, []),
+    EdocOpts = rebar_state:get(State, edoc_opts, []),
+    ShouldAccPaths = not has_configured_paths(EdocOpts),
     Cwd = rebar_state:dir(State),
     rebar_hooks:run_all_hooks(Cwd, pre, ?PROVIDER, Providers, State),
-    lists:foreach(fun(AppInfo) ->
-                          rebar_hooks:run_all_hooks(Cwd, pre, ?PROVIDER, Providers, AppInfo, State),
-                          AppName = ec_cnv:to_list(rebar_app_info:name(AppInfo)),
-                          ?INFO("Running edoc for ~s", [AppName]),
-                          AppDir = rebar_app_info:dir(AppInfo),
-                          ok = edoc:application(list_to_atom(AppName), AppDir, EDocOpts),
-                          rebar_hooks:run_all_hooks(Cwd, post, ?PROVIDER, Providers, AppInfo, State)
-                  end, ProjectApps),
+    lists:foldl(fun(AppInfo, EdocOptsAcc) ->
+                    rebar_hooks:run_all_hooks(Cwd, pre, ?PROVIDER, Providers, AppInfo, State),
+                    AppName = ec_cnv:to_list(rebar_app_info:name(AppInfo)),
+                    ?INFO("Running edoc for ~s", [AppName]),
+                    AppDir = rebar_app_info:dir(AppInfo),
+                    ok = edoc:application(list_to_atom(AppName), AppDir, EdocOptsAcc),
+                    rebar_hooks:run_all_hooks(Cwd, post, ?PROVIDER, Providers, AppInfo, State),
+                    case ShouldAccPaths of
+                        true ->
+                            %% edoc wants / on all OSes
+                            add_to_paths(EdocOptsAcc, AppDir++"/doc");
+                        false ->
+                            EdocOptsAcc
+                    end
+                end, EdocOpts, ProjectApps),
     rebar_hooks:run_all_hooks(Cwd, post, ?PROVIDER, Providers, State),
     rebar_utils:cleanup_code_path(rebar_state:code_paths(State, default)),
     {ok, State}.
@@ -55,3 +63,12 @@ format_error(Reason) ->
 %% ===================================================================
 %% Internal functions
 %% ===================================================================
+has_configured_paths(EdocOpts) ->
+    proplists:get_value(dir, EdocOpts) =/= undefined.
+
+add_to_paths([], Path) ->
+    [{doc_path, [Path]}];
+add_to_paths([{doc_path, Paths}|T], Path) ->
+    [{doc_path, [Path | Paths]} | T];
+add_to_paths([H|T], Path) ->
+    [H | add_to_paths(Path, T)].

From 2c78cfd557249166cdd264d976ca191eb8a5061f Mon Sep 17 00:00:00 2001
From: Fred Hebert <mononcqc@ferd.ca>
Date: Thu, 25 Aug 2016 09:35:59 -0400
Subject: [PATCH 2/2] Add tests for multi-app edoc linking working

---
 test/rebar_edoc_SUITE.erl                     | 52 +++++++++++++++++++
 .../foo/apps/bar1/src/bar1.app.src            | 16 ++++++
 .../foo/apps/bar1/src/bar1.erl                |  9 ++++
 .../foo/apps/bar1/src/bar1_app.erl            | 26 ++++++++++
 .../foo/apps/bar1/src/bar1_sup.erl            | 35 +++++++++++++
 .../foo/apps/bar2/src/bar2.app.src            | 16 ++++++
 .../foo/apps/bar2/src/bar2.erl                |  9 ++++
 .../foo/apps/bar2/src/bar2_app.erl            | 26 ++++++++++
 .../foo/apps/bar2/src/bar2_sup.erl            | 35 +++++++++++++
 .../foo/apps/foo/src/foo.app.src              | 17 ++++++
 .../foo/apps/foo/src/foo.erl                  | 19 +++++++
 .../foo/apps/foo/src/foo_app.erl              | 26 ++++++++++
 .../foo/apps/foo/src/foo_sup.erl              | 35 +++++++++++++
 13 files changed, 321 insertions(+)
 create mode 100644 test/rebar_edoc_SUITE.erl
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1.app.src
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1.erl
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1_app.erl
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1_sup.erl
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2.app.src
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2.erl
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2_app.erl
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2_sup.erl
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo.app.src
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo.erl
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo_app.erl
 create mode 100644 test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo_sup.erl

diff --git a/test/rebar_edoc_SUITE.erl b/test/rebar_edoc_SUITE.erl
new file mode 100644
index 00000000..fded2b0a
--- /dev/null
+++ b/test/rebar_edoc_SUITE.erl
@@ -0,0 +1,52 @@
+-module(rebar_edoc_SUITE).
+-include_lib("common_test/include/ct.hrl").
+-include_lib("eunit/include/eunit.hrl").
+-compile(export_all).
+
+all() -> [multiapp].
+
+init_per_testcase(multiapp, Config) ->
+    application:load(rebar),
+    DataDir = ?config(data_dir, Config),
+    PrivDir = ?config(priv_dir, Config),
+    Name = rebar_test_utils:create_random_name("multiapp"),
+    AppsDir = filename:join([PrivDir, rebar_test_utils:create_random_name(Name)]),
+    ec_file:copy(filename:join([DataDir, "foo"]), AppsDir, [recursive]),
+    Verbosity = rebar3:log_level(),
+    rebar_log:init(command_line, Verbosity),
+    State = rebar_state:new([{base_dir, filename:join([AppsDir, "_build"])}
+                            ,{root_dir, AppsDir}]),
+    [{apps, AppsDir}, {state, State}, {name, Name} | Config].
+
+end_per_testcase(_, Config) ->
+    Config.
+
+multiapp(Config) ->
+    %% With an empty config (no `dir'), links are being processed
+    RebarConfig = [],
+    rebar_test_utils:run_and_check(Config, RebarConfig, ["edoc"], {ok, []}),
+    %% validate that all doc entries are generated and links work
+    AppsDir = ?config(apps, Config),
+    ct:pal("AppsDir: ~s", [AppsDir]),
+    ?assert(file_content_matches(
+              filename:join([AppsDir, "apps", "bar1", "doc", "bar1.html"]),
+              "barer1")),
+    ?assert(file_content_matches(
+              filename:join([AppsDir, "apps", "bar2", "doc", "bar2.html"]),
+              "barer2")),
+    %% Links are in place for types
+    ?assert(file_content_matches(
+              filename:join([AppsDir, "apps", "foo", "doc", "foo.html"]),
+              "barer1")),
+    ?assert(file_content_matches(
+              filename:join([AppsDir, "apps", "foo", "doc", "foo.html"]),
+              "apps/bar1/doc/bar1.html")).
+
+
+file_content_matches(Path, Regex) ->
+    case file:read_file(Path) of
+        {ok, Bin} ->
+            nomatch =/= re:run(Bin, Regex);
+        {error, Reason} ->
+            Reason
+    end.
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1.app.src b/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1.app.src
new file mode 100644
index 00000000..6e7ec246
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1.app.src
@@ -0,0 +1,16 @@
+{application, bar1,
+ [{description, "An OTP application"},
+  {vsn, "0.1.0"},
+  {registered, []},
+  {mod, { bar1_app, []}},
+  {applications,
+   [kernel,
+    stdlib
+   ]},
+  {env,[]},
+  {modules, []},
+
+  {maintainers, []},
+  {licenses, []},
+  {links, []}
+ ]}.
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1.erl b/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1.erl
new file mode 100644
index 00000000..2700aefb
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1.erl
@@ -0,0 +1,9 @@
+-module(bar1).
+-export([bar1/0]).
+-export_type([barer1/0]).
+
+-type barer1() :: string().
+
+% @doc Bar1 bars the bar.
+-spec bar1() -> barer1().
+bar1() -> "Barer1".
\ No newline at end of file
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1_app.erl b/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1_app.erl
new file mode 100644
index 00000000..414ac30b
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1_app.erl
@@ -0,0 +1,26 @@
+%%%-------------------------------------------------------------------
+%% @doc bar1 public API
+%% @end
+%%%-------------------------------------------------------------------
+
+-module(bar1_app).
+
+-behaviour(application).
+
+%% Application callbacks
+-export([start/2, stop/1]).
+
+%%====================================================================
+%% API
+%%====================================================================
+
+start(_StartType, _StartArgs) ->
+    bar1_sup:start_link().
+
+%%--------------------------------------------------------------------
+stop(_State) ->
+    ok.
+
+%%====================================================================
+%% Internal functions
+%%====================================================================
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1_sup.erl b/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1_sup.erl
new file mode 100644
index 00000000..f9d66706
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/bar1/src/bar1_sup.erl
@@ -0,0 +1,35 @@
+%%%-------------------------------------------------------------------
+%% @doc bar1 top level supervisor.
+%% @end
+%%%-------------------------------------------------------------------
+
+-module(bar1_sup).
+
+-behaviour(supervisor).
+
+%% API
+-export([start_link/0]).
+
+%% Supervisor callbacks
+-export([init/1]).
+
+-define(SERVER, ?MODULE).
+
+%%====================================================================
+%% API functions
+%%====================================================================
+
+start_link() ->
+    supervisor:start_link({local, ?SERVER}, ?MODULE, []).
+
+%%====================================================================
+%% Supervisor callbacks
+%%====================================================================
+
+%% Child :: {Id,StartFunc,Restart,Shutdown,Type,Modules}
+init([]) ->
+    {ok, { {one_for_all, 0, 1}, []} }.
+
+%%====================================================================
+%% Internal functions
+%%====================================================================
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2.app.src b/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2.app.src
new file mode 100644
index 00000000..58de8bcb
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2.app.src
@@ -0,0 +1,16 @@
+{application, bar2,
+ [{description, "An OTP application"},
+  {vsn, "0.1.0"},
+  {registered, []},
+  {mod, { bar2_app, []}},
+  {applications,
+   [kernel,
+    stdlib
+   ]},
+  {env,[]},
+  {modules, []},
+
+  {maintainers, []},
+  {licenses, []},
+  {links, []}
+ ]}.
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2.erl b/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2.erl
new file mode 100644
index 00000000..c639db0f
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2.erl
@@ -0,0 +1,9 @@
+-module(bar2).
+-export([bar2/0]).
+-export_type([barer2/0]).
+
+-type barer2() :: string().
+
+% @doc Bar2 bars the bar2.
+-spec bar2() -> barer2().
+bar2() -> "Barer2".
\ No newline at end of file
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2_app.erl b/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2_app.erl
new file mode 100644
index 00000000..d0058a00
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2_app.erl
@@ -0,0 +1,26 @@
+%%%-------------------------------------------------------------------
+%% @doc bar2 public API
+%% @end
+%%%-------------------------------------------------------------------
+
+-module(bar2_app).
+
+-behaviour(application).
+
+%% Application callbacks
+-export([start/2, stop/1]).
+
+%%====================================================================
+%% API
+%%====================================================================
+
+start(_StartType, _StartArgs) ->
+    bar2_sup:start_link().
+
+%%--------------------------------------------------------------------
+stop(_State) ->
+    ok.
+
+%%====================================================================
+%% Internal functions
+%%====================================================================
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2_sup.erl b/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2_sup.erl
new file mode 100644
index 00000000..0bdaf4ab
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/bar2/src/bar2_sup.erl
@@ -0,0 +1,35 @@
+%%%-------------------------------------------------------------------
+%% @doc bar2 top level supervisor.
+%% @end
+%%%-------------------------------------------------------------------
+
+-module(bar2_sup).
+
+-behaviour(supervisor).
+
+%% API
+-export([start_link/0]).
+
+%% Supervisor callbacks
+-export([init/1]).
+
+-define(SERVER, ?MODULE).
+
+%%====================================================================
+%% API functions
+%%====================================================================
+
+start_link() ->
+    supervisor:start_link({local, ?SERVER}, ?MODULE, []).
+
+%%====================================================================
+%% Supervisor callbacks
+%%====================================================================
+
+%% Child :: {Id,StartFunc,Restart,Shutdown,Type,Modules}
+init([]) ->
+    {ok, { {one_for_all, 0, 1}, []} }.
+
+%%====================================================================
+%% Internal functions
+%%====================================================================
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo.app.src b/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo.app.src
new file mode 100644
index 00000000..9987fd56
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo.app.src
@@ -0,0 +1,17 @@
+{application, foo,
+ [{description, "An OTP application"},
+  {vsn, "0.1.0"},
+  {registered, []},
+  {mod, { foo_app, []}},
+  {applications,
+   [kernel,
+    stdlib,
+    bar1, bar2
+   ]},
+  {env,[]},
+  {modules, []},
+
+  {maintainers, []},
+  {licenses, []},
+  {links, []}
+ ]}.
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo.erl b/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo.erl
new file mode 100644
index 00000000..52e3d0a6
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo.erl
@@ -0,0 +1,19 @@
+-module(foo).
+
+-export([foo/0, bar1/0, bar2/0]).
+
+-export_type([fooer/0]).
+
+-type fooer() :: string().
+
+% @doc Foo function returns fooer.
+-spec foo() -> fooer().
+foo() -> "fooer".
+
+% @doc Bar1 function returns barer1.
+-spec bar1() -> bar1:barer1().
+bar1() -> bar1:bar1().
+
+% @doc Bar2 functions returns barer2.
+-spec bar2() -> bar2:barer2().
+bar2() -> bar2:bar2().
\ No newline at end of file
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo_app.erl b/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo_app.erl
new file mode 100644
index 00000000..d0158d7a
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo_app.erl
@@ -0,0 +1,26 @@
+%%%-------------------------------------------------------------------
+%% @doc foo public API
+%% @end
+%%%-------------------------------------------------------------------
+
+-module(foo_app).
+
+-behaviour(application).
+
+%% Application callbacks
+-export([start/2, stop/1]).
+
+%%====================================================================
+%% API
+%%====================================================================
+
+start(_StartType, _StartArgs) ->
+    foo_sup:start_link().
+
+%%--------------------------------------------------------------------
+stop(_State) ->
+    ok.
+
+%%====================================================================
+%% Internal functions
+%%====================================================================
diff --git a/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo_sup.erl b/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo_sup.erl
new file mode 100644
index 00000000..67e88b44
--- /dev/null
+++ b/test/rebar_edoc_SUITE_data/foo/apps/foo/src/foo_sup.erl
@@ -0,0 +1,35 @@
+%%%-------------------------------------------------------------------
+%% @doc foo top level supervisor.
+%% @end
+%%%-------------------------------------------------------------------
+
+-module(foo_sup).
+
+-behaviour(supervisor).
+
+%% API
+-export([start_link/0]).
+
+%% Supervisor callbacks
+-export([init/1]).
+
+-define(SERVER, ?MODULE).
+
+%%====================================================================
+%% API functions
+%%====================================================================
+
+start_link() ->
+    supervisor:start_link({local, ?SERVER}, ?MODULE, []).
+
+%%====================================================================
+%% Supervisor callbacks
+%%====================================================================
+
+%% Child :: {Id,StartFunc,Restart,Shutdown,Type,Modules}
+init([]) ->
+    {ok, { {one_for_all, 0, 1}, []} }.
+
+%%====================================================================
+%% Internal functions
+%%====================================================================