diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..63148db --- /dev/null +++ b/LICENSE @@ -0,0 +1,181 @@ +Copyright (c) 2016, Christopher Meiklejohn +All rights reserved. + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..a9a8b7c --- /dev/null +++ b/Makefile @@ -0,0 +1,51 @@ +PACKAGE ?= types +VERSION ?= $(shell git describe --tags) +BASE_DIR = $(shell pwd) +ERLANG_BIN = $(shell dirname $(shell which erl)) +REBAR = $(shell pwd)/rebar3 +MAKE = make + +.PHONY: rel deps test eqc plots + +all: compile + +## +## Compilation targets +## + +compile: + $(REBAR) compile + +clean: packageclean + $(REBAR) clean + +packageclean: + rm -fr *.deb + rm -fr *.tar.gz + +## +## Test targets +## + +check: test xref dialyzer lint + +test: ct eunit + +lint: + ${REBAR} as lint lint + +eqc: + ${REBAR} as test eqc + +eunit: + ${REBAR} as test eunit + +ct: + ${REBAR} as test ct + +shell: + ${REBAR} shell --apps types + +DIALYZER_APPS = kernel stdlib erts sasl eunit syntax_tools compiler crypto + +include tools.mk diff --git a/_build/default/lib/lager b/_build/default/lib/lager new file mode 160000 index 0000000..b2cb273 --- /dev/null +++ b/_build/default/lib/lager @@ -0,0 +1 @@ +Subproject commit b2cb2735713e3021e0761623ff595d53a545438e diff --git a/_build/default/lib/lasp_support b/_build/default/lib/lasp_support new file mode 160000 index 0000000..f5b7223 --- /dev/null +++ b/_build/default/lib/lasp_support @@ -0,0 +1 @@ +Subproject commit f5b72230e04a16a511f30cef22cdda1204cd7585 diff --git a/_build/default/lib/mochiweb b/_build/default/lib/mochiweb new file mode 160000 index 0000000..c3fb6ae --- /dev/null +++ b/_build/default/lib/mochiweb @@ -0,0 +1 @@ +Subproject commit c3fb6aed018d47a9c313daa966657a157d88dbc6 diff --git a/_build/default/lib/ranch b/_build/default/lib/ranch new file mode 160000 index 0000000..a5d2efc --- /dev/null +++ b/_build/default/lib/ranch @@ -0,0 +1 @@ +Subproject commit a5d2efcde9a34ad38ab89a26d98ea5335e88625a diff --git a/_build/default/lib/riak_dt b/_build/default/lib/riak_dt new file mode 160000 index 0000000..16ba975 --- /dev/null +++ b/_build/default/lib/riak_dt @@ -0,0 +1 @@ +Subproject commit 16ba975ca6980ddf76e3c3202411f29ba37c0329 diff --git a/_build/default/lib/time_compat b/_build/default/lib/time_compat new file mode 160000 index 0000000..6007f68 --- /dev/null +++ b/_build/default/lib/time_compat @@ -0,0 +1 @@ +Subproject commit 6007f68892104ebb6fa2366cebf9d928d8856273 diff --git a/include/.gitkeep b/include/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/priv/.gitkeep b/priv/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/rebar.config b/rebar.config new file mode 100644 index 0000000..2caf8cc --- /dev/null +++ b/rebar.config @@ -0,0 +1,102 @@ +{deps, [ + {time_compat, {git, "https://github.com/lasp-lang/time_compat", {tag, "0.0.2"}}}, + {lasp_support, {git, "https://github.com/lasp-lang/lasp_support", {tag, "0.0.2"}}}, + {ranch, {git, "https://github.com/extend/ranch.git", {tag, "1.2.1"}}}, + {lager, {git, "https://github.com/basho/lager", {tag, "3.1.0"}}}, + {mochiweb, {git, "https://github.com/mochi/mochiweb.git", {tag, "v2.12.2"}}}, + {riak_dt, ".*", {git, "https://github.com/basho/riak_dt", {tag, "develop"}}} + ]}. + +{dialyzer_base_plt_apps, [kernel, stdlib, erts, sasl, eunit, syntax_tools, compiler, crypto]}. +{xref_checks, [undefined_function_calls]}. +{erl_opts, [debug_info, + warnings_as_errors, + {platform_define, "^[0-9]+", namespaced_types}, + {parse_transform, lager_transform}]}. +{cover_enabled, true}. +{eunit_opts, [verbose, {report,{eunit_surefire,[{dir,"."}]}}]}. +{edoc_opts, [{preprocess, true}]}. + +{profiles, [ + {test, [ + {plugins, [{rebar3_eqc, {git, "https://github.com/kellymclaughlin/rebar3-eqc-plugin.git", {branch, "master"}}}]} + ]}, + {lint, [ + {plugins, [{rebar3_lint, {git, "https://github.com/project-fifo/rebar3_lint.git", {tag, "0.1.2"}}}]} + ]}, + {docs, [ + {deps, [{edown, ".*", {git, "https://github.com/uwiger/edown.git", {branch, "master"}}}]} + ]} +]}. + +{elvis, + [#{dirs => ["src"], + filter => "*.erl", + rules => [ + %% {elvis_style, line_length, + %% #{ignore => [], + %% limit => 80, + %% skip_comments => false}}, + {elvis_style, no_tabs}, + {elvis_style, no_trailing_whitespace}, + {elvis_style, macro_names, #{ignore => []}}, + %% {elvis_style, macro_module_names}, + {elvis_style, operator_spaces, #{rules => [{right, ","}, + {right, "++"}, + {left, "++"}]}}, + %% {elvis_style, nesting_level, #{level => 3}}, + {elvis_style, god_modules, + #{limit => 25, + ignore => []}}, + {elvis_style, no_if_expression}, + %% {elvis_style, invalid_dynamic_call, #{ignore => []}}, + {elvis_style, used_ignored_variable}, + {elvis_style, no_behavior_info}, + { + elvis_style, + module_naming_convention, + #{regex => "^[a-z]([a-z0-9]*_?)*(_SUITE)?$", + ignore => []} + }, + { + elvis_style, + function_naming_convention, + #{regex => "^([a-z][a-z0-9]*_?)*$"} + }, + {elvis_style, state_record_and_type}, + {elvis_style, no_spec_with_records} + %% {elvis_style, dont_repeat_yourself, #{min_complexity => 10}} + %% {elvis_style, no_debug_call, #{ignore => []}} + ] + }, + #{dirs => ["."], + filter => "Makefile", + rules => [{elvis_project, no_deps_master_erlang_mk, #{ignore => []}}, + {elvis_project, protocol_for_deps_erlang_mk, #{ignore => []}}] + }, + #{dirs => ["."], + filter => "rebar.config", + rules => [{elvis_project, no_deps_master_rebar, #{ignore => []}}, + {elvis_project, protocol_for_deps_rebar, #{ignore => []}}] + } + ] +}. + +{dialyzer, [ + {warnings, [no_return, + no_unused, + no_improper_lists, + no_fun_app, + no_match, + no_opaque, + no_fail_call, + no_contracts, + no_behaviours, + no_undefined_callbacks, + %% unmatched_returns, + error_handling, + race_conditions + %% overspecs, + %% underspecs, + %% specdiffs + ]}]}. diff --git a/rebar3 b/rebar3 new file mode 100755 index 0000000..e7d0894 Binary files /dev/null and b/rebar3 differ diff --git a/relx.config b/relx.config new file mode 100644 index 0000000..fd51c54 --- /dev/null +++ b/relx.config @@ -0,0 +1,3 @@ +{release, {types, "0.0.1"}, [types]}. +{extended_start_script, true}. +{overlay, [{mkdir, "data"}]}. diff --git a/src/types.app.src b/src/types.app.src new file mode 100644 index 0000000..b3cb0e3 --- /dev/null +++ b/src/types.app.src @@ -0,0 +1,15 @@ +{application, types, + [ + {description, "Conflict-free Replicated Data Types"}, + {vsn, "0.0.1"}, + {registered, []}, + {applications, [ + kernel, + stdlib, + crypto, + lager + ]}, + {mod, {types, []}}, + {modules, []}, + {env, [{types, "data"}]} + ]}. diff --git a/src/types.erl b/src/types.erl new file mode 100644 index 0000000..f7cc6f3 --- /dev/null +++ b/src/types.erl @@ -0,0 +1,33 @@ +%% ------------------------------------------------------------------- +%% +%% Copyright (c) 2016 Christopher Meiklejohn. All Rights Reserved. +%% +%% This file is provided to you under the Apache License, +%% Version 2.0 (the "License"); you may not use this file +%% except in compliance with the License. You may obtain +%% a copy of the License at +%% +%% http://www.apache.org/licenses/LICENSE-2.0 +%% +%% Unless required by applicable law or agreed to in writing, +%% software distributed under the License is distributed on an +%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +%% KIND, either express or implied. See the License for the +%% specific language governing permissions and limitations +%% under the License. +%% +%% ------------------------------------------------------------------- + +-module(types). +-author("Christopher S. Meiklejohn "). + +-export([start/0, + stop/0]). + +%% @doc Start the application. +start() -> + application:ensure_all_started(types). + +%% @doc Stop the application. +stop() -> + application:stop(types). diff --git a/src/types_app.erl b/src/types_app.erl new file mode 100644 index 0000000..841529a --- /dev/null +++ b/src/types_app.erl @@ -0,0 +1,39 @@ +%% ------------------------------------------------------------------- +%% +%% Copyright (c) 2016 Christopher Meiklejohn. All Rights Reserved. +%% +%% This file is provided to you under the Apache License, +%% Version 2.0 (the "License"); you may not use this file +%% except in compliance with the License. You may obtain +%% a copy of the License at +%% +%% http://www.apache.org/licenses/LICENSE-2.0 +%% +%% Unless required by applicable law or agreed to in writing, +%% software distributed under the License is distributed on an +%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +%% KIND, either express or implied. See the License for the +%% specific language governing permissions and limitations +%% under the License. +%% +%% ------------------------------------------------------------------- + +-module(types_app). +-author("Christopher S. Meiklejohn + case types_sup:start_link() of + {ok, Pid} -> + {ok, Pid}; + Other -> + {error, Other} + end. + +%% @doc Stop the application. +stop(_State) -> + ok. diff --git a/src/types_sup.erl b/src/types_sup.erl new file mode 100644 index 0000000..51de501 --- /dev/null +++ b/src/types_sup.erl @@ -0,0 +1,41 @@ +%% ------------------------------------------------------------------- +%% +%% Copyright (c) 2016 Christopher Meiklejohn. All Rights Reserved. +%% +%% This file is provided to you under the Apache License, +%% Version 2.0 (the "License"); you may not use this file +%% except in compliance with the License. You may obtain +%% a copy of the License at +%% +%% http://www.apache.org/licenses/LICENSE-2.0 +%% +%% Unless required by applicable law or agreed to in writing, +%% software distributed under the License is distributed on an +%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +%% KIND, either express or implied. See the License for the +%% specific language governing permissions and limitations +%% under the License. +%% +%% ------------------------------------------------------------------- + +-module(types_sup). +-author("Christopher S. Meiklejohn "). + +-behaviour(supervisor). + +-export([start_link/0]). + +-export([init/1]). + +-define(CHILD(I, Type, Timeout), + {I, {I, start_link, []}, permanent, Timeout, Type, [I]}). +-define(CHILD(I, Type), ?CHILD(I, Type, 5000)). + +start_link() -> + supervisor:start_link({local, ?MODULE}, ?MODULE, []). + +init([]) -> + Children = lists:flatten([]), + + RestartStrategy = {one_for_one, 10, 10}, + {ok, {RestartStrategy, Children}}. diff --git a/test/.gitkeep b/test/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tools.mk b/tools.mk new file mode 100644 index 0000000..a05f35a --- /dev/null +++ b/tools.mk @@ -0,0 +1,46 @@ +# ------------------------------------------------------------------- +# +# Copyright (c) 2014 Basho Technologies, Inc. +# +# This file is provided to you under the Apache License, +# Version 2.0 (the "License"); you may not use this file +# except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# ------------------------------------------------------------------- + +# ------------------------------------------------------------------- +# NOTE: This file is is from https://github.com/basho/tools.mk. +# It should not be edited in a project. It should simply be updated +# wholesale when a new version of tools.mk is released. +# ------------------------------------------------------------------- + +REBAR = $(shell pwd)/rebar3 +REVISION ?= $(shell git rev-parse --short HEAD) +PROJECT ?= $(shell basename `find src -name "*.app.src"` .app.src) +DEP_DIR ?= "deps" +EBIN_DIR ?= "ebin" + +.PHONY: compile-no-deps test docs xref dialyzer-run dialyzer-quick dialyzer \ + cleanplt upload-docs + +compile-no-deps: + ${REBAR} compile skip_deps=true + +docs: + ${REBAR} doc skip_deps=true + +xref: compile + ${REBAR} xref skip_deps=true + +dialyzer: compile + ${REBAR} dialyzer