added section to help entries

rueckstiess · kangas · commit 99f6b29d2d1b · 2015-11-23T00:22:20.000-05:00
diff --git a/src/help/entries/connect-favorite-name.md b/src/help/entries/connect-favorite-name.md
@@ -4,6 +4,7 @@ tags:
   - authentication
   - connect
   - favorite
+section: Connect
 ---
 
 <strong>Favorite name for a saved connection.</strong>
diff --git a/src/help/entries/connect-kerberos-principal.md b/src/help/entries/connect-kerberos-principal.md
@@ -7,6 +7,7 @@ tags:
   - needs review
 related:
   - connect-kerberos-service-name
+section: Connect
 ---
 
 <strong>
diff --git a/src/help/entries/connect-kerberos-service-name.md b/src/help/entries/connect-kerberos-service-name.md
@@ -5,6 +5,7 @@ tags:
   - connect
   - kerberos
   - needs review
+section: Connect
 ---
 
 <strong>
diff --git a/src/help/entries/connect-ssl-certificate-authority.md b/src/help/entries/connect-ssl-certificate-authority.md
@@ -9,6 +9,7 @@ related:
   - connect-ssl-client-certificate-key
   - connect-ssl-client-certificate
   - connect-ssl-private-key-password
+section: Connect
 ---
 
 <strong>
diff --git a/src/help/entries/connect-ssl-client-certificate-key.md b/src/help/entries/connect-ssl-client-certificate-key.md
@@ -9,6 +9,7 @@ related:
   - connect-ssl-certificate-authority
   - connect-ssl-client-certificate
   - connect-ssl-private-key-password
+section: Connect
 ---
 Describes what the `Client Certificate Key` field in the connect dialog does.
 
diff --git a/src/help/entries/connect-ssl-client-certificate.md b/src/help/entries/connect-ssl-client-certificate.md
@@ -9,6 +9,7 @@ related:
   - connect-ssl-certificate-authority
   - connect-ssl-client-certificate-key
   - connect-ssl-private-key-password
+section: Connect
 ---
 Describes what the `Client Certificate` field in the connect dialog does.
 
diff --git a/src/help/entries/connect-ssl-private-key-password.md b/src/help/entries/connect-ssl-private-key-password.md
@@ -9,5 +9,6 @@ related:
   - connect-ssl-certificate-authority
   - connect-ssl-client-certificate-key
   - connect-ssl-client-certificate
+section: Connect
 ---
 Describes what the `Private Key Password` field in the connect dialog does. It's optional.
diff --git a/src/help/entries/connect-userpass-auth-db.md b/src/help/entries/connect-userpass-auth-db.md
@@ -3,6 +3,7 @@ title: Authentication Database
 tags:
   - authentication
   - connect
+section: Connect
 ---
 <strong>This field represents the _Authentication Database_ (also called
 _Authentication Source_) for User/Password authentication.</strong>
diff --git a/src/help/entries/dev-ampersand-tips.md b/src/help/entries/dev-ampersand-tips.md
@@ -6,6 +6,7 @@ tags:
   - view
   - model
 devOnly: true
+section: Development
 ---
 
 <strong>Ampersand.js is the Model and View layer used by Compass.</strong>
diff --git a/src/help/entries/dev-how-help-works.md b/src/help/entries/dev-how-help-works.md
@@ -3,6 +3,7 @@ title: Compass Help System
 tags:
   - help
 devOnly: true
+section: Development
 ---
 
 <strong>This entry explains the help system in Compass.</strong>
diff --git a/src/help/entries/dev-taxonomy.md b/src/help/entries/dev-taxonomy.md
@@ -4,6 +4,7 @@ tags:
   - taxonomy
   - needs work
 devOnly: true
+section: Development
 ---
 
 The [docs style guide][docs-style] has a beautifully detailed and thorough
diff --git a/src/help/entries/schema-how-sampling-works.md b/src/help/entries/schema-how-sampling-works.md
@@ -3,6 +3,7 @@ title: How Sampling Works
 tags:
   - schema
   - sampling
+section: Schema
 ---
 <strong>Sampling in MongoDB Compass is the practice of selecting a subset of data from the desired collection and analyzing the documents within the sample set.</strong>
 
@@ -20,4 +21,4 @@ Collections in MongoDB 3.0 and 2.6 are sampled via a backwards compatible algori
 
 The choice of sampling method is transparent in usage to the end-user.
 
-`sampleSize` is currently set to 100 documents.
+`sampleSize` is currently set to 100 documents.
diff --git a/src/help/entries/schema-query-bar.md b/src/help/entries/schema-query-bar.md
@@ -5,4 +5,5 @@ tags:
   - sampling
   - query
   - todo
+section: Schema
 ---
diff --git a/src/help/entries/schema-sampling-results.md b/src/help/entries/schema-sampling-results.md
@@ -7,6 +7,7 @@ tags:
 related:
   - schema-how-sampling-works
   - schema-query-bar
+section: Schema
 ---
 <strong>
 The message below the Query Bar provides information about the
diff --git a/src/help/index.js b/src/help/index.js
@@ -3,9 +3,10 @@ var format = require('util').format;
 var debug = require('debug')('scout:help');
 var relatedTemplate = require('./related.jade');
 var tagTemplate = require('./tags.jade');
+var HelpSectionCollection = require('../models/help-section-collection');
 var HelpEntryCollection = require('../models/help-entry-collection');
 var HelpEntry = require('../models/help-entry');
-var SidebarView = require('./sidebar');
+var SidebarView = require('../sidebar');
 var ViewSwitcher = require('ampersand-view-switcher');
 var app = require('ampersand-app');
 var _ = require('lodash');
@@ -19,6 +20,9 @@ var HelpPage = View.extend({
   children: {
     entry: HelpEntry
   },
+  collections: {
+    sections: HelpSectionCollection
+  },
   derived: {
     title: {
       deps: ['entry.title'],
@@ -44,17 +48,10 @@ var HelpPage = View.extend({
       }
     }
   },
-  onLinkClicked: function(evt) {
-    evt.preventDefault();
-    evt.stopPropagation();
-    // @todo handle external links
-    var entryId = evt.delegateTarget.hash.slice(1);
-    if (entryId) {
-      this.show(entryId);
-    }
-  },
   template: require('./index.jade'),
   initialize: function(spec) {
+    debug('initialize');
+
     spec = spec || {};
     entries.fetch();
 
@@ -64,22 +61,46 @@ var HelpPage = View.extend({
     }
     this.listenTo(this, 'change:rendered', function() {
       this.viewSwitcher = new ViewSwitcher(this.queryByHook('help-entry-content'));
-
-      if (this.entryId) {
-        this.show(this.entryId);
-      }
+      this.show(this.entryId);
     });
 
     this.listenTo(app, 'show-help-entry', this.show.bind(this));
   },
+  onLinkClicked: function(evt) {
+    evt.preventDefault();
+    evt.stopPropagation();
+    // @todo handle external links
+    var entryId = evt.delegateTarget.hash.slice(1);
+    if (entryId) {
+      this.show(entryId);
+    }
+  },
+  onSynced: function(entryId) {
+    // group by sections
+    this.sections.reset(
+      _.map(entries.groupBy('section'), function(value, key) {
+        return {
+          name: key === 'undefined' ? 'General' : key,
+          entries: value
+        };
+      }), {
+        parse: true
+      }
+    );
+    this.show(entryId);
+  },
   show: function(entryId) {
     debug('show `%s`', entryId);
     if (entries.length === 0) {
-      entries.once('sync', this.show.bind(this, entryId));
+      entries.once('sync', this.onSynced.bind(this, entryId));
       debug('entries not synced yet.  queuing...');
       return;
     }
 
+    if (!entryId) {
+      return;
+    }
+
     var entry = entries.get(entryId);
 
     if (!entry) {
@@ -136,12 +157,20 @@ var HelpPage = View.extend({
   subviews: {
     sidebar: {
       hook: 'sidebar-subview',
+      // waitFor: 'sections',
       prepareView: function(el) {
         return new SidebarView({
           el: el,
           parent: this,
-          entries: entries
-        });
+          collection: this.sections,
+          displayProp: 'name',
+          filterEnabled: true,
+          icon: 'fa-book',
+          nested: {
+            displayProp: 'title',
+            collectionName: 'entries'
+          }
+        }).on('show', this.show.bind(this));
       }
     }
   }
diff --git a/src/home/collection-list-item.js b/src/home/collection-list-item.js
@@ -0,0 +1,39 @@
+var ListItemView = require('../sidebar/list-item');
+var toNS = require('mongodb-ns');
+var _ = require('lodash');
+// var debug = require('debug')('scout:sidebar:collection-list-item');
+
+var CollectionListItemView = ListItemView.extend({
+  props: {
+    displayProp: ['string', true, 'name']
+  },
+  bindings: _.extend({}, ListItemView.prototype.bindings, {
+    is_special: {
+      type: 'booleanClass',
+      name: 'special'
+    }
+  }),
+  derived: {
+    is_special: {
+      deps: ['model._id'],
+      fn: function() {
+        if (!this.model._id) {
+          return false;
+        }
+        return toNS(this.model._id).specialish;
+      }
+    },
+    title: {
+      deps: ['model._id', 'is_special'],
+      fn: function() {
+        var title = this.model._id;
+        if (this.is_special) {
+          title += ' (internal collection)';
+        }
+        return title;
+      }
+    }
+  }
+});
+
+module.exports = CollectionListItemView;
diff --git a/src/home/index.js b/src/home/index.js
@@ -3,6 +3,7 @@ var format = require('util').format;
 var SidebarView = require('../sidebar');
 var CollectionView = require('./collection');
 var InstancePropertyView = require('./instance-properties');
+var CollectionListItemView = require('./collection-list-item');
 var TourView = require('../tour');
 var app = require('ampersand-app');
 var debug = require('debug')('scout:home');
@@ -134,8 +135,9 @@ var HomeView = View.extend({
             }
           }],
           nested: {
-            collectionName: 'collections',
-            displayProp: 'name'
+            itemViewClass: CollectionListItemView,
+            collectionName: 'collections'
+            // displayProp: 'name'
           },
           collection: app.instance.databases
         }).on('show', this.showCollection.bind(this));
diff --git a/src/models/help-entry-collection.js b/src/models/help-entry-collection.js
@@ -1,44 +1,48 @@
 var Collection = require('ampersand-rest-collection');
 var HelpEntry = require('./help-entry');
+var lodashMixin = require('ampersand-collection-lodash-mixin');
 var selectableMixin = require('./selectable-collection-mixin');
+var filterableMixin = require('ampersand-collection-filterable');
 var withSync = require('./with-sync');
 var debug = require('debug')('scout:models:help-entry-collection');
 var ipc = window.require('ipc');
 
-var HelpEntryCollection = Collection.extend(selectableMixin, {
-  namespace: 'HelpEntryCollection',
-  comparator: 'title',
-  model: HelpEntry
-}, withSync(function(options, done) {
-  if (options.method !== 'read') {
-    return done(new TypeError('Read-only!'));
-  }
+var HelpEntryCollection = Collection.extend(
+  selectableMixin, lodashMixin, filterableMixin, {
+    namespace: 'HelpEntryCollection',
+    comparator: 'title',
+    model: HelpEntry
+  }, withSync(function(options, done) {
+    if (options.method !== 'read') {
+      return done(new TypeError('Read-only!'));
+    }
 
-  debug('sync called w options', options);
+    debug('sync called w options', options);
 
-  if (this.models.length > 0) {
-    debug('already fetched');
-    options.reset = false;
-    return done();
-  }
+    if (this.models.length > 0) {
+      debug('already fetched');
+      options.reset = false;
+      return done();
+    }
 
-  var onSuccess;
-  var onError = function(err) {
-    debug('error', err);
-    ipc.removeListener('/help/entries/success', onSuccess);
-    done(err);
-  };
+    var onSuccess;
+    var onError = function(err) {
+      debug('error', err);
+      ipc.removeListener('/help/entries/success', onSuccess);
+      done(err);
+    };
 
-  onSuccess = function(entries) {
-    debug('got entries', entries);
-    ipc.removeListener('/help/entries/error', onError);
-    done(null, entries);
-  };
+    onSuccess = function(entries) {
+      debug('got entries', entries);
+      ipc.removeListener('/help/entries/error', onError);
+      done(null, entries);
+    };
 
-  debug('loading help entries...');
-  ipc.once('/help/entries/success', onSuccess)
-    .once('/help/entries/error', onError)
-    .send('/help/entries');
-}));
+    debug('loading help entries...');
+    ipc.once('/help/entries/success', onSuccess)
+      .once('/help/entries/error', onError)
+      .send('/help/entries');
+  }
+));
 
 module.exports = HelpEntryCollection;
diff --git a/src/models/help-entry.js b/src/models/help-entry.js
@@ -10,7 +10,8 @@ var HelpEntry = State.extend({
     content: 'string',
     tags: 'array',
     related: 'array',
-    devOnly: 'boolean'
+    devOnly: 'boolean',
+    section: 'string'
   },
   derived: {
     url: {
@@ -32,9 +33,10 @@ var HelpEntry = State.extend({
       id: resp.filename.replace('.md', ''),
       title: resp.meta.title,
       tags: resp.meta.tags || [],
+      content: resp.content,
       related: resp.meta.related || [],
       devOnly: !!resp.meta.devOnly,
-      content: resp.content
+      section: resp.meta.section
     };
   }
 });
diff --git a/src/models/help-section-collection.js b/src/models/help-section-collection.js
diff --git a/src/models/help-section.js b/src/models/help-section.js
diff --git a/src/sidebar/filter.jade b/src/sidebar/filter.jade
diff --git a/src/sidebar/filter.js b/src/sidebar/filter.js
diff --git a/src/sidebar/index.js b/src/sidebar/index.js
