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

#2808 Sorting numerical or Integer tags in ascending order in AEM #2814

Merged
merged 2 commits into from
Apr 8, 2022
Merged

#2808 Sorting numerical or Integer tags in ascending order in AEM #2814

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f03c729
#2808 Sorting numerical or Integer tags in ascending order in AEM
YegorKozlov Apr 6, 2022
ee04c53
Merge branch 'master' into sort-respect-numbers
davidjgonzalez Apr 8, 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
45 changes: 39 additions & 6 deletions bundle/src/main/java/com/adobe/acs/commons/sorter/impl/NodeNameSorter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,36 +28,69 @@
import java.util.Comparator;

import static com.adobe.acs.commons.sorter.impl.HierarchyNodeComparator.RP_NOT_HIERARCHY_FIRST;
import static org.apache.commons.lang3.StringUtils.isNumeric;

@Component
public class NodeNameSorter implements NodeSorter {
public static final String SORTER_NAME = "byName";
public static final String RP_CASE_SENSITIVE = ":caseSensitive";
public static final String RP_RESPECT_NUMBERS = ":respectNumbers";

public String getName(){
public String getName() {
return SORTER_NAME;
}

public String getLabel(){
public String getLabel() {
return "By Node Name";
}


private Comparator<Node> numbersFirstComparator = (n1, n2) -> {
try {
String name1 = n1.getName();
String name2 = n2.getName();
return Boolean.compare(
isNumeric(name2),
isNumeric(name1)
);
} catch (RepositoryException e) {
return 0;
}
};

@Override
public Comparator<Node> createComparator(HttpServletRequest request) {
boolean caseSensitive = Boolean.parseBoolean(request.getParameter(RP_CASE_SENSITIVE));
boolean respectNumbers = Boolean.parseBoolean(request.getParameter(RP_RESPECT_NUMBERS));
boolean nonHierarchyFirst = request.getParameter(RP_NOT_HIERARCHY_FIRST) == null
|| Boolean.parseBoolean(request.getParameter(RP_NOT_HIERARCHY_FIRST));
Comparator<Node> parentComparator = nonHierarchyFirst ? HierarchyNodeComparator.INSTANCE : (n1, n2) -> 0;
return parentComparator.thenComparing((n1, n2) -> {
Comparator<Node> comparator = (n1, n2) -> 0;
if (nonHierarchyFirst) {
comparator = comparator.thenComparing(HierarchyNodeComparator.INSTANCE);
}
if (respectNumbers) {
comparator = comparator.thenComparing(numbersFirstComparator);
}

comparator = comparator.thenComparing((n1, n2) -> {
try {
String name1 = n1.getName();
String name2 = n2.getName();
return caseSensitive ? name1.compareTo(name2) :
name1.compareToIgnoreCase(name2);
if (respectNumbers && isNumeric(name1) && isNumeric(name2)) {
Integer number1 = Integer.valueOf(name1);
Integer number2 = Integer.valueOf(name2);
return number1.compareTo(number2);
} else {
return caseSensitive ? name1.compareTo(name2) :
name1.compareToIgnoreCase(name2);
}

} catch (RepositoryException e) {
return 0;
}
});

return comparator;
}

}
48 changes: 42 additions & 6 deletions bundle/src/main/java/com/adobe/acs/commons/sorter/impl/NodeTitleSorter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,28 +29,57 @@
import java.util.Comparator;

import static com.adobe.acs.commons.sorter.impl.HierarchyNodeComparator.RP_NOT_HIERARCHY_FIRST;
import static org.apache.commons.lang3.StringUtils.isNumeric;

@Component
public class NodeTitleSorter implements NodeSorter {

public static final String SORTER_NAME = "byTitle";
public static final String RP_CASE_SENSITIVE = ":caseSensitive";
public static final String RP_RESPECT_NUMBERS = ":respectNumbers";

public String getName(){
public String getName() {
return SORTER_NAME;
}

public String getLabel(){
public String getLabel() {
return "By Node Title";
}

private Comparator<Node> numbersFirstComparator = (n1, n2) -> {
try {
String title1 = new JcrLabeledResource(n1).getTitle();
if (title1 == null) {
title1 = n1.getName();
}
String title2 = new JcrLabeledResource(n2).getTitle();
if (title2 == null) {
title2 = n2.getName();
}
return Boolean.compare(
isNumeric(title2),
isNumeric(title1)
);
} catch (RepositoryException e) {
return 0;
}
};

@Override
public Comparator<Node> createComparator(HttpServletRequest request) {
boolean caseSensitive = Boolean.parseBoolean(request.getParameter(RP_CASE_SENSITIVE));
boolean respectNumbers = Boolean.parseBoolean(request.getParameter(RP_RESPECT_NUMBERS));
boolean nonHierarchyFirst = request.getParameter(RP_NOT_HIERARCHY_FIRST) == null
|| Boolean.parseBoolean(request.getParameter(RP_NOT_HIERARCHY_FIRST));
Comparator<Node> parentComparator = nonHierarchyFirst ? HierarchyNodeComparator.INSTANCE : (n1, n2) -> 0;
return parentComparator.thenComparing((n1, n2) -> {
Comparator<Node> comparator = (n1, n2) -> 0;
if (nonHierarchyFirst) {
comparator = comparator.thenComparing(HierarchyNodeComparator.INSTANCE);
}
if (respectNumbers) {
comparator = comparator.thenComparing(numbersFirstComparator);
}

comparator = comparator.thenComparing((n1, n2) -> {
try {
String title1 = new JcrLabeledResource(n1).getTitle();
if (title1 == null) {
Expand All @@ -60,11 +89,18 @@ public Comparator<Node> createComparator(HttpServletRequest request) {
if (title2 == null) {
title2 = n2.getName();
}
return caseSensitive ? title1.compareTo(title2) :
title1.compareToIgnoreCase(title2);
if (respectNumbers && isNumeric(title1) && isNumeric(title2)) {
Integer number1 = Integer.valueOf(title1);
Integer number2 = Integer.valueOf(title2);
return number1.compareTo(number2);
} else {
return caseSensitive ? title1.compareTo(title2) :
title1.compareToIgnoreCase(title2);
}
} catch (RepositoryException e) {
return 0;
}
});
return comparator;
}
}
64 changes: 49 additions & 15 deletions bundle/src/test/java/com/adobe/acs/commons/sorter/SortNodesOperationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import com.adobe.acs.commons.sorter.impl.NodeTitleSorter;
import org.apache.sling.api.resource.NonExistingResource;
import org.apache.sling.api.resource.Resource;
import org.apache.sling.resourcebuilder.api.ResourceBuilder;
import org.apache.sling.servlets.post.PostResponse;
import org.apache.sling.testing.mock.sling.ResourceResolverType;
import org.apache.sling.testing.mock.sling.junit.SlingContext;
Expand All @@ -40,7 +41,9 @@
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

import static com.adobe.acs.commons.sorter.SortNodesOperation.RP_SORTER_NAME;
Expand All @@ -59,18 +62,32 @@ public class SortNodesOperationTest {

@Before
public void setUp(){
Map<String, String> sortableContent = new LinkedHashMap<>();
sortableContent.put("aaa", "aaa"); // name -> title
sortableContent.put("Bbb", "Bbb");
sortableContent.put("Zorro", "Zorro");
sortableContent.put("1", "1");
sortableContent.put("20", "20");
sortableContent.put("1-A", "1-A");
sortableContent.put("200", "200");
sortableContent.put("2-B", "2-B");
sortableContent.put("101", "101");
sortableContent.put("11", "11");
sortableContent.put("22", "22");
sortableContent.put("Two", "Two");

sorter.bindNodeSorter(new NodeNameSorter(), Collections.emptyMap());
sorter.bindNodeSorter(new NodeTitleSorter(), Collections.emptyMap());
context.build()
ResourceBuilder bldr = context.build()
.resource("/sortable", JCR_PRIMARYTYPE, "cq:Page")
.resource("/sortable/page2", JCR_PRIMARYTYPE, "cq:Page")
.resource("/sortable/page2/jcr:content", JCR_PRIMARYTYPE, "cq:PageContent", "jcr:title", "A: Page-2")
.resource("/sortable/jcr:content", JCR_PRIMARYTYPE, "nt:unstructured")
.resource("/sortable/page1", JCR_PRIMARYTYPE, "cq:Page")
.resource("/sortable/Page3/jcr:content", JCR_PRIMARYTYPE, "cq:PageContent", "jcr:title", "C: Page-3")
.resource("/sortable/Page3", JCR_PRIMARYTYPE, "cq:Page")
.resource("/sortable/page1/jcr:content", JCR_PRIMARYTYPE, "cq:PageContent", "jcr:title", "a: Page-1")
.resource("/sortable/rep:policy", JCR_PRIMARYTYPE, "rep:ACL");
.siblingsMode();
for(String nodeName : sortableContent.keySet()){
String title = sortableContent.get(nodeName);
bldr.resource(nodeName + "/jcr:content", JCR_PRIMARYTYPE, "cq:PageContent", "jcr:title", title)
.resource(nodeName, JCR_PRIMARYTYPE, "cq:Page");
}
bldr.resource("rep:policy", JCR_PRIMARYTYPE, "rep:ACL")
.resource("jcr:content", JCR_PRIMARYTYPE, "nt:unstructured");
}


Expand All @@ -84,7 +101,7 @@ public void testSortByNameCaseInsensitive() throws RepositoryException {
Node node = context.resourceResolver().getResource("/sortable").adaptTo(Node.class);
List<Node> list = sorter.getSortedNodes(node, comparator);

assertSortOrder(Arrays.asList("jcr:content", "rep:policy", "page1", "page2", "Page3"), list);
assertSortOrder(Arrays.asList("jcr:content", "rep:policy", "1", "1-A", "101", "11", "2-B", "20", "200", "22", "aaa", "Bbb", "Two", "Zorro"), list);

}

Expand All @@ -99,7 +116,8 @@ public void testDisableNonHierarchyFirst() throws RepositoryException {
Node node = context.resourceResolver().getResource("/sortable").adaptTo(Node.class);
List<Node> list = sorter.getSortedNodes(node, comparator);

assertSortOrder(Arrays.asList("jcr:content", "page1", "page2", "Page3", "rep:policy"), list);
assertSortOrder(Arrays.asList("1", "1-A", "101", "11", "2-B", "20", "200", "22", "aaa", "Bbb", "jcr:content", "rep:policy", "Two", "Zorro"
), list);

}

Expand All @@ -114,7 +132,7 @@ public void testSortByNameCaseSensitive() throws RepositoryException {
Node node = context.resourceResolver().getResource("/sortable").adaptTo(Node.class);
List<Node> list = sorter.getSortedNodes(node, comparator);

assertSortOrder(Arrays.asList("jcr:content", "rep:policy", "Page3", "page1", "page2"), list);
assertSortOrder(Arrays.asList("jcr:content", "rep:policy", "1", "1-A", "101", "11", "2-B", "20", "200", "22", "Bbb", "Two", "Zorro", "aaa"), list);

}

Expand All @@ -128,7 +146,7 @@ public void testSortByTitleCaseInsensitive() throws RepositoryException {
Node node = context.resourceResolver().getResource("/sortable").adaptTo(Node.class);
List<Node> list = sorter.getSortedNodes(node, comparator);

assertSortOrder(Arrays.asList("jcr:content", "rep:policy", "page1" /*a: Page-1*/, "page2" /*A: Page-2*/, "Page3" /*C: Page-3*/), list);
assertSortOrder(Arrays.asList("jcr:content", "rep:policy", "1", "1-A", "101", "11", "2-B", "20", "200", "22", "aaa", "Bbb", "Two", "Zorro"), list);

}

Expand All @@ -144,7 +162,23 @@ public void testSortByTitleCaseSensitive() throws RepositoryException {
Node node = context.resourceResolver().getResource("/sortable").adaptTo(Node.class);
List<Node> list = sorter.getSortedNodes(node, comparator);

assertSortOrder(Arrays.asList("jcr:content", "rep:policy", "page2" /*A: Page-2*/, "Page3" /*C: Page-3*/, "page1" /*a: Page-1*/), list);
assertSortOrder(Arrays.asList("jcr:content", "rep:policy", "1", "1-A", "101", "11", "2-B", "20", "200", "22", "Bbb", "Two", "Zorro", "aaa"), list);
}

/**
* by name, case insensitive, numbers first followed by strings
*/
@Test
public void testSortByNameCaseInsensitiveRespectNumbers() throws RepositoryException {
MockSlingHttpServletRequest request = context.request();
request.addRequestParameter(RP_SORTER_NAME, NodeTitleSorter.SORTER_NAME);
request.addRequestParameter(NodeTitleSorter.RP_CASE_SENSITIVE, "true");
request.addRequestParameter(NodeTitleSorter.RP_RESPECT_NUMBERS, "true");
Comparator<Node> comparator = sorter.getNodeSorter(request);
Node node = context.resourceResolver().getResource("/sortable").adaptTo(Node.class);
List<Node> list = sorter.getSortedNodes(node, comparator);

assertSortOrder(Arrays.asList("jcr:content", "rep:policy", "1", "11", "20", "22", "101", "200", "1-A", "2-B", "Bbb", "Two", "Zorro", "aaa"), list);
}

@Test
Expand All @@ -157,7 +191,7 @@ public void testDefaultRequestParameters() {
List<Node> children = new ArrayList<>();
resource.getChildren().forEach(r -> children.add(r.adaptTo(Node.class)));

assertSortOrder(Arrays.asList("jcr:content", "rep:policy", "page1", "page2", "Page3"), children);
assertSortOrder(Arrays.asList("jcr:content", "rep:policy", "1", "1-A", "101", "11", "2-B", "20", "200", "22", "aaa", "Bbb", "Two", "Zorro"), children);
}

@Test
Expand Down
11 changes: 11 additions & 0 deletions ...rc/main/content/jcr_root/apps/acs-commons/components/utilities/sort-nodes/sort-nodes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,17 @@
<coral-checkbox-label>Case Sensitive</coral-checkbox-label>
</coral-checkbox>
</div>
<div class="foundation-field-edit coral-Form-fieldwrapper coral-Form-fieldwrapper--singleline">
<coral-checkbox data-allowBulkEdit="true" name="./:respectNumbers" value="true" class="coral-Form-field">
<coral-checkbox-label>Numbers First</coral-checkbox-label>
</coral-checkbox>
<coral-icon class="coral-Form-fieldinfo coral-Icon coral-Icon--infoCircle coral-Icon--sizeS" icon="infoCircle" size="S" id="file-info" role="img" aria-label="info circle"></coral-icon>
<coral-tooltip variant="info" placement="right" target="#file-info" class="coral3-Tooltip coral3-Tooltip--info" aria-hidden="true" tabindex="-1" role="tooltip" style="display: none;">
<coral-tooltip-content>
Sort numbers first followed by alphabetical values.
</coral-tooltip-content>
</coral-tooltip>
</div>

</section>

Expand Down