Merge pull request openedx-unsupported#121 from edx/l10n

Localized Graphs and Tables

Author: clintonb

.bowerrc

@@ -0,0 +1,6 @@
+{
+    "directory": "analytics_dashboard/static/bower_components",
+    "scripts": {
+        "postinstall": "./bower-post-install.sh"
+    }
+}

.gitignore

@@ -41,6 +41,7 @@ Desktop.ini
 .idea/
 analytics_dashboard/assets/
 node_modules/
+analytics_dashboard/static/bower_components/
 .coverage
 nosetests.xml
 reports/

.pep8

@@ -1,4 +1,4 @@
 [pep8]
 ignore=E501
 max_line_length=119
-exclude=settings,migrations,bower_components
+exclude=settings,migrations,analytics_dashboard/static,bower_components

.travis.yml

@@ -4,6 +4,7 @@ before_install:
   - export PATH=./node_modules/.bin:$PATH
   - sudo apt-get update -qq
   - sudo apt-get install -y npm
+  - sudo apt-get --reinstall install -qq language-pack-en
   - "export DISPLAY=:99.0"
   - "sh -e /etc/init.d/xvfb start"
 install:

Makefile

@@ -1,13 +1,19 @@
+.PHONY: requirements
+
 ROOT = $(shell echo "$$PWD")
 COVERAGE = $(ROOT)/build/coverage
 PACKAGES = analytics_dashboard courses
 NUM_PROCESSES = 2
 
 .PHONY: requirements clean
 
-requirements:
+requirements: requirements.js
 	pip install -q -r requirements/base.txt --exists-action w
 
+requirements.js:
+	npm install
+	bower install
+
 test.requirements: requirements
 	pip install -q -r requirements/test.txt --exists-action w
 
@@ -48,9 +54,9 @@ quality:
 
 validate_python: test.requirements test_python quality
 
-validate_js:
-	npm install
-	gulp
+validate_js: requirements.js
+	gulp test
+	gulp lint
 
 validate: validate_python validate_js
 

README.md

@@ -7,12 +7,13 @@ Dashboard to display course analytics to course teams
 Prerequisites
 -------------
 * Python 2.7.x (not tested with Python 3.x)
-* [gettext](http://www.gnu.org/software/gettext/) 
+* [gettext](http://www.gnu.org/software/gettext/)
+* [npm](https://www.npmjs.org/) 
 
 Getting Started
 ---------------
 1. Get the code (e.g. clone the repository).
-2. Install the Python requirements:
+2. Install the Python/Node/Bower requirements:
 
         $ make develop
 

acceptance_tests/__init__.py

@@ -1,5 +1,8 @@
+import locale
 import os
 
+locale.setlocale(locale.LC_ALL, 'en_US.UTF-8')
+
 
 def str2bool(s):
     s = unicode(s)
@@ -28,7 +31,7 @@ def str2bool(s):
 LMS_USERNAME = os.environ.get('LMS_USERNAME')
 LMS_PASSWORD = os.environ.get('LMS_PASSWORD')
 
-if ENABLE_OAUTH_TESTS and not(LMS_HOSTNAME and LMS_USERNAME and LMS_PASSWORD):
+if ENABLE_OAUTH_TESTS and not (LMS_HOSTNAME and LMS_USERNAME and LMS_PASSWORD):
     raise Exception('LMS settings must be set in order to test OAuth.')
 
 TEST_COURSE_ID = os.environ.get('TEST_COURSE_ID', u'edX/DemoX/Demo_Course')

acceptance_tests/mixins.py

@@ -1,3 +1,4 @@
+import locale
 from bok_choy.promise import EmptyPromise
 from analyticsclient.client import Client
 from acceptance_tests import API_SERVER_URL, API_AUTH_TOKEN, DASHBOARD_FEEDBACK_EMAIL, SUPPORT_URL, LMS_USERNAME, \
@@ -209,3 +210,8 @@ def test_page(self):
         self._test_user_menu()
         self._test_footer()
         self._test_data_update_message()
+
+    @staticmethod
+    def format_number(value):
+        """ Format the given value for the current locale (e.g. include decimal separator). """
+        return locale.format("%d", value, grouping=True)

acceptance_tests/test_course_engagement.py

@@ -1,8 +1,8 @@
 import datetime
 
 from bok_choy.web_app_test import WebAppTest
-
 from analyticsclient.constants import activity_type as at
+
 from acceptance_tests.mixins import CoursePageTestsMixin
 from acceptance_tests.pages import CourseEngagementContentPage
 
@@ -50,7 +50,7 @@ def _test_engagement_metrics(self):
         }
         for activity_type in activity_types:
             data_selector = 'data-activity-type={0}'.format(activity_type)
-            self.assertSummaryPointValueEquals(data_selector, unicode(recent_activity[activity_type]))
+            self.assertSummaryPointValueEquals(data_selector, self.format_number(recent_activity[activity_type]))
             self.assertSummaryTooltipEquals(data_selector, expected_tooltips[activity_type])
 
     def _test_engagement_graph(self):
@@ -85,9 +85,11 @@ def _test_engagement_table(self):
             weekly_activity = trend_activity[i]
             expected_date = self.format_time_as_dashboard((
                 datetime.datetime.strptime(weekly_activity['interval_end'], date_time_format)) - datetime.timedelta(days=1)).replace(' 0', ' ')
-            expected = [expected_date, weekly_activity[at.ANY], weekly_activity[at.PLAYED_VIDEO],
-                        weekly_activity[at.ATTEMPTED_PROBLEM]]
-            actual = [columns[0].text, int(columns[1].text), int(columns[2].text), int(columns[3].text)]
+            expected = [expected_date,
+                        self.format_number(weekly_activity[at.ANY]),
+                        self.format_number(weekly_activity[at.PLAYED_VIDEO]),
+                        self.format_number(weekly_activity[at.ATTEMPTED_PROBLEM])]
+            actual = [columns[0].text, columns[1].text, columns[2].text, columns[3].text]
             self.assertListEqual(actual, expected)
 
             for j in range(1, 4):

acceptance_tests/test_course_enrollment.py

@@ -1,8 +1,8 @@
 import datetime
 
 from bok_choy.web_app_test import WebAppTest
+from analyticsclient.constants import demographic, UNKNOWN_COUNTRY_CODE
 
-from analyticsclient.constants import demographic
 from acceptance_tests.mixins import CoursePageTestsMixin
 from acceptance_tests.pages import CourseEnrollmentActivityPage, CourseEnrollmentGeographyPage
 
@@ -44,7 +44,7 @@ def _test_enrollment_metrics_and_graph(self):
         # Check values of summary boxes
         current_enrollment_count = current_enrollment['count']
         data_selector = 'data-stat-type=current_enrollment'
-        self.assertSummaryPointValueEquals(data_selector, unicode(current_enrollment_count))
+        self.assertSummaryPointValueEquals(data_selector, self.format_number(current_enrollment_count))
         self.assertSummaryTooltipEquals(data_selector, u'Students enrolled in the course.')
 
         # Check value of summary box for last week
@@ -74,8 +74,8 @@ def _test_enrollment_trend_table(self):
             enrollment = enrollment_data[i]
             expected_date = datetime.datetime.strptime(enrollment['date'], self.api_date_format).strftime(
                 "%B %d, %Y").replace(' 0', ' ')
-            expected = [expected_date, enrollment['count']]
-            actual = [columns[0].text, int(columns[1].text)]
+            expected = [expected_date, self.format_number(enrollment['count'])]
+            actual = [columns[0].text, columns[1].text]
             self.assertListEqual(actual, expected)
             self.assertIn('text-right', columns[1].get_attribute('class'))
 
@@ -159,7 +159,12 @@ def _test_enrollment_country_table(self):
             enrollment = self.enrollment_data[i]
             expected_percent = enrollment['count'] / sum_count * 100
             expected_percent_display = '{:.1f}%'.format(expected_percent) if expected_percent >= 1.0 else '< 1%'
-            expected = [enrollment['country']['name'], expected_percent_display, enrollment['count']]
+
+            country_name = enrollment['country']['name']
+            if country_name == UNKNOWN_COUNTRY_CODE:
+                country_name = u'Unknown Country'
+
+            expected = [country_name, expected_percent_display, enrollment['count']]
             actual = [columns[0].text, columns[1].text, int(columns[2].text)]
             self.assertListEqual(actual, expected)
             self.assertIn('text-right', columns[1].get_attribute('class'))

analytics_dashboard/analytics_dashboard/formats/__init__.py

@@ -0,0 +1 @@
+DATE_FORMAT = 'F d, Y'

analytics_dashboard/analytics_dashboard/formats/en/__init__.py

@@ -77,6 +77,8 @@
 
 # See: https://docs.djangoproject.com/en/dev/ref/settings/#use-tz
 USE_TZ = True
+
+FORMAT_MODULE_PATH = 'analytics_dashboard.formats'
 ########## END GENERAL CONFIGURATION
 
 
@@ -210,7 +212,8 @@
 
     # Admin panel and documentation:
     'django.contrib.admin',
-    'waffle'
+    'waffle',
+    'django_countries',
 )
 
 # Apps specific for this project go here.

analytics_dashboard/analytics_dashboard/formats/en/formats.py

@@ -1,13 +1,17 @@
 import datetime
+import logging
 
+from django.utils.translation import ugettext as _
 from django.conf import settings
-
+from django_countries import countries
+from waffle import switch_is_active
 from analyticsclient.client import Client
 import analyticsclient.constants.activity_type as AT
-from analyticsclient.constants import demographic
-from analyticsclient.constants import UNKNOWN_COUNTRY_CODE
+from analyticsclient.constants import demographic, UNKNOWN_COUNTRY_CODE
 
-from waffle import switch_is_active
+
+logger = logging.getLogger(__name__)
+COUNTRIES = dict(countries)
 
 
 class BasePresenter(object):
@@ -140,6 +144,23 @@ def _build_empty_trend(self, day):
         trend = {'date': day.isoformat(), 'count': 0}
         return trend
 
+    def _translate_country_names(self, data):
+        """ Translate full country name from English to the language of the logged in user. """
+
+        for datum in data:
+            if datum['country']['name'] == UNKNOWN_COUNTRY_CODE:
+                # Translators: This is a placeholder for enrollment data collected without a known geolocation.
+                datum['country']['name'] = _('Unknown Country')
+            else:
+                country_code = datum['country']['alpha3']
+
+                try:
+                    datum['country']['name'] = unicode(COUNTRIES[datum['country']['alpha2']])
+                except KeyError:
+                    logger.warning('Unable to locate %s in django_countries.', country_code)
+
+        return data
+
     def get_geography_data(self):
         """
         Returns a list of course geography data and the updated date (ex. 2014-1-31).
@@ -154,6 +175,9 @@ def get_geography_data(self):
             # Sort data by descending enrollment count
             api_response = sorted(api_response, key=lambda i: i['count'], reverse=True)
 
+            # Translate the country names
+            api_response = self._translate_country_names(api_response)
+
             # get the sum as a float so we can divide by it to get a percent
             total_enrollment = float(sum([datum['count'] for datum in api_response]))
 
@@ -164,8 +188,8 @@ def get_geography_data(self):
                      'percent': datum['count'] / total_enrollment if total_enrollment > 0 else 0.0}
                     for datum in api_response]
 
-            # do not include unknown country metrics in summary information
-            data_without_unknown = [datum for datum in data if datum['countryName'] != UNKNOWN_COUNTRY_CODE]
+            # Filter out the unknown entry for the summary data
+            data_without_unknown = [datum for datum in data if datum['countryCode'] is not None]
 
             # Include a summary of the number of countries and the top 3 countries, excluding unknown.
             summary = {

analytics_dashboard/analytics_dashboard/settings/base.py

@@ -151,9 +151,7 @@ def test_get_summary_and_trend_data_small(self, mock_enrollment):
 
     @mock.patch('analyticsclient.course.Course.enrollment')
     def test_get_geography_data(self, mock_enrollment):
-        # test with a full set of countries
-        mock_data = get_mock_api_enrollment_geography_data(self.course_id)
-        mock_enrollment.return_value = mock_data
+        mock_enrollment.return_value = get_mock_api_enrollment_geography_data(self.course_id)
 
         expected_summary, expected_data = get_mock_presenter_enrollment_geography_data()
         summary, actual_data = self.presenter.get_geography_data()

analytics_dashboard/courses/presenters.py

@@ -77,20 +77,19 @@ def get_mock_api_enrollment_geography_data_limited(course_id):
 
 
 def get_mock_presenter_enrollment_geography_data():
-    # top three are used in the summary (unknown is excluded)
     data = [
         {'countryCode': 'USA', 'countryName': 'United States', 'count': 500, 'percent': 0.5},
         {'countryCode': 'GER', 'countryName': 'Germany', 'count': 100, 'percent': 0.1},
         {'countryCode': 'CAN', 'countryName': 'Canada', 'count': 100, 'percent': 0.1},
-        {'countryCode': None, 'countryName': UNKNOWN_COUNTRY_CODE, 'count': 300, 'percent': 0.3},
+        {'countryCode': None, 'countryName': 'Unknown Country', 'count': 300, 'percent': 0.3},
     ]
     summary = {
         'last_updated': CREATED_DATETIME,
         'num_countries': 3,
-        'top_countries': data[:3]  # unknown countries are excluded in the top 3
+        'top_countries': data[:3]  # The unknown entry is excluded from the list of top countries.
     }
 
-    # sort so unknown is corrected placed in the returned data
+    # Sort so that the unknown entry is in the correct location within the list.
     data = sorted(data, key=lambda i: i['count'], reverse=True)
 
     return summary, data

analytics_dashboard/courses/tests/test_presenters.py

@@ -2,27 +2,33 @@
  * This defines our libraries across the application.  Each page
  * should load this file.
  */
-var require = {
+
+var require_config = {
     baseUrl: '/static/',
     waitSeconds: 60,
     paths: {
-        jquery: 'vendor/jquery-1.11.1.min',
-        underscore: 'vendor/underscore-min',
-        backbone: 'vendor/backbone-min',
-        bootstrap: 'vendor/bootstrap/javascripts/bootstrap.min',
-        bootstrap_accessibility: 'vendor/bootstrap-accessibility-plugin/js/bootstrap-accessibility.min',
+        jquery: 'bower_components/jquery/dist/jquery.min',
+        underscore: 'bower_components/underscore/underscore-min',
+        backbone: 'bower_components/backbone/backbone',
+        bootstrap: 'bower_components/bootstrap-sass-official/assets/javascripts/bootstrap',
+        bootstrap_accessibility: 'bower_components/bootstrapaccessibilityplugin/plugins/js/bootstrap-accessibility.min',
         models: 'js/models',
         views: 'js/views',
         utils: 'js/utils',
         load: 'js/load',
-        holder: 'vendor/holder',
-        dataTables: 'vendor/dataTables/jquery.dataTables.min',
+        dataTables: 'bower_components/datatables/media/js/jquery.dataTables.min',
         dataTablesBootstrap: 'vendor/dataTables/dataTables.bootstrap',
-        d3: 'vendor/d3/d3',
-        nvd3: 'vendor/nvd3/nv.d3',
-        topojson: 'vendor/topojson/topojson',
-        datamaps: 'vendor/datamaps/datamaps.world.min',
-        moment: 'vendor/moment/moment-with-locales'
+        d3: 'bower_components/d3/d3.min',
+        nvd3: 'bower_components/nvd3/nv.d3.min',
+        topojson: 'bower_components/topojson/topojson',
+        datamaps: 'bower_components/datamaps/dist/datamaps.world.min',
+        moment: 'bower_components/moment/min/moment-with-locales.min',
+        text: 'bower_components/requirejs-plugins/lib/text',
+        json: 'bower_components/requirejs-plugins/src/json',
+        cldr: 'bower_components/cldrjs/dist/cldr',
+        'cldr-data': 'bower_components/cldr-data',
+        globalize: 'bower_components/globalize/dist/globalize',
+        globalization: 'js/utils/globalization'
     },
     shim: {
         bootstrap: {
@@ -46,6 +52,9 @@ var require = {
         dataTablesBootstrap: {
             deps: ['jquery', 'dataTables']
         },
+        d3: {
+            exports: 'd3'
+        },
         nvd3: {
             deps: ['d3'],
             exports: 'nv'
@@ -56,8 +65,21 @@ var require = {
         },
         moment: {
             noGlobal: true
+        },
+        json: {
+            deps: ['text']
+        },
+        globalize: {
+            deps: ['jquery', 'cldr'],
+            exports: 'Globalize'
+        },
+        globalization: {
+            deps: ['globalize'],
+            exports: 'Globalize'
         }
     },
     // load jquery automatically
     deps: ['jquery']
 };
+
+requirejs.config(require_config);