Commit 7245f769 by Nimisha Asthagiri

Fix quality issues in ace_common

parent 7ef443f7
default_app_config = 'openedx.core.djangoapps.ace_common.apps.AceCommonConfig' """
ace_common is a Django App that provides common utilities and templates
for edx-platform applications that use ACE as their messaging framework.
"""
default_app_config = 'openedx.core.djangoapps.ace_common.apps.AceCommonConfig' # pylint: disable=invalid-name
"""
Configuration for the ace_common Django app.
"""
from django.apps import AppConfig from django.apps import AppConfig
from django.utils.translation import ugettext_lazy as _ from django.utils.translation import ugettext_lazy as _
class AceCommonConfig(AppConfig): class AceCommonConfig(AppConfig):
"""
Configuration class for the ace_common Django app.
"""
name = 'openedx.core.djangoapps.ace_common' name = 'openedx.core.djangoapps.ace_common'
verbose_name = _('ACE Common') verbose_name = _('ACE Common')
"""
Context dictionary for templates that use the ace_common base template.
"""
from django.conf import settings from django.conf import settings
from django.core.urlresolvers import reverse from django.core.urlresolvers import reverse
...@@ -6,13 +9,19 @@ from openedx.core.djangoapps.theming.helpers import get_config_value_from_site_o ...@@ -6,13 +9,19 @@ from openedx.core.djangoapps.theming.helpers import get_config_value_from_site_o
def get_base_template_context(site): def get_base_template_context(site):
"""Dict with entries needed for all templates that use the base template""" """
Dict with entries needed for all templates that use the base template.
"""
return { return {
# Platform information # Platform information
'homepage_url': marketing_link('ROOT'), 'homepage_url': marketing_link('ROOT'),
'dashboard_url': reverse('dashboard'), 'dashboard_url': reverse('dashboard'),
'template_revision': getattr(settings, 'EDX_PLATFORM_REVISION', None), 'template_revision': getattr(settings, 'EDX_PLATFORM_REVISION', None),
'platform_name': get_config_value_from_site_or_settings('PLATFORM_NAME', site=site, site_config_name='platform_name'), 'platform_name': get_config_value_from_site_or_settings(
'PLATFORM_NAME',
site=site,
site_config_name='platform_name',
),
'contact_mailing_address': get_config_value_from_site_or_settings( 'contact_mailing_address': get_config_value_from_site_or_settings(
'CONTACT_MAILING_ADDRESS', site=site, site_config_name='contact_mailing_address'), 'CONTACT_MAILING_ADDRESS', site=site, site_config_name='contact_mailing_address'),
'social_media_urls': get_config_value_from_site_or_settings('SOCIAL_MEDIA_FOOTER_URLS', site=site), 'social_media_urls': get_config_value_from_site_or_settings('SOCIAL_MEDIA_FOOTER_URLS', site=site),
......
# pylint: disable=missing-docstring
from urlparse import urlparse from urlparse import urlparse
from crum import get_current_request from crum import get_current_request
...@@ -7,7 +8,7 @@ from django.utils.safestring import mark_safe ...@@ -7,7 +8,7 @@ from django.utils.safestring import mark_safe
from openedx.core.djangoapps.ace_common.tracking import CampaignTrackingInfo, GoogleAnalyticsTrackingPixel from openedx.core.djangoapps.ace_common.tracking import CampaignTrackingInfo, GoogleAnalyticsTrackingPixel
from openedx.core.djangolib.markup import HTML from openedx.core.djangolib.markup import HTML
register = template.Library() register = template.Library() # pylint: disable=invalid-name
@register.simple_tag(takes_context=True) @register.simple_tag(takes_context=True)
...@@ -133,7 +134,7 @@ def modify_url_to_track_clicks(url, campaign=None): ...@@ -133,7 +134,7 @@ def modify_url_to_track_clicks(url, campaign=None):
if campaign is None: if campaign is None:
campaign = CampaignTrackingInfo() campaign = CampaignTrackingInfo()
modified_url = parsed_url._replace(query=campaign.to_query_string(parsed_url.query)) modified_url = parsed_url._replace(query=campaign.to_query_string(parsed_url.query))
return modified_url.geturl() return modified_url.geturl() # pylint: disable=no-member
def ensure_url_is_absolute(site, relative_path): def ensure_url_is_absolute(site, relative_path):
......
# pylint: disable=missing-docstring
from urlparse import parse_qs, urlparse from urlparse import parse_qs, urlparse
......
# pylint: disable=missing-docstring,no-member
import uuid import uuid
from django.http import HttpRequest from django.http import HttpRequest
...@@ -23,6 +24,7 @@ class TestAbsoluteUrl(CacheIsolationTestCase): ...@@ -23,6 +24,7 @@ class TestAbsoluteUrl(CacheIsolationTestCase):
def setUp(self): def setUp(self):
self.site = SiteFactory.create() self.site = SiteFactory.create()
self.site.domain = 'example.com' self.site.domain = 'example.com'
super(TestAbsoluteUrl, self).setUp()
def test_absolute_url(self): def test_absolute_url(self):
absolute = ensure_url_is_absolute(self.site, '/foo/bar') absolute = ensure_url_is_absolute(self.site, '/foo/bar')
......
# pylint: disable=missing-docstring,no-member
from unittest import TestCase from unittest import TestCase
from django.test import override_settings from django.test import override_settings
......
# pylint: disable=missing-docstring
from urlparse import parse_qs from urlparse import parse_qs
import attr import attr
...@@ -92,7 +93,10 @@ class GoogleAnalyticsTrackingPixel(object): ...@@ -92,7 +93,10 @@ class GoogleAnalyticsTrackingPixel(object):
parameters['tid'] = tracking_id parameters['tid'] = tracking_id
user_id_dimension = get_config_value_from_site_or_settings("GOOGLE_ANALYTICS_USER_ID_CUSTOM_DIMENSION", site=self.site) user_id_dimension = get_config_value_from_site_or_settings(
"GOOGLE_ANALYTICS_USER_ID_CUSTOM_DIMENSION",
site=self.site,
)
if user_id_dimension is not None and self.user_id is not None: if user_id_dimension is not None and self.user_id is not None:
parameter_name = 'cd{0}'.format(user_id_dimension) parameter_name = 'cd{0}'.format(user_id_dimension)
parameters[parameter_name] = self.user_id parameters[parameter_name] = self.user_id
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment