Split crate_owner_invitations into MVC modules

Author: jtgeibel

src/crate_owner_invitation.rs renamed to src/controllers/crate_owner_invitation.rs

@@ -1,70 +1,10 @@
-use chrono::NaiveDateTime;
-use conduit::{Request, Response};
-use diesel::prelude::*;
-use serde_json;
-
-use db::RequestTransaction;
-use user::RequestUser;
-use util::errors::{human, CargoResult};
-use util::RequestUtils;
-
-use models::{CrateOwner, OwnerKind};
-use schema::{crate_owner_invitations, crate_owners, crates, users};
-
-/// The model representing a row in the `crate_owner_invitations` database table.
-#[derive(Clone, Copy, Debug, PartialEq, Eq, Identifiable, Queryable)]
-#[primary_key(invited_user_id, crate_id)]
-pub struct CrateOwnerInvitation {
-    pub invited_user_id: i32,
-    pub invited_by_user_id: i32,
-    pub crate_id: i32,
-    pub created_at: NaiveDateTime,
-}
-
-#[derive(Insertable, Clone, Copy, Debug)]
-#[table_name = "crate_owner_invitations"]
-pub struct NewCrateOwnerInvitation {
-    pub invited_user_id: i32,
-    pub invited_by_user_id: i32,
-    pub crate_id: i32,
-}
+use super::prelude::*;
 
-impl CrateOwnerInvitation {
-    pub fn invited_by_username(&self, conn: &PgConnection) -> String {
-        users::table
-            .find(self.invited_by_user_id)
-            .select(users::gh_login)
-            .first(&*conn)
-            .unwrap_or_else(|_| String::from("(unknown username)"))
-    }
-
-    pub fn crate_name(&self, conn: &PgConnection) -> String {
-        crates::table
-            .find(self.crate_id)
-            .select(crates::name)
-            .first(&*conn)
-            .unwrap_or_else(|_| String::from("(unknown crate name)"))
-    }
-
-    pub fn encodable(self, conn: &PgConnection) -> EncodableCrateOwnerInvitation {
-        EncodableCrateOwnerInvitation {
-            invited_by_username: self.invited_by_username(conn),
-            crate_name: self.crate_name(conn),
-            crate_id: self.crate_id,
-            created_at: self.created_at,
-        }
-    }
-}
+use serde_json;
 
-/// The serialization format for the `CrateOwnerInvitation` model.
-#[derive(Deserialize, Serialize, Debug)]
-pub struct EncodableCrateOwnerInvitation {
-    pub invited_by_username: String,
-    pub crate_name: String,
-    pub crate_id: i32,
-    #[serde(with = "::util::rfc3339")]
-    pub created_at: NaiveDateTime,
-}
+use models::{CrateOwner, CrateOwnerInvitation, OwnerKind};
+use schema::{crate_owner_invitations, crate_owners};
+use views::{EncodableCrateOwnerInvitation, InvitationResponse};
 
 /// Handles the `GET /me/crate_owner_invitations` route.
 pub fn list(req: &mut Request) -> CargoResult<Response> {
@@ -92,12 +32,6 @@ struct OwnerInvitation {
     crate_owner_invite: InvitationResponse,
 }
 
-#[derive(Deserialize, Serialize, Debug, Copy, Clone)]
-pub struct InvitationResponse {
-    pub crate_id: i32,
-    pub accepted: bool,
-}
-
 /// Handles the `PUT /me/crate_owner_invitations/:crate_id` route.
 pub fn handle_invite(req: &mut Request) -> CargoResult<Response> {
     let conn = &*req.db_conn()?;
@@ -175,27 +109,3 @@ fn decline_invite(
         crate_owner_invitation: crate_invite,
     }))
 }
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use chrono::NaiveDate;
-    use serde_json;
-
-    #[test]
-    fn crate_owner_invitation_serializes_to_rfc3339() {
-        let inv = EncodableCrateOwnerInvitation {
-            invited_by_username: "".to_string(),
-            crate_name: "".to_string(),
-            crate_id: 123,
-            created_at: NaiveDate::from_ymd(2017, 1, 6).and_hms(14, 23, 11),
-        };
-        let json = serde_json::to_string(&inv).unwrap();
-        assert!(
-            json.as_str()
-                .find(r#""created_at":"2017-01-06T14:23:11+00:00""#)
-                .is_some()
-        );
-    }
-
-}

src/controllers/mod.rs

@@ -15,5 +15,6 @@ mod prelude {
 pub mod helpers;
 
 pub mod category;
+pub mod crate_owner_invitation;
 pub mod keyword;
 pub mod krate;

src/lib.rs

@@ -65,7 +65,6 @@ use util::{R404, C, R};
 pub mod app;
 pub mod boot;
 pub mod config;
-pub mod crate_owner_invitation;
 pub mod db;
 pub mod dependency;
 pub mod dist;
@@ -223,11 +222,11 @@ pub fn middleware(app: Arc<App>) -> MiddlewareBuilder {
     api_router.delete("/me/tokens/:id", C(token::revoke));
     api_router.get(
         "/me/crate_owner_invitations",
-        C(crate_owner_invitation::list),
+        C(controllers::crate_owner_invitation::list),
     );
     api_router.put(
         "/me/crate_owner_invitations/:crate_id",
-        C(crate_owner_invitation::handle_invite),
+        C(controllers::crate_owner_invitation::handle_invite),
     );
     api_router.get("/summary", C(controllers::krate::metadata::summary));
     api_router.put("/confirm/:email_token", C(user::confirm_user_email));

src/models/crate_owner_invitation.rs

@@ -0,0 +1,50 @@
+use chrono::NaiveDateTime;
+use diesel::prelude::*;
+
+use schema::{crate_owner_invitations, crates, users};
+use views::EncodableCrateOwnerInvitation;
+
+/// The model representing a row in the `crate_owner_invitations` database table.
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Identifiable, Queryable)]
+#[primary_key(invited_user_id, crate_id)]
+pub struct CrateOwnerInvitation {
+    pub invited_user_id: i32,
+    pub invited_by_user_id: i32,
+    pub crate_id: i32,
+    pub created_at: NaiveDateTime,
+}
+
+#[derive(Insertable, Clone, Copy, Debug)]
+#[table_name = "crate_owner_invitations"]
+pub struct NewCrateOwnerInvitation {
+    pub invited_user_id: i32,
+    pub invited_by_user_id: i32,
+    pub crate_id: i32,
+}
+
+impl CrateOwnerInvitation {
+    pub fn invited_by_username(&self, conn: &PgConnection) -> String {
+        users::table
+            .find(self.invited_by_user_id)
+            .select(users::gh_login)
+            .first(&*conn)
+            .unwrap_or_else(|_| String::from("(unknown username)"))
+    }
+
+    pub fn crate_name(&self, conn: &PgConnection) -> String {
+        crates::table
+            .find(self.crate_id)
+            .select(crates::name)
+            .first(&*conn)
+            .unwrap_or_else(|_| String::from("(unknown crate name)"))
+    }
+
+    pub fn encodable(self, conn: &PgConnection) -> EncodableCrateOwnerInvitation {
+        EncodableCrateOwnerInvitation {
+            invited_by_username: self.invited_by_username(conn),
+            crate_name: self.crate_name(conn),
+            crate_id: self.crate_id,
+            created_at: self.created_at,
+        }
+    }
+}

src/models/mod.rs

@@ -1,6 +1,6 @@
 pub use self::badge::{Badge, MaintenanceStatus};
 pub use self::category::{Category, CrateCategory, NewCategory};
-pub use crate_owner_invitation::NewCrateOwnerInvitation;
+pub use self::crate_owner_invitation::{CrateOwnerInvitation, NewCrateOwnerInvitation};
 pub use dependency::{Dependency, Kind, ReverseDependency};
 pub use download::VersionDownload;
 pub use self::follow::Follow;
@@ -17,6 +17,7 @@ pub mod helpers;
 
 mod badge;
 mod category;
+mod crate_owner_invitation;
 mod follow;
 mod keyword;
 pub mod krate;

src/tests/owners.rs

@@ -85,12 +85,6 @@ fn new_crate_owner() {
         crate_owner_invitation: InvitationResponse,
     }
 
-    #[derive(Deserialize)]
-    struct InvitationResponse {
-        crate_id: i32,
-        accepted: bool,
-    }
-
     let crate_owner_invite = ::json::<CrateOwnerInvitation>(&mut response);
     assert!(crate_owner_invite.crate_owner_invitation.accepted);
     assert_eq!(crate_owner_invite.crate_owner_invitation.crate_id, krate_id);
@@ -202,12 +196,6 @@ fn owners_can_remove_self() {
         crate_owner_invitation: InvitationResponse,
     }
 
-    #[derive(Deserialize)]
-    struct InvitationResponse {
-        crate_id: i32,
-        accepted: bool,
-    }
-
     let crate_owner_invite = ::json::<CrateOwnerInvitation>(&mut response);
     assert!(crate_owner_invite.crate_owner_invitation.accepted);
     assert_eq!(crate_owner_invite.crate_owner_invitation.crate_id, krate_id);

src/views/mod.rs

@@ -1,6 +1,3 @@
-// TODO: Move all encodable types here
-// For now, just reexport
-
 use std::collections::HashMap;
 use chrono::NaiveDateTime;
 
@@ -33,7 +30,22 @@ pub struct EncodableCategoryWithSubcategories {
     pub subcategories: Vec<EncodableCategory>,
 }
 
-pub use crate_owner_invitation::{EncodableCrateOwnerInvitation, InvitationResponse};
+/// The serialization format for the `CrateOwnerInvitation` model.
+#[derive(Deserialize, Serialize, Debug)]
+pub struct EncodableCrateOwnerInvitation {
+    pub invited_by_username: String,
+    pub crate_name: String,
+    pub crate_id: i32,
+    #[serde(with = "::util::rfc3339")]
+    pub created_at: NaiveDateTime,
+}
+
+#[derive(Deserialize, Serialize, Debug, Copy, Clone)]
+pub struct InvitationResponse {
+    pub crate_id: i32,
+    pub accepted: bool,
+}
+
 pub use dependency::EncodableDependency;
 pub use download::EncodableVersionDownload;
 
@@ -240,4 +252,20 @@ mod tests {
                 .is_some()
         );
     }
+
+    #[test]
+    fn crate_owner_invitation_serializes_to_rfc3339() {
+        let inv = EncodableCrateOwnerInvitation {
+            invited_by_username: "".to_string(),
+            crate_name: "".to_string(),
+            crate_id: 123,
+            created_at: NaiveDate::from_ymd(2017, 1, 6).and_hms(14, 23, 11),
+        };
+        let json = serde_json::to_string(&inv).unwrap();
+        assert!(
+            json.as_str()
+                .find(r#""created_at":"2017-01-06T14:23:11+00:00""#)
+                .is_some()
+        );
+    }
 }