Add descriptions to categories

Have to switch from a nice batch insert to running a query for each
category so that we can use apostrophes in the descriptions and have
the string escaped for SQL.

Author: carols10cents

app/models/category.js

@@ -3,6 +3,7 @@ import DS from 'ember-data';
 export default DS.Model.extend({
     category: DS.attr('string'),
     slug: DS.attr('string'),
+    description: DS.attr('string'),
     created_at: DS.attr('date'),
     crates_cnt: DS.attr('number'),
 

app/templates/categories.hbs

@@ -42,12 +42,19 @@
 <div class='white-rows'>
     {{#each model as |category|}}
         <div class='row'>
-            <div class='info'>
-                {{link-to category.category "category" category.slug}}
-                <span class='vers small'>
-                    {{ format-num category.crates_cnt }}
-                    crates
-                </span>
+            <div class='desc'>
+                <div class='info'>
+                    {{link-to category.category "category" category.slug}}
+                    <span class='small'>
+                        {{ format-num category.crates_cnt }}
+                        crates
+                    </span>
+                </div>
+                <div class='summary'>
+                    <span class='small'>
+                        {{ truncate-text category.description }}
+                    </span>
+                </div>
             </div>
         </div>
     {{/each}}

app/templates/category/index.hbs

@@ -11,12 +11,19 @@
       <div class='white-rows'>
           {{#each category.subcategories as |subcategory| }}
               <div class='row'>
-                  <div class='info'>
-                      {{link-to subcategory.category "category" subcategory.slug}}
-                      <span class='vers small'>
-                          {{ format-num subcategory.crates_cnt }}
-                          crates
-                      </span>
+                  <div class='desc'>
+                      <div class='info'>
+                          {{link-to subcategory.category "category" subcategory.slug}}
+                          <span class='small'>
+                              {{ format-num subcategory.crates_cnt }}
+                              crates
+                          </span>
+                      </div>
+                      <div class='summary'>
+                          <span class='small'>
+                              {{ truncate-text subcategory.description }}
+                          </span>
+                      </div>
                   </div>
               </div>
           {{/each}}

src/bin/migrate.rs

@@ -768,6 +768,7 @@ fn migrations() -> Vec<Migration> {
             id               SERIAL PRIMARY KEY, \
             category         VARCHAR NOT NULL UNIQUE, \
             slug             VARCHAR NOT NULL UNIQUE, \
+            description      VARCHAR NOT NULL DEFAULT '', \
             crates_cnt       INTEGER NOT NULL DEFAULT 0, \
             created_at       TIMESTAMP NOT NULL DEFAULT current_timestamp"),
         Migration::add_table(20161115111828, "crates_categories", " \

src/categories.rs

@@ -9,13 +9,15 @@ use util::errors::{CargoResult, ChainError, internal};
 struct Category {
     name: String,
     slug: String,
+    description: String,
 }
 
 impl Category {
     fn concat(&self, child: &Category) -> Category {
         Category {
             name: format!("{}::{}", self.name, child.name),
             slug: format!("{}::{}", self.slug, child.slug),
+            description: child.description.clone(),
         }
     }
 }
@@ -35,6 +37,14 @@ fn required_string_from_toml(toml: &toml::Table, key: &str)
         })
 }
 
+fn optional_string_from_toml(toml: &toml::Table, key: &str)
+                             -> String {
+    toml.get(key)
+        .and_then(toml::Value::as_str)
+        .unwrap_or("")
+        .to_string()
+}
+
 fn category_from_toml(toml: &toml::Value, parent: Option<&Category>)
                       -> CargoResult<Vec<Category>> {
     let toml = toml.as_table().chain_error(|| {
@@ -44,6 +54,7 @@ fn category_from_toml(toml: &toml::Value, parent: Option<&Category>)
     let category = Category {
         slug: required_string_from_toml(&toml, "slug")?,
         name: required_string_from_toml(&toml, "name")?,
+        description: optional_string_from_toml(&toml, "description"),
     };
 
     let category = concat_parent_and_child(parent, category);
@@ -85,25 +96,27 @@ pub fn sync() -> CargoResult<()> {
                 .expect("Categories from toml failed")
         }).collect();
 
-    let insert = categories.iter().map(|ref category| {
-        format!("(LOWER('{}'), '{}')", category.slug, category.name)
-    }).collect::<Vec<_>>().join(",");
+    for category in categories.iter() {
+        tx.execute("\
+            INSERT INTO categories (slug, category, description) \
+            VALUES (LOWER($1), $2, $3) \
+            ON CONFLICT (slug) DO UPDATE \
+                SET category = EXCLUDED.category, \
+                    description = EXCLUDED.description;",
+            &[&category.slug, &category.name, &category.description]
+        )?;
+    }
 
     let in_clause = categories.iter().map(|ref category| {
         format!("LOWER('{}')", category.slug)
     }).collect::<Vec<_>>().join(",");
 
-    try!(tx.batch_execute(
-        &format!(" \
-            INSERT INTO categories (slug, category) \
-            VALUES {} \
-            ON CONFLICT (slug) DO UPDATE SET category = EXCLUDED.category; \
-            DELETE FROM categories \
-            WHERE slug NOT IN ({});",
-            insert,
-            in_clause
-        )[..]
-    ));
+    tx.execute(&format!("\
+        DELETE FROM categories \
+        WHERE slug NOT IN ({});",
+        in_clause),
+        &[]
+    )?;
     tx.set_commit();
     tx.finish().unwrap();
     Ok(())

src/categories.toml

@@ -1,10 +1,12 @@
 [[categories]]
 slug = "development-tools"
 name = "Development Tools"
+description = "Ways to make developing in Rust better"
 
 [[categories.categories]]
   slug = "testing"
   name = "Testing"
+  description = "Additions to automated testing features"
 
   [[categories.categories.categories]]
     slug = "mocking"
@@ -17,11 +19,14 @@ name = "Libraries"
 [[categories.categories]]
   slug = "async"
   name = "Async"
+  description = "Code that can take time to run but won't block"
 
 [[categories.categories]]
   slug = "date-and-time"
   name = "Date and Time"
+  description = "Date and time math"
 
 [[categories]]
 slug = "games"
 name = "Games"
+description = "Share fun things"

src/category.rs

@@ -16,6 +16,7 @@ pub struct Category {
     pub id: i32,
     pub category: String,
     pub slug: String,
+    pub description: String,
     pub created_at: Timespec,
     pub crates_cnt: i32,
 }
@@ -25,6 +26,7 @@ pub struct EncodableCategory {
     pub id: String,
     pub category: String,
     pub slug: String,
+    pub description: String,
     pub created_at: String,
     pub crates_cnt: i32,
 }
@@ -34,6 +36,7 @@ pub struct EncodableCategoryWithSubcategories {
     pub id: String,
     pub category: String,
     pub slug: String,
+    pub description: String,
     pub created_at: String,
     pub crates_cnt: i32,
     pub subcategories: Vec<EncodableCategory>,
@@ -61,10 +64,13 @@ impl Category {
     }
 
     pub fn encodable(self) -> EncodableCategory {
-        let Category { id: _, crates_cnt, category, slug, created_at } = self;
+        let Category {
+            id: _, crates_cnt, category, slug, description, created_at
+        } = self;
         EncodableCategory {
             id: slug.clone(),
             slug: slug.clone(),
+            description: description.clone(),
             created_at: ::encode_time(created_at),
             crates_cnt: crates_cnt,
             category: category,
@@ -155,6 +161,7 @@ impl Model for Category {
             crates_cnt: row.get("crates_cnt"),
             category: row.get("category"),
             slug: row.get("slug"),
+            description: row.get("description"),
         }
     }
     fn table_name(_: Option<Category>) -> &'static str { "categories" }
@@ -174,7 +181,7 @@ pub fn index(req: &mut Request) -> CargoResult<Response> {
     // Collect all the top-level categories and sum up the crates_cnt of
     // the crates in all subcategories
     let stmt = try!(conn.prepare(&format!(
-        "SELECT c.id, c.category, c.slug, c.created_at, \
+        "SELECT c.id, c.category, c.slug, c.description, c.created_at, \
                 counts.sum::int as crates_cnt \
          FROM categories as c \
          LEFT JOIN ( \
@@ -224,6 +231,7 @@ pub fn show(req: &mut Request) -> CargoResult<Response> {
         id: cat.id,
         category: cat.category,
         slug: cat.slug,
+        description: cat.description,
         created_at: cat.created_at,
         crates_cnt: cat.crates_cnt,
         subcategories: subcats,