mirror of
https://github.com/kristoferssolo/filecaster.git
synced 2025-10-21 19:00:34 +00:00
Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 087fdc7ea5 | |||
| 523cf95b6b | |||
| b900680235 | |||
| 0b9994a689 | |||
| 6f60d8f5f1 | |||
| e20000513a | |||
| c4cf6aa25b | |||
| b1b4a3daeb | |||
| f972876880 | |||
| 89732ff8e2 |
124
.github/workflows/ci.yml
vendored
124
.github/workflows/ci.yml
vendored
@ -9,112 +9,30 @@ env:
|
|||||||
RUSTFLAGS: --deny warnings
|
RUSTFLAGS: --deny warnings
|
||||||
RUSTDOCFLAGS: --deny warnings
|
RUSTDOCFLAGS: --deny warnings
|
||||||
jobs:
|
jobs:
|
||||||
# Run tests
|
build-and-test:
|
||||||
test:
|
|
||||||
name: Tests
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
timeout-minutes: 30
|
env:
|
||||||
|
SCCACHE_GHA_ENABLED: "true"
|
||||||
|
RUSTC_WRAPPER: "sccache"
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v5
|
||||||
- name: Install Rust toolchain
|
- name: Install Rust
|
||||||
uses: dtolnay/rust-toolchain@stable
|
uses: dtolnay/rust-toolchain@stable
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
sudo apt-get update
|
|
||||||
sudo apt-get install --no-install-recommends \
|
|
||||||
libasound2-dev libudev-dev libwayland-dev \
|
|
||||||
libxkbcommon-dev
|
|
||||||
- name: Populate target directory from cache
|
|
||||||
uses: Leafwing-Studios/cargo-cache@v2
|
|
||||||
with:
|
with:
|
||||||
sweep-cache: true
|
toolchain: stable
|
||||||
|
components: clippy, rustfmt
|
||||||
|
- name: Run sccache-cache
|
||||||
|
uses: mozilla-actions/sccache-action@v0.0.9
|
||||||
- name: Install cargo-nextest
|
- name: Install cargo-nextest
|
||||||
run: cargo install cargo-nextest --locked
|
uses: taiki-e/install-action@cargo-nextest
|
||||||
- name: Run tests with nextest
|
- name: Run Clippy
|
||||||
|
run: cargo clippy --locked --workspace --all-targets --all-features -- -D warnings
|
||||||
|
- name: Run formatting
|
||||||
|
run: cargo fmt --all --check
|
||||||
|
- name: Run Tests
|
||||||
run: |
|
run: |
|
||||||
cargo nextest run \
|
cargo nextest run --all-features --all-targets
|
||||||
--all-features \
|
cargo test --locked --workspace --all-features --doc
|
||||||
--all-targets
|
- name: Check Documentation
|
||||||
# Workaround for https://github.com/rust-lang/cargo/issues/6669
|
run: cargo doc --locked --workspace --all-features --document-private-items --no-deps
|
||||||
cargo test \
|
|
||||||
--locked \
|
|
||||||
--workspace \
|
|
||||||
--all-features \
|
|
||||||
--doc
|
|
||||||
# Run clippy lints
|
|
||||||
clippy:
|
|
||||||
name: Clippy
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 30
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Install Rust toolchain
|
|
||||||
uses: dtolnay/rust-toolchain@stable
|
|
||||||
with:
|
|
||||||
components: clippy
|
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
sudo apt-get update
|
|
||||||
sudo apt-get install --no-install-recommends \
|
|
||||||
libasound2-dev libudev-dev libwayland-dev \
|
|
||||||
libxkbcommon-dev
|
|
||||||
- name: Populate target directory from cache
|
|
||||||
uses: Leafwing-Studios/cargo-cache@v2
|
|
||||||
with:
|
|
||||||
sweep-cache: true
|
|
||||||
- name: Run clippy lints
|
|
||||||
run: |
|
|
||||||
cargo clippy \
|
|
||||||
--locked \
|
|
||||||
--workspace \
|
|
||||||
--all-features \
|
|
||||||
-- \
|
|
||||||
--deny warnings
|
|
||||||
# Check formatting
|
|
||||||
format:
|
|
||||||
name: Format
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 30
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Install Rust toolchain
|
|
||||||
uses: dtolnay/rust-toolchain@stable
|
|
||||||
with:
|
|
||||||
components: rustfmt
|
|
||||||
- name: Run cargo fmt
|
|
||||||
run: |
|
|
||||||
cargo fmt \
|
|
||||||
--all \
|
|
||||||
-- \
|
|
||||||
--check
|
|
||||||
# Check documentation
|
|
||||||
doc:
|
|
||||||
name: Docs
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 30
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v4
|
|
||||||
- name: Install Rust toolchain
|
|
||||||
uses: dtolnay/rust-toolchain@stable
|
|
||||||
- name: Install dependencies
|
|
||||||
run: |
|
|
||||||
sudo apt-get update
|
|
||||||
sudo apt-get install --no-install-recommends \
|
|
||||||
libasound2-dev libudev-dev libwayland-dev \
|
|
||||||
libxkbcommon-dev
|
|
||||||
- name: Populate target directory from cache
|
|
||||||
uses: Leafwing-Studios/cargo-cache@v2
|
|
||||||
with:
|
|
||||||
sweep-cache: true
|
|
||||||
- name: Check documentation
|
|
||||||
run: |
|
|
||||||
cargo doc \
|
|
||||||
--locked \
|
|
||||||
--workspace \
|
|
||||||
--all-features \
|
|
||||||
--document-private-items \
|
|
||||||
--no-deps
|
|
||||||
|
|||||||
24
.github/workflows/publish.yml
vendored
24
.github/workflows/publish.yml
vendored
@ -15,10 +15,9 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
audit:
|
audit:
|
||||||
name: Audit
|
name: Audit
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 10
|
timeout-minutes: 10
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
- uses: actions-rust-lang/audit@v1
|
- uses: actions-rust-lang/audit@v1
|
||||||
with:
|
with:
|
||||||
token: ${{ secrets.GITHUB_TOKEN }}
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
@ -28,11 +27,17 @@ jobs:
|
|||||||
- audit
|
- audit
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
timeout-minutes: 25
|
timeout-minutes: 25
|
||||||
|
env:
|
||||||
|
SCCACHE_GHA_ENABLED: "true"
|
||||||
|
RUSTC_WRAPPER: "sccache"
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v5
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
- uses: dtolnay/rust-toolchain@stable
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
|
with:
|
||||||
|
toolchain: stable
|
||||||
|
components: clippy, rustfmt
|
||||||
|
- name: Run sccache-cache
|
||||||
|
uses: mozilla-actions/sccache-action@v0.0.9
|
||||||
- name: cargo-release Cache
|
- name: cargo-release Cache
|
||||||
id: cargo_release_cache
|
id: cargo_release_cache
|
||||||
uses: actions/cache@v4
|
uses: actions/cache@v4
|
||||||
@ -60,11 +65,4 @@ jobs:
|
|||||||
# to the tag while building, which is a detached head
|
# to the tag while building, which is a detached head
|
||||||
|
|
||||||
run: |
|
run: |
|
||||||
cargo release \
|
cargo release publish --workspace --all-features --allow-branch HEAD --no-confirm --no-verify --execute
|
||||||
publish \
|
|
||||||
--workspace \
|
|
||||||
--all-features \
|
|
||||||
--allow-branch HEAD \
|
|
||||||
--no-confirm \
|
|
||||||
--no-verify \
|
|
||||||
--execute
|
|
||||||
|
|||||||
50
Cargo.lock
generated
50
Cargo.lock
generated
@ -50,7 +50,7 @@ checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be"
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "filecaster"
|
name = "filecaster"
|
||||||
version = "0.2.2"
|
version = "0.2.3"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"filecaster-derive",
|
"filecaster-derive",
|
||||||
"merge",
|
"merge",
|
||||||
@ -58,11 +58,12 @@ dependencies = [
|
|||||||
"serde_json",
|
"serde_json",
|
||||||
"tempfile",
|
"tempfile",
|
||||||
"toml",
|
"toml",
|
||||||
|
"trybuild",
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "filecaster-derive"
|
name = "filecaster-derive"
|
||||||
version = "0.2.2"
|
version = "0.2.3"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"claims",
|
"claims",
|
||||||
"filecaster",
|
"filecaster",
|
||||||
@ -87,6 +88,12 @@ dependencies = [
|
|||||||
"wasi",
|
"wasi",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "glob"
|
||||||
|
version = "0.3.3"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "0cc23270f6e1808e30a928bdc84dea0b9b4136a8bc82338574f23baf47bbd280"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "hashbrown"
|
name = "hashbrown"
|
||||||
version = "0.15.4"
|
version = "0.15.4"
|
||||||
@ -281,6 +288,12 @@ dependencies = [
|
|||||||
"unicode-ident",
|
"unicode-ident",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "target-triple"
|
||||||
|
version = "0.1.4"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "1ac9aa371f599d22256307c24a9d748c041e548cbf599f35d890f9d365361790"
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "tempfile"
|
name = "tempfile"
|
||||||
version = "3.20.0"
|
version = "3.20.0"
|
||||||
@ -294,6 +307,15 @@ dependencies = [
|
|||||||
"windows-sys 0.59.0",
|
"windows-sys 0.59.0",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "termcolor"
|
||||||
|
version = "1.4.1"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "06794f8f6c5c898b3275aebefa6b8a1cb24cd2c6c79397ab15774837a0bc5755"
|
||||||
|
dependencies = [
|
||||||
|
"winapi-util",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "toml"
|
name = "toml"
|
||||||
version = "0.9.2"
|
version = "0.9.2"
|
||||||
@ -333,6 +355,21 @@ version = "1.0.2"
|
|||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "fcc842091f2def52017664b53082ecbbeb5c7731092bad69d2c63050401dfd64"
|
checksum = "fcc842091f2def52017664b53082ecbbeb5c7731092bad69d2c63050401dfd64"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "trybuild"
|
||||||
|
version = "1.0.110"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "32e257d7246e7a9fd015fb0b28b330a8d4142151a33f03e6a497754f4b1f6a8e"
|
||||||
|
dependencies = [
|
||||||
|
"glob",
|
||||||
|
"serde",
|
||||||
|
"serde_derive",
|
||||||
|
"serde_json",
|
||||||
|
"target-triple",
|
||||||
|
"termcolor",
|
||||||
|
"toml",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "unicode-ident"
|
name = "unicode-ident"
|
||||||
version = "1.0.18"
|
version = "1.0.18"
|
||||||
@ -348,6 +385,15 @@ dependencies = [
|
|||||||
"wit-bindgen-rt",
|
"wit-bindgen-rt",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "winapi-util"
|
||||||
|
version = "0.1.9"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb"
|
||||||
|
dependencies = [
|
||||||
|
"windows-sys 0.59.0",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "windows-sys"
|
name = "windows-sys"
|
||||||
version = "0.59.0"
|
version = "0.59.0"
|
||||||
|
|||||||
@ -12,6 +12,7 @@ claims = "0.8"
|
|||||||
serde_json = "1.0"
|
serde_json = "1.0"
|
||||||
tempfile = "3.10"
|
tempfile = "3.10"
|
||||||
toml = "0.9"
|
toml = "0.9"
|
||||||
|
trybuild = "1.0"
|
||||||
|
|
||||||
[workspace.lints.clippy]
|
[workspace.lints.clippy]
|
||||||
pedantic = "warn"
|
pedantic = "warn"
|
||||||
|
|||||||
62
README.md
62
README.md
@ -5,7 +5,7 @@ Procedural macro to derive configuration from files, with optional merging capab
|
|||||||
## Features
|
## Features
|
||||||
|
|
||||||
- **Derive Configuration:** Easily load configuration from files into your Rust structs.
|
- **Derive Configuration:** Easily load configuration from files into your Rust structs.
|
||||||
- **Default Values:** Specify default values for struct fields using the `#[default = "..."]` attribute.
|
- **Default Values:** Specify default values for struct fields using the `#[from_file(default = "...")]` attribute.
|
||||||
- **Optional Merging:** When the `merge` feature is enabled, allows merging multiple configuration sources.
|
- **Optional Merging:** When the `merge` feature is enabled, allows merging multiple configuration sources.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@ -18,32 +18,58 @@ filecaster = "0.2"
|
|||||||
```rust
|
```rust
|
||||||
use filecaster::FromFile;
|
use filecaster::FromFile;
|
||||||
|
|
||||||
#[derive(Debug, Clone, FromFile)]
|
#[derive(Debug, Clone, PartialEq, FromFile)]
|
||||||
pub struct MyConfig {
|
struct AppConfig {
|
||||||
#[from_file(default = "localhost")]
|
/// If the user does not specify a host, use `"127.0.0.1"`.
|
||||||
pub host: String,
|
#[from_file(default = "127.0.0.1")]
|
||||||
|
host: String,
|
||||||
|
|
||||||
|
/// Port number; defaults to `8080`.
|
||||||
#[from_file(default = 8080)]
|
#[from_file(default = 8080)]
|
||||||
pub port: u16,
|
port: u16,
|
||||||
#[from_file(default = false)]
|
|
||||||
pub enabled: bool,
|
/// If not set, use `false`. Requires `bool: Default`.
|
||||||
|
auto_reload: bool,
|
||||||
}
|
}
|
||||||
|
|
||||||
fn main() {
|
fn main() {
|
||||||
// Simulate loading from a file (e.g., JSON, YAML, TOML)
|
// Simulate file content (e.g., from a JSON file)
|
||||||
let file_content = r#"
|
let file_content = r#"{ "host": "localhost", "port": 3000 }"#;
|
||||||
{
|
|
||||||
"host": "localhost"
|
|
||||||
}
|
|
||||||
"#;
|
|
||||||
|
|
||||||
let config_from_file: MyConfig = serde_json::from_str(file_content).unwrap();
|
// The `AppConfigFile` struct is automatically generated by `#[derive(FromFile)]`.
|
||||||
let config = MyConfig::from_file(Some(config_from_file));
|
// It has all fields as `Option<T>`.
|
||||||
|
let partial_config: AppConfigFile = serde_json::from_str(file_content).unwrap();
|
||||||
|
let partial_config2 = partial_config.clone();
|
||||||
|
|
||||||
println!("Config: {:?}", config);
|
// Use the generated `from_file` method to get the final config.
|
||||||
// Expected output: Config { host: "localhost", port: 8080, enabled: false }
|
// Default values are applied for missing fields.
|
||||||
|
let config = AppConfig::from_file(Some(partial_config));
|
||||||
|
// or
|
||||||
|
let config: AppConfig = partial_config2.into();
|
||||||
|
|
||||||
|
assert_eq!(config.host, "localhost");
|
||||||
|
assert_eq!(config.port, 3000);
|
||||||
|
assert_eq!(config.auto_reload, false); // `bool::default()` is `false`
|
||||||
|
|
||||||
|
println!("Final Config: {:#?}", config);
|
||||||
|
|
||||||
|
// Example with no file content (all defaults)
|
||||||
|
let default_config = AppConfig::from_file(None);
|
||||||
|
assert_eq!(default_config.host, "127.0.0.1");
|
||||||
|
assert_eq!(default_config.port, 8080);
|
||||||
|
assert_eq!(default_config.auto_reload, false);
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
Use `cargo run --example <example_name>` to execute a specific example. For example:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo run --example simple
|
||||||
|
cargo run --example nested
|
||||||
|
```
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
Full documentation is available at [docs.rs](https://docs.rs/filecaster).
|
Full documentation is available at [docs.rs](https://docs.rs/filecaster).
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "filecaster-derive"
|
name = "filecaster-derive"
|
||||||
version = "0.2.2"
|
version = "0.2.3"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
authors = ["Kristofers Solo <dev@kristofers.xyz>"]
|
authors = ["Kristofers Solo <dev@kristofers.xyz>"]
|
||||||
description = "Procedural derive macro for `filecaster`: automatically implement `FromFile` for your structs."
|
description = "Procedural derive macro for `filecaster`: automatically implement `FromFile` for your structs."
|
||||||
|
|||||||
@ -60,12 +60,14 @@ fn extract_named_fields(input: &DeriveInput) -> Result<&FieldsNamed> {
|
|||||||
Fields::Named(fields) => Ok(fields),
|
Fields::Named(fields) => Ok(fields),
|
||||||
_ => Err(Error::new_spanned(
|
_ => Err(Error::new_spanned(
|
||||||
&input.ident,
|
&input.ident,
|
||||||
"FromFile can only be derived for structs with named fields",
|
r#"FromFile only works on structs with *named* fields.
|
||||||
|
Tuple structs and unit structs are not supported."#,
|
||||||
)),
|
)),
|
||||||
},
|
},
|
||||||
_ => Err(Error::new_spanned(
|
_ => Err(Error::new_spanned(
|
||||||
&input.ident,
|
&input.ident,
|
||||||
"FromFile can only be derived for structs",
|
r#"FromFile only works on structs.
|
||||||
|
Enums are not supported."#,
|
||||||
)),
|
)),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -172,13 +174,13 @@ fn parse_default(list: &MetaList) -> Result<Option<Expr>> {
|
|||||||
let value = meta.value()?;
|
let value = meta.value()?;
|
||||||
let expr = value.parse::<Expr>()?;
|
let expr = value.parse::<Expr>()?;
|
||||||
|
|
||||||
if let Expr::Lit(expr_lit) = &expr {
|
if let Expr::Lit(expr_lit) = &expr
|
||||||
if let Lit::Str(lit_str) = &expr_lit.lit {
|
&& let Lit::Str(lit_str) = &expr_lit.lit
|
||||||
default_expr = Some(parse_quote! {
|
{
|
||||||
#lit_str.to_string()
|
default_expr = Some(parse_quote! {
|
||||||
});
|
#lit_str.to_string()
|
||||||
return Ok(());
|
});
|
||||||
}
|
return Ok(());
|
||||||
}
|
}
|
||||||
default_expr = Some(expr);
|
default_expr = Some(expr);
|
||||||
}
|
}
|
||||||
|
|||||||
@ -34,39 +34,38 @@
|
|||||||
//!
|
//!
|
||||||
//! ```rust
|
//! ```rust
|
||||||
//! use filecaster::FromFile;
|
//! use filecaster::FromFile;
|
||||||
//! use serde::{Deserialize, Serialize};
|
|
||||||
//!
|
//!
|
||||||
//! #[derive(Debug, Clone, PartialEq, FromFile, Serialize, Deserialize)]
|
//! #[derive(Debug, Clone, PartialEq, FromFile)]
|
||||||
//! struct AppConfig {
|
//! struct AppConfig {
|
||||||
//! /// If the user does not specify a host, use `"127.0.0.1"`.
|
//! /// If the user does not specify a host, use `"127.0.0.1"`.
|
||||||
//! #[from_file(default = "127.0.0.1")]
|
//! #[from_file(default = "127.0.0.1")]
|
||||||
//! host: String,
|
//! host: String,
|
||||||
//!
|
//!
|
||||||
//! /// Number of worker threads; defaults to `4`.
|
//! /// Port number; defaults to `8080`.
|
||||||
//! #[from_file(default = 4)]
|
//! #[from_file(default = 8080)]
|
||||||
//! workers: usize,
|
//! port: u16,
|
||||||
//!
|
//!
|
||||||
//! /// If not set, use `false`. Requires `bool: Default`.
|
//! /// If not set, use `false`. Requires `bool: Default`.
|
||||||
//! auto_reload: bool,
|
//! auto_reload: bool,
|
||||||
//! }
|
//! }
|
||||||
//!
|
//!
|
||||||
//! fn main() {
|
//! fn example() {
|
||||||
//! // Simulate file content (e.g., from a JSON file)
|
//! // Simulate file content (e.g., from a JSON file)
|
||||||
//! let file_content = r#"{
|
//! let file_content = r#"{ "host": "localhost", "port": 3000 }"#;
|
||||||
//! "host": "localhost",
|
|
||||||
//! "workers": 8
|
|
||||||
//! }"#;
|
|
||||||
//!
|
//!
|
||||||
//! // The `AppConfigFile` struct is automatically generated by `#[derive(FromFile)]`.
|
//! // The `AppConfigFile` struct is automatically generated by `#[derive(FromFile)]`.
|
||||||
//! // It has all fields as `Option<T>`.
|
//! // It has all fields as `Option<T>`.
|
||||||
//! let partial_config: AppConfigFile = serde_json::from_str(file_content).unwrap();
|
//! let partial_config: AppConfigFile = serde_json::from_str(file_content).unwrap();
|
||||||
|
//! let partial_config2 = partial_config.clone();
|
||||||
//!
|
//!
|
||||||
//! // Use the generated `from_file` method to get the final config.
|
//! // Use the generated `from_file` method to get the final config.
|
||||||
//! // Default values are applied for missing fields.
|
//! // Default values are applied for missing fields.
|
||||||
//! let config = AppConfig::from_file(Some(partial_config));
|
//! let config = AppConfig::from_file(Some(partial_config));
|
||||||
|
//! // or
|
||||||
|
//! let config: AppConfig = partial_config2.into();
|
||||||
//!
|
//!
|
||||||
//! assert_eq!(config.host, "localhost");
|
//! assert_eq!(config.host, "localhost");
|
||||||
//! assert_eq!(config.workers, 8);
|
//! assert_eq!(config.port, 3000);
|
||||||
//! assert_eq!(config.auto_reload, false); // `Default::default()` for bool is `false`
|
//! assert_eq!(config.auto_reload, false); // `Default::default()` for bool is `false`
|
||||||
//!
|
//!
|
||||||
//! println!("Final Config: {:#?}", config);
|
//! println!("Final Config: {:#?}", config);
|
||||||
@ -74,7 +73,7 @@
|
|||||||
//! // Example with no file content (all defaults)
|
//! // Example with no file content (all defaults)
|
||||||
//! let default_config = AppConfig::from_file(None);
|
//! let default_config = AppConfig::from_file(None);
|
||||||
//! assert_eq!(default_config.host, "127.0.0.1");
|
//! assert_eq!(default_config.host, "127.0.0.1");
|
||||||
//! assert_eq!(default_config.workers, 4);
|
//! assert_eq!(default_config.port, 8080);
|
||||||
//! assert_eq!(default_config.auto_reload, false);
|
//! assert_eq!(default_config.auto_reload, false);
|
||||||
//! }
|
//! }
|
||||||
//! ```
|
//! ```
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "filecaster"
|
name = "filecaster"
|
||||||
version = "0.2.2"
|
version = "0.2.3"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
authors = ["Kristofers Solo <dev@kristofers.xyz>"]
|
authors = ["Kristofers Solo <dev@kristofers.xyz>"]
|
||||||
description = "Procedural macro to derive configuration from files, with optional merging capabilities."
|
description = "Procedural macro to derive configuration from files, with optional merging capabilities."
|
||||||
@ -28,3 +28,4 @@ merge = { workspace = true, optional = true }
|
|||||||
serde_json.workspace = true
|
serde_json.workspace = true
|
||||||
tempfile.workspace = true
|
tempfile.workspace = true
|
||||||
toml.workspace = true
|
toml.workspace = true
|
||||||
|
trybuild.workspace = true
|
||||||
|
|||||||
7
filecaster/examples/data/nested.json
Normal file
7
filecaster/examples/data/nested.json
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
{
|
||||||
|
"key": "json key",
|
||||||
|
"number": 123,
|
||||||
|
"nested": {
|
||||||
|
"inner_number": 42
|
||||||
|
}
|
||||||
|
}
|
||||||
6
filecaster/examples/data/nested.toml
Normal file
6
filecaster/examples/data/nested.toml
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
key = "toml key"
|
||||||
|
number = 456
|
||||||
|
|
||||||
|
[nested]
|
||||||
|
inner_key = "inner toml key"
|
||||||
|
inner_number = 99
|
||||||
4
filecaster/examples/data/simple.json
Normal file
4
filecaster/examples/data/simple.json
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"key": "json key",
|
||||||
|
"number": 123
|
||||||
|
}
|
||||||
2
filecaster/examples/data/simple.toml
Normal file
2
filecaster/examples/data/simple.toml
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
number = 456
|
||||||
|
exists = true
|
||||||
59
filecaster/examples/nested.rs
Normal file
59
filecaster/examples/nested.rs
Normal file
@ -0,0 +1,59 @@
|
|||||||
|
use filecaster::FromFile;
|
||||||
|
use std::fs;
|
||||||
|
|
||||||
|
#[derive(Debug, FromFile)]
|
||||||
|
pub struct InnerData {
|
||||||
|
#[from_file(default = "inner default")]
|
||||||
|
pub inner_key: String,
|
||||||
|
#[from_file(default = 42)]
|
||||||
|
pub inner_number: i32,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, FromFile)]
|
||||||
|
pub struct MyData {
|
||||||
|
#[from_file(default = "default key")]
|
||||||
|
pub key: String,
|
||||||
|
#[from_file(default = 0)]
|
||||||
|
pub number: i32,
|
||||||
|
pub nested: InnerData,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
// Get the absolute current directory
|
||||||
|
let current_dir = std::env::current_dir().expect("Failed to get current directory");
|
||||||
|
// Path to the data directory
|
||||||
|
let data_dir = current_dir.join("filecaster/examples/data");
|
||||||
|
|
||||||
|
// Paths to JSON and TOML files
|
||||||
|
let json_path = data_dir.join("nested.json");
|
||||||
|
let toml_path = data_dir.join("nested.toml");
|
||||||
|
|
||||||
|
// Read and parse JSON file
|
||||||
|
let json_content = fs::read_to_string(&json_path)
|
||||||
|
.unwrap_or_else(|e| panic!("Failed to read JSON file at {:?}: {}", json_path, e));
|
||||||
|
let json_data: MyData = serde_json::from_str::<MyDataFile>(&json_content)
|
||||||
|
.unwrap_or_else(|e| panic!("Failed to parse JSON in {:?}: {}", json_path, e))
|
||||||
|
.into();
|
||||||
|
|
||||||
|
// Read and parse TOML file
|
||||||
|
let toml_content = fs::read_to_string(&toml_path)
|
||||||
|
.unwrap_or_else(|e| panic!("Failed to read TOML file at {:?}: {}", toml_path, e));
|
||||||
|
let toml_data: MyData = toml::from_str::<MyDataFile>(&toml_content)
|
||||||
|
.unwrap_or_else(|e| panic!("Failed to parse TOML in {:?}: {}", toml_path, e))
|
||||||
|
.into();
|
||||||
|
|
||||||
|
// Output the parsed data
|
||||||
|
dbg!(&json_data);
|
||||||
|
dbg!(&toml_data);
|
||||||
|
|
||||||
|
// Example assertions (adjust based on your actual file contents)
|
||||||
|
assert_eq!(json_data.key, "json key");
|
||||||
|
assert_eq!(json_data.number, 123);
|
||||||
|
assert_eq!(json_data.nested.inner_key, "inner default");
|
||||||
|
assert_eq!(json_data.nested.inner_number, 42);
|
||||||
|
|
||||||
|
assert_eq!(toml_data.key, "toml key");
|
||||||
|
assert_eq!(toml_data.number, 456);
|
||||||
|
assert_eq!(toml_data.nested.inner_key, "inner toml key");
|
||||||
|
assert_eq!(toml_data.nested.inner_number, 99);
|
||||||
|
}
|
||||||
48
filecaster/examples/simple.rs
Normal file
48
filecaster/examples/simple.rs
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
use filecaster::FromFile;
|
||||||
|
use std::fs;
|
||||||
|
|
||||||
|
#[derive(Debug, FromFile)]
|
||||||
|
pub struct MyData {
|
||||||
|
#[from_file(default = "default key")]
|
||||||
|
pub key: String,
|
||||||
|
pub number: i32,
|
||||||
|
pub exists: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn main() {
|
||||||
|
// Get the absolute current directory
|
||||||
|
let current_dir = std::env::current_dir().expect("Failed to get current directory");
|
||||||
|
// Path to the data directory
|
||||||
|
let data_dir = current_dir.join("filecaster/examples/data");
|
||||||
|
|
||||||
|
// Paths to JSON and TOML files
|
||||||
|
let json_path = data_dir.join("simple.json");
|
||||||
|
let toml_path = data_dir.join("simple.toml");
|
||||||
|
|
||||||
|
// Read and parse JSON file
|
||||||
|
let json_content = fs::read_to_string(&json_path)
|
||||||
|
.unwrap_or_else(|e| panic!("Failed to read JSON file at {:?}: {}", json_path, e));
|
||||||
|
let json_data: MyData = serde_json::from_str::<MyDataFile>(&json_content)
|
||||||
|
.unwrap_or_else(|e| panic!("Failed to parse JSON in {:?}: {}", json_path, e))
|
||||||
|
.into();
|
||||||
|
|
||||||
|
// Read and parse TOML file
|
||||||
|
let toml_content = fs::read_to_string(&toml_path)
|
||||||
|
.unwrap_or_else(|e| panic!("Failed to read TOML file at {:?}: {}", toml_path, e));
|
||||||
|
let toml_data: MyData = toml::from_str::<MyDataFile>(&toml_content)
|
||||||
|
.unwrap_or_else(|e| panic!("Failed to parse TOML in {:?}: {}", toml_path, e))
|
||||||
|
.into();
|
||||||
|
|
||||||
|
// Output the parsed data
|
||||||
|
dbg!(&json_data);
|
||||||
|
dbg!(&toml_data);
|
||||||
|
|
||||||
|
// Example assertions (adjust based on your actual file contents)
|
||||||
|
assert_eq!(json_data.key, "json key".to_string());
|
||||||
|
assert_eq!(json_data.number, 123);
|
||||||
|
assert!(!json_data.exists); // `bool::default()` is `false`
|
||||||
|
|
||||||
|
assert_eq!(toml_data.key, "default key".to_string());
|
||||||
|
assert_eq!(toml_data.number, 456);
|
||||||
|
assert!(toml_data.exists);
|
||||||
|
}
|
||||||
@ -40,7 +40,7 @@
|
|||||||
//! struct AppConfig {
|
//! struct AppConfig {
|
||||||
//! host: String,
|
//! host: String,
|
||||||
//! port: u16,
|
//! port: u16,
|
||||||
//! enabled: bool,
|
//! auto_reload: bool,
|
||||||
//! }
|
//! }
|
||||||
//!
|
//!
|
||||||
//! // The `Shadow` type is automatically generated by `filecaster-derive`
|
//! // The `Shadow` type is automatically generated by `filecaster-derive`
|
||||||
@ -49,12 +49,12 @@
|
|||||||
//! struct AppConfigFile {
|
//! struct AppConfigFile {
|
||||||
//! host: Option<String>,
|
//! host: Option<String>,
|
||||||
//! port: Option<u16>,
|
//! port: Option<u16>,
|
||||||
//! enabled: Option<bool>,
|
//! auto_reload: Option<bool>,
|
||||||
//! }
|
//! }
|
||||||
//!
|
//!
|
||||||
//! // The `FromFile` implementation is also automatically generated.
|
//! // The `FromFile` implementation is also automatically generated.
|
||||||
//! // For demonstration, here's a simplified manual implementation:
|
//! // For demonstration, here's a simplified manual implementation:
|
||||||
//! impl FromFile for AppConfig {
|
//! impl FromFile for AppConfig {
|
||||||
//! type Shadow = AppConfigFile;
|
//! type Shadow = AppConfigFile;
|
||||||
//!
|
//!
|
||||||
//! fn from_file(file: Option<Self::Shadow>) -> Self {
|
//! fn from_file(file: Option<Self::Shadow>) -> Self {
|
||||||
@ -62,12 +62,12 @@
|
|||||||
//! AppConfig {
|
//! AppConfig {
|
||||||
//! host: file.host.unwrap_or_else(|| "127.0.0.1".to_string()),
|
//! host: file.host.unwrap_or_else(|| "127.0.0.1".to_string()),
|
||||||
//! port: file.port.unwrap_or(8080),
|
//! port: file.port.unwrap_or(8080),
|
||||||
//! enabled: file.enabled.unwrap_or(true),
|
//! auto_reload: file.auto_reload.unwrap_or(true),
|
||||||
//! }
|
//! }
|
||||||
//! }
|
//! }
|
||||||
//! }
|
//! }
|
||||||
//!
|
//!
|
||||||
//! fn main() {
|
//! fn example() {
|
||||||
//! // Simulate deserializing from a file
|
//! // Simulate deserializing from a file
|
||||||
//! let file_content = r#"{ "host": "localhost", "port": 3000 }"#;
|
//! let file_content = r#"{ "host": "localhost", "port": 3000 }"#;
|
||||||
//! let partial_config: AppConfigFile = serde_json::from_str(file_content).unwrap();
|
//! let partial_config: AppConfigFile = serde_json::from_str(file_content).unwrap();
|
||||||
@ -77,9 +77,15 @@
|
|||||||
//!
|
//!
|
||||||
//! assert_eq!(config.host, "localhost");
|
//! assert_eq!(config.host, "localhost");
|
||||||
//! assert_eq!(config.port, 3000);
|
//! assert_eq!(config.port, 3000);
|
||||||
//! assert_eq!(config.enabled, true); // Default value applied
|
//! assert_eq!(config.auto_reload, false); // `Default::default()` for bool is `false`
|
||||||
//!
|
//!
|
||||||
//! println!("Final Config: {:?}", config);
|
//! println!("Final Config: {:#?}", config);
|
||||||
|
//!
|
||||||
|
//! // Example with no file content (all defaults)
|
||||||
|
//! let default_config = AppConfig::from_file(None);
|
||||||
|
//! assert_eq!(default_config.host, "127.0.0.1");
|
||||||
|
//! assert_eq!(default_config.port, 8080);
|
||||||
|
//! assert_eq!(default_config.auto_reload, false);
|
||||||
//! }
|
//! }
|
||||||
//! ```
|
//! ```
|
||||||
//!
|
//!
|
||||||
|
|||||||
7
filecaster/tests/ui.rs
Normal file
7
filecaster/tests/ui.rs
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
use trybuild::TestCases;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn ui() {
|
||||||
|
let t = TestCases::new();
|
||||||
|
t.compile_fail("tests/ui/*.rs");
|
||||||
|
}
|
||||||
9
filecaster/tests/ui/enum_not_supported.rs
Normal file
9
filecaster/tests/ui/enum_not_supported.rs
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
use filecaster::FromFile;
|
||||||
|
|
||||||
|
#[derive(FromFile)]
|
||||||
|
enum MyEnum {
|
||||||
|
A,
|
||||||
|
B,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn main() {}
|
||||||
6
filecaster/tests/ui/enum_not_supported.stderr
Normal file
6
filecaster/tests/ui/enum_not_supported.stderr
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
error: FromFile only works on structs.
|
||||||
|
Enums are not supported.
|
||||||
|
--> tests/ui/enum_not_supported.rs:4:6
|
||||||
|
|
|
||||||
|
4 | enum MyEnum {
|
||||||
|
| ^^^^^^
|
||||||
6
filecaster/tests/ui/tuple_struct_not_supported.rs
Normal file
6
filecaster/tests/ui/tuple_struct_not_supported.rs
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
use filecaster::FromFile;
|
||||||
|
|
||||||
|
#[derive(FromFile)]
|
||||||
|
struct MyTuple(i32, String);
|
||||||
|
|
||||||
|
fn main() {}
|
||||||
6
filecaster/tests/ui/tuple_struct_not_supported.stderr
Normal file
6
filecaster/tests/ui/tuple_struct_not_supported.stderr
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
error: FromFile only works on structs with *named* fields.
|
||||||
|
Tuple structs and unit structs are not supported.
|
||||||
|
--> tests/ui/tuple_struct_not_supported.rs:4:8
|
||||||
|
|
|
||||||
|
4 | struct MyTuple(i32, String);
|
||||||
|
| ^^^^^^^
|
||||||
Loading…
Reference in New Issue
Block a user