Merge #1155

1155: Propose new MVC module layout r=carols10cents

This pull request proposes a new module layout following a model-view-controller style.  For now, the functionality is re-exported from the new locations and the `use` statements have been updated to use the new locations.    If we define where things should be moved to now, it should be easier to split future changes into small, reviewable PRs.

## Controllers - `src/api/*`

For now, this is an empty placeholder, but the api route declarations and endpoints would be moved here.  (In a [separate branch](jtgeibel/crates.io@master...mvc-example) I have some examples where the existing logic is moved.)

## Views - `src/views/*`

Currently this is JSON only and most existing types are prefixed with `Encodable`.  The major exception to this is the types from the `cargo publish` endpoint, which has been moved to `views::krate_publish`.

## Models - `src/models/*`

All of the Diesel types would move to here.  Many of these were previously reexported from the crate root.

Going forward, I think many of the `New*` structs can go away using the new syntax as shown in: https://github.com/rust-lang/crates.io/blob/e0e57b9843c2fb244997a2e47d8cedc40fa9b516/src/boot/categories.rs#L105-L109

# Future work

We can consider additional top level modules.  For instance, the outgoing email and github_auth functionality could be moved to a module for `external` services.  Additionally, `src/pagination.rs` could be moved into `src/api/mod.rs` and a few more things could probably move to `util`.  I'm not sure yet where something like the README rendering would fit in.

Author: bors-voyager[bot]

src/badge.rs

@@ -1,11 +1,11 @@
-use krate::Crate;
-use schema::badges;
-
 use diesel::pg::Pg;
 use diesel::prelude::*;
 use serde_json;
 use std::collections::HashMap;
 
+use models::Crate;
+use schema::badges;
+
 #[derive(Debug, PartialEq, Clone, Deserialize, Serialize)]
 #[serde(rename_all = "kebab-case", tag = "badge_type", content = "attributes")]
 pub enum Badge {

src/bin/delete-crate.rs

@@ -15,7 +15,7 @@ use std::env;
 use std::io;
 use std::io::prelude::*;
 
-use cargo_registry::Crate;
+use cargo_registry::models::Crate;
 use cargo_registry::schema::crates;
 
 #[allow(dead_code)]

src/bin/delete-version.rs

@@ -15,7 +15,7 @@ use std::env;
 use std::io;
 use std::io::prelude::*;
 
-use cargo_registry::{Crate, Version};
+use cargo_registry::models::{Crate, Version};
 use cargo_registry::schema::versions;
 
 #[allow(dead_code)]

src/bin/render-readmes.rs

@@ -32,10 +32,12 @@ use std::thread;
 use tar::Archive;
 use url::Url;
 
-use cargo_registry::{Config, Version};
-use cargo_registry::schema::*;
+use cargo_registry::Config;
 use cargo_registry::render::readme_to_html;
 
+use cargo_registry::models::Version;
+use cargo_registry::schema::*;
+
 const DEFAULT_PAGE_SIZE: usize = 25;
 const USAGE: &str = "
 Usage: render-readmes [options]

src/bin/transfer-crates.rs

@@ -13,8 +13,7 @@ use std::env;
 use std::io;
 use std::io::prelude::*;
 
-use cargo_registry::{Crate, User};
-use cargo_registry::owner::OwnerKind;
+use cargo_registry::models::{Crate, OwnerKind, User};
 use cargo_registry::schema::*;
 
 fn main() {

src/bin/update-downloads.rs

@@ -8,7 +8,7 @@ use diesel::prelude::*;
 use std::env;
 use std::time::Duration;
 
-use cargo_registry::VersionDownload;
+use cargo_registry::models::VersionDownload;
 use cargo_registry::schema::*;
 
 static LIMIT: i64 = 1000;
@@ -118,9 +118,7 @@ mod test {
     use diesel::insert_into;
     use super::*;
     use cargo_registry::env;
-    use cargo_registry::krate::{Crate, NewCrate};
-    use cargo_registry::user::{NewUser, User};
-    use cargo_registry::version::{NewVersion, Version};
+    use cargo_registry::models::{Crate, NewCrate, NewUser, NewVersion, User, Version};
 
     fn conn() -> PgConnection {
         let conn = PgConnection::establish(&env("TEST_DATABASE_URL")).unwrap();

src/category.rs

@@ -3,11 +3,12 @@ use conduit::{Request, Response};
 use conduit_router::RequestParams;
 use diesel::*;
 
-use Crate;
 use db::RequestTransaction;
-use schema::*;
 use util::{CargoResult, RequestUtils};
 
+use models::Crate;
+use schema::*;
+
 #[derive(Clone, Identifiable, Queryable, QueryableByName, Debug)]
 #[table_name = "categories"]
 pub struct Category {

src/controllers/helpers/mod.rs

@@ -0,0 +1,3 @@
+pub mod pagination;
+
+pub use self::pagination::Paginate;

src/pagination.rs renamed to src/controllers/helpers/pagination.rs

@@ -3,6 +3,7 @@ use diesel::query_builder::*;
 use diesel::sql_types::BigInt;
 use diesel::pg::Pg;
 
+#[derive(Debug)]
 pub struct Paginated<T> {
     query: T,
     limit: i64,

src/controllers/mod.rs

@@ -0,0 +1,3 @@
+// TODO: All endpoints would be moved to submodules here
+
+pub mod helpers;