Add custom rebar plugin to create releases (#5)

* Create custom rebar plugin

* Add missing modules

* Remove invalid fields

* Add `cauder_plugin`

* Add `cauder_plugin` as a new module in IntelliJ

* Add launcher script for Windows and Unix

* Set executable bit in unix systems

* Create `include` folder

* Create `priv` folder

* Add improved clean command to cauder plugin

Refactor cauder plugin

* Unignore rebar3

* Update .gitignore

* Update commands

* Move `cauder_plugin.iml` file

* Remove line break

* Delete Makefile

* Remove redundant line and add clarification

* Update execute file permission

* Rename release launch script for linux

Author: SackCastellon

.gitignore

@@ -4,9 +4,8 @@
 erl_crash.dump
 
 # Rebar 3
-rebar3
-rebar3.cmd
 rebar.lock
+rebar3.crashdump
 _build/
 
 ### JetBrains
@@ -17,6 +16,7 @@ _build/
 .idea/**/usage.statistics.xml
 .idea/**/dictionaries
 .idea/**/shelf
+.idea/emacs.xml
 
 # IntelliJ
 out/

.idea/modules.xml

@@ -4,46 +4,58 @@ A Causal-Consistent Reversible Debugger for Erlang
 
 ![CauDEr screenshot](screenshot.png)
 
+**_CAUTION: This tool is still under development_**
 
 ## Dependencies
 
-* **Erlang/OTP** ≥ 23.0
-* **Rebar3** (Optional)
-* **Make**
-
+* Erlang 23 or higher
 
 ## Building
 
-You can use the following `make` tasks to build CauDEr:
+To build the project, type:
 
-* Create _escript_: `make` (or `make escriptize`)
-* Compile only: `make compile`
-* Build documentation: `make edoc`
-* Run dialyzer: `make dialyzer`
-* Cleanup: `make clean`
+    ./rebar3 compile
 
+To create an _escript_, type:
 
-## Running
+    ./rebar3 escriptize
+
+To create a release for your platform, type:
+
+    ./rebar3 reltool
+
+To run tests, type:
+
+    ./rebar3 do eunit, ct
+
+To run dialyzer, type:
 
-You can run CauDEr in multiple ways:
+    ./rebar3 dialyzer
+
+To clean-up the build files, type:
+
+    ./rebar3 clean
+
+## Running
 
 ### Using the Erlang shell
 
-Using `rebar3 shell` will start a shell with all the required dependencies.
+To start an Erlang shell with all the required dependencies, type:
 
-There are multiples ways to run CauDEr:
+    ./rebar3 shell
 
-#### Like an _escript_
+There are multiples ways to run CauDEr from the Erlang shell:
 
-Calling the function `cauder:main/0` will start CauDEr like the _escript_.
+#### Like an _escript_
 
 ```
 Eshell V11.0  (abort with ^G)
 1> cauder:main().
 ok
 ```
 
-ℹ️ This function will wait for the GUI to close before returning, which means the shell will be blocked.
+ℹ️ This function will wait for the CauDEr window to close before returning,
+which means the shell will be blocked.
 
 #### Like an application
 
@@ -53,47 +65,41 @@ Eshell V11.0  (abort with ^G)
 ok
 ```
 
-ℹ️ To stop CauDEr you can use `application:stop(cauder)`, but it is not necessary if you just close the window.
+ℹ️ To stop CauDEr you can use `application:stop(cauder)`, or simply close the
+window.
 
 #### Manually
 
-##### Debugger only
-
-To start the debugger only you can call the following function:
-
 ```
 Eshell V11.0  (abort with ^G)
 1> cauder:start(). % Starting the debugger
 {ok,<0.80.0>}
+2> cauder_wx:start(). % Starting the GUI
+{ok,<0.82.0>,{wx_ref,35,wxFrame,<0.82.0>}}
 ```
 
-##### Debugger and GUI
+⚠️ If you try to start the GUI without previously starting the debugger, it will
+fail with the following error: `{error,{not_started,cauder}}`
 
-To start the debugger and the GUI you will need to call the following functions in order:
 
-```
-Eshell V11.0  (abort with ^G)
-1> cauder:start(). % Starting the debugger
-{ok,<0.80.0>}
-2> cauder_wx:start(). % Starting the GUI
-{ok,<0.82.0>,{wx_ref,35,wxFrame,<0.82.0>}}
-```
+### Using the _escript_
 
-⚠️ If you try to start the GUI without previously starting the debugger, it will fail with the following error: `{error,{not_started,cauder}}`
+    ./_build/default/bin/cauder
 
+ℹ️ This will block the current shell until the CauDEr window is closed.
 
-#### Using the _escript_
+### Using the release
 
-Simply run the `cauder` binary generated in the `_build/default/bin` folder:
+    ./_build/default/reltool/cauder
 
-```shell script
-./_build/default/bin/cauder
-```
+ℹ️ This script will start CauDEr in detached mode.
 
-## Usage
+## Documentation
 
-For more information about how to use CauDEr you can check the [Wiki](https://github.com/mistupv/cauder-v2/wiki) (Under construction!)
+To learn how to use CauDEr you can check the
+[Wiki](https://github.com/mistupv/cauder-v2/wiki) (Under construction!)
 
 ## License
 
-See [LICENSE](LICENSE) file.
+This project is available under the terms of the MIT license. See the
+[`LICENSE`](LICENSE) file for the copyright information and licensing terms.

Makefile

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="ERLANG_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="erlang" name="Erlang">
+      <configuration />
+    </facet>
+  </component>
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+    </content>
+    <orderEntry type="jdk" jdkName="Erlang 23" jdkType="Erlang SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

README.md

@@ -0,0 +1,2 @@
+{erl_opts, [debug_info]}.
+{deps, []}.

_checkouts/cauder_plugin/cauder_plugin.iml

@@ -0,0 +1,9 @@
+{application, cauder_plugin,
+  [
+    {description, "Custom rebar3 plugin for CauDEr"},
+    {vsn, "0.1.0"},
+    {registered, []},
+    {applications, [kernel, stdlib]},
+    {env, []},
+    {modules, []}
+  ]}.

_checkouts/cauder_plugin/rebar.config

@@ -0,0 +1,17 @@
+-module(cauder_plugin).
+
+-export([init/1]).
+
+-spec init(rebar_state:t()) -> {ok, rebar_state:t()}.
+init(State) ->
+  {ok, init_providers(State)}.
+
+init_providers(State) ->
+  lists:foldl(fun init_provider/2, State, [
+    cauder_plugin_prv_clean,
+    cauder_plugin_prv_reltool
+  ]).
+
+init_provider(Module, State) ->
+  {ok, NewState} = Module:init(State),
+  NewState.

_checkouts/cauder_plugin/src/cauder_plugin.app.src

@@ -0,0 +1,67 @@
+-module(cauder_plugin_prv_clean).
+
+%% API
+-export([init/1, do/1, format_error/1]).
+
+-include_lib("kernel/include/file.hrl").
+
+-define(PROVIDER, ?MODULE).
+-define(DEPS, []).
+
+
+%%%=============================================================================
+%%% API
+%%%=============================================================================
+
+
+%% Called when rebar3 first boots, before even parsing the arguments
+%% or commands to be run. Purely initiates the provider, and nothing
+%% else should be done here.
+
+-spec init(rebar_state:t()) -> {ok, rebar_state:t()}.
+
+init(State) ->
+  Provider = providers:create(
+    [
+      {name, ?PROVIDER},
+      {module, ?MODULE},
+      {bare, true},
+      {deps, ?DEPS},
+      {desc, "Creates a release of CauDEr using reltool"},
+      {short_desc, "Creates a release of CauDEr using reltool"},
+      {example, "rebar3 " ++ atom_to_list(?PROVIDER)},
+      {opts, []}
+    ]),
+  {ok, rebar_state:add_provider(State, Provider)}.
+
+
+%% Run the code for the plugin. The command line argument are parsed
+%% and dependencies have been run.
+
+-spec do(rebar_state:t()) -> {ok, rebar_state:t()} | {error, string()}.
+
+do(State) ->
+  case rebar_state:current_app(State) of
+    undefined ->
+      ok;
+    AppInfo ->
+      case rebar_app_info:name(AppInfo) of
+        <<"cauder">> ->
+          rebar_file_utils:rm_rf(rebar_dir:base_dir(State));
+        _ ->
+          ok
+      end
+  end,
+
+  {ok, State}.
+
+
+%% When an exception is raised or a value returned as
+%% `{error, {?MODULE, Reason}}` will see the `format_error(Reason)`
+%% function called for them, so a string can be formatted explaining
+%% the issue.
+
+-spec format_error(any()) -> iolist().
+
+format_error(Reason) ->
+  io_lib:format("~p", [Reason]).