refactor: [torrust#581] rename TorrustIndex to Settings

Author: josecelano

src/config/mod.rs

@@ -13,7 +13,7 @@ use tokio::sync::RwLock;
 use torrust_index_located_error::{Located, LocatedError};
 use url::{ParseError, Url};
 
-pub type TorrustIndex = v1::Settings;
+pub type Settings = v1::Settings;
 pub type Api = v1::api::Api;
 pub type Auth = v1::auth::Auth;
 pub type Database = v1::database::Database;
@@ -225,13 +225,13 @@ impl Tsl {
 #[derive(Debug)]
 pub struct Configuration {
     /// The state of the configuration.
-    pub settings: RwLock<TorrustIndex>,
+    pub settings: RwLock<Settings>,
 }
 
 impl Default for Configuration {
     fn default() -> Configuration {
         Configuration {
-            settings: RwLock::new(TorrustIndex::default()),
+            settings: RwLock::new(Settings::default()),
         }
     }
 }
@@ -252,22 +252,22 @@ impl Configuration {
         let config_builder = Config::builder()
             .add_source(File::from_str(&info.index_toml, FileFormat::Toml))
             .build()?;
-        let mut index_config: TorrustIndex = config_builder.try_deserialize()?;
+        let mut settings: Settings = config_builder.try_deserialize()?;
 
         if let Some(ref token) = info.tracker_api_token {
-            index_config.override_tracker_api_token(token);
+            settings.override_tracker_api_token(token);
         };
 
         if let Some(ref secret_key) = info.auth_secret_key {
-            index_config.override_auth_secret_key(secret_key);
+            settings.override_auth_secret_key(secret_key);
         };
 
         Ok(Configuration {
-            settings: RwLock::new(index_config),
+            settings: RwLock::new(settings),
         })
     }
 
-    pub async fn get_all(&self) -> TorrustIndex {
+    pub async fn get_all(&self) -> Settings {
         let settings_lock = self.settings.read().await;
 
         settings_lock.clone()

src/services/settings.rs

@@ -2,7 +2,7 @@
 use std::sync::Arc;
 
 use super::user::DbUserRepository;
-use crate::config::{Configuration, ConfigurationPublic, TorrustIndex};
+use crate::config::{Configuration, ConfigurationPublic, Settings};
 use crate::errors::ServiceError;
 use crate::models::user::UserId;
 
@@ -25,7 +25,7 @@ impl Service {
     /// # Errors
     ///
     /// It returns an error if the user does not have the required permissions.
-    pub async fn get_all(&self, user_id: &UserId) -> Result<TorrustIndex, ServiceError> {
+    pub async fn get_all(&self, user_id: &UserId) -> Result<Settings, ServiceError> {
         let user = self.user_repository.get_compact(user_id).await?;
 
         // Check if user is administrator
@@ -44,7 +44,7 @@ impl Service {
     /// # Errors
     ///
     /// It returns an error if the user does not have the required permissions.
-    pub async fn get_all_masking_secrets(&self, user_id: &UserId) -> Result<TorrustIndex, ServiceError> {
+    pub async fn get_all_masking_secrets(&self, user_id: &UserId) -> Result<Settings, ServiceError> {
         let user = self.user_repository.get_compact(user_id).await?;
 
         // Check if user is administrator

src/web/api/client/v1/contexts/settings/mod.rs

@@ -4,7 +4,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::config::{
     Api as DomainApi, Auth as DomainAuth, Database as DomainDatabase, ImageCache as DomainImageCache, Mail as DomainMail,
-    Network as DomainNetwork, TorrustIndex as DomainSettings, Tracker as DomainTracker,
+    Network as DomainNetwork, Settings as DomainSettings, Tracker as DomainTracker,
     TrackerStatisticsImporter as DomainTrackerStatisticsImporter, Website as DomainWebsite,
 };
 

src/web/api/server/v1/contexts/settings/mod.rs

@@ -82,7 +82,7 @@
 //! ```
 //! **Resource**
 //!
-//! Refer to the [`TorrustIndex`](crate::config::TorrustIndex)
+//! Refer to the [`TorrustIndex`](crate::config::Settings)
 //! struct for more information about the response attributes.
 //!
 //! # Update all settings
@@ -110,7 +110,7 @@
 //!
 //! **Resource**
 //!
-//! Refer to the [`TorrustIndex`](crate::config::TorrustIndex)
+//! Refer to the [`TorrustIndex`](crate::config::Settings)
 //! struct for more information about the response attributes.
 //!
 //! # Get site name

tests/common/contexts/settings/mod.rs

@@ -3,7 +3,7 @@ pub mod responses;
 use serde::{Deserialize, Serialize};
 use torrust_index::config::{
     Api as DomainApi, Auth as DomainAuth, Database as DomainDatabase, ImageCache as DomainImageCache, Mail as DomainMail,
-    Network as DomainNetwork, TorrustIndex as DomainSettings, Tracker as DomainTracker,
+    Network as DomainNetwork, Settings as DomainSettings, Tracker as DomainTracker,
     TrackerStatisticsImporter as DomainTrackerStatisticsImporter, Website as DomainWebsite,
 };
 

tests/environments/app_starter.rs

@@ -9,7 +9,7 @@ use torrust_index::{app, config};
 
 /// It launches the app and provides a way to stop it.
 pub struct AppStarter {
-    configuration: config::TorrustIndex,
+    configuration: config::Settings,
     /// The application binary state (started or not):
     ///  - `None`: if the app is not started,
     ///  - `RunningState`: if the app was started.
@@ -18,7 +18,7 @@ pub struct AppStarter {
 
 impl AppStarter {
     #[must_use]
-    pub fn with_custom_configuration(configuration: config::TorrustIndex) -> Self {
+    pub fn with_custom_configuration(configuration: config::Settings) -> Self {
         Self {
             configuration,
             running_state: None,
@@ -78,7 +78,7 @@ impl AppStarter {
     }
 
     #[must_use]
-    pub fn server_configuration(&self) -> config::TorrustIndex {
+    pub fn server_configuration(&self) -> config::Settings {
         self.configuration.clone()
     }
 

tests/environments/isolated.rs

@@ -46,7 +46,7 @@ impl TestEnv {
 
     /// Provides the whole server configuration.
     #[must_use]
-    pub fn server_configuration(&self) -> config::TorrustIndex {
+    pub fn server_configuration(&self) -> config::Settings {
         self.app_starter.server_configuration()
     }
 
@@ -69,10 +69,10 @@ impl Default for TestEnv {
 }
 
 /// Provides a configuration with ephemeral data for testing.
-fn ephemeral(temp_dir: &TempDir) -> config::TorrustIndex {
-    let mut configuration = config::TorrustIndex {
+fn ephemeral(temp_dir: &TempDir) -> config::Settings {
+    let mut configuration = config::Settings {
         log_level: Some("off".to_owned()), // Change to `debug` for tests debugging
-        ..config::TorrustIndex::default()
+        ..config::Settings::default()
     };
 
     // Ephemeral API port