Implement Events Handling (#1)

.github/workflows/ci.yml

@@ -0,0 +1,108 @@
+name: CI
+
+on: [push, pull_request]
+
+env:
+  RUST_BACKTRACE: 1
+
+jobs:
+
+  ##########################
+  # Linting and formatting #
+  ##########################
+
+  clippy:
+    if: ${{ github.ref == 'refs/heads/master'
+      || startsWith(github.ref, 'refs/tags/v')
+      || !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/v')
+      || !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/v')
+      || !contains(github.event.head_commit.message, '[skip ci]') }}
+    strategy:
+      fail-fast: false
+      matrix:
+        crate:
+          - arcana
+          - arcana-core
+          - arcana-codegen
+          - arcana-codegen-impl
+        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 }}
+
+
+
+
+  #################
+  # Documentation #
+  #################
+
+  docs:
+    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 open=no
+
+      - name: Finalize
+        run: |
+          CRATE_NAME=$(echo '${{ github.repository }}' | tr '[:upper:]' '[:lower:]' | cut -f2 -d"/")
+          echo "<meta http-equiv=\"refresh\" content=\"0; url=${CRATE_NAME/-/_}\">" > target/doc/index.html
+          touch target/doc/.nojekyll
+      - name: Upload as artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: Documentation
+          path: target/doc

.rustfmt.toml

@@ -0,0 +1,16 @@
+# Project configuration for rustfmt Rust code formatter.
+# See full list of configurations at:
+# https://github.com/rust-lang-nursery/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,18 @@
+[package]
+name = "arcana"
+version = "0.1.0"
+edition = "2018"
+
+[features]
+default = ["derive", "es"]
+derive = []
+es = ["arcana-core/es"]
+
+[dependencies]
+arcana-core = { version = "0.1.0", path = "./core" }
+arcana-codegen = { version = "0.1.0", path = "./codegen" }
+static_assertions = "1.1"
+once_cell = "1.8"
+
+[workspace]
+members = ["codegen", "codegen/impl", "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 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 fmt --all $(if $(call eq,$(check),yes),-- --check,)
+
+
+# Lint Rust sources with Clippy.
+#
+# Usage:
+#	make cargo.lint
+
+cargo.lint:
+	cargo clippy --workspace -- -D clippy::pedantic -D warnings
+
+
+
+
+####################
+# Testing commands #
+####################
+
+# Run Rust tests of project.
+#
+# Usage:
+#	make test [crate=<crate-name>]
+
+test:
+	cargo 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,7 @@
+[package]
+name = "arcana-codegen"
+version = "0.1.0"
+edition = "2018"
+
+[dependencies]
+arcana-codegen-impl = { version = "0.1.0", path = "./impl"}

codegen/README.md

@@ -0,0 +1,2 @@
+arcana-codegen
+==============

codegen/impl/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "arcana-codegen-impl"
+version = "0.1.0"
+edition = "2018"
+
+[lib]
+proc-macro = true
+
+[dependencies]
+arcana-core = { version = "0.1.0", path = "../../core" }
+proc-macro2 = "1.0"
+quote = "1.0"
+strum = { version = "0.21", features = ["derive"] }
+syn = "1.0"
+synthez = "0.1"

codegen/impl/README.md

@@ -0,0 +1,2 @@
+arcana-codegen-impl
+===================