Merge branch 'release/0.5.1'

Author: jamescdavis

.vscode/settings.json

@@ -1,3 +1,13 @@
 {
-    "typescript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions": false
-}
+    "typescript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions": false,
+    "files.exclude": {
+        "**/.git": true,
+        "**/.DS_Store": true,
+        "tmp/**": true,
+    },
+    "search.exclude": {
+        "**/node_modules": true,
+        "**/bower_components": true,
+        "tmp/**": true,
+    },
+}

.watchmanconfig

@@ -1,3 +1,3 @@
 {
-  "ignore_dirs": ["tmp", "dist"]
+  "ignore_dirs": ["tmp", "dist", "node_modules"]
 }

CHANGELOG.md

@@ -4,6 +4,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.5.1] - 2018-07-10
+### Added
+- Missing analytics:
+  - Institutions landing page (page and event tracking)
+  - Dashboard filtering
+  - User quick files page (more event tracking)
+  - Quick files detail page (event tracking)
+
+### Changed
+- Components:
+  - `simple-paginator` - use > and < instead of font-awesome chevrons
+- Engines:
+  - `analytics` - set page title to "OSF | [node title] Analytics"
+- DX:
+  - Test assertions: Collapse all whitespace characters to a single space
+
 ## [0.5.0] - 2018-06-29
 ### Added
 - Routes:

README.md

@@ -8,27 +8,83 @@
 `develop` Build Status: [![Build Status](https://travis-ci.org/CenterForOpenScience/ember-osf-web.svg?branch=develop)](https://travis-ci.org/CenterForOpenScience/ember-osf-web)
 [![Coverage Status](https://coveralls.io/repos/github/CenterForOpenScience/ember-osf-web/badge.svg?branch=develop)](https://coveralls.io/github/CenterForOpenScience/ember-osf-web?branch=develop)
 
-This README outlines the details of collaborating on this Ember application.
-A short introduction of this app could easily go here.
+A front end for [osf.io](https://github.com/CenterForOpenScience/osf.io).
 
 ## Prerequisites
 
 You will need the following things properly installed on your computer.
 
+* [osf.io back end](https://github.com/CenterForOpenScience/osf.io)
 * [Git](https://git-scm.com/)
 * [Node.js](https://nodejs.org/) (with NPM)
 * [Ember CLI](https://ember-cli.com/)
+* [Watchman](https://facebook.github.io/watchman/)
 
 ## Installation
 
-* `git clone <repository-url>` this repository
+* `git clone https://github.com/CenterForOpenScience/ember-osf-web.git`
 * `cd ember-osf-web`
 * `yarn --frozen-lockfile`
 
 ## Running / Development
 
+### Mac OS File Descriptor Limits
+
+Watchman [states](https://facebook.github.io/watchman/docs/install.html#mac-os-file-descriptor-limits) "*Only applicable on OS X 10.6 and earlier*". Though it's been observed this setting can remain incorrect on systems where the operation system was upgraded from a legacy version.
+
+> Putting the following into a file named /etc/sysctl.conf on OS X will cause these values to persist across reboots:
+
+```bash
+kern.maxfiles=10485760
+kern.maxfilesperproc=1048576
+```
+
+### Development
+
+Configure the application for local development, add the following to your `config/local.js`:
+```ts
+module.exports = {
+    // an ally audit can use 100% of your browsers cpu, so use it wisely
+    A11Y_AUDIT: false,
+    // toggle on/off the engine applications you will be working on
+    COLLECTIONS_ENABLED: false,
+    // sourcemaps are useful if you need to step through typescript code in the browser
+    SOURCEMAPS_ENABLED: true,
+};
+```
+
 * `ember serve`
-* Visit your app at [http://localhost:4200](http://localhost:4200).
+* View the ember app (alone) at [localhost:4200](http://localhost:4200)
+
+To integrate with the legacy front end at [localhost:5000](http://localhost:5000), you have two options:
+* Enable the waffle flags for each page in your [local OSF Admin](http://localhost:8001/admin/waffle/flag)
+* Add routes to your `osf.io/website/settings/local.py`:
+    ```py
+    EXTERNAL_EMBER_APPS = {
+        'ember_osf_web': {
+            # ...
+            'routes': [
+                'handbook',
+                'dashboard',
+                # ...
+            ],
+        },
+        # ...
+    ```
+
+### Developer Handbook
+
+To enable the [developer handbook](https://centerforopenscience.github.io/ember-osf-web/handbook) locally,
+add the following to your `config/local.js`:
+```ts
+module.exports = {
+    HANDBOOK_ENABLED: true,
+};
+```
+The handbook will be available at [http://localhost:4200/handbook](http://localhost:4200/handbook).
+
+To enable (experimental) auto-generated docs in the handbook, you can also set
+`HANDBOOK_DOC_GENERATION_ENABLED: true` in your local config.
 
 ### Code Generators
 
@@ -44,10 +100,6 @@ Make use of the many generators for code, try `ember help generate` for more det
 * `ember build` (development)
 * `ember build --environment production` (production)
 
-### Deploying
-
-Specify what it takes to deploy your app.
-
 ## Further Reading / Useful Links
 
 * [ember.js](http://emberjs.com/)

app/app.ts

@@ -36,6 +36,8 @@ const App = Application.extend({
                     'store',
                     'analytics',
                     'ready',
+                    'page-title-list',
+                    'head-data',
                 ],
                 externalRoutes: {
                     nodeForks: 'guid-node.forks',

app/dashboard/controller.ts

@@ -48,6 +48,7 @@ export default class Dashboard extends Controller {
     filterNodes = task(function *(this: Dashboard, filter: string) {
         yield timeout(500);
         this.setProperties({ filter });
+        this.analytics.track('list', 'filter', 'Dashboard - Search projects');
         yield this.get('findNodes').perform();
     }).restartable();
 

app/guid-file/controller.ts

@@ -64,59 +64,56 @@ export default class GuidFile extends Controller {
 
     @computed('currentUser', 'user.id')
     get canEdit(this: GuidFile): boolean {
-        const modelUserId = this.get('user').get('id');
+        const modelUserId = this.user.id;
 
-        return !!modelUserId && modelUserId === this.get('currentUser').get('currentUserId');
+        return !!modelUserId && modelUserId === this.currentUser.currentUserId;
     }
 
     @computed('revision', 'file.currentVersion')
     get mfrVersion(this: GuidFile): number {
-        return this.get('revision') || this.get('file').get('currentVersion');
+        return this.revision || this.file.currentVersion;
     }
 
     // TODO: get this from the model
     @computed('file.currentVersion')
     get fileVersions(this: GuidFile): Promise<any> {
         return (async () => {
-            const { data } = await $.getJSON(`${this.get('downloadLink')}?revisions=&`);
+            const { data } = await $.getJSON(`${this.downloadLink}?revisions=&`);
             return data;
         })();
     }
 
     @computed('file.name')
     get isEditableFile(this: GuidFile): boolean {
-        const filename = this.get('file').get('name');
+        const filename = this.file.name;
         const mimeType = mime.lookup(filename);
         return !!mimeType && /^text\//.test(mimeType);
     }
 
     @computed('file.currentVersion')
     get fileText(this: GuidFile) {
-        const file: File = this.get('file');
-        return !!file && file.getContents();
+        return Boolean(this.file) && this.file.getContents();
     }
 
     updateFilter = task(function *(this: GuidFile, filter: string) {
         yield timeout(250);
         this.setProperties({ filter });
-    }).drop();
+        this.analytics.track('list', 'filter', 'Quick Files - Filter file browser');
+    }).restartable();
 
     @computed('allFiles.[]', 'filter', 'sort')
     get files(this: GuidFile) {
-        const filter: string = this.get('filter');
-        const sort: string = this.get('sort');
+        let results: File[] = this.allFiles;
 
-        let results: File[] = this.get('allFiles');
-
-        if (filter) {
-            const filterLowerCase = filter.toLowerCase();
-            results = results.filter(file => file.get('name').toLowerCase().includes(filterLowerCase));
+        if (this.filter) {
+            const filterLowerCase = this.filter.toLowerCase();
+            results = results.filter(file => file.name.toLowerCase().includes(filterLowerCase));
         }
 
-        if (sort) {
-            const reverse: boolean = sort.slice(0, 1) === '-';
+        if (this.sort) {
+            const reverse: boolean = this.sort.slice(0, 1) === '-';
 
-            results = A(results).sortBy(sort.slice(+reverse));
+            results = A(results).sortBy(this.sort.slice(+reverse));
 
             if (reverse) {
                 results = results.reverse();
@@ -128,77 +125,84 @@ export default class GuidFile extends Controller {
 
     @action
     download(this: GuidFile, version: number) {
-        const url = `${this.get('downloadLink')}?revision=${version}`;
+        // analytics sent in template, since this is used twice
+        const url = `${this.downloadLink}?revision=${version}`;
         window.location.href = url;
     }
 
     @action
     async delete(this: GuidFile) {
         this.set('deleteModalOpen', false);
+        this.analytics.click('button', 'Quick Files - Delete file');
 
         try {
-            await this.get('file').destroyRecord();
-            this.transitionToRoute('guid-user.quickfiles', this.get('user').get('id'));
-            const message: string = this.get('i18n').t('file_detail.delete_success');
-            return this.get('toast').success(message);
+            await this.file.destroyRecord();
+            this.transitionToRoute('guid-user.quickfiles', this.user.id);
+            const message: string = this.i18n.t('file_detail.delete_success');
+            return this.toast.success(message);
         } catch (e) {
-            const message: string = this.get('i18n').t('file_detail.delete_fail');
-            return this.get('toast').error(message);
+            const message: string = this.i18n.t('file_detail.delete_fail');
+            return this.toast.error(message);
         }
     }
 
     @action
     openDeleteModal(this: GuidFile) {
         this.set('deleteModalOpen', true);
+        this.analytics.click('button', 'Quick Files - Open delete modal');
     }
 
     @action
     closeDeleteModal(this: GuidFile) {
         this.set('deleteModalOpen', false);
+        this.analytics.click('button', 'Quick Files - Close delete modal');
     }
 
     @action
     changeView(this: GuidFile, button: string) {
-        const show = lookupTable[this.get('show')][button];
+        const show = lookupTable[this.show][button];
 
         if (show) {
             this.set('show', show);
         }
+        this.analytics.click('button', `Quick Files - Change view - ${show}`);
     }
 
     @action
     async save(this: GuidFile, text: string) {
-        const toast = this.get('toast');
-        const i18n = this.get('i18n');
+        this.analytics.click('button', 'Quick Files - Save');
 
         try {
-            await this.get('file').updateContents(text);
-            return toast.success(i18n.t('file_detail.save_success'));
+            await this.file.updateContents(text);
+            return this.toast.success(this.i18n.t('file_detail.save_success'));
         } catch (e) {
-            return toast.error(i18n.t('file_detail.save_fail'));
+            return this.toast.error(this.i18n.t('file_detail.save_fail'));
         }
     }
 
     @action
     async openFile(this: GuidFile, file: File) {
-        const guid = file.get('guid') || await file.getGuid();
+        const guid = file.guid || await file.getGuid();
 
         this.set('revision', null);
         this.transitionToRoute('guid-file', guid, { queryParams: { show: 'view' } });
+        this.analytics.click('link', 'Quick Files - Open file');
     }
 
     @action
     addTag(this: GuidFile, tag: string) {
-        const model = this.get('file');
-        model.set('tags', [...this.get('tags').slice(), tag].sort());
+        const model = this.file;
+        model.set('tags', [...this.tags.slice(), tag].sort());
         model.save();
+        this.analytics.click('button', 'Quick Files - Add tag');
     }
 
     @action
     removeTagAtIndex(this: GuidFile, index: number) {
-        const model = this.get('file');
-        model.set('tags', this.get('tags').slice().removeAt(index));
+        const model = this.file;
+        model.set('tags', this.tags.slice().removeAt(index));
         model.save();
+        this.analytics.click('button', 'Quick Files - Remove tag');
     }
 
     @action

app/guid-file/template.hbs

@@ -55,14 +55,14 @@
         </div>
     </div>
     {{#bs-modal open=deleteModalOpen onSubmit=(action 'delete') onHidden=(action 'closeDeleteModal') as |modal|}}
-        {{#modal.header onClose=(action 'closeDeleteModal')}}
+        {{#modal.header}}
             <h4 class="modal-title">{{t "file_detail.delete_file.question"}}</h4>
         {{/modal.header}}
         {{#modal.body}}
             <p>{{t 'file_detail.delete_file.confirm' file-name=model.file.name}}</p>
         {{/modal.body}}
         {{#modal.footer}}
-            {{#bs-button onClick=(action 'closeDeleteModal') type='default'}}
+            {{#bs-button onClick=(action modal.close) type='default'}}
                 {{t 'general.cancel'}}
             {{/bs-button}}
             {{#bs-button onClick=(action modal.submit) type='danger'}}
@@ -100,7 +100,12 @@
                             readOnly=(unless canEdit true false)
                             as |tag|
                         }}
-                            <a href='{{searchUrl}}?q=(tags:"{{tag}}")'>{{tag}}</a>
+                            <a
+                                href='{{searchUrl}}?q=(tags:"{{tag}}")'
+                                onclick={{action 'click' 'link' 'Quick Files - Search by tag' target=analytics}}
+                            >
+                                {{tag}}
+                            </a>
                         {{/tag-input}}
                         <div class="tags_clear"></div>
                     </div>