refactor: [#1002] rename is_good fn to meets_retaining_policy

A "good" torrent means it should be retained in the repository according
to the tracker policy. It should not be removed (even if it does not
have any peers).

Author: josecelano

packages/torrent-repository/src/entry/mod.rs

@@ -22,7 +22,7 @@ pub trait Entry {
     fn get_swarm_metadata(&self) -> SwarmMetadata;
 
     /// Returns True if Still a Valid Entry according to the Tracker Policy
-    fn is_good(&self, policy: &TrackerPolicy) -> bool;
+    fn meets_retaining_policy(&self, policy: &TrackerPolicy) -> bool;
 
     /// Returns True if the Peers is Empty
     fn peers_is_empty(&self) -> bool;
@@ -53,7 +53,7 @@ pub trait Entry {
 #[allow(clippy::module_name_repetitions)]
 pub trait EntrySync {
     fn get_swarm_metadata(&self) -> SwarmMetadata;
-    fn is_good(&self, policy: &TrackerPolicy) -> bool;
+    fn meets_retaining_policy(&self, policy: &TrackerPolicy) -> bool;
     fn peers_is_empty(&self) -> bool;
     fn get_peers_len(&self) -> usize;
     fn get_peers(&self, limit: Option<usize>) -> Vec<Arc<peer::Peer>>;
@@ -65,7 +65,7 @@ pub trait EntrySync {
 #[allow(clippy::module_name_repetitions)]
 pub trait EntryAsync {
     fn get_swarm_metadata(&self) -> impl std::future::Future<Output = SwarmMetadata> + Send;
-    fn check_good(self, policy: &TrackerPolicy) -> impl std::future::Future<Output = bool> + Send;
+    fn meets_retaining_policy(self, policy: &TrackerPolicy) -> impl std::future::Future<Output = bool> + Send;
     fn peers_is_empty(&self) -> impl std::future::Future<Output = bool> + Send;
     fn get_peers_len(&self) -> impl std::future::Future<Output = usize> + Send;
     fn get_peers(&self, limit: Option<usize>) -> impl std::future::Future<Output = Vec<Arc<peer::Peer>>> + Send;

packages/torrent-repository/src/entry/mutex_parking_lot.rs

@@ -13,8 +13,8 @@ impl EntrySync for EntryMutexParkingLot {
         self.lock().get_swarm_metadata()
     }
 
-    fn is_good(&self, policy: &TrackerPolicy) -> bool {
-        self.lock().is_good(policy)
+    fn meets_retaining_policy(&self, policy: &TrackerPolicy) -> bool {
+        self.lock().meets_retaining_policy(policy)
     }
 
     fn peers_is_empty(&self) -> bool {

packages/torrent-repository/src/entry/mutex_std.rs

@@ -13,8 +13,8 @@ impl EntrySync for EntryMutexStd {
         self.lock().expect("it should get a lock").get_swarm_metadata()
     }
 
-    fn is_good(&self, policy: &TrackerPolicy) -> bool {
-        self.lock().expect("it should get a lock").is_good(policy)
+    fn meets_retaining_policy(&self, policy: &TrackerPolicy) -> bool {
+        self.lock().expect("it should get a lock").meets_retaining_policy(policy)
     }
 
     fn peers_is_empty(&self) -> bool {

packages/torrent-repository/src/entry/mutex_tokio.rs

@@ -13,8 +13,8 @@ impl EntryAsync for EntryMutexTokio {
         self.lock().await.get_swarm_metadata()
     }
 
-    async fn check_good(self, policy: &TrackerPolicy) -> bool {
-        self.lock().await.is_good(policy)
+    async fn meets_retaining_policy(self, policy: &TrackerPolicy) -> bool {
+        self.lock().await.meets_retaining_policy(policy)
     }
 
     async fn peers_is_empty(&self) -> bool {

packages/torrent-repository/src/entry/rw_lock_parking_lot.rs

@@ -13,8 +13,8 @@ impl EntrySync for EntryRwLockParkingLot {
         self.read().get_swarm_metadata()
     }
 
-    fn is_good(&self, policy: &TrackerPolicy) -> bool {
-        self.read().is_good(policy)
+    fn meets_retaining_policy(&self, policy: &TrackerPolicy) -> bool {
+        self.read().meets_retaining_policy(policy)
     }
 
     fn peers_is_empty(&self) -> bool {

packages/torrent-repository/src/entry/single.rs

@@ -22,7 +22,7 @@ impl Entry for EntrySingle {
         }
     }
 
-    fn is_good(&self, policy: &TrackerPolicy) -> bool {
+    fn meets_retaining_policy(&self, policy: &TrackerPolicy) -> bool {
         if policy.persistent_torrent_completed_stat && self.downloaded > 0 {
             return true;
         }

packages/torrent-repository/src/repository/dash_map_mutex_std.rs

@@ -103,6 +103,6 @@ where
     }
 
     fn remove_peerless_torrents(&self, policy: &TrackerPolicy) {
-        self.torrents.retain(|_, entry| entry.is_good(policy));
+        self.torrents.retain(|_, entry| entry.meets_retaining_policy(policy));
     }
 }

packages/torrent-repository/src/repository/rw_lock_std.rs

@@ -126,6 +126,6 @@ where
     fn remove_peerless_torrents(&self, policy: &TrackerPolicy) {
         let mut db = self.get_torrents_mut();
 
-        db.retain(|_, e| e.is_good(policy));
+        db.retain(|_, e| e.meets_retaining_policy(policy));
     }
 }

packages/torrent-repository/src/repository/rw_lock_std_mutex_std.rs

@@ -124,6 +124,6 @@ where
     fn remove_peerless_torrents(&self, policy: &TrackerPolicy) {
         let mut db = self.get_torrents_mut();
 
-        db.retain(|_, e| e.lock().expect("it should lock entry").is_good(policy));
+        db.retain(|_, e| e.lock().expect("it should lock entry").meets_retaining_policy(policy));
     }
 }

packages/torrent-repository/src/repository/rw_lock_std_mutex_tokio.rs

@@ -143,8 +143,8 @@ where
             handles = zip(db.keys().copied(), db.values().cloned())
                 .map(|(infohash, torrent)| {
                     torrent
-                        .check_good(policy)
-                        .map(move |good| if good { None } else { Some(infohash) })
+                        .meets_retaining_policy(policy)
+                        .map(move |should_be_retained| if should_be_retained { None } else { Some(infohash) })
                         .boxed()
                 })
                 .collect::<Vec<_>>();