Implement Events Handling (#1)

.editorconfig

@@ -20,3 +20,12 @@ indent_size = 4
 [*.toml]
 indent_style = space
 indent_size = 4
+max_line_length = off
+
+[*.{yaml, yml}]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+indent_style = tab
+indent_size = 4

.github/workflows/ci.yml

@@ -0,0 +1,146 @@
+name: CI
+
+on:
+  push:
+    branches: ["master"]
+    tags: ["arcana-*"]
+  pull_request:
+    branches: ["master"]
+
+env:
+  RUST_BACKTRACE: 1
+
+jobs:
+
+  ##########################
+  # Linting and formatting #
+  ##########################
+
+  clippy:
+    if: ${{ github.ref == 'refs/heads/master'
+            || startsWith(github.ref, 'refs/tags/arcana-')
+            || !contains(github.event.head_commit.message, '[skip ci]') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          components: clippy
+
+      - run: make cargo.lint
+
+  rustfmt:
+    if: ${{ github.ref == 'refs/heads/master'
+            || startsWith(github.ref, 'refs/tags/arcana-')
+            || !contains(github.event.head_commit.message, '[skip ci]') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          components: rustfmt
+
+      - run: make cargo.fmt check=yes
+
+
+
+
+  ###########
+  # Testing #
+  ###########
+
+  test:
+    if: ${{ github.ref == 'refs/heads/master'
+            || startsWith(github.ref, 'refs/tags/arcana-')
+            || !contains(github.event.head_commit.message, '[skip ci]') }}
+    strategy:
+      fail-fast: false
+      matrix:
+        crate:
+          - arcana-core
+          - arcana-codegen-impl
+          - arcana-codegen-shim
+          - arcana-codegen
+          - arcana
+        os:
+          - ubuntu
+          - macOS
+          - windows
+        toolchain:
+          - nightly
+    runs-on: ${{ matrix.os }}-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: ${{ matrix.toolchain }}
+          override: true
+
+      - run: make test crate=${{ matrix.crate }}
+
+# TODO: MSRV currently has no sense since we sit on nightly Rust.
+#       Re-enable once again on stable Rust.
+#  msrv:
+#    name: MSRV
+#    if: ${{ github.ref == 'refs/heads/master'
+#            || startsWith(github.ref, 'refs/tags/v')
+#            || !contains(github.event.head_commit.message, '[skip ci]') }}
+#    strategy:
+#      fail-fast: false
+#      matrix:
+#        msrv: [ '1.54.0' ]
+#        os:
+#          - ubuntu
+#          - macOS
+#          - windows
+#    runs-on: ${{ matrix.os }}-latest
+#    steps:
+#      - uses: actions/checkout@v2
+#      - uses: actions-rs/toolchain@v1
+#        with:
+#          profile: minimal
+#          toolchain: nightly
+#      - uses: actions-rs/toolchain@v1
+#        with:
+#          profile: minimal
+#          toolchain: ${{ matrix.msrv }}
+#          override: true
+#
+#      - run: cargo +nightly update -Z minimal-versions
+#
+#      - run: make test
+
+
+
+
+  #################
+  # Documentation #
+  #################
+
+  rustdoc:
+    if: ${{ github.ref == 'refs/heads/master'
+            || startsWith(github.ref, 'refs/tags/arcana-')
+            || !contains(github.event.head_commit.message, '[skip ci]') }}
+    strategy:
+      matrix:
+        crate:
+          - arcana-core
+          - arcana-codegen-impl
+          - arcana-codegen-shim
+          - arcana-codegen
+          - arcana
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions-rs/toolchain@v1
+        with:
+          profile: minimal
+          toolchain: nightly
+          override: true
+
+      - run: make cargo.doc crate=${{ matrix.crate }} open=no

.rustfmt.toml

@@ -0,0 +1,16 @@
+# Project configuration for rustfmt Rust code formatter.
+# See full list of configurations at:
+# https://github.com/rust-lang/rustfmt/blob/master/Configurations.md
+
+max_width = 80
+format_strings = false
+imports_granularity = "Crate"
+
+format_code_in_doc_comments = true
+format_macro_matchers = true
+use_try_shorthand = true
+
+error_on_line_overflow = true
+error_on_unformatted = true
+
+unstable_features = true

CHANGELOG.md

@@ -0,0 +1,30 @@
+`arcana` changelog
+===================
+
+All user visible changes to this project will be documented in this file. This project uses [Semantic Versioning 2.0.0].
+
+
+
+
+## [0.1.0] · 2021-06-25
+[0.1.0]: /../../tree/v0.1.0
+
+### Initially implemented
+
+- Events
+  - Traits
+    - `Event`
+    - `VersionedEvent`
+    - `EventSourced`
+    - `EventInitialised`
+  - Structs
+    - `InitialEvent` wrapper
+    - `EventVersion`
+  - Proc macros
+    - `Event` derive
+    - `VersionedEvent` derive
+
+
+
+
+[Semantic Versioning 2.0.0]: https://semver.org

Cargo.toml

@@ -0,0 +1,34 @@
+[package]
+name = "arcana"
+version = "0.1.0-dev"
+edition = "2018"
+resolver = "2"
+description = "Opionated CQRS/ES framework with type magic."
+authors = [
+    "Ilya Solovyiov <[email protected]>",
+    "Kai Ren <[email protected]>",
+]
+documentation = "https://docs.rs/arcana-core"
+homepage = "https://github.com/arcana-rs/arcana"
+repository = "https://github.com/arcana-rs/arcana"
+readme = "README.md"
+
+[features]
+doc = ["arcana-codegen/doc"] # only for generating documentation
+derive = ["arcana-codegen"]
+es = ["arcana-core/es"]
+
+[dependencies]
+arcana-core = { version = "0.1.0-dev", path = "./core" }
+arcana-codegen = { version = "0.1.0-dev", path = "./codegen", optional = true }
+
+[[example]]
+name = "event"
+required-features = ["derive", "es"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
+[workspace]
+members = ["codegen", "codegen/impl", "codegen/shim", "core"]

Makefile

@@ -0,0 +1,88 @@
+###############################
+# Common defaults/definitions #
+###############################
+
+comma := ,
+
+# Checks two given strings for equality.
+eq = $(if $(or $(1),$(2)),$(and $(findstring $(1),$(2)),\
+                                $(findstring $(2),$(1))),1)
+
+
+
+
+###########
+# Aliases #
+###########
+
+docs: cargo.doc
+
+
+fmt: cargo.fmt
+
+
+lint: cargo.lint
+
+
+
+
+##################
+# Cargo commands #
+##################
+
+# Generate crates documentation from Rust sources.
+#
+# Usage:
+#	make cargo.doc [crate=<crate-name>] [open=(yes|no)] [clean=(no|yes)]
+
+cargo.doc:
+ifeq ($(clean),yes)
+	@rm -rf target/doc/
+endif
+	cargo +nightly doc $(if $(call eq,$(crate),),--workspace,-p $(crate)) \
+		--all-features \
+		$(if $(call eq,$(open),no),,--open)
+
+
+# Format Rust sources with rustfmt.
+#
+# Usage:
+#	make cargo.fmt [check=(no|yes)]
+
+cargo.fmt:
+	cargo +nightly fmt --all $(if $(call eq,$(check),yes),-- --check,)
+
+
+# Lint Rust sources with Clippy.
+#
+# Usage:
+#	make cargo.lint
+
+cargo.lint:
+	cargo +nightly clippy --workspace -- -D clippy::pedantic -D warnings
+
+
+
+
+####################
+# Testing commands #
+####################
+
+# Run Rust tests of project.
+#
+# Usage:
+#	make test [crate=<crate-name>]
+
+test:
+	cargo +nightly test $(if $(call eq,$(crate),),--workspace,-p $(crate)) \
+		--all-features
+
+
+
+
+##################
+# .PHONY section #
+##################
+
+.PHONY: docs fmt lint test \
+        cargo.doc cargo.fmt cargo.lint

codegen/Cargo.toml

@@ -0,0 +1,28 @@
+[package]
+name = "arcana-codegen"
+version = "0.1.0-dev"
+edition = "2018"
+resolver = "2"
+description = "Code generation for `arcana` crate."
+authors = [
+    "Ilya Solovyiov <[email protected]>",
+    "Kai Ren <[email protected]>",
+]
+documentation = "https://docs.rs/arcana-codegen"
+homepage = "https://github.com/arcana-rs/arcana/tree/master/codegen"
+repository = "https://github.com/arcana-rs/arcana"
+readme = "README.md"
+
+[features]
+doc = ["arcana-codegen-shim/doc", "arcana-core"] # only for generating documentation
+
+[dependencies]
+arcana-codegen-shim = { version = "0.1.0-dev", path = "./shim" }
+static_assertions = { version = "1.1", default-features = false }
+
+# `doc` feature
+arcana-core = { version = "0.1.0-dev", path = "../core", features = ["es"], optional = true }
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

codegen/README.md

@@ -0,0 +1,18 @@
+arcana-codegen
+==============
+
+Code generation for [`arcana`] crate.
+
+DO NOT use it directly, use [`arcana`] crate instead. 
+
+If you want to reuse [`arcana-codegen`] inner machinery in your own [proc macro][1] crate, then consider to use [`arcana-codegen-impl`] crate also.
+
+
+
+
+
+[`arcana`]: https://docs.rs/arcana
+[`arcana-codegen`]: https://docs.rs/arcana-codegen
+[`arcana-codegen-impl`]: https://docs.rs/arcana-codegen-impl
+
+[1]: https://doc.rust-lang.org/reference/procedural-macros.html