Merge pull request #45 from twihno/master

Migrate to syn v2

Author: greyblake

Cargo.toml

@@ -1,6 +1,12 @@
 [workspace]
-members = [
-    "envconfig",
-    "envconfig_derive",
-    "test_suite"
-]
+resolver = "2"
+members = ["envconfig", "envconfig_derive", "test_suite"]
+
+[workspace.package]
+edition = "2021"
+
+[workspace.lints.rust]
+unsafe_code = "forbid"
+
+[workspace.lints.clippy]
+pedantic = "warn"

envconfig/Cargo.toml

@@ -7,12 +7,11 @@ categories = ["config", "web-programming"]
 keywords = ["config", "env", "macro", "configuration", "environment"]
 license = "MIT"
 repository = "https://github.com/greyblake/envconfig-rs"
-homepage = "https://github.com/greyblake/envconfig-rs"
-documentation = "https://docs.rs/envconfig"
 readme = "README.md"
-edition = "2018"
+edition.workspace = true
 
-[dev-dependencies]
+[lints]
+workspace = true
 
 [dependencies]
 envconfig_derive = { version = "0.10.0", path = "../envconfig_derive" }

envconfig/src/error.rs

@@ -1,5 +1,6 @@
-use std::error::Error as StdError;
-use std::fmt;
+//! Errors resulting from calling functions in this crate
+
+use std::{error::Error as StdError, fmt};
 
 /// Represents an error, that may be returned by `fn init_from_env()` of trait `Envconfig`.
 #[derive(Debug, PartialEq)]
@@ -11,9 +12,11 @@ pub enum Error {
 impl fmt::Display for Error {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match self {
-            Error::EnvVarMissing { name } => write!(f, "Environment variable {} is missing", name),
+            Error::EnvVarMissing { name } => {
+                write!(f, "Environment variable {name} is missing")
+            }
             Error::ParseError { name } => {
-                write!(f, "Failed to parse environment variable {}", name)
+                write!(f, "Failed to parse environment variable {name}")
             }
         }
     }

envconfig/src/lib.rs

@@ -25,7 +25,7 @@
 //! env::set_var("DB_PORT", "5432");
 //!
 //! // Initialize config from environment variables
-//! let config = Config::init().unwrap();
+//! let config = Config::init_from_env().unwrap();
 //!
 //! assert_eq!(config.db_host, "localhost");
 //! assert_eq!(config.db_port, Some(5432));

envconfig/src/traits.rs

@@ -4,7 +4,11 @@ use std::collections::HashMap;
 /// Indicates that structure can be initialize from environment variables.
 pub trait Envconfig {
     /// Initialize structure from environment variables.
-    /// Deprecated in favor of init_from_env().
+    /// Deprecated in favor of [`::init_from_env()`].
+    ///
+    /// # Errors
+    /// - Environment variable is missing.
+    /// - Failed to parse environment variable.
     #[deprecated(
         since = "0.9.0",
         note = "Function init() is deprecated. Please use init_from_env() instead."
@@ -14,11 +18,19 @@ pub trait Envconfig {
         Self: Sized;
 
     /// Initialize structure from environment variables.
+    ///
+    /// # Errors
+    /// - Environment variable is missing.
+    /// - Failed to parse environment variable.
     fn init_from_env() -> Result<Self, Error>
     where
         Self: Sized;
 
     /// Initialize structure from a hashmap.
+    ///
+    /// # Errors
+    /// - Environment variable is missing.
+    /// - Failed to parse environment variable.
     fn init_from_hashmap(hashmap: &HashMap<String, String>) -> Result<Self, Error>
     where
         Self: Sized;

envconfig/src/utils.rs

@@ -4,19 +4,20 @@ use std::str::FromStr;
 use crate::error::Error;
 use std::collections::HashMap;
 
-/// Load a nenvironment variable by name and parse it into type `T`.
-/// The function is used by `envconfig_derive` to implement `init()`.
+/// Load an environment variable by name and parse it into type `T`.
 ///
-/// It returns `Error` in the following cases:
+/// This function can also use a hashmap as a fallback or for testing purposes.
+///
+/// # Errors
 /// - Environment variable is not present
 /// - Parsing failed
-pub fn load_var<T: FromStr>(
+pub fn load_var<T: FromStr, S: ::std::hash::BuildHasher>(
     var_name: &'static str,
-    hashmap: Option<&HashMap<String, String>>,
+    hashmap: Option<&HashMap<String, String, S>>,
 ) -> Result<T, Error> {
     match hashmap {
         None => env::var(var_name).ok(),
-        Some(hashmap) => hashmap.get(var_name).map(|val| val.to_string()),
+        Some(hashmap) => hashmap.get(var_name).map(std::string::ToString::to_string),
     }
     .ok_or(Error::EnvVarMissing { name: var_name })
     .and_then(|string_value| {
@@ -26,14 +27,21 @@ pub fn load_var<T: FromStr>(
     })
 }
 
-pub fn load_var_with_default<T: FromStr>(
+/// Tries to load an environment variable by name and parse it into type `T`.
+/// If the environment variable is not present, it returns a default value.
+///
+/// This function can also use a hashmap as a fallback or for testing purposes.
+///
+/// # Errors
+/// - Parsing failed
+pub fn load_var_with_default<T: FromStr, S: ::std::hash::BuildHasher>(
     var_name: &'static str,
-    hashmap: Option<&HashMap<String, String>>,
+    hashmap: Option<&HashMap<String, String, S>>,
     default: &'static str,
 ) -> Result<T, Error> {
     let opt_var = match hashmap {
         None => env::var(var_name).ok(),
-        Some(hashmap) => hashmap.get(var_name).map(|val| val.to_string()),
+        Some(hashmap) => hashmap.get(var_name).map(std::string::ToString::to_string),
     };
 
     let string_value = match opt_var {
@@ -46,13 +54,20 @@ pub fn load_var_with_default<T: FromStr>(
         .map_err(|_| Error::ParseError { name: var_name })
 }
 
-pub fn load_optional_var<T: FromStr>(
+/// Tries to load an environment variable by name and parse it into type `T`.
+/// If the environment variable is not present, it returns `None`.
+///
+/// This function can also use a hashmap as a fallback or for testing purposes.
+///
+/// # Errors
+/// - Parsing failed
+pub fn load_optional_var<T: FromStr, S: ::std::hash::BuildHasher>(
     var_name: &'static str,
-    hashmap: Option<&HashMap<String, String>>,
+    hashmap: Option<&HashMap<String, String, S>>,
 ) -> Result<Option<T>, Error> {
     let opt_var = match hashmap {
         None => env::var(var_name).ok(),
-        Some(hashmap) => hashmap.get(var_name).map(|val| val.to_string()),
+        Some(hashmap) => hashmap.get(var_name).map(std::string::ToString::to_string),
     };
 
     match opt_var {

envconfig_derive/Cargo.toml

@@ -7,15 +7,16 @@ categories = ["config", "web-programming"]
 keywords = ["config", "env", "macro", "configuration", "environment"]
 license = "MIT"
 repository = "https://github.com/greyblake/envconfig-rs"
-homepage = "https://github.com/greyblake/envconfig-rs"
-documentation = "https://docs.rs/envconfig_derive"
 readme = "README.md"
-edition = "2018"
+edition.workspace = true
+
+[lints]
+workspace = true
 
 [lib]
 proc-macro = true
 
 [dependencies]
-syn = "1.0.17"
-quote = "1.0.3"
-proc-macro2 = "1.0.9"
+syn = { version = "2.0.77", features = ["parsing", "derive"] }
+quote = { version = "1.0.37", features = [] }
+proc-macro2 = { version = "1.0.86", features = [] }