Polish 'Add an issue type filter'

See gh-86

Author: philwebb

src/main/java/io/spring/githubchangeloggenerator/ApplicationProperties.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018-2024 the original author or authors.
+ * Copyright 2018-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -147,7 +147,7 @@ public static class Section {
 		private final IssueType type;
 
 		public Section(String title, @DefaultValue("default") String group, IssueSort sort, Set<String> labels,
-				@DefaultValue("ANY") IssueType type) {
+				@DefaultValue("any") IssueType type) {
 			this.title = title;
 			this.group = (group != null) ? group : "default";
 			this.sort = sort;

src/main/java/io/spring/githubchangeloggenerator/ChangelogSection.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018-2022 the original author or authors.
+ * Copyright 2018-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,17 +16,12 @@
 
 package io.spring.githubchangeloggenerator;
 
-import java.util.Arrays;
-import java.util.LinkedHashSet;
-import java.util.Set;
+import java.util.function.Predicate;
 
 import org.springframework.util.Assert;
-import org.springframework.util.CollectionUtils;
 
 import io.spring.githubchangeloggenerator.ApplicationProperties.IssueSort;
-import io.spring.githubchangeloggenerator.ApplicationProperties.IssueType;
 import io.spring.githubchangeloggenerator.github.payload.Issue;
-import io.spring.githubchangeloggenerator.github.payload.Label;
 
 /**
  * A single section of a changelog report.
@@ -42,22 +37,15 @@ class ChangelogSection {
 
 	private final IssueSort sort;
 
-	private final Set<String> labels;
+	private Predicate<Issue> filter;
 
-	private final IssueType type;
-
-	ChangelogSection(String title, String group, IssueSort sort, String... labels) {
-		this(title, group, sort, new LinkedHashSet<>(Arrays.asList(labels)), IssueType.ANY);
-	}
-
-	ChangelogSection(String title, String group, IssueSort sort, Set<String> labels, IssueType type) {
+	ChangelogSection(String title, String group, IssueSort sort, Predicate<Issue> filter) {
 		Assert.hasText(title, "Title must not be empty");
-		Assert.isTrue(!CollectionUtils.isEmpty(labels), "Labels must not be empty");
+		Assert.notNull(filter, "Filter must not be null");
 		this.title = title;
 		this.group = group;
 		this.sort = sort;
-		this.labels = labels;
-		this.type = type;
+		this.filter = filter;
 	}
 
 	String getGroup() {
@@ -68,27 +56,13 @@ IssueSort getSort() {
 		return this.sort;
 	}
 
-	boolean isMatchFor(Issue issue) {
-		for (String candidate : this.labels) {
-			for (Label label : issue.getLabels()) {
-				if (label.getName().contains(candidate)) {
-					switch (this.type) {
-						case ISSUE:
-							return issue.getPullRequest() == null;
-						case PULL_REQUEST:
-							return issue.getPullRequest() != null;
-						default:
-							return true;
-					}
-				}
-			}
-		}
-		return false;
-	}
-
 	@Override
 	public String toString() {
 		return this.title;
 	}
 
+	boolean isMatchFor(Issue issue) {
+		return this.filter.test(issue);
+	}
+
 }

src/main/java/io/spring/githubchangeloggenerator/ChangelogSections.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2018-2022 the original author or authors.
+ * Copyright 2018-2025 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@
 import java.util.Set;
 import java.util.SortedMap;
 import java.util.TreeMap;
+import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
 import org.springframework.util.CollectionUtils;
@@ -50,8 +51,8 @@ class ChangelogSections {
 		DEFAULT_SECTIONS = Collections.unmodifiableList(sections);
 	}
 
-	private static void add(List<ChangelogSection> sections, String title, String... labels) {
-		sections.add(new ChangelogSection(title, null, null, labels));
+	private static void add(List<ChangelogSection> sections, String title, String... labelNameContent) {
+		sections.add(new ChangelogSection(title, null, null, SelectIssues.withLabelNamesContaining(labelNameContent)));
 	}
 
 	private final List<ChangelogSection> sections;
@@ -74,9 +75,10 @@ private List<ChangelogSection> adapt(ApplicationProperties properties) {
 		return customSections;
 	}
 
-	private ChangelogSection adapt(ApplicationProperties.Section propertySection) {
-		return new ChangelogSection(propertySection.getTitle(), propertySection.getGroup(), propertySection.getSort(),
-				propertySection.getLabels(), propertySection.getType());
+	private ChangelogSection adapt(ApplicationProperties.Section section) {
+		Predicate<Issue> filter = SelectIssues.withLabelNamesContaining(section.getLabels());
+		filter = filter.and(SelectIssues.withType(section.getType()));
+		return new ChangelogSection(section.getTitle(), section.getGroup(), section.getSort(), filter);
 	}
 
 	Map<ChangelogSection, List<Issue>> collate(List<Issue> issues) {

src/main/java/io/spring/githubchangeloggenerator/SelectIssues.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2018-2024 the original author or authors.
+ *
+ * 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
+ *
+ *      https://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 io.spring.githubchangeloggenerator;
+
+import java.util.Collection;
+import java.util.Set;
+import java.util.function.Predicate;
+
+import io.spring.githubchangeloggenerator.ApplicationProperties.IssueType;
+import io.spring.githubchangeloggenerator.github.payload.Issue;
+import io.spring.githubchangeloggenerator.github.payload.Label;
+
+/**
+ * Utility to select issues.
+ *
+ * @author Phillip Webb
+ * @author Steven Sheehy
+ */
+final class SelectIssues {
+
+	private SelectIssues() {
+	}
+
+	static Predicate<Issue> withLabelNamesContaining(String... nameContent) {
+		return withLabelNamesContaining(Set.of(nameContent));
+	}
+
+	static Predicate<Issue> withLabelNamesContaining(Collection<String> nameContent) {
+		return (issue) -> issue.getLabels()
+			.stream()
+			.map(Label::getName)
+			.anyMatch((name) -> nameContent.stream().anyMatch(name::contains));
+	}
+
+	static Predicate<? super Issue> withType(IssueType type) {
+		return (issue) -> {
+			return switch (type) {
+				case ANY -> true;
+				case ISSUE -> issue.getPullRequest() == null;
+				case PULL_REQUEST -> issue.getPullRequest() != null;
+			};
+		};
+	}
+
+}

src/test/resources/io/spring/githubchangeloggenerator/test-application.yml

@@ -4,7 +4,7 @@ changelog:
   - title: ":star: New Features"
     labels: ["enhancement"]
     sort: "created"
-    type: ISSUE
+    type: issue
   - title: "Bugs"
     labels: ["bug"]
     group: "test"