splinter 0.6.14

// Copyright 2018-2022 Cargill Incorporated
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! A data structure for reference counting a set of strings.
//!
//! An item can be added to `RefMap` with `add_ref`; each call to `add_ref` will increment the
//! internal reference count associated with the given `ref_id`. When `remove_ref` is called, the
//! reference count is decremented. If a reference count reaches zero, then the item is removed.

use std::borrow::Borrow;
use std::collections::HashMap;
use std::hash::Hash;

use super::error::RefMapRemoveError;

/// A map that will keep track of the number of times an ID has been added, and only remove the ID
/// once the reference count is 0.
pub struct RefMap<K: Hash + Eq> {
    // ID to reference count
    references: HashMap<K, u64>,
}

impl<K: Hash + Eq> RefMap<K> {
    /// Create a new `RefMap`
    pub fn new() -> Self {
        RefMap {
            references: HashMap::new(),
        }
    }

    /// Increments the reference count for `ref_id`
    ///
    /// If `ref_id` does not already exit, it will be added.
    pub fn add_ref(&mut self, ref_id: K) -> u64 {
        if let Some(ref_count) = self.references.remove(&ref_id) {
            let new_ref_count = ref_count + 1;
            self.references.insert(ref_id, new_ref_count);
            new_ref_count
        } else {
            self.references.insert(ref_id, 1);
            1
        }
    }

    /// Decrements the referece count for `ref_id`
    ///
    /// If the internal reference count reaches zero, then `ref_id` will be removed.
    pub fn remove_ref<Q: ?Sized>(&mut self, ref_id: &Q) -> Result<Option<K>, RefMapRemoveError>
    where
        K: Borrow<Q>,
        Q: Hash + Eq,
    {
        let (key, ref_count) = match self.references.remove_entry(ref_id) {
            Some((key, ref_count)) => (key, ref_count),
            None => {
                return Err(RefMapRemoveError(
                    "Trying to remove a reference that does not exist".into(),
                ))
            }
        };

        if ref_count == 1 {
            Ok(Some(key))
        } else {
            self.references.insert(key, ref_count - 1);
            Ok(None)
        }
    }
}

#[cfg(test)]
pub mod tests {
    use super::*;

    // Test that the reference count is set to 1 if the ID is new. If the same ID is added, the
    // reference count is incremented again.
    #[test]
    fn test_add_ref() {
        let mut ref_map = RefMap::new();
        let ref_count = ref_map.add_ref("test_id".to_string());
        assert_eq!(ref_count, 1);

        let ref_count = ref_map.add_ref("test_id".to_string());
        assert_eq!(ref_count, 2);

        let ref_count = ref_map.add_ref("test_id_2".to_string());
        assert_eq!(ref_count, 1);
    }

    // Test that when removing a reference, if the reference count is greater than 1, the reference
    // count is decremented and `None` is retured to notify that caller that the reference has not
    // been fully removed.
    //
    // Then test that if the reference count is 1, the reference is removed and the ID is retured
    // to tell the caller the reference has been removed.
    #[test]
    fn test_remove_ref() {
        let mut ref_map = RefMap::new();
        let ref_count = ref_map.add_ref("test_id".to_string());
        assert_eq!(ref_count, 1);

        let ref_count = ref_map.add_ref("test_id".to_string());
        assert_eq!(ref_count, 2);

        let id = ref_map.remove_ref("test_id");
        assert_eq!(id, Ok(None));

        assert_eq!(ref_map.references.get("test_id").cloned(), Some(1 as u64));

        let id = ref_map.remove_ref("test_id");
        assert_eq!(id, Ok(Some("test_id".to_string())));
        assert_eq!(ref_map.references.get("test_id"), None);
    }

    // Test that if `remove_ref` is called with a reference does not exist, an error is returned.
    #[test]
    fn test_remove_ref_err() {
        let mut ref_map: RefMap<String> = RefMap::new();
        if let Ok(_) = ref_map.remove_ref("test_id") {
            panic!("remove_ref should have returned an error");
        }
    }
}