Feature/better project page

app.js

@@ -11,6 +11,9 @@ var cookieParser = require('cookie-parser');
 var bodyParser = require('body-parser');
 var hbs = require('hbs');
 
+// Pull in polyfills.
+require('./polyfill');
+
 var appVersion = require('./package.json').version;
 
 // Set the config object for use elsewhere.

features-support/test-data/no-feature-file.feature

@@ -0,0 +1 @@
+# This file contains no feature.

lib/configuration/index.js

@@ -12,6 +12,12 @@ var folderNames = {
   projects: 'projects'
 };
 
+// List of filename extensions the app cares about.
+var filesOfInterest = [
+  'feature',
+  'md'
+];
+
 // Cached instance of Config.
 var configInstance;
 
@@ -25,6 +31,11 @@ function Config(configuration) {
   this.dataStoragePath = path.join(this.rootPath, folderNames.dataStorage);
   this.derivedDataPath = path.join(this.dataStoragePath, folderNames.derived);
   this.projectsPath = path.join(this.dataStoragePath, folderNames.projects);
+
+  this.regex = {};
+
+  // Define which file types the application willl process and display.
+  this.regex['fileOfInterest'] = new RegExp('\\.(' + filesOfInterest.join('|') + ')$');
 }
 
 /**

lib/specifications/project.js

@@ -2,8 +2,9 @@
 
 var fs = require('q-io/fs');
 
-var getProject = require('./repositoryTypes/git').getProject;
-var getProjectData = require('./repositoryTypes/git').getProjectData;
+var getProjectGit = require('./repositoryTypes/git').getProject;
+var getProjectDataGit = require('./repositoryTypes/git').getProjectData;
+var getFileContentsGit = require('./repositoryTypes/git').getFileContents;
 var config = require('../configuration').get();
 
 
@@ -13,16 +14,23 @@ var config = require('../configuration').get();
  * @return a promise for the meta data for one project.
  */
 function get(projectData) {
-  return getProject(projectData);
+  return getProjectGit(projectData);
 }
 
+function getData(projectData, targetBranchName) {
+  return getProjectDataGit(projectData, targetBranchName);
+}
+
+function getFileContents(projectData, filePath) {
+  return getFileContentsGit(projectData, filePath);
+}
 
 /**
- * Get the meta data for all projects.
+ * Get a list of known project names.
  *
- * @return a promise for an array meta data for all the projects.
+ * @return a promise for an array of project names.
  */
-function getAll() {
+function getNames() {
   return fs.list(config.projectsPath)
       .then(function(paths) {
         return paths.map(function(path) {
@@ -40,7 +48,8 @@ function getAll() {
 }
 
 module.exports = {
-  getAll: getAll,
   get: get,
-  getData: getProjectData
+  getData: getData,
+  getNames: getNames,
+  getFileContents: getFileContents
 };

lib/specifications/repositoryTypes/git.js

@@ -50,9 +50,8 @@ function generateRepoMetaData(projectData, sha, tagsAndBranches, currentBranchNa
     shortCommit: sha.substring(0, 7),
     tagsAndBranches: tagsAndBranches,
     currentBranchName: currentBranchName,
-    currentBranchNameShort: currentBranchName,
-    featureFilePaths: files,
-    repoUrl: remoteUrl
+    repoUrl: remoteUrl,
+    files: files
   };
 
   // Filter falsey values and empty arrays.
@@ -78,8 +77,24 @@ function generateRepoMetaData(projectData, sha, tagsAndBranches, currentBranchNa
  *
  * @return a promise for the repo metadata.
  */
-function clone(projectData, cloneOptions) {
+function clone(projectData) {
   var repository;
+
+  // Need to define this here as the Clone function modifies the passed object (face palm).
+  var cloneOptions = {};
+  cloneOptions.bare = 1;
+
+  // Mac OSX certificate issue http://www.nodegit.org/guides/cloning/
+  // This is now an undocumented Mac only part of the API.
+  cloneOptions.remoteCallbacks = ignoreSSLErrors;
+
+  // General option to ingore SSL errors.
+  if(appConfig.allowInsecureSSL) {
+    cloneOptions.fetchOpts = {
+      callbacks: ignoreSSLErrors
+    };
+  }
+
   if (!projectData.repoUrl) {
     throw new TypeError('Clone called without a repo URL. Possible wrong project name?');
   }
@@ -104,11 +119,13 @@ function update(projectData) {
   return git.Repository.openBare(projectData.localPath)
     .then(function (repository) {
 
-      // Sync.
-      // BUG: this doesn't seem to pull down new tags.
-      repository.fetch(repository.getRemote('origin'), {
+      // BUG: This isn't working at all, no new tags or branch are pulled down,
+      // current heads aren't updated.
+      // https://github.com/nodegit/nodegit/issues/742
+      return repository.fetch(repository.getRemote('origin'), {
         callback: ignoreSSLErrors,
-        downloadTags: 1
+        downloadTags: 1,
+        prune: 1
       });
     })
     .then(function () {
@@ -125,35 +142,20 @@ function getProject(projectData) {
   return fs.exists(projectData.localPath)
     .then(function (pathExists) {
 
-      // Need to define this here as the Clone function modifies the passed object (face palm).
-      var cloneOptions = {};
-      cloneOptions.bare = 1;
-
-      // Mac OSX certificate issue http://www.nodegit.org/guides/cloning/
-      // This is now an undocumented Mac only part of the API.
-      cloneOptions.remoteCallbacks = ignoreSSLErrors;
-
-      // General option to ingore SSL errors.
-      if(appConfig.allowInsecureSSL) {
-        cloneOptions.fetchOpts = {
-          callbacks: ignoreSSLErrors
-        };
-      }
-
       /**
        * If there is no matching directory then clone the repo
        * else perform a pull on it.
        */
       if (!pathExists) {
-        return clone(projectData, cloneOptions);
+        return clone(projectData);
       } else {
         return update(projectData);
       }
     });
 }
 
 function getBranch(projectData, branchName) {
-  return git.Repository.open(projectData.localPath)
+  return git.Repository.openBare(projectData.localPath)
     .then(function (repo) {
       if (branchName) {
         return repo.getBranch(branchName);
@@ -168,7 +170,7 @@ function getBranch(projectData, branchName) {
 // if that fails fall bacl to try the annotated tag approach.
 function getCommitByName(repository, refName) {
   return repository.getReferenceCommit(refName)
-    .catch(function(err) {
+    .catch(function() {
       return repository.getTagByName(refName).then(function(tag) {
         return repository.getCommit(tag.targetId().tostrS());
       });
@@ -185,7 +187,7 @@ function getProjectData(projectData, targetBranchName) {
   return getBranch(projectData, targetBranchName)
     .then(function (ref) {
       currentRef = ref;
-      return git.Repository.open(projectData.localPath);
+      return git.Repository.openBare(projectData.localPath);
     })
     .then(function (repo) {
       repository = repo;
@@ -201,13 +203,8 @@ function getProjectData(projectData, targetBranchName) {
     })
     .then(getAllFiles)
     .then(function (files) {
-      listOfFiles = files.map(function (fileOfInterestName) {
-        return {
-          ref: currentRef.name(),
-          featureName: fileOfInterestName,
-          featureNameShort: fileOfInterestName.replace(/\.feature$/, '')
-        };
-      });
+      listOfFiles = files;
+
       return repository.getReferences(git.Reference.TYPE.OID);
     })
     .then(function (refs) {
@@ -219,7 +216,11 @@ function getProjectData(projectData, targetBranchName) {
 function getFileContents(projectData, filePath) {
   var repository;
 
-  return git.Repository.open(projectData.localPath)
+  if (!filePath) {
+    throw new TypeError('Please supply a file path to read file contents.');
+  }
+
+  return git.Repository.openBare(projectData.localPath)
     .then(function (repo) {
       repository = repo;
       return getCommitByName(repository, projectData.currentBranchName);
@@ -261,7 +262,7 @@ function getAllFiles(tree) {
   return _getAllFiles(tree)
     .then(function (files) {
       return files.filter(function (f) {
-        return /\.(feature|md)/.test(f);
+        return (appConfig.regex.fileOfInterest).test(f);
       });
     });
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "oss-specs",
-  "version": "0.10.1",
+  "version": "0.11.1",
   "bin": {
     "oss-specs": "./bin/www"
   },
@@ -56,6 +56,7 @@
     "express": "^4.13.3",
     "express-session": "^1.11.3",
     "file-stream-rotator": "0.0.6",
+    "file-tree": "git+https://github.com/jimCresswell/file-tree#v1.0.1-rc1",
     "gherkin": "^3.1.1",
     "github-markdown-css": "^2.0.10",
     "hbs": "^3.1.1",
@@ -68,6 +69,7 @@
     "q-io": "^1.13.1",
     "serve-favicon": "^2.3.0",
     "session-file-store": "0.0.20",
+    "tree-model": "^1.0.2",
     "underscore": "1.8.3"
   },
   "devDependencies": {

polyfill.js

@@ -0,0 +1,13 @@
+if (!String.prototype.endsWith) {
+  String.prototype.endsWith = function(searchString, position) {
+    var subjectString = this.toString();
+    if (typeof position !== 'number' || !isFinite(position) || Math.floor(position) !== position || position > subjectString.length) {
+      position = subjectString.length;
+    }
+    position -= searchString.length;
+    var lastIndex = subjectString.indexOf(searchString, position);
+    return lastIndex !== -1 && lastIndex === position;
+  };
+}
+
+module.exports = 'done';

public/css/main.css

@@ -135,6 +135,13 @@ button.call-to-action:active {
   }
 }
 
+/**
+ * Hide things.
+ */
+ .hidden {
+   display: none;
+ }
+
 /**
  * Semantic clearfix.
  */

public/css/project.css

@@ -46,9 +46,86 @@
   text-decoration: underline;
 }
 
-.spec-links > h2 {
-  color: grey;
+
+.file-list li {
+  max-width: 100%;
+}
+
+a.spec-link {
+  max-width: 100%;
+  color: black;
+  text-decoration: none;
+}
+
+.directory {
+  margin: 1em;
+}
+/* Minus and plus signs for expandable directories */
+.directory-path::before {
+  content: '\2296\2003';
+}
+.directory-path.expand::before {
+  content: '\2295\2003';
+}
+
+.file-container {
+  font-size: 1.2em;
+
+  /*
+   * M ke max-width:100% constrain the width out
+   * to the edge of the border rather than the
+   * content.
+   */
+  box-sizing: border-box;
+  max-width: 100%;
+
+  padding: 0.8em;
+  margin-bottom: 1.5em;
+  margin-left: 1.5em;
+  background-color: #FAFAFA;
+  border: 2px solid rgba(100, 100, 100, 0.5);
+  border-radius: 0.8em;
+  box-shadow: -0.1em 0.1em 0.2em 0.1em rgba(100, 100, 100, 0.5);
+}
+
+.empty-file {
+  color: #555;
+}
+
+.parse-error {
+  color: darkred;
+}
+
+.file-details {
+  word-wrap: break-word; /* break long file names and paths */
+  padding: 0.6em;
+}
+.file-name {
+  margin-bottom: 0.3em;
+  color: darkblue;
+}
+.file-path {
+  font-size: 0.6em;
+  margin-bottom: 0;
 }
-.spec-links > div {
-  margin-left: 3em;
+
+.feature-summary {
+  padding: 1em;
+  border-radius: 1em;
+  background: linear-gradient(180deg, rgba(255, 255, 255, 0) 2%, rgba(240, 240, 240, 1) 16%, rgba(255, 255, 255, 0) 100%);
+}
+.feature-summary p {
+  margin-bottom: 0.5em;
+  margin-left: 0.5em;
+}
+.feature-summary .feature-name {
+  color: blue;
+}
+.feature-summary .feature-description {
+  font-size: 0.8em;
+
+  /* Truncate the feature descriptions. */
+  overflow: hidden;
+  white-space: nowrap;
+  text-overflow: ellipsis;
 }