1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
//! This is a simple crate designed to prevent you from forgetting to `pop` off of a `PathBuf` upon exiting scope //! (i.e. at the end of a loop, when returning from a function, etc). This makes it easy to have multiple //! return points, as your context will automatically be restored upon `Drop`. //! //! This crate is not perfectly safe at the moment (it is "safe" in the Rust sense, but you can trigger //! undesired behavior when used improperly), but the basic functionality works. //! //! For more documentation, see the main feature of this package, [`CdManager`]. //! //! [`CdManager`]: ./CdManager.t.html #[macro_use] extern crate failure; use std::path::{Path, PathBuf}; use failure::Error; pub mod error; /// A "Change Directory" manager or `CdManager` prevents you from forgetting to pop /// directories at the end of a block. /// /// It takes a reference to a `PathBuf` and, upon going out of scope, will manually `pop` /// all elements of the `PathBuf` off that were added during its life. /// /// The only supported operations are `push` or `pop`, more complex operations such as /// cannot easily be managed. /// /// Note that the `CdManager` uses a path's `Components` to determine how many times /// to call `pop`, so this may cause some inconsistency if your path includes `.`. /// /// A `CdManager` implements `AsRef<Path>` so it may be used anywhere a `Path` is needed. #[derive(Debug)] pub struct CdManager<'a> { path: &'a mut PathBuf, added_depth: usize, } impl<'a> CdManager<'a> { /// Starts a new context from the given `PathBuf` pub fn new(path: &'a mut PathBuf) -> Self { CdManager { path, added_depth: 0, } } /// Pushes a [`Path`] onto the [`PathBuf`], to be undone when the /// [`CdManager`] goes out of scope. /// /// ``` /// extern crate cd_manager; /// use cd_manager::CdManager; /// use std::path::PathBuf; /// /// let mut path = PathBuf::from("a/path/to/something".to_string()); /// let mut p2 = path.clone(); /// /// { /// let mut manager = CdManager::new(&mut p2); /// /// path.push("foo/bar"); /// manager.push("foo/bar"); /// /// assert_eq!(path, manager); /// } // Automatically pop "foo" from the manager /// /// path.pop(); /// path.pop(); /// assert_eq!(path, p2); /// ``` /// /// [`Path`]: https://doc.rust-lang.org/std/path/struct.Path.html /// [`PathBuf`]: https://doc.rust-lang.org/std/path/struct.PathBuf.html /// [`CdManager`]: ./CdManager.t.html pub fn push<P: AsRef<Path>>(&mut self, path: P) { self.added_depth += path.as_ref().components().count(); self.path.push(path); } /// Pops a single link from the underlying [`PathBuf`]. /// This will return an error if this is identical to the /// [`PathBuf`] the [`CdManager`] was constructured with (that is, /// the number of `pop` calls matches the number of pushed [`Path`] components). /// /// ``` /// extern crate cd_manager; /// use cd_manager::CdManager; /// use std::path::PathBuf; /// /// let mut path = PathBuf::from("a/path".to_string()); /// let mut p2 = path.clone(); /// { /// let mut cd = CdManager::new(&mut p2); /// cd.push("foo"); /// /// cd.pop().unwrap(); /// assert_eq!(cd, path); /// /// assert!(cd.pop().is_err()); /// } /// /// assert_eq!(path, p2); /// ``` /// /// [`Path`]: https://doc.rust-lang.org/std/path/struct.Path.html /// [`PathBuf`]: https://doc.rust-lang.org/std/path/struct.PathBuf.html /// [`CdManager`]: ./CdManager.t.html pub fn pop(&mut self) -> Result<(), Error> { ensure!(self.added_depth > 0, error::TooManyPopError); self.added_depth -= 1; self.path.pop(); Ok(()) } /// Creates a new "layer" of the manager, for scoping purposes /// /// That is, if you call [`CdManager::layer`] in a loop body or function call, /// it ensures that any behavior done to the returned [`CdManager`] will be /// undone for you. /// /// You can think of this as a cheaper, scoped [`Clone`]. /// /// ``` /// extern crate cd_manager; /// use cd_manager::CdManager; /// use std::path::PathBuf; /// /// let mut path = PathBuf::from("a/path".to_string()); /// let mut p2 = path.clone(); /// /// let mut cd = CdManager::new(&mut p2); /// /// for _ in 0..100 { /// assert_eq!(cd, path); /// let mut cd = cd.layer(); /// cd.push("bar"); /// /// path.push("bar"); /// assert_eq!(cd, path); /// path.pop(); /// } /// ``` /// /// [`CdManager`]: ./CdManager.t.html /// [`CdManager::layer`]: ./CdManager.t.html#method.layer /// [`Clone`]: https://doc.rust-lang.org/std/clone/trait.Clone.html pub fn layer(&mut self) -> CdManager { CdManager::new(&mut self.path) } /// Returns a clone of the inner [`PathBuf`]. /// /// [`PathBuf`]: https://doc.rust-lang.org/std/path/struct.PathBuf.html pub fn clone_inner(&self) -> PathBuf { self.path.clone() } } impl<'a, P: AsRef<Path>> PartialEq<P> for CdManager<'a> { fn eq(&self, other: &P) -> bool { self.path.as_path() == other.as_ref() } } impl<'a> Eq for CdManager<'a> {} impl<'a> PartialEq<CdManager<'a>> for PathBuf { fn eq(&self, other: &CdManager) -> bool { self == other.path } } impl<'a> Drop for CdManager<'a> { fn drop(&mut self) { for _ in 0..self.added_depth { self.path.pop(); } } } impl<'a> AsRef<Path> for CdManager<'a> { fn as_ref(&self) -> &Path { self.path } } #[cfg(test)] mod test { use super::CdManager; use std::path::PathBuf; #[test] fn cd_manager_push() { let mut path = PathBuf::from("a/path/to/something".to_string()); let mut p2 = path.clone(); { let mut cd_manager = CdManager::new(&mut p2); cd_manager.push("abc/def"); path.push("abc/def"); assert_eq!(cd_manager.added_depth, 2); assert_eq!(path, cd_manager); path.pop(); path.pop(); } assert_eq!(p2, path); } #[test] fn cd_manager_pop() { let mut path = PathBuf::from("a/path/to/something".to_string()); let mut p2 = path.clone(); { let mut cd_manager = CdManager::new(&mut p2); cd_manager.push("abc/def"); path.push("abc/def"); cd_manager.pop().unwrap(); path.pop(); assert_eq!(path, cd_manager); assert_eq!(cd_manager.added_depth, 1); path.pop(); } assert_eq!(p2, path); } #[test] fn cd_manager_error() { let mut path = PathBuf::from("a/path/to/something".to_string()); let mut cd_manager = CdManager::new(&mut path); assert!(cd_manager.pop().is_err()); } }