Skip to content

Clean _make_menu_item helper #6263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amercader merged 4 commits into from
Sep 7, 2021
Merged

Clean _make_menu_item helper #6263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a9d889d
Clean routes.named_routes config
pdelboca Jul 17, 2021
6f8aba1
Remove old highlight_actions parameter
pdelboca Jul 17, 2021
d221fa5
Fix pep8
pdelboca Jul 17, 2021
d6ef2b0
Change log for 6263
pdelboca Jul 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changes/6263.removal
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
`build_nav_main()`, `build_nav_icon()` and `build_nav()` helpers no longer support
Pylons route syntax. eg use `dataset.search` instead of `controller=dataset, action=search`.
19 changes: 0 additions & 19 deletions ckan/config/middleware/flask_app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,25 +271,6 @@ def ungettext_alias():
lib_plugins.register_package_blueprints(app)
lib_plugins.register_group_blueprints(app)

# Set flask routes in named_routes
# TODO: refactor whatever helper is using this to not do it
if 'routes.named_routes' not in config:
config['routes.named_routes'] = {}
for rule in app.url_map.iter_rules():
if '.' not in rule.endpoint:
continue
controller, action = rule.endpoint.split('.')
needed = list(rule.arguments - set(rule.defaults or {}))
route = {
rule.endpoint: {
'action': action,
'controller': controller,
'highlight_actions': action,
'needed': needed
}
}
config['routes.named_routes'].update(route)

# Start other middleware
for plugin in PluginImplementations(IMiddleware):
app = plugin.make_middleware(app, config)
Expand Down
18 changes: 6 additions & 12 deletions ckan/lib/helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -797,7 +797,6 @@ def _link_class(kwargs):
active = ' active'
else:
active = ''
kwargs.pop('highlight_actions', '')
return kwargs.pop('class_', '') + active or None

def _create_link_text(text, **kwargs):
Expand Down Expand Up @@ -1024,21 +1023,16 @@ def _make_menu_item(menu_item, title, **kw):

This function is called by wrapper functions.
'''
menu_item = map_pylons_to_flask_route_name(menu_item)
_menu_items = config['routes.named_routes']
if menu_item not in _menu_items:
raise Exception('menu item `%s` cannot be found' % menu_item)
item = copy.copy(_menu_items[menu_item])
controller, action = menu_item.split('.')
item = {
'action': action,
'controller': controller
}
item.update(kw)
active = _link_active(item)

# Remove highlight controllers so that they won't appear in generated urls.
item.pop('highlight_controllers', False)
needed = item.pop('needed')
for need in needed:
if need not in kw:
raise Exception('menu item `%s` need parameter `%s`'
% (menu_item, need))

link = _link_to(title, menu_item, suppress_active_class=True, **item)
if active:
return literal('<li class="active">') + link + literal('</li>')
Expand Down
2 changes: 1 addition & 1 deletion ckan/templates/package/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{% block subtitle %}{{ _(dataset_type.title()) }}{% endblock %}

{% block breadcrumb_content %}
<li class="active">{{ h.nav_link(_(dataset_type.title() + 's'), named_route='%s.search' % dataset_type, highlight_actions = 'new index') }}</li>
<li class="active">{{ h.nav_link(_(dataset_type.title() + 's'), named_route='%s.search' % dataset_type) }}</li>
{% endblock %}

{% block primary_content %}
Expand Down
2 changes: 1 addition & 1 deletion ckan/templates/package/snippets/new_package_breadcrumb.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<li>{% link_for _('Datasets'), named_route='dataset.search', highlight_actions = 'new index' %}</li>
<li>{% link_for _('Datasets'), named_route='dataset.search' %}</li>
<li class="active">{% link_for _('Create Dataset'), named_route='dataset.new' %}</li>
127 changes: 8 additions & 119 deletions ckan/tests/lib/test_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,127 +622,16 @@ def test_active_in_resource_controller(self, test_request_context):
'<li><a href="/about">About</a></li>'
)

def test_legacy_pylon_routes(self):
menu = (
("home", "Home"),
("search", "Datasets"),
("organizations_index", "Organizations"),
("group_index", "Groups"),
("about", "About"),
)
assert h.build_nav_main(*menu) == (
'<li class="active"><a href="/">Home</a></li>'
'<li><a href="/dataset/">Datasets</a></li>'
'<li><a href="/organization/">Organizations</a></li>'
'<li><a href="/group/">Groups</a></li>'
'<li><a href="/about">About</a></li>'
)
def test_link_to(self):
link = h.link_to("Example Link", "https://www.example.com", cls='css-class', target='_blank')
assert link == '<a class="css-class" href="https://www.example.com" target="_blank">Example Link</a>'

def test_active_in_legacy_pylon_routes(self, test_request_context):
link2 = h.link_to('display_name', h.url_for('dataset.search', tags='name'), class_='tag')
link2 == '<a class="tag" href="/dataset/?tags=name">display_name</a>'

with test_request_context(u'/organization'):
menu = (
("home", "Home"),
("search", "Datasets", ['dataset', 'resource']),
("organizations_index", "Organizations"),
("group_index", "Groups"),
("about", "About"),
)
assert h.build_nav_main(*menu) == (
'<li><a href="/">Home</a></li>'
'<li><a href="/dataset/">Datasets</a></li>'
'<li class="active"><a href="/organization/">Organizations</a></li>'
'<li><a href="/group/">Groups</a></li>'
'<li><a href="/about">About</a></li>'
)

@pytest.mark.usefixtures("clean_db")
def test_active_in_resource_controller_legacy_pylon_routes(self, test_request_context):

dataset = factories.Dataset()
with test_request_context(u'/dataset/' + dataset['id']):
menu = (
("home", "Home"),
("search", "Datasets", ['dataset', 'resource']),
("organizations_index", "Organizations"),
("group_index", "Groups"),
("about", "About"),
)
assert h.build_nav_main(*menu) == (
'<li><a href="/">Home</a></li>'
'<li class="active"><a href="/dataset/">Datasets</a></li>'
'<li><a href="/organization/">Organizations</a></li>'
'<li><a href="/group/">Groups</a></li>'
'<li><a href="/about">About</a></li>'
)

resource = factories.Resource(name="some_resource")
with test_request_context(u'/dataset/' + resource['package_id'] + '/resource/' + resource['id']):
menu = (
("home", "Home"),
("search", "Datasets", ['dataset', 'resource']),
("organizations_index", "Organizations"),
("group_index", "Groups"),
("about", "About"),
)
assert h.build_nav_main(*menu) == (
'<li><a href="/">Home</a></li>'
'<li class="active"><a href="/dataset/">Datasets</a></li>'
'<li><a href="/organization/">Organizations</a></li>'
'<li><a href="/group/">Groups</a></li>'
'<li><a href="/about">About</a></li>'
)

def test_dataset_navigation_legacy_routes(self):
dataset_name = "test-dataset"
assert (
h.build_nav_icon("dataset_read", "Datasets", id=dataset_name)
== '<li><a href="/dataset/test-dataset">Datasets</a></li>'
)
assert (
h.build_nav_icon("dataset_groups", "Groups", id=dataset_name)
== '<li><a href="/dataset/groups/test-dataset">Groups</a></li>'
)
assert (
h.build_nav_icon(
"dataset_activity", "Activity Stream", id=dataset_name
)
== '<li><a href="/dataset/activity/test-dataset">Activity Stream</a></li>'
)

def test_group_navigation_legacy_routes(self):
group_name = "test-group"
assert (
h.build_nav_icon("group_read", "Datasets", id=group_name)
== '<li><a href="/group/test-group">Datasets</a></li>'
)
assert (
h.build_nav_icon(
"group_activity", "Activity Stream", id=group_name
)
== '<li><a href="/group/activity/test-group">Activity Stream</a></li>'
)
assert (
h.build_nav_icon("group_about", "About", id=group_name)
== '<li><a href="/group/about/test-group">About</a></li>'
)

def test_organization_navigation_legacy_routes(self):
org_name = "test-org"
assert (
h.build_nav_icon("organization_read", "Datasets", id=org_name)
== '<li><a href="/organization/test-org">Datasets</a></li>'
)
assert (
h.build_nav_icon(
"organization_activity", "Activity Stream", id=org_name
)
== '<li><a href="/organization/activity/test-org">Activity Stream</a></li>'
)
assert (
h.build_nav_icon("organization_about", "About", id=org_name)
== '<li><a href="/organization/about/test-org">About</a></li>'
)
def test_build_nav_icon(self):
link = h.build_nav_icon('organization.edit', 'Edit', id='org-id', icon='pencil-square-o')
assert link == '<li><a href="/organization/edit/org-id"><i class="fa fa-pencil-square-o"></i> Edit</a></li>'


class TestHelpersPlugin(p.SingletonPlugin):
Expand Down