From 3553f23eab25a5999082cec80dc09693c7cb776f Mon Sep 17 00:00:00 2001 From: Lance Edgar Date: Wed, 23 Feb 2022 00:26:14 -0600 Subject: [PATCH] Use dict instead of custom object to represent menus as prep for editing menu config directly in app --- tailbone/menus.py | 86 ++++++++++----------- tailbone/templates/menu.mako | 12 +-- tailbone/templates/themes/falafel/base.mako | 28 +++---- 3 files changed, 63 insertions(+), 63 deletions(-) diff --git a/tailbone/menus.py b/tailbone/menus.py index 2402e768..e2c025c1 100644 --- a/tailbone/menus.py +++ b/tailbone/menus.py @@ -2,7 +2,7 @@ ################################################################################ # # Rattail -- Retail Software Framework -# Copyright © 2010-2021 Lance Edgar +# Copyright © 2010-2022 Lance Edgar # # This file is part of Rattail. # @@ -26,38 +26,11 @@ App Menus from __future__ import unicode_literals, absolute_import -from rattail.core import Object +import re + from rattail.util import import_module_path -class MenuGroup(Object): - title = None - items = None - is_menu = True - is_link = False - - -class MenuItem(Object): - title = None - url = None - target = None - is_link = True - is_menu = False - is_sep = False - - -class MenuItemMenu(Object): - title = None - items = None - is_menu = True - is_sep = False - - -class MenuSeparator(object): - is_menu = False - is_sep = True - - def make_simple_menus(request): """ Build the main menu list for the app. @@ -93,30 +66,48 @@ def make_simple_menus(request): for subitem in item['items']: if subitem['allowed']: submenu_items.append(make_menu_entry(subitem)) - menu_items.append(MenuItemMenu( - title=item['title'], - items=submenu_items)) + menu_items.append({ + 'type': 'submenu', + 'title': item['title'], + 'items': submenu_items, + 'is_menu': True, + 'is_sep': False, + }) elif item.get('type') == 'sep': # we only want to add a sep, *if* we already have some # menu items (i.e. there is something to separate) # *and* the last menu item is not a sep (avoid doubles) - if menu_items and not menu_items[-1].is_sep: + if menu_items and not menu_items[-1]['is_sep']: menu_items.append(make_menu_entry(item)) else: # standard menu item menu_items.append(make_menu_entry(item)) # remove final separator if present - if menu_items and menu_items[-1].is_sep: + if menu_items and menu_items[-1]['is_sep']: menu_items.pop() # only add if we wound up with something assert menu_items if menu_items: - final_menus.append(MenuGroup( - title=topitem['title'], - items=menu_items)) + group = { + 'type': 'menu', + 'key': topitem.get('key'), + 'title': topitem['title'], + 'items': menu_items, + 'is_menu': True, + 'is_link': False, + } + + # topitem w/ no key likely means it did not come + # from config but rather explicit definition in + # code. so we are free to "invent" a (safe) key + # for it, since that is only for editing config + if not group['key']: + group['key'] = re.sub(r'\W', '', topitem['title'].lower()) + + final_menus.append(group) return final_menus @@ -128,13 +119,22 @@ def make_menu_entry(item): """ # separator if item.get('type') == 'sep': - return MenuSeparator() + return { + 'type': 'sep', + 'is_menu': False, + 'is_sep': True, + } # standard menu item - return MenuItem( - title=item['title'], - url=item['url'], - target=item.get('target')) + return { + 'type': 'item', + 'title': item['title'], + 'url': item['url'], + 'target': item.get('target'), + 'is_link': True, + 'is_menu': False, + 'is_sep': False, + } def is_allowed(request, item): diff --git a/tailbone/templates/menu.mako b/tailbone/templates/menu.mako index 7549e763..65acd0dd 100644 --- a/tailbone/templates/menu.mako +++ b/tailbone/templates/menu.mako @@ -4,16 +4,16 @@ % for topitem in menus:
  • - % if topitem.is_link: - ${h.link_to(topitem.title, topitem.url, target=topitem.target)} + % if topitem['is_link']: + ${h.link_to(topitem['title'], topitem['url'], target=topitem['target'])} % else: - ${topitem.title} + ${topitem['title']} diff --git a/tailbone/templates/themes/falafel/base.mako b/tailbone/templates/themes/falafel/base.mako index 4378c4cf..0bc0aca8 100644 --- a/tailbone/templates/themes/falafel/base.mako +++ b/tailbone/templates/themes/falafel/base.mako @@ -200,33 +200,33 @@
    % for topitem in menus: - % if topitem.is_link: - ${h.link_to(topitem.title, topitem.url, target=topitem.target, class_='navbar-item')} + % if topitem['is_link']: + ${h.link_to(topitem['title'], topitem['url'], target=topitem['target'], class_='navbar-item')} % else:
    - ${topitem.title} + ${topitem['title']}
    - % for item in topitem.items: - % if item.is_menu: + % for item in topitem['items']: + % if item['is_menu']: <% item_hash = id(item) %> <% toggle = 'menu_{}_shown'.format(item_hash) %> - % for subitem in item.items: - % if subitem.is_sep: + % for subitem in item['items']: + % if subitem['is_sep']:
    % else: - ${h.link_to("{}".format(subitem.title), subitem.url, class_='navbar-item nested', target=subitem.target, **{'v-show': toggle})} + ${h.link_to("{}".format(subitem['title']), subitem['url'], class_='navbar-item nested', target=subitem['target'], **{'v-show': toggle})} % endif % endfor % else: - % if item.is_sep: + % if item['is_sep']:
    % else: - ${h.link_to(item.title, item.url, class_='navbar-item', target=item.target)} + ${h.link_to(item['title'], item['url'], class_='navbar-item', target=item['target'])} % endif % endif % endfor @@ -705,9 +705,9 @@ ## declare nested menu visibility toggle flags % for topitem in menus: - % if topitem.is_menu: - % for item in topitem.items: - % if item.is_menu: + % if topitem['is_menu']: + % for item in topitem['items']: + % if item['is_menu']: WholePageData.menu_${id(item)}_shown = false % endif % endfor