add docs and inherit

Signed-off-by: Freyskeyd <[email protected]>

Author: Freyskeyd

src/environment.rs

@@ -1,7 +1,9 @@
-#![allow(missing_docs)]
+/// Structure to deal with environment variables
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct Environment {
+    /// Customized environment variables
     pub vars: Vec<(String, String)>,
+    /// Define if the structure must inherit
     pub inherit: bool,
 }
 
@@ -15,22 +17,58 @@ impl Default for Environment {
 }
 
 impl Environment {
+    /// Create a new Environment object with inherit
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// extern crate assert_cli;
+    ///
+    /// let e = assert_cli::Environment::inherit().compile();
+    /// let e_ = ::std::env::vars();
+    ///
+    /// assert_eq!(e, e_);
+    /// ```
     pub fn inherit() -> Self {
         Self {
             vars: vec![],
             inherit: true,
         }
     }
 
+    /// Create a new Environment object without inheriting
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// extern crate assert_cli;
+    ///
+    /// let e = assert_cli::Environment::empty().compile();
+    /// assert_eq!(e, Vec::new());
+    /// ```
     pub fn empty() -> Self {
         Self::default()
     }
 
-    // Since this is meant to act like a map, calling it `insert`
+    /// Insert a new entry into the custom variables for this environment object
+    ///
+    /// # Examples
+    ///
+    /// ```rust
+    /// extern crate assert_cli;
+    ///
+    /// let e = assert_cli::Environment::empty().insert("boo", "bar").compile();
+    /// assert_eq!(e, vec![("foo", "bar")];
+    /// ```
     pub fn insert<S1: Into<String>, S2: Into<String>>(mut self, key: S1, val: S2) -> Self {
         self.vars.push((key.into(), val.into()));
         self
     }
+
+    /// Compile Environment object
+    pub fn compile(&self) -> Vec<(String, String)> {
+        ::std::env::vars().chain(self.vars.clone()).collect()
+    }
 }
 
 /// Implicit clone for ergonomics
@@ -40,23 +78,23 @@ impl<'a> From<&'a Environment> for Environment {
     }
 }
 
-pub trait FooIterItem {
-    fn to_tuple(&self) -> (String, String);
+pub trait EnvironmentItem {
+    fn to_environment_tuple(&self) -> (String, String);
 }
 
-impl<'s, T: ToString, Z:ToString> FooIterItem for &'s (T, Z) {
-    fn to_tuple(&self) -> (String, String) {
+impl<'s, T: ToString, Z:ToString> EnvironmentItem for &'s (T, Z) {
+    fn to_environment_tuple(&self) -> (String, String) {
         (self.0.to_string(), self.1.to_string())
     }
 }
 
 impl<'s, T> From<T> for Environment
-    where T: IntoIterator, T::Item: FooIterItem
+    where T: IntoIterator, T::Item: EnvironmentItem
 {
     fn from(v: T) -> Self {
         Self {
             vars: v.into_iter()
-                .map(|k| k.to_tuple())
+                .map(|k| k.to_environment_tuple())
                 .collect(),
             inherit: false,
         }