From e86e9a0ae0e4a772a2d4ebe04eb4f3c22fdd71bf Mon Sep 17 00:00:00 2001
From: Yining Shi <shiyining1023@gmail.com>
Date: Wed, 9 Nov 2016 12:52:14 -0500
Subject: [PATCH] Added a star icon for unsaved file name, added 'Saved:  xx
 time ago' (#177)

* added a star icon for unsaved file name, added saved time ago

* changed text

* added timer component

* clean extra styling in _editor.sass

* customize momentjs fromnow function

* clear 10s interval in componentWillUnmount

* use space-between instead of float
---
 client/constants.js                      |  3 ++
 client/modules/IDE/actions/ide.js        | 13 +++++++
 client/modules/IDE/actions/project.js    | 11 ++++--
 client/modules/IDE/components/Editor.jsx | 10 ++++++
 client/modules/IDE/components/Timer.js   | 46 ++++++++++++++++++++++++
 client/modules/IDE/pages/IDEView.jsx     |  4 ++-
 client/modules/IDE/reducers/ide.js       |  7 +++-
 client/styles/components/_editor.scss    | 18 +++++-----
 client/styles/components/_sidebar.scss   |  7 ++--
 client/styles/components/_timer.scss     |  7 ++++
 client/styles/main.scss                  |  1 +
 11 files changed, 113 insertions(+), 14 deletions(-)
 create mode 100644 client/modules/IDE/components/Timer.js
 create mode 100644 client/styles/components/_timer.scss

diff --git a/client/constants.js b/client/constants.js
index 77b7e35e24..0ef97b4ea4 100644
--- a/client/constants.js
+++ b/client/constants.js
@@ -101,3 +101,6 @@ export const ERROR = 'ERROR';
 
 export const JUST_OPENED_PROJECT = 'JUST_OPENED_PROJECT';
 export const RESET_JUST_OPENED_PROJECT = 'RESET_JUST_OPENED_PROJECT';
+
+export const SET_PROJECT_SAVED_TIME = 'SET_PROJECT_SAVED_TIME';
+export const RESET_PROJECT_SAVED_TIME = 'RESET_PROJECT_SAVED_TIME';
diff --git a/client/modules/IDE/actions/ide.js b/client/modules/IDE/actions/ide.js
index a31b989d62..8696e42be7 100644
--- a/client/modules/IDE/actions/ide.js
+++ b/client/modules/IDE/actions/ide.js
@@ -207,3 +207,16 @@ export function resetJustOpenedProject() {
     type: ActionTypes.RESET_JUST_OPENED_PROJECT
   };
 }
+
+export function setProjectSavedTime(value) {
+  return {
+    type: ActionTypes.SET_PROJECT_SAVED_TIME,
+    value
+  };
+}
+
+export function resetProjectSavedTime() {
+  return {
+    type: ActionTypes.RESET_PROJECT_SAVED_TIME,
+  };
+}
diff --git a/client/modules/IDE/actions/project.js b/client/modules/IDE/actions/project.js
index 8e2fc4f3f8..d2de3c375b 100644
--- a/client/modules/IDE/actions/project.js
+++ b/client/modules/IDE/actions/project.js
@@ -2,13 +2,18 @@ import * as ActionTypes from '../../../constants';
 import { browserHistory } from 'react-router';
 import axios from 'axios';
 import { showToast, setToastText } from './toast';
-import { setUnsavedChanges, justOpenedProject, resetJustOpenedProject } from './ide';
+import { setUnsavedChanges, justOpenedProject, resetJustOpenedProject, setProjectSavedTime, resetProjectSavedTime } from './ide';
+import moment from 'moment';
 
 const ROOT_URL = location.href.indexOf('localhost') > 0 ? 'http://localhost:8000/api' : '/api';
 
 export function getProject(id) {
-  return (dispatch) => {
+  return (dispatch, getState) => {
+    const state = getState();
     dispatch(justOpenedProject());
+    if (state.ide.justOpenedProject) {
+      dispatch(resetProjectSavedTime());
+    }
     axios.get(`${ROOT_URL}/projects/${id}`, { withCredentials: true })
       .then(response => {
         // browserHistory.push(`/projects/${id}`);
@@ -46,6 +51,7 @@ export function saveProject(autosave = false) {
       axios.put(`${ROOT_URL}/projects/${state.project.id}`, formParams, { withCredentials: true })
         .then(() => {
           dispatch(setUnsavedChanges(false));
+          dispatch(setProjectSavedTime(moment().format()));
           dispatch({
             type: ActionTypes.PROJECT_SAVE_SUCCESS
           });
@@ -69,6 +75,7 @@ export function saveProject(autosave = false) {
       axios.post(`${ROOT_URL}/projects`, formParams, { withCredentials: true })
         .then(response => {
           dispatch(setUnsavedChanges(false));
+          dispatch(setProjectSavedTime(moment().format()));
           browserHistory.push(`/projects/${response.data.id}`);
           dispatch({
             type: ActionTypes.NEW_PROJECT,
diff --git a/client/modules/IDE/components/Editor.jsx b/client/modules/IDE/components/Editor.jsx
index 874245ac34..e90d1c1991 100644
--- a/client/modules/IDE/components/Editor.jsx
+++ b/client/modules/IDE/components/Editor.jsx
@@ -28,6 +28,7 @@ const downArrowUrl = require('../../../images/down-arrow.svg');
 import classNames from 'classnames';
 
 import { debounce } from 'lodash';
+import Timer from '../components/Timer';
 
 class Editor extends React.Component {
   constructor(props) {
@@ -158,6 +159,13 @@ class Editor extends React.Component {
         role="main"
         className={editorSectionClass}
       >
+        <div className="editor__file-name">
+          <span>{this.props.file.name}
+          {this.props.unsavedChanges ? '*' : null}</span>
+          <Timer
+            projectSavedTime={this.props.projectSavedTime}
+          />
+        </div>
         <button
           className="editor__options-button"
           aria-label="editor options"
@@ -214,6 +222,8 @@ Editor.propTypes = {
   autorefresh: PropTypes.bool.isRequired,
   isPlaying: PropTypes.bool.isRequired,
   theme: PropTypes.string.isRequired,
+  unsavedChanges: PropTypes.bool.isRequired,
+  projectSavedTime: PropTypes.string.isRequired
 };
 
 export default Editor;
diff --git a/client/modules/IDE/components/Timer.js b/client/modules/IDE/components/Timer.js
new file mode 100644
index 0000000000..9d98021202
--- /dev/null
+++ b/client/modules/IDE/components/Timer.js
@@ -0,0 +1,46 @@
+import React, { PropTypes } from 'react';
+import moment from 'moment';
+
+class Timer extends React.Component {
+  constructor(props) {
+    super(props);
+    this.showSavedTime = this.showSavedTime.bind(this);
+  }
+
+  componentDidMount() {
+    this.interval = setInterval(() => this.forceUpdate(), 10000);
+  }
+
+  componentWillUnmount() {
+    if (this.interval) {
+      clearInterval(this.interval);
+    }
+  }
+
+  showSavedTime() {
+    if (Math.abs(moment().diff(this.props.projectSavedTime)) < 10000) {
+      return 'Saved: just now';
+    } else if (Math.abs(moment().diff(this.props.projectSavedTime)) < 20000) {
+      return 'Saved: 15 seconds ago';
+    } else if (Math.abs(moment().diff(this.props.projectSavedTime)) < 30000) {
+      return 'Saved: 25 seconds ago';
+    } else if (Math.abs(moment().diff(this.props.projectSavedTime)) < 46000) {
+      return 'Saved: 35 seconds ago';
+    }
+    return `Saved: ${moment(this.props.projectSavedTime).fromNow()}`;
+  }
+
+  render() {
+    return (
+      <span className="timer__saved-time">
+        {this.props.projectSavedTime !== '' ? this.showSavedTime() : null}
+      </span>
+    );
+  }
+}
+
+Timer.propTypes = {
+  projectSavedTime: PropTypes.string.isRequired
+};
+
+export default Timer;
diff --git a/client/modules/IDE/pages/IDEView.jsx b/client/modules/IDE/pages/IDEView.jsx
index 260727fd26..0b15cec5da 100644
--- a/client/modules/IDE/pages/IDEView.jsx
+++ b/client/modules/IDE/pages/IDEView.jsx
@@ -295,6 +295,7 @@ class IDEView extends React.Component {
                   stopSketch={this.props.stopSketch}
                   autorefresh={this.props.preferences.autorefresh}
                   unsavedChanges={this.props.ide.unsavedChanges}
+                  projectSavedTime={this.props.ide.projectSavedTime}
                 />
                 <Console
                   consoleEvent={this.props.ide.consoleEvent}
@@ -477,7 +478,8 @@ IDEView.propTypes = {
     unsavedChanges: PropTypes.bool.isRequired,
     infiniteLoop: PropTypes.bool.isRequired,
     previewIsRefreshing: PropTypes.bool.isRequired,
-    infiniteLoopMessage: PropTypes.string.isRequired
+    infiniteLoopMessage: PropTypes.string.isRequired,
+    projectSavedTime: PropTypes.string.isRequired
   }).isRequired,
   startSketch: PropTypes.func.isRequired,
   stopSketch: PropTypes.func.isRequired,
diff --git a/client/modules/IDE/reducers/ide.js b/client/modules/IDE/reducers/ide.js
index 4ba6decc3c..04ce8416b5 100644
--- a/client/modules/IDE/reducers/ide.js
+++ b/client/modules/IDE/reducers/ide.js
@@ -17,7 +17,8 @@ const initialState = {
   infiniteLoop: false,
   previewIsRefreshing: false,
   infiniteLoopMessage: '',
-  projectJustOpened: false
+  projectJustOpened: false,
+  projectSavedTime: ''
 };
 
 const ide = (state = initialState, action) => {
@@ -84,6 +85,10 @@ const ide = (state = initialState, action) => {
       return Object.assign({}, state, { justOpenedProject: true });
     case ActionTypes.RESET_JUST_OPENED_PROJECT:
       return Object.assign({}, state, { justOpenedProject: false });
+    case ActionTypes.SET_PROJECT_SAVED_TIME:
+      return Object.assign({}, state, { projectSavedTime: action.value });
+    case ActionTypes.RESET_PROJECT_SAVED_TIME:
+      return Object.assign({}, state, { projectSavedTime: '' });
     default:
       return state;
   }
diff --git a/client/styles/components/_editor.scss b/client/styles/components/_editor.scss
index a6bc6350e2..d2cfba6f50 100644
--- a/client/styles/components/_editor.scss
+++ b/client/styles/components/_editor.scss
@@ -79,8 +79,8 @@
     @extend %icon;
   }
   position: absolute;
-  top: #{5 / $base-font-size}rem;
-  right: #{20 / $base-font-size}rem; // move left to avoid vertical scroll bar
+  top: 0;
+  right: #{1.5 / $base-font-size}rem; // move left to avoid vertical scroll bar
   z-index: 1;
 }
 
@@ -97,10 +97,12 @@
   }
 }
 
-.lint-error {
-  font-family: Inconsolata, monospace;
-  font-size: 100%;
-  background: rgba($console-error-color, 0.3);
-  color: $console-error-color;
-  padding: 2px 5px 3px;
+.editor__file-name {
+  @include themify() {
+    color: getThemifyVariable('inactive-text-color');
+  }
+  padding: 0 0 #{7 / $base-font-size}rem #{76 / $base-font-size}rem;
+  font-size: #{12 / $base-font-size}rem;
+  display: flex;
+  justify-content: space-between;
 }
diff --git a/client/styles/components/_sidebar.scss b/client/styles/components/_sidebar.scss
index e9142ef043..e71a7db2f2 100644
--- a/client/styles/components/_sidebar.scss
+++ b/client/styles/components/_sidebar.scss
@@ -1,7 +1,10 @@
-.sidebar__header {
+.sidebar {
   @include themify() {
-    border-top: 1px solid map-get($theme-map, 'ide-border-color');
+    border: 1px solid map-get($theme-map, 'ide-border-color');
   }
+}
+
+.sidebar__header {
   padding: #{10 / $base-font-size}rem #{6 / $base-font-size}rem;
   display: flex;
   justify-content: space-between;
diff --git a/client/styles/components/_timer.scss b/client/styles/components/_timer.scss
new file mode 100644
index 0000000000..abf28e21fa
--- /dev/null
+++ b/client/styles/components/_timer.scss
@@ -0,0 +1,7 @@
+.timer__saved-time {
+  @include themify() {
+    color: getThemifyVariable('inactive-text-color');
+  }
+  font-size: #{12 / $base-font-size}rem;
+  padding-right: #{30 / $base-font-size}rem;
+}
diff --git a/client/styles/main.scss b/client/styles/main.scss
index 026eda2a2f..7d644d186e 100644
--- a/client/styles/main.scss
+++ b/client/styles/main.scss
@@ -32,6 +32,7 @@
 @import 'components/github-button';
 @import 'components/forms';
 @import 'components/toast';
+@import 'components/timer';
 
 @import 'layout/ide';
 @import 'layout/fullscreen';