Reorganized the project into a workspace

Cargo.toml

@@ -1,87 +1,7 @@
-[package]
-name = "alexandrie"
-version = "0.1.0"
-edition = "2018"
-authors = ["Nicolas Polomack <nicolas@polomack.eu>"]
-description = "An alternative crate registry, implemented in Rust."
-repository = "https://github.com/Hirevo/alexandrie"
-documentation = "https://crates.polomack.eu/docs/alexandrie"
-keywords = ["crates", "cargo", "web", "registry"]
-categories = ["development-tools"]
-license = "MIT OR Apache-2.0"
-
-default-run = "alexandrie"
-
-[dependencies]
-# core
-tide = { version = "0.5.0" }
-http = { version = "0.1.21" }
-
-# data types
-url = { version = "2.1.1" }
-semver = { version = "0.9.0", features = ["serde"] }
-chrono = { version = "0.4.10", features = ["serde"] }
-
-# file formats
-serde = { version = "1.0.104", features = ["derive"] }
-json = { package = "serde_json", version = "1.0.44" }
-toml = { version = "0.5.5" }
-
-# binary parsing
-byteorder = { version = "1.3.2" }
-bytes = { version = "0.5.3" }
-
-# (en|de)coding / hashing
-ring = { version = "0.16.9" }
-hex = { version = "0.4.0" }
-base64 = { version = "0.11.0" }
-percent-encoding = { version = "2.1.0" }
-
-# database
-diesel = { version = "1.4.3", features = ["r2d2", "chrono", "numeric"] }
-diesel_migrations = { version = "1.4.0" }
-
-# async primitives
-async-std = { version = "1.4.0", features = ["unstable", "attributes"] }
-futures = { version = "0.3.1" }
-
-# error handling
-thiserror = { version = "1.0.9" }
-
-# README rendering
-syntect = { version = "3.3.0" }
-cmark = { package = "pulldown-cmark", version = "0.6.1" }
-flate2 = { version = "1.0.13" }
-tar = { version = "0.4.26" }
-
-# frontend
-handlebars = { version = "2.0.4", optional = true }
-cookie = { version = "0.12.0", features = ["percent-encode"], optional = true }
-time = { version = "0.1.42", optional = true }
-num-format = { version = "0.4.0", optional = true }
-bigdecimal = { version = "0.1.0", features = ["serde"], optional = true }
-
-# git2
-git2 = { version = "0.11.0", optional = true }
-
-# logs
-log = { version = "0.4.8" }
-slog = { version = "2.5.2" }
-slog-stdlog = { version = "4.0.0" }
-slog-scope = { version = "4.3.0" }
-slog-term = { version = "2.4.2" }
-slog-async = { version = "2.3.0" }
-slog-json = { version = "2.3.0" }
-
-# miscellaneous
-path-absolutize = { version = "1.1.7" }
-mime_guess = { version = "2.0.1" }
-
-[features]
-# default = ["frontend", "sqlite"]
-# default = ["frontend", "mysql"]
-default = ["frontend", "postgres"]
-frontend = ["handlebars", "num-format", "bigdecimal", "cookie", "time"]
-mysql = ["diesel/mysql", "diesel_migrations/mysql"]
-sqlite = ["diesel/sqlite", "diesel_migrations/sqlite"]
-postgres = ["diesel/postgres", "diesel_migrations/postgres"]
+[workspace]
+members = [
+    "alexandrie",
+    "alexandrie-index",
+    "alexandrie-storage",
+    "alexandrie-rendering"
+]

alexandrie-index/Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+name = "alexandrie-index"
+version = "0.1.0"
+edition = "2018"
+authors = ["Nicolas Polomack <nicolas@polomack.eu>"]
+description = "The index management library for Alexandrie, an alternative crate registry."
+repository = "https://github.com/Hirevo/alexandrie"
+documentation = "https://crates.polomack.eu/docs/alexandrie"
+keywords = ["crates", "cargo", "web", "registry"]
+categories = ["development-tools"]
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+# data types
+semver = { version = "0.9.0", features = ["serde"] }
+
+# file formats
+serde = { version = "1.0.104", features = ["derive"] }
+json = { package = "serde_json", version = "1.0.44" }
+
+# error handling
+thiserror = { version = "1.0.9" }
+
+# git2
+git2 = { version = "0.11.0", optional = true }

src/index/cli.rs → alexandrie-index/src/cli.rs

@@ -4,8 +4,9 @@ use std::process::{Command, Stdio};
 use semver::{Version, VersionReq};
 
 use crate::error::Error;
-use crate::index::tree::Tree;
-use crate::index::{CrateVersion, Indexer};
+use crate::models::CrateVersion;
+use crate::tree::Tree;
+use crate::Indexer;
 
 /// The 'command-line' crate index management strategy type.
 ///

src/config/index/cli.rs → alexandrie-index/src/config/cli.rs

@@ -2,7 +2,7 @@ use std::path::PathBuf;
 
 use serde::{Deserialize, Serialize};
 
-use crate::index::cli::CommandLineIndex;
+use crate::cli::CommandLineIndex;
 
 /// The configuration struct for the 'command-line' index management strategy.
 ///

src/config/index/git2.rs → alexandrie-index/src/config/git2.rs

@@ -2,7 +2,7 @@ use std::path::PathBuf;
 
 use serde::{Deserialize, Serialize};
 
-use crate::index::git2::Git2Index;
+use crate::git2::Git2Index;
 
 /// The configuration struct for the 'git2' index management strategy.
 ///

src/config/index/mod.rs → alexandrie-index/src/config/mod.rs

@@ -7,11 +7,11 @@ pub mod cli;
 #[cfg(feature = "git2")]
 pub mod git2;
 
-use crate::config::index::cli::CommandLineIndexConfig;
-use crate::index::Index;
+use crate::config::cli::CommandLineIndexConfig;
+use crate::Index;
 
 #[cfg(feature = "git2")]
-use crate::config::index::git2::Git2IndexConfig;
+use crate::config::git2::Git2IndexConfig;
 
 /// The configuration enum for index management strategies.
 ///

alexandrie-index/src/error.rs

@@ -0,0 +1,43 @@
+use semver::Version;
+use thiserror::Error;
+
+/// The Error type for the registry.
+///
+/// It can represent any kind of error the registry might encounter.
+#[derive(Error, Debug)]
+pub enum Error {
+    /// An IO error (file not found, access forbidden, etc...).
+    #[error("IO error: {0}")]
+    IOError(#[from] std::io::Error),
+    /// JSON (de)serialization error (invalid JSON parsed, etc...).
+    #[error("JSON error: {0}")]
+    JSONError(#[from] json::Error),
+    /// Git2 error.
+    #[error("libgit2 error: {0}")]
+    #[cfg(feature = "git2")]
+    Git2Error(#[from] git2::Error),
+    /// Other index-specific error (crate not found, etc...).
+    #[error("index-specific error: {0}")]
+    IndexError(#[from] IndexError),
+}
+
+/// The Error type for Alexandrie's own errors.
+#[derive(Error, Debug)]
+pub enum IndexError {
+    /// The requested crate cannot be found.
+    #[error("no crate named '{name}' found")]
+    CrateNotFound {
+        /// The requested crate's name.
+        name: String,
+    },
+    /// The published crate version is lower than the current hosted version.
+    #[error("the published version is too low (hosted version is {hosted}, and thus {published} <= {hosted})")]
+    VersionTooLow {
+        /// The krate's name.
+        krate: String,
+        /// The available hosted version.
+        hosted: Version,
+        /// The proposed version to be published.
+        published: Version,
+    },
+}

src/index/git2.rs → alexandrie-index/src/git2.rs

@@ -4,8 +4,9 @@ use std::sync::Mutex;
 use semver::{Version, VersionReq};
 
 use crate::error::Error;
-use crate::index::tree::Tree;
-use crate::index::{CrateVersion, Indexer};
+use crate::models::CrateVersion;
+use crate::tree::Tree;
+use crate::Indexer;
 
 /// The 'git2' crate index management strategy type.
 ///

src/index/mod.rs → alexandrie-index/src/lib.rs

@@ -2,21 +2,26 @@ use semver::{Version, VersionReq};
 
 /// Index management through `git` shell command invocations.
 pub mod cli;
-mod models;
-mod tree;
+/// Configuration-related types.
+pub mod config;
+/// Error-handling types.
+pub mod error;
 
 /// Index management using [**`libgit2`**][libgit2].
 /// [libgit2]: https://libgit2.org
 #[cfg(feature = "git2")]
 pub mod git2;
 
-pub use models::{CrateDependency, CrateDependencyKind, CrateVersion};
+mod models;
+mod tree;
+
+pub use models::*;
 
+use crate::cli::CommandLineIndex;
 use crate::error::Error;
-use crate::index::cli::CommandLineIndex;
 
 #[cfg(feature = "git2")]
-use crate::index::git2::Git2Index;
+use crate::git2::Git2Index;
 
 /// The crate indexing management strategy type.
 ///

src/index/tree.rs → alexandrie-index/src/tree.rs

@@ -1,13 +1,14 @@
-use super::models::CrateVersion;
-use crate::error::AlexError;
-use crate::Error;
-use semver::{Version, VersionReq};
 use std::fs;
 use std::io;
 use std::io::BufRead;
 use std::io::Write;
 use std::path::PathBuf;
 
+use semver::{Version, VersionReq};
+
+use crate::error::{Error, IndexError};
+use crate::models::CrateVersion;
+
 #[derive(Debug, Clone, PartialEq)]
 pub struct Tree {
     path: PathBuf,
@@ -30,7 +31,7 @@ impl Tree {
     pub fn match_record(&self, name: &str, req: VersionReq) -> Result<CrateVersion, Error> {
         let path = self.compute_record_path(name);
         let file = fs::File::open(path).map_err(|err| match err.kind() {
-            io::ErrorKind::NotFound => Error::from(AlexError::CrateNotFound {
+            io::ErrorKind::NotFound => Error::from(IndexError::CrateNotFound {
                 name: String::from(name),
             }),
             _ => Error::from(err),
@@ -41,7 +42,7 @@ impl Tree {
             .flat_map(|ret: Option<CrateVersion>| ret.into_iter())
             .filter(|krate| req.matches(&krate.vers))
             .max_by(|k1, k2| k1.vers.cmp(&k2.vers));
-        Ok(found.ok_or_else(|| AlexError::CrateNotFound {
+        Ok(found.ok_or_else(|| IndexError::CrateNotFound {
             name: String::from(name),
         })?)
     }
@@ -77,7 +78,7 @@ impl Tree {
                 .max_by(|k1, k2| k1.vers.cmp(&k2.vers))
                 .expect("at least one record should exist");
             if record.vers <= latest.vers {
-                return Err(Error::from(AlexError::VersionTooLow {
+                return Err(Error::from(IndexError::VersionTooLow {
                     krate: record.name,
                     hosted: latest.vers,
                     published: record.vers,
@@ -106,7 +107,7 @@ impl Tree {
     {
         let path = self.compute_record_path(name);
         let file = fs::File::open(path.as_path()).map_err(|err| match err.kind() {
-            io::ErrorKind::NotFound => Error::from(AlexError::CrateNotFound {
+            io::ErrorKind::NotFound => Error::from(IndexError::CrateNotFound {
                 name: String::from(name),
             }),
             _ => Error::from(err),
@@ -123,7 +124,7 @@ impl Tree {
             .iter_mut()
             .find(|krate| krate.vers == version)
             .ok_or_else(|| {
-                Error::from(AlexError::CrateNotFound {
+                Error::from(IndexError::CrateNotFound {
                     name: String::from(name),
                 })
             })?;

alexandrie-rendering/Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+name = "alexandrie-rendering"
+version = "0.1.0"
+edition = "2018"
+authors = ["Nicolas Polomack <nicolas@polomack.eu>"]
+description = "The markdown rendering library for Alexandrie, an alternative crate registry."
+repository = "https://github.com/Hirevo/alexandrie"
+documentation = "https://crates.polomack.eu/docs/alexandrie"
+keywords = ["crates", "cargo", "web", "registry"]
+categories = ["development-tools"]
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+# data types
+semver = { version = "0.9.0", features = ["serde"] }
+
+# file formats
+serde = { version = "1.0.104", features = ["derive"] }
+
+# error handling
+thiserror = { version = "1.0.9" }
+
+# README rendering
+syntect = { version = "3.3.0" }
+cmark = { package = "pulldown-cmark", version = "0.6.1" }