site: support permalinks. fixes googleapis#184

Author: stephenplusplus

docs/components/docs/docs.html

@@ -48,12 +48,17 @@ <h1>{{module[0].toUpperCase() + module.substr(1)}}</h1>
       </article>
     </article>
 
-    <article ng-repeat="method in methods" id="{{method.name}}">
+    <article
+      ng-repeat="method in methods"
+      ng-hide="singleMethod && method.name !== singleMethod">
       <h2 ng-if="method.name[0].toUpperCase() === method.name[0]">
         {{method.name}}
       </h2>
       <h3 ng-if="method.name[0].toUpperCase() !== method.name[0]">
-        {{method.name}}
+        <span ng-if="noHeadingLink">{{method.name}}</span>
+        <a ng-if="!noHeadingLink" ng-href="{{activeUrl + '/' + method.name}}">
+          {{method.name}}
+        </a>
       </h3>
       <p ng-if="method.description" ng-bind-html="method.description"></p>
       <h4 ng-show="method.params">Parameters</h4>

docs/components/docs/docs.js

@@ -100,14 +100,39 @@ angular
       };
     }
 
+    function setMethod($location, methodName) {
+      return function(methods) {
+        var methodExists = methods.some(function(methodObj) {
+          return methodName === methodObj.name;
+        });
+        if (methodExists) {
+          methods.singleMethod = methodName;
+          return methods;
+        } else {
+          $location.path('/docs/' + module + '/' + cl);
+        }
+      };
+    }
+
+    var MODULE_TO_CLASSES = {
+      datastore: ['dataset', 'query'],
+      storage: []
+    };
+
     $routeProvider
       .when('/docs', {
         controller: 'DocsCtrl',
         templateUrl: '/gcloud-node/components/docs/docs.html',
         resolve: {
           methods: function($http, $sce) {
             return $http.get('/gcloud-node/json/index.json')
-                .then(filterDocJson($sce));
+                .then(filterDocJson($sce))
+                .then(function(methods) {
+                  // Prevent headings from turning into links.
+                  // ** Can remove when PubSub api is documented **
+                  methods.noHeadingLink = true;
+                  return methods;
+                });
           }
         }
       })
@@ -117,6 +142,9 @@ angular
         resolve: {
           methods: function($http, $route, $sce) {
             var module = $route.current.params.module;
+            if (!MODULE_TO_CLASSES[module]) {
+              return [];
+            }
             return $http.get('/gcloud-node/json/' + module + '/index.json')
                 .then(filterDocJson($sce));
           }
@@ -126,11 +154,33 @@ angular
         controller: 'DocsCtrl',
         templateUrl: '/gcloud-node/components/docs/docs.html',
         resolve: {
-          methods: function($q, $http, $route, $sce) {
+          methods: function($q, $http, $route, $sce, $location) {
             var module = $route.current.params.module;
             var cl = $route.current.params.class;
+            if (MODULE_TO_CLASSES[module].length > 0) {
+              return $http
+                  .get('/gcloud-node/json/' + module + '/' + cl + '.json')
+                  .then(filterDocJson($sce));
+            } else {
+              var method = cl;
+              return $http.get('/gcloud-node/json/' + module + '/index.json')
+                  .then(filterDocJson($sce))
+                  .then(setMethod($location, method));
+            }
+          }
+        }
+      })
+      .when('/docs/:module/:class/:method', {
+        controller: 'DocsCtrl',
+        templateUrl: '/gcloud-node/components/docs/docs.html',
+        resolve: {
+          methods: function($q, $http, $route, $sce, $location) {
+            var module = $route.current.params.module;
+            var cl = $route.current.params.class;
+            var method = $route.current.params.method;
             return $http.get('/gcloud-node/json/' + module + '/' + cl + '.json')
-                .then(filterDocJson($sce));
+                .then(filterDocJson($sce))
+                .then(setMethod($location, method));
           }
         }
       });
@@ -139,13 +189,20 @@ angular
     'use strict';
 
     $scope.isActiveUrl = function(url) {
-      return url.replace(/^\/gcloud-node\/#/, '') === $location.path();
+      var current = $location.path().replace('/' + methods.singleMethod, '');
+      var link = url
+          .replace(/^\/gcloud-node\/#/, '')
+          .replace('/' + methods.singleMethod, '');
+      return current === link;
     };
 
     $scope.isActiveDoc = function(doc) {
       return doc.toLowerCase() === $routeParams.module;
     };
 
+    $scope.activeUrl = '/gcloud-node/#' + $location.path();
+    $scope.singleMethod = methods.singleMethod;
+    $scope.noHeadingLink = methods.singleMethod || methods.noHeadingLink;
     $scope.methods = methods;
     $scope.module = $routeParams.module;
     $scope.pages = [

docs/home.js

@@ -7,4 +7,16 @@ angular
       .when('/', {
         templateUrl: '/gcloud-node/home.html'
       });
+  })
+  .run(function($rootScope, $location) {
+    'use strict';
+
+    $rootScope.$on('$routeChangeStart', function(event) {
+      var hash = $location.hash();
+      if (hash) {
+        event.preventDefault();
+        $location.hash('');
+        $location.replace().path($location.path() + '/' + hash);
+      }
+    });
   });