Merge pull request #196 from ef4/auto-migrate

Site reorg including top-level latest

Author: pzuraq

addon/components/docs-header/component.js

@@ -7,7 +7,7 @@ import { addonLogo } from 'ember-cli-addon-docs/utils/computed';
 import { inject as service } from '@ember/service';
 import { reads } from '@ember/object/computed';
 
-const { projectName, projectHref } = config['ember-cli-addon-docs'];
+const { projectName, projectHref, latestVersionName } = config['ember-cli-addon-docs'];
 
 /**
   Render a header showing a link to your documentation, your project logo, a
@@ -36,6 +36,7 @@ export default Component.extend({
   projectVersion: service(),
 
   projectHref,
+  latestVersionName,
 
   didInsertElement() {
     this._super(...arguments);

addon/components/docs-header/template.hbs

@@ -25,7 +25,7 @@
       {{#docs-header/link on-click=(action (toggle 'isShowingVersionSelector' this)) data-test-id='current-version'}}
         <span data-version-selector class='flex items-center'>
 
-          {{#if (or (eq currentVersion.name 'latest'))}}
+          {{#if (or (eq currentVersion.key latestVersionName))}}
             {{#if currentVersion.tag}}
               {{currentVersion.tag}}
             {{else}}

addon/components/docs-header/version-selector/component.js

@@ -3,20 +3,26 @@ import { inject as service } from '@ember/service';
 import layout from './template';
 import { sort } from '@ember/object/computed';
 import { reads } from '@ember/object/computed';
+import config from 'dummy/config/environment';
+
+const { latestVersionName, primaryBranch } = config['ember-cli-addon-docs'];
 
 export default Component.extend({
   layout,
 
+  latestVersionName,
+  primaryBranch,
+
   projectVersion: service(),
   'on-close'() {},
 
   currentVersion: reads('projectVersion.currentVersion'),
 
   sortedVersions: sort('projectVersion.versions', function(a, b) {
-    if (['latest', 'master'].includes(a.name) || ['latest', 'master'].includes(b.name) ) {
-      return a.name > b.name;
+    if ([latestVersionName, primaryBranch].includes(a.key) || [latestVersionName, primaryBranch].includes(b.key) ) {
+      return a.key > b.key;
     } else {
-      return a.name < b.name;
+      return a.key < b.key;
     }
   }),
 

addon/components/docs-header/version-selector/template.hbs

@@ -9,23 +9,23 @@
       <li data-test-id='version'>
         <a {{action 'changeVersion' version}} href='#' class='text-black no-underline flex items-center px-4 py-3 hover:bg-grey-lighter'>
           <span class='w-6 flex'>
-            {{#if (eq version.name currentVersion.name)}}
+            {{#if (eq version.key currentVersion.key)}}
               {{svg-jar 'check' height=16 width=16}}
             {{/if}}
           </span>
           <span class='font-medium'>
-            {{if (eq version.name 'latest') 'Latest' version.name}}
+            {{version.name}}
           </span>
 
           <span class="ml-auto pl-8 flex items-center opacity-50">
-            {{#if (or (eq version.name 'latest') (eq version.name 'master'))}}
+            {{#if (or (eq version.key latestVersionName) (eq version.key primaryBranch))}}
               {{svg-jar (if version.tag 'git-tag' 'git-sha') height=16 width=16}}
             {{else}}
               {{svg-jar 'git-sha' height=16 width=16}}
             {{/if}}
 
             <span class='text-xs font-mono pl-1'>
-              {{#if (or (eq version.name 'latest') (eq version.name 'master'))}}
+              {{#if (or (eq version.key latestVersionName) (eq version.key primaryBranch))}}
                 {{#if version.tag}}
                   {{version.tag}}
                 {{else}}

addon/components/docs-viewer/x-main/component.js

@@ -9,7 +9,7 @@ import { getOwner } from '@ember/application';
 
 import layout from './template';
 
-const projectHref = config['ember-cli-addon-docs'].projectHref;
+const { projectHref, primaryBranch } = config['ember-cli-addon-docs'];
 
 const tagToSize = { H2: 'xs', H3: 'xs' };
 const tagToIndent = { H2: '0', H3: '4' };
@@ -76,14 +76,14 @@ export default Component.extend({
       let file = addonFiles.find(f => f.match(path));
 
       if (file) {
-        return `${projectHref}/edit/master/addon/${file}`;
+        return `${projectHref}/edit/${primaryBranch}/addon/${file}`;
       }
     } else {
       let file = appFiles
         .filter(file => file.match(/template.(hbs|md)/))
         .find(file => file.match(path));
 
-      return `${projectHref}/edit/master/tests/dummy/app/${file}`;
+      return `${projectHref}/edit/${primaryBranch}/tests/dummy/app/${file}`;
     }
   })
 

addon/services/project-version.js

@@ -2,17 +2,28 @@ import Service, { inject as service } from '@ember/service';
 import { getOwner } from '@ember/application';
 import { computed } from '@ember/object';
 import { task } from 'ember-concurrency';
+import config from 'dummy/config/environment';
+import { assign } from '@ember/polyfills';
+
+const { latestVersionName } = config['ember-cli-addon-docs'];
 
 export default Service.extend({
   docsFetch: service(),
 
   _loadAvailableVersions: task(function*() {
     let response = yield this.get('docsFetch').fetch({ url: `${this.get('root')}versions.json` }).response();
-    let json = yield response.ok ? response.json() : { latest: this.get('currentVersion') };
+    let json;
+    if(response.ok){
+      json = yield response.json();
+    }else{
+      json = { [latestVersionName]: assign({}, this.get('currentVersion')) };
+    }
+
 
     this.set('versions', Object.keys(json).map(key => {
       let version = json[key];
       version.truncatedSha = version.sha.substr(0,5);
+      version.key = key;
 
       return version;
     }));
@@ -38,7 +49,8 @@ export default Service.extend({
     // In development, this token won't have been replaced replaced
     if (currentVersion === 'ADDON_DOCS_DEPLOY_VERSION') {
       currentVersion = {
-        name: 'latest',
+        key: latestVersionName,
+        name: latestVersionName,
         tag: config.projectTag,
         path: '',
         sha: 'abcde'

blueprints/ember-cli-addon-docs/files/config/addon-docs.js

@@ -4,6 +4,6 @@
 const AddonDocsConfig = require('ember-cli-addon-docs/lib/config');
 
 module.exports = class extends AddonDocsConfig {
-  // See https://ember-learn.github.io/ember-cli-addon-docs/latest/docs/deploying
+  // See https://ember-learn.github.io/ember-cli-addon-docs/docs/deploying
   // for details on configuration you can override here.
 };

index.js

@@ -9,9 +9,13 @@ const EmberApp = require('ember-cli/lib/broccoli/ember-app'); // eslint-disable-
 const Plugin = require('broccoli-plugin');
 const walkSync = require('walk-sync');
 
+const LATEST_VERSION_NAME = '-latest';
+
 module.exports = {
   name: 'ember-cli-addon-docs',
 
+  LATEST_VERSION_NAME,
+
   options: {
     nodeAssets: {
       'highlight.js': {
@@ -38,6 +42,7 @@ module.exports = {
   config(env, baseConfig) {
     let repo = this.parent.pkg.repository;
     let info = require('hosted-git-info').fromUrl(repo.url || repo);
+    let userConfig = this._readUserConfig();
 
     let config = {
       'ember-component-css': {
@@ -47,6 +52,8 @@ module.exports = {
         projectName: this.parent.pkg.name,
         projectTag: this.parent.pkg.version,
         projectHref: info && info.browse(),
+        primaryBranch: userConfig.getPrimaryBranch(),
+        latestVersionName: LATEST_VERSION_NAME,
         deployVersion: 'ADDON_DOCS_DEPLOY_VERSION',
         searchTokenSeparator: "\\s+"
       }
@@ -108,10 +115,7 @@ module.exports = {
 
   createDeployPlugin() {
     const AddonDocsDeployPlugin = require('./lib/deploy/plugin');
-    const readConfig = require('./lib/utils/read-config');
-
-    let userConfig = readConfig(this.project);
-    return new AddonDocsDeployPlugin(userConfig);
+    return new AddonDocsDeployPlugin(this._readUserConfig());
   },
 
   setupPreprocessorRegistry(type, registry) {
@@ -211,6 +215,15 @@ module.exports = {
       srcDir: 'styles',
       destDir: 'highlightjs-styles'
     });
+  },
+
+  _readUserConfig() {
+    if (!this._userConfig) {
+      const readConfig = require('./lib/utils/read-config');
+      this._userConfig = readConfig(this.project);
+    }
+
+    return this._userConfig;
   }
 };
 

lib/config.js

@@ -10,6 +10,10 @@ module.exports = class AddonDocsConfig {
     this.repoInfo = gitRepoInfo();
   }
 
+  getPrimaryBranch() {
+    return 'master';
+  }
+
   getRootURL() {
     let repository = this.project.pkg.repository || '';
     let info = hostedGitInfo.fromUrl(repository.url || repository);

lib/deploy/migration.js

@@ -0,0 +1,133 @@
+const fs = require('fs-extra');
+const path = require('path');
+const { JSDOM } = require('jsdom');
+const { LATEST_VERSION_NAME } = require('../..');
+const OLD_LATEST_NAME = 'latest';
+
+module.exports = function maybeMigrateSiteFormat(context, plugin) {
+  return shouldMigrate(context).then(weShould => {
+    if (weShould) {
+      return migrateSiteFormat(context, plugin);
+    }
+  })
+}
+
+function shouldMigrate(context) {
+  // we should migrate if there a `versions.json` file but no `versions` folder
+  return directoryExists(path.join(context.gitDeploy.worktreePath, "versions"))
+  .then(hasVersions => {
+    if (hasVersions){
+      return false;
+    }
+    return fs.stat(path.join(context.gitDeploy.worktreePath, "versions.json"))
+      .then(() => true, () => false);
+    });
+}
+
+function migrateSiteFormat(context, plugin) {
+    let stagingDirectory = context.addonDocs.stagingDirectory;
+    let versionedApps = discoverLegacyVersionedApps(stagingDirectory);
+
+    moveVersionedApps(stagingDirectory, versionedApps);
+    moveLatestToRoot(stagingDirectory);
+    rewriteIndexHTMLs(stagingDirectory);
+    rewriteVersionsJSON(stagingDirectory, plugin);
+}
+
+function moveVersionedApps(stagingDirectory, versionedApps){
+    fs.mkdirSync(path.join(stagingDirectory, "versions"));
+    versionedApps.forEach(name => {
+      fs.renameSync(path.join(stagingDirectory, name), path.join(stagingDirectory, 'versions', name));
+    });
+}
+
+function moveLatestToRoot(stagingDirectory){
+    let latestContents;
+    try {
+      latestContents = fs.readdirSync(path.join(stagingDirectory, 'versions', OLD_LATEST_NAME));
+    } catch (err){
+      if (err.code !== 'ENOENT') {
+        throw err;
+      }
+      latestContents = [];
+    }
+    latestContents.forEach(name => {
+      fs.renameSync(path.join(stagingDirectory, 'versions', OLD_LATEST_NAME, name), path.join(stagingDirectory, name));
+    });
+    fs.rmdirSync(path.join(stagingDirectory, 'versions', OLD_LATEST_NAME));
+}
+
+function rewriteIndexHTMLs(stagingDirectory){
+    fs.readdirSync(path.join(stagingDirectory, 'versions')).forEach(appName => {
+        rewriteIndexHTML(path.join(stagingDirectory, 'versions', appName, 'index.html'), appName, 'versions/' + appName);
+    })
+    rewriteIndexHTML(path.join(stagingDirectory, 'index.html'), OLD_LATEST_NAME, '');
+}
+
+function rewriteIndexHTML(filename, oldPath, newPath){
+    let indexPath = `${filename}`;
+    let contents = fs.readFileSync(indexPath, 'utf-8');
+    let updated = contents.replace(new RegExp(`/ember-cli-addon-docs/${oldPath}/assets`, 'g'), path.join('/ember-cli-addon-docs', newPath, 'assets'));
+    let doc = new JSDOM(contents).window.document;
+    let oldMeta = [...doc.querySelectorAll('meta')].find(m => /config\/environment$/.test(m.name)).content;
+    let config = JSON.parse(decodeURIComponent(oldMeta));
+    let newRootURL = config.rootURL.replace(`/${oldPath}/`, `/${newPath}` + (newPath ? '/' : ''));
+    config.rootURL = newRootURL;
+    if (config['ember-cli-addon-docs'] && config['ember-cli-addon-docs'].deployVersion) {
+      config['ember-cli-addon-docs'].deployVersion.path = newPath;
+    }
+    let updatedMeta = encodeURIComponent(JSON.stringify(config));
+    updated = updated.replace(oldMeta, updatedMeta);
+    fs.writeFileSync(indexPath, updated);
+}
+
+function rewriteVersionsJSON(stagingDirectory){
+  let versionsFile = `${stagingDirectory}/versions.json`;
+  let versions = require(versionsFile);
+
+  Object.keys(versions).forEach(key => {
+    let entry = versions[key];
+    let newPath = path.join('versions', entry.path);
+    if (entry.path === OLD_LATEST_NAME) {
+      newPath = '';
+      entry.name = 'Latest';
+    }
+    entry.oldPath = entry.path;
+    entry.path = newPath;
+  });
+  if (versions[OLD_LATEST_NAME]) {
+    versions[LATEST_VERSION_NAME] = versions[OLD_LATEST_NAME];
+    delete versions[OLD_LATEST_NAME];
+  }
+  fs.writeJSONSync(versionsFile, versions, { spaces: 2 });
+}
+
+
+
+function discoverLegacyVersionedApps(stagingDirectory){
+    return fs.readdirSync(stagingDirectory).filter(name => {
+      // a versioned app is a directory that contains index.html
+      let dir = path.join(stagingDirectory, name);
+      if (!fs.statSync(dir).isDirectory()) {
+        return false;
+      }
+      try {
+        fs.statSync(path.join(dir, "index.html"));
+        return true;
+      } catch(err) {
+        if (err.code !== 'ENOENT') {
+          throw err;
+        }
+        return false;
+      }
+    });
+}
+
+function directoryExists(dir){
+    return fs.stat(dir)
+      .then(stats => {
+        return stats.isDirectory();
+      }, err => {
+        return false;
+      });
+  }