feat(header): add new responsive header

Minor clean-up.

.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 .eslintcache
+.idea
 node_modules
 npm-debug.log
 coverage

README.md

@@ -23,7 +23,7 @@ npm i --save @edx/gradebook
 
 After cloning the repository, run `make up-detached` in the `gradebook` directory - this will build and start the `gradebook` web application in a docker container.
 
-The web application runs on port **1991**, so when you go to `http://localhost:1991` you should see the UI.
+The web application runs on port **1991**, so when you go to `http://localhost:1991/course-v1:edX+DemoX+Demo_Course` you should see the UI (assuming you have such a Demo Course in your devstack).  Note that you always have to provide a course id to actually see a gradebook.
 
 If you don't, you can see the log messages for the docker container by executing `make logs` in the `gradebook` directory.
 

config/webpack.prod.config.js

@@ -47,6 +47,7 @@ module.exports = Merge.smart(commonConfig, {
               minimize: true,
             },
           },
+          'postcss-loader',
           {
             loader: 'sass-loader', // compiles Sass to CSS
             options: {

package.json

@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "@edx/edx-bootstrap": "^0.4.3",
-    "@edx/frontend-auth": "^1.2.1",
+    "@edx/frontend-auth": "^1.3.0",
     "@edx/paragon": "^3.7.2",
     "babel-polyfill": "^6.26.0",
     "classnames": "^2.2.5",
@@ -33,13 +33,14 @@
     "font-awesome": "^4.7.0",
     "history": "^4.7.2",
     "prop-types": "^15.5.10",
-    "query-string": "^6.2.0",
+    "query-string": "^5.1.1",
     "react": "^16.2.0",
     "react-dom": "^16.2.0",
     "react-redux": "^5.0.7",
     "react-router": "^4.2.0",
     "react-router-dom": "^4.2.2",
     "react-router-redux": "^5.0.0-alpha.9",
+    "reactstrap": "^6.5.0",
     "redux": "^3.7.2",
     "redux-devtools-extension": "^2.13.2",
     "redux-logger": "^3.0.6",
@@ -47,6 +48,7 @@
     "whatwg-fetch": "^2.0.3"
   },
   "devDependencies": {
+    "autoprefixer": "^9.4.2",
     "axios-mock-adapter": "^1.15.0",
     "babel-cli": "^6.26.0",
     "babel-eslint": "^8.2.2",
@@ -72,6 +74,7 @@
     "jest": "^22.4.0",
     "mini-css-extract-plugin": "^0.4.0",
     "node-sass": "^4.7.2",
+    "postcss-loader": "^3.0.0",
     "react-dev-utils": "^5.0.0",
     "react-test-renderer": "^16.2.0",
     "redux-mock-store": "^1.5.1",

src/App.scss

@@ -7,3 +7,4 @@ $fa-font-path: "~font-awesome/fonts";
 @import "~@edx/paragon/src/SearchField/SearchField";
 
 @import "./components/Gradebook/gradebook";
+@import "./components/Gradebook/footer";

src/components/Gradebook/footer.jsx

@@ -0,0 +1,122 @@
+import React from 'react';
+import { Hyperlink, Icon } from '@edx/paragon';
+
+import EdXLogo from '../../../assets/edx-sm.png';
+
+export default function Footer() {
+  function renderLogo() {
+    return (
+      <img src={EdXLogo} alt="edX logo" height="30" width="60" />
+    );
+  }
+
+  return (
+    <footer
+      role="contentinfo"
+      aria-label="Page Footer"
+      className="footer d-flex justify-content-center border-top py-3 px-4"
+    >
+      <div className="max-width-1180 d-grid">
+        <div className="area-1">
+          <Hyperlink destination="https://www.edx.org/" content={renderLogo()} />
+        </div>
+        <div className="area-2">
+          <h2>edx</h2>
+          <ul className="list-unstyled p-0 m-0">
+            <li><a href="https://www.edx.org/about-us">About</a></li>
+            <li><a href="https://www.edx.org/enterprise">edX for Business</a></li>
+            <li><a href="https://www.edx.org/affiliate-program">Affiliates</a></li>
+            <li><a href="http://open.edx.org">Open edX</a></li>
+            <li><a href="https://www.edx.org/careers">Careers</a></li>
+            <li><a href="https://www.edx.org/news-announcements">News</a></li>
+          </ul>
+        </div>
+        <div className="area-3">
+          <h2>Legal</h2>
+          <ul className="list-unstyled p-0 m-0">
+            <li><a href="https://www.edx.org/edx-terms-service">Terms of Service &amp; Honor Code</a></li>
+            <li><a href="https://www.edx.org/edx-privacy-policy">Privacy Policy</a></li>
+            <li><a href="https://www.edx.org/accessibility">Accessibility Policy</a></li>
+            <li><a href="https://www.edx.org/trademarks">Trademark Policy</a></li>
+            <li><a href="https://www.edx.org/sitemap">Sitemap</a></li>
+          </ul>
+        </div>
+        <div className="area-4">
+          <h2>Connect</h2>
+          <ul className="list-unstyled p-0 m-0">
+            <li><a href="https://www.edx.org/blog">Blog</a></li>
+            <li><a href="https://courses.edx.org/support/contact_us">Contact Us</a></li>
+            <li><a href="https://support.edx.org">Help Center</a></li>
+            <li><a href="https://www.edx.org/media-kit">Media Kit</a></li>
+            <li><a href="https://www.edx.org/donate">Donate</a></li>
+          </ul>
+        </div>
+        <div className="area-5">
+          <ul
+            className="d-flex flex-row justify-content-between list-unstyled max-width-222 p-0 mb-4"
+          >
+            {/* TODO: Use Paragon HyperLink with Icon. */}
+            {/*  Would need to add rel to paragon if we still need it. */}
+            <li>
+              <a href="http://www.facebook.com/EdxOnline" title="Facebook" rel="noopener noreferrer" target="_blank">
+                <Icon className={['fa', 'fa-facebook-square', 'fa-2x']} screenReaderText="Like edX on Facebook" />
+              </a>
+            </li>
+            <li>
+              <a href="https://twitter.com/edXOnline" title="Twitter" rel="noopener noreferrer" target="_blank">
+                <Icon className={['fa', 'fa-twitter-square', 'fa-2x']} screenReaderText="Follow edX on Twitter" />
+              </a>
+            </li>
+            <li>
+              <a href="https://www.youtube.com/user/edxonline" title="Youtube" rel="noopener noreferrer" target="_blank">
+                <Icon className={['fa', 'fa-youtube-square', 'fa-2x']} screenReaderText="Subscribe to the edX YouTube channel" />
+              </a>
+            </li>
+            <li>
+              <a href="https://www.linkedin.com/company/edx" title="LinkedIn" rel="noopener noreferrer" target="_blank">
+                <Icon className={['fa', 'fa-linkedin-square', 'fa-2x']} screenReaderText="Follow edX on LinkedIn" />
+              </a>
+            </li>
+            <li>
+              <a href="https://plus.google.com/+edXOnline" title="Google+" rel="noopener noreferrer" target="_blank">
+                <Icon className={['fa', 'fa-google-plus-square', 'fa-2x']} screenReaderText="Follow edX on Google+" />
+              </a>
+            </li>
+            <li>
+              <a href="https://www.reddit.com/r/edx" title="Reddit" rel="noopener noreferrer" target="_blank">
+                <Icon className={['fa', 'fa-reddit-square', 'fa-2x']} screenReaderText="Subscribe to the edX subreddit" />
+              </a>
+            </li>
+          </ul>
+          <ul className="d-flex flex-row justify-content-between list-unstyled max-width-264 p-0 mb-5">
+            <li>
+              <a href="https://itunes.apple.com/us/app/edx/id945480667?mt=8" rel="noopener noreferrer" target="_blank">
+                <img
+                  className="max-height-39"
+                  alt="Download the edX mobile app from the Apple App Store"
+                  src="https://prod-edxapp.edx-cdn.org/static/images/app/app_store_badge_135x40.d0558d910630.svg"
+                />
+              </a>
+            </li>
+            <li>
+              <a href="https://play.google.com/store/apps/details?id=org.edx.mobile" rel="noopener noreferrer" target="_blank">
+                <img
+                  className="max-height-39"
+                  alt="Download the edX mobile app from Google Play"
+                  src="https://prod-edxapp.edx-cdn.org/static/images/app/google_play_badge_45.6ea466e328da.png"
+                />
+              </a>
+            </li>
+          </ul>
+          <p>
+            © 2012–{(new Date().getFullYear())} edX Inc.
+            <br />
+            EdX, Open edX, and MicroMasters are registered trademarks of edX Inc.
+            | 粤ICP备17044299号-2
+          </p>
+        </div>
+      </div>
+    </footer>
+  );
+}
+

src/components/Gradebook/footer.scss

@@ -0,0 +1,165 @@
+.max-width-222 {
+  max-width: 222px;
+}
+
+.max-width-264 {
+  max-width: 264px;
+}
+
+.max-width-1180 {
+  max-width: 1180px;
+}
+
+.max-height-39 {
+  max-height: 39px;
+}
+
+.d-grid {
+  display: grid;
+}
+
+$gray-footer: #fcfcfc;
+$border-1: 1px solid $gray-200;
+
+.footer {
+  background-color: $gray-footer;
+
+  .area-1 {
+    grid-column: 1;
+    grid-row: 1;
+    border-bottom: $border-1;
+    padding-bottom: 1rem;
+  }
+
+  .area-2 {
+    grid-column: 1;
+    grid-row: 2;
+    border-bottom: $border-1;
+    padding: 1rem 0;
+  }
+
+  .area-3 {
+    grid-column: 1;
+    grid-row: 3;
+    border-bottom: $border-1;
+    padding: 1rem 0;
+  }
+
+  .area-4 {
+    grid-column: 1;
+    grid-row: 4;
+    border-bottom: $border-1;
+    padding: 1rem 0;
+  }
+
+  .area-5 {
+    grid-column: 1;
+    grid-row: 5;
+    padding: 1rem 0;
+  }
+
+  @media only screen and (min-width: 717px) {
+    .area-1 {
+      grid-column: 1 / span 2;
+      grid-row: 1;
+      border-bottom: none;
+      padding: 1rem 0;
+    }
+
+    .area-2 {
+      grid-column: 1;
+      grid-row: 2;
+    }
+
+    .area-3 {
+      grid-column: 1;
+      grid-row: 3;
+    }
+
+    .area-4 {
+      grid-column: 1;
+      grid-row: 4;
+      border-bottom: none;
+    }
+
+    .area-5 {
+      grid-column: 2;
+      grid-row: 2 / span 3;
+      border-left: $border-1;
+      padding-left: 1rem;
+      margin-left: 1rem;
+    }
+  }
+
+  @media only screen and (min-width: 870px) {
+    .area-1 {
+      grid-column: 1;
+      grid-row: 1 / span 3;
+      border-right: $border-1;
+      padding-right: 1rem;
+      margin-right: 1rem;
+    }
+
+    .area-2 {
+      grid-column: 2;
+      grid-row: 1;
+      border-bottom: none;
+      border-right: $border-1;
+      padding-right: 1rem;
+      margin-right: 1rem;
+    }
+
+    .area-3 {
+      grid-column: 3;
+      grid-row: 1;
+      border-bottom: none;
+      border-right: $border-1;
+      padding-right: 1rem;
+      margin-right: 1rem;
+    }
+
+    .area-4 {
+      grid-column: 4;
+      grid-row: 1;
+    }
+
+    .area-5 {
+      grid-column: 2 / span 3;
+      grid-row: 2;
+      border: none;
+      margin-left: 0;
+      padding-left: 0;
+    }
+  }
+
+  @media only screen and (min-width: 1188px) {
+    .area-1 {
+      grid-column: 1 / span 1;
+      grid-row: 1;
+    }
+
+    .area-2 {
+      grid-column: 2;
+      grid-row: 1;
+    }
+
+    .area-3 {
+      grid-column: 3;
+      grid-row: 1;
+    }
+
+    .area-4 {
+      grid-column: 4;
+      grid-row: 1;
+      border-right: $border-1;
+      padding-right: 1rem;
+      margin-right: 1rem;
+    }
+
+    .area-5 {
+      grid-column: 5 / span 1;
+      grid-row: 1;
+      max-width: 372px;
+    }
+  }
+}

src/components/Gradebook/index.jsx

@@ -39,17 +39,23 @@ export default class Gradebook extends React.Component {
   }
 
   setNewModalState = (userEntry, subsection) => {
+    let adjustedGradePossible = '';
+    let currentGradePossible = '';
+    if (subsection.attempted) {
+      adjustedGradePossible = ` / ${subsection.score_possible}`;
+      currentGradePossible = `/${subsection.score_possible}`;
+    }
     this.setState({
       modalModel: [{
         username: userEntry.username,
-        currentGrade: `${subsection.score_earned}/${subsection.score_possible}`,
+        currentGrade: `${subsection.score_earned}${currentGradePossible}`,
         adjustedGrade: (
           <span>
             <input
               style={{ width: '25px' }}
               type="text"
               onChange={event => this.setState({ updateVal: event.target.value })}
-            /> / {subsection.score_possible}
+            />{adjustedGradePossible}
           </span>
         ),
         assignmentName: `${subsection.subsection_name}`,
@@ -206,16 +212,23 @@ export default class Gradebook extends React.Component {
       const assignments = entry.section_breakdown
         .filter(section => section.is_graded)
         .reduce((acc, subsection) => {
+          const scoreEarned = this.roundGrade(subsection.score_earned);
+          const scorePossible = this.roundGrade(subsection.score_possible);
+          let label = `${scoreEarned}`;
+          if (subsection.attempted) {
+            label = `${scoreEarned}/${scorePossible}`;
+          }
           if (areGradesFrozen) {
-            acc[subsection.label] = `${this.roundGrade(subsection.score_earned)}/${this.roundGrade(subsection.score_possible)}`;
+            acc[subsection.label] = label;
           } else {
             acc[subsection.label] = (
               <button
                 className="btn btn-header link-style"
                 onClick={() => this.setNewModalState(entry, subsection)}
               >
-                {this.roundGrade(subsection.score_earned)}/{this.roundGrade(subsection.score_possible)}
-              </button>);
+                {label}
+              </button>
+            );
           }
           return acc;
         }, {});
@@ -242,7 +255,7 @@ export default class Gradebook extends React.Component {
             <h1>Gradebook</h1>
             <h3> {this.props.match.params.courseId}</h3>
             { this.props.areGradesFrozen &&
-              <div className="alert alert-danger" role="alert" >
+              <div className="alert alert-warning" role="alert" >
                 The grades for this course are now frozen. Editing of grades is no longer allowed.
               </div>
             }

src/components/Header/index.jsx

@@ -1,30 +1,94 @@
 import React from 'react';
-import { Hyperlink } from '@edx/paragon';
+import {
+  Collapse,
+  Navbar,
+  NavbarToggler,
+  NavbarBrand,
+  Nav,
+  NavItem,
+  NavLink,
+  UncontrolledDropdown,
+  DropdownToggle,
+  DropdownMenu,
+  DropdownItem,
+} from 'reactstrap';
+import { Icon } from '@edx/paragon';
+import PropTypes from 'prop-types';
 
+import apiClient from '../../data/apiClient';
+import { configuration } from '../../config';
 import EdxLogo from '../../../assets/edx-sm.png';
 
-export default class Header extends React.Component {
+class Header extends React.Component {
   constructor(props) {
     super(props);
+
+    this.toggle = this.toggle.bind(this);
     this.state = {
       mobileNavOpen: false,
     };
   }
 
-  renderLogo() {
-    return (
-      <img src={EdxLogo} alt="edX logo" height="30" width="60" />
-    );
+  toggle() {
+    this.setState({
+      mobileNavOpen: !this.state.mobileNavOpen,
+    });
+  }
+
+  getUserProfileImageIcon() {
+    const screenReaderText = `Profile image for ${this.props.username}`;
+
+    if (this.props.userProfileImageUrl) {
+      return <img src={this.props.userProfileImageUrl} alt={screenReaderText} />;
+    }
+    return <Icon className={['fa', 'fa-user', 'px-3']} screenReaderText={screenReaderText} />;
   }
 
   render() {
     return (
-      <div className="mb-3">
-        <header className="d-flex justify-content-center align-items-center p-3 border-bottom-blue">
-          <Hyperlink content={this.renderLogo()} destination="https://www.edx.org" />
-          <div />
-        </header>
-      </div>
+      <Navbar light expand="md" className="border-bottom">
+        <NavbarBrand href={configuration.LMS_BASE_URL}>
+          <img src={EdxLogo} alt="edX logo" height="30" width="60" />
+        </NavbarBrand>
+        <NavbarToggler onClick={this.toggle} />
+        <Collapse isOpen={this.state.mobileNavOpen} navbar>
+          <Nav className="ml-auto" navbar>
+            <UncontrolledDropdown nav inNavbar>
+              <DropdownToggle nav caret>
+                {this.getUserProfileImageIcon()}
+                {this.props.username}
+              </DropdownToggle>
+              <DropdownMenu right>
+                <DropdownItem href={`${configuration.LMS_BASE_URL}/dashboard`}>
+                  Dashboard
+                </DropdownItem>
+                <DropdownItem href={`${configuration.LMS_BASE_URL}/u/${this.props.username}`}>
+                  Profile
+                </DropdownItem>
+                <DropdownItem href={`${configuration.LMS_BASE_URL}/account/settings`}>
+                  Account
+                </DropdownItem>
+                <DropdownItem divider />
+                <DropdownItem onClick={() => apiClient.logout()}>
+                  Logout
+                </DropdownItem>
+              </DropdownMenu>
+            </UncontrolledDropdown>
+          </Nav>
+        </Collapse>
+      </Navbar>
     );
   }
 }
+
+Header.defaultProps = {
+  username: null,
+  userProfileImageUrl: null,
+};
+
+Header.propTypes = {
+  username: PropTypes.string,
+  userProfileImageUrl: PropTypes.string,
+};
+
+export default Header;

src/containers/Header/index.jsx

@@ -0,0 +1,11 @@
+import { connect } from 'react-redux';
+import { fetchUserProfile } from '@edx/frontend-auth';
+
+import Header from '../../components/Header';
+
+const mapStateToProps = state => ({
+  username: state.userProfile.username,
+  userProfileImageUrl: state.userProfile.userProfileImageUrl,
+});
+
+export default connect(mapStateToProps)(Header);

src/data/apiClient.js

@@ -4,6 +4,7 @@ import { configuration } from '../config';
 
 const apiClient = getAuthenticatedAPIClient({
   appBaseUrl: configuration.BASE_URL,
+  authBaseUrl: configuration.LMS_BASE_URL,
   loginUrl: configuration.LOGIN_URL,
   logoutUrl: configuration.LOGOUT_URL,
   csrfTokenApiPath: process.env.CSRF_TOKEN_API_PATH,

src/data/reducers/index.js

@@ -1,11 +1,21 @@
 import { combineReducers } from 'redux';
+import { userProfile } from '@edx/frontend-auth';
 
 import cohorts from './cohorts';
 import grades from './grades';
 import tracks from './tracks';
 import assignmentTypes from './assignmentTypes';
 
+const identityReducer = (state) => {
+  const newState = { ...state };
+  return newState;
+};
+
 const rootReducer = combineReducers({
+  // The authentication state is added as initialState when
+  // creating the store in data/store.js.
+  authentication: identityReducer,
+  userProfile,
   grades,
   cohorts,
   tracks,

src/data/store.js

@@ -3,12 +3,15 @@ import thunkMiddleware from 'redux-thunk';
 import { composeWithDevTools } from 'redux-devtools-extension/logOnlyInProduction';
 import { createLogger } from 'redux-logger';
 
+import apiClient from './apiClient';
 import reducers from './reducers';
 
 const loggerMiddleware = createLogger();
+const initialState = apiClient.getAuthenticationState();
 
 const store = createStore(
   reducers,
+  initialState,
   composeWithDevTools(applyMiddleware(thunkMiddleware, loggerMiddleware)),
 );
 

src/index.jsx

@@ -3,27 +3,37 @@ import React from 'react';
 import ReactDOM from 'react-dom';
 import { BrowserRouter as Router, Route, Switch } from 'react-router-dom';
 import { Provider } from 'react-redux';
+import { fetchUserProfile } from '@edx/frontend-auth';
 
 import apiClient from './data/apiClient';
+import Footer from './components/Gradebook/footer';
 import GradebookPage from './containers/GradebookPage';
-import Header from './components/Header';
+import Header from './containers/Header';
 import store from './data/store';
 import './App.scss';
 
-const App = () => (
-  <Provider store={store}>
-    <Router>
-      <div>
-        <Header />
-        <main>
-          <Switch>
-            <Route exact path="/:courseId" component={GradebookPage} />
-          </Switch>
-        </main>
-      </div>
-    </Router>
-  </Provider>
-);
+class App extends React.Component {
+  componentDidMount() {
+    const username = store.getState().authentication.username;
+    store.dispatch(fetchUserProfile(apiClient, username));
+  }
+
+  render() {
+    return <Provider store={store}>
+      <Router>
+        <div>
+          <Header />
+          <main>
+            <Switch>
+              <Route exact path="/:courseId" component={GradebookPage} />
+            </Switch>
+          </main>
+          <Footer />
+        </div>
+      </Router>
+    </Provider>;
+  }
+}
 
 if (apiClient.ensurePublicOrAuthencationAndCookies(window.location.pathname)) {
   ReactDOM.render(<App />, document.getElementById('root'));

src/postcss.config.js

@@ -0,0 +1,7 @@
+/* I'm here to allow autoprefixing in webpack.prod.config.js */
+module.exports = {
+  plugins: [
+    require('autoprefixer')({ grid: true, browsers: ['>1%'] }),
+  ],
+};
+