ephp

%% @doc The cover module is in charge to store the information about the lines
%%      executed and the times. Finally it generates a XML file with that
%%      information in the coverage format. It uses the version 4.
%% @end
-module(ephp_cover).

-author('manuel@altenwald.com').

-behaviour(gen_server).

-include("ephp_parser.hrl").
-include("ephp.hrl").

-define(XML_HEAD,
        "<?xml version=\"1.0\"?>"
        "<!--DOCTYPE coverage SYSTEM "
        "\"http://cobertura.sourceforge.net/xml/coverage-04.dtd\"-->"
        "<coverage timestamp=\"~b\" line-rate=\"~f\" "
        "lines-covered=\"0\" lines-valid=\"0\" branch-rate=\"0.0\" "
        "branches-covered=\"0\" branches-valid=\"0\" "
        "complexity=\"0\" version=\"1.9.4.1\">"
        "<sources>~s</sources>"
        "<packages>~s</packages>"
        "</coverage>").
-define(SOURCE, "<source>~s</source>").
-define(PACKAGE,
        "<package name=\"~s\" line-rate=\"~f\" branch-rate=\"0\" "
        "complexity=\"0\"><classes>~s</classes></package>").
-define(CLASS,
        "<class name=\"~s\" filename=\"~s\" line-rate=\"~f\" "
        "branch-rate=\"0.0\" complexity=\"0\">"
        "<methods/>"
        "<lines>~s</lines>"
        "</class>").

                %% TODO methods should have some more information like...

-define(ENTRY, "<line number=\"~b\" hits=\"~b\"/>").

-export([start_link/0, init_file/3, store/3, store/4, dump/0, get_config/0]).
%% gen_server callbacks
-export([init/1, handle_call/3, handle_cast/2, handle_info/2, code_change/3,
         terminate/2]).

-type is_cover() :: boolean().
-type hits() :: non_neg_integer().
-type file_line() :: pos_integer().
-type cover_dict() :: [{file_line(), hits()}].
-type statement_type() ::
    print | eval | assign | if_block | switch | switch_case | for | foreach | while |
    {call, binary()} | pre_incr | post_incr | pre_decr | post_decr | {op, Type :: atom()} |
    class | function | global | return | int | float | text | object | define | constant |
    switch_default.

-spec start_link() -> ok.
%% @doc ensure the cover information is in the process.
start_link() ->
    case erlang:get(cover) of
        undefined ->
            %% FIXME: generate this information under a supervisor with
            %%        the context.
            {ok, PID} = gen_server:start_link(?MODULE, [self()], []),
            erlang:put(cover, PID),
            ok;
        _ ->
            ok
    end.

-spec init_file(is_cover(), Filename :: binary(), Compiled :: [main_statement()]) -> ok.
%% @doc store the lines of the file inside of the cover information.
init_file(false, _Filename, _Compiled) ->
    ok;
init_file(true, Filename, Compiled) ->
    case erlang:get(cover) of
        undefined ->
            ok;
        PID ->
            gen_server:cast(PID, {init_file, Filename, Compiled})
    end.

-spec store(is_cover(),
            statement_type(),
            FileOrContext :: binary() | ephp:context_id(),
            line() | undefined) ->
               ok.
%% @doc store the information about the statement passed as a param. Calls to
%%      store/3 only if is_cover() (first param) is true.
%% @end
store(_Cover, _Type, _FileOrContext, undefined) ->
    ok;
store(false = _Cover, _Type, _FileOrContext, _Line) ->
    ok;
store(true = _Cover, Type, FileOrContext, Line) ->
    store(Type, FileOrContext, Line).

-spec store(statement_type(),
            FileOrContext :: binary() | ephp:context_id(),
            line() | undefined) ->
               ok.
%% @doc store the information about the statement passed as a param.
store(_Type, _File, undefined) ->
    ok;
store(Type, Context, Line) when is_reference(Context) ->
    File = ephp_context:get_active_file(Context),
    store(Type, File, Line);
store(_Type, File, Pos) ->
    case erlang:get(cover) of
        undefined ->
            ok;
        PID ->
            gen_server:cast(PID, {store, File, Pos})
    end.

-spec dump() -> ok.
%% @doc dump the coverage information to the output file defined by
%%      cover.output or cobertura.xml by default.
%% @end
dump() ->
    case erlang:get(cover) of
        undefined ->
            ok;
        PID ->
            gen_server:call(PID, dump)
    end.

-spec get_config() -> boolean().
%% @doc get information about whether cover is enabled.
get_config() ->
    ephp_config:get_bool(<<"cover.enable">>).

%% gen_server callbacks

init([Parent]) ->
    monitor(process, Parent),
    {ok, []}.

handle_cast({init_file, Filename, Compiled}, Files) ->
    case lists:keyfind(Filename, 1, Files) of
        {Filename, _} ->
            {noreply, Files};
        false ->
            Lines = process(Compiled, []),
            FileDict = lists:foldl(fun(N, D) -> orddict:store(N, 0, D) end, orddict:new(), Lines),
            {noreply, [{Filename, FileDict} | Files]}
    end;
handle_cast({store, File, Pos}, Files) ->
    Line =
        case Pos of
            #parser{row = L} ->
                L;
            {{line, L}, _} ->
                L
        end,
    NewFiles =
        orddict:update(File, fun(Dict) -> orddict:update_counter(Line, 1, Dict) end, [], Files),
    case ephp_config:get_bool(<<"cover.realtime">>, false) of
        true ->
            case whereis(ephp_config:get_atom(<<"cover.process">>)) of
                PID when is_pid(PID) ->
                    PID ! {run, File, Line};
                _ ->
                    io:format("=> ~s ~b~n", [File, Line])
            end;
        false ->
            ok
    end,
    {noreply, NewFiles}.

handle_call(dump, _From, Files) ->
    Classes = dump(Files, []),
    Percentage = total_percentage(Files),
    Packages = io_lib:format(?PACKAGE, ["base", Percentage, Classes]),
    Sources = lists:map(fun({File, _}) -> io_lib:format(?SOURCE, [dirname(File)]) end, Files),
    Epoch = ephp_datetime:posix_time_ms(),
    XML = io_lib:format(?XML_HEAD, [Epoch, Percentage, Sources, Packages]),
    Output =
        case ephp_config:get(<<"cover.output">>) of
            undefined ->
                <<"cobertura.xml">>;
            Filename ->
                Filename
        end,
    file:write_file(Output, XML),
    {reply, ok, Files}.

handle_info({'DOWN', _Ref, process, _Pid, _Reason}, State) ->
    {stop, normal, State}.

code_change(_OldVsn, State, _Extra) ->
    {ok, State}.

terminate(_Reason, _State) ->
    ok.

%% internal functions

-spec process(Compiled :: [main_statement()], Lines :: cover_dict()) -> cover_dict().
%% @doc get the line information from commands and return the dictionary with
%%      lines.
%% @end
process([{{line, L}, _} | Data], N) ->
    process(Data, [L | N]);
process([], N) ->
    lists:usort(N);
process([Data | Rest], N) when is_tuple(Data) ->
    process(Rest, process(erlang:tuple_to_list(Data), N));
process([Data | Rest], N) when is_list(Data) ->
    process(Rest, process(Data, N));
process([_ | Data], N) ->
    process(Data, N).

-spec dump(Files :: [binary()], Output :: iolist()) -> iolist().
%% @hidden
dump([], Classes) ->
    lists:reverse(Classes);
dump([{File, Dict} | Cover], Classes) ->
    Percentage = percentage(Dict),
    Lines = lists:flatmap(fun({Line, Hits}) -> io_lib:format(?ENTRY, [Line, Hits]) end, Dict),
    Class = io_lib:format(?CLASS, [name(File), basename(File), Percentage, Lines]),
    dump(Cover, [Class | Classes]).

-spec get_active_lines(cover_dict()) -> non_neg_integer().
%% @doc number of lines used in the running.
get_active_lines(Data) ->
    length(lists:filter(fun ({_, 0}) ->
                                false;
                            (_) ->
                                true
                        end,
                        Data)).

-spec percentage(cover_dict()) -> float().
%% @doc percentage between 0 and 1 about the coverage.
percentage(Data) ->
    get_active_lines(Data) / length(Data).

-spec total_percentage(Files :: [{File :: binary(), cover_dict()}]) -> float().
%% @doc percentage total for all of the files between 0 and 1 about the
%%      coverage.
%% @end
total_percentage(Files) ->
    {A, T} =
        lists:foldl(fun({_, Dict}, {A, T}) -> {A + get_active_lines(Dict), T + length(Dict)} end,
                    {0, 0},
                    Files),
    A / T.

-spec dirname(Filename :: binary()) -> binary().
%% @hidden
dirname(Filename) ->
    filename:dirname(Filename).

-spec basename(Filename :: binary()) -> binary().
%% @hidden
basename(Filename) ->
    filename:basename(Filename).

-spec name(Filename :: binary()) -> binary().
%% @hidden
name(Filename) ->
    filename:rootname(
        filename:basename(Filename)).