Make rebar3 friendly

Author: Silviu Caragea

.travis.yml

@@ -0,0 +1,20 @@
+language: erlang
+matrix:
+  include:
+    - os: linux
+      dist: xenial
+      otp_release: 21.1
+    - os: linux
+      dist: xenial
+      otp_release: 20.3.8.5
+    - os: linux
+      dist: xenial
+      otp_release: 19.3
+    - os: osx
+      language: generic
+before_script:
+- if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update; fi
+- if [[ $TRAVIS_OS_NAME == osx ]]; then brew install erlang || true; fi
+- curl https://s3.amazonaws.com/rebar3/rebar3 --output rebar3 && chmod +x rebar3
+script:
+    - ./rebar3 compile

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Silviu Caragea
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,35 @@
+C_SRC_DIR = $(shell pwd)/c_src
+C_SRC_ENV ?= $(C_SRC_DIR)/env.mk
+
+#regenerate all the time the env.mk
+ifneq ($(wildcard $(C_SRC_DIR)),)
+	GEN_ENV ?= $(shell erl -noshell -s init stop -eval "file:write_file(\"$(C_SRC_ENV)\", \
+		io_lib:format( \
+			\"ERTS_INCLUDE_DIR ?= ~s/erts-~s/include/~n\" \
+			\"ERL_INTERFACE_INCLUDE_DIR ?= ~s~n\" \
+			\"ERL_INTERFACE_LIB_DIR ?= ~s~n\", \
+			[code:root_dir(), erlang:system_info(version), \
+			code:lib_dir(erl_interface, include), \
+			code:lib_dir(erl_interface, lib)])), \
+		halt().")
+    $(GEN_ENV)
+endif
+
+include $(C_SRC_ENV)
+
+cpplint:
+	cpplint --counting=detailed \
+	        --filter=-legal/copyright,-build/include_subdir,-build/include_order,-whitespace/blank_line,-whitespace/braces,-whitespace/indent,-whitespace/parens,-whitespace/newline \
+            --linelength=300 \
+			--exclude=c_src/*.o --exclude=c_src/*.mk  \
+			c_src/*.*
+
+cppcheck:
+	cppcheck -j 8 \
+             -I $(ERTS_INCLUDE_DIR) \
+             -I $(ERL_INTERFACE_INCLUDE_DIR) \
+             --force \
+             --enable=all \
+	 		 --xml-version=2 \
+	 		 --output-file=cppcheck_results.xml \
+	 		 c_src/

rebar.config

@@ -1,6 +1,17 @@
 {pre_hooks, [{"(linux|darwin)", compile, "make V=0 -C c_src -j 8"}]}.
 {post_hooks, [{"(linux|darwin)", clean, "make -C c_src clean"}]}.
 
+{artifacts, ["priv/epqueue_nif.so"]}.
+
 %because enif_binary_to_term and enif_term_to_binary are not available in previous versions.
 %this can be changed if it's required by moving the encoding/decoding in erlang and in NIF only store the received binary
-{require_min_otp_vsn, "R19.*"}.
+{require_min_otp_vsn, "R19.*"}.
+
+{project_plugins, [rebar3_hex]}.
+
+{deps, []}.
+
+{erl_opts, [
+    warnings_as_errors,
+    warn_export_all
+]}.

src/epqueue.app.src

@@ -1,7 +1,10 @@
 {application, epqueue, [
     {description, "Erlang Priority Queue"},
-    {vsn, "1.1"},
+    {vsn, "1.2.0"},
     {registered, []},
-    {applications, [kernel, stdlib]},
+    {applications, [
+        kernel,
+        stdlib
+    ]},
     {env, []}
 ]}.

src/epqueue.erl

@@ -1,44 +1,60 @@
 -module(epqueue).
--author("silviu.caragea").
 
--export([new/0, new/1, size/1, insert/3, remove/2, pop/1, peek/1]).
-
-
--spec(new() -> {ok, QueueRef::reference()} | badarg | {error, Reason :: binary()}).
+-export([
+    new/0,
+    new/1,
+    size/1,
+    insert/3,
+    remove/2,
+    pop/1,
+    peek/1
+]).
+
+-type error() :: badarg | {error, binary()}.
+-type queue_option() :: {global_lock, boolean()}.
+-type priority() :: non_neg_integer().
+-type data() :: any().
+-type queue_ref() :: reference().
+-type data_ref() :: reference().
+
+-spec new() ->
+    {ok, queue_ref()} | error().
 
 new() ->
     epqueue_nif:new([]).
 
--spec(new(Options::list()) -> {ok, QueueRef :: reference()} | badarg | {error, Reason :: binary()}).
+-spec new([queue_option()]) ->
+    {ok, queue_ref()} | error().
 
 new(Options) ->
     epqueue_nif:new(Options).
 
--spec(size(QueueRef::reference()) -> badarg | integer()).
+-spec size(queue_ref()) ->
+    non_neg_integer() | badarg.
 
 size(QueueRef) ->
     epqueue_nif:size(QueueRef).
 
--spec(insert(QueueRef::reference(), Data::term(), Priority::integer()) ->
-    {ok, ItemRef :: reference()} | badarg | {error, Reason :: binary()}).
+-spec insert(queue_ref(), data(), priority()) ->
+    {ok, data_ref()} | error().
 
 insert(QueueRef, Data, Priority) ->
     epqueue_nif:insert(QueueRef, Data, Priority).
 
--spec(remove(QueueRef::reference(), Ref::reference()) ->
-    boolean() |  badarg | {error, Reason :: binary()}).
+-spec remove(queue_ref(), data_ref()) ->
+    boolean() | error().
 
 remove(QueueRef, Ref) ->
     epqueue_nif:remove(QueueRef, Ref).
 
--spec(pop(QueueRef::reference()) ->
-    {ok, Data::term(), Priority::integer()} | badarg | {error, Reason :: binary()}).
+-spec pop(queue_ref()) ->
+    {ok, data(), priority()} | error().
 
 pop(QueueRef) ->
     epqueue_nif:pop(QueueRef).
 
--spec(peek(QueueRef::reference()) ->
-    {ok, Data::term(), Priority::integer()} | badarg | {error, Reason :: binary()}).
+-spec peek(queue_ref()) ->
+    {ok, data(), priority()} | error().
 
 peek(QueueRef) ->
-    epqueue_nif:peek(QueueRef).
+    epqueue_nif:peek(QueueRef).

src/epqueue_nif.erl

@@ -1,5 +1,4 @@
 -module(epqueue_nif).
--author("silviu.caragea").
 
 -define(NOT_LOADED, not_loaded(?LINE)).
 
@@ -14,25 +13,11 @@
     peek/1
 ]).
 
-%% nif functions
-
 load_nif() ->
     SoName = get_priv_path(?MODULE),
     io:format(<<"Loading library: ~p ~n">>, [SoName]),
     ok = erlang:load_nif(SoName, 0).
 
-get_priv_path(File) ->
-    case code:priv_dir(epqueue) of
-        {error, bad_name} ->
-            Ebin = filename:dirname(code:which(?MODULE)),
-            filename:join([filename:dirname(Ebin), "priv", File]);
-        Dir ->
-            filename:join(Dir, File)
-    end.
-
-not_loaded(Line) ->
-    erlang:nif_error({not_loaded, [{module, ?MODULE}, {line, Line}]}).
-
 new(_Options) ->
     ?NOT_LOADED.
 
@@ -49,4 +34,18 @@ pop(_QueueRef) ->
     ?NOT_LOADED.
 
 peek(_QueueRef) ->
-    ?NOT_LOADED.
+    ?NOT_LOADED.
+
+% internals
+
+get_priv_path(File) ->
+    case code:priv_dir(epqueue) of
+        {error, bad_name} ->
+            Ebin = filename:dirname(code:which(?MODULE)),
+            filename:join([filename:dirname(Ebin), "priv", File]);
+        Dir ->
+            filename:join(Dir, File)
+    end.
+
+not_loaded(Line) ->
+    erlang:nif_error({not_loaded, [{module, ?MODULE}, {line, Line}]}).