Table of Contents generated with DocToc
Changelog
v1.0.0
Enhancements
- #1 - KronicDeth
- CircleCI build setup
- JUnit formatter for CircleCI’s test output parsing
- #2 - KronicDeth
mix test --cover
with CoverEx- Archive coverage reports on CircleCI
- #3 - KronicDeth
- Use
ex_doc
andearmark
to generate documentation withmix docs
- Use
mix inch (--pedantic)
to see coverage for documentation - #4 - KronicDeth
- Add repository to hexfaktor, so that outdated hex dependencies are automatically notified through CI.
- Add hexfaktor badge to README.md
- #5 - KronicDeth
- Configure
mix credo
to run againstlib
andtest
to maintain consistency with Ruby projects that userubocop
onlib
andspec
. - Run
mix credo --strict
on CircleCI to check style and consistency in CI - #6 - KronicDeth
- Use
dialyze
for dialyzer access withmix dialyze
- #7 - Validation and conversion of JSON API errors Documents - KronicDeth
- JSON API errors documents can be validated and converted to
%Alembic.Document{}
usingAlembic.Document.from_json/2
. Invalid documents return{:error, %Alembic.Document{}}
. The%Alembic.Document{}
can be sent back to the sender, which can be validated on the other end usingfrom_json/2
. Valid documents return{:ok, %Alembic.Document{}}
. - #8 - JSON API (non-errors) Documents - KronicDeth
Alembic.ResourceIdentifier
Alembic.ResourceLinkage
Alembic.Relationship
Alembic.Relationships
Alembic.Resource
Alembic.Document
can parsefrom_json
, represent, and encode withPoison.encode
all document format, includingdata
andmeta
, in addition to the prior support forerrors
assert_idempotent
is defined in a module,Alembic.FromJsonCase
undertest/support
, so it’s no longer necessary to runmix test <file> test/interpreter_server/api/from_json_test.exs
to get access toassert_idempotent
in<file>
.
Bug Fixes
Incompatible Changes
- #8 - JSON API (non-errors) Documents - KronicDeth
Alembic.FromJsonTest.assert_idempotent
has moved toAlembic.FromJsonCase
.