feat: add custom env name for variables

This commit is contained in:
Dmitriy Pleshevskiy 2019-12-26 08:26:27 +03:00
parent 99244a01cb
commit ca44b3a85d
5 changed files with 99 additions and 9 deletions

View file

@ -12,22 +12,28 @@ We recommend you start with the [documentation].
```rust ```rust
#[macro_use] extern crate itconfig; #[macro_use] extern crate itconfig;
use dotenv::dotenv; use std::env;
//use dotenv::dotenv;
config! { config! {
DEBUG: bool => true, DEBUG: bool => true,
HOST: String => "127.0.0.1".to_string(), HOST: String => "127.0.0.1".to_string(),
NAMESPACE { NAMESPACE {
FOO: bool => true, #[env_name = "MY_CUSTOM_NAME"]
FOO: bool,
BAR: i32 => 10, BAR: i32 => 10,
} }
} }
fn main () { fn main () {
dotenv().ok(); // dotenv().ok();
env::set_var("MY_CUSTOM_NAME", "t");
cfg::init(); cfg::init();
assert_eq(cfg::HOST(), String::from("127.0.0.1")); assert_eq(cfg::HOST(), String::from("127.0.0.1"));
assert_eq(cfg::NAMESPACE::FOO(), true);
} }
``` ```
@ -41,7 +47,7 @@ cargo test
## Roadmap ## Roadmap
* [x] Add namespace for variables * [x] Add namespace for variables
* [ ] Custom env name * [x] Custom env name
* [ ] Add if condition for feature variables * [ ] Add if condition for feature variables

View file

@ -1,6 +1,6 @@
[package] [package]
name = "itconfig" name = "itconfig"
version = "0.3.0" version = "0.4.0"
authors = ["Dmitriy Pleshevskiy <dmitriy@ideascup.me>"] authors = ["Dmitriy Pleshevskiy <dmitriy@ideascup.me>"]
description = "Easy build a configs from environment variables and use it in globally." description = "Easy build a configs from environment variables and use it in globally."
categories = ["config", "web-programming"] categories = ["config", "web-programming"]

View file

@ -9,22 +9,28 @@ We recommend you start with the [documentation].
```rust ```rust
#[macro_use] extern crate itconfig; #[macro_use] extern crate itconfig;
// use dotenv::dotenv; use std::env;
//use dotenv::dotenv;
config! { config! {
DEBUG: bool => true, DEBUG: bool => true,
HOST: String => "127.0.0.1".to_string(), HOST: String => "127.0.0.1".to_string(),
NAMESPACE { NAMESPACE {
FOO: bool => true, #[env_name = "MY_CUSTOM_NAME"]
FOO: bool,
BAR: i32 => 10, BAR: i32 => 10,
} }
} }
fn main () { fn main () {
// dotenv().ok(); // dotenv().ok();
env::set_var("MY_CUSTOM_NAME", "t");
cfg::init(); cfg::init();
assert_eq(cfg::HOST(), String::from("127.0.0.1")); assert_eq(cfg::HOST(), String::from("127.0.0.1"));
assert_eq(cfg::NAMESPACE::FOO(), true);
} }
``` ```
@ -32,7 +38,7 @@ fn main () {
## Roadmap ## Roadmap
* [x] Add namespace for variables * [x] Add namespace for variables
* [ ] Custom env name * [x] Custom env name
* [ ] Add if condition for feature variables * [ ] Add if condition for feature variables

View file

@ -7,6 +7,7 @@
//! //!
//! ```rust //! ```rust
//! #[macro_use] extern crate itconfig; //! #[macro_use] extern crate itconfig;
//! use std::env;
//! // use dotenv::dotenv; //! // use dotenv::dotenv;
//! //!
//! config! { //! config! {
@ -14,15 +15,20 @@
//! HOST: String => "127.0.0.1".to_string(), //! HOST: String => "127.0.0.1".to_string(),
//! //!
//! NAMESPACE { //! NAMESPACE {
//! FOO: bool => true, //! #[env_name = "MY_CUSTOM_NAME"]
//! FOO: bool,
//!
//! BAR: i32 => 10, //! BAR: i32 => 10,
//! } //! }
//! } //! }
//! //!
//! fn main () { //! fn main () {
//! // dotenv().ok(); //! // dotenv().ok();
//! env::set_var("MY_CUSTOM_NAME", "t");
//!
//! cfg::init(); //! cfg::init();
//! assert_eq!(cfg::HOST(), String::from("127.0.0.1")); //! assert_eq!(cfg::HOST(), String::from("127.0.0.1"));
//! assert_eq!(cfg::NAMESPACE::FOO(), true);
//! } //! }
//! ``` //! ```
@ -142,6 +148,30 @@ impl From<EnvValue> for String {
/// # cfg::init() /// # cfg::init()
/// ``` /// ```
/// ///
/// If you want to read custom env name for variable you can change it manually.
///
/// **A variable in the nameespace will lose environment prefix**
///
/// ```rust
/// # #[macro_use] extern crate itconfig;
/// # use std::env;
/// env::set_var("MY_CUSTOM_NAME", "95");
///
/// config! {
/// #[env_name = "MY_CUSTOM_NAME"]
/// PER_PAGE: i32,
///
/// APP {
/// #[env_name = "MY_CUSTOM_NAME"]
/// RECIPES_PER_PAGE: i32,
/// }
/// }
///
/// cfg::init();
/// assert_eq!(cfg::PER_PAGE(), 95);
/// assert_eq!(cfg::APP::RECIPES_PER_PAGE(), 95);
/// ```
///
/// ///
/// This module will also contain helper method: /// This module will also contain helper method:
/// ///
@ -257,6 +287,7 @@ macro_rules! __itconfig_parse_variables {
// Find variable with default value // Find variable with default value
( (
tokens = [ tokens = [
$(#$meta:tt)*
$name:ident : $ty:ty => $default:expr, $name:ident : $ty:ty => $default:expr,
$($rest:tt)* $($rest:tt)*
], ],
@ -264,6 +295,7 @@ macro_rules! __itconfig_parse_variables {
) => { ) => {
__itconfig_parse_variables! { __itconfig_parse_variables! {
current_variable = { current_variable = {
unparsed_meta = [$(#$meta)*],
name = $name, name = $name,
ty = $ty, ty = $ty,
default = $default, default = $default,
@ -276,6 +308,7 @@ macro_rules! __itconfig_parse_variables {
// Find variable without default value // Find variable without default value
( (
tokens = [ tokens = [
$(#$meta:tt)*
$name:ident : $ty:ty, $name:ident : $ty:ty,
$($rest:tt)* $($rest:tt)*
], ],
@ -283,6 +316,7 @@ macro_rules! __itconfig_parse_variables {
) => { ) => {
__itconfig_parse_variables! { __itconfig_parse_variables! {
current_variable = { current_variable = {
unparsed_meta = [$(#$meta)*],
name = $name, name = $name,
ty = $ty, ty = $ty,
}, },
@ -291,9 +325,32 @@ macro_rules! __itconfig_parse_variables {
} }
}; };
(
current_variable = {
unparsed_meta = [
#[env_name = $env_name:expr]
$($meta:tt)*
],
name = $name:ident,
$($current_variable:tt)*
},
$($args:tt)*
) => {
__itconfig_parse_variables! {
current_variable = {
unparsed_meta = [$($meta)*],
name = $name,
env_name = $env_name,
$($current_variable)*
},
$($args)*
}
};
// Done parsing variable // Done parsing variable
( (
current_variable = { current_variable = {
unparsed_meta = [],
$($current_variable:tt)* $($current_variable:tt)*
}, },
tokens = $tokens:tt, tokens = $tokens:tt,

View file

@ -197,3 +197,24 @@ fn configuration_variables_and_namespace_in_lowercase() {
env::remove_var("TESTING"); env::remove_var("TESTING");
env::remove_var("NAMESPACE_FOO"); env::remove_var("NAMESPACE_FOO");
} }
#[test]
fn custom_environment_name_for_variable() {
env::set_var("MY_CUSTOM_NAME", "95");
config! {
#[env_name = "MY_CUSTOM_NAME"]
PER_PAGE: i32,
APP {
#[env_name = "MY_CUSTOM_NAME"]
RECIPES_PER_PAGE: i32,
}
}
cfg::init();
assert_eq!(cfg::PER_PAGE(), 95);
assert_eq!(cfg::APP::RECIPES_PER_PAGE(), 95);
env::remove_var("MY_CUSTOM_NAME");
}