Skip to content
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

Jump to bottom

Add Menus #1667

Merged
merged 9 commits into from
Nov 8, 2019
Merged

Add Menus #1667

merged 9 commits into from
Nov 8, 2019

Conversation

tvdeyen
Copy link
Member

@tvdeyen tvdeyen commented Nov 4, 2019

What is this pull request for?

Introduces Menus as a new concept for managing navigation menus.

Notable changes

Adds a new Module "Menus" that allows to add unlimited menus. Those menus have nodes. Each node can be just a name, can have an url and/or reference a page. All of those are optional.

Each menu has its own templates (at app/views/alchemy/menus/<menu-name>) for ease of customization.

  • Deprecates render_navigation in favor of render_menu('<menu-name>')
  • Introduces a new rails generate alchemy:menus generator
  • Adds a rake alchemy:convert:page_trees:to_menus Rake task for migrating existing sites

Screenshots

Menus and nodes list

Screen Shot 2019-11-04 at 23 41 38

Attach page to a menu

Screen Shot 2019-11-04 at 23 48 16

List of menus page is attached to

Screen Shot 2019-11-04 at 23 48 06

@tvdeyen tvdeyen added this to the 4.4 milestone Nov 4, 2019
@tvdeyen tvdeyen force-pushed the add-menus branch 2 times, most recently from 5cb3aef to 78d2e4d Compare November 5, 2019 08:23
mamhoff
mamhoff reviewed Nov 5, 2019
View reviewed changes
Copy link
Contributor

@mamhoff mamhoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks quite nice! Reminds me of conversations we've had a long time ago. Good riddance, page tree!

I'll defer approval until all the specs are green, and I have a question regarding the VALID_URL_REGEX.

@tvdeyen
Copy link
Member Author

tvdeyen commented Nov 5, 2019 via email

@tvdeyen tvdeyen self-assigned this Nov 5, 2019
@tvdeyen
Copy link
Member Author

tvdeyen commented Nov 5, 2019 •
edited
Loading

Note to self

  • proper error message
  • fix convert rake task for pages redirect to external

@tvdeyen
Copy link
Member Author

tvdeyen commented Nov 6, 2019

@mamhoff added a hint on how the url should be formatted

Screen Shot 2019-11-06 at 11 35 15

@tvdeyen tvdeyen mentioned this pull request Nov 7, 2019
Closed
@tvdeyen tvdeyen force-pushed the add-menus branch 3 times, most recently from 04bdcca to 1ed8b12 Compare November 7, 2019 22:24
@tvdeyen tvdeyen removed their assignment Nov 8, 2019
tvdeyen and others added 7 commits November 8, 2019 09:45
@tvdeyen
Adds nodes controller and admin views.
c75ec86
@tvdeyen
Implement attach page to menu feature
39c690b 
A page can now be attached to a menu.

This works with the "visible in navigation" checkbox, but only
if Menus are already present - it will fall back to old behavior
instead.

Once attached to a menu node it you cannot detach it from the page,
you need to remove the menu node first.
@tvdeyen
Deprecate external and controller redirects on page
c854fd8 
Instead use a menu node with either the external url or
your controller path.
@tvdeyen
Deprecate render_navigation helpers
2988807 
Create a menu and use render_menu helper instead.
@tvdeyen
Do not generate the navigation views any more
1cf3fc2 
Create a menu and generate menu views instead.
@tvdeyen
Add a menus generator
8419df3 
Generates view partials for menus

    rails g alchemy:menus
@tvdeyen
Add render_menu helper
0113747 
It renders a menu's view templates.
@tvdeyen
Add a rake task to convert page trees into menus
7ba30a3 
Run this task to convert your current page trees into menus

    rake alchemy:convert:page_trees:to_menus
@codeclimate
Copy link

codeclimate bot commented Nov 8, 2019

Code Climate has analyzed commit 7ba30a3 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (80% is the threshold).

This pull request will bring the total coverage in the repository to 92.1% (0.0% change).

View more on Code Climate.

@tvdeyen tvdeyen merged commit 2cb573a into AlchemyCMS:master Nov 8, 2019
@tvdeyen tvdeyen deleted the add-menus branch November 8, 2019 08:59
tvdeyen added a commit that referenced this pull request Jan 6, 2020
@tvdeyen
v4.4.0
f714109 
- Use contents settings for size in EssencePicture#picture_url [#1703](#1703) ([tvdeyen](https://github.com/tvdeyen))
- Remove title tag from preview elements [#1701](#1701) ([tvdeyen](https://github.com/tvdeyen))
- Remove custom JS logging [#1700](#1700) ([tvdeyen](https://github.com/tvdeyen))
- Remove demo locale files [#1699](#1699) ([tvdeyen](https://github.com/tvdeyen))
- Use alchemyPageSelect for Node page select [#1698](#1698) ([tvdeyen](https://github.com/tvdeyen))
- Cache menu partials [#1697](#1697) ([tvdeyen](https://github.com/tvdeyen))
- Update page tree to menu nodes Rake task [#1696](#1696) ([tvdeyen](https://github.com/tvdeyen))
- Validate nodes name if page is absent [#1695](#1695) ([tvdeyen](https://github.com/tvdeyen))
- Update the application layout installer template [#1691](#1691) ([tvdeyen](https://github.com/tvdeyen))
- Update note about missing user class [#1690](#1690) ([tvdeyen](https://github.com/tvdeyen))
- Use a Sprockets 3/4 manifest file [#1689](#1689) ([tvdeyen](https://github.com/tvdeyen))
- Use select2 for internal page link in link overlay [#1685](#1685) ([tvdeyen](https://github.com/tvdeyen))
- Do not consider nested elements "orphaned" [#1684](#1684) ([mamhoff](https://github.com/mamhoff))
- Destroy page-dependent elements [#1683](#1683) ([mamhoff](https://github.com/mamhoff))
- Add anchor link tab to link overlay [#1682](#1682) ([tvdeyen](https://github.com/tvdeyen))
- Ensure the apt/cache folder exists while installing [#1678](#1678) ([tvdeyen](https://github.com/tvdeyen))
- Cache apt packages between CI runs [#1677](#1677) ([tvdeyen](https://github.com/tvdeyen))
- Use select2 with AJAX search for essence page select [#1675](#1675) ([tvdeyen](https://github.com/tvdeyen))
- Eager load associated records [#1674](#1674) ([tvdeyen](https://github.com/tvdeyen))
- Add support for testing with multiple Rails versions [#1673](#1673) ([tvdeyen](https://github.com/tvdeyen))
- Page api pagination [#1672](#1672) ([tvdeyen](https://github.com/tvdeyen))
- Adjust select2 loading-more indicator [#1671](#1671) ([tvdeyen](https://github.com/tvdeyen))
- Test support fixes [#1669](#1669) ([tvdeyen](https://github.com/tvdeyen))
- Build fixes [#1668](#1668) ([tvdeyen](https://github.com/tvdeyen))
- Add Menus [#1667](#1667) ([tvdeyen](https://github.com/tvdeyen))
- Add a label component [#1666](#1666) ([tvdeyen](https://github.com/tvdeyen))
- Run bundle install on CI even if cache hits [#1665](#1665) ([tvdeyen](https://github.com/tvdeyen))
- Moves switch_language method into languages_controller. [#1664](#1664) ([tvdeyen](https://github.com/tvdeyen))
- Cache gems between CI runs [#1663](#1663) ([tvdeyen](https://github.com/tvdeyen))
- Remove production gems from local Gemfile [#1662](#1662) ([tvdeyen](https://github.com/tvdeyen))
- Touch contents updated_at column in pure SQL [#1661](#1661) ([tvdeyen](https://github.com/tvdeyen))
- Convert page editing user methods into AR relations [#1658](#1658) ([tvdeyen](https://github.com/tvdeyen))
- Ensure the admin locale is only set by available locales [#1655](#1655) ([tvdeyen](https://github.com/tvdeyen))
- Add a GitHub actions ci.yml [#1654](#1654) ([tvdeyen](https://github.com/tvdeyen))
- Adjust install generator to latest changes [#1649](#1649) ([tvdeyen](https://github.com/tvdeyen))
- Deprecate _view suffix of element views [#1648](#1648) ([tvdeyen](https://github.com/tvdeyen))
- Add a configurable logout method (default: delete) [#1647](#1647) ([delphaber](https://github.com/delphaber))
- Deprecate render_essence helpers [#1644](#1644) ([tvdeyen](https://github.com/tvdeyen))
- Deprecate element editors [#1643](#1643) ([tvdeyen](https://github.com/tvdeyen))
- Deprecate local options in essence editors [#1642](#1642) ([tvdeyen](https://github.com/tvdeyen))
- Ensure the EssencePage id regexp matches only numbers [#1641](#1641) ([tvdeyen](https://github.com/tvdeyen))
- Use EssencePage in contact forms [#1640](#1640) ([tvdeyen](https://github.com/tvdeyen))
- Add Alchemy::EssencePage [#1639](#1639) ([tvdeyen](https://github.com/tvdeyen))
- FEAT: Render message and warnings in element editor [#1637](#1637) ([tvdeyen](https://github.com/tvdeyen))
- Tackle Rails 6 deprecations [#1636](#1636) ([tvdeyen](https://github.com/tvdeyen))
- Preload assets in tests [#1635](#1635) ([tvdeyen](https://github.com/tvdeyen))
- Allow acts-as-list 1.0 [#1634](#1634) ([tvdeyen](https://github.com/tvdeyen))
- Add Sprockets manifest file to dummy app [#1632](#1632) ([tvdeyen](https://github.com/tvdeyen))
- Master now tracks 4.4.0.alpha [#1627](#1627) ([tvdeyen](https://github.com/tvdeyen))
- Fix Cell Migration to maintain positions [#1625](#1625) ([mamhoff](https://github.com/mamhoff))
- Cell Upgrader: Match quotation marks in cell name string [#1624](#1624) ([mamhoff](https://github.com/mamhoff))
- Cell Migrator: Maintain element order in fixed elements [#1623](#1623) ([mamhoff](https://github.com/mamhoff))
- Enhance cells upgrader to deal with render_elements from_page: x [#1622](#1622) ([mamhoff](https://github.com/mamhoff))
@tvdeyen tvdeyen mentioned this pull request Jan 6, 2020
Merged
tvdeyen added a commit that referenced this pull request Jan 6, 2020
@tvdeyen
v4.4.0
0d96bec 
- Use contents settings for size in EssencePicture#picture_url [#1703](#1703) ([tvdeyen](https://github.com/tvdeyen))
- Remove title tag from preview elements [#1701](#1701) ([tvdeyen](https://github.com/tvdeyen))
- Remove custom JS logging [#1700](#1700) ([tvdeyen](https://github.com/tvdeyen))
- Remove demo locale files [#1699](#1699) ([tvdeyen](https://github.com/tvdeyen))
- Use alchemyPageSelect for Node page select [#1698](#1698) ([tvdeyen](https://github.com/tvdeyen))
- Cache menu partials [#1697](#1697) ([tvdeyen](https://github.com/tvdeyen))
- Update page tree to menu nodes Rake task [#1696](#1696) ([tvdeyen](https://github.com/tvdeyen))
- Validate nodes name if page is absent [#1695](#1695) ([tvdeyen](https://github.com/tvdeyen))
- Update the application layout installer template [#1691](#1691) ([tvdeyen](https://github.com/tvdeyen))
- Update note about missing user class [#1690](#1690) ([tvdeyen](https://github.com/tvdeyen))
- Use a Sprockets 3/4 manifest file [#1689](#1689) ([tvdeyen](https://github.com/tvdeyen))
- Use select2 for internal page link in link overlay [#1685](#1685) ([tvdeyen](https://github.com/tvdeyen))
- Do not consider nested elements "orphaned" [#1684](#1684) ([mamhoff](https://github.com/mamhoff))
- Destroy page-dependent elements [#1683](#1683) ([mamhoff](https://github.com/mamhoff))
- Add anchor link tab to link overlay [#1682](#1682) ([tvdeyen](https://github.com/tvdeyen))
- Ensure the apt/cache folder exists while installing [#1678](#1678) ([tvdeyen](https://github.com/tvdeyen))
- Cache apt packages between CI runs [#1677](#1677) ([tvdeyen](https://github.com/tvdeyen))
- Use select2 with AJAX search for essence page select [#1675](#1675) ([tvdeyen](https://github.com/tvdeyen))
- Eager load associated records [#1674](#1674) ([tvdeyen](https://github.com/tvdeyen))
- Add support for testing with multiple Rails versions [#1673](#1673) ([tvdeyen](https://github.com/tvdeyen))
- Page api pagination [#1672](#1672) ([tvdeyen](https://github.com/tvdeyen))
- Adjust select2 loading-more indicator [#1671](#1671) ([tvdeyen](https://github.com/tvdeyen))
- Test support fixes [#1669](#1669) ([tvdeyen](https://github.com/tvdeyen))
- Build fixes [#1668](#1668) ([tvdeyen](https://github.com/tvdeyen))
- Add Menus [#1667](#1667) ([tvdeyen](https://github.com/tvdeyen))
- Add a label component [#1666](#1666) ([tvdeyen](https://github.com/tvdeyen))
- Run bundle install on CI even if cache hits [#1665](#1665) ([tvdeyen](https://github.com/tvdeyen))
- Moves switch_language method into languages_controller. [#1664](#1664) ([tvdeyen](https://github.com/tvdeyen))
- Cache gems between CI runs [#1663](#1663) ([tvdeyen](https://github.com/tvdeyen))
- Remove production gems from local Gemfile [#1662](#1662) ([tvdeyen](https://github.com/tvdeyen))
- Touch contents updated_at column in pure SQL [#1661](#1661) ([tvdeyen](https://github.com/tvdeyen))
- Convert page editing user methods into AR relations [#1658](#1658) ([tvdeyen](https://github.com/tvdeyen))
- Ensure the admin locale is only set by available locales [#1655](#1655) ([tvdeyen](https://github.com/tvdeyen))
- Add a GitHub actions ci.yml [#1654](#1654) ([tvdeyen](https://github.com/tvdeyen))
- Adjust install generator to latest changes [#1649](#1649) ([tvdeyen](https://github.com/tvdeyen))
- Deprecate _view suffix of element views [#1648](#1648) ([tvdeyen](https://github.com/tvdeyen))
- Add a configurable logout method (default: delete) [#1647](#1647) ([delphaber](https://github.com/delphaber))
- Deprecate render_essence helpers [#1644](#1644) ([tvdeyen](https://github.com/tvdeyen))
- Deprecate element editors [#1643](#1643) ([tvdeyen](https://github.com/tvdeyen))
- Deprecate local options in essence editors [#1642](#1642) ([tvdeyen](https://github.com/tvdeyen))
- Ensure the EssencePage id regexp matches only numbers [#1641](#1641) ([tvdeyen](https://github.com/tvdeyen))
- Use EssencePage in contact forms [#1640](#1640) ([tvdeyen](https://github.com/tvdeyen))
- Add Alchemy::EssencePage [#1639](#1639) ([tvdeyen](https://github.com/tvdeyen))
- FEAT: Render message and warnings in element editor [#1637](#1637) ([tvdeyen](https://github.com/tvdeyen))
- Tackle Rails 6 deprecations [#1636](#1636) ([tvdeyen](https://github.com/tvdeyen))
- Preload assets in tests [#1635](#1635) ([tvdeyen](https://github.com/tvdeyen))
- Allow acts-as-list 1.0 [#1634](#1634) ([tvdeyen](https://github.com/tvdeyen))
- Add Sprockets manifest file to dummy app [#1632](#1632) ([tvdeyen](https://github.com/tvdeyen))
- Master now tracks 4.4.0.alpha [#1627](#1627) ([tvdeyen](https://github.com/tvdeyen))
- Fix Cell Migration to maintain positions [#1625](#1625) ([mamhoff](https://github.com/mamhoff))
- Cell Upgrader: Match quotation marks in cell name string [#1624](#1624) ([mamhoff](https://github.com/mamhoff))
- Cell Migrator: Maintain element order in fixed elements [#1623](#1623) ([mamhoff](https://github.com/mamhoff))
- Enhance cells upgrader to deal with render_elements from_page: x [#1622](#1622) ([mamhoff](https://github.com/mamhoff))
robinboening added a commit to robinboening/alchemy_cms that referenced this pull request Apr 19, 2021
@robinboening
hotfix and deprecate page_active? helper
5328e36 
The `page_active?` helper used to depend on `Page.ancestors_for` but got removed with AlchemyCMS#1813. This PR hotfixes the `page_active?` helper, but since menus got introduced with AlchemyCMS#1667 the `page_active?` helper is obsolete and is now marked for deletion.
robinboening added a commit to robinboening/alchemy_cms that referenced this pull request Apr 19, 2021
@robinboening
hotfix and deprecate page_active? helper
e139958 
The `page_active?` helper used to depend on `Page.ancestors_for` which got removed with AlchemyCMS#1813. This PR hotfixes the `page_active?` helper, but since menus got introduced with AlchemyCMS#1667 the `page_active?` helper is obsolete and is now marked for deletion.
robinboening added a commit to robinboening/alchemy_cms that referenced this pull request Apr 19, 2021
@robinboening
hotfix and deprecate page_active? helper
611779c 
The `page_active?` helper used to depend on `Page.ancestors_for` which got removed with AlchemyCMS#1813. This PR hotfixes `page_active?`, but since menus got introduced with AlchemyCMS#1667 the helper is obsolete and is now marked for deletion.
robinboening added a commit to robinboening/alchemy_cms that referenced this pull request Apr 19, 2021
@robinboening
hotfix and deprecate page_active? helper
5ebde5e 
The `page_active?` helper used to depend on `Page.ancestors_for` which got removed with AlchemyCMS#1813. This PR hotfixes `page_active?`, but since menus got introduced with AlchemyCMS#1667 the helper is obsolete and is now marked for deletion.
@robinboening robinboening mentioned this pull request Apr 19, 2021
Merged
robinboening added a commit to robinboening/alchemy_cms that referenced this pull request Apr 20, 2021
@robinboening
hotfix and deprecate page_active? helper
2437561 
The `page_active?` helper used to depend on `Page.ancestors_for` which got removed with AlchemyCMS#1813. This PR hotfixes `page_active?`, but since menus got introduced with AlchemyCMS#1667 the helper is obsolete and is now marked for deletion.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mamhoff mamhoff mamhoff left review comments

@houndci-bot houndci-bot houndci-bot left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
4.4
Development

Successfully merging this pull request may close these issues.
3 participants
@tvdeyen @mamhoff @houndci-bot