Move repositories code source into a new module

Author: GuillaumeGomez

src/bin/cratesfyi.rs

@@ -4,7 +4,8 @@ use std::path::PathBuf;
 use std::sync::Arc;
 
 use docs_rs::db::{self, add_path_into_database, Pool, PoolClient};
-use docs_rs::utils::{remove_crate_priority, set_crate_priority, RepositoryStatsUpdater};
+use docs_rs::repositories::RepositoryStatsUpdater;
+use docs_rs::utils::{remove_crate_priority, set_crate_priority};
 use docs_rs::{
     BuildQueue, Config, Context, DocBuilder, Index, Metrics, PackageKind, RustwideBuilder, Server,
     Storage,

src/docbuilder/rustwide_builder.rs

@@ -6,8 +6,9 @@ use crate::db::{
 use crate::docbuilder::{crates::crates_from_path, Limits};
 use crate::error::Result;
 use crate::index::api::ReleaseData;
+use crate::repositories::RepositoryStatsUpdater;
 use crate::storage::CompressionAlgorithms;
-use crate::utils::{copy_doc_dir, parse_rustc_version, CargoMetadata, RepositoryStatsUpdater};
+use crate::utils::{copy_doc_dir, parse_rustc_version, CargoMetadata};
 use crate::{db::blacklist::is_blacklisted, utils::MetadataPackage};
 use crate::{Config, Context, Index, Metrics, Storage};
 use docsrs_metadata::{Metadata, DEFAULT_TARGETS, HOST_TARGET};

src/lib.rs

@@ -21,6 +21,7 @@ mod docbuilder;
 mod error;
 pub mod index;
 mod metrics;
+pub mod repositories;
 pub mod storage;
 #[cfg(test)]
 mod test;

src/utils/github_updater.rs renamed to src/repositories/github_updater.rs

@@ -10,7 +10,7 @@ use reqwest::{
 use serde::Deserialize;
 use std::sync::Arc;
 
-use crate::utils::{Updater, APP_USER_AGENT};
+use crate::repositories::{Updater, APP_USER_AGENT};
 
 const GRAPHQL_UPDATE: &str = "query($ids: [ID!]!) {
     nodes(ids: $ids) {
@@ -309,7 +309,7 @@ struct GraphIssues {
 #[cfg(test)]
 mod test {
     use super::*;
-    use crate::utils::RepositoryName;
+    use crate::repositories::RepositoryName;
 
     #[test]
     fn test_repository_name() {
@@ -324,16 +324,20 @@ mod test {
                     })
                 );
             };
+            ($url:expr => None) => {
+                assert_eq!(GithubUpdater::repository_name($url), None);
+            };
         }
 
         assert_name!("https://github.com/onur/cratesfyi" => ("onur", "cratesfyi", "github.com"));
         assert_name!("http://github.com/onur/cratesfyi" => ("onur", "cratesfyi", "github.com"));
-        assert_name!("https://www.github.com/onur/cratesfyi" => ("onur", "cratesfyi", "www.github.com"));
-        assert_name!("http://www.github.com/onur/cratesfyi" => ("onur", "cratesfyi", "www.github.com"));
         assert_name!("https://github.com/onur/cratesfyi.git" => ("onur", "cratesfyi", "github.com"));
         assert_name!("https://github.com/docopt/docopt.rs" => ("docopt", "docopt.rs", "github.com"));
         assert_name!("https://github.com/onur23cmD_M_R_L_/crates_fy-i" => (
             "onur23cmD_M_R_L_", "crates_fy-i", "github.com"
         ));
+        assert_name!("https://www.github.com/onur/cratesfyi" => None);
+        assert_name!("http://www.github.com/onur/cratesfyi" => None);
+        assert_name!("http://www.gitlab.com/onur/cratesfyi" => None);
     }
 }

src/utils/gitlab_updater.rs renamed to src/repositories/gitlab_updater.rs

@@ -10,7 +10,7 @@ use reqwest::{
 use serde::Deserialize;
 use std::sync::Arc;
 
-use crate::utils::{Updater, APP_USER_AGENT};
+use crate::repositories::{Updater, APP_USER_AGENT};
 
 const GRAPHQL_UPDATE: &str = "query($ids: [ID!]!) {
     projects(ids: $ids) {
@@ -287,7 +287,7 @@ struct GraphProject {
 #[cfg(test)]
 mod test {
     use super::*;
-    use crate::utils::RepositoryName;
+    use crate::repositories::RepositoryName;
 
     #[test]
     fn test_repository_name() {
@@ -302,6 +302,9 @@ mod test {
                     })
                 );
             };
+            ($url:expr => None) => {
+                assert_eq!(GitlabUpdater::repository_name($url), None);
+            };
         }
 
         assert_name!("https://gitlab.com/onur/cratesfyi" => ("onur", "cratesfyi", "gitlab.com"));
@@ -314,5 +317,7 @@ mod test {
         assert_name!("https://gitlab.freedesktop.org/test/test" => (
             "test", "test", "gitlab.freedesktop.org"
         ));
+        assert_name!("https://www.github.com/onur/cratesfyi" => None);
+        assert_name!("https://github.com/onur/cratesfyi" => None);
     }
 }

src/repositories/mod.rs

@@ -0,0 +1,15 @@
+pub use self::github_updater::GithubUpdater;
+pub use self::gitlab_updater::GitlabUpdater;
+#[cfg(test)]
+pub(crate) use self::updater::RepositoryName;
+pub use self::updater::{RepositoryStatsUpdater, Updater};
+
+pub const APP_USER_AGENT: &str = concat!(
+    env!("CARGO_PKG_NAME"),
+    " ",
+    include_str!(concat!(env!("OUT_DIR"), "/git_version"))
+);
+
+mod github_updater;
+mod gitlab_updater;
+mod updater;

src/utils/updater.rs renamed to src/repositories/updater.rs

@@ -1,6 +1,6 @@
 use crate::error::Result;
-use crate::utils::daemon::cron;
-use crate::utils::{GithubUpdater, GitlabUpdater, MetadataPackage};
+use crate::repositories::{GithubUpdater, GitlabUpdater};
+use crate::utils::{daemon::cron, MetadataPackage};
 use crate::{db::Pool, Config, Context};
 use chrono::{DateTime, Utc};
 use log::{debug, info, trace, warn};
@@ -11,12 +11,6 @@ use std::collections::HashSet;
 use std::sync::Arc;
 use std::time::Duration;
 
-pub const APP_USER_AGENT: &str = concat!(
-    env!("CARGO_PKG_NAME"),
-    " ",
-    include_str!(concat!(env!("OUT_DIR"), "/git_version"))
-);
-
 pub trait Updater {
     fn new(config: Arc<Config>, pool: Pool) -> Result<Option<Self>>
     where
@@ -41,6 +35,7 @@ pub trait Updater {
         Ok(())
     }
 
+    #[allow(clippy::too_many_arguments)]
     fn store_repository(
         &self,
         conn: &mut Client,

src/utils/daemon.rs

@@ -3,7 +3,8 @@
 //! This daemon will start web server, track new packages and build them
 
 use crate::{
-    utils::{queue_builder, update_release_activity, RepositoryStatsUpdater},
+    repositories::RepositoryStatsUpdater,
+    utils::{queue_builder, update_release_activity},
     Context, DocBuilder, RustwideBuilder,
 };
 use chrono::{Timelike, Utc};

src/utils/mod.rs

@@ -3,33 +3,24 @@
 pub(crate) use self::cargo_metadata::{CargoMetadata, Package as MetadataPackage};
 pub(crate) use self::copy::copy_doc_dir;
 pub use self::daemon::start_daemon;
-pub use self::github_updater::GithubUpdater;
-pub use self::gitlab_updater::GitlabUpdater;
 pub(crate) use self::html::rewrite_lol;
 pub use self::queue::{get_crate_priority, remove_crate_priority, set_crate_priority};
 pub use self::queue_builder::queue_builder;
 pub use self::release_activity_updater::update_release_activity;
 pub(crate) use self::rustc_version::parse_rustc_version;
-pub(crate) use self::updater::APP_USER_AGENT;
-pub use self::updater::{RepositoryStatsUpdater, Updater};
 
 #[cfg(test)]
 pub(crate) use self::cargo_metadata::{Dependency, Target};
-#[cfg(test)]
-pub(crate) use self::updater::RepositoryName;
 
 mod cargo_metadata;
 #[cfg(feature = "consistency_check")]
 pub mod consistency;
 mod copy;
-mod daemon;
-mod github_updater;
-mod gitlab_updater;
+pub(crate) mod daemon;
 mod html;
 mod pubsubhubbub;
 mod queue;
 mod queue_builder;
 mod release_activity_updater;
 mod rustc_version;
 pub(crate) mod sized_buffer;
-mod updater;