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

CIF-2673 - Add navRoot checkbox to page properties #942

Merged
merged 3 commits into from
Jul 14, 2022
Merged

CIF-2673 - Add navRoot checkbox to page properties #942

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a4fa5b0
CIF-2673 - Add navRoot checkbox to page properties
herzog31 Jul 13, 2022
732d1ee
Merge branch 'master' into issue/CIF-2673
buuhuu Jul 14, 2022
f630dcd
hide associated content section when no landing page is known
buuhuu Jul 14, 2022
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
78 changes: 78 additions & 0 deletions ...dobe/cq/commerce/core/components/internal/servlets/ShowNavRootRenderConditionServlet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~ Copyright 2022 Adobe
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
package com.adobe.cq.commerce.core.components.internal.servlets;

import java.io.IOException;

import javax.servlet.Servlet;
import javax.servlet.ServletException;

import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingSafeMethodsServlet;
import org.jetbrains.annotations.NotNull;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;

import com.adobe.cq.commerce.core.components.internal.services.site.SiteStructureFactory;
import com.adobe.cq.commerce.core.components.models.common.SiteStructure;
import com.adobe.granite.ui.components.rendercondition.RenderCondition;
import com.adobe.granite.ui.components.rendercondition.SimpleRenderCondition;
import com.day.cq.wcm.api.Page;
import com.day.cq.wcm.api.PageManager;

/**
* {@code ShowNavRootRenderConditionServlet} implements a {@code granite:rendercondition} used to determine if the navRoot option should be
* displayed on the properties page of a page.
*/
@Component(
service = { Servlet.class },
property = {
"sling.servlet.resourceTypes=" + ShowNavRootRenderConditionServlet.RESOURCE_TYPE,
"sling.servlet.methods=GET",
"sling.servlet.extensions=html"
})
public class ShowNavRootRenderConditionServlet extends SlingSafeMethodsServlet {
public final static String RESOURCE_TYPE = "core/cif/components/renderconditions/showNavRoot";

@Reference
private SiteStructureFactory siteStructureFactory;

@Override
protected void doGet(@NotNull SlingHttpServletRequest request, @NotNull SlingHttpServletResponse response)
throws ServletException, IOException {
request.setAttribute(RenderCondition.class.getName(), new SimpleRenderCondition(showNavRoot(request)));
}

private boolean showNavRoot(SlingHttpServletRequest request) {
PageManager pageManager = request.getResourceResolver().adaptTo(PageManager.class);
if (pageManager == null) {
return false;
}

String pagePath = request.getParameter("item");
Page page = pageManager.getPage(pagePath);
if (page == null) {
return false;
}

SiteStructure siteStructure = siteStructureFactory.getSiteStructure(page);
Page landingPage = siteStructure.getLandingPage();

// Show navRoot option if there is no landing page or if the current page is the landing page.
return landingPage == null || landingPage.equals(page);
}
}
92 changes: 92 additions & 0 deletions .../cq/commerce/core/components/internal/servlets/ShowNavRootRenderConditionServletTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~ Copyright 2022 Adobe
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
package com.adobe.cq.commerce.core.components.internal.servlets;

import java.io.IOException;

import javax.servlet.ServletException;

import org.apache.sling.api.resource.Resource;
import org.apache.sling.servlethelpers.MockSlingHttpServletRequest;
import org.apache.sling.servlethelpers.MockSlingHttpServletResponse;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;

import com.adobe.granite.ui.components.rendercondition.RenderCondition;
import com.adobe.granite.ui.components.rendercondition.SimpleRenderCondition;
import io.wcm.testing.mock.aem.junit.AemContext;

import static com.adobe.cq.commerce.core.testing.TestContext.newAemContext;
import static org.mockito.Mockito.mock;

public class ShowNavRootRenderConditionServletTest {

@Rule
public final AemContext context = newAemContext("/context/SiteStructureImplTest/jcr-content.json");

private MockSlingHttpServletRequest request;
private MockSlingHttpServletResponse response;
private ShowNavRootRenderConditionServlet servlet;

@Before
public void setUp() {
response = new MockSlingHttpServletResponse();
request = new MockSlingHttpServletRequest(context.resourceResolver());
Resource resource = mock(Resource.class);
request.setResource(resource);
request.setPathInfo("/mnt/overlay/wcm/core/content/sites/properties.html");

servlet = context.registerInjectActivateService(new ShowNavRootRenderConditionServlet());
}

@Test
public void testReturnsTrueForLandingPageEqualsPage() throws ServletException, IOException {
request.setQueryString("item=/content/nav-root");
servlet.doGet(request, response);

SimpleRenderCondition condition = (SimpleRenderCondition) request.getAttribute(RenderCondition.class.getName());
Assert.assertTrue(condition.check());
}

@Test
public void testReturnsTrueForNoLandingPage() throws ServletException, IOException {
request.setQueryString("item=/content/no-nav-root");
servlet.doGet(request, response);

SimpleRenderCondition condition = (SimpleRenderCondition) request.getAttribute(RenderCondition.class.getName());
Assert.assertTrue(condition.check());
}

@Test
public void testReturnsFalseForDefinedLandingPage() throws ServletException, IOException {
request.setQueryString("item=/content/nav-root/content-page");
servlet.doGet(request, response);

SimpleRenderCondition condition = (SimpleRenderCondition) request.getAttribute(RenderCondition.class.getName());
Assert.assertFalse(condition.check());
}

@Test
public void testReturnsFalseForInvalidPage() throws ServletException, IOException {
request.setQueryString("item=/content/does-not-exist");
servlet.doGet(request, response);

SimpleRenderCondition condition = (SimpleRenderCondition) request.getAttribute(RenderCondition.class.getName());
Assert.assertFalse(condition.check());
}
}
13 changes: 13 additions & 0 deletions .../content/jcr_root/apps/core/cif/components/structure/page/v1/page/_cq_dialog/.content.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,21 @@
jcr:primaryType="nt:unstructured"
sling:resourceType="core/cif/components/renderconditions/pagetype"
pageType="product"/>
<navRootCondition jcr:primaryType="nt:unstructured"
sling:resourceType="core/cif/components/renderconditions/showNavRoot"/>
</granite:rendercondition>
<items jcr:primaryType="nt:unstructured">
<navRoot
jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/coral/foundation/form/checkbox"
fieldDescription="Make this page the landing page of your site."
name="./navRoot"
text="Landing Page"
uncheckedValue="false"
value="true">
<granite:rendercondition jcr:primaryType="nt:unstructured"
sling:resourceType="core/cif/components/renderconditions/showNavRoot"/>
</navRoot>
<categoryFilter jcr:primaryType="nt:unstructured"
sling:resourceType="commerce/gui/components/common/cifcategoryfield"
fieldDescription="Category ids for which this page will be used."
Expand Down
13 changes: 13 additions & 0 deletions .../content/jcr_root/apps/core/cif/components/structure/page/v2/page/_cq_dialog/.content.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,21 @@
jcr:primaryType="nt:unstructured"
sling:resourceType="core/cif/components/renderconditions/pagetype"
pageType="product"/>
<navRootCondition jcr:primaryType="nt:unstructured"
sling:resourceType="core/cif/components/renderconditions/showNavRoot"/>
</granite:rendercondition>
<items jcr:primaryType="nt:unstructured">
<navRoot
jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/coral/foundation/form/checkbox"
fieldDescription="Make this page the landing page of your site."
name="./navRoot"
text="Landing Page"
uncheckedValue="false"
value="true">
<granite:rendercondition jcr:primaryType="nt:unstructured"
sling:resourceType="core/cif/components/renderconditions/showNavRoot"/>
</navRoot>
<productFilter jcr:primaryType="nt:unstructured"
sling:resourceType="commerce/gui/components/common/cifproductfield"
fieldDescription="Product slugs for which this page will be used."
Expand Down
16 changes: 14 additions & 2 deletions .../content/jcr_root/apps/core/cif/components/structure/page/v3/page/_cq_dialog/.content.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,12 +150,24 @@
<categoryPageCondition jcr:primaryType="nt:unstructured"
sling:resourceType="core/cif/components/renderconditions/pagetype"
pageType="category"/>
<productPageCondition
jcr:primaryType="nt:unstructured"
<productPageCondition jcr:primaryType="nt:unstructured"
sling:resourceType="core/cif/components/renderconditions/pagetype"
pageType="product"/>
<navRootCondition jcr:primaryType="nt:unstructured"
sling:resourceType="core/cif/components/renderconditions/showNavRoot"/>
</granite:rendercondition>
<items jcr:primaryType="nt:unstructured">
<navRoot
jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/coral/foundation/form/checkbox"
fieldDescription="Make this page the landing page of your site."
name="./navRoot"
text="Landing Page"
uncheckedValue="false"
value="true">
<granite:rendercondition jcr:primaryType="nt:unstructured"
sling:resourceType="core/cif/components/renderconditions/showNavRoot"/>
</navRoot>
<productFilter jcr:primaryType="nt:unstructured"
sling:resourceType="commerce/gui/components/common/cifproductfield"
fieldDescription="Product slugs for which this page will be used."
Expand Down