feat: implement a macro for trait transformations (#12)

Author: loichyan

.github/codecov.yml

@@ -0,0 +1,10 @@
+coverage:
+  precision: 2
+  round: down
+  range: 70...90
+
+  status:
+    project:
+      default:
+        enabled: true
+        threshold: 1%

.github/workflows/cicd.yml

@@ -107,7 +107,7 @@ jobs:
 
       - name: Check | Miri
         if: matrix.toolchain == 'nightly'
-        run: cargo miri test --workspace --all-features
+        run: cargo miri test -p dynify --all-features
 
       - name: Check | Coverage
         if: matrix.toolchain == 'nightly'
@@ -125,9 +125,36 @@ jobs:
           files: lcov.info
           fail_ci_if_error: true
 
+  changelog:
+    name: Update changelog
+    needs: [check]
+    if: github.event_name == 'pull_request'
+    permissions:
+      contents: write # need to commit changes
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup | Checkout
+        uses: actions/checkout@v4
+        with: { ref: "${{ github.head_ref }}" }
+
+      - name: Doc | Update changelog
+        run: |
+          sed -i \
+            -e 's/{{PRNUM}}/${{ github.event.number }}/g' \
+            -e "s/{{DATE}}/$(date -u +'%Y-%m-%d')/g" \
+            CHANGELOG.md
+
+      - name: Post Doc | Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v6
+        with:
+          commit_message: "docs: expand variables in changelog"
+          commit_user_name: github-actions[bot]
+          commit_user_email: github-actions[bot]@users.noreply.github.com
+          commit_author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
+
   release:
     name: Create GitHub release
-    needs: [metadata, check]
+    needs: [check, changelog]
     if: startsWith(github.head_ref, 'release/')
     permissions:
       contents: write # Need to update release

CHANGELOG.md

@@ -2,20 +2,25 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
-adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 <!--
-Here's a template for each release section. This file should only include changes that are
-noticeable to end-users since the last release. For developers, this project follows
-[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to track changes.
+Here's a template for each release section. This file should only include updates
+that are noticeable to end users between two releases. For developers, this project
+follows <https://www.conventionalcommits.org/en/v1.0.0/> to track changes.
 
 ## [1.0.0] - YYYY-MM-DD
 
 ### Added
 
-- (**BREAKING**) Always place breaking changes at the top.
-- Append other changes in chronological order under the relevant subsections.
+- (**breaking**) Always place breaking changes at the top of each subsection.
+- Append other changes in chronological order under the appropriate subsection.
+- Additionally, you may use `{{variable name}}` as a placeholder for the value
+  of a named variable, which includes:
+  - `PRNUM`: the number of the pull request
+  - `DATE`: the date in `YYYY-MM-DD` format whenever the pull request is updated
 
 ### Changed
 
@@ -36,14 +41,17 @@ noticeable to end-users since the last release. For developers, this project fol
 
 - Support downcasting a `Buffered` pointer ([#10]).
 - Support unwrapping a `Buffered` pointer ([#11]).
+- Add a helper macro `#[dynify]` for trait transformations ([#12]).
 
 [#10]: https://github.com/loichyan/dynify/pull/10
 [#11]: https://github.com/loichyan/dynify/pull/11
+[#12]: https://github.com/loichyan/dynify/pull/12
 
 ## [0.1.0] - 2025-07-06
 
-The main purpose of this release is to address unsoundness and introduce breaking changes early to
-prevent further issues. Consequently, it includes few changes.
+The main purpose of this release is to address unsoundness and introduce
+breaking changes early to prevent further issues. Consequently, it includes few
+changes.
 
 ### Added
 
@@ -56,8 +64,8 @@ prevent further issues. Consequently, it includes few changes.
 
 ### Removed
 
-- (**BREAKING**) Remove `Emplace` implementations for `&mut [u8; N]`, `&mut [u8]` and `&mut Vec<u8>`
-  ([#2]).
+- (**breaking**) Remove `Emplace` implementations for `&mut [u8; N]`,
+  `&mut [u8]` and `&mut Vec<u8>` ([#2]).
 
 ### Fixed
 
@@ -70,8 +78,9 @@ prevent further issues. Consequently, it includes few changes.
 
 ## [0.0.1] - 2025-07-05
 
-🎉 Initial release. Check out [README](https://github.com/loichyan/dynify/blob/v0.0.1/README.md) for
-more details.
+🎉 Initial release. Check out
+[README](https://github.com/loichyan/dynify/blob/v0.0.1/README.md) for more
+details.
 
 [0.0.1]: https://github.com/loichyan/dynify/releases/tag/v0.0.1
 [0.1.0]: https://github.com/loichyan/dynify/releases/tag/v0.1.0

Cargo.lock

@@ -1,38 +1,59 @@
-[package]
-name = "dynify"
-version = "0.1.0"
+[workspace]
+members = ["macros"]
+
+[workspace.package]
 authors = ["Loi Chyan <[email protected]>"]
 license = "MIT OR Apache-2.0"
 edition = "2021"
 rust-version = "1.80"
-
 repository = "https://github.com/loichyan/dynify"
-description = "Add dyn compatible variant to you async trait"
+
+[workspace.dependencies]
+fastrand = "2.3.0"
+rstest = { version = "0.25.0", default-features = false }
+
+[workspace.lints.rust]
+unexpected_cfgs.level = "warn"
+unexpected_cfgs.check-cfg = ["cfg(coverage)", "cfg(coverage_nightly)"]
+unknown_lints = "allow"
+
+[workspace.lints.clippy]
+uninlined_format_args = "allow"
+
+[package]
+name = "dynify"
+version = "0.1.0"
+authors.workspace = true
+license.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+
+repository.workspace = true
+description = "Add dyn compatible variant to your async trait"
 keywords = ["async", "trait", "impl"]
 categories = ["asynchronous", "no-std", "rust-patterns"]
 
 [features]
-default = ["alloc"]
+default = ["alloc", "macros"]
 alloc = []
+macros = ["dep:dynify-macros"]
 smallvec = ["dep:smallvec"]
 
 [dependencies]
+dynify-macros = { path = "./macros", optional = true }
 smallvec = { version = "1", optional = true }
 
 [dev-dependencies]
-fastrand = "2.3.0"
+fastrand.workspace = true
 pollster = { version = "0.4.0", features = ["macro"] }
-rstest = { version = "0.25.0", default-features = false }
+rstest.workspace = true
+rustversion = "1.0.21"
+trait-variant = "0.1.2"
 trybuild = "1.0.105"
 
 [package.metadata.docs.rs]
 all-features = true
 rustdoc-args = ["--cfg", "docsrs"]
 
-[lints.rust]
-unexpected_cfgs.level = "warn"
-unexpected_cfgs.check-cfg = ["cfg(coverage)", "cfg(coverage_nightly)"]
-unknown_lints = "allow"
-
-[lints.clippy]
-uninlined_format_args = "allow"
+[lints]
+workspace = true