Merge lp:~cjohnston/summit/menu-fixes into lp:summit

[Chris Johnston]

Fixes the menu highlighting

[Michael Hall (mhall119)]

LGTM

review: Approve

=== added file 'summit/common/migrations/0002_update_menu_app.py'
--- summit/common/migrations/0002_update_menu_app.py	1970-01-01 00:00:00 +0000
+++ summit/common/migrations/0002_update_menu_app.py	2012-10-03 21:03:22 +0000
@@ -0,0 +1,49 @@
+# encoding: utf-8
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        
+        # Adding field 'MenuItem.anonymous_only'
+        db.add_column('common_menuitem', 'anonymous_only', self.gf('django.db.models.fields.BooleanField')(default=False), keep_default=False)
+
+
+    def backwards(self, orm):
+        
+        # Deleting field 'MenuItem.anonymous_only'
+        db.delete_column('common_menuitem', 'anonymous_only')
+
+
+    models = {
+        'common.menu': {
+            'Meta': {'object_name': 'Menu'},
+            'base_url': ('django.db.models.fields.CharField', [], {'max_length': '100', 'null': 'True', 'blank': 'True'}),
+            'description': ('django.db.models.fields.TextField', [], {'null': 'True', 'blank': 'True'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'site': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['sites.Site']"}),
+            'slug': ('django.db.models.fields.SlugField', [], {'max_length': '50', 'db_index': 'True'})
+        },
+        'common.menuitem': {
+            'Meta': {'object_name': 'MenuItem'},
+            'anonymous_only': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'link_url': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'login_required': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
+            'menu': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['common.Menu']"}),
+            'order': ('django.db.models.fields.IntegerField', [], {}),
+            'title': ('django.db.models.fields.CharField', [], {'max_length': '100'})
+        },
+        'sites.site': {
+            'Meta': {'ordering': "('domain',)", 'object_name': 'Site', 'db_table': "'django_site'"},
+            'domain': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
+        }
+    }
+
+    complete_apps = ['common']

=== modified file 'summit/common/models.py'
--- summit/common/models.py	2012-03-08 02:35:38 +0000
+++ summit/common/models.py	2012-10-03 21:03:22 +0000
@@ -16,12 +16,29 @@
     def __unicode__(self):
         return "%s" % self.name
 
+    def save(self, force_insert=False, force_update=False):
+        """
+        Re-order all items from 10 upwards, at intervals of 10.
+        This makes it easy to insert new items in the middle of 
+        existing items without having to manually shuffle 
+        them all around.
+        """
+        super(Menu, self).save(force_insert, force_update)
+        
+        current = 10
+        for item in MenuItem.objects.filter(menu=self).order_by('order'):
+            item.order = current
+            item.save()
+            current += 10
+
+
 class MenuItem(models.Model):
     menu = models.ForeignKey(Menu)
     order = models.IntegerField()
     link_url = models.CharField(max_length=100, help_text='URL or URI to the content, eg /about/ or http://foo.com/')
     title = models.CharField(max_length=100)
-    login_required = models.BooleanField(blank=True)
+    login_required = models.BooleanField(blank=True, help_text='Should this item only be shown to authenticated users?')
+    anonymous_only = models.BooleanField(blank=True, help_text='Should this item only be shown to non-logged-in users?')
     
     def __unicode__(self):
         return "%s %s. %s" % (self.menu.slug, self.order, self.title)

=== modified file 'summit/common/templatetags/menubuilder.py'
--- summit/common/templatetags/menubuilder.py	2012-04-17 01:53:48 +0000
+++ summit/common/templatetags/menubuilder.py	2012-10-03 21:03:22 +0000
@@ -1,5 +1,6 @@
 from common.models import Menu, MenuItem
 from django import template
+from django.core.cache import cache
 
 register = template.Library()
 
@@ -23,7 +24,7 @@
         user = context['request'].user
         context['menuitems'] = get_items(real_menu_name, current_path, user)
         return ''
-  
+
 def build_sub_menu(parser, token):
     """
     {% submenu %}
@@ -49,15 +50,41 @@
             context['submenu_items'] = context['submenu'] = None
         return ''
 
-def get_items(menu, current_path, user):
-    menuitems = []
+def get_items(menu_name, current_path, user):
+    """
+    If possible, use a cached list of items to avoid continually re-querying 
+    the database.
+    The key contains the menu name, whether the user is authenticated, and the current path.
+    Disable caching by setting MENU_CACHE_TIME to -1.
+    """
+    from django.conf import settings
+    cache_time = getattr(settings, 'MENU_CACHE_TIME', 1800)
+    debug = getattr(settings, 'DEBUG', False)
+
+    if cache_time >= 0 and not debug:
+        cache_key = 'django-menu-items/%s/%s/%s'  % (menu_name, current_path, user.is_authenticated())
+        menuitems = cache.get(cache_key, [])
+        if menuitems:
+            return menuitems
+    else:
+        menuitems = []
+        
     try:
-        for i in MenuItem.objects.filter(menu__slug=menu).order_by('order'):
-            current = ( i.link_url != '/' and current_path.endswith(i.link_url + '/')) or ( i.link_url == '/' and current_path == '/' )
-            if not i.login_required or ( i.login_required and user.is_authenticated() ):
-                menuitems.append({'url': i.link_url, 'title': i.title, 'current': current,})
-    except MenuItem.DoesNotExist:
-        pass# No Menu by this name, fail gracefully
+        menu = Menu.objects.get(slug=menu_name)
+    except Menu.DoesNotExist:
+        return []
+
+    for i in MenuItem.objects.filter(menu=menu).order_by('order'):
+        current = ( i.link_url != '/' and current_path.startswith(i.link_url)) or ( i.link_url == '/' and current_path == '/' )
+        if menu.base_url and i.link_url == menu.base_url and current_path != i.link_url:
+            current = False
+        show_anonymous = i.anonymous_only and user.is_anonymous()
+        show_auth = i.login_required and user.is_authenticated()
+        if (not (i.login_required or i.anonymous_only)) or (i.login_required and show_auth) or (i.anonymous_only and show_anonymous):
+            menuitems.append({'url': i.link_url, 'title': i.title, 'current': current,})
+
+    if cache_time >= 0 and not debug:
+        cache.set(cache_key, menuitems, cache_time)
     return menuitems
 
 register.tag('menu', build_menu)

=== modified file 'summit/common/tests.py'
--- summit/common/tests.py	2012-04-18 21:51:05 +0000
+++ summit/common/tests.py	2012-10-03 21:03:22 +0000
@@ -22,6 +22,8 @@
 from summit.schedule.fields import NameField
 
 from summit.schedule.models import Summit
+from summit.common.models import Menu
+from django.contrib.sites.models import Site
 
 # Monkey-patch our NameField into the types of fields that the factory
 # understands.  This is simpler than trying to subclass the Mommy
@@ -33,13 +35,32 @@
     def setUp(self):
         now = datetime.datetime.utcnow()
         one_hour = datetime.timedelta(0, 3600)
-        summit = factory.make_one(Summit, name='uds-test')
+        site = factory.make_one(Site, id=1)
+        summit = factory.make_one(Summit, name='uds-test', date_start=datetime.datetime.now(), date_end=datetime.datetime.now())
+        summit.sites.add(site)
+        menu = factory.make_one(Menu, name='Main', slug="main", site=site)
+        menu.menuitem_set.create(order=0, link_url='/uds-test/', title='Schedule')
+        menu.menuitem_set.create(order=0, link_url='/today/uds-test/', title='Today')
         
-    def test_menu_highlights(self):
+    def test_toplevel_menu_highlights(self):
         schedule_page = self.client.get('/uds-test/')
-        self.assertContains(schedule_page, '<a class="main-nav-item current" href="/uds-test/" title="Schedule">Schedule</a>', 1)
-        self.assertContains(schedule_page, '<a class="main-nav-item current" href="/today/uds-test/" title="Today">Today</a>', 0)
+        print schedule_page.content
+        self.assertContains(schedule_page, 
+            '<li class=\'active\' id="main-nav"><a class="main-nav-item" href="/uds-test/" title="Schedule">Schedule</a>', 1)
+        self.assertContains(schedule_page, 
+            '<li id="main-nav"><a class="main-nav-item" href="/uds-test/" title="Schedule">Schedule</a>', 0)
+        self.assertContains(schedule_page, 
+            '<li class=\'active\' id="main-nav"><a class="main-nav-item" href="/today/uds-test/" title="Today">Today</a>', 0)
+        self.assertContains(schedule_page, 
+            '<li id="main-nav"><a class="main-nav-item" href="/today/uds-test/" title="Today">Today</a>', 1)
 
+    def test_sublevel_menu_highlights(self):
         today_page = self.client.get('/today/uds-test/')
-        self.assertContains(today_page, '<a class="main-nav-item current" href="/uds-test/" title="Schedule">Schedule</a>', 0)
-        self.assertContains(today_page, '<a class="main-nav-item current" href="/today/uds-test/" title="Today">Today</a>', 1)
+        self.assertContains(today_page, 
+            '<li class=\'active\' id="main-nav"><a class="main-nav-item" href="/uds-test/" title="Schedule">Schedule</a>', 0)
+        self.assertContains(today_page, 
+            '<li id="main-nav"><a class="main-nav-item" href="/uds-test/" title="Schedule">Schedule</a>', 1)
+        self.assertContains(today_page, 
+            '<li class=\'active\' id="main-nav"><a class="main-nav-item" href="/today/uds-test/" title="Today">Today</a>', 1)
+        self.assertContains(today_page, 
+            '<li id="main-nav"><a class="main-nav-item" href="/today/uds-test/" title="Today">Today</a>', 0)