Moves a bunch of libraries to traits

src/static_data/libraries/nature_library.rs

@@ -1,38 +1,51 @@
 use crate::static_data::Nature;
 use crate::{StringKey, ValueIdentifiable, ValueIdentifier};
 use hashbrown::HashMap;
+use std::fmt::Debug;
 use std::sync::Arc;
 
+/// A library of all natures that can be used, stored by their names.
+pub trait NatureLibrary: Debug + ValueIdentifiable {
+    /// Adds a new nature with name to the library.
+    fn load_nature(&mut self, name: StringKey, nature: Arc<dyn Nature>);
+    /// Gets a nature by name.
+    fn get_nature(&self, key: &StringKey) -> Option<Arc<dyn Nature>>;
+    /// Finds a nature name by nature.
+    fn get_nature_name(&self, nature: &Arc<dyn Nature>) -> StringKey;
+}
+
 /// A library of all natures that can be used, stored by their names.
 #[derive(Debug)]
-pub struct NatureLibrary {
+pub struct NatureLibraryImpl {
     /// A unique identifier so we know what value this is.
     identifier: ValueIdentifier,
     /// The underlying data structure.
     map: HashMap<StringKey, Arc<dyn Nature>>,
 }
 
-impl NatureLibrary {
+impl NatureLibraryImpl {
     /// Creates a new nature library with a given capacity.
     pub fn new(capacity: usize) -> Self {
-        NatureLibrary {
+        Self {
             identifier: Default::default(),
             map: HashMap::with_capacity(capacity),
         }
     }
+}
 
+impl NatureLibrary for NatureLibraryImpl {
     /// Adds a new nature with name to the library.
-    pub fn load_nature(&mut self, name: StringKey, nature: Arc<dyn Nature>) {
+    fn load_nature(&mut self, name: StringKey, nature: Arc<dyn Nature>) {
         self.map.insert(name, nature);
     }
 
     /// Gets a nature by name.
-    pub fn get_nature(&self, key: &StringKey) -> Option<&Arc<dyn Nature>> {
-        self.map.get(key)
+    fn get_nature(&self, key: &StringKey) -> Option<Arc<dyn Nature>> {
+        self.map.get(key).cloned()
     }
 
     /// Finds a nature name by nature.
-    pub fn get_nature_name(&self, nature: &Arc<dyn Nature>) -> StringKey {
+    fn get_nature_name(&self, nature: &Arc<dyn Nature>) -> StringKey {
         for kv in &self.map {
             // As natures can't be copied, and should always be the same reference as the value
             // in the map, we just compare by reference.
@@ -44,7 +57,7 @@ impl NatureLibrary {
     }
 }
 
-impl ValueIdentifiable for NatureLibrary {
+impl ValueIdentifiable for NatureLibraryImpl {
     fn value_identifier(&self) -> ValueIdentifier {
         self.identifier
     }
@@ -52,11 +65,12 @@ impl ValueIdentifiable for NatureLibrary {
 
 #[cfg(test)]
 pub mod tests {
+    use super::*;
     use crate::static_data::statistics::Statistic;
-    use crate::static_data::{NatureImpl, NatureLibrary};
+    use crate::static_data::{NatureImpl, NatureLibrary, NatureLibraryImpl};
 
-    pub fn build() -> NatureLibrary {
-        let mut lib = NatureLibrary::new(2);
+    pub fn build() -> NatureLibraryImpl {
+        let mut lib = NatureLibraryImpl::new(2);
 
         lib.load_nature(
             "test_nature".into(),
@@ -66,9 +80,24 @@ pub mod tests {
         lib
     }
 
+    mockall::mock! {
+        #[derive(Debug)]
+        pub NatureLibrary{}
+        impl NatureLibrary for NatureLibrary {
+            fn load_nature(&mut self, name: StringKey, nature: Arc<dyn Nature>);
+            fn get_nature(&self, key: &StringKey) -> Option<Arc<dyn Nature>>;
+            fn get_nature_name(&self, nature: &Arc<dyn Nature>) -> StringKey;
+        }
+        impl ValueIdentifiable for NatureLibrary {
+            fn value_identifier(&self) -> ValueIdentifier{
+                ValueIdentifier::new(0)
+            }
+        }
+    }
+
     #[test]
     fn create_nature_library_insert_and_retrieve() {
-        let mut lib = NatureLibrary::new(2);
+        let mut lib = NatureLibraryImpl::new(2);
         lib.load_nature(
             "foo".into(),
             NatureImpl::new(Statistic::HP, Statistic::Attack, 1.1, 0.9),
@@ -86,7 +115,7 @@ pub mod tests {
 
     #[test]
     fn create_nature_library_insert_and_get_name() {
-        let mut lib = NatureLibrary::new(2);
+        let mut lib = NatureLibraryImpl::new(2);
         lib.load_nature(
             "foo".into(),
             NatureImpl::new(Statistic::HP, Statistic::Attack, 1.1, 0.9),
@@ -97,10 +126,10 @@ pub mod tests {
         );
 
         let n1 = lib.get_nature(&"foo".into()).expect("Nature was not found");
-        let name = lib.get_nature_name(n1);
+        let name = lib.get_nature_name(&n1);
         assert_eq!(name, "foo".into());
         let n2 = lib.get_nature(&"bar".into()).expect("Nature was not found");
-        let name2 = lib.get_nature_name(n2);
+        let name2 = lib.get_nature_name(&n2);
         assert_eq!(name2, "bar".into());
     }
 }