.github/workflows/main.yml

@@ -1,31 +0,0 @@
-name: Integration tests
-
-on:
-  pull_request:
-    branches:
-      - 'master'
-  push:
-    branches:
-      - 'master'
-
-jobs:
-  build:
-    name: OTP ${{ matrix.otp_version }} on ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    container:
-      image: erlang:${{matrix.otp_version}}
-
-    strategy:
-      matrix:
-        otp_version: ['27', '25', '23']
-        os: [ubuntu-latest]
-
-    steps:
-    - uses: actions/checkout@v4
-
-    - name: Compile
-      run: rebar3 compile
-    - name: Dialyzer
-      run: rebar3 as test dialyzer
-    - name: EUnit
-      run: TERM=xterm rebar3 eunit

.gitignore

@@ -1,18 +1,3 @@
-.erlware_commons_plt
-.eunit/*
-deps/*
-doc/*.html
-doc/*.css
-doc/edoc-info
-doc/erlang.png
-ebin/*
-.*
-!.github
 _build
 erl_crash.dump
 *.pyc
-*~
-TEST-*.xml
-/foo
-
-src/ec_semver_parser.peg

CONTRIBUTING.md

@@ -1,139 +0,0 @@
-Contributing
-============
-
-Introduction
-------------
-
-This document describes the usages and rules to follow when contributing
-to this project.
-
-It uses the uppercase keywords SHOULD for optional but highly recommended
-conditions and MUST for required conditions.
-
-`git` is a distributed source code versioning system. This document refers
-to three different repositories hosting the source code of the project.
-`Your local copy` refers to the copy of the repository that you have on
-your computer. The remote repository `origin` refers to your fork of the
-project's repository that you can find in your GitHub account. The remote
-repository `upstream` refers to the official repository for this project.
-
-Reporting bugs
---------------
-
-Upon identifying a bug you SHOULD submit a ticket, regardless of your
-plan for fixing it. If you plan to fix the bug, you SHOULD discuss your
-plans to avoid having your work rejected.
-
-Before implementing a new feature, you SHOULD submit a ticket for discussion
-on your plans. The feature might have been rejected already, or the
-implementation might already be decided.
-
-Cloning
--------
-
-You MUST fork the project's repository to your GitHub account by clicking
-on the `Fork` button.
-
-Then, from your fork's page, copy the `Git Read-Only` URL to your clipboard.
-You MUST perform the following commands in the folder you choose, replacing
-`$URL` by the URL you just copied, `$UPSTREAM_URL` by the `Git Read-Only`
-project of the official repository, and `$PROJECT` by the name of this project.
-
-``` bash
-$ git clone "$URL"
-$ cd $PROJECT
-$ git remote add upstream $UPSTREAM_URL
-```
-
-Branching
----------
-
-Before starting working on the code, you MUST update to `upstream`. The
-project is always evolving, and as such you SHOULD always strive to keep
-up to date when submitting patches to make sure they can be merged without
-conflicts.
-
-To update the current branch to `upstream`, you can use the following commands.
-
-``` bash
-$ git fetch upstream
-$ git rebase upstream/master
-```
-
-It may ask you to stash your changes, in which case you stash with:
-
-``` bash
-$ git stash
-```
-
-And put your changes back in with:
-
-``` bash
-$ git stash pop
-```
-
-You SHOULD use these commands both before working on your patch and before
-submitting the pull request. If conflicts arise it is your responsibility
-to deal with them.
-
-You MUST create a new branch for your work. First make sure you have
-'fetched' `master`
-
-``` bash
-$ git checkout -b $BRANCH upstream/master
-```
-
-You MUST use a an insightful branch name.
-
-If you later need to switch back to an existing branch `$BRANCH`, you can use:
-
-``` bash
-$ git checkout $BRANCH
-```
-
-Source editing
---------------
-
-The following rules MUST be followed:
- *  Indentation uses 4 horizontal spaces
- *  Tabs should not be used
- *  Do NOT align code; only indentation is allowed
-
-
-The following rules SHOULD be followed:
- *  Write small functions whenever possible
- *  Avoid having too many clauses containing clauses containing clauses
- *  Lines SHOULD NOT span more than 80 columns
-
-When in doubt indentation as performed in the Erlang Emacs Mode is
-correct.
-
-Committing
-----------
-
-You MUST ensure that all commits pass all tests and do not have extra
-Dialyzer warnings.
-
-You MUST put all the related work in a single commit. Fixing a bug is one
-commit, adding a feature is one commit, adding two features is two commits.
-
-You MUST write a proper commit title and message. The commit title MUST be
-at most 72 characters; it is the first line of the commit text. The second
-line of the commit text MUST be left blank. The third line and beyond is the
-commit message. You SHOULD write a commit message. If you do, you MUST make
-all lines smaller than 80 characters. You SHOULD explain what the commit
-does, what references you used and any other information that helps
-understanding your work.
-
-Submitting the pull request
----------------------------
-
-You MUST push your branch `$BRANCH` to GitHub, using the following command:
-
-``` bash
-$ git push origin $BRANCH
-```
-
-You MUST then submit the pull request by using the GitHub interface to
-the `master` branch. You SHOULD provide an explanatory message and refer
-to any previous ticket related to this patch.

README.md

@@ -1,143 +0,0 @@
-Erlware Commons
-===============
-
-Current Status
---------------
-
-[![Hex.pm](https://img.shields.io/hexpm/v/erlware_commons)](https://hex.pm/packages/erlware_commons)
-[![Tests](https://github.com/erlware/erlware_commons/workflows/EUnit/badge.svg)](https://github.com/erlware/erlware_commons/actions)
-
-Introduction
-------------
-
-Erlware commons can best be described as an extension to the stdlib
-application that is distributed with Erlang. These are things that we
-at Erlware have found useful for production applications but are not
-included with the distribution. We hope that as things in this library
-prove themselves useful, they will make their way into the main Erlang
-distribution. However, whether they do or not, we hope that this
-application will prove generally useful.
-
-Goals for the project
----------------------
-
-* Generally Useful Code
-* High Quality
-* Well Documented
-* Well Tested
-
-Licenses
---------
-
-This project contains elements licensed with Apache License, Version 2.0,
-as well as elements licensed with The MIT License.
-
-You'll find license-related information in the header of specific files,
-where warranted.
-
-In cases where no such information is present refer to
-[COPYING](COPYING).
-
-Currently Available Modules/Systems
-------------------------------------
-
-### [ec_date](https://github.com/erlware/erlware_commons/blob/master/src/ec_date.erl)
-
-This module formats erlang dates in the form {{Year, Month, Day},
-{Hour, Minute, Second}} to printable strings, using (almost)
-equivalent formatting rules as http://uk.php.net/date, US vs European
-dates are disambiguated in the same way as
-http://uk.php.net/manual/en/function.strtotime.php That is, Dates in
-the m/d/y or d-m-y formats are disambiguated by looking at the
-separator between the various components: if the separator is a slash
-(/), then the American m/d/y is assumed; whereas if the separator is a
-dash (-) or a dot (.), then the European d-m-y format is assumed. To
-avoid potential ambiguity, it's best to use ISO 8601 (YYYY-MM-DD)
-dates.
-
-erlang has no concept of timezone so the following formats are not
-implemented: B e I O P T Z formats c and r will also differ slightly
-
-### [ec_file](https://github.com/erlware/erlware_commons/blob/master/src/ec_file.erl)
-
-A set of commonly defined helper functions for files that are not
-included in stdlib.
-
-### [ec_plists](https://github.com/erlware/erlware_commons/blob/master/src/ec_plists.erl)
-
-plists is a drop-in replacement for module <a
-href="http://www.erlang.org/doc/man/lists.html">lists</a>, making most
-list operations parallel. It can operate on each element in parallel,
-for IO-bound operations, on sublists in parallel, for taking advantage
-of multi-core machines with CPU-bound operations, and across erlang
-nodes, for parallelizing inside a cluster. It handles errors and node
-failures. It can be configured, tuned, and tweaked to get optimal
-performance while minimizing overhead.
-
-Almost all the functions are identical to equivalent functions in
-lists, returning exactly the same result, and having both a form with
-an identical syntax that operates on each element in parallel and a
-form which takes an optional "malt", a specification for how to
-parallelize the operation.
-
-fold is the one exception, parallel fold is different from linear
-fold.  This module also include a simple mapreduce implementation, and
-the function runmany. All the other functions are implemented with
-runmany, which is as a generalization of parallel list operations.
-
-### [ec_semver](https://github.com/erlware/erlware_commons/blob/master/src/ec_semver.erl)
-
-A complete parser for the [semver](http://semver.org/)
-standard. Including a complete set of conforming comparison functions.
-
-### [ec_lists](https://github.com/erlware/erlware_commons/blob/master/src/ec_lists.erl)
-
-A set of additional list manipulation functions designed to supliment
-the `lists` module in stdlib.
-
-### [ec_talk](https://github.com/erlware/erlware_commons/blob/master/src/ec_talk.erl)
-
-A set of simple utility functions to facilitate command line
-communication with a user.
-
-Signatures
------------
-
-Other languages, have built in support for **Interface** or
-**signature** functionality. Java has Interfaces, SML has
-Signatures. Erlang, though, doesn't currently support this model, at
-least not directly. There are a few ways you can approximate it. We
-have defined a mechanism called *signatures* and several modules that
-to serve as examples and provide a good set of *dictionary*
-signatures. More information about signatures can be found at
-[signature](https://github.com/erlware/erlware_commons/blob/master/doc/signatures.md).
-
-
-### [ec_dictionary](https://github.com/erlware/erlware_commons/blob/master/src/ec_dictionary.erl)
-
-A signature that supports association of keys to values. A map cannot
-contain duplicate keys; each key can map to at most one value.
-
-### [ec_dict](https://github.com/erlware/erlware_commons/blob/master/src/ec_dict.erl)
-
-This provides an implementation of the ec_dictionary signature using
-erlang's dicts as a base. The function documentation for ec_dictionary
-applies here as well.
-
-### [ec_gb_trees](https://github.com/erlware/erlware_commons/blob/master/src/ec_gb_trees.erl)
-
-This provides an implementation of the ec_dictionary signature using
-erlang's gb_trees as a base. The function documentation for
-ec_dictionary applies here as well.
-
-### [ec_orddict](https://github.com/erlware/erlware_commons/blob/master/src/ec_orddict.erl)
-
-This provides an implementation of the ec_dictionary signature using
-erlang's orddict as a base. The function documentation for
-ec_dictionary applies here as well.
-
-### [ec_rbdict](https://github.com/erlware/erlware_commons/blob/master/src/ec_rbdict.erl)
-
-This provides an implementation of the ec_dictionary signature using
-Robert Virding's rbdict module as a base. The function documentation
-for ec_dictionary applies here as well.

doc/property_based_testing.md

@@ -0,0 +1,363 @@
+Property based testing for unit testers
+=======================================
+
+Main contributors: Torben Hoffmann, Raghav Karol, Eric Merritt
+
+The purpose of the short document is to help people who are familiar
+with unit testing understand how property based testing (PBT) differs,
+but also where the thinking is the same.
+
+This document focusses on the PBT tool
+[`PropEr`](https://github.com/manopapad/proper) for Erlang since that is
+what I am familiar with, but the general principles applies to all PBT
+tools regardless of which language they are written in.
+
+The approach taken here is that we hear from people who are used to
+working with unit testing regarding how they think when designing
+their tests and how a concrete test might look.
+
+These descriptions are then "converted" into the way it works with
+PBT, with a clear focus on what stays the same and what is different.
+
+## Testing philosophies
+
+### A quote from Martin Logan:
+
+> For me unit testing is about contracts. I think about the same things
+> I think about when I write statements like {ok, Resp} =
+> Mod:Func(Args). Unit testing and writing specs are very close for me.
+> Hypothetically speaking lets say a function should return return {ok,
+> string()} | {error, term()} for all given input parameters then my
+> unit tests should be able to show that for a representative set of
+> input parameters that those contracts are honored. The art comes in
+> thinking about what that set is.
+
+
+The trap in writing all your own tests can often be that we think
+about the set in terms of what we coded for and not what may indeed be
+asked of our function. As the code is tried in further exploratory
+testing and in production new input parameter sets for which the given
+function does not meet the stated contract are discovered and added to
+the test case once a fix has been put into place.
+
+This is a very good description of what the ground rules for unit
+testing are:
+
+* Checking that contracts are obeyed.
+* Creating a representative set of input parameters.
+
+The former is very much part of PBT - each property you write will
+check a contract, so that thinking is the same.
+
+## xUnit vs PBT
+
+Unit testing has become popular for software testing with the advent
+of xUnit tools like jUnit for Java.  xUnit like tools typically
+provide a testing framework with the following functionality
+
+*    test fixture setup
+*    test case execution
+*    test fixture teardown
+*    test suite management
+*    test status reporting and management
+
+While xUnit tools provide a lot of functionality to execute and manage
+test cases and suites, reporting results there is no focus on test
+case execution step, while this is the main focus area of
+property-based testing (PBT).
+
+Consider the following function specification
+
+    :::erlang
+    sort(list::integer()) ---> list::integer() | error
+
+A verbal specification of this function is,
+
+> For all input lists of integers, the sort function returns a sorted
+> list of integers.
+
+For any other kind of argument the function returns the atom error.
+
+The specification above may be a requirement of how the function
+should behave or even how the function does behave. This distinction
+is important; the former is the requirement for the function, the
+latter is the actual API. Both should be the same and that is what our
+testing should confirm. Test cases for this function might look like
+
+    :::erlang
+    assertEqual(sort([5,4,3,2,1]), [1,2,3,4,5])
+    assertEqual(sort([1,2,3,4,5]), [1,2,3,4,5])
+    assertEqual(sort([]         ), []         )
+    assertEqual(sort([-1,0, 1]  ), [-1, 0, 1] )
+
+How many tests cases should we write to be convinced that the actual
+behaviour of the function is the same as its specification? Clearly,
+it is impossible to write tests cases for all possible input values,
+here all lists of integers, the art of testing is finding individual
+input values that are representative of a large part of the input
+space. We hope that the test cases are exhaustive to cover the
+specification. xUnit tools offer no support for this and this is where
+PBT and PBT Tools like `PropEr` and `QuickCheck` come in.
+
+PBT introduces testing with a large set of random input values and
+verifying that the specification holds for each input value
+selected. Functions used to generate input values, generators, are
+specified using rules and can be simply composed together to construct
+complicated values.  So, a property based test for the function above
+may look like:
+
+    :::erlang
+    FOREACH({I, J, InputList},  {nat(), nat(), integer_list()},
+        SUCHTHAT(I < J andalso J < length(InputList),
+        SortedList = sort(InputList)
+        length(SortedList) == length(InputList)
+        andalso
+        lists:get(SortedList, I) =< lists:get(SortedList, J))
+
+
+The property above works as follows
+
+* Generate a random list of integers `InputList` and two natural numbers
+  I, J, such that I < J < size of `InputList`
+* Check that size of sorted and input lists is the same.
+* Check that element with smaller index I is less than or equal to
+  element with larger index J in `SortedList`.
+
+Notice in the property above, we *specify* property. Verification of
+the property based on random input values will be done by the property
+based tool, therefore we can generated a large number of tests cases
+with random input values and have a higher level of confidence that
+the function when using unit tests alone.
+
+But it does not stop at generation of input parameters. If you have
+more complex tests where you have to generate a series of events and
+keep track of some state then your PBT tool will generate random
+sequences of events which corresponds to legal sequences of events and
+test that your system behaves correctly for all sequences.
+
+So when you have written a property with associated generators you
+have in fact created something that can create numerous test cases -
+you just have to tell your PBT tool how many test cases you want to
+check the property on.
+
+## Shrinking the bar
+
+At this point you might still have the feeling that introducing the
+notion of some sort of generators to your unit testing tool of choice
+would bring you on par with PBT tools, but wait there is more to
+come.
+
+When a PBT tool creates a test case that fails there is real chance
+that it has created a long test case or some big input parameters -
+trying to debug that is very much like receiving a humongous log from
+a system in the field and try to figure out what cause the system to
+fail.
+
+Enter shrinking...
+
+When a test case fails the PBT tool will try to shrink the failing
+test case down to the essentials by stripping out input elements or
+events that does not cause the failure. In most cases this results in
+a very short counterexample that clearly states which events and
+inputs are required to break a property.
+
+As we go through some concrete examples later the effects of shrinking
+will be shown.
+
+Shrinking makes it a lot easier to debug problems and is as key to the
+strength of PBT as the generators.
+
+## Converting a unit test
+
+We will now take a look at one possible way of translating a unit
+test into a PBT setting.
+
+The example comes from Eric Merritt and is about the `add/2` function in
+the `ec_dictionary` instance `ec_gb_trees`.
+
+The add function has the following spec:
+
+    :::erlang
+    -spec add(ec_dictionary:key(), ec_dictionary:value(), Object::dictionary()) ->
+              dictionary().
+
+and it is supposed to do the obvious: add the key and value pair to
+the dictionary and return a new dictionary.
+
+Eric states his basic expectations as follows:
+
+1. I can put arbitrary terms into the dictionary as keys
+2. I can put arbitrary terms into the dictionary as values
+3. When I put a value in the dictionary by a key, I can retrieve that same value
+4. When I put a different value in the dictionary by key it does not change other key value pairs.
+5. When I update a value the new value in available by the new key
+6. When a value does not exist a not found exception is created
+
+The first two expectations regarding being able to use arbritrary
+terms as keys and values is a job for generators.
+
+The latter four are prime candidates for properties and we will create
+one for each of them.
+
+### Generators
+
+    :::erlang
+    key() -> any().
+
+    value() -> any().
+
+
+For `PropEr` this approach has the drawback that creation and shrinking
+becomes rather time consuming, so it might be better to narrow to
+something like this:
+
+    :::erlang
+    key() -> union([integer(),atom()]).
+
+    value() -> union([integer(),atom(),binary(),boolean(),string()]).
+
+What is best depends on the situation and intended usage.
+
+Now, being able to generate keys and values is not enough. You also
+have to tell `PropEr` how to create a dictionary and in this case we
+will use a symbolic generator (detail to be explained later).
+
+    :::erlang
+    sym_dict() ->
+        ?SIZED(N,sym_dict(N)).
+
+    sym_dict(0) ->
+        {'$call',ec_dictionary,new,[ec_gb_trees]};
+    sym_dict(N) ->
+        ?LAZY(
+           frequency([
+                      {1, {'$call',ec_dictionary,remove,[key(),sym_dict(N-1)]}},
+                      {2, {'$call',ec_dictionary,add,[value(),value(),sym_dict(N-1)]}}
+                     ])).
+
+
+`sym_dict/0` uses the `?SIZED` macro to control the size of the
+generated dictionary. `PropEr` will start out with small numbers and
+gradually raise it.
+
+`sym_dict/1` is building a dictionary by randomly adding key/value
+pairs and removing keys. Eventually the base case is reached which
+will create an empty dictionary.
+
+The `?LAZY` macro is used to defer the calculation of the
+`sym_dict(N-1)` until they are needed and `frequency/1` is used
+to ensure that twice as many adds compared to removes are done. This
+should give rather more interesting dictionaries in the long run, if
+not one can alter the frequencies accondingly.
+
+But does it really work?
+
+That is a good question and one that should always be asked when
+looking at genetors. Fortunately there is a way to see what a
+generator produces provided that the generator functions are exported.
+
+Hint: in most cases it will not hurt to throw in a
+`-compile(export_all).` in the module used to specify the
+properties. And here we actually have a sub-hint: specify the
+properties in a separate file to avoid peeking inside the
+implementation! Base the test on the published API as this is what the
+users of the code will be restricted to.
+
+When the test module has been loaded you can test the generators by
+starting up an Erlang shell (this example uses the erlware_commons
+code so get yourself a clone to play with):
+
+    :::sh
+    $ erl -pz ebin -pz test
+    1> proper_gen:pick(ec_dictionary_proper:key()).
+    {ok,4}
+    2> proper_gen:pick(ec_dictionary_proper:key()).
+    {ok,35}
+    3> proper_gen:pick(ec_dictionary_proper:key()).
+    {ok,-5}
+    4> proper_gen:pick(ec_dictionary_proper:key()).
+    {ok,48}
+    5> proper_gen:pick(ec_dictionary_proper:key()).
+    {ok,'\036\207_là´?\nc'}
+    6> proper_gen:pick(ec_dictionary_proper:value()).
+    {ok,2}
+    7> proper_gen:pick(ec_dictionary_proper:value()).
+    {ok,-14}
+    8> proper_gen:pick(ec_dictionary_proper:value()).
+    {ok,-3}
+    9> proper_gen:pick(ec_dictionary_proper:value()).
+    {ok,27}
+    10> proper_gen:pick(ec_dictionary_proper:value()).
+    {ok,-8}
+    11> proper_gen:pick(ec_dictionary_proper:value()).
+    {ok,[472765,17121]}
+    12> proper_gen:pick(ec_dictionary_proper:value()).
+    {ok,true}
+    13> proper_gen:pick(ec_dictionary_proper:value()).
+    {ok,<<>>}
+    14> proper_gen:pick(ec_dictionary_proper:value()).
+    {ok,<<89,69,18,148,32,42,238,101>>}
+    15> proper_gen:pick(ec_dictionary_proper:sym_dict()).
+    {ok,{'$call',ec_dictionary,add,
+            [[114776,1053475],
+             'fª\020\227\215',
+             {'$call',ec_dictionary,add,
+                 ['',true,
+                  {'$call',ec_dictionary,add,
+                      ['2^Ø¡',
+                       [900408,886056],
+                       {'$call',ec_dictionary,add,[[48618|...],<<...>>|...]}]}]}]}}
+    16> proper_gen:pick(ec_dictionary_proper:sym_dict()).
+    {ok,{'$call',ec_dictionary,add,
+            [10,'a¯\214\031fõC',
+             {'$call',ec_dictionary,add,
+                 [false,-1,
+                  {'$call',ec_dictionary,remove,
+                      ['d·ÉV÷[',
+                       {'$call',ec_dictionary,remove,[12,{'$call',...}]}]}]}]}}
+
+That does not look too bad, so we will continue with that for now.
+
+
+### Properties of `add/2`
+
+The first expectation Eric had about how the dictionary works was that
+if a key had been stored it could be retrieved.
+
+One way of expressing this could be with this property:
+
+    :::erlang
+    prop_get_after_add_returns_correct_value() ->
+        ?FORALL({Dict,K,V}, {sym_dict(),key(),value()},
+             begin
+                 try ec_dictionary:get(K,ec_dictionary:add(K,V,Dict)) of
+                        V ->
+                            true;
+                        _ ->
+                            false
+                 catch
+                       _:_ ->
+                           false
+                 end
+              end).
+
+This property reads that for all dictionaries `get/2` using a key
+from a key/value pair just inserted using the `add/3` function
+will return that value. If that is not the case the property will
+evaluate to false.
+
+Running the property is done using `proper:quickcheck/1`:
+
+    :::sh
+    proper:quickcheck(ec_dictionary_proper:prop_get_after_add_returns_correct_value()).
+    ....................................................................................................
+    OK: Passed 100 test(s).
+    true
+
+
+This was as expected, but at this point we will take a little detour
+and introduce a mistake in the `ec_gb_trees` implementation and see
+how that works.
+
+
+

doc/signatures.md

@@ -2,10 +2,10 @@ Signatures
 ==========
 
 It often occurs in coding that we need a library, a set of
-functionalities. Often there are several algorithms that could provide
+functionaly. Often there are several algorithms that could provide
-each of these functionalities. However, the code that uses it, either doesn't
+this functionality. However, the code that uses it, either doesn't
 care about the individual algorithm or wishes to delegate choosing
-that algorithm to some higher level. Let's take the concrete example of
+that algorithm to some higher level. Lets take the concrete example of
 dictionaries. A dictionary provides the ability to access a value via
 a key (other things as well but primarily this). There are may ways to
 implement a dictionary. Just a few are:
@@ -16,17 +16,17 @@ implement a dictionary. Just a few are:
 * [Skip Lists](http://en.wikipedia.org/wiki/Skip_list)
 * Many, many more ....
 
-Each of these approaches has their own performance characteristics,
+Each of these approaches has there own performance characteristics,
-memory footprints, etc. For example, a table of size $n$ with open
+memory footprints etc. For example, a table of size n with open
-addressing has no collisions and holds up to $n$ elements, with a single
+addressing has no collisions and holds up to n elements, with a single
-comparison for successful lookup, and a table of size $n$ with chaining
+comparison for successful lookup, and a table of size n with chaining
-and $k$ keys has the minimum $\max(0, k-n)$ collisions and $\mathcal{O}(1 + k/n)$
+and k keys has the minimum max(0, k-n) collisions and O(1 + k/n)
 comparisons for lookup. While for skip lists the performance
 characteristics are about as good as that of randomly-built binary
-search trees - namely $\mathcal{O}(\log n)$. So the choice of which to select
+search trees - namely (O log n). So the choice of which to select
 depends very much on memory available, insert/read characteristics,
 etc. So delegating the choice to a single point in your code is a very
-good idea. Unfortunately, in Erlang that's so easy to do at the moment.
+good idea. Unfortunately, in Erlang thats ot so easy to do at the moment.
 
 Other languages, have built in support for this
 functionality. [Java](http://en.wikipedia.org/wiki/Java_(programming_language))
@@ -39,20 +39,17 @@ directly. There are a few ways you can approximate it. One way is to
 pass the Module name to the calling functions along with the data that
 it is going to be called on.
 
-```erlang
+    :::erlang
-add(ModuleToUse, Key, Value, DictData) ->
+    add(ModuleToUse, Key, Value, DictData) ->
         ModuleToUse:add(Key, Value, DictData).
-```
 
 This works, and you can vary how you want to pass the data. For
 example, you could easily use a tuple to contain the data. That is,
 you could pass in `{ModuleToUse, DictData}` and that would make it a
 bit cleaner. 
-
+    :::erlang
-```erlang
+    add(Key, Value, {ModuleToUse, DictData}) ->
-add(Key, Value, {ModuleToUse, DictData}) ->
         ModuleToUse:add(Key, Value, DictData).        
-```
 
 Either way, there are a few problems with this approach. One of the
 biggest is that you lose code locality, by looking at this bit of code
@@ -66,22 +63,21 @@ mistakes that you might have made. Tools like
 [Dialyzer](http://www.erlang.org/doc/man/dialyzer.html) have just as
 hard a time figuring out the what `ModuleToUse` is pointing to as you
 do. So they can't give you warnings about potential problems. In fact
-someone could inadvertently pass an unexpected function name as
+someone could inadvertantly pass an unexpected function name as
 `ModuleToUse` and you would never get any warnings, just an exception
 at run time.
 
-Fortunately, Erlang is a pretty flexible language so we can use a
+Fortunately, Erlang is a pretty flexable language so we can use a
 similar approach with a few adjustments to give us the best of both
-worlds. Both the flexibility of ignoring a specific implementation
+worlds. Both the flexibiltiy of ignoreing a specific implementation
 and keeping all the nice locality we get by using an explicit module
 name.
 
 So what we actually want to do is something mole like this:
 
-```erlang
+    :::erlang
-add(Key, Value, DictData) ->
+    add(Key, Value, DictData) ->
         dictionary:add(Key, Value, DictData).
-```
 
 Doing this we retain the locality. We can easily look up the
 `dictionary` Module. We immediately have a good idea what a
@@ -94,19 +90,19 @@ reasons, this is a much better approach to the problem. This is what
 Signatures
 ----------
 
-How do we actually do this in Erlang now that Erlang is missing what Java, SML and friends have built in? 
+How do we actually do this in Erlang now that Erlang is missing what Java, SML and friends has built in? 
 
 The first thing we need to do is to define
 a [Behaviour](http://metajack.im/2008/10/29/custom-behaviors-in-erlang/)
 for our functionality. To continue our example we will define a
 Behaviour for dictionaries. That Behaviour looks like this:
 
-```erlang
+    :::erlang
--module(ec_dictionary).
+    -module(ec_dictionary).
 
--export([behaviour_info/1]).
+    -export([behaviour_info/1]).
 
-behaviour_info(callbacks) ->
+    behaviour_info(callbacks) ->
         [{new, 0},
          {has_key, 2},
          {get, 2},
@@ -117,33 +113,31 @@ behaviour_info(callbacks) ->
          {to_list, 1},
          {from_list, 1},
          {keys, 1}];
-behaviour_info(_) ->
+    behaviour_info(_) ->
         undefined.
-```
 
 
 So we have our Behaviour now. Unfortunately, this doesn't give us much
 yet. It will make sure that any dictionaries we write will have all
-the functions they need to have, but it won't help us actually use the
+the functions they need to have, but it wont help use actually use the
 dictionaries in an abstract way in our code. To do that we need to add
 a bit of functionality. We do that by actually implementing our own
 behaviour, starting with `new/1`.
 
-```erlang
+    :::erlang
-%% @doc create a new dictionary object from the specified module. The
+    %% @doc create a new dictionary object from the specified module. The
-%% module should implement the dictionary behaviour.
+    %% module should implement the dictionary behaviour.
-%%
+    %%
-%% @param ModuleName The module name.
+    %% @param ModuleName The module name.
--spec new(module()) -> dictionary(_K, _V).
+    -spec new(module()) -> dictionary(_K, _V).
-new(ModuleName) when is_atom(ModuleName) ->
+    new(ModuleName) when is_atom(ModuleName) ->
         #dict_t{callback = ModuleName, data = ModuleName:new()}.
-```
 
 This code creates a new dictionary for us. Or to be more specific it
 actually creates a new dictionary Signature record, that will be used
 subsequently in other calls. This might look a bit familiar from our
 previous less optimal approach. We have both the module name and the
-data in the record. We call the module name named in
+data. here in the record. We call the module name named in
 `ModuleName` to create the initial data. We then construct the record
 and return that record to the caller and we have a new
 dictionary. What about the other functions, the ones that don't create
@@ -154,17 +148,16 @@ dictionary and another that just retrieves data.
 The first we will look at is the one that updates the dictionary by
 adding a value.
 
-```erlang
+    :::erlang
-%% @doc add a new value to the existing dictionary. Return a new
+    %% @doc add a new value to the existing dictionary. Return a new
-%% dictionary containing the value.
+    %% dictionary containing the value.
-%%
+    %%
-%% @param Dict the dictionary object to add too
+    %% @param Dict the dictionary object to add too
-%% @param Key the key to add
+    %% @param Key the key to add
-%% @param Value the value to add
+    %% @param Value the value to add
--spec add(key(K), value(V), dictionary(K, V)) -> dictionary(K, V).
+    -spec add(key(K), value(V), dictionary(K, V)) -> dictionary(K, V).
-add(Key, Value, #dict_t{callback = Mod, data = Data} = Dict) ->
+    add(Key, Value, #dict_t{callback = Mod, data = Data} = Dict) ->
         Dict#dict_t{data = Mod:add(Key, Value, Data)}.
-```
 
 There are two key things here. 
 
@@ -180,17 +173,16 @@ implementation to do the work itself.
 Now lets do a data retrieval function. In this case, the `get` function
 of the dictionary Signature.
 
-```erlang
+    :::erlang
-%% @doc given a key return that key from the dictionary. If the key is
+    %% @doc given a key return that key from the dictionary. If the key is
-%% not found throw a 'not_found' exception.
+    %% not found throw a 'not_found' exception.
-%%
+    %%
-%% @param Dict The dictionary object to return the value from
+    %% @param Dict The dictionary object to return the value from
-%% @param Key The key requested
+    %% @param Key The key requested
-%% @throws not_found when the key does not exist
+    %% @throws not_found when the key does not exist
--spec get(key(K), dictionary(K, V)) -> value(V).
+    -spec get(key(K), dictionary(K, V)) -> value(V).
-get(Key, #dict_t{callback = Mod, data = Data}) ->
+    get(Key, #dict_t{callback = Mod, data = Data}) ->
         Mod:get(Key, Data).
-```
 
 In this case, you can see a very similar approach to deconstructing
 the dict record. We still need to pull out the callback module and the
@@ -205,7 +197,7 @@ implementation in
 Using Signatures
 ----------------
 
-It's a good idea to work through an example so we have a bit better
+Its a good idea to work through an example so we have a bit better
 idea of how to use these Signatures. If you are like me, you probably
 have some questions about what kind of performance burden this places
 on the code. At the very least we have an additional function call
@@ -214,7 +206,7 @@ lets write a little timing test, so we can get a good idea of how much
 this is all costing us.
 
 In general, there are two kinds of concrete implementations for
-Signatures. The first is a native implementation, the second is a
+Signatures. The first is a native implementations, the second is a
 wrapper.
 
 ### Native Signature Implementations
@@ -231,33 +223,32 @@ implements the ec_dictionary module directly.
 
 A Signature Wrapper is a module that wraps another module. Its
 purpose is to help a preexisting module implement the Behaviour
-defined by a Signature. A good example of this in our current example
+defined by a Signature. A good example if this in our current example
 is the
 [erlware_commons/ec_dict](https://github.com/ericbmerritt/erlware_commons/blob/types/src/ec_dict.erl)
-module. It implements the `ec_dictionary` Behaviour, but all the
+module. It implements the ec_dictionary Behaviour, but all the
 functionality is provided by the
 [stdlib/dict](http://www.erlang.org/doc/man/dict.html) module
-itself. Let's take a look at one example to see how this is done.
+itself. Lets take a look at one example to see how this is done.
 
 We will take a look at one of the functions we have already seen. The
-`get` function in `ec_dictionary` doesn't have quite the same
+`get` function an ec_dictionary `get` doesn't have quite the same
-semantics as any of the functions in the `dict` module. So a bit of
+semantics as any of the functions in the dict module. So a bit of
-translation needs to be done. We do that in the `ec_dict:get/2` function.
+translation needs to be done. We do that in the ec_dict module `get` function.
 
-```erlang
+    :::erlang
--spec get(ec_dictionary:key(K), Object::dictionary(K, V)) ->
+    -spec get(ec_dictionary:key(K), Object::dictionary(K, V)) ->
                ec_dictionary:value(V).
-get(Key, Data) ->
+    get(Key, Data) ->
         case dict:find(Key, Data) of
 	    {ok, Value} ->
 	        Value;
 	     error ->
 	        throw(not_found)
         end.
-```
 
-So the `ec_dict` module's purpose for existence is to help the
+So the ec_dict module's purpose for existence is to help the
-preexisting `dict` module implement the Behaviour defined by the
+preexisting dict module implement the Behaviour defined by the
 Signature.
 
 
@@ -267,25 +258,24 @@ the mix and that adds a bit of additional overhead.
 
 ### Creating the Timing Module
 
-We are going to be creating timings for both Native Signature
+We are going to creating timings for both Native Signature
 Implementations and Signature Wrappers.
 
-Let's get started by looking at some helper functions. We want
+Lets get started by looking at some helper functions. We want
-dictionaries to have a bit of data in them. So to that end we will
+dictionaries to have a bit of data in them. So to that end we are will
 create a couple of functions that create dictionaries for each type we
 want to test. The first we want to time is the Signature Wrapper, so
 `dict` vs `ec_dict` called as a Signature.
 
-```erlang
+    :::erlang
-create_dict() ->
+    create_dict() ->
     lists:foldl(fun(El, Dict) ->
 			dict:store(El, El, Dict)
 		end, dict:new(),
 		lists:seq(1,100)).
-```
 
 The only thing we do here is create a sequence of numbers 1 to 100,
-and then add each of those to the `dict` as an entry. We aren't too
+and then add each of those to the dict as an entry. We aren't too
 worried about replicating real data in the dictionary. We care about
 timing the function call overhead of Signatures, not the performance
 of the dictionaries themselves.
@@ -293,28 +283,27 @@ of the dictionaries themselves.
 We need to create a similar function for our Signature based
 dictionary `ec_dict`.
 
-```erlang
+    :::erlang
-create_dictionary(Type) ->
+    create_dictionary(Type) ->
     lists:foldl(fun(El, Dict) ->
 			ec_dictionary:add(El, El, Dict)
 		end,
 		ec_dictionary:new(Type),
 		lists:seq(1,100)).
-```
 
 Here we actually create everything using the Signature. So we don't
 need one function for each type. We can have one function that can
 create anything that implements the Signature. That is the magic of
-Signatures. Otherwise, this does the exact same thing as the dictionary
+Signatures. Otherwise, this does the exact same thing as the dict
-given by `create_dict/0`.
+`create_dict/1`.
 
 We are going to use two function calls in our timing. One that updates
 data and one that returns data, just to get good coverage. For our
-dictionaries we are going to use the `size` function as well as
+dictionaries that we are going to use the `size` function as well as
 the `add` function.
 
-```erlang
+    :::erlang
-time_direct_vs_signature_dict() ->
+    time_direct_vs_signature_dict() ->
         io:format("Timing dict~n"),
         Dict = create_dict(),
         test_avg(fun() ->
@@ -323,31 +312,29 @@ time_direct_vs_signature_dict() ->
 	         1000000),
         io:format("Timing ec_dict implementation of ec_dictionary~n"),
         time_dict_type(ec_dict).
-```
 
 The `test_avg` function runs the provided function the number of times
 specified in the second argument and collects timing information. We
-are going to run these one million times to get a good average (it's
+are going to run these one million times to get a good average (its
-fast so it doesn't take long). You can see in the anonymous
+fast so it doesn't take long). You can see that in the anonymous
 function that we directly call `dict:size/1` and `dict:store/3` to perform
 the test. However, because we are in the wonderful world of Signatures
 we don't have to hard code the calls for the Signature
 implementations. Lets take a look at the `time_dict_type` function.
 
 
-```erlang
+    :::erlang
-time_dict_type(Type) ->
+    time_dict_type(Type) ->
         io:format("Testing ~p~n", [Type]),
         Dict = create_dictionary(Type),
         test_avg(fun() ->
 		     ec_dictionary:size(ec_dictionary:add(some_key, some_value, Dict))
 	         end,
 	         1000000).
-```
 
 As you can see we take the type as an argument (we need it for `dict`
 creation) and call our create function. Then we run the same timings
-that we did for `ec_dict`. In this case though, the type of dictionary
+that we did for ec dict. In this case though, the type of dictionary
 is never specified, we only ever call ec_dictionary, so this test will
 work for anything that implements that Signature.
 
@@ -356,26 +343,25 @@ work for anything that implements that Signature.
 So we have our tests, what was the result. Well on my laptop this is
 what it looked like.
 
-```sh
+    :::sh
-Erlang R14B01 (erts-5.8.2) [source] [64-bit] [smp:4:4] [rq:4] [async-threads:0] [hipe] [kernel-poll:false]
+    Erlang R14B01 (erts-5.8.2) [source] [64-bit] [smp:4:4] [rq:4] [async-threads:0] [hipe] [kernel-poll:false]
 
-Eshell V5.8.2  (abort with ^G)
+    Eshell V5.8.2  (abort with ^G)
 
-1> ec_timing:time_direct_vs_signature_dict().
+    1> ec_timing:time_direct_vs_signature_dict().
-Timing dict
+    Timing dict
-Range: 2 - 5621 mics
+    Range: 2 - 5621 mics
-Median: 3 mics
+    Median: 3 mics
-Average: 3 mics
+    Average: 3 mics
-Timing ec_dict implementation of ec_dictionary
+    Timing ec_dict implementation of ec_dictionary
-Testing ec_dict
+    Testing ec_dict
-Range: 3 - 6097 mics
+    Range: 3 - 6097 mics
-Median: 3 mics
+    Median: 3 mics
-Average: 4 mics
+    Average: 4 mics
-2>
+    2>
-```
 
-So for the direct `dict` call, we average about 3 mics per call, while
+So for the direct dict call, we average about 3 mics per call, while
-for the Signature Wrapper we average around 4. That's a 25% cost for
+for the Signature Wrapper we average around 4. Thats a 25% cost for
 Signature Wrappers in this example, for a very small number of
 calls. Depending on what you are doing that is going to be greater or
 lesser. In any case, we can see that there is some cost associated
@@ -387,23 +373,22 @@ Signature, but it is not a Signature Wrapper. It is a native
 implementation of the Signature. To use `ec_rbdict` directly we have
 to create a creation helper just like we did for dict.
 
-```erlang
+    :::erlang
-create_rbdict() ->
+    create_rbdict() ->
     lists:foldl(fun(El, Dict) ->
 			ec_rbdict:add(El, El, Dict)
 		end, ec_rbdict:new(),
 		lists:seq(1,100)).
-```
 
 This is exactly the same as `create_dict` with the exception that dict
 is replaced by `ec_rbdict`.
 
 The timing function itself looks very similar as well. Again notice
 that we have to hard code the concrete name for the concrete
-implementation, but we don't for the `ec_dictionary` test.
+implementation, but we don't for the ec_dictionary test.
 
-```erlang
+    :::erlang
-time_direct_vs_signature_rbdict() ->
+    time_direct_vs_signature_rbdict() ->
         io:format("Timing rbdict~n"),
         Dict = create_rbdict(),
         test_avg(fun() ->
@@ -412,7 +397,6 @@ time_direct_vs_signature_rbdict() ->
 	         1000000),
        io:format("Timing ec_dict implementation of ec_dictionary~n"),
        time_dict_type(ec_rbdict).
-```
 
 And there we have our test. What do the results look like?
 
@@ -422,35 +406,34 @@ The main thing we are timing here is the additional cost of the
 dictionary Signature itself. Keep that in mind as we look at the
 results.
 
-```sh
+    :::sh
-Erlang R14B01 (erts-5.8.2) [source] [64-bit] [smp:4:4] [rq:4] [async-threads:0] [hipe] [kernel-poll:false]
+    Erlang R14B01 (erts-5.8.2) [source] [64-bit] [smp:4:4] [rq:4] [async-threads:0] [hipe] [kernel-poll:false]
 
-Eshell V5.8.2  (abort with ^G)
+    Eshell V5.8.2  (abort with ^G)
 
-1> ec_timing:time_direct_vs_signature_rbdict().
+    1> ec_timing:time_direct_vs_signature_rbdict().
-Timing rbdict
+    Timing rbdict
-Range: 6 - 15070 mics
+    Range: 6 - 15070 mics
-Median: 7 mics
+    Median: 7 mics
-Average: 7 mics
+    Average: 7 mics
-Timing ec_dict implementation of ec_dictionary
+    Timing ec_dict implementation of ec_dictionary
-Testing ec_rbdict
+    Testing ec_rbdict
-Range: 6 - 6013 mics
+    Range: 6 - 6013 mics
-Median: 7 mics
+    Median: 7 mics
-Average: 7 mics
+    Average: 7 mics
-2>
+    2>
-```
 
 So no difference it time. Well the reality is that there is a
 difference in timing, there must be, but we don't have enough
 resolution in the timing system to be able to figure out what that
-difference is. Essentially that means it's really, really small - or small
+difference is. Essentially that means its really, really small - or small
 enough not to worry about at the very least.
 
 Conclusion
 ----------
 
 Signatures are a viable, useful approach to the problem of interfaces
-in Erlang. They have little or no overhead depending on the type of
+in Erlang. The have little or no over head depending on the type of
 implementation, and greatly increase the flexibility of the a library
 while retaining testability and locality.
 
@@ -473,7 +456,7 @@ Signature Wrapper
 
 ### Code Referenced
 
-* [ec_dictionary Implementation](https://github.com/ericbmerritt/erlware_commons/blob/types/src/ec_dictionary.erl)
+* [ec_dictionary Implementation] (https://github.com/ericbmerritt/erlware_commons/blob/types/src/ec_dictionary.erl)
-* [ec_dict Signature Wrapper](https://github.com/ericbmerritt/erlware_commons/blob/types/src/ec_dict.erl)
+* [ec_dict Signature Wrapper] (https://github.com/ericbmerritt/erlware_commons/blob/types/src/ec_dict.erl)
-* [ec_rbdict Native Signature Implementation](https://github.com/ericbmerritt/erlware_commons/blob/types/src/ec_rbdict.erl)
+* [ec_rbdict Native Signature Implementation] (https://github.com/ericbmerritt/erlware_commons/blob/types/src/ec_rbdict.erl)
-* [ec_timing Signature Use Example and Timing Collector](https://github.com/ericbmerritt/erlware_commons/blob/types/examples/ec_timing.erl)
+* [ec_timing Signature Use Example and Timing Collector] (https://github.com/ericbmerritt/erlware_commons/blob/types/examples/ec_timing.erl)

ebin/erlware_commons.app

@@ -0,0 +1,18 @@
+%% -*- mode: Erlang; fill-column: 75; comment-column: 50; -*-
+{application, erlware_commons,
+ [{description, "Additional standard library for Erlang"},
+  {vsn, "0.6.0"},
+  {modules, [
+             ec_lists,
+             ec_plists,
+             ec_file,
+             ec_string,
+             ec_semver,
+             ec_dictionary,
+             ec_assoc_list,
+             ec_dict,
+             ec_gb_trees,
+             ec_rbdict,
+             ec_orddict]},
+  {registered, []},
+  {applications, [kernel, stdlib]}]}.

include/ec_cmd_log.hrl

@@ -1,24 +0,0 @@
-%% -*- erlang-indent-level: 4; indent-tabs-mode: nil; fill-column: 80 -*-
-%%% Copyright 2012 Erlware, LLC. 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.
-%%%---------------------------------------------------------------------------
-%%% @author Eric Merritt <ericbmerritt@gmail.com>
-%%% @copyright (C) 2012 Erlware, LLC.
-
--define(EC_ERROR, 0).
--define(EC_WARN, 1).
--define(EC_INFO, 2).
--define(EC_DEBUG, 3).

priv/ec_semver_parser.peg

@@ -1,9 +0,0 @@
-semver <- major_minor_patch_min_patch ("-" alpha_part ("." alpha_part)*)? ("+" alpha_part ("." alpha_part)*)?  !.
-       ` ec_semver:internal_parse_version(Node) ` ;
-
-major_minor_patch_min_patch <- ("v"? numeric_part / alpha_part)  ("." version_part)? ("." version_part)? ("." version_part)? ;
-
-version_part <- numeric_part / alpha_part ;
-
-numeric_part <- [0-9]+ `erlang:list_to_integer(erlang:binary_to_list(erlang:iolist_to_binary(Node)))` ;
-alpha_part <- [A-Za-z0-9]+ `erlang:iolist_to_binary(Node)` ;

rebar.config

@@ -1,24 +0,0 @@
-%% -*- mode: Erlang; fill-column: 80; comment-column: 75; -*-
-
-%% Dependencies ================================================================
-{deps, [
-    {cf, "~>0.3"}
-]}.
-
-{erl_first_files, ["ec_dictionary", "ec_vsn"]}.
-
-%% Compiler Options ============================================================
-{erl_opts, [debug_info, warnings_as_errors]}.
-
-%% EUnit =======================================================================
-{eunit_opts, [verbose,
-              {report, {eunit_surefire, [{dir, "."}]}}]}.
-
-{cover_enabled, true}.
-{cover_print_enabled, true}.
-
-%% Profiles ====================================================================
-{profiles, [{dev, [{deps,
-                    [{neotoma, "",
-                      {git, "https://github.com/seancribbs/neotoma.git", {branch, master}}}]}]}
-           ]}.

rebar.config.script

@@ -1,7 +0,0 @@
-NoDialWarns = {dialyzer, [{warnings, [no_unknown]}]},
-OTPRelease  = erlang:list_to_integer(erlang:system_info(otp_release)),
-
-case OTPRelease<26 of
-    true  -> CONFIG;
-    false -> lists:keystore(dialyzer, 1, CONFIG, NoDialWarns)
-end.

rebar.lock

@@ -1,8 +0,0 @@
-{"1.2.0",
-[{<<"cf">>,{pkg,<<"cf">>,<<"0.3.1">>},0}]}.
-[
-{pkg_hash,[
- {<<"cf">>, <<"5CB902239476E141EA70A740340233782D363A31EEA8AD37049561542E6CD641">>}]},
-{pkg_hash_ext,[
- {<<"cf">>, <<"315E8D447D3A4B02BCDBFA397AD03BBB988A6E0AA6F44D3ADD0F4E3C3BF97672">>}]}
-].

src/ec_assoc_list.erl

@@ -1,12 +1,11 @@
-%%% vi:ts=4 sw=4 et
 %%%-------------------------------------------------------------------
 %%% @author Eric Merritt <ericbmerritt@gmail.com>
 %%% @copyright 2011 Erlware, LLC.
 %%% @doc
 %%%  provides an implementation of ec_dictionary using an association
 %%%  list as a basy
-%%% see ec_dictionary
 %%% @end
+%%% @see ec_dictionary
 %%%-------------------------------------------------------------------
 -module(ec_assoc_list).
 
@@ -30,9 +29,7 @@
 %%%===================================================================
 %%% Types
 %%%===================================================================
-%% This should be opaque, but that kills dialyzer so for now we export it
+-opaque dictionary(K, V) :: {ec_assoc_list,
-%% however you should not rely on the internal representation here
--type dictionary(K, V) :: {ec_assoc_list,
 			     [{ec_dictionary:key(K), ec_dictionary:value(V)}]}.
 
 %%%===================================================================
@@ -85,7 +82,7 @@ remove(Key, {ec_assoc_list, Data}) ->
 has_value(Value, {ec_assoc_list, Data}) ->
     lists:keymember(Value, 2, Data).
 
--spec size(Object::dictionary(_K, _V)) -> non_neg_integer().
+-spec size(Object::dictionary(_K, _V)) -> integer().
 size({ec_assoc_list, Data}) ->
     length(Data).
 

src/ec_cmd_log.erl

@@ -1,257 +0,0 @@
-%% -*- erlang-indent-level: 4; indent-tabs-mode: nil; fill-column: 80 -*-
-%%% Copyright 2012 Erlware, LLC. 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.
-%%%---------------------------------------------------------------------------
-%%% @author Eric Merritt <ericbmerritt@gmail.com>
-%%% @copyright (C) 2012 Erlware, LLC.
-%%%
-%%% @doc This provides simple output functions for command line apps. You should
-%%% use this to talk to the users if you are writing code for the system
--module(ec_cmd_log).
-
-%% Avoid clashing with `error/3` BIF added in Erlang/OTP 24
--compile({no_auto_import,[error/3]}).
-
--export([new/1,
-         new/2,
-         new/3,
-         log/4,
-         should/2,
-         debug/2,
-         debug/3,
-         info/2,
-         info/3,
-         error/2,
-         error/3,
-         warn/2,
-         warn/3,
-         log_level/1,
-         atom_log_level/1,
-         colorize/4,
-         format/1]).
-
--include("include/ec_cmd_log.hrl").
--include("src/ec_cmd_log.hrl").
-
--define(PREFIX, "===> ").
-
--record(state_t, {log_level=0 :: int_log_level(),
-                  caller=api :: caller(),
-                  intensity=low :: intensity()}).
-
-%%============================================================================
-%% types
-%%============================================================================
--export_type([t/0,
-              int_log_level/0,
-              atom_log_level/0,
-              log_level/0,
-              caller/0,
-              log_fun/0]).
-
--type caller() :: api | command_line.
-
--type log_level() :: int_log_level() | atom_log_level().
-
--type int_log_level() :: 0..3.
-
--type atom_log_level() :: error | warn | info | debug.
-
--type intensity() :: none | low | high.
-
--type log_fun() :: fun(() -> iolist()).
-
--type color() :: char().
-
--opaque t() :: #state_t{}.
-
-%%============================================================================
-%% API
-%%============================================================================
-%% @doc Create a new 'log level' for the system
--spec new(log_level()) -> t().
-new(LogLevel) ->
-    new(LogLevel, api).
-
--spec new(log_level(), caller()) -> t().
-new(LogLevel, Caller) ->
-    new(LogLevel, Caller, high).
-
-
--spec new(log_level(), caller(), intensity()) -> t().
-new(LogLevel, Caller, Intensity) when (Intensity =:= none orelse
-                                       Intensity =:= low orelse
-                                       Intensity =:= high),
-                                      LogLevel >= 0, LogLevel =< 3 ->
-    #state_t{log_level=LogLevel, caller=Caller,
-             intensity=Intensity};
-new(AtomLogLevel, Caller, Intensity)
-  when AtomLogLevel =:= error;
-       AtomLogLevel =:= warn;
-       AtomLogLevel =:= info;
-       AtomLogLevel =:= debug ->
-    LogLevel = case AtomLogLevel of
-                   error -> 0;
-                   warn -> 1;
-                   info -> 2;
-                   debug -> 3
-               end,
-    new(LogLevel, Caller, Intensity).
-
-
-%% @doc log at the debug level given the current log state with a string or
-%% function that returns a string
--spec debug(t(), string() | log_fun()) -> ok.
-debug(LogState, Fun)
-  when erlang:is_function(Fun) ->
-    log(LogState, ?EC_DEBUG, fun() ->
-                                     colorize(LogState, ?CYAN, false, Fun())
-                             end);
-debug(LogState, String) ->
-    debug(LogState, "~ts~n", [String]).
-
-%% @doc log at the debug level given the current log state with a format string
-%% and arguments @see io:format/2
--spec debug(t(), string(), [any()]) -> ok.
-debug(LogState, FormatString, Args) ->
-    log(LogState, ?EC_DEBUG, colorize(LogState, ?CYAN, false, FormatString), Args).
-
-%% @doc log at the info level given the current log state with a string or
-%% function that returns a string
--spec info(t(), string() | log_fun()) -> ok.
-info(LogState, Fun)
-    when erlang:is_function(Fun) ->
-    log(LogState, ?EC_INFO, fun() ->
-                                    colorize(LogState, ?GREEN, false, Fun())
-                            end);
-info(LogState, String) ->
-    info(LogState, "~ts~n", [String]).
-
-%% @doc log at the info level given the current log state with a format string
-%% and arguments @see io:format/2
--spec info(t(), string(), [any()]) -> ok.
-info(LogState, FormatString, Args) ->
-    log(LogState, ?EC_INFO, colorize(LogState, ?GREEN, false, FormatString), Args).
-
-%% @doc log at the error level given the current log state with a string or
-%% format string that returns a function
--spec error(t(), string() | log_fun()) -> ok.
-error(LogState, Fun)
-    when erlang:is_function(Fun) ->
-    log(LogState, ?EC_ERROR, fun() ->
-                                     colorize(LogState, ?RED, false, Fun())
-                             end);
-error(LogState, String) ->
-    error(LogState, "~ts~n", [String]).
-
-%% @doc log at the error level given the current log state with a format string
-%% and arguments @see io:format/2
--spec error(t(), string(), [any()]) -> ok.
-error(LogState, FormatString, Args) ->
-    log(LogState, ?EC_ERROR, colorize(LogState, ?RED, false, FormatString), Args).
-
-%% @doc log at the warn level given the current log state with a string or
-%% format string that returns a function
--spec warn(t(), string() | log_fun()) -> ok.
-warn(LogState, Fun)
-    when erlang:is_function(Fun) ->
-    log(LogState, ?EC_WARN, fun() -> colorize(LogState, ?MAGENTA, false, Fun()) end);
-warn(LogState, String) ->
-    warn(LogState, "~ts~n", [String]).
-
-%% @doc log at the warn level given the current log state with a format string
-%% and arguments @see io:format/2
--spec warn(t(), string(), [any()]) -> ok.
-warn(LogState, FormatString, Args) ->
-    log(LogState, ?EC_WARN, colorize(LogState, ?MAGENTA, false, FormatString), Args).
-
-%% @doc Execute the fun passed in if log level is as expected.
--spec log(t(), int_log_level(), log_fun()) -> ok.
-log(#state_t{log_level=DetailLogLevel}, LogLevel, Fun)
-    when DetailLogLevel >= LogLevel ->
-    io:format("~ts~n", [Fun()]);
-log(_, _, _) ->
-    ok.
-
-%% @doc when the module log level is less then or equal to the log level for the
-%% call then write the log info out. When its not then ignore the call.
--spec log(t(), int_log_level(), string(), [any()]) -> ok.
-log(#state_t{log_level=DetailLogLevel}, LogLevel, FormatString, Args)
-  when DetailLogLevel >= LogLevel,
-       erlang:is_list(Args) ->
-    io:format(FormatString, Args);
-log(_, _, _, _) ->
-    ok.
-
-%% @doc return a boolean indicating if the system should log for the specified
-%% levelg
--spec should(t(), int_log_level() | any()) -> boolean().
-should(#state_t{log_level=DetailLogLevel}, LogLevel)
-  when DetailLogLevel >= LogLevel ->
-    true;
-should(_, _) ->
-    false.
-
-%% @doc get the current log level as an integer
--spec log_level(t()) -> int_log_level().
-log_level(#state_t{log_level=DetailLogLevel}) ->
-    DetailLogLevel.
-
-%% @doc get the current log level as an atom
--spec atom_log_level(t()) -> atom_log_level().
-atom_log_level(#state_t{log_level=?EC_ERROR}) ->
-    error;
-atom_log_level(#state_t{log_level=?EC_WARN}) ->
-    warn;
-atom_log_level(#state_t{log_level=?EC_INFO}) ->
-    info;
-atom_log_level(#state_t{log_level=?EC_DEBUG}) ->
-    debug.
-
--spec format(t()) -> iolist().
-format(Log) ->
-    [<<"(">>,
-     ec_cnv:to_binary(log_level(Log)), <<":">>,
-     ec_cnv:to_binary(atom_log_level(Log)),
-     <<")">>].
-
--spec colorize(t(), color(), boolean(), string()) -> string().
-
--define(VALID_COLOR(C),
-        C =:= $r orelse C =:= $g orelse C =:= $y orelse
-        C =:= $b orelse C =:= $m orelse C =:= $c orelse
-        C =:= $R orelse C =:= $G orelse C =:= $Y orelse
-        C =:= $B orelse C =:= $M orelse C =:= $C).
-
-colorize(#state_t{intensity=none}, _, _, Msg) ->
-                Msg;
-%% When it is supposed to be bold and we already have a uppercase
-%% (bold color) we don't need to modify the color
-colorize(State, Color, true, Msg)  when ?VALID_COLOR(Color),
-                                        Color >= $A, Color =< $Z ->
-    colorize(State, Color, false, Msg);
-%% We're sneaky we can subtract 32 to get the uppercase character if we want
-%% bold but have a non bold color.
-colorize(State, Color, true, Msg) when ?VALID_COLOR(Color) ->
-    colorize(State, Color - 32, false, Msg);
-colorize(#state_t{caller=command_line, intensity = high},
-         Color, false, Msg) when ?VALID_COLOR(Color) ->
-    lists:flatten(cf:format("~!" ++ [Color] ++"~ts~ts", [?PREFIX, Msg]));
-colorize(#state_t{caller=command_line, intensity = low},
-         Color, false, Msg) when ?VALID_COLOR(Color) ->
-    lists:flatten(cf:format("~!" ++ [Color] ++"~ts~!!~ts", [?PREFIX, Msg]));
-colorize(_LogState, _Color, _Bold, Msg) ->
-    Msg.

src/ec_cmd_log.hrl

@@ -1,7 +0,0 @@
-%%% @copyright 2024 Erlware, LLC.
--define(RED,     $r).
--define(GREEN,   $g).
--define(YELLOW,  $y).
--define(BLUE,    $b).
--define(MAGENTA, $m).
--define(CYAN,    $c).

src/ec_cnv.erl

@@ -1,214 +0,0 @@
-%% -*- erlang-indent-level: 4; indent-tabs-mode: nil; fill-column: 80 -*-
-%%% Copyright 2012 Erlware, LLC. 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.
-%%%---------------------------------------------------------------------------
-%%% @author Eric Merritt <ericbmerritt@gmail.com>
-%%% @copyright (C) 2012 Erlware, LLC.
-%%%
--module(ec_cnv).
-
-%% API
--export([to_integer/1,
-         to_integer/2,
-         to_float/1,
-         to_float/2,
-         to_number/1,
-         to_list/1,
-         to_binary/1,
-         to_atom/1,
-         to_boolean/1,
-         is_true/1,
-         is_false/1]).
-
-%%%===================================================================
-%%% API
-%%%===================================================================
-
-%% @doc
-%% Automatic conversion of a term into integer type.  The conversion
-%% will round a float value if nonstrict is specified otherwise badarg
--spec to_integer(string() | binary() | integer() | float()) ->
-                        integer().
-to_integer(X)->
-    to_integer(X, nonstrict).
-
--spec to_integer(string() | binary() | integer() | float(),
-                 strict | nonstrict) ->
-                        integer().
-to_integer(X, strict)
-  when erlang:is_float(X) ->
-    erlang:error(badarg);
-to_integer(X, nonstrict)
-  when erlang:is_float(X) ->
-    erlang:round(X);
-to_integer(X, S)
-  when erlang:is_binary(X) ->
-    to_integer(erlang:binary_to_list(X), S);
-to_integer(X, S)
-  when erlang:is_list(X) ->
-    try erlang:list_to_integer(X) of
-        Result ->
-            Result
-    catch
-        error:badarg when S =:= nonstrict ->
-            erlang:round(erlang:list_to_float(X))
-    end;
-to_integer(X, _)
-  when erlang:is_integer(X) ->
-    X.
-
-%% @doc
-%% Automatic conversion of a term into float type. badarg if strict
-%% is defined and an integer value is passed.
--spec to_float(string() | binary() | integer() | float()) ->
-                      float().
-to_float(X) ->
-    to_float(X, nonstrict).
-
--spec to_float(string() | binary() | integer() | float(),
-               strict | nonstrict) ->
-                       float().
-to_float(X, S) when is_binary(X) ->
-    to_float(erlang:binary_to_list(X), S);
-to_float(X, S)
-  when erlang:is_list(X) ->
-    try erlang:list_to_float(X) of
-        Result ->
-            Result
-    catch
-        error:badarg when S =:= nonstrict ->
-            erlang:list_to_integer(X) * 1.0
-    end;
-to_float(X, strict) when
-      erlang:is_integer(X) ->
-    erlang:error(badarg);
-to_float(X, nonstrict)
-  when erlang:is_integer(X) ->
-    X * 1.0;
-to_float(X, _) when erlang:is_float(X) ->
-    X.
-
-%% @doc
-%% Automatic conversion of a term into number type.
--spec to_number(binary() | string() | number()) ->
-                       number().
-to_number(X)
-  when erlang:is_number(X) ->
-    X;
-to_number(X)
-  when erlang:is_binary(X) ->
-    to_number(to_list(X));
-to_number(X)
-  when erlang:is_list(X) ->
-    try list_to_integer(X) of
-        Int -> Int
-    catch
-        error:badarg ->
-            list_to_float(X)
-    end.
-
-%% @doc
-%% Automatic conversion of a term into Erlang list
--spec to_list(atom() | list() | binary() | integer() | float()) ->
-                     list().
-to_list(X)
-  when erlang:is_float(X) ->
-    erlang:float_to_list(X);
-to_list(X)
-  when erlang:is_integer(X) ->
-    erlang:integer_to_list(X);
-to_list(X)
-  when erlang:is_binary(X) ->
-    erlang:binary_to_list(X);
-to_list(X)
-  when erlang:is_atom(X) ->
-    erlang:atom_to_list(X);
-to_list(X)
-  when erlang:is_list(X) ->
-    X.
-
-%% @doc
-%% Known limitations:
-%%   Converting [256 | _], lists with integers > 255
--spec to_binary(atom() | string() | binary() | integer() | float()) ->
-                       binary().
-to_binary(X)
-  when erlang:is_float(X) ->
-    to_binary(to_list(X));
-to_binary(X)
-  when erlang:is_integer(X) ->
-    erlang:iolist_to_binary(integer_to_list(X));
-to_binary(X)
-  when erlang:is_atom(X) ->
-    erlang:list_to_binary(erlang:atom_to_list(X));
-to_binary(X)
-  when erlang:is_list(X) ->
-    erlang:iolist_to_binary(X);
-to_binary(X)
-  when erlang:is_binary(X) ->
-    X.
-
--spec to_boolean(binary() | string() | atom()) ->
-                        boolean().
-to_boolean(<<"true">>) ->
-    true;
-to_boolean("true") ->
-    true;
-to_boolean(true) ->
-    true;
-to_boolean(<<"false">>) ->
-    false;
-to_boolean("false") ->
-    false;
-to_boolean(false) ->
-    false.
-
--spec is_true(binary() | string() | atom()) ->
-                     boolean().
-is_true(<<"true">>) ->
-    true;
-is_true("true") ->
-    true;
-is_true(true) ->
-    true;
-is_true(_) ->
-    false.
-
--spec is_false(binary() | string() | atom()) ->
-                      boolean().
-is_false(<<"false">>) ->
-    true;
-is_false("false") ->
-    true;
-is_false(false) ->
-    true;
-is_false(_) ->
-    false.
-
-%% @doc
-%% Automation conversion a term to an existing atom. badarg is
-%% returned if the atom doesn't exist.  the safer version, won't let
-%% you leak atoms
--spec to_atom(atom() | list() | binary() | integer() | float()) ->
-                     atom().
-to_atom(X)
-  when erlang:is_atom(X) ->
-    X;
-to_atom(X)
-  when erlang:is_list(X) ->
-    erlang:list_to_existing_atom(X);
-to_atom(X) ->
-    to_atom(to_list(X)).

src/ec_compile.erl

@@ -1,131 +0,0 @@
-%%%-------------------------------------------------------------------
-%%% @author Eric Merritt <>
-%%% @copyright (C) 2011, Erlware, LLC.
-%%% @doc
-%%%  These are various utility functions to help with compiling and
-%%%  decompiling erlang source. They are mostly useful to the
-%%%  language/parse transform implementor.
-%%% @end
-%%%-------------------------------------------------------------------
--module(ec_compile).
-
--export([beam_to_erl_source/2,
-         erl_source_to_core_ast/1,
-         erl_source_to_erl_ast/1,
-         erl_source_to_asm/1,
-         erl_source_to_erl_syntax/1,
-         erl_string_to_core_ast/1,
-         erl_string_to_erl_ast/1,
-         erl_string_to_asm/1,
-         erl_string_to_erl_syntax/1]).
-
-%%%===================================================================
-%%% API
-%%%===================================================================
-
-%% @doc decompile a beam file that has been compiled with +debug_info
-%% into a erlang source file
-%%
-%% @param BeamFName the name of the beamfile
-%% @param ErlFName the name of the erlang file where the generated
-%% source file will be output. This should *not* be the same as the
-%% source file that created the beamfile unless you want to overwrite
-%% it.
--spec beam_to_erl_source(string(), string()) -> ok | term().
-beam_to_erl_source(BeamFName, ErlFName) ->
-  case beam_lib:chunks(BeamFName, [abstract_code]) of
-    {ok, {_, [{abstract_code, {raw_abstract_v1,Forms}}]}} ->
-          Src =
-              erl_prettypr:format(erl_syntax:form_list(tl(Forms))),
-          {ok, Fd} = file:open(ErlFName, [write]),
-          io:fwrite(Fd, "~ts~n", [Src]),
-          file:close(Fd);
-      Error ->
-          Error
-  end.
-
-%% @doc compile an erlang source file into a Core Erlang AST
-%%
-%% @param Path - The path to the erlang source file
--spec erl_source_to_core_ast(file:filename()) -> CoreAst::term().
-erl_source_to_core_ast(Path) ->
-    {ok, Contents} = file:read_file(Path),
-    erl_string_to_core_ast(binary_to_list(Contents)).
-
-%% @doc compile an erlang source file into an Erlang AST
-%%
-%% @param Path - The path to the erlang source file
--spec erl_source_to_erl_ast(file:filename()) -> ErlangAst::term().
-erl_source_to_erl_ast(Path) ->
-    {ok, Contents} = file:read_file(Path),
-    erl_string_to_erl_ast(binary_to_list(Contents)).
-
-%% @doc compile an erlang source file into erlang terms that represent
-%% the relevant ASM
-%%
-%% @param Path - The path to the erlang source file
--spec erl_source_to_asm(file:filename()) -> ErlangAsm::term().
-erl_source_to_asm(Path) ->
-    {ok, Contents} = file:read_file(Path),
-    erl_string_to_asm(binary_to_list(Contents)).
-
-%% @doc compile an erlang source file to a string that displays the
-%% 'erl_syntax1 calls needed to reproduce those terms.
-%%
-%% @param Path - The path to the erlang source file
--spec erl_source_to_erl_syntax(file:filename()) -> string().
-erl_source_to_erl_syntax(Path) ->
-    {ok, Contents} = file:read_file(Path),
-    erl_string_to_erl_syntax(Contents).
-
-%% @doc compile a string representing an erlang expression into an
-%% Erlang AST
-%%
-%% @param StringExpr - The path to the erlang source file
--spec erl_string_to_erl_ast(string()) -> ErlangAst::term().
-erl_string_to_erl_ast(StringExpr) ->
-    Forms0 =
-        lists:foldl(fun(<<>>, Acc) ->
-                            Acc;
-                       (<<"\n\n">>, Acc) ->
-                            Acc;
-                       (El, Acc) ->
-                            {ok, Tokens, _} =
-                                erl_scan:string(binary_to_list(El)
-                                                ++ "."),
-                            [Tokens | Acc]
-                    end, [], re:split(StringExpr, "\\.\n")),
-    %% No need to reverse. This will rereverse for us
-    lists:foldl(fun(Form, Forms) ->
-                        {ok, ErlAST} = erl_parse:parse_form(Form),
-                        [ErlAST | Forms]
-                end, [], Forms0).
-
-%% @doc compile a string representing an erlang expression into a
-%% Core Erlang AST
-%%
-%% @param StringExpr - The path to the erlang source file
--spec erl_string_to_core_ast(string()) -> CoreAst::term().
-erl_string_to_core_ast(StringExpr) ->
-    compile:forms(erl_string_to_erl_ast(StringExpr), [to_core]).
-
-%% @doc compile a string representing an erlang expression into a term
-%% that represents the ASM
-%%
-%% @param StringExpr - The path to the erlang source file
--spec erl_string_to_asm(string()) -> ErlangAsm::term().
-erl_string_to_asm(StringExpr) ->
-    compile:forms(erl_string_to_erl_ast(StringExpr), ['S']).
-
-%% @doc compile an erlang source file to a string that displays the
-%% 'erl_syntax1 calls needed to reproduce those terms.
-%%
-%% @param StringExpr - The string representing the erlang code.
--spec erl_string_to_erl_syntax(string() | binary()) -> string().
-erl_string_to_erl_syntax(BinaryExpr)
-  when erlang:is_binary(BinaryExpr) ->
-    erlang:binary_to_list(BinaryExpr);
-erl_string_to_erl_syntax(StringExpr) ->
-    {ok, Tokens, _} = erl_scan:string(StringExpr),
-    {ok, ErlAST} = erl_parse:parse_form(Tokens),
-    io:format(erl_prettypr:format(erl_syntax:meta(ErlAST))).

src/ec_dict.erl

@@ -1,4 +1,3 @@
-%%% vi:ts=4 sw=4 et
 %%%-------------------------------------------------------------------
 %%% @author Eric Merritt <ericbmerritt@gmail.com>
 %%% @copyright 2011 Erlware, LLC.
@@ -6,9 +5,9 @@
 %%%  This provides an implementation of the ec_dictionary type using
 %%%  erlang dicts as a base. The function documentation for
 %%%  ec_dictionary applies here as well.
-%%% see ec_dictionary
-%%% see dict
 %%% @end
+%%% @see ec_dictionary
+%%% @see dict
 %%%-------------------------------------------------------------------
 -module(ec_dict).
 
@@ -32,9 +31,7 @@
 %%%===================================================================
 %%% Types
 %%%===================================================================
-%% This should be opaque, but that kills dialyzer so for now we export it
+-opaque dictionary(_K, _V) :: dict().
-%% however you should not rely on the internal representation here
--type dictionary(_K, _V) :: dict:dict().
 
 %%%===================================================================
 %%% API
@@ -91,7 +88,7 @@ has_value(Value, Data) ->
 	      false,
 	      Data).
 
--spec size(Object::dictionary(_K, _V)) -> non_neg_integer().
+-spec size(Object::dictionary(_K, _V)) -> integer().
 size(Data) ->
     dict:size(Data).
 

src/ec_dictionary.erl

@@ -1,4 +1,3 @@
-%%% vi:ts=4 sw=4 et
 %%%-------------------------------------------------------------------
 %%% @author Eric Merritt <ericbmerritt@gmail.com>
 %%% @copyright 2011 Erlware, LLC.
@@ -11,6 +10,9 @@
 %%%-------------------------------------------------------------------
 -module(ec_dictionary).
 
+%%% Behaviour Callbacks
+-export([behaviour_info/1]).
+
 %% API
 -export([new/1,
 	 has_key/2,
@@ -36,27 +38,30 @@
 	{callback,
 	  data}).
 
-%% This should be opaque, but that kills dialyzer so for now we export it
+-opaque dictionary(_K, _V) :: #dict_t{}.
-%% however you should not rely on the internal representation here
--type dictionary(_K, _V) :: #dict_t{}.
 -type key(T) :: T.
 -type value(T) :: T.
 
--callback new() -> any().
--callback has_key(key(any()), any()) -> boolean().
--callback get(key(any()), any()) -> any().
--callback add(key(any()), value(any()), T) -> T.
--callback remove(key(any()), T) -> T.
--callback has_value(value(any()), any()) -> boolean().
--callback size(any()) -> non_neg_integer().
--callback to_list(any()) -> [{key(any()), value(any())}].
--callback from_list([{key(any()), value(any())}]) -> any().
--callback keys(any()) -> [key(any())].
-
 %%%===================================================================
 %%% API
 %%%===================================================================
 
+%% @doc export the behaviour callbacks for this type
+%% @private
+behaviour_info(callbacks) ->
+    [{new, 0},
+     {has_key, 2},
+     {get, 2},
+     {add, 3},
+     {remove, 2},
+     {has_value, 2},
+     {size, 1},
+     {to_list, 1},
+     {from_list, 1},
+     {keys, 1}];
+behaviour_info(_) ->
+    undefined.
+
 %% @doc create a new dictionary object from the specified module. The
 %% module should implement the dictionary behaviour.
 %%
@@ -78,7 +83,7 @@ has_key(Key, #dict_t{callback = Mod, data = Data}) ->
 %%
 %% @param Dict The dictionary object to return the value from
 %% @param Key The key requested
-%%  when the key does not exist @throws not_found
+%% @throws not_found when the key does not exist
 -spec get(key(K), dictionary(K, V)) -> value(V).
 get(Key, #dict_t{callback = Mod, data = Data}) ->
     Mod:get(Key, Data).

src/ec_file.erl

@@ -1,4 +1,3 @@
-%%% vi:ts=4 sw=4 et
 %%%-------------------------------------------------------------------
 %%% @copyright (C) 2011, Erlware LLC
 %%% @doc
@@ -8,171 +7,95 @@
 -module(ec_file).
 
 -export([
-         exists/1,
          copy/2,
          copy/3,
-         copy_file_info/3,
+         mkdtemp/0,
-         insecure_mkdtemp/0,
          mkdir_path/1,
-         mkdir_p/1,
          find/2,
          is_symlink/1,
-         is_dir/1,
-         type/1,
-         real_dir_path/1,
          remove/1,
          remove/2,
          md5sum/1,
-         sha1sum/1,
          read/1,
          write/2,
-         write_term/2
+         write_term/2,
+         consult/1
         ]).
 
 -export_type([
+              path/0,
               option/0
              ]).
 
 -include_lib("kernel/include/file.hrl").
 
+%% User friendly exception message (remove line and module info once we
+%% get them in stack traces)
+-define(UEX(Exception, UMSG, UVARS),
+        {uex, {?MODULE,
+               ?LINE,
+               Exception,
+               lists:flatten(io_lib:fwrite(UMSG, UVARS))}}).
+
 -define(CHECK_PERMS_MSG,
         "Try checking that you have the correct permissions and try again~n").
 
 %%============================================================================
 %% Types
 %%============================================================================
--type file_info() :: mode | time | owner | group.
+-type path() :: string().
--type option() :: recursive | {file_info, [file_info()]}.
+-type option() :: [atom()].
 
 %%%===================================================================
 %%% API
 %%%===================================================================
--spec exists(file:filename()) -> boolean().
-exists(Filename) ->
-    case file:read_file_info(Filename) of
-        {ok, _}         ->
-            true;
-        {error, _Reason} ->
-            false
-    end.
-
 %% @doc copy an entire directory to another location.
--spec copy(file:name(), file:name(), Options::[option()]) -> ok | {error, Reason::term()}.
+-spec copy(path(), path(), Options::[option()]) -> ok.
 copy(From, To, []) ->
-    copy_(From, To, []);
+    copy(From, To);
-copy(From, To, Options) ->
+copy(From, To, [recursive] = Options) ->
-    case proplists:get_value(recursive,  Options, false) of
+    case filelib:is_dir(From) of
-        true ->
-            case is_dir(From) of
         false ->
-                    copy_(From, To, Options);
+            copy(From, To);
         true ->
             make_dir_if_dir(To),
             copy_subfiles(From, To, Options)
-            end;
-        false ->
-            copy_(From, To, Options)
     end.
 
 %% @doc copy a file including timestamps,ownership and mode etc.
--spec copy(From::file:filename(), To::file:filename()) -> ok | {error, Reason::term()}.
+-spec copy(From::string(), To::string()) -> ok.
 copy(From, To) ->
-    copy_(From, To, [{file_info, [mode, time, owner, group]}]).
+    try
-
+        ec_file_copy(From, To)
-copy_(From, To, Options) ->
+    catch
-    Linked
+        _C:E -> throw(?UEX({copy_failed, E}, ?CHECK_PERMS_MSG, []))
-        = case file:read_link(From) of
-            {ok, Linked0} -> Linked0;
-            {error, _} -> undefined
-          end,
-    case Linked =/= undefined orelse file:copy(From, To) of
-        true ->
-            file:make_symlink(Linked, To);
-        {ok, _} ->
-            copy_file_info(To, From, proplists:get_value(file_info, Options, []));
-        {error, Error} ->
-            {error, {copy_failed, Error}}
     end.
 
-copy_file_info(To, From, FileInfoToKeep) ->
+%% @doc return an md5 checksum string or a binary. Same as unix utility of
-    case file:read_file_info(From) of
+%%      same name.
-        {ok, FileInfo} ->
-            case write_file_info(To, FileInfo, FileInfoToKeep) of
-                [] ->
-                    ok;
-                Errors ->
-                    {error, {write_file_info_failed_for, Errors}}
-            end;
-        {error, RFError} ->
-            {error, {read_file_info_failed, RFError}}
-    end.
-
-write_file_info(To, FileInfo, FileInfoToKeep) ->
-    WriteInfoFuns = [{mode, fun try_write_mode/2},
-                     {time, fun try_write_time/2},
-                     {group, fun try_write_group/2},
-                     {owner, fun try_write_owner/2}],
-    lists:foldl(fun(Info, Acc) ->
-                        case proplists:get_value(Info, WriteInfoFuns, undefined) of
-                            undefined ->
-                                Acc;
-                            F ->
-                                case F(To, FileInfo) of
-                                    ok ->
-                                        Acc;
-                                    {error, Reason} ->
-                                        [{Info, Reason} | Acc]
-                                end
-                        end
-                end, [], FileInfoToKeep).
-
-
-try_write_mode(To, #file_info{mode=Mode}) ->
-    file:write_file_info(To, #file_info{mode=Mode}).
-
-try_write_time(To, #file_info{atime=Atime, mtime=Mtime}) ->
-    file:write_file_info(To, #file_info{atime=Atime, mtime=Mtime}).
-
-try_write_owner(To, #file_info{uid=OwnerId}) ->
-    file:write_file_info(To, #file_info{uid=OwnerId}).
-
-try_write_group(To, #file_info{gid=OwnerId}) ->
-    file:write_file_info(To, #file_info{gid=OwnerId}).
-
-%% @doc return the MD5 digest of a string or a binary,
-%%      named after the UNIX utility.
 -spec md5sum(string() | binary()) -> string().
 md5sum(Value) ->
-    bin_to_hex(crypto:hash(md5, Value)).
+    hex(binary_to_list(erlang:md5(Value))).
-
-%% @doc return the SHA-1 digest of a string or a binary,
-%%      named after the UNIX utility.
--spec sha1sum(string() | binary()) -> string().
-sha1sum(Value) ->
-    bin_to_hex(crypto:hash(sha, Value)).
-
-bin_to_hex(Bin) ->
-    hex(binary_to_list(Bin)).
 
 %% @doc delete a file. Use the recursive option for directories.
 %% <pre>
 %% Example: remove("./tmp_dir", [recursive]).
 %% </pre>
--spec remove(file:name(), Options::[option()]) -> ok | {error, Reason::term()}.
+-spec remove(path(), Options::[option()]) -> ok | {error, Reason::term()}.
 remove(Path, Options) ->
-    case lists:member(recursive, Options) of
+    try
-        false -> file:delete(Path);
+        ok = ec_file_remove(Path, Options)
-        true  -> remove_recursive(Path, Options)
+    catch
+        _C:E -> throw(?UEX({remove_failed, E}, ?CHECK_PERMS_MSG, []))
     end.
 
-
 %% @doc delete a file.
--spec remove(file:name()) -> ok | {error, Reason::term()}.
+-spec remove(path()) -> ok | {error, Reason::term()}.
 remove(Path) ->
     remove(Path, []).
 
-%% @doc indicates with a boolean if the path supplied refers to symlink.
+%% @doc indicates witha boolean if the path supplied refers to symlink.
--spec is_symlink(file:name()) -> boolean().
+-spec is_symlink(path()) -> boolean().
 is_symlink(Path) ->
     case file:read_link_info(Path) of
         {ok, #file_info{type = symlink}} ->
@@ -181,103 +104,93 @@ is_symlink(Path) ->
             false
     end.
 
-is_dir(Path) ->
-    case file:read_file_info(Path) of
-        {ok, #file_info{type = directory}} ->
-            true;
-        _ ->
-            false
-    end.
 
-%% @doc returns the type of the file.
+%% @doc make a unique temorory directory. Similar function to BSD stdlib
--spec type(file:name()) -> file | symlink | directory | undefined.
-type(Path) ->
-    case filelib:is_regular(Path) of
-        true ->
-            file;
-        false ->
-            case is_symlink(Path) of
-                true ->
-                    symlink;
-                false ->
-                    case is_dir(Path) of
-                        true -> directory;
-                        false -> undefined
-                    end
-            end
-
-    end.
-%% @doc gets the real path of a directory. This is mostly useful for
-%% resolving symlinks. Be aware that this temporarily changes the
-%% current working directory to figure out what the actual path
-%% is. That means that it can be quite slow.
--spec real_dir_path(file:name()) -> file:name().
-real_dir_path(Path) ->
-    {ok, CurCwd} = file:get_cwd(),
-    ok = file:set_cwd(Path),
-    {ok, RealPath} = file:get_cwd(),
-    ok = file:set_cwd(CurCwd),
-    filename:absname(RealPath).
-
-%% @doc make a unique temporary directory. Similar function to BSD stdlib
 %% function of the same name.
--spec insecure_mkdtemp() -> TmpDirPath::file:name() | {error, term()}.
+-spec mkdtemp() -> TmpDirPath::path().
-insecure_mkdtemp() ->
+mkdtemp() ->
-    UniqueNumber = erlang:integer_to_list(erlang:trunc(rand:uniform() * 1_000_000_000_000)),
+    UniqueNumber = integer_to_list(element(3, now())),
     TmpDirPath =
         filename:join([tmp(), lists:flatten([".tmp_dir", UniqueNumber])]),
-
+    try
-    case mkdir_path(TmpDirPath) of
+        ok = mkdir_path(TmpDirPath),
-        ok -> TmpDirPath;
+        TmpDirPath
-        Error -> Error
+    catch
+        _C:E -> throw(?UEX({mkdtemp_failed, E}, ?CHECK_PERMS_MSG, []))
     end.
 
-%% @doc Makes a directory including parent dirs if they are missing.
--spec mkdir_p(file:name()) -> ok | {error, Reason::term()}.
-mkdir_p(Path) ->
-    %% We are exploiting a feature of ensuredir that that creates all
-    %% directories up to the last element in the filename, then ignores
-    %% that last element. This way we ensure that the dir is created
-    %% and not have any worries about path names
-    DirName = filename:join([filename:absname(Path), "tmp"]),
-    filelib:ensure_dir(DirName).
-
 
 %% @doc Makes a directory including parent dirs if they are missing.
--spec mkdir_path(file:name()) -> ok | {error, Reason::term()}.
+-spec mkdir_path(path()) -> ok.
 mkdir_path(Path) ->
-    mkdir_p(Path).
+                                                % We are exploiting a feature of ensuredir that that creates all
+                                                % directories up to the last element in the filename, then ignores
+                                                % that last element. This way we ensure that the dir is created
+                                                % and not have any worries about path names
+    DirName = filename:join([filename:absname(Path), "tmp"]),
+    try
+        ok = filelib:ensure_dir(DirName)
+    catch
+        _C:E -> throw(?UEX({mkdir_path_failed, E}, ?CHECK_PERMS_MSG, []))
+    end.
 
 
-%% @doc read a file from the file system. Provide UEX exception on failure.
+%% @doc consult an erlang term file from the file system.
--spec read(FilePath::file:filename()) -> {ok, binary()} | {error, Reason::term()}.
+%%      Provide user readible exeption on failure.
+-spec consult(FilePath::path()) -> term().
+consult(FilePath) ->
+    case file:consult(FilePath) of
+        {ok, [Term]} ->
+            Term;
+        {error, Error} ->
+            Msg = "The file at ~p~n" ++
+                "is either not a valid Erlang term, does not to exist~n" ++
+                "or you lack the permissions to read it. Please check~n" ++
+                "to see if the file exists and that it has the correct~n" ++
+                "permissions~n",
+            throw(?UEX({failed_to_consult_file, {FilePath, Error}},
+                       Msg, [FilePath]))
+    end.
+
+%% @doc read a file from the file system. Provide UEX exeption on failure.
+-spec read(FilePath::string()) -> binary().
 read(FilePath) ->
-    %% Now that we are moving away from exceptions again this becomes
+    try
-    %% a bit redundant but we want to be backwards compatible as much
+        {ok, FileBin} = file:read_file(FilePath),
-    %% as possible in the api.
+        FileBin
-    file:read_file(FilePath).
+    catch
+        _C:E -> throw(?UEX({read_failed, {FilePath, E}},
+                           "Read failed for the file ~p with ~p~n" ++
+                               ?CHECK_PERMS_MSG,
+                           [FilePath, E]))
+    end.
 
-
+%% @doc write a file to the file system. Provide UEX exeption on failure.
-%% @doc write a file to the file system. Provide UEX exception on failure.
+-spec write(FileName::string(), Contents::string()) -> ok.
--spec write(FileName::file:filename(), Contents::string()) -> ok | {error, Reason::term()}.
 write(FileName, Contents) ->
-    %% Now that we are moving away from exceptions again this becomes
+    case file:write_file(FileName, Contents) of
-    %% a bit redundant but we want to be backwards compatible as much
+        ok ->
-    %% as possible in the api.
+            ok;
-    file:write_file(FileName, Contents).
+        {error, Reason} ->
+            Msg = "Writing the file ~s to disk failed with reason ~p.~n" ++
+                ?CHECK_PERMS_MSG,
+            throw(?UEX({write_file_failure, {FileName, Reason}},
+                       Msg,
+                       [FileName, Reason]))
+    end.
 
 %% @doc write a term out to a file so that it can be consulted later.
--spec write_term(file:filename(), term()) -> ok | {error, Reason::term()}.
+-spec write_term(string(), term()) -> ok.
 write_term(FileName, Term) ->
     write(FileName, lists:flatten(io_lib:fwrite("~p. ", [Term]))).
 
 %% @doc Finds files and directories that match the regexp supplied in
 %%  the TargetPattern regexp.
--spec find(FromDir::file:name(), TargetPattern::string()) -> [file:name()].
+-spec find(FromDir::path(), TargetPattern::string()) -> [path()].
 find([], _) ->
     [];
 find(FromDir, TargetPattern) ->
-    case is_dir(FromDir) of
+    case filelib:is_dir(FromDir) of
         false ->
             case re:run(FromDir, TargetPattern) of
                 {match, _} -> [FromDir];
@@ -294,7 +207,7 @@ find(FromDir, TargetPattern) ->
 %%%===================================================================
 %%% Internal Functions
 %%%===================================================================
--spec find_in_subdirs(file:name(), string()) -> [file:name()].
+-spec find_in_subdirs(path(), string()) -> [path()].
 find_in_subdirs(FromDir, TargetPattern) ->
     lists:foldl(fun(CheckFromDir, Acc)
                       when CheckFromDir == FromDir ->
@@ -306,52 +219,57 @@ find_in_subdirs(FromDir, TargetPattern) ->
                         end
                 end,
                 [],
-                sub_files(FromDir)).
+                filelib:wildcard(filename:join(FromDir, "*"))).
 
+-spec ec_file_remove(path(), [{atom(), any()}]) -> ok.
+ec_file_remove(Path, Options) ->
+    case lists:member(recursive, Options) of
+        false -> file:delete(Path);
+        true  -> remove_recursive(Path, Options)
+    end.
 
-
+-spec remove_recursive(path(), Options::list()) -> ok.
--spec remove_recursive(file:name(), Options::list()) -> ok | {error, Reason::term()}.
 remove_recursive(Path, Options) ->
-    case is_dir(Path) of
+    case filelib:is_dir(Path) of
         false ->
             file:delete(Path);
         true ->
             lists:foreach(fun(ChildPath) ->
                                   remove_recursive(ChildPath, Options)
-                          end, sub_files(Path)),
+                          end, filelib:wildcard(filename:join(Path, "*"))),
-            file:del_dir(Path)
+            ok = file:del_dir(Path)
     end.
 
--spec tmp() -> file:name().
+-spec tmp() -> path().
 tmp() ->
     case erlang:system_info(system_architecture) of
         "win32" ->
-            case os:getenv("TEMP") of
+            "./tmp";
-                false -> "./tmp";
-                Val -> Val
-            end;
         _SysArch ->
-            case os:getenv("TMPDIR") of
+            "/tmp"
-                false -> "/tmp";
-                Val -> Val
-            end
     end.
 
 %% Copy the subfiles of the From directory to the to directory.
--spec copy_subfiles(file:name(), file:name(), [option()]) -> {error, Reason::term()} | ok.
+-spec copy_subfiles(path(), path(), [option()]) -> ok.
 copy_subfiles(From, To, Options) ->
     Fun =
         fun(ChildFrom) ->
                 ChildTo = filename:join([To, filename:basename(ChildFrom)]),
                 copy(ChildFrom, ChildTo, Options)
         end,
-    lists:foreach(Fun, sub_files(From)).
+    lists:foreach(Fun, filelib:wildcard(filename:join(From, "*"))).
 
--spec make_dir_if_dir(file:name()) -> ok | {error, Reason::term()}.
+-spec ec_file_copy(path(), path()) -> ok.
+ec_file_copy(From, To) ->
+    {ok, _} = file:copy(From, To),
+    {ok, FileInfo} = file:read_file_info(From),
+    ok = file:write_file_info(To, FileInfo).
+
+-spec make_dir_if_dir(path()) -> ok.
 make_dir_if_dir(File) ->
-    case is_dir(File) of
+    case filelib:is_dir(File) of
         true  -> ok;
-        false -> mkdir_path(File)
+        false -> ok = mkdir_path(File)
     end.
 
 %% @doc convert a list of integers into hex.
@@ -371,7 +289,72 @@ hex0(14) -> $e;
 hex0(15) -> $f;
 hex0(I)  -> $0 + I.
 
+%%%===================================================================
+%%% Test Functions
+%%%===================================================================
 
-sub_files(From) ->
+-ifndef(NOTEST).
-    {ok, SubFiles} = file:list_dir(From),
+-include_lib("eunit/include/eunit.hrl").
-    [filename:join(From, SubFile) || SubFile <- SubFiles].
+
+setup_test() ->
+    case filelib:is_dir("/tmp/ec_file") of
+        true ->
+            remove("/tmp/ec_file", [recursive]);
+        false ->
+            ok
+    end,
+    mkdir_path("/tmp/ec_file/dir"),
+    ?assertMatch(false, is_symlink("/tmp/ec_file/dir")),
+    ?assertMatch(true, filelib:is_dir("/tmp/ec_file/dir")).
+
+
+md5sum_test() ->
+    ?assertMatch("cfcd208495d565ef66e7dff9f98764da", md5sum("0")).
+
+file_test() ->
+    TermFile = "/tmp/ec_file/dir/file.term",
+    TermFileCopy = "/tmp/ec_file/dircopy/file.term",
+    write_term(TermFile, "term"),
+    ?assertMatch("term", consult(TermFile)),
+    ?assertMatch(<<"\"term\". ">>, read(TermFile)),
+    copy(filename:dirname(TermFile),
+         filename:dirname(TermFileCopy),
+         [recursive]),
+    ?assertMatch("term", consult(TermFileCopy)).
+
+teardown_test() ->
+    remove("/tmp/ec_file", [recursive]),
+    ?assertMatch(false, filelib:is_dir("/tmp/ec_file")).
+
+setup_base_and_target() ->
+    {ok, BaseDir} = ewl_file:create_tmp_dir("/tmp"),
+    DummyContents = <<"This should be deleted">>,
+    SourceDir = filename:join([BaseDir, "source"]),
+    ok = file:make_dir(SourceDir),
+    Name1 = filename:join([SourceDir, "fileone"]),
+    Name2 = filename:join([SourceDir, "filetwo"]),
+    Name3 = filename:join([SourceDir, "filethree"]),
+    NoName = filename:join([SourceDir, "noname"]),
+
+    ok = file:write_file(Name1, DummyContents),
+    ok = file:write_file(Name2, DummyContents),
+    ok = file:write_file(Name3, DummyContents),
+    ok = file:write_file(NoName, DummyContents),
+    {BaseDir, SourceDir, {Name1, Name2, Name3, NoName}}.
+
+find_test() ->
+                                                % Create a directory in /tmp for the test. Clean everything afterwards
+
+    {setup,
+     fun setup_base_and_target/0,
+     fun ({BaseDir, _, _}) ->
+             ewl_file:delete_dir(BaseDir)
+     end,
+     fun ({BaseDir, _, {Name1, Name2, Name3, _}}) ->
+             ?assertMatch([Name2,
+                           Name3,
+                           Name1],
+                          ewl_file:find(BaseDir, "file[a-z]+\$"))
+     end}.
+
+-endif.

src/ec_gb_trees.erl

@@ -1,13 +1,12 @@
-%%% vi:ts=4 sw=4 et
 %%%-------------------------------------------------------------------
 %%% @author Eric Merritt <ericbmerritt@gmail.com>
 %%% @copyright 2011 Erlware, LLC.
 %%% @doc
 %%% This provides an implementation of the type ec_dictionary using
 %%% gb_trees as a backin
-%%% see ec_dictionary
-%%% see gb_trees
 %%% @end
+%%% @see ec_dictionary
+%%% @see gb_trees
 %%%-------------------------------------------------------------------
 -module(ec_gb_trees).
 
@@ -26,6 +25,17 @@
 	 from_list/1,
 	 keys/1]).
 
+-export_type([dictionary/2]).
+
+%%%===================================================================
+%%% Types
+%%%===================================================================
+-opaque dictionary(K, V) :: {non_neg_integer(), ec_gb_tree_node(K, V)}.
+
+-type ec_gb_tree_node(K, V) :: 'nil' | {K, V,
+					ec_gb_tree_node(K, V),
+					ec_gb_tree_node(K, V)}.
+
 %%%===================================================================
 %%% API
 %%%===================================================================
@@ -36,7 +46,7 @@
 %% same implementation is created and returned.
 %%
 %% @param ModuleName|Object The module name or existing dictionary object.
--spec new() -> gb_trees:tree(_K, _V).
+-spec new() -> dictionary(_K, _V).
 new() ->
     gb_trees:empty().
 
@@ -44,7 +54,7 @@ new() ->
 %%
 %% @param Object The dictory object to check
 %% @param Key The key to check the dictionary for
--spec has_key(ec_dictionary:key(K), Object::gb_trees:tree(K, _V)) -> boolean().
+-spec has_key(ec_dictionary:key(K), Object::dictionary(K, _V)) -> boolean().
 has_key(Key, Data) ->
     case gb_trees:lookup(Key, Data) of
 	{value, _Val} ->
@@ -58,8 +68,8 @@ has_key(Key, Data) ->
 %%
 %% @param Object The dictionary object to return the value from
 %% @param Key The key requested
-%% when the key does not exist @throws not_found
+%% @throws not_found when the key does not exist
--spec get(ec_dictionary:key(K), Object::gb_trees:tree(K, V)) ->
+-spec get(ec_dictionary:key(K), Object::dictionary(K, V)) ->
     ec_dictionary:value(V).
 get(Key, Data) ->
     case gb_trees:lookup(Key, Data) of
@@ -71,7 +81,7 @@ get(Key, Data) ->
 
 -spec get(ec_dictionary:key(K),
 	  ec_dictionary:value(V),
-          Object::gb_trees:tree(K, V)) ->
+	  Object::dictionary(K, V)) ->
     ec_dictionary:value(V).
 get(Key, Default, Data) ->
     case gb_trees:lookup(Key, Data) of
@@ -88,8 +98,8 @@ get(Key, Default, Data) ->
 %% @param Key the key to add
 %% @param Value the value to add
 -spec add(ec_dictionary:key(K), ec_dictionary:value(V),
-          Object::gb_trees:tree(K, V)) ->
+	  Object::dictionary(K, V)) ->
-    gb_trees:tree(K, V).
+    dictionary(K, V).
 add(Key, Value, Data) ->
     gb_trees:enter(Key, Value, Data).
 
@@ -98,8 +108,8 @@ add(Key, Value, Data) ->
 %%
 %% @param Object the dictionary object to remove the value from
 %% @param Key the key of the key/value pair to remove
--spec remove(ec_dictionary:key(K), Object::gb_trees:tree(K, V)) ->
+-spec remove(ec_dictionary:key(K), Object::dictionary(K, V)) ->
-    gb_trees:tree(K, V).
+    dictionary(K, V).
 remove(Key, Data) ->
     gb_trees:delete_any(Key, Data).
 
@@ -107,24 +117,24 @@ remove(Key, Data) ->
 %%
 %% @param Object the dictionary object to check
 %% @param Value The value to check if exists
--spec has_value(ec_dictionary:value(V), Object::gb_trees:tree(_K, V)) -> boolean().
+-spec has_value(ec_dictionary:value(V), Object::dictionary(_K, V)) -> boolean().
 has_value(Value, Data) ->
     lists:member(Value, gb_trees:values(Data)).
 
 %% @doc return the current number of key value pairs in the dictionary
 %%
 %% @param Object the object return the size for.
--spec size(Object::gb_trees:tree(_K, _V)) -> non_neg_integer().
+-spec size(Object::dictionary(_K, _V)) -> integer().
 size(Data) ->
     gb_trees:size(Data).
 
--spec to_list(gb_trees:tree(K, V)) -> [{ec_dictionary:key(K),
+-spec to_list(dictionary(K, V)) -> [{ec_dictionary:key(K),
 				     ec_dictionary:value(V)}].
 to_list(Data) ->
     gb_trees:to_list(Data).
 
 -spec from_list([{ec_dictionary:key(K), ec_dictionary:value(V)}]) ->
-    gb_trees:tree(K, V).
+    dictionary(K, V).
 from_list(List) when is_list(List) ->
     lists:foldl(fun({Key, Value}, Dict) ->
 			gb_trees:enter(Key, Value, Dict)
@@ -132,6 +142,82 @@ from_list(List) when is_list(List) ->
 		gb_trees:empty(),
 		List).
 
--spec keys(gb_trees:tree(K,_V)) -> [ec_dictionary:key(K)].
+-spec keys(dictionary(K,_V)) -> [ec_dictionary:key(K)].
 keys(Data) ->
     gb_trees:keys(Data).
+
+%%%===================================================================
+%%% Tests
+%%%===================================================================
+
+
+-ifndef(NOTEST).
+-include_lib("eunit/include/eunit.hrl").
+
+%% For me unit testing initially is about covering the obvious case. A
+%% check to make sure that what you expect the tested functionality to
+%% do, it actually does. As time goes on and people detect bugs you
+%% add tests for those specific problems to the unit test suit.
+%%
+%% However, when getting started you can only test your basic
+%% expectations. So here are the expectations I have for the add
+%% functionality.
+%%
+%% 1) I can put arbitrary terms into the dictionary as keys
+%% 2) I can put arbitrary terms into the dictionary as values
+%% 3) When I put a value in the dictionary by a key, I can retrieve
+%% that same value
+%% 4) When I put a different value in the dictionary by key it does
+%% not change other key value pairs.
+%% 5) When I update a value the new value in available by the new key
+%% 6) When a value does not exist a not found exception is created
+
+add_test() ->
+    Dict0 = ec_dictionary:new(ec_gb_trees),
+
+    Key1 = foo,
+    Key2 = [1, 3],
+    Key3 = {"super"},
+    Key4 = <<"fabulous">>,
+    Key5 = {"Sona", 2, <<"Zuper">>},
+
+    Value1 = Key5,
+    Value2 = Key4,
+    Value3 = Key2,
+    Value4 = Key3,
+    Value5 = Key1,
+
+    Dict01 = ec_dictionary:add(Key1, Value1, Dict0),
+    Dict02 = ec_dictionary:add(Key3, Value3,
+			       ec_dictionary:add(Key2, Value2,
+						 Dict01)),
+    Dict1 =
+	ec_dictionary:add(Key5, Value5,
+			  ec_dictionary:add(Key4, Value4,
+					    Dict02)),
+
+    ?assertMatch(Value1, ec_dictionary:get(Key1, Dict1)),
+    ?assertMatch(Value2, ec_dictionary:get(Key2, Dict1)),
+    ?assertMatch(Value3, ec_dictionary:get(Key3, Dict1)),
+    ?assertMatch(Value4, ec_dictionary:get(Key4, Dict1)),
+    ?assertMatch(Value5, ec_dictionary:get(Key5, Dict1)),
+
+
+    Dict2 = ec_dictionary:add(Key3, Value5,
+			      ec_dictionary:add(Key2, Value4, Dict1)),
+
+
+    ?assertMatch(Value1, ec_dictionary:get(Key1, Dict2)),
+    ?assertMatch(Value4, ec_dictionary:get(Key2, Dict2)),
+    ?assertMatch(Value5, ec_dictionary:get(Key3, Dict2)),
+    ?assertMatch(Value4, ec_dictionary:get(Key4, Dict2)),
+    ?assertMatch(Value5, ec_dictionary:get(Key5, Dict2)),
+
+
+    ?assertThrow(not_found, ec_dictionary:get(should_blow_up, Dict2)),
+    ?assertThrow(not_found, ec_dictionary:get("This should blow up too",
+					      Dict2)).
+
+
+
+-endif.

src/ec_git_vsn.erl

@@ -1,107 +0,0 @@
-%%% vi:ts=4 sw=4 et
-%%%-------------------------------------------------------------------
-%%% @author Eric Merritt <ericbmerritt@gmail.com>
-%%% @copyright 2011 Erlware, LLC.
-%%% @doc
-%%%  This provides an implementation of the ec_vsn for git. That is
-%%%  it is capable of returning a semver for a git repository
-%%% see ec_vsn
-%%% see ec_semver
-%%% @end
-%%%-------------------------------------------------------------------
--module(ec_git_vsn).
-
--behaviour(ec_vsn).
-
-%% API
--export([new/0,
-         vsn/1]).
-
--ifdef(TEST).
--export([parse_tags/1,
-	 get_patch_count/1,
-	 collect_default_refcount/1
-	]).
--endif.
-
--export_type([t/0]).
-
-%%%===================================================================
-%%% Types
-%%%===================================================================
-%% This should be opaque, but that kills dialyzer so for now we export it
-%% however you should not rely on the internal representation here
--type t() :: {}.
-
-%%%===================================================================
-%%% API
-%%%===================================================================
-
--spec new() -> t().
-new() ->
-    {}.
-
--spec vsn(t()|string()) -> {ok, string()} | {error, Reason::any()}.
-vsn(Data) ->
-    {Vsn, RawRef, RawCount} = collect_default_refcount(Data),
-    {ok, build_vsn_string(Vsn, RawRef, RawCount)}.
-
-%%%===================================================================
-%%% Internal Functions
-%%%===================================================================
-
-collect_default_refcount(Data) ->
-    %% Get the tag timestamp and minimal ref from the system. The
-    %% timestamp is really important from an ordering perspective.
-    RawRef = os:cmd("git log -n 1 --pretty=format:'%h\n' "),
-
-    {Tag, TagVsn} = parse_tags(Data),
-    RawCount =
-        case Tag of
-            undefined ->
-                os:cmd("git rev-list --count HEAD");
-            _ ->
-                get_patch_count(Tag)
-        end,
-    {TagVsn, RawRef, RawCount}.
-
-build_vsn_string(Vsn, RawRef, RawCount) ->
-    %% Cleanup the tag and the Ref information. Basically leading 'v's and
-    %% whitespace needs to go away.
-    RefTag = [".ref", re:replace(RawRef, "\\s", "", [global])],
-    Count = erlang:iolist_to_binary(re:replace(RawCount, "\\s", "", [global])),
-
-    %% Create the valid [semver](http://semver.org) version from the tag
-    case Count of
-        <<"0">> ->
-            erlang:binary_to_list(erlang:iolist_to_binary(Vsn));
-        _ ->
-            erlang:binary_to_list(erlang:iolist_to_binary([Vsn, "+build.",
-                                                           Count, RefTag]))
-    end.
-
-get_patch_count(RawRef) ->
-    Ref = re:replace(RawRef, "\\s", "", [global]),
-    Cmd = io_lib:format("git rev-list --count ~ts..HEAD",
-                         [Ref]),
-    case os:cmd(Cmd) of
-        "fatal: " ++ _ ->
-            0;
-        Count ->
-            Count
-    end.
-
--spec parse_tags(t()|string()) -> {string()|undefined, ec_semver:version_string()}.
-parse_tags({}) ->
-    parse_tags("");
-parse_tags(Pattern) ->
-    Cmd = io_lib:format("git describe --abbrev=0 --tags --match \"~ts*\"", [Pattern]),
-    Tag = os:cmd(Cmd),
-    case Tag of
-        "fatal: " ++ _ ->
-            {undefined, ""};
-        _ ->
-            Vsn  = string:slice(Tag, string:length(Pattern)),
-            Vsn1 = string:trim(string:trim(Vsn, leading, "v"), trailing, "\n"),
-            {Tag, Vsn1}
-    end.

src/ec_lists.erl

@@ -1,4 +1,3 @@
-%%% vi:ts=4 sw=4 et
 %%%-------------------------------------------------------------------
 %%% @copyright (C) 2011, Erlware LLC
 %%% @doc
@@ -24,7 +23,7 @@
 %% the third value is the element passed to the function. The purpose
 %% of this is to allow a list to be searched where some internal state
 %% is important while the input element is not.
--spec search(fun(), list()) -> {ok, Result::term(), Element::term()} | not_found.
+-spec search(fun(), list()) -> {ok, Result::term(), Element::term()}.
 search(Fun, [H|T]) ->
     case Fun(H) of
         {ok, Value} ->
@@ -52,7 +51,7 @@ find(_Fun, []) ->
     error.
 
 %% @doc Fetch a value from the list. If the function returns true the
-%% value is returned. If processing reaches the end of the list and
+%% value is returend. If processing reaches the end of the list and
 %% the function has never returned true an exception not_found is
 %% thrown.
 -spec fetch(fun(), list()) -> term().
@@ -63,3 +62,184 @@ fetch(Fun, List) when is_list(List), is_function(Fun) ->
         error ->
             throw(not_found)
     end.
+
+%%%===================================================================
+%%% Test Functions
+%%%===================================================================
+
+-ifndef(NOTEST).
+-include_lib("eunit/include/eunit.hrl").
+
+find1_test() ->
+    TestData = [1, 2, 3, 4, 5, 6],
+    Result = find(fun(5) ->
+                          true;
+                     (_) ->
+                          false
+                  end,
+                  TestData),
+    ?assertMatch({ok, 5}, Result),
+
+    Result2 = find(fun(37) ->
+                           true;
+                      (_) ->
+                           false
+                   end,
+                   TestData),
+    ?assertMatch(error, Result2).
+
+find2_test() ->
+    TestData = ["one", "two", "three", "four", "five", "six"],
+    Result = find(fun("five") ->
+                          true;
+                     (_) ->
+                          false
+                  end,
+                  TestData),
+    ?assertMatch({ok, "five"}, Result),
+
+    Result2 = find(fun(super_duper) ->
+                           true;
+                      (_) ->
+                           false
+                   end,
+                   TestData),
+    ?assertMatch(error, Result2).
+
+
+
+find3_test() ->
+    TestData = [{"one", 1}, {"two", 2}, {"three", 3}, {"four", 5}, {"five", 5},
+                {"six", 6}],
+    Result = find(fun({"one", 1}) ->
+                          true;
+                     (_) ->
+                          false
+                  end,
+                  TestData),
+    ?assertMatch({ok, {"one", 1}}, Result),
+
+    Result2 = find(fun([fo, bar, baz]) ->
+                           true;
+                      ({"onehundred", 100}) ->
+                           true;
+                      (_) ->
+                           false
+                   end,
+                   TestData),
+    ?assertMatch(error, Result2).
+
+
+
+fetch1_test() ->
+    TestData = [1, 2, 3, 4, 5, 6],
+    Result = fetch(fun(5) ->
+                           true;
+                      (_) ->
+                           false
+                   end,
+                   TestData),
+    ?assertMatch(5, Result),
+
+    ?assertThrow(not_found,
+                 fetch(fun(37) ->
+                               true;
+                          (_) ->
+                               false
+                       end,
+                       TestData)).
+
+fetch2_test() ->
+    TestData = ["one", "two", "three", "four", "five", "six"],
+    Result = fetch(fun("five") ->
+                           true;
+                      (_) ->
+                           false
+                   end,
+                   TestData),
+    ?assertMatch("five", Result),
+
+    ?assertThrow(not_found,
+                 fetch(fun(super_duper) ->
+                               true;
+                          (_) ->
+                               false
+                       end,
+                       TestData)).
+
+fetch3_test() ->
+    TestData = [{"one", 1}, {"two", 2}, {"three", 3}, {"four", 5}, {"five", 5},
+                {"six", 6}],
+    Result = fetch(fun({"one", 1}) ->
+                           true;
+                      (_) ->
+                           false
+                   end,
+                   TestData),
+    ?assertMatch({"one", 1}, Result),
+
+    ?assertThrow(not_found,
+                 fetch(fun([fo, bar, baz]) ->
+                               true;
+                          ({"onehundred", 100}) ->
+                               true;
+                          (_) ->
+                               false
+                       end,
+                       TestData)).
+
+search1_test() ->
+    TestData = [1, 2, 3, 4, 5, 6],
+    Result = search(fun(5) ->
+                            {ok, 5};
+                       (_) ->
+                            not_found
+                    end,
+                    TestData),
+    ?assertMatch({ok, 5, 5}, Result),
+
+    Result2 = search(fun(37) ->
+                             {ok, 37};
+                        (_) ->
+                             not_found
+                     end,
+                     TestData),
+    ?assertMatch(not_found, Result2).
+
+search2_test() ->
+    TestData = [1, 2, 3, 4, 5, 6],
+    Result = search(fun(1) ->
+                            {ok, 10};
+                       (_) ->
+                            not_found
+                    end,
+                    TestData),
+    ?assertMatch({ok, 10, 1}, Result),
+
+    Result2 = search(fun(6) ->
+                             {ok, 37};
+                        (_) ->
+                             not_found
+                     end,
+                     TestData),
+    ?assertMatch({ok, 37, 6}, Result2).
+
+search3_test() ->
+    TestData = [1, 2, 3, 4, 5, 6],
+    Result = search(fun(10) ->
+                            {ok, 10};
+                       (_) ->
+                            not_found
+                    end,
+                    TestData),
+    ?assertMatch(not_found, Result),
+
+    Result2 = search(fun(-1) ->
+                             {ok, 37};
+                        (_) ->
+                             not_found
+                     end,
+                     TestData),
+    ?assertMatch(not_found, Result2).
+
+-endif.

src/ec_orddict.erl

@@ -1,4 +1,3 @@
-%%% vi:ts=4 sw=4 et
 %%%-------------------------------------------------------------------
 %%% @author Eric Merritt <ericbmerritt@gmail.com>
 %%% @copyright 2011 Erlware, LLC.
@@ -6,9 +5,9 @@
 %%%  This provides an implementation of the ec_dictionary type using
 %%%  erlang orddicts as a base. The function documentation for
 %%%  ec_dictionary applies here as well.
-%%% see ec_dictionary
-%%% see orddict
 %%% @end
+%%% @see ec_dictionary
+%%% @see orddict
 %%%-------------------------------------------------------------------
 -module(ec_orddict).
 
@@ -32,9 +31,7 @@
 %%%===================================================================
 %%% Types
 %%%===================================================================
-%% This should be opaque, but that kills dialyzer so for now we export it
+-opaque dictionary(K, V) :: [{K, V}].
-%% however you should not rely on the internal representation here
--type dictionary(K, V) :: [{K, V}].
 
 %%%===================================================================
 %%% API
@@ -91,7 +88,7 @@ has_value(Value, Data) ->
 	      false,
 	      Data).
 
--spec size(Object::dictionary(_K, _V)) -> non_neg_integer().
+-spec size(Object::dictionary(_K, _V)) -> integer().
 size(Data) ->
     orddict:size(Data).
 

src/ec_rbdict.erl

@@ -1,4 +1,3 @@
-%%% vi:ts=4 sw=4 et
 %%% Copyright (c) 2008 Robert Virding. All rights reserved.
 %%%
 %%% Redistribution and use in source and binary forms, with or without
@@ -32,7 +31,7 @@
 %%% representation of a dictionary, where a red-black tree is used to
 %%% store the keys and values.
 %%%
-%%% This module implements exactly the same interface as the module
+%%% This module implents exactly the same interface as the module
 %%% ec_dictionary but with a defined representation. One difference is
 %%% that while dict considers two keys as different if they do not
 %%% match (=:=), this module considers two keys as different if and
@@ -52,8 +51,8 @@
 %%% l/rbalance, the colour, in store etc. is actually slower than not
 %%% doing it. Measured.
 %%%
-%%% see ec_dictionary
 %%% @end
+%%% @see ec_dictionary
 %%%-------------------------------------------------------------------
 -module(ec_rbdict).
 
@@ -69,9 +68,8 @@
 %%%===================================================================
 %%% Types
 %%%===================================================================
-%% This should be opaque, but that kills dialyzer so for now we export it
+
-%% however you should not rely on the internal representation here
+-opaque dictionary(K, V) :: empty | {color(),
--type dictionary(K, V) :: empty | {color(),
 				     dictionary(K, V),
 				     ec_dictionary:key(K),
 				     ec_dictionary:value(V),
@@ -118,7 +116,7 @@ get(K, Default, {_, _, K1, _, Right}) when K > K1 ->
 get(_, _, {_, _, _, Val, _}) ->
     Val.
 
--spec add(ec_dictionary:key(K), ec_dictionary:value(V),
+-spec add(ec_dicitonary:key(K), ec_dictionary:value(V),
 	  dictionary(K, V)) -> dictionary(K, V).
 add(Key, Value, Dict) ->
     {_, L, K1, V1, R} = add1(Key, Value, Dict),
@@ -135,7 +133,7 @@ has_value(Value, Dict) ->
 	 end,
 	 false, Dict).
 
--spec size(dictionary(_K, _V)) -> non_neg_integer().
+-spec size(dictionary(_K, _V)) -> integer().
 size(T) ->
     size1(T).
 
@@ -229,7 +227,7 @@ erase_aux(K, {r, A, Xk, Xv, B}) ->
     end.
 
 -spec erase_min(dictionary(K, V)) ->
-                       {dictionary(K, V), {ec_dictionary:key(K), ec_dictionary:value(V)}, boolean()}.
+    {dictionary(K, V), {ec_dictionary:key(K), ec_dictionary:value(V)}, boolean}.
 erase_min({b, empty, Xk, Xv, empty}) ->
     {empty, {Xk, Xv}, true};
 erase_min({b, empty, Xk, Xv, {r, A, Yk, Yv, B}}) ->
@@ -276,8 +274,7 @@ unbalright(b, A, Xk, Xv,
       D},
      false}.
 
--spec fold(fun((ec_dictionary:key(K), ec_dictionary:value(V), any()) -> any()),
+-spec fold(fun(), dictionary(K, V), dictionary(K, V)) -> dictionary(K, V).
-           any(), dictionary(K, V)) -> any().
 fold(_, Acc, empty) -> Acc;
 fold(F, Acc, {_, A, Xk, Xv, B}) ->
     fold(F, F(Xk, Xv, fold(F, Acc, B)), A).
@@ -296,9 +293,9 @@ to_list(empty, List) -> List;
 to_list({_, A, Xk, Xv, B}, List) ->
     to_list(A, [{Xk, Xv} | to_list(B, List)]).
 
-%% Balance a tree after (possibly) adding a node to the left/right.
+%% Balance a tree afer (possibly) adding a node to the left/right.
 -spec lbalance(color(), dictionary(K, V),
-               ec_dictionary:key(K), ec_dictionary:value(V),
+	       ec_dictinary:key(K), ec_dictionary:value(V),
 	       dictionary(K, V)) ->
    dictionary(K, V).
 lbalance(b, {r, {r, A, Xk, Xv, B}, Yk, Yv, C}, Zk, Zv,
@@ -310,7 +307,7 @@ lbalance(b, {r, A, Xk, Xv, {r, B, Yk, Yv, C}}, Zk, Zv,
 lbalance(C, A, Xk, Xv, B) -> {C, A, Xk, Xv, B}.
 
 -spec rbalance(color(), dictionary(K, V),
-               ec_dictionary:key(K), ec_dictionary:value(V),
+	       ec_dictinary:key(K), ec_dictionary:value(V),
 	       dictionary(K, V)) ->
     dictionary(K, V).
 rbalance(b, A, Xk, Xv,

src/ec_semver.erl

@@ -1,4 +1,3 @@
-%%% vi:ts=4 sw=4 et
 %%%-------------------------------------------------------------------
 %%% @copyright (C) 2011, Erlware LLC
 %%% @doc
@@ -8,304 +7,113 @@
 %%%-------------------------------------------------------------------
 -module(ec_semver).
 
--export([parse/1,
+-exports([
-         format/1,
+          compare/2
-         eql/2,
+         ]).
-         gt/2,
-         gte/2,
-         lt/2,
-         lte/2,
-         pes/2,
-         between/3]).
 
-%% For internal use by the ec_semver_parser peg
+-export_type([
--export([internal_parse_version/1]).
+              semvar/0
-
+             ]).
--export_type([semver/0,
-              version_string/0,
-              any_version/0]).
 
 %%%===================================================================
 %%% Public Types
 %%%===================================================================
 
--type version_element() :: non_neg_integer() | binary().
+-type semvar() :: string().
-
+-type parsed_semvar() :: {MajorVsn::string(),
--type major_minor_patch_minpatch() ::
+                          MinorVsn::string(),
-        version_element()
+                          PatchVsn::string(),
-      | {version_element(), version_element()}
+                          PathString::string()}.
-      | {version_element(), version_element(), version_element()}
-      | {version_element(), version_element(),
-         version_element(), version_element()}.
-
--type alpha_part() :: integer() | binary() | string().
--type alpha_info() :: {PreRelease::[alpha_part()],
-                       BuildVersion::[alpha_part()]}.
-
--type semver() :: {major_minor_patch_minpatch(), alpha_info()}.
-
--type version_string() :: string() | binary().
-
--type any_version() :: version_string() | semver().
 
 %%%===================================================================
 %%% API
 %%%===================================================================
 
-%% @doc parse a string or binary into a valid semver representation
+%% @doc Is semver version string A bigger than version string B?
--spec parse(any_version()) -> semver().
+%% <pre>
-parse(Version) when erlang:is_list(Version) ->
+%% Example: compare("3.2.5alpha", "3.10.6") returns: false
-    case ec_semver_parser:parse(Version) of
+%% </pre>
-        {fail, _} ->
+-spec compare(VsnA::string(), VsnB::string()) -> boolean().
-            {erlang:iolist_to_binary(Version), {[],[]}};
+compare(VsnA, VsnB) ->
-        Good ->
+    compare_toks(tokens(VsnA),tokens(VsnB)).
-            Good
-    end;
-parse(Version) when erlang:is_binary(Version) ->
-    case ec_semver_parser:parse(Version) of
-        {fail, _} ->
-            {Version, {[],[]}};
-        Good ->
-            Good
-    end;
-parse(Version) ->
-    Version.
-
--spec format(semver()) -> iolist().
-format({Maj, {AlphaPart, BuildPart}})
-  when erlang:is_integer(Maj);
-       erlang:is_binary(Maj) ->
-    [format_version_part(Maj),
-     format_vsn_rest(<<"-">>, AlphaPart),
-     format_vsn_rest(<<"+">>, BuildPart)];
-format({{Maj, Min}, {AlphaPart, BuildPart}}) ->
-    [format_version_part(Maj), ".",
-     format_version_part(Min),
-     format_vsn_rest(<<"-">>, AlphaPart),
-     format_vsn_rest(<<"+">>, BuildPart)];
-format({{Maj, Min, Patch}, {AlphaPart, BuildPart}}) ->
-    [format_version_part(Maj), ".",
-     format_version_part(Min), ".",
-     format_version_part(Patch),
-     format_vsn_rest(<<"-">>, AlphaPart),
-     format_vsn_rest(<<"+">>, BuildPart)];
-format({{Maj, Min, Patch, MinPatch}, {AlphaPart, BuildPart}}) ->
-    [format_version_part(Maj), ".",
-     format_version_part(Min), ".",
-     format_version_part(Patch), ".",
-     format_version_part(MinPatch),
-     format_vsn_rest(<<"-">>, AlphaPart),
-     format_vsn_rest(<<"+">>, BuildPart)].
-
--spec format_version_part(integer() | binary()) -> iolist().
-format_version_part(Vsn)
-  when erlang:is_integer(Vsn) ->
-    erlang:integer_to_list(Vsn);
-format_version_part(Vsn)
-  when erlang:is_binary(Vsn) ->
-    Vsn.
-
-
-
-%% @doc test for quality between semver versions
--spec eql(any_version(), any_version()) -> boolean().
-eql(VsnA, VsnB) ->
-    NVsnA = normalize(parse(VsnA)),
-    NVsnB = normalize(parse(VsnB)),
-    NVsnA =:= NVsnB.
-
-%% @doc Test that VsnA is greater than VsnB
--spec gt(any_version(), any_version()) -> boolean().
-gt(VsnA, VsnB) ->
-    {MMPA, {AlphaA, PatchA}} = normalize(parse(VsnA)),
-    {MMPB, {AlphaB, PatchB}} = normalize(parse(VsnB)),
-    ((MMPA > MMPB)
-     orelse
-       ((MMPA =:= MMPB)
-        andalso
-          ((AlphaA =:= [] andalso AlphaB =/= [])
-           orelse
-             ((not (AlphaB =:= [] andalso AlphaA =/= []))
-              andalso
-                (AlphaA > AlphaB))))
-     orelse
-       ((MMPA =:= MMPB)
-        andalso
-          (AlphaA =:= AlphaB)
-        andalso
-          ((PatchB =:= [] andalso PatchA =/= [])
-           orelse
-           PatchA > PatchB))).
-
-%% @doc Test that VsnA is greater than or equal to VsnB
--spec gte(any_version(), any_version()) -> boolean().
-gte(VsnA, VsnB) ->
-    NVsnA = normalize(parse(VsnA)),
-    NVsnB = normalize(parse(VsnB)),
-    gt(NVsnA, NVsnB) orelse eql(NVsnA, NVsnB).
-
-%% @doc Test that VsnA is less than VsnB
--spec lt(any_version(), any_version()) -> boolean().
-lt(VsnA, VsnB) ->
-    {MMPA, {AlphaA, PatchA}} = normalize(parse(VsnA)),
-    {MMPB, {AlphaB, PatchB}} = normalize(parse(VsnB)),
-    ((MMPA < MMPB)
-     orelse
-       ((MMPA =:= MMPB)
-        andalso
-          ((AlphaB =:= [] andalso AlphaA =/= [])
-           orelse
-             ((not (AlphaA =:= [] andalso AlphaB =/= []))
-              andalso
-                (AlphaA < AlphaB))))
-     orelse
-       ((MMPA =:= MMPB)
-        andalso
-          (AlphaA =:= AlphaB)
-        andalso
-          ((PatchA =:= [] andalso PatchB =/= [])
-           orelse
-           PatchA < PatchB))).
-
-%% @doc Test that VsnA is less than or equal to VsnB
--spec lte(any_version(), any_version()) -> boolean().
-lte(VsnA, VsnB) ->
-    NVsnA = normalize(parse(VsnA)),
-    NVsnB = normalize(parse(VsnB)),
-    lt(NVsnA, NVsnB) orelse eql(NVsnA, NVsnB).
-
-%% @doc Test that VsnMatch is greater than or equal to Vsn1 and
-%% less than or equal to Vsn2
--spec between(any_version(), any_version(), any_version()) -> boolean().
-between(Vsn1, Vsn2, VsnMatch) ->
-    NVsnA = normalize(parse(Vsn1)),
-    NVsnB = normalize(parse(Vsn2)),
-    NVsnMatch = normalize(parse(VsnMatch)),
-    gte(NVsnMatch, NVsnA) andalso
-        lte(NVsnMatch, NVsnB).
-
-%% @doc check that VsnA is Approximately greater than VsnB
-%%
-%% Specifying ">= 2.6.5" is an optimistic version constraint. All
-%% versions greater than the one specified, including major releases
-%% (e.g. 3.0.0) are allowed.
-%%
-%% Conversely, specifying "~> 2.6" is pessimistic about future major
-%% revisions and "~> 2.6.5" is pessimistic about future minor
-%% revisions.
-%%
-%%  "~> 2.6" matches cookbooks >= 2.6.0 AND &lt; 3.0.0
-%% "~> 2.6.5" matches cookbooks >= 2.6.5 AND &lt; 2.7.0
-pes(VsnA, VsnB) ->
-    internal_pes(parse(VsnA), parse(VsnB)).
-
-%%%===================================================================
-%%% Friend Functions
-%%%===================================================================
-%% @doc helper function for the peg grammar to parse the iolist into a semver
--spec internal_parse_version(iolist()) -> semver().
-internal_parse_version([MMP, AlphaPart, BuildPart, _]) ->
-    {parse_major_minor_patch_minpatch(MMP), {parse_alpha_part(AlphaPart),
-                                             parse_alpha_part(BuildPart)}}.
-
-%% @doc helper function for the peg grammar to parse the iolist into a major_minor_patch
--spec parse_major_minor_patch_minpatch(iolist()) -> major_minor_patch_minpatch().
-parse_major_minor_patch_minpatch([MajVsn, [], [], []]) ->
-    strip_maj_version(MajVsn);
-parse_major_minor_patch_minpatch([MajVsn, [<<".">>, MinVsn], [], []]) ->
-    {strip_maj_version(MajVsn), MinVsn};
-parse_major_minor_patch_minpatch([MajVsn,
-                                  [<<".">>, MinVsn],
-                                  [<<".">>, PatchVsn], []]) ->
-    {strip_maj_version(MajVsn), MinVsn, PatchVsn};
-parse_major_minor_patch_minpatch([MajVsn,
-                                  [<<".">>, MinVsn],
-                                  [<<".">>, PatchVsn],
-                                  [<<".">>, MinPatch]]) ->
-    {strip_maj_version(MajVsn), MinVsn, PatchVsn, MinPatch}.
-
-%% @doc helper function for the peg grammar to parse the iolist into an alpha part
--spec parse_alpha_part(iolist()) -> [alpha_part()].
-parse_alpha_part([]) ->
-    [];
-parse_alpha_part([_, AV1, Rest]) ->
-    [erlang:iolist_to_binary(AV1) |
-     [format_alpha_part(Part) || Part <- Rest]].
-
-%% @doc according to semver alpha parts that can be treated like
-%% numbers must be. We implement that here by taking the alpha part
-%% and trying to convert it to a number, if it succeeds we use
-%% it. Otherwise we do not.
--spec format_alpha_part(iolist()) -> integer() | binary().
-format_alpha_part([<<".">>, AlphaPart]) ->
-    Bin = erlang:iolist_to_binary(AlphaPart),
-    try
-        erlang:list_to_integer(erlang:binary_to_list(Bin))
-    catch
-        error:badarg ->
-            Bin
-    end.
 
 %%%===================================================================
 %%% Internal Functions
 %%%===================================================================
--spec strip_maj_version(iolist()) -> version_element().
-strip_maj_version([<<"v">>, MajVsn]) ->
-    MajVsn;
-strip_maj_version([[], MajVsn]) ->
-    MajVsn;
-strip_maj_version(MajVsn) ->
-    MajVsn.
 
--spec to_list(integer() | binary() | string()) -> string() | binary().
+-spec tokens(semvar()) -> parsed_semvar().
-to_list(Detail) when erlang:is_integer(Detail) ->
+tokens(Vsn) ->
-    erlang:integer_to_list(Detail);
+    [MajorVsn, MinorVsn, RawPatch] = string:tokens(Vsn, "."),
-to_list(Detail) when erlang:is_list(Detail); erlang:is_binary(Detail) ->
+    {PatchVsn, PatchString} = split_patch(RawPatch),
-    Detail.
+    {MajorVsn, MinorVsn, PatchVsn, PatchString}.
 
--spec format_vsn_rest(binary() | string(), [integer() | binary()]) -> iolist().
+-spec split_patch(string()) ->
-format_vsn_rest(_TypeMark, []) ->
+                         {PatchVsn::string(), PatchStr::string()}.
-    [];
+split_patch(RawPatch) ->
-format_vsn_rest(TypeMark, [Head | Rest]) ->
+    {PatchVsn, PatchStr} = split_patch(RawPatch, {"", ""}),
-    [TypeMark, Head |
+    {lists:reverse(PatchVsn), PatchStr}.
-     [[".", to_list(Detail)] || Detail <- Rest]].
 
-%% @doc normalize the semver so they can be compared
+-spec split_patch(string(), {AccPatchVsn::string(), AccPatchStr::string()}) ->
--spec normalize(semver()) -> semver().
+                         {PatchVsn::string(), PatchStr::string()}.
-normalize({Vsn, Rest})
+split_patch([], Acc) ->
-  when erlang:is_binary(Vsn);
+    Acc;
-       erlang:is_integer(Vsn) ->
+split_patch([Dig|T], {PatchVsn, PatchStr}) when Dig >= $0 andalso Dig =< $9 ->
-    {{Vsn, 0, 0, 0}, Rest};
+    split_patch(T, {[Dig|PatchVsn], PatchStr});
-normalize({{Maj, Min}, Rest}) ->
+split_patch(PatchStr, {PatchVsn, ""}) ->
-    {{Maj, Min, 0, 0}, Rest};
+    {PatchVsn, PatchStr}.
-normalize({{Maj, Min, Patch}, Rest}) ->
-    {{Maj, Min, Patch, 0}, Rest};
-normalize(Other = {{_, _, _, _}, {_,_}}) ->
-    Other.
 
-%% @doc to do the pessimistic compare we need a parsed semver. This is
+-spec compare_toks(parsed_semvar(), parsed_semvar()) -> boolean().
-%% the internal implementation of the of the pessimistic run. The
+compare_toks({MajA, MinA, PVA, PSA}, {MajB, MinB, PVB, PSB}) ->
-%% external just ensures that versions are parsed.
+    compare_toks2({to_int(MajA), to_int(MinA), to_int(PVA), PSA},
--spec internal_pes(semver(), semver()) -> boolean().
+                  {to_int(MajB), to_int(MinB), to_int(PVB), PSB}).
-internal_pes(VsnA, {{LM, LMI}, Alpha})
+
-  when erlang:is_integer(LM),
+-spec compare_toks2(parsed_semvar(), parsed_semvar()) -> boolean().
-       erlang:is_integer(LMI) ->
+compare_toks2({MajA, _MinA, _PVA, _PSA}, {MajB, _MinB, _PVB, _PSB})
-    gte(VsnA, {{LM, LMI, 0}, Alpha}) andalso
+  when MajA > MajB ->
-        lt(VsnA, {{LM + 1, 0, 0, 0}, {[], []}});
+    true;
-internal_pes(VsnA, {{LM, LMI, LP}, Alpha})
+compare_toks2({_Maj, MinA, _PVA, _PSA}, {_Maj, MinB, _PVB, _PSB})
-    when erlang:is_integer(LM),
+  when MinA > MinB ->
-         erlang:is_integer(LMI),
+    true;
-         erlang:is_integer(LP) ->
+compare_toks2({_Maj, _Min, PVA, _PSA}, {_Maj, _Min, PVB, _PSB})
-    gte(VsnA, {{LM, LMI, LP}, Alpha})
+  when PVA > PVB ->
-        andalso
+    true;
-        lt(VsnA, {{LM, LMI + 1, 0, 0}, {[], []}});
+compare_toks2({_Maj, _Min, _PV, ""}, {_Maj, _Min, _PV, PSB}) when PSB /= ""->
-internal_pes(VsnA, {{LM, LMI, LP, LMP}, Alpha})
+    true;
-    when erlang:is_integer(LM),
+compare_toks2({_Maj, _Min, _PV, PSA}, {_Maj, _Min, _PV, ""}) when PSA /= ""->
-         erlang:is_integer(LMI),
+    false;
-         erlang:is_integer(LP),
+compare_toks2({_Maj, _Min, _PV, PSA}, {_Maj, _Min, _PV, PSB}) when PSA > PSB ->
-         erlang:is_integer(LMP) ->
+    true;
-    gte(VsnA, {{LM, LMI, LP, LMP}, Alpha})
+compare_toks2(_ToksA, _ToksB) ->
-        andalso
+    false.
-        lt(VsnA, {{LM, LMI, LP + 1, 0}, {[], []}});
+
-internal_pes(Vsn, LVsn) ->
+-spec to_int(string()) -> integer().
-    gte(Vsn, LVsn).
+to_int(String) ->
+    try
+        list_to_integer(String)
+    catch
+        error:badarg ->
+            throw(invalid_semver_string)
+    end.
+
+%%%===================================================================
+%%% Test Functions
+%%%===================================================================
+
+-ifndef(NOTEST).
+-include_lib("eunit/include/eunit.hrl").
+
+split_patch_test() ->
+    ?assertMatch({"123", "alpha1"}, split_patch("123alpha1")).
+
+compare_test() ->
+    ?assertMatch(true, compare("1.2.3", "1.2.3alpha")),
+    ?assertMatch(true, compare("1.2.3beta", "1.2.3alpha")),
+    ?assertMatch(true, compare("1.2.4", "1.2.3")),
+    ?assertMatch(true, compare("1.3.3", "1.2.3")),
+    ?assertMatch(true, compare("2.2.3", "1.2.3")),
+    ?assertMatch(true, compare("4.2.3", "3.10.3")),
+    ?assertMatch(false, compare("1.2.3", "2.2.3")),
+    ?assertThrow(invalid_semver_string, compare("1.b.2", "1.3.4")),
+    ?assertThrow(invalid_semver_string, compare("1.2.2", "1.3.t")).
+
+-endif.

src/ec_semver_parser.erl

@@ -1,302 +0,0 @@
--module(ec_semver_parser).
--export([parse/1,file/1]).
--define(p_anything,true).
--define(p_charclass,true).
--define(p_choose,true).
--define(p_not,true).
--define(p_one_or_more,true).
--define(p_optional,true).
--define(p_scan,true).
--define(p_seq,true).
--define(p_string,true).
--define(p_zero_or_more,true).
-
-
-
--spec file(file:name()) -> any().
-file(Filename) -> case file:read_file(Filename) of {ok,Bin} -> parse(Bin); Err -> Err end.
-
--spec parse(binary() | list()) -> any().
-parse(List) when is_list(List) -> parse(unicode:characters_to_binary(List));
-parse(Input) when is_binary(Input) ->
-  _ = setup_memo(),
-  Result = case 'semver'(Input,{{line,1},{column,1}}) of
-             {AST, <<>>, _Index} -> AST;
-             Any -> Any
-           end,
-  release_memo(), Result.
-
--spec 'semver'(input(), index()) -> parse_result().
-'semver'(Input, Index) ->
-  p(Input, Index, 'semver', fun(I,D) -> (p_seq([fun 'major_minor_patch_min_patch'/2, p_optional(p_seq([p_string(<<"-">>), fun 'alpha_part'/2, p_zero_or_more(p_seq([p_string(<<".">>), fun 'alpha_part'/2]))])), p_optional(p_seq([p_string(<<"+">>), fun 'alpha_part'/2, p_zero_or_more(p_seq([p_string(<<".">>), fun 'alpha_part'/2]))])), p_not(p_anything())]))(I,D) end, fun(Node, _Idx) -> ec_semver:internal_parse_version(Node)  end).
-
--spec 'major_minor_patch_min_patch'(input(), index()) -> parse_result().
-'major_minor_patch_min_patch'(Input, Index) ->
-  p(Input, Index, 'major_minor_patch_min_patch', fun(I,D) -> (p_seq([p_choose([p_seq([p_optional(p_string(<<"v">>)), fun 'numeric_part'/2]), fun 'alpha_part'/2]), p_optional(p_seq([p_string(<<".">>), fun 'version_part'/2])), p_optional(p_seq([p_string(<<".">>), fun 'version_part'/2])), p_optional(p_seq([p_string(<<".">>), fun 'version_part'/2]))]))(I,D) end, fun(Node, Idx) ->transform('major_minor_patch_min_patch', Node, Idx) end).
-
--spec 'version_part'(input(), index()) -> parse_result().
-'version_part'(Input, Index) ->
-  p(Input, Index, 'version_part', fun(I,D) -> (p_choose([fun 'numeric_part'/2, fun 'alpha_part'/2]))(I,D) end, fun(Node, Idx) ->transform('version_part', Node, Idx) end).
-
--spec 'numeric_part'(input(), index()) -> parse_result().
-'numeric_part'(Input, Index) ->
-  p(Input, Index, 'numeric_part', fun(I,D) -> (p_one_or_more(p_charclass(<<"[0-9]">>)))(I,D) end, fun(Node, _Idx) ->erlang:list_to_integer(erlang:binary_to_list(erlang:iolist_to_binary(Node))) end).
-
--spec 'alpha_part'(input(), index()) -> parse_result().
-'alpha_part'(Input, Index) ->
-  p(Input, Index, 'alpha_part', fun(I,D) -> (p_one_or_more(p_charclass(<<"[A-Za-z0-9-]">>)))(I,D) end, fun(Node, _Idx) ->erlang:iolist_to_binary(Node) end).
-
-
-transform(_,Node,_Index) -> Node.
--type index() :: {{line, pos_integer()}, {column, pos_integer()}}.
--type input() :: binary().
--type parse_failure() :: {fail, term()}.
--type parse_success() :: {term(), input(), index()}.
--type parse_result() :: parse_failure() | parse_success().
--type parse_fun() :: fun((input(), index()) -> parse_result()).
--type xform_fun() :: fun((input(), index()) -> term()).
-
--spec p(input(), index(), atom(), parse_fun(), xform_fun()) -> parse_result().
-p(Inp, StartIndex, Name, ParseFun, TransformFun) ->
-  case get_memo(StartIndex, Name) of      % See if the current reduction is memoized
-    {ok, Memo} -> %Memo;                     % If it is, return the stored result
-      Memo;
-    _ ->                                        % If not, attempt to parse
-      Result = case ParseFun(Inp, StartIndex) of
-        {fail,_} = Failure ->                       % If it fails, memoize the failure
-          Failure;
-        {Match, InpRem, NewIndex} ->               % If it passes, transform and memoize the result.
-          Transformed = TransformFun(Match, StartIndex),
-          {Transformed, InpRem, NewIndex}
-      end,
-      memoize(StartIndex, Name, Result),
-      Result
-  end.
-
--spec setup_memo() -> ets:tid().
-setup_memo() ->
-  put({parse_memo_table, ?MODULE}, ets:new(?MODULE, [set])).
-
--spec release_memo() -> true.
-release_memo() ->
-  ets:delete(memo_table_name()).
-
--spec memoize(index(), atom(), parse_result()) -> true.
-memoize(Index, Name, Result) ->
-  Memo = case ets:lookup(memo_table_name(), Index) of
-              [] -> [];
-              [{Index, Plist}] -> Plist
-         end,
-  ets:insert(memo_table_name(), {Index, [{Name, Result}|Memo]}).
-
--spec get_memo(index(), atom()) -> {ok, term()} | {error, not_found}.
-get_memo(Index, Name) ->
-  case ets:lookup(memo_table_name(), Index) of
-    [] -> {error, not_found};
-    [{Index, Plist}] ->
-      case proplists:lookup(Name, Plist) of
-        {Name, Result}  -> {ok, Result};
-        _  -> {error, not_found}
-      end
-    end.
-
--spec memo_table_name() -> ets:tid().
-memo_table_name() ->
-    get({parse_memo_table, ?MODULE}).
-
--ifdef(p_eof).
--spec p_eof() -> parse_fun().
-p_eof() ->
-  fun(<<>>, Index) -> {eof, [], Index};
-     (_, Index) -> {fail, {expected, eof, Index}} end.
--endif.
-
--ifdef(p_optional).
--spec p_optional(parse_fun()) -> parse_fun().
-p_optional(P) ->
-  fun(Input, Index) ->
-      case P(Input, Index) of
-        {fail,_} -> {[], Input, Index};
-        {_, _, _} = Success -> Success
-      end
-  end.
--endif.
-
--ifdef(p_not).
--spec p_not(parse_fun()) -> parse_fun().
-p_not(P) ->
-  fun(Input, Index)->
-      case P(Input,Index) of
-        {fail,_} ->
-          {[], Input, Index};
-        {Result, _, _} -> {fail, {expected, {no_match, Result},Index}}
-      end
-  end.
--endif.
-
--ifdef(p_assert).
--spec p_assert(parse_fun()) -> parse_fun().
-p_assert(P) ->
-  fun(Input,Index) ->
-      case P(Input,Index) of
-        {fail,_} = Failure-> Failure;
-        _ -> {[], Input, Index}
-      end
-  end.
--endif.
-
--ifdef(p_seq).
--spec p_seq([parse_fun()]) -> parse_fun().
-p_seq(P) ->
-  fun(Input, Index) ->
-      p_all(P, Input, Index, [])
-  end.
-
--spec p_all([parse_fun()], input(), index(), [term()]) -> parse_result().
-p_all([], Inp, Index, Accum ) -> {lists:reverse( Accum ), Inp, Index};
-p_all([P|Parsers], Inp, Index, Accum) ->
-  case P(Inp, Index) of
-    {fail, _} = Failure -> Failure;
-    {Result, InpRem, NewIndex} -> p_all(Parsers, InpRem, NewIndex, [Result|Accum])
-  end.
--endif.
-
--ifdef(p_choose).
--spec p_choose([parse_fun()]) -> parse_fun().
-p_choose(Parsers) ->
-  fun(Input, Index) ->
-      p_attempt(Parsers, Input, Index, none)
-  end.
-
--spec p_attempt([parse_fun()], input(), index(), none | parse_failure()) -> parse_result().
-p_attempt([], _Input, _Index, Failure) -> Failure;
-p_attempt([P|Parsers], Input, Index, FirstFailure)->
-  case P(Input, Index) of
-    {fail, _} = Failure ->
-      case FirstFailure of
-        none -> p_attempt(Parsers, Input, Index, Failure);
-        _ -> p_attempt(Parsers, Input, Index, FirstFailure)
-      end;
-    Result -> Result
-  end.
--endif.
-
--ifdef(p_zero_or_more).
--spec p_zero_or_more(parse_fun()) -> parse_fun().
-p_zero_or_more(P) ->
-  fun(Input, Index) ->
-      p_scan(P, Input, Index, [])
-  end.
--endif.
-
--ifdef(p_one_or_more).
--spec p_one_or_more(parse_fun()) -> parse_fun().
-p_one_or_more(P) ->
-  fun(Input, Index)->
-      Result = p_scan(P, Input, Index, []),
-      case Result of
-        {[_|_], _, _} ->
-          Result;
-        _ ->
-          {fail, {expected, Failure, _}} = P(Input,Index),
-          {fail, {expected, {at_least_one, Failure}, Index}}
-      end
-  end.
--endif.
-
--ifdef(p_label).
--spec p_label(atom(), parse_fun()) -> parse_fun().
-p_label(Tag, P) ->
-  fun(Input, Index) ->
-      case P(Input, Index) of
-        {fail,_} = Failure ->
-           Failure;
-        {Result, InpRem, NewIndex} ->
-          {{Tag, Result}, InpRem, NewIndex}
-      end
-  end.
--endif.
-
--ifdef(p_scan).
--spec p_scan(parse_fun(), input(), index(), [term()]) -> {[term()], input(), index()}.
-p_scan(_, <<>>, Index, Accum) -> {lists:reverse(Accum), <<>>, Index};
-p_scan(P, Inp, Index, Accum) ->
-  case P(Inp, Index) of
-    {fail,_} -> {lists:reverse(Accum), Inp, Index};
-    {Result, InpRem, NewIndex} -> p_scan(P, InpRem, NewIndex, [Result | Accum])
-  end.
--endif.
-
--ifdef(p_string).
--spec p_string(binary()) -> parse_fun().
-p_string(S) ->
-    Length = erlang:byte_size(S),
-    fun(Input, Index) ->
-      try
-          <<S:Length/binary, Rest/binary>> = Input,
-          {S, Rest, p_advance_index(S, Index)}
-      catch
-          error:{badmatch,_} -> {fail, {expected, {string, S}, Index}}
-      end
-    end.
--endif.
-
--ifdef(p_anything).
--spec p_anything() -> parse_fun().
-p_anything() ->
-  fun(<<>>, Index) -> {fail, {expected, any_character, Index}};
-     (Input, Index) when is_binary(Input) ->
-          <<C/utf8, Rest/binary>> = Input,
-          {<<C/utf8>>, Rest, p_advance_index(<<C/utf8>>, Index)}
-  end.
--endif.
-
--ifdef(p_charclass).
--spec p_charclass(string() | binary()) -> parse_fun().
-p_charclass(Class) ->
-    {ok, RE} = re:compile(Class, [unicode, dotall]),
-    fun(Inp, Index) ->
-            case re:run(Inp, RE, [anchored]) of
-                {match, [{0, Length}|_]} ->
-                    {Head, Tail} = erlang:split_binary(Inp, Length),
-                    {Head, Tail, p_advance_index(Head, Index)};
-                _ -> {fail, {expected, {character_class, binary_to_list(Class)}, Index}}
-            end
-    end.
--endif.
-
--ifdef(p_regexp).
--spec p_regexp(binary()) -> parse_fun().
-p_regexp(Regexp) ->
-    {ok, RE} = re:compile(Regexp, [unicode, dotall, anchored]),
-    fun(Inp, Index) ->
-        case re:run(Inp, RE) of
-            {match, [{0, Length}|_]} ->
-                {Head, Tail} = erlang:split_binary(Inp, Length),
-                {Head, Tail, p_advance_index(Head, Index)};
-            _ -> {fail, {expected, {regexp, binary_to_list(Regexp)}, Index}}
-        end
-    end.
--endif.
-
--ifdef(line).
--spec line(index() | term()) -> pos_integer() | undefined.
-line({{line,L},_}) -> L;
-line(_) -> undefined.
--endif.
-
--ifdef(column).
--spec column(index() | term()) -> pos_integer() | undefined.
-column({_,{column,C}}) -> C;
-column(_) -> undefined.
--endif.
-
--spec p_advance_index(input() | unicode:charlist() | pos_integer(), index()) -> index().
-p_advance_index(MatchedInput, Index) when is_list(MatchedInput) orelse is_binary(MatchedInput)-> % strings
-  lists:foldl(fun p_advance_index/2, Index, unicode:characters_to_list(MatchedInput));
-p_advance_index(MatchedInput, Index) when is_integer(MatchedInput) -> % single characters
-  {{line, Line}, {column, Col}} = Index,
-  case MatchedInput of
-    $\n -> {{line, Line+1}, {column, 1}};
-    _ -> {{line, Line}, {column, Col+1}}
-  end.

src/ec_string.erl

@@ -0,0 +1,128 @@
+%%%-------------------------------------------------------------------
+%%% @copyright (C) 2011, Erlware LLC
+%%% @doc
+%%%  Helper functions for working with strings.
+%%% @end
+%%%-------------------------------------------------------------------
+-module(ec_string).
+
+-export([
+         compare_versions/2
+        ]).
+%%%===================================================================
+%%% API
+%%%===================================================================
+
+%% @doc Is arbitrary version string A bigger than version string B?
+%% Valid version string elements are either separated by . or - or both.
+%% Final version string elements may have a numeric followed directly by an
+%% alpha numeric and will be compared separately as in 12alpha.
+%%
+%% <pre>
+%% Example: compare_versions("3-2-5-alpha", "3.10.6") will return false
+%%          compare_versions("3-2-alpha", "3.2.1-alpha") will return false
+%%          compare_versions("3-2alpha", "3.2.1-alpha") will return false
+%%          compare_versions("3.2.2", "3.2.2") will return false
+%%          compare_versions("3.2.1", "3.2.1-rc2") will return true
+%%          compare_versions("3.2.2", "3.2.1") will return true
+%% </pre>
+-spec compare_versions(VsnA::string(), VsnB::string()) -> boolean().
+compare_versions(VsnA, VsnB) ->
+    compare(string:tokens(VsnA, ".-"),string:tokens(VsnB, ".-")).
+
+%%%===================================================================
+%%% Internal Functions
+%%%===================================================================
+
+-spec compare(string(), string()) -> boolean().
+compare([Str|TA], [Str|TB]) ->
+    compare(TA, TB);
+compare([StrA|TA], [StrB|TB]) ->
+    fine_compare(split_numeric_alpha(StrA), TA,
+                 split_numeric_alpha(StrB), TB);
+compare([], [Str]) ->
+    not compare_against_nothing(Str);
+compare([Str], []) ->
+    compare_against_nothing(Str);
+compare([], [_,_|_]) ->
+    false;
+compare([_,_|_], []) ->
+    true;
+compare([], []) ->
+    false.
+
+-spec compare_against_nothing(string()) -> boolean().
+compare_against_nothing(Str) ->
+    case split_numeric_alpha(Str) of
+        {_StrDig, ""} -> true;
+        {"", _StrAlpha} -> false;
+        {_StrDig, _StrAlpha} -> true
+    end.
+
+-spec fine_compare({string(), string()}, string(),
+                   {string(), string()}, string()) ->
+                          boolean().
+fine_compare({_StrDigA, StrA}, TA, {_StrDigB, _StrB}, _TB)
+  when StrA /= "", TA /= [] ->
+    throw(invalid_version_string);
+fine_compare({_StrDigA, _StrA}, _TA, {_StrDigB, StrB}, TB)
+  when StrB /= "", TB /= [] ->
+    throw(invalid_version_string);
+fine_compare({"", _StrA}, _TA, {StrDigB, _StrB}, _TB) when StrDigB /= "" ->
+    false;
+fine_compare({StrDigA, _StrA}, _TA, {"", _StrB}, _TB) when StrDigA /= "" ->
+    true;
+fine_compare({StrDig, ""}, _TA, {StrDig, StrB}, _TB) when StrB /= "" ->
+    true;
+fine_compare({StrDig, StrA}, _TA, {StrDig, ""}, _TB) when StrA /= "" ->
+    false;
+fine_compare({StrDig, StrA}, _TA, {StrDig, StrB}, _TB) ->
+    StrA > StrB;
+fine_compare({StrDigA, _StrA}, _TA, {StrDigB, _StrB}, _TB) ->
+    list_to_integer(StrDigA) > list_to_integer(StrDigB).
+
+%% In the case of a version sub part with a numeric then an alpha,
+%% split out the numeric and alpha "24alpha" becomes {"24", "alpha"}
+-spec split_numeric_alpha(string()) ->
+                                 {PatchVsn::string(), PatchStr::string()}.
+split_numeric_alpha(RawVsn) ->
+    {Num, Str} = split_numeric_alpha(RawVsn, {"", ""}),
+    {lists:reverse(Num), Str}.
+
+-spec split_numeric_alpha(string(), {PatchVsnAcc::string(),
+                                     PatchStrAcc::string()}) ->
+                                 {PatchVsn::string(), PatchStr::string()}.
+split_numeric_alpha([], Acc) ->
+    Acc;
+split_numeric_alpha([Dig|T], {PatchVsn, PatchStr})
+  when Dig >= $0 andalso Dig =< $9 ->
+    split_numeric_alpha(T, {[Dig|PatchVsn], PatchStr});
+split_numeric_alpha(PatchStr, {PatchVsn, ""}) ->
+    {PatchVsn, PatchStr}.
+
+%%%===================================================================
+%%% Test Functions
+%%%===================================================================
+
+-ifndef(NOTEST).
+-include_lib("eunit/include/eunit.hrl").
+
+split_numeric_alpha_test() ->
+    ?assertMatch({"123", "alpha1"}, split_numeric_alpha("123alpha1")).
+
+compare_versions_test() ->
+    ?assertMatch(true, compare_versions("1.2.3", "1.2.3alpha")),
+    ?assertMatch(true, compare_versions("1.2.3-beta", "1.2.3-alpha")),
+    ?assertMatch(true, compare_versions("1-2-3", "1-2-3alpha")),
+    ?assertMatch(true, compare_versions("1-2-3", "1-2-3-rc3")),
+    ?assertMatch(true, compare_versions("1.2.3beta", "1.2.3alpha")),
+    ?assertMatch(true, compare_versions("1.2.4", "1.2.3")),
+    ?assertMatch(true, compare_versions("1.3.3", "1.2.3")),
+    ?assertMatch(true, compare_versions("2.2.3", "1.2.3")),
+    ?assertMatch(true, compare_versions("4.2.3", "3.10.3")),
+    ?assertMatch(false, compare_versions("1.2.3", "2.2.3")),
+    ?assertMatch(false, compare_versions("1.2.2", "1.3.t")),
+    ?assertMatch(false, compare_versions("1.2t", "1.3.t")),
+    ?assertThrow(invalid_version_string, compare_versions("1.b.2", "1.3.4")).
+
+-endif.

src/ec_talk.erl

@@ -1,5 +1,4 @@
 %% -*- mode: Erlang; fill-column: 79; comment-column: 70; -*-
-%% vi:ts=4 sw=4 et
 %%%---------------------------------------------------------------------------
 %%% Permission is hereby granted, free of charge, to any person
 %%% obtaining a copy of this software and associated documentation
@@ -39,21 +38,18 @@
          say/1,
          say/2]).
 
--ifdef(TEST).
--export([get_boolean/1,
-	 get_integer/1]).
--endif.
-
 -export_type([prompt/0,
               type/0,
               supported/0]).
 
+-include_lib("eunit/include/eunit.hrl").
+
 %%============================================================================
 %% Types
 %%============================================================================
 -type prompt() :: string().
 -type type() :: boolean | number | string.
--type supported() ::  boolean() | number() | string().
+-type supported() :: string() | boolean() | number().
 
 %%============================================================================
 %% API
@@ -80,7 +76,7 @@ ask(Prompt) ->
 ask_default(Prompt, Default) ->
     ask_convert(Prompt, fun get_string/1, string, Default).
 
-%% @doc Asks the user to respond to the prompt. Tries to return the
+%% @doc Asks the user to respond to the prompt. Trys to return the
 %% value in the format specified by 'Type'.
 -spec ask(prompt(), type()) ->  supported().
 ask(Prompt, boolean) ->
@@ -88,9 +84,9 @@ ask(Prompt, boolean) ->
 ask(Prompt, number) ->
     ask_convert(Prompt, fun get_integer/1, number,  none);
 ask(Prompt, string) ->
-    ask_convert(Prompt, fun get_string/1, string, none).
+    ask_convert(Prompt, fun get_integer/1, string, none).
 
-%% @doc Asks the user to respond to the prompt. Tries to return the
+%% @doc Asks the user to respond to the prompt. Trys to return the
 %% value in the format specified by 'Type'.
 -spec ask_default(prompt(), type(), supported()) ->  supported().
 ask_default(Prompt, boolean, Default)  ->
@@ -104,11 +100,8 @@ ask_default(Prompt, string, Default) ->
 %% between min and max.
 -spec ask(prompt(), number(), number()) -> number().
 ask(Prompt, Min, Max)
-  when erlang:is_list(Prompt),
+  when is_list(Prompt), is_number(Min), is_number(Max) ->
-       erlang:is_number(Min),
+    Res = ask(Prompt, fun get_integer/1, none),
-       erlang:is_number(Max),
-       Min =< Max ->
-    Res = ask_convert(Prompt, fun get_integer/1, number, none),
     case (Res >= Min andalso Res =< Max) of
         true ->
             Res;
@@ -122,17 +115,15 @@ ask(Prompt, Min, Max)
 %% ============================================================================
 %% @doc Actually does the work of asking, checking result and
 %% translating result into the requested format.
--spec ask_convert(prompt(), fun((any()) -> any()), type(), supported() | none) -> supported().
+-spec ask_convert(prompt(), fun(), type(), supported()) -> supported().
 ask_convert(Prompt, TransFun, Type,  Default) ->
-    NewPrompt =
+    NewPrompt = Prompt ++ case Default of
-        erlang:binary_to_list(erlang:iolist_to_binary([Prompt,
-                                                       case Default of
                               none ->
                                   [];
                               Default ->
-                                                               [" (", io_lib:format("~p", [Default]) , ")"]
+                                  " (" ++ sin_utils:term_to_list(Default) ++ ")"
-                                                       end, "> "])),
+                          end ++ "> ",
-    Data = string:trim(string:trim(io:get_line(NewPrompt)), both, [$\n]),
+    Data = string:strip(string:strip(io:get_line(NewPrompt)), both, $\n),
     Ret = TransFun(Data),
     case Ret of
         no_data ->
@@ -150,7 +141,7 @@ ask_convert(Prompt, TransFun, Type,  Default) ->
             Ret
     end.
 
-%% @doc Tries to translate the result into a boolean
+%% @doc Trys to translate the result into a boolean
 -spec get_boolean(string()) -> boolean().
 get_boolean([]) ->
     no_data;
@@ -177,7 +168,7 @@ get_boolean([$N | _]) ->
 get_boolean(_) ->
     no_clue.
 
-%% @doc Tries to translate the result into an integer
+%% @doc Trys to translate the result into an integer
 -spec get_integer(string()) -> integer().
 get_integer([]) ->
     no_data;
@@ -201,3 +192,21 @@ get_string(String) ->
         false ->
             no_clue
     end.
+
+%%%====================================================================
+%%% tests
+%%%====================================================================
+general_test_() ->
+    [?_test(42 == get_integer("42")),
+     ?_test(500211 == get_integer("500211")),
+     ?_test(1234567890 == get_integer("1234567890")),
+     ?_test(12345678901234567890 == get_integer("12345678901234567890")),
+     ?_test(true == get_boolean("true")),
+     ?_test(false == get_boolean("false")),
+     ?_test(true == get_boolean("Ok")),
+     ?_test(true == get_boolean("ok")),
+     ?_test(true == get_boolean("Y")),
+     ?_test(true == get_boolean("y")),
+     ?_test(false == get_boolean("False")),
+     ?_test(false == get_boolean("No")),
+     ?_test(false == get_boolean("no"))].

src/ec_vsn.erl

@@ -1,51 +0,0 @@
-%%% vi:ts=4 sw=4 et
-%%%-------------------------------------------------------------------
-%%% @author Eric Merritt <ericbmerritt@gmail.com>
-%%% @copyright 2014 Erlware, LLC.
-%%% @doc
-%%%  Provides a signature to manage returning semver formatted versions
-%%%  from various version control repositories.
-%%%
-%%%  This interface is a member of the Erlware Commons Library.
-%%% @end
-%%%-------------------------------------------------------------------
--module(ec_vsn).
-
-%% API
--export([new/1,
-         vsn/1]).
-
--export_type([t/0]).
-
-%%%===================================================================
-%%% Types
-%%%===================================================================
-
--record(t, {callback, data}).
-
-%% This should be opaque, but that kills dialyzer so for now we export it
-%% however you should not rely on the internal representation here
--type t() :: #t{}.
-
--callback new() -> any().
--callback vsn(any()) -> {ok, string()} | {error, Reason::any()}.
-
-%%%===================================================================
-%%% API
-%%%===================================================================
-
-%% @doc create a new dictionary object from the specified module. The
-%% module should implement the dictionary behaviour.
-%%
-%% @param ModuleName The module name.
--spec new(module()) -> t().
-new(ModuleName) when erlang:is_atom(ModuleName) ->
-    #t{callback = ModuleName, data = ModuleName:new()}.
-
-%% @doc Return the semver or an error depending on what is possible
-%% with this implementation in this directory.
-%%
-%% @param The dictionary object
--spec vsn(t()) ->  {ok, string()} | {error, Reason::any()}.
-vsn(#t{callback = Mod, data = Data}) ->
-    Mod:vsn(Data).

src/erlware_commons.app.src

@@ -1,11 +0,0 @@
-{application,erlware_commons,
-             [{description,"Additional standard library for Erlang"},
-              {vsn,"git"},
-              {modules,[]},
-              {registered,[]},
-              {applications,[kernel,stdlib,cf]},
-              {maintainers,["Eric Merritt","Tristan Sloughter",
-                            "Jordan Wilberding","Martin Logan"]},
-              {licenses,["Apache", "MIT"]},
-              {links,[{"Github",
-                       "https://github.com/erlware/erlware_commons"}]}]}.

test/ec_cmd_log_tests.erl

@@ -1,39 +0,0 @@
-%%% @copyright 2024 Erlware, LLC.
--module(ec_cmd_log_tests).
-
--include("include/ec_cmd_log.hrl").
--include("src/ec_cmd_log.hrl").
--include_lib("eunit/include/eunit.hrl").
-
-should_test() ->
-    ErrorLogState = ec_cmd_log:new(error),
-    ?assertMatch(true, ec_cmd_log:should(ErrorLogState, ?EC_ERROR)),
-    ?assertMatch(true, not ec_cmd_log:should(ErrorLogState, ?EC_INFO)),
-    ?assertMatch(true, not ec_cmd_log:should(ErrorLogState, ?EC_DEBUG)),
-    ?assertEqual(?EC_ERROR, ec_cmd_log:log_level(ErrorLogState)),
-    ?assertEqual(error, ec_cmd_log:atom_log_level(ErrorLogState)),
-
-    InfoLogState = ec_cmd_log:new(info),
-    ?assertMatch(true, ec_cmd_log:should(InfoLogState, ?EC_ERROR)),
-    ?assertMatch(true, ec_cmd_log:should(InfoLogState, ?EC_INFO)),
-    ?assertMatch(true, not ec_cmd_log:should(InfoLogState, ?EC_DEBUG)),
-    ?assertEqual(?EC_INFO, ec_cmd_log:log_level(InfoLogState)),
-    ?assertEqual(info, ec_cmd_log:atom_log_level(InfoLogState)),
-
-    DebugLogState = ec_cmd_log:new(debug),
-    ?assertMatch(true, ec_cmd_log:should(DebugLogState, ?EC_ERROR)),
-    ?assertMatch(true, ec_cmd_log:should(DebugLogState, ?EC_INFO)),
-    ?assertMatch(true, ec_cmd_log:should(DebugLogState, ?EC_DEBUG)),
-    ?assertEqual(?EC_DEBUG, ec_cmd_log:log_level(DebugLogState)),
-    ?assertEqual(debug, ec_cmd_log:atom_log_level(DebugLogState)).
-
-
-no_color_test() ->
-    LogState = ec_cmd_log:new(debug, command_line, none),
-    ?assertEqual("test",
-                 ec_cmd_log:colorize(LogState, ?RED, true, "test")).
-
-color_test() ->
-    LogState = ec_cmd_log:new(debug, command_line, high),
-    ?assertEqual("\e[1;31m===> test\e[0m",
-                 ec_cmd_log:colorize(LogState, ?RED, true, "test")).

test/ec_cnv_tests.erl

@@ -1,28 +0,0 @@
-%%% @copyright 2024 Erlware, LLC.
--module(ec_cnv_tests).
-
--include_lib("eunit/include/eunit.hrl").
-
-to_integer_test() ->
-    ?assertError(badarg, ec_cnv:to_integer(1.5, strict)).
-
-to_float_test() ->
-    ?assertError(badarg, ec_cnv:to_float(10, strict)).
-
-to_atom_test() ->
-    ?assertMatch(true, ec_cnv:to_atom("true")),
-    ?assertMatch(true, ec_cnv:to_atom(<<"true">>)),
-    ?assertMatch(false, ec_cnv:to_atom(<<"false">>)),
-    ?assertMatch(false, ec_cnv:to_atom(false)),
-    ?assertError(badarg, ec_cnv:to_atom("hello_foo_bar_baz")),
-
-    S = erlang:list_to_atom("1"),
-    ?assertMatch(S, ec_cnv:to_atom(1)).
-
-to_boolean_test()->
-    ?assertMatch(true, ec_cnv:to_boolean(<<"true">>)),
-    ?assertMatch(true, ec_cnv:to_boolean("true")),
-    ?assertMatch(true, ec_cnv:to_boolean(true)),
-    ?assertMatch(false, ec_cnv:to_boolean(<<"false">>)),
-    ?assertMatch(false, ec_cnv:to_boolean("false")),
-    ?assertMatch(false, ec_cnv:to_boolean(false)).

test/ec_dictionary_proper.erl

@@ -0,0 +1,223 @@
+%% compile with
+%% erl -pz ebin --make
+%% start test with
+%%   erl -pz ebin -pz test
+%%   proper:module(ec_dictionary_proper).
+-module(ec_dictionary_proper).
+
+-export([my_dict/0, dict/1, sym_dict/0, sym_dict/1, gb_tree/0, gb_tree/1, sym_dict2/0]).
+
+-include_lib("proper/include/proper.hrl").
+
+
+%%------------------------------------------------------------------------------
+%% Properties
+%%------------------------------------------------------------------------------
+
+prop_size_increases_with_new_key() ->
+    ?FORALL({Dict,K}, {sym_dict(),integer()},
+            begin
+                Size = ec_dictionary:size(Dict),
+                case ec_dictionary:has_key(K,Dict) of
+                    true ->
+                        Size == ec_dictionary:size(ec_dictionary:add(K,0,Dict));
+                    false ->
+                        (Size + 1) == ec_dictionary:size(ec_dictionary:add(K,0,Dict))
+                end
+            end).
+
+prop_size_decrease_when_removing() ->
+    ?FORALL({Dict,K}, {sym_dict(),integer()},
+            begin
+                Size = ec_dictionary:size(Dict),
+                case ec_dictionary:has_key(K,Dict) of
+                    false ->
+                        Size == ec_dictionary:size(ec_dictionary:remove(K,Dict));
+                    true ->
+                        (Size - 1) == ec_dictionary:size(ec_dictionary:remove(K,Dict))
+                end
+            end).
+
+prop_get_after_add_returns_correct_value() ->
+    ?FORALL({Dict,K,V}, {sym_dict(),key(),value()},
+            begin
+                try ec_dictionary:get(K,ec_dictionary:add(K,V,Dict)) of
+                    V ->
+                        true;
+                    _ ->
+                        false
+                catch
+                    _:_ ->
+                        false
+                end
+            end).
+
+prop_get_default_returns_correct_value() ->
+    ?FORALL({Dict,K1,K2,V,Default},
+            {sym_dict(),key(),key(),value(),value()},
+            begin
+                NewDict = ec_dictionary:add(K1,V, Dict),
+                %% In the unlikely event that keys that are the same
+                %% are generated
+                case ec_dictionary:has_key(K2, NewDict) of
+                    true ->
+                        true;
+                    false ->
+                        ec_dictionary:get(K2, Default, NewDict) == Default
+                end
+            end).
+
+
+prop_add_does_not_change_values_for_other_keys() ->
+    ?FORALL({Dict,K,V},  {sym_dict(),key(),value()},
+            begin
+                Keys = ec_dictionary:keys(Dict),
+                ?IMPLIES(not lists:member(K,Keys),
+                         begin
+                             Dict2 = ec_dictionary:add(K,V,Dict),
+                             try lists:all(fun(B) -> B end,
+                                           [ ec_dictionary:get(Ka,Dict) ==
+                                                 ec_dictionary:get(Ka,Dict2) ||
+                                               Ka <- Keys ]) of
+                                 Bool -> Bool
+                             catch
+                                 throw:not_found -> true
+                             end
+                         end)
+            end).
+
+
+
+prop_key_is_present_after_add() ->
+    ?FORALL({Dict,K,V}, {sym_dict(),integer(),integer()},
+            begin
+                ec_dictionary:has_key(K,ec_dictionary:add(K,V,Dict))        end).
+
+prop_value_is_present_after_add() ->
+    ?FORALL({Dict,K,V}, {sym_dict(),integer(),integer()},
+            begin
+                ec_dictionary:has_value(V,ec_dictionary:add(K,V,Dict))
+            end).
+
+prop_to_list_matches_get() ->
+    ?FORALL(Dict,sym_dict(),
+            begin
+                %% Dict = eval(SymDict),
+                %% io:format("SymDict: ~p~n",[proper_symb:symbolic_seq(SymDict)]),
+                ToList = ec_dictionary:to_list(Dict),
+                %% io:format("ToList:~p~n",[ToList]),
+                GetList =
+                    try [ {K,ec_dictionary:get(K,Dict)} || {K,_V} <- ToList ] of
+                        List -> List
+                    catch
+                        throw:not_found -> key_not_found
+                    end,
+                %% io:format("~p == ~p~n",[ToList,GetList]),
+                lists:sort(ToList) == lists:sort(GetList)
+            end).
+
+prop_value_changes_after_update() ->
+    ?FORALL({Dict, K1, V1, V2},
+            {sym_dict(),
+             key(), value(), value()},
+            begin
+                Dict1 = ec_dictionary:add(K1, V1, Dict),
+                Dict2 = ec_dictionary:add(K1, V2, Dict1),
+                V1 == ec_dictionary:get(K1, Dict1) andalso
+                    V2 == ec_dictionary:get(K1, Dict2)
+            end).
+
+prop_remove_removes_only_one_key() ->
+    ?FORALL({Dict,K},
+            {sym_dict(),key()},
+            begin
+                {KeyGone,Dict2} = case ec_dictionary:has_key(K,Dict) of
+                                      true ->
+                                          D2 = ec_dictionary:remove(K,Dict),
+                                          {ec_dictionary:has_key(K,D2) == false,
+                                           D2};
+                                      false ->
+                                          {true,ec_dictionary:remove(K,Dict)}
+                                  end,
+                OtherEntries = [ KV || {K1,_} = KV <- ec_dictionary:to_list(Dict),
+                                       K1 /= K ],
+                KeyGone andalso
+                    lists:sort(OtherEntries) == lists:sort(ec_dictionary:to_list(Dict2))
+            end).
+
+prop_from_list() ->
+    ?FORALL({Dict,DictType},
+            {sym_dict(),dictionary()},
+            begin
+                List = ec_dictionary:to_list(Dict),
+                D2 = ec_dictionary:from_list(DictType,List),
+                List2 = ec_dictionary:to_list(D2),
+                lists:sort(List) == lists:sort(List2)
+            end).
+
+
+%%-----------------------------------------------------------------------------
+%% Generators
+%%-----------------------------------------------------------------------------
+
+key() -> union([integer(),atom()]).
+
+value() -> union([integer(),atom(),binary(),boolean(),string()]).
+
+
+my_dict() ->
+    ?SIZED(N,dict(N)).
+
+
+dict(0) ->
+    ec_dictionary:new(ec_gb_trees);
+dict(N) ->
+    ?LET(D,dict(N-1),
+         frequency([
+                    {1, dict(0)},
+                    {3, ec_dictionary:remove(integer(),D)},
+                    {6, ec_dictionary:add(integer(),integer(),D)}
+                  ])).
+
+sym_dict() ->
+    ?SIZED(N,sym_dict(N)).
+
+%% This symbolic generator will create a random instance of a ec_dictionary
+%% that will be used in the properties.
+sym_dict(0) ->
+    ?LET(Dict,dictionary(),
+         {'$call',ec_dictionary,new,[Dict]});
+sym_dict(N) ->
+    ?LAZY(
+       frequency([
+                  {1, sym_dict(0)},
+                  {3, {'$call',ec_dictionary,remove,[key(),sym_dict(N-1)]}},
+                  {6, {'$call',ec_dictionary,add,[value(),value(),sym_dict(N-1)]}}
+                 ])
+      ).
+
+dictionary() ->
+    union([ec_gb_trees,ec_assoc_list,ec_dict,ec_orddict]).
+
+sym_dict2() ->
+    ?SIZED(N,sym_dict2(N)).
+
+sym_dict2(0) ->
+    {call,ec_dictionary,new,[ec_gb_trees]};
+sym_dict2(N) ->
+    D = dict(N-1),
+    frequency([
+               {1, {call,ec_dictionary,remove,[integer(),D]}},
+               {2, {call,ec_dictionary,add,[integer(),integer(),D]}}
+               ]).
+
+
+%% For the tutorial.
+gb_tree() ->
+    ?SIZED(N,gb_tree(N)).
+
+gb_tree(0) ->
+    gb_trees:empty();
+gb_tree(N) ->
+    gb_trees:enter(key(),value(),gb_tree(N-1)).
+

test/ec_file_tests.erl

@@ -1,84 +0,0 @@
-%%% @copyright 2024 Erlware, LLC.
--module(ec_file_tests).
-
--include_lib("eunit/include/eunit.hrl").
-
-setup_test() ->
-    Dir = ec_file:insecure_mkdtemp(),
-    ec_file:mkdir_path(Dir),
-    ?assertMatch(false, ec_file:is_symlink(Dir)),
-    ?assertMatch(true, filelib:is_dir(Dir)).
-
-md5sum_test() ->
-    ?assertMatch("cfcd208495d565ef66e7dff9f98764da", ec_file:md5sum("0")).
-
-sha1sum_test() ->
-    ?assertMatch("b6589fc6ab0dc82cf12099d1c2d40ab994e8410c", ec_file:sha1sum("0")).
-
-file_test() ->
-    Dir = ec_file:insecure_mkdtemp(),
-    TermFile = filename:join(Dir, "ec_file/dir/file.term"),
-    TermFileCopy = filename:join(Dir, "ec_file/dircopy/file.term"),
-    filelib:ensure_dir(TermFile),
-    filelib:ensure_dir(TermFileCopy),
-    ec_file:write_term(TermFile, "term"),
-    ?assertMatch({ok, <<"\"term\". ">>}, ec_file:read(TermFile)),
-    ec_file:copy(filename:dirname(TermFile),
-         filename:dirname(TermFileCopy),
-         [recursive]).
-
-teardown_test() ->
-    Dir = ec_file:insecure_mkdtemp(),
-    ec_file:remove(Dir, [recursive]),
-    ?assertMatch(false, filelib:is_dir(Dir)).
-
-setup_base_and_target() ->
-    BaseDir = ec_file:insecure_mkdtemp(),
-    DummyContents = <<"This should be deleted">>,
-    SourceDir = filename:join([BaseDir, "source"]),
-    ok = file:make_dir(SourceDir),
-    Name1 = filename:join([SourceDir, "fileone"]),
-    Name2 = filename:join([SourceDir, "filetwo"]),
-    Name3 = filename:join([SourceDir, "filethree"]),
-    NoName = filename:join([SourceDir, "noname"]),
-
-    ok = file:write_file(Name1, DummyContents),
-    ok = file:write_file(Name2, DummyContents),
-    ok = file:write_file(Name3, DummyContents),
-    ok = file:write_file(NoName, DummyContents),
-    {BaseDir, SourceDir, {Name1, Name2, Name3, NoName}}.
-
-exists_test() ->
-    BaseDir = ec_file:insecure_mkdtemp(),
-    SourceDir = filename:join([BaseDir, "source1"]),
-    NoName = filename:join([SourceDir, "noname"]),
-    ok = file:make_dir(SourceDir),
-    Name1 = filename:join([SourceDir, "fileone"]),
-    ok = file:write_file(Name1, <<"Testn">>),
-    ?assertMatch(true, ec_file:exists(Name1)),
-    ?assertMatch(false, ec_file:exists(NoName)).
-
-real_path_test() ->
-    BaseDir = "foo",
-    Dir = filename:absname(filename:join(BaseDir, "source1")),
-    LinkDir = filename:join([BaseDir, "link"]),
-    ok = ec_file:mkdir_p(Dir),
-    file:make_symlink(Dir, LinkDir),
-    ?assertEqual(Dir, ec_file:real_dir_path(LinkDir)),
-    ?assertEqual(directory, ec_file:type(Dir)),
-    ?assertEqual(symlink, ec_file:type(LinkDir)),
-    TermFile = filename:join(BaseDir, "test_file"),
-    ok = ec_file:write_term(TermFile, foo),
-    ?assertEqual(file, ec_file:type(TermFile)),
-    ?assertEqual(true, ec_file:is_symlink(LinkDir)),
-    ?assertEqual(false, ec_file:is_symlink(Dir)).
-
-find_test() ->
-    %% Create a directory in /tmp for the test. Clean everything afterwards
-    {BaseDir, _SourceDir, {Name1, Name2, Name3, _NoName}} = setup_base_and_target(),
-    Result = ec_file:find(BaseDir, "file[a-z]+\$"),
-    ?assertMatch(3, erlang:length(Result)),
-    ?assertEqual(true, lists:member(Name1, Result)),
-    ?assertEqual(true, lists:member(Name2, Result)),
-    ?assertEqual(true, lists:member(Name3, Result)),
-    ec_file:remove(BaseDir, [recursive]).

test/ec_gb_trees_tests.erl

@@ -1,67 +0,0 @@
-%%% @copyright 2024 Erlware, LLC.
--module(ec_gb_trees_tests).
--include_lib("eunit/include/eunit.hrl").
-
-%% For me unit testing initially is about covering the obvious case. A
-%% check to make sure that what you expect the tested functionality to
-%% do, it actually does. As time goes on and people detect bugs you
-%% add tests for those specific problems to the unit test suit.
-%%
-%% However, when getting started you can only test your basic
-%% expectations. So here are the expectations I have for the add
-%% functionality.
-%%
-%% 1) I can put arbitrary terms into the dictionary as keys
-%% 2) I can put arbitrary terms into the dictionary as values
-%% 3) When I put a value in the dictionary by a key, I can retrieve
-%% that same value
-%% 4) When I put a different value in the dictionary by key it does
-%% not change other key value pairs.
-%% 5) When I update a value the new value in available by the new key
-%% 6) When a value does not exist a not found exception is created
-
-add_test() ->
-    Dict0 = ec_dictionary:new(ec_gb_trees),
-
-    Key1 = foo,
-    Key2 = [1, 3],
-    Key3 = {"super"},
-    Key4 = <<"fabulous">>,
-    Key5 = {"Sona", 2, <<"Zuper">>},
-
-    Value1 = Key5,
-    Value2 = Key4,
-    Value3 = Key2,
-    Value4 = Key3,
-    Value5 = Key1,
-
-    Dict01 = ec_dictionary:add(Key1, Value1, Dict0),
-    Dict02 = ec_dictionary:add(Key3, Value3,
-                               ec_dictionary:add(Key2, Value2,
-                                                 Dict01)),
-    Dict1 =
-        ec_dictionary:add(Key5, Value5,
-                          ec_dictionary:add(Key4, Value4,
-                                            Dict02)),
-
-    ?assertMatch(Value1, ec_dictionary:get(Key1, Dict1)),
-    ?assertMatch(Value2, ec_dictionary:get(Key2, Dict1)),
-    ?assertMatch(Value3, ec_dictionary:get(Key3, Dict1)),
-    ?assertMatch(Value4, ec_dictionary:get(Key4, Dict1)),
-    ?assertMatch(Value5, ec_dictionary:get(Key5, Dict1)),
-
-
-    Dict2 = ec_dictionary:add(Key3, Value5,
-                              ec_dictionary:add(Key2, Value4, Dict1)),
-
-
-    ?assertMatch(Value1, ec_dictionary:get(Key1, Dict2)),
-    ?assertMatch(Value4, ec_dictionary:get(Key2, Dict2)),
-    ?assertMatch(Value5, ec_dictionary:get(Key3, Dict2)),
-    ?assertMatch(Value4, ec_dictionary:get(Key4, Dict2)),
-    ?assertMatch(Value5, ec_dictionary:get(Key5, Dict2)),
-
-
-    ?assertThrow(not_found, ec_dictionary:get(should_blow_up, Dict2)),
-    ?assertThrow(not_found, ec_dictionary:get("This should blow up too",
-                                              Dict2)).

test/ec_git_vsn_tests.erl

@@ -1,13 +0,0 @@
-%%% @copyright 2024 Erlware, LLC.
--module(ec_git_vsn_tests).
-
--include_lib("eunit/include/eunit.hrl").
-
-parse_tags_test() ->
-    ?assertEqual({undefined, ""}, ec_git_vsn:parse_tags("a.b.c")).
-
-get_patch_count_test() ->
-    ?assertEqual(0, ec_git_vsn:get_patch_count("a.b.c")).
-
-collect_default_refcount_test() ->
-    ?assertMatch({"", _, _}, ec_git_vsn:collect_default_refcount("a.b.c")).

test/ec_lists_tests.erl

@@ -1,172 +0,0 @@
-%%% @copyright 2024 Erlware, LLC.
--module(ec_lists_tests).
-
--include_lib("eunit/include/eunit.hrl").
-
-find1_test() ->
-    TestData = [1, 2, 3, 4, 5, 6],
-    Result = ec_lists:find(fun(5) ->
-                          true;
-                     (_) ->
-                          false
-                  end,
-                  TestData),
-    ?assertMatch({ok, 5}, Result),
-
-    Result2 = ec_lists:find(fun(37) ->
-                           true;
-                      (_) ->
-                           false
-                   end,
-                   TestData),
-    ?assertMatch(error, Result2).
-
-find2_test() ->
-    TestData = ["one", "two", "three", "four", "five", "six"],
-    Result = ec_lists:find(fun("five") ->
-                          true;
-                     (_) ->
-                          false
-                  end,
-                  TestData),
-    ?assertMatch({ok, "five"}, Result),
-
-    Result2 = ec_lists:find(fun(super_duper) ->
-                           true;
-                      (_) ->
-                           false
-                   end,
-                   TestData),
-    ?assertMatch(error, Result2).
-
-find3_test() ->
-    TestData = [{"one", 1}, {"two", 2}, {"three", 3}, {"four", 5}, {"five", 5},
-                {"six", 6}],
-    Result = ec_lists:find(fun({"one", 1}) ->
-                          true;
-                     (_) ->
-                          false
-                  end,
-                  TestData),
-    ?assertMatch({ok, {"one", 1}}, Result),
-
-    Result2 = ec_lists:find(fun([fo, bar, baz]) ->
-                           true;
-                      ({"onehundred", 100}) ->
-                           true;
-                      (_) ->
-                           false
-                   end,
-                   TestData),
-    ?assertMatch(error, Result2).
-
-fetch1_test() ->
-    TestData = [1, 2, 3, 4, 5, 6],
-    Result = ec_lists:fetch(fun(5) ->
-                           true;
-                      (_) ->
-                           false
-                   end,
-                   TestData),
-    ?assertMatch(5, Result),
-
-    ?assertThrow(not_found,
-                 ec_lists:fetch(fun(37) ->
-                               true;
-                          (_) ->
-                               false
-                       end,
-                       TestData)).
-
-fetch2_test() ->
-    TestData = ["one", "two", "three", "four", "five", "six"],
-    Result = ec_lists:fetch(fun("five") ->
-                           true;
-                      (_) ->
-                           false
-                   end,
-                   TestData),
-    ?assertMatch("five", Result),
-
-    ?assertThrow(not_found,
-                 ec_lists:fetch(fun(super_duper) ->
-                               true;
-                          (_) ->
-                               false
-                       end,
-                       TestData)).
-
-fetch3_test() ->
-    TestData = [{"one", 1}, {"two", 2}, {"three", 3}, {"four", 5}, {"five", 5},
-                {"six", 6}],
-    Result = ec_lists:fetch(fun({"one", 1}) ->
-                           true;
-                      (_) ->
-                           false
-                   end,
-                   TestData),
-    ?assertMatch({"one", 1}, Result),
-
-    ?assertThrow(not_found,
-                 ec_lists:fetch(fun([fo, bar, baz]) ->
-                               true;
-                          ({"onehundred", 100}) ->
-                               true;
-                          (_) ->
-                               false
-                       end,
-                       TestData)).
-
-search1_test() ->
-    TestData = [1, 2, 3, 4, 5, 6],
-    Result = ec_lists:search(fun(5) ->
-                            {ok, 5};
-                       (_) ->
-                            not_found
-                    end,
-                    TestData),
-    ?assertMatch({ok, 5, 5}, Result),
-
-    Result2 = ec_lists:search(fun(37) ->
-                             {ok, 37};
-                        (_) ->
-                             not_found
-                     end,
-                     TestData),
-    ?assertMatch(not_found, Result2).
-
-search2_test() ->
-    TestData = [1, 2, 3, 4, 5, 6],
-    Result = ec_lists:search(fun(1) ->
-                            {ok, 10};
-                       (_) ->
-                            not_found
-                    end,
-                    TestData),
-    ?assertMatch({ok, 10, 1}, Result),
-
-    Result2 = ec_lists:search(fun(6) ->
-                             {ok, 37};
-                        (_) ->
-                             not_found
-                     end,
-                     TestData),
-    ?assertMatch({ok, 37, 6}, Result2).
-
-search3_test() ->
-    TestData = [1, 2, 3, 4, 5, 6],
-    Result = ec_lists:search(fun(10) ->
-                            {ok, 10};
-                       (_) ->
-                            not_found
-                    end,
-                    TestData),
-    ?assertMatch(not_found, Result),
-
-    Result2 = ec_lists:search(fun(-1) ->
-                             {ok, 37};
-                        (_) ->
-                             not_found
-                     end,
-                     TestData),
-    ?assertMatch(not_found, Result2).

test/ec_plists_tests.erl

@@ -1,84 +0,0 @@
-%%% @copyright Erlware, LLC.
--module(ec_plists_tests).
-
--include_lib("eunit/include/eunit.hrl").
-
-%%%===================================================================
-%%% Tests
-%%%===================================================================
-
-map_good_test() ->
-    Results = ec_plists:map(fun(_) ->
-                                    ok
-                            end,
-                            lists:seq(1, 5)),
-    ?assertMatch([ok, ok, ok, ok, ok],
-                 Results).
-
-ftmap_good_test() ->
-    Results = ec_plists:ftmap(fun(_) ->
-                                      ok
-                              end,
-                              lists:seq(1, 3)),
-    ?assertMatch([{value, ok}, {value, ok}, {value, ok}],
-                 Results).
-
-filter_good_test() ->
-    Results = ec_plists:filter(fun(X) ->
-                                       X == show
-                               end,
-                               [show, show, remove]),
-    ?assertMatch([show, show],
-                 Results).
-
-map_timeout_test() ->
-    ?assertExit(timeout,
-                ec_plists:map(fun(T) ->
-                                      timer:sleep(T),
-                                      T
-                              end,
-                              [1, 100], {timeout, 10})).
-
-ftmap_timeout_test() ->
-    ?assertExit(timeout,
-                ec_plists:ftmap(fun(X) ->
-                                        timer:sleep(X),
-                                        true
-                                end,
-                                [100, 1], {timeout, 10})).
-
-filter_timeout_test() ->
-    ?assertExit(timeout,
-                 ec_plists:filter(fun(T) ->
-                                          timer:sleep(T),
-                                          T == 1
-                                  end,
-                                  [1, 100], {timeout, 10})).
-
-map_bad_test() ->
-    ?assertExit({{nocatch,test_exception}, _},
-                 ec_plists:map(fun(_) ->
-                                    erlang:throw(test_exception)
-                            end,
-                            lists:seq(1, 5))).
-
-
-ftmap_bad_test() ->
-    Results =
-        ec_plists:ftmap(fun(2) ->
-                                erlang:throw(test_exception);
-                           (N) ->
-                                N
-                        end,
-                        lists:seq(1, 5)),
-    ?assertMatch([{value, 1}, {error,{throw,test_exception}}, {value, 3},
-                  {value, 4}, {value, 5}] , Results).
-
-external_down_message_test() ->
-    erlang:spawn_monitor(fun() -> erlang:throw(fail) end),
-    Results = ec_plists:map(fun(_) ->
-                                    ok
-                            end,
-                            lists:seq(1, 5)),
-    ?assertMatch([ok, ok, ok, ok, ok],
-                 Results).

test/ec_semver_tests.erl

@@ -1,447 +0,0 @@
-%%% @copyright 2024 Erlware, LLC.
--module(ec_semver_tests).
-
--include_lib("eunit/include/eunit.hrl").
-
-eql_test() ->
-    ?assertMatch(true, ec_semver:eql("1.0.0-alpha",
-                           "1.0.0-alpha")),
-    ?assertMatch(true, ec_semver:eql("v1.0.0-alpha",
-                           "1.0.0-alpha")),
-    ?assertMatch(true, ec_semver:eql("1",
-                           "1.0.0")),
-    ?assertMatch(true, ec_semver:eql("v1",
-                           "v1.0.0")),
-    ?assertMatch(true, ec_semver:eql("1.0",
-                           "1.0.0")),
-    ?assertMatch(true, ec_semver:eql("1.0.0",
-                           "1")),
-    ?assertMatch(true, ec_semver:eql("1.0.0.0",
-                           "1")),
-    ?assertMatch(true, ec_semver:eql("1.0+alpha.1",
-                           "1.0.0+alpha.1")),
-    ?assertMatch(true, ec_semver:eql("1.0-alpha.1+build.1",
-                           "1.0.0-alpha.1+build.1")),
-    ?assertMatch(true, ec_semver:eql("1.0-alpha.1+build.1",
-                           "1.0.0.0-alpha.1+build.1")),
-    ?assertMatch(true, ec_semver:eql("1.0-alpha.1+build.1",
-                           "v1.0.0.0-alpha.1+build.1")),
-    ?assertMatch(true, ec_semver:eql("1.0-pre-alpha.1",
-                           "1.0.0-pre-alpha.1")),
-    ?assertMatch(true, ec_semver:eql("aa", "aa")),
-    ?assertMatch(true, ec_semver:eql("AA.BB", "AA.BB")),
-    ?assertMatch(true, ec_semver:eql("BBB-super", "BBB-super")),
-    ?assertMatch(true, not ec_semver:eql("1.0.0",
-                               "1.0.1")),
-    ?assertMatch(true, not ec_semver:eql("1.0.0-alpha",
-                               "1.0.1+alpha")),
-    ?assertMatch(true, not ec_semver:eql("1.0.0+build.1",
-                               "1.0.1+build.2")),
-    ?assertMatch(true, not ec_semver:eql("1.0.0.0+build.1",
-                               "1.0.0.1+build.2")),
-    ?assertMatch(true, not ec_semver:eql("FFF", "BBB")),
-    ?assertMatch(true, not ec_semver:eql("1", "1BBBB")).
-
-gt_test() ->
-    ?assertMatch(true, ec_semver:gt("1.0.0-alpha.1",
-                          "1.0.0-alpha")),
-    ?assertMatch(true, ec_semver:gt("1.0.0.1-alpha.1",
-                          "1.0.0.1-alpha")),
-    ?assertMatch(true, ec_semver:gt("1.0.0.4-alpha.1",
-                          "1.0.0.2-alpha")),
-    ?assertMatch(true, ec_semver:gt("1.0.0.0-alpha.1",
-                          "1.0.0-alpha")),
-    ?assertMatch(true, ec_semver:gt("1.0.0-beta.2",
-                          "1.0.0-alpha.1")),
-    ?assertMatch(true, ec_semver:gt("1.0.0-beta.11",
-                          "1.0.0-beta.2")),
-    ?assertMatch(true, ec_semver:gt("1.0.0-pre-alpha.14",
-                          "1.0.0-pre-alpha.3")),
-    ?assertMatch(true, ec_semver:gt("1.0.0-beta.11",
-                          "1.0.0.0-beta.2")),
-    ?assertMatch(true, ec_semver:gt("1.0.0-rc.1", "1.0.0-beta.11")),
-    ?assertMatch(true, ec_semver:gt("1.0.0-rc.1+build.1", "1.0.0-rc.1")),
-    ?assertMatch(true, ec_semver:gt("1.0.0", "1.0.0-rc.1+build.1")),
-    ?assertMatch(true, ec_semver:gt("1.0.0+0.3.7", "1.0.0")),
-    ?assertMatch(true, ec_semver:gt("1.3.7+build", "1.0.0+0.3.7")),
-    ?assertMatch(true, ec_semver:gt("1.3.7+build.2.b8f12d7",
-                          "1.3.7+build")),
-    ?assertMatch(true, ec_semver:gt("1.3.7+build.2.b8f12d7",
-                          "1.3.7.0+build")),
-    ?assertMatch(true, ec_semver:gt("1.3.7+build.11.e0f985a",
-                          "1.3.7+build.2.b8f12d7")),
-    ?assertMatch(true, ec_semver:gt("aa.cc",
-                          "aa.bb")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0-alpha",
-                              "1.0.0-alpha.1")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0-alpha",
-                              "1.0.0.0-alpha.1")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0-alpha.1",
-                              "1.0.0-beta.2")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0-beta.2",
-                              "1.0.0-beta.11")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0-beta.11",
-                              "1.0.0-rc.1")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0-pre-alpha.3",
-                              "1.0.0-pre-alpha.14")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0-rc.1",
-                              "1.0.0-rc.1+build.1")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0-rc.1+build.1",
-                              "1.0.0")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0",
-                              "1.0.0+0.3.7")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0+0.3.7",
-                              "1.3.7+build")),
-    ?assertMatch(true, not ec_semver:gt("1.3.7+build",
-                              "1.3.7+build.2.b8f12d7")),
-    ?assertMatch(true, not ec_semver:gt("1.3.7+build.2.b8f12d7",
-                              "1.3.7+build.11.e0f985a")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0-alpha",
-                              "1.0.0-alpha")),
-    ?assertMatch(true, not ec_semver:gt("1",
-                              "1.0.0")),
-    ?assertMatch(true, not ec_semver:gt("aa.bb",
-                              "aa.bb")),
-    ?assertMatch(true, not ec_semver:gt("aa.cc",
-                              "aa.dd")),
-    ?assertMatch(true, not ec_semver:gt("1.0",
-                              "1.0.0")),
-    ?assertMatch(true, not ec_semver:gt("1.0.0",
-                              "1")),
-    ?assertMatch(true, not ec_semver:gt("1.0+alpha.1",
-                              "1.0.0+alpha.1")),
-    ?assertMatch(true, not ec_semver:gt("1.0-alpha.1+build.1",
-                              "1.0.0-alpha.1+build.1")).
-
-lt_test() ->
-    ?assertMatch(true, ec_semver:lt("1.0.0-alpha",
-                          "1.0.0-alpha.1")),
-    ?assertMatch(true, ec_semver:lt("1.0.0-alpha",
-                          "1.0.0.0-alpha.1")),
-    ?assertMatch(true, ec_semver:lt("1.0.0-alpha.1",
-                          "1.0.0-beta.2")),
-    ?assertMatch(true, ec_semver:lt("1.0.0-beta.2",
-                          "1.0.0-beta.11")),
-    ?assertMatch(true, ec_semver:lt("1.0.0-pre-alpha.3",
-                          "1.0.0-pre-alpha.14")),
-    ?assertMatch(true, ec_semver:lt("1.0.0-beta.11",
-                          "1.0.0-rc.1")),
-    ?assertMatch(true, ec_semver:lt("1.0.0.1-beta.11",
-                          "1.0.0.1-rc.1")),
-    ?assertMatch(true, ec_semver:lt("1.0.0-rc.1",
-                          "1.0.0-rc.1+build.1")),
-    ?assertMatch(true, ec_semver:lt("1.0.0-rc.1+build.1",
-                          "1.0.0")),
-    ?assertMatch(true, ec_semver:lt("1.0.0",
-                          "1.0.0+0.3.7")),
-    ?assertMatch(true, ec_semver:lt("1.0.0+0.3.7",
-                          "1.3.7+build")),
-    ?assertMatch(true, ec_semver:lt("1.3.7+build",
-                          "1.3.7+build.2.b8f12d7")),
-    ?assertMatch(true, ec_semver:lt("1.3.7+build.2.b8f12d7",
-                          "1.3.7+build.11.e0f985a")),
-    ?assertMatch(true, not ec_semver:lt("1.0.0-alpha",
-                              "1.0.0-alpha")),
-    ?assertMatch(true, not ec_semver:lt("1",
-                              "1.0.0")),
-    ?assertMatch(true, ec_semver:lt("1",
-                          "1.0.0.1")),
-    ?assertMatch(true, ec_semver:lt("AA.DD",
-                          "AA.EE")),
-    ?assertMatch(true, not ec_semver:lt("1.0",
-                              "1.0.0")),
-    ?assertMatch(true, not ec_semver:lt("1.0.0.0",
-                              "1")),
-    ?assertMatch(true, not ec_semver:lt("1.0+alpha.1",
-                              "1.0.0+alpha.1")),
-    ?assertMatch(true, not ec_semver:lt("AA.DD", "AA.CC")),
-    ?assertMatch(true, not ec_semver:lt("1.0-alpha.1+build.1",
-                              "1.0.0-alpha.1+build.1")),
-    ?assertMatch(true, not ec_semver:lt("1.0.0-alpha.1",
-                              "1.0.0-alpha")),
-    ?assertMatch(true, not ec_semver:lt("1.0.0-beta.2",
-                              "1.0.0-alpha.1")),
-    ?assertMatch(true, not ec_semver:lt("1.0.0-beta.11",
-                              "1.0.0-beta.2")),
-    ?assertMatch(true, not ec_semver:lt("1.0.0-pre-alpha.14",
-                              "1.0.0-pre-alpha.3")),
-    ?assertMatch(true, not ec_semver:lt("1.0.0-rc.1", "1.0.0-beta.11")),
-    ?assertMatch(true, not ec_semver:lt("1.0.0-rc.1+build.1", "1.0.0-rc.1")),
-    ?assertMatch(true, not ec_semver:lt("1.0.0", "1.0.0-rc.1+build.1")),
-    ?assertMatch(true, not ec_semver:lt("1.0.0+0.3.7", "1.0.0")),
-    ?assertMatch(true, not ec_semver:lt("1.3.7+build", "1.0.0+0.3.7")),
-    ?assertMatch(true, not ec_semver:lt("1.3.7+build.2.b8f12d7",
-                              "1.3.7+build")),
-    ?assertMatch(true, not ec_semver:lt("1.3.7+build.11.e0f985a",
-                              "1.3.7+build.2.b8f12d7")).
-
-gte_test() ->
-    ?assertMatch(true, ec_semver:gte("1.0.0-alpha",
-                           "1.0.0-alpha")),
-
-    ?assertMatch(true, ec_semver:gte("1",
-                           "1.0.0")),
-
-    ?assertMatch(true, ec_semver:gte("1.0",
-                           "1.0.0")),
-
-    ?assertMatch(true, ec_semver:gte("1.0.0",
-                           "1")),
-
-    ?assertMatch(true, ec_semver:gte("1.0.0.0",
-                           "1")),
-
-    ?assertMatch(true, ec_semver:gte("1.0+alpha.1",
-                           "1.0.0+alpha.1")),
-
-    ?assertMatch(true, ec_semver:gte("1.0-alpha.1+build.1",
-                           "1.0.0-alpha.1+build.1")),
-
-    ?assertMatch(true, ec_semver:gte("1.0.0-alpha.1+build.1",
-                           "1.0.0.0-alpha.1+build.1")),
-    ?assertMatch(true, ec_semver:gte("1.0.0-alpha.1",
-                           "1.0.0-alpha")),
-    ?assertMatch(true, ec_semver:gte("1.0.0-pre-alpha.2",
-                           "1.0.0-pre-alpha")),
-    ?assertMatch(true, ec_semver:gte("1.0.0-beta.2",
-                           "1.0.0-alpha.1")),
-    ?assertMatch(true, ec_semver:gte("1.0.0-beta.11",
-                           "1.0.0-beta.2")),
-    ?assertMatch(true, ec_semver:gte("aa.bb", "aa.bb")),
-    ?assertMatch(true, ec_semver:gte("dd", "aa")),
-    ?assertMatch(true, ec_semver:gte("1.0.0-rc.1", "1.0.0-beta.11")),
-    ?assertMatch(true, ec_semver:gte("1.0.0-rc.1+build.1", "1.0.0-rc.1")),
-    ?assertMatch(true, ec_semver:gte("1.0.0", "1.0.0-rc.1+build.1")),
-    ?assertMatch(true, ec_semver:gte("1.0.0+0.3.7", "1.0.0")),
-    ?assertMatch(true, ec_semver:gte("1.3.7+build", "1.0.0+0.3.7")),
-    ?assertMatch(true, ec_semver:gte("1.3.7+build.2.b8f12d7",
-                           "1.3.7+build")),
-    ?assertMatch(true, ec_semver:gte("1.3.7+build.11.e0f985a",
-                           "1.3.7+build.2.b8f12d7")),
-    ?assertMatch(true, not ec_semver:gte("1.0.0-alpha",
-                               "1.0.0-alpha.1")),
-    ?assertMatch(true, not ec_semver:gte("1.0.0-pre-alpha",
-                               "1.0.0-pre-alpha.1")),
-    ?assertMatch(true, not ec_semver:gte("CC", "DD")),
-    ?assertMatch(true, not ec_semver:gte("1.0.0-alpha.1",
-                               "1.0.0-beta.2")),
-    ?assertMatch(true, not ec_semver:gte("1.0.0-beta.2",
-                               "1.0.0-beta.11")),
-    ?assertMatch(true, not ec_semver:gte("1.0.0-beta.11",
-                               "1.0.0-rc.1")),
-    ?assertMatch(true, not ec_semver:gte("1.0.0-rc.1",
-                               "1.0.0-rc.1+build.1")),
-    ?assertMatch(true, not ec_semver:gte("1.0.0-rc.1+build.1",
-                               "1.0.0")),
-    ?assertMatch(true, not ec_semver:gte("1.0.0",
-                               "1.0.0+0.3.7")),
-    ?assertMatch(true, not ec_semver:gte("1.0.0+0.3.7",
-                               "1.3.7+build")),
-    ?assertMatch(true, not ec_semver:gte("1.0.0",
-                               "1.0.0+build.1")),
-    ?assertMatch(true, not ec_semver:gte("1.3.7+build",
-                               "1.3.7+build.2.b8f12d7")),
-    ?assertMatch(true, not ec_semver:gte("1.3.7+build.2.b8f12d7",
-                               "1.3.7+build.11.e0f985a")).
-lte_test() ->
-    ?assertMatch(true, ec_semver:lte("1.0.0-alpha",
-                           "1.0.0-alpha.1")),
-    ?assertMatch(true, ec_semver:lte("1.0.0-alpha.1",
-                           "1.0.0-beta.2")),
-    ?assertMatch(true, ec_semver:lte("1.0.0-beta.2",
-                           "1.0.0-beta.11")),
-    ?assertMatch(true, ec_semver:lte("1.0.0-pre-alpha.2",
-                           "1.0.0-pre-alpha.11")),
-    ?assertMatch(true, ec_semver:lte("1.0.0-beta.11",
-                           "1.0.0-rc.1")),
-    ?assertMatch(true, ec_semver:lte("1.0.0-rc.1",
-                           "1.0.0-rc.1+build.1")),
-    ?assertMatch(true, ec_semver:lte("1.0.0-rc.1+build.1",
-                           "1.0.0")),
-    ?assertMatch(true, ec_semver:lte("1.0.0",
-                           "1.0.0+0.3.7")),
-    ?assertMatch(true, ec_semver:lte("1.0.0+0.3.7",
-                           "1.3.7+build")),
-    ?assertMatch(true, ec_semver:lte("1.3.7+build",
-                           "1.3.7+build.2.b8f12d7")),
-    ?assertMatch(true, ec_semver:lte("1.3.7+build.2.b8f12d7",
-                           "1.3.7+build.11.e0f985a")),
-    ?assertMatch(true, ec_semver:lte("1.0.0-alpha",
-                           "1.0.0-alpha")),
-    ?assertMatch(true, ec_semver:lte("1",
-                           "1.0.0")),
-    ?assertMatch(true, ec_semver:lte("1.0",
-                           "1.0.0")),
-    ?assertMatch(true, ec_semver:lte("1.0.0",
-                           "1")),
-    ?assertMatch(true, ec_semver:lte("1.0+alpha.1",
-                           "1.0.0+alpha.1")),
-    ?assertMatch(true, ec_semver:lte("1.0.0.0+alpha.1",
-                           "1.0.0+alpha.1")),
-    ?assertMatch(true, ec_semver:lte("1.0-alpha.1+build.1",
-                           "1.0.0-alpha.1+build.1")),
-    ?assertMatch(true, ec_semver:lte("aa","cc")),
-    ?assertMatch(true, ec_semver:lte("cc","cc")),
-    ?assertMatch(true, not ec_semver:lte("1.0.0-alpha.1",
-                              "1.0.0-alpha")),
-    ?assertMatch(true, not ec_semver:lte("1.0.0-pre-alpha.2",
-                               "1.0.0-pre-alpha")),
-    ?assertMatch(true, not ec_semver:lte("cc", "aa")),
-    ?assertMatch(true, not ec_semver:lte("1.0.0-beta.2",
-                              "1.0.0-alpha.1")),
-    ?assertMatch(true, not ec_semver:lte("1.0.0-beta.11",
-                              "1.0.0-beta.2")),
-    ?assertMatch(true, not ec_semver:lte("1.0.0-rc.1", "1.0.0-beta.11")),
-    ?assertMatch(true, not ec_semver:lte("1.0.0-rc.1+build.1", "1.0.0-rc.1")),
-    ?assertMatch(true, not ec_semver:lte("1.0.0", "1.0.0-rc.1+build.1")),
-    ?assertMatch(true, not ec_semver:lte("1.0.0+0.3.7", "1.0.0")),
-    ?assertMatch(true, not ec_semver:lte("1.3.7+build", "1.0.0+0.3.7")),
-    ?assertMatch(true, not ec_semver:lte("1.3.7+build.2.b8f12d7",
-                              "1.3.7+build")),
-    ?assertMatch(true, not ec_semver:lte("1.3.7+build.11.e0f985a",
-                              "1.3.7+build.2.b8f12d7")).
-
-between_test() ->
-    ?assertMatch(true, ec_semver:between("1.0.0-alpha",
-                               "1.0.0-alpha.3",
-                               "1.0.0-alpha.2")),
-    ?assertMatch(true, ec_semver:between("1.0.0-alpha.1",
-                               "1.0.0-beta.2",
-                               "1.0.0-alpha.25")),
-    ?assertMatch(true, ec_semver:between("1.0.0-beta.2",
-                               "1.0.0-beta.11",
-                               "1.0.0-beta.7")),
-    ?assertMatch(true, ec_semver:between("1.0.0-pre-alpha.2",
-                               "1.0.0-pre-alpha.11",
-                               "1.0.0-pre-alpha.7")),
-    ?assertMatch(true, ec_semver:between("1.0.0-beta.11",
-                               "1.0.0-rc.3",
-                               "1.0.0-rc.1")),
-    ?assertMatch(true, ec_semver:between("1.0.0-rc.1",
-                               "1.0.0-rc.1+build.3",
-                               "1.0.0-rc.1+build.1")),
-
-    ?assertMatch(true, ec_semver:between("1.0.0.0-rc.1",
-                               "1.0.0-rc.1+build.3",
-                               "1.0.0-rc.1+build.1")),
-    ?assertMatch(true, ec_semver:between("1.0.0-rc.1+build.1",
-                               "1.0.0",
-                               "1.0.0-rc.33")),
-    ?assertMatch(true, ec_semver:between("1.0.0",
-                               "1.0.0+0.3.7",
-                               "1.0.0+0.2")),
-    ?assertMatch(true, ec_semver:between("1.0.0+0.3.7",
-                               "1.3.7+build",
-                               "1.2")),
-    ?assertMatch(true, ec_semver:between("1.3.7+build",
-                               "1.3.7+build.2.b8f12d7",
-                               "1.3.7+build.1")),
-    ?assertMatch(true, ec_semver:between("1.3.7+build.2.b8f12d7",
-                               "1.3.7+build.11.e0f985a",
-                               "1.3.7+build.10.a36faa")),
-    ?assertMatch(true, ec_semver:between("1.0.0-alpha",
-                               "1.0.0-alpha",
-                               "1.0.0-alpha")),
-    ?assertMatch(true, ec_semver:between("1",
-                               "1.0.0",
-                               "1.0.0")),
-    ?assertMatch(true, ec_semver:between("1.0",
-                               "1.0.0",
-                               "1.0.0")),
-
-    ?assertMatch(true, ec_semver:between("1.0",
-                               "1.0.0.0",
-                               "1.0.0.0")),
-    ?assertMatch(true, ec_semver:between("1.0.0",
-                               "1",
-                               "1")),
-    ?assertMatch(true, ec_semver:between("1.0+alpha.1",
-                               "1.0.0+alpha.1",
-                               "1.0.0+alpha.1")),
-    ?assertMatch(true, ec_semver:between("1.0-alpha.1+build.1",
-                               "1.0.0-alpha.1+build.1",
-                               "1.0.0-alpha.1+build.1")),
-    ?assertMatch(true, ec_semver:between("aaa",
-                               "ddd",
-                               "cc")),
-    ?assertMatch(true, not ec_semver:between("1.0.0-alpha.1",
-                                   "1.0.0-alpha.22",
-                                   "1.0.0")),
-    ?assertMatch(true, not ec_semver:between("1.0.0-pre-alpha.1",
-                                   "1.0.0-pre-alpha.22",
-                                   "1.0.0")),
-    ?assertMatch(true, not ec_semver:between("1.0.0",
-                                   "1.0.0-alpha.1",
-                                   "2.0")),
-    ?assertMatch(true, not ec_semver:between("1.0.0-beta.1",
-                                   "1.0.0-beta.11",
-                                   "1.0.0-alpha")),
-    ?assertMatch(true, not ec_semver:between("1.0.0-beta.11", "1.0.0-rc.1",
-                                   "1.0.0-rc.22")),
-    ?assertMatch(true, not ec_semver:between("aaa", "ddd", "zzz")).
-
-pes_test() ->
-    ?assertMatch(true, ec_semver:pes("1.0.0-rc.0", "1.0.0-rc.0")),
-    ?assertMatch(true, ec_semver:pes("1.0.0-rc.1", "1.0.0-rc.0")),
-    ?assertMatch(true, ec_semver:pes("1.0.0", "1.0.0-rc.0")),
-    ?assertMatch(false, ec_semver:pes("1.0.0-rc.0", "1.0.0-rc.1")),
-    ?assertMatch(true, ec_semver:pes("2.6.0", "2.6")),
-    ?assertMatch(true, ec_semver:pes("2.7", "2.6")),
-    ?assertMatch(true, ec_semver:pes("2.8", "2.6")),
-    ?assertMatch(true, ec_semver:pes("2.9", "2.6")),
-    ?assertMatch(true, ec_semver:pes("A.B", "A.A")),
-    ?assertMatch(true, not ec_semver:pes("3.0.0", "2.6")),
-    ?assertMatch(true, not ec_semver:pes("2.5", "2.6")),
-    ?assertMatch(true, ec_semver:pes("2.6.5", "2.6.5")),
-    ?assertMatch(true, ec_semver:pes("2.6.6", "2.6.5")),
-    ?assertMatch(true, ec_semver:pes("2.6.7", "2.6.5")),
-    ?assertMatch(true, ec_semver:pes("2.6.8", "2.6.5")),
-    ?assertMatch(true, ec_semver:pes("2.6.9", "2.6.5")),
-    ?assertMatch(true, ec_semver:pes("2.6.0.9", "2.6.0.5")),
-    ?assertMatch(true, not ec_semver:pes("2.7", "2.6.5")),
-    ?assertMatch(true, not ec_semver:pes("2.1.7", "2.1.6.5")),
-    ?assertMatch(true, not ec_semver:pes("A.A", "A.B")),
-    ?assertMatch(true, not ec_semver:pes("2.5", "2.6.5")).
-
-parse_test() ->
-    ?assertEqual({1, {[],[]}}, ec_semver:parse(<<"1">>)),
-    ?assertEqual({{1,2,34},{[],[]}}, ec_semver:parse(<<"1.2.34">>)),
-    ?assertEqual({<<"a">>, {[],[]}}, ec_semver:parse(<<"a">>)),
-    ?assertEqual({{<<"a">>,<<"b">>}, {[],[]}}, ec_semver:parse(<<"a.b">>)),
-    ?assertEqual({1, {[],[]}}, ec_semver:parse(<<"1">>)),
-    ?assertEqual({{1,2}, {[],[]}}, ec_semver:parse(<<"1.2">>)),
-    ?assertEqual({{1,2,2}, {[],[]}}, ec_semver:parse(<<"1.2.2">>)),
-    ?assertEqual({{1,99,2}, {[],[]}}, ec_semver:parse(<<"1.99.2">>)),
-    ?assertEqual({{1,99,2}, {[<<"alpha">>],[]}}, ec_semver:parse(<<"1.99.2-alpha">>)),
-    ?assertEqual({{1,99,2}, {[<<"alpha">>,1], []}}, ec_semver:parse(<<"1.99.2-alpha.1">>)),
-    ?assertEqual({{1,99,2}, {[<<"pre-alpha">>,1], []}}, ec_semver:parse(<<"1.99.2-pre-alpha.1">>)),
-    ?assertEqual({{1,99,2}, {[], [<<"build">>, 1, <<"a36">>]}},
-        ec_semver:parse(<<"1.99.2+build.1.a36">>)),
-    ?assertEqual({{1,99,2,44}, {[], [<<"build">>, 1, <<"a36">>]}},
-        ec_semver:parse(<<"1.99.2.44+build.1.a36">>)),
-    ?assertEqual({{1,99,2}, {[<<"alpha">>, 1], [<<"build">>, 1, <<"a36">>]}},
-        ec_semver:parse("1.99.2-alpha.1+build.1.a36")),
-    ?assertEqual({{1,99,2}, {[<<"pre-alpha">>, 1], [<<"build">>, 1, <<"a36">>]}},
-        ec_semver:parse("1.99.2-pre-alpha.1+build.1.a36")).
-
-version_format_test() ->
-    ?assertEqual(["1", [], []], ec_semver:format({1, {[],[]}})),
-    ?assertEqual(["1", ".", "2", ".", "34", [], []], ec_semver:format({{1,2,34},{[],[]}})),
-    ?assertEqual(<<"a">>, erlang:iolist_to_binary(ec_semver:format({<<"a">>, {[],[]}}))),
-    ?assertEqual(<<"a.b">>, erlang:iolist_to_binary(ec_semver:format({{<<"a">>,<<"b">>}, {[],[]}}))),
-    ?assertEqual(<<"1">>, erlang:iolist_to_binary(ec_semver:format({1, {[],[]}}))),
-    ?assertEqual(<<"1.2">>, erlang:iolist_to_binary(ec_semver:format({{1,2}, {[],[]}}))),
-    ?assertEqual(<<"1.2.2">>, erlang:iolist_to_binary(ec_semver:format({{1,2,2}, {[],[]}}))),
-    ?assertEqual(<<"1.99.2">>, erlang:iolist_to_binary(ec_semver:format({{1,99,2}, {[],[]}}))),
-    ?assertEqual(<<"1.99.2-alpha">>, erlang:iolist_to_binary(ec_semver:format({{1,99,2}, {[<<"alpha">>],[]}}))),
-    ?assertEqual(<<"1.99.2-alpha.1">>, erlang:iolist_to_binary(ec_semver:format({{1,99,2}, {[<<"alpha">>,1], []}}))),
-    ?assertEqual(<<"1.99.2-pre-alpha.1">>, erlang:iolist_to_binary(ec_semver:format({{1,99,2}, {[<<"pre-alpha">>,1], []}}))),
-    ?assertEqual(<<"1.99.2+build.1.a36">>,
-                 erlang:iolist_to_binary(ec_semver:format({{1,99,2}, {[], [<<"build">>, 1, <<"a36">>]}}))),
-    ?assertEqual(<<"1.99.2.44+build.1.a36">>,
-                 erlang:iolist_to_binary(ec_semver:format({{1,99,2,44}, {[], [<<"build">>, 1, <<"a36">>]}}))),
-    ?assertEqual(<<"1.99.2-alpha.1+build.1.a36">>,
-                 erlang:iolist_to_binary(ec_semver:format({{1,99,2}, {[<<"alpha">>, 1], [<<"build">>, 1, <<"a36">>]}}))),
-    ?assertEqual(<<"1.99.2-pre-alpha.1+build.1.a36">>,
-        erlang:iolist_to_binary(ec_semver:format({{1,99,2}, {[<<"pre-alpha">>, 1], [<<"build">>, 1, <<"a36">>]}}))),
-    ?assertEqual(<<"1">>, erlang:iolist_to_binary(ec_semver:format({1, {[],[]}}))).

test/ec_talk_tests.erl

@@ -1,19 +0,0 @@
-%%% @copyright 2024 Erlware, LLC.
--module(ec_talk_tests).
-
--include_lib("eunit/include/eunit.hrl").
-
-general_test_() ->
-    [?_test(42 == ec_talk:get_integer("42")),
-     ?_test(500_211 == ec_talk:get_integer("500211")),
-     ?_test(1_234_567_890 == ec_talk:get_integer("1234567890")),
-     ?_test(12_345_678_901_234_567_890 == ec_talk:get_integer("12345678901234567890")),
-     ?_test(true == ec_talk:get_boolean("true")),
-     ?_test(false == ec_talk:get_boolean("false")),
-     ?_test(true == ec_talk:get_boolean("Ok")),
-     ?_test(true == ec_talk:get_boolean("ok")),
-     ?_test(true == ec_talk:get_boolean("Y")),
-     ?_test(true == ec_talk:get_boolean("y")),
-     ?_test(false == ec_talk:get_boolean("False")),
-     ?_test(false == ec_talk:get_boolean("No")),
-     ?_test(false == ec_talk:get_boolean("no"))].

test/mock.erl

@@ -0,0 +1,10 @@
+-module(mock).
+
+-export([new_dictionary/0]).
+
+new_dictionary() ->
+    meck:new(ec_dictionary_proper),
+    meck:expect(ec_dictionary_proper, dictionary, fun() ->
+							  proper_types:union([ec_dict])
+						  end).
+