refactor!: simplify featureset

Cargo.toml

@@ -28,8 +28,6 @@ mockito = "0.31.1"
 tokio-test = "0.4.2"
 
 [features]
-default = ["sync", "local-cache"]
-client = ["dep:thiserror", "dep:url"]
-sync = ["client", "dep:ureq"]
-local-cache = ["sync", "dep:cacache-sync"]
-async = ["client", "dep:reqwest", "dep:reqwest-middleware", "dep:http-cache-reqwest"]
+default = ["sync"]
+sync = ["dep:thiserror", "dep:url", "dep:ureq", "dep:cacache-sync"]
+async = ["dep:thiserror", "dep:url", "dep:reqwest", "dep:reqwest-middleware", "dep:http-cache-reqwest"]

README.md

@@ -18,8 +18,6 @@ Rust library for accessing the latest LoL patch's ddragon data.
 use ddragon::{cache_middleware::CacheMiddleware, DDragonClientError, DDragonClient};
 
 fn main() -> Result<(), DDragonClientError> {
-    // Using caching, the preferred option.
-    // If you do not want caching enabled, disable the "local-cache" feature.
     let client = DDragonClient::new("/path/to/your/cache/dir")?;
 
     // If you want to use an existing agent
@@ -41,13 +39,9 @@ fn main() -> Result<(), DDragonClientError> {
 The following crate features are available:
 
 - `sync` (on by default) enables the synchronous client.
-  - Provides the `ddragon::client` module.
+  - Provides the `ddragon::client` and `ddragon::cache_middleware` module.
   - Provides the re-exported `ddragon::DDragonClient` client.
-  - Adds `url`, `thiserror`, and `ureq` with the `json` feature enabled as dependencies.
-- `local-cache` (on by default) enables the synchronous client.
-  - Provides the `ddragon::cache_middleware` module.
-  - Changes the default `DDragonClient::new()` implementation to set up caching.
-  - Adds `cacache-sync` as a dependency.
+  - Adds `cacache-sync`, `url`, `thiserror`, and `ureq` with the `json` feature enabled as dependencies.
 - `async` enables the asynchronous client.
   - Provides the `ddragon::async_client` module.
   - Provides the re-exported `ddragon::AsyncDDragonClient` client.

src/client.rs

@@ -6,7 +6,6 @@ use url::Url;
 #[cfg(test)]
 use mockito;
 
-#[cfg(feature = "local-cache")]
 use crate::cache_middleware::CacheMiddleware;
 
 use crate::{
@@ -57,7 +56,6 @@ impl DDragonClient {
         Self::create(agent, Url::parse(&base_url)?)
     }
 
-    #[cfg(feature = "local-cache")]
     /// Creates a new client with the specified directory as the caching location
     /// for any data the client downloads.
     pub fn new(cache_dir: &str) -> Result<Self, DDragonClientError> {
@@ -67,18 +65,12 @@ impl DDragonClient {
         Self::with_agent(agent)
     }
 
-    #[cfg(any(test, not(feature = "local-cache")))]
+    #[cfg(test)]
     fn new_no_cache() -> Result<Self, DDragonClientError> {
         let agent = ureq::Agent::new();
         Self::with_agent(agent)
     }
 
-    #[cfg(not(feature = "local-cache"))]
-    /// Creates a new client without using a local cache.
-    pub fn new() -> Result<Self, DDragonClientError> {
-        Self::new_no_cache()
-    }
-
     fn get_data_url(&self) -> Result<Url, url::ParseError> {
         self.base_url
             .join(&format!("/cdn/{}/data/en_US/", &self.version))

src/lib.rs

@@ -9,7 +9,7 @@ mod error;
 #[cfg(any(feature = "sync", feature = "async"))]
 pub use error::DDragonClientError;
 
-#[cfg(feature = "local-cache")]
+#[cfg(feature = "sync")]
 /// Contains the local file caching middleware used for `ureq`.
 pub mod cache_middleware;