Merge pull request #473 from integer32llc/categorization

Add Categorization!

Cargo.toml

@@ -35,6 +35,7 @@ env_logger = "0.3"
 rustc-serialize = "0.3"
 license-exprs = "^1.3"
 dotenv = "0.8.0"
+toml = "0.2"
 
 conduit = "0.8"
 conduit-conditional-get = "0.8"

README.md

@@ -123,6 +123,21 @@ follows:
     ```
     cargo test
     ```
+
+## Categories
+
+The list of categories available on crates.io is stored in
+`src/categories.toml`. To propose adding, removing, or changing a category,
+send a pull request making the appropriate change to that file as noted in the
+comment at the top of the file. Please add a description that will help others
+to know what crates are in that category.
+
+For new categories, it's helpful to note in your PR description examples of
+crates that would fit in that category, and describe what distinguishes the new
+category from existing categories.
+
+After your PR is accepted, the next time that crates.io is deployed the
+categories will be synced from this file.
 
 ## Deploying & Using a Mirror
 

app/adapters/category-slug.js

@@ -0,0 +1,11 @@
+import ApplicationAdapter from './application';
+import Ember from 'ember';
+
+export default ApplicationAdapter.extend({
+    pathForType(modelName) {
+        var decamelized = Ember.String.underscore(
+          Ember.String.decamelize(modelName)
+        );
+        return Ember.String.pluralize(decamelized);
+    }
+});

app/controllers/categories.js

@@ -0,0 +1,17 @@
+import Ember from 'ember';
+import PaginationMixin from '../mixins/pagination';
+
+const { computed } = Ember;
+
+export default Ember.Controller.extend(PaginationMixin, {
+    queryParams: ['page', 'per_page', 'sort'],
+    page: '1',
+    per_page: 10,
+    sort: 'alpha',
+
+    totalItems: computed.readOnly('model.meta.total'),
+
+    currentSortBy: computed('sort', function() {
+        return (this.get('sort') === 'crates') ? '# Crates' : 'Alphabetical';
+    }),
+});

app/controllers/category/index.js

@@ -0,0 +1,17 @@
+import Ember from 'ember';
+import PaginationMixin from '../../mixins/pagination';
+
+const { computed } = Ember;
+
+export default Ember.Controller.extend(PaginationMixin, {
+    queryParams: ['page', 'per_page', 'sort'],
+    page: '1',
+    per_page: 10,
+    sort: 'downloads',
+
+    totalItems: computed.readOnly('model.meta.total'),
+
+    currentSortBy: computed('sort', function() {
+        return (this.get('sort') === 'downloads') ? 'Downloads' : 'Alphabetical';
+    }),
+});

app/controllers/crate/version.js

@@ -19,6 +19,7 @@ export default Ember.Controller.extend({
     currentVersion: computed.alias('model'),
     requestedVersion: null,
     keywords: computed.alias('crate.keywords'),
+    categories: computed.alias('crate.categories'),
 
     sortedVersions: computed.readOnly('crate.versions'),
 
@@ -49,6 +50,7 @@ export default Ember.Controller.extend({
     }),
 
     anyKeywords: computed.gt('keywords.length', 0),
+    anyCategories: computed.gt('categories.length', 0),
 
     currentDependencies: computed('currentVersion.dependencies', function() {
         var deps = this.get('currentVersion.dependencies');

app/models/category-slug.js

@@ -0,0 +1,5 @@
+import DS from 'ember-data';
+
+export default DS.Model.extend({
+    slug: DS.attr('string'),
+});

app/models/category.js

@@ -0,0 +1,13 @@
+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'),
+
+    subcategories: DS.attr(),
+
+    crates: DS.hasMany('crate', { async: true })
+});

app/models/crate.js

@@ -20,6 +20,7 @@ export default DS.Model.extend({
     owners: DS.hasMany('users', { async: true }),
     version_downloads: DS.hasMany('version-download', { async: true }),
     keywords: DS.hasMany('keywords', { async: true }),
+    categories: DS.hasMany('categories', { async: true }),
     reverse_dependencies: DS.hasMany('dependency', { async: true }),
 
     follow() {

app/router.js

@@ -35,6 +35,11 @@ Router.map(function() {
     this.route('keyword', { path: '/keywords/:keyword_id' }, function() {
         this.route('index', { path: '/' });
     });
+    this.route('categories');
+    this.route('category', { path: '/categories/:category_id' }, function() {
+        this.route('index', { path: '/' });
+    });
+    this.route('category_slugs');
     this.route('catchAll', { path: '*path' });
 });
 

app/routes/categories.js

@@ -0,0 +1,12 @@
+import Ember from 'ember';
+
+export default Ember.Route.extend({
+    queryParams: {
+        page: { refreshModel: true },
+        sort: { refreshModel: true },
+    },
+
+    model(params) {
+        return this.store.query('category', params);
+    },
+});

app/routes/category-slugs.js

@@ -0,0 +1,12 @@
+import Ember from 'ember';
+
+export default Ember.Route.extend({
+    queryParams: {
+        page: { refreshModel: true },
+        sort: { refreshModel: true },
+    },
+
+    model(params) {
+        return this.store.query('category-slug', params);
+    },
+});

app/routes/category.js

@@ -0,0 +1,11 @@
+import Ember from 'ember';
+
+export default Ember.Route.extend({
+    model(params) {
+        return this.store.find('category', params.category_id).catch(e => {
+            if (e.errors.any(e => e.detail === 'Not Found')) {
+                this.controllerFor('application').set('flashError', `Category '${params.category_id}' does not exist`);
+            }
+        });
+    }
+});

app/routes/category/index.js

@@ -0,0 +1,18 @@
+import Ember from 'ember';
+
+export default Ember.Route.extend({
+    queryParams: {
+        page: { refreshModel: true },
+        sort: { refreshModel: true },
+    },
+
+    model(params) {
+        params.category = this.modelFor('category').id;
+        return this.store.query('crate', params);
+    },
+
+    setupController(controller, model) {
+        controller.set('category', this.modelFor('category'));
+        this._super(controller, model);
+    },
+});

app/templates/categories.hbs

@@ -0,0 +1,73 @@
+{{ title 'Categories' }}
+
+<div id='crates-heading'>
+    <img class='logo crate' src="/assets/crate.png"/>
+    <h1>All Categories</h1>
+</div>
+
+<div id='results'>
+    <div class='nav'>
+        <span class='amt small'>
+            Displaying
+            <span class='cur'>{{ currentPageStart }}-{{ currentPageEnd }}</span>
+            of <span class='total'>{{ totalItems }}</span> total results
+        </span>
+    </div>
+
+    <div class='sort'>
+        <span class='small'>Sort by</span>
+        {{#rl-dropdown-container class="dropdown-container"}}
+            {{#rl-dropdown-toggle tagName="a" class="dropdown"}}
+                <img class="sort" src="/assets/sort.png"/>
+                {{ currentSortBy }}
+                <span class='arrow'></span>
+            {{/rl-dropdown-toggle}}
+
+            {{#rl-dropdown tagName="ul" class="dropdown" closeOnChildClick="a:link"}}
+                <li>
+                    {{#link-to (query-params sort="alpha")}}
+                        Alphabetical
+                    {{/link-to}}
+                </li>
+                <li>
+                    {{#link-to (query-params sort="crates")}}
+                        # Crates
+                    {{/link-to}}
+                </li>
+            {{/rl-dropdown}}
+        {{/rl-dropdown-container}}
+    </div>
+</div>
+
+<div class='white-rows'>
+    {{#each model as |category|}}
+        <div class='row'>
+            <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}}
+</div>
+
+<div class='pagination'>
+    {{#link-to (query-params page=prevPage) class="prev" rel="prev" title="previous page"}}
+        <img class="left-pag" src="/assets/left-pag.png"/>
+    {{/link-to}}
+    {{#each pages as |page|}}
+        {{#link-to (query-params page=page)}}{{ page }}{{/link-to}}
+    {{/each}}
+    {{#link-to (query-params page=nextPage) class="next" rel="next" title="next page"}}
+        <img class="right-pag" src="/assets/right-pag.png"/>
+    {{/link-to}}
+</div>

app/templates/category/error.hbs

@@ -0,0 +1 @@
+{{ title 'Category Not Found' }}

app/templates/category/index.hbs

@@ -0,0 +1,85 @@
+{{ title category.category ' - Categories' }}
+
+<div id='crates-heading'>
+    <img class='logo crate' src="/assets/crate.png"/>
+    <h1>{{ category.category }}</h1>
+</div>
+
+{{#if category.subcategories }}
+  <div id='subcategories'>
+      <h2>Subcategories</h2>
+      <div class='white-rows'>
+          {{#each category.subcategories as |subcategory| }}
+              <div class='row'>
+                  <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}}
+      </div>
+  </div>
+{{/if}}
+
+<h2>Crates</h2>
+<div id='results'>
+    <div class='nav'>
+        <span class='amt small'>
+            Displaying
+            <span class='cur'>{{ currentPageStart }}-{{ currentPageEnd }}</span>
+            of <span class='total'>{{ totalItems }}</span> total results
+        </span>
+    </div>
+
+    <div class='sort'>
+        <span class='small'>Sort by</span>
+        {{#rl-dropdown-container class="dropdown-container"}}
+            {{#rl-dropdown-toggle tagName="a" class="dropdown"}}
+                <img class="sort" src="/assets/sort.png"/>
+                {{ currentSortBy }}
+                <span class='arrow'></span>
+            {{/rl-dropdown-toggle}}
+
+            {{#rl-dropdown tagName="ul" class="dropdown" closeOnChildClick="a:link"}}
+                <li>
+                    {{#link-to (query-params sort="alpha")}}
+                        Alphabetical
+                    {{/link-to}}
+                </li>
+                <li>
+                    {{#link-to (query-params sort="downloads")}}
+                        Downloads
+                    {{/link-to}}
+                </li>
+            {{/rl-dropdown}}
+        {{/rl-dropdown-container}}
+    </div>
+</div>
+
+<div id='crates' class='white-rows'>
+    {{#each model as |crate|}}
+        {{crate-row crate=crate}}
+    {{/each}}
+</div>
+
+<div class='pagination'>
+    {{#link-to (query-params page=prevPage) class="prev" rel="prev" title="previous page"}}
+        <img class="left-pag" src="/assets/left-pag.png"/>
+    {{/link-to}}
+    {{#each pages as |page|}}
+        {{#link-to (query-params page=page)}}{{ page }}{{/link-to}}
+    {{/each}}
+    {{#link-to (query-params page=nextPage) class="next" rel="next" title="next page"}}
+        <img class="right-pag" src="/assets/right-pag.png"/>
+    {{/link-to}}
+</div>