Adapt to changes in spring-website-content

Closes gh-28

Author: mbhave

src/main/java/io/spring/projectapi/ProjectRepository.java

@@ -21,7 +21,7 @@
 
 import io.spring.projectapi.github.Project;
 import io.spring.projectapi.github.ProjectDocumentation;
-import io.spring.projectapi.github.ProjectSupport;
+import io.spring.projectapi.github.ProjectGeneration;
 import io.spring.projectapi.web.webhook.CacheController;
 
 /**
@@ -39,7 +39,7 @@ public interface ProjectRepository {
 
 	List<ProjectDocumentation> getProjectDocumentations(String projectSlug);
 
-	List<ProjectSupport> getProjectSupports(String projectSlug);
+	ProjectGeneration getProjectGenerations(String projectSlug);
 
 	String getProjectSupportPolicy(String projectSlug);
 

src/main/java/io/spring/projectapi/github/GithubProjectRepository.java

@@ -66,10 +66,10 @@ public List<ProjectDocumentation> getProjectDocumentations(String projectSlug) {
 	}
 
 	@Override
-	public List<ProjectSupport> getProjectSupports(String projectSlug) {
-		List<ProjectSupport> projectSupports = this.projectData.support().get(projectSlug);
-		NoSuchGithubProjectException.throwIfNotFound(projectSupports, projectSlug);
-		return projectSupports;
+	public ProjectGeneration getProjectGenerations(String projectSlug) {
+		ProjectGeneration projectGeneration = this.projectData.generation().get(projectSlug);
+		NoSuchGithubProjectException.throwIfNotFound(projectGeneration, projectSlug);
+		return projectGeneration;
 	}
 
 	@Override

src/main/java/io/spring/projectapi/github/GithubQueries.java

@@ -50,9 +50,6 @@ public class GithubQueries {
 	private static final TypeReference<@NotNull List<ProjectDocumentation>> DOCUMENTATION_LIST = new TypeReference<>() {
 	};
 
-	private static final TypeReference<List<ProjectSupport>> SUPPORT_LIST = new TypeReference<>() {
-	};
-
 	private static final String GITHUB_URI = "https://api.github.com/repos/spring-io/spring-website-content/contents";
 
 	private static final Logger logger = LoggerFactory.getLogger(GithubOperations.class);
@@ -85,28 +82,28 @@ public GithubQueries(RestTemplateBuilder restTemplateBuilder, ObjectMapper objec
 	ProjectData getData() {
 		Map<String, Project> projects = new LinkedHashMap<>();
 		Map<String, List<ProjectDocumentation>> documentation = new LinkedHashMap<>();
-		Map<String, List<ProjectSupport>> support = new LinkedHashMap<>();
+		Map<String, ProjectGeneration> generation = new LinkedHashMap<>();
 		Map<String, String> supportPolicy = new LinkedHashMap<>();
 		try {
 			RequestEntity<Void> request = RequestEntity.get("/project?ref=" + this.branch).build();
 			ResponseEntity<List<Map<String, Object>>> exchange = this.restTemplate.exchange(request,
 					STRING_OBJECT_MAP_LIST);
 			InvalidGithubResponseException.throwIfInvalid(exchange);
 			List<Map<String, Object>> body = exchange.getBody();
-			body.forEach((project) -> populateData(project, projects, documentation, support, supportPolicy));
+			body.forEach((project) -> populateData(project, projects, documentation, generation, supportPolicy));
 		}
 		catch (Exception ex) {
 			logger.debug("Could not get projects due to '%s'".formatted(ex.getMessage()));
 			// Return empty list
 		}
-		return new ProjectData(projects, documentation, support, supportPolicy);
+		return new ProjectData(projects, documentation, generation, supportPolicy);
 	}
 
 	ProjectData updateData(ProjectData data, List<String> changes) {
 		Assert.notNull(data, "Project data should not be null");
 		Map<String, Project> projects = new LinkedHashMap<>(data.project());
 		Map<String, List<ProjectDocumentation>> documentation = new LinkedHashMap<>(data.documentation());
-		Map<String, List<ProjectSupport>> support = new LinkedHashMap<>(data.support());
+		Map<String, ProjectGeneration> generation = new LinkedHashMap<>(data.generation());
 		Map<String, String> supportPolicy = new LinkedHashMap<>(data.supportPolicy());
 		Map<String, Boolean> checkedProjects = new LinkedHashMap<>();
 		try {
@@ -115,18 +112,18 @@ ProjectData updateData(ProjectData data, List<String> changes) {
 				if (ProjectFile.OTHER.equals(file)) {
 					return;
 				}
-				updateData(change, file, projects, supportPolicy, documentation, support, checkedProjects);
+				updateData(change, file, projects, supportPolicy, documentation, generation, checkedProjects);
 			});
 		}
 		catch (Exception ex) {
 			logger.debug("Could not update data due to '%s'".formatted(ex.getMessage()));
 		}
-		return new ProjectData(projects, documentation, support, supportPolicy);
+		return new ProjectData(projects, documentation, generation, supportPolicy);
 	}
 
 	private void updateData(String change, ProjectFile file, Map<String, Project> projects,
 			Map<String, String> supportPolicy, Map<String, List<ProjectDocumentation>> documentation,
-			Map<String, List<ProjectSupport>> support, Map<String, Boolean> checkedprojects) {
+			Map<String, ProjectGeneration> generation, Map<String, Boolean> checkedprojects) {
 		Matcher matcher = PROJECT_FILE.matcher(change);
 		if (!matcher.matches()) {
 			return;
@@ -138,18 +135,18 @@ private void updateData(String change, ProjectFile file, Map<String, Project> pr
 		if (checkedprojects.get(slug)) {
 			updateFromIndex(file, projects, supportPolicy, slug);
 			updateDocumentation(file, documentation, slug);
-			updateSupport(file, support, slug);
+			updateGeneration(file, generation, slug);
 			return;
 		}
 		projects.remove(slug);
 		documentation.remove(slug);
-		support.remove(slug);
+		generation.remove(slug);
 		supportPolicy.remove(slug);
 	}
 
-	private void updateSupport(ProjectFile file, Map<String, List<ProjectSupport>> support, String slug) {
+	private void updateGeneration(ProjectFile file, Map<String, ProjectGeneration> support, String slug) {
 		if (ProjectFile.SUPPORT.equals(file)) {
-			List<ProjectSupport> projectSupports = getProjectSupports(slug);
+			ProjectGeneration projectSupports = getProjectSupports(slug);
 			support.put(slug, projectSupports);
 		}
 	}
@@ -192,7 +189,7 @@ private boolean doesProjectExist(String projectSlug) {
 	}
 
 	private void populateData(Map<String, Object> project, Map<String, Project> projects,
-			Map<String, List<ProjectDocumentation>> documentation, Map<String, List<ProjectSupport>> support,
+			Map<String, List<ProjectDocumentation>> documentation, Map<String, ProjectGeneration> support,
 			Map<String, String> supportPolicy) {
 		String projectSlug = (String) project.get("name");
 		ResponseEntity<Map<String, Object>> response = getFile(projectSlug, "index.md");
@@ -202,7 +199,7 @@ private void populateData(Map<String, Object> project, Map<String, Project> proj
 		}
 		List<ProjectDocumentation> projectDocumentations = getProjectDocumentations(projectSlug);
 		documentation.put(projectSlug, projectDocumentations);
-		List<ProjectSupport> projectSupports = getProjectSupports(projectSlug);
+		ProjectGeneration projectSupports = getProjectSupports(projectSlug);
 		support.put(projectSlug, projectSupports);
 		String policy = getProjectSupportPolicy(response, projectSlug);
 		supportPolicy.put(projectSlug, policy);
@@ -234,16 +231,17 @@ private List<ProjectDocumentation> getProjectDocumentations(String projectSlug)
 		return Collections.emptyList();
 	}
 
-	private List<ProjectSupport> getProjectSupports(String projectSlug) {
+	private ProjectGeneration getProjectSupports(String projectSlug) {
 		try {
-			ResponseEntity<Map<String, Object>> response = getFile(projectSlug, "support.json");
+			ResponseEntity<Map<String, Object>> response = getFile(projectSlug, "generations.json");
 			String contents = getFileContent(response);
-			return List.copyOf(readValue(contents, SUPPORT_LIST));
+			return this.objectMapper.readValue(contents, ProjectGeneration.class);
 		}
 		catch (Exception ex) {
-			logger.debug("Could not get project support for '%s' due to '%s'".formatted(projectSlug, ex.getMessage()));
+			logger
+				.debug("Could not get project generation for '%s' due to '%s'".formatted(projectSlug, ex.getMessage()));
 		}
-		return Collections.emptyList();
+		return new ProjectGeneration(Collections.emptyList());
 	}
 
 	private String getProjectSupportPolicy(ResponseEntity<Map<String, Object>> response, String projectSlug) {
@@ -255,7 +253,7 @@ private String getProjectSupportPolicy(ResponseEntity<Map<String, Object>> respo
 			return (supportPolicy != null) ? supportPolicy : DEFAULT_SUPPORT_POLICY;
 		}
 		catch (Exception ex) {
-			logger.debug("Could not get project support policy for '%s' due to '%s'".formatted(projectSlug,
+			logger.debug("Could not get project generation policy for '%s' due to '%s'".formatted(projectSlug,
 					ex.getMessage()));
 		}
 		return DEFAULT_SUPPORT_POLICY;
@@ -300,7 +298,7 @@ static ProjectFile from(String fileName) {
 			if (fileName.contains("documentation.json")) {
 				return DOCUMENTATION;
 			}
-			if (fileName.contains("support.json")) {
+			if (fileName.contains("generations.json")) {
 				return SUPPORT;
 			}
 			return OTHER;

src/main/java/io/spring/projectapi/github/ProjectData.java

@@ -26,13 +26,13 @@
  *
  * @param project all projects
  * @param documentation map of project slug to project documentations
- * @param support map of project slug to project supports
- * @param supportPolicy map of project slug to project support policy
+ * @param generation map of project slug to project generations
+ * @param supportPolicy map of project slug to project generation policy
  * @author Phillip Webb
  * @author Madhura Bhave
  */
 record ProjectData(Map<String, Project> project, Map<String, List<ProjectDocumentation>> documentation,
-		Map<String, List<ProjectSupport>> support, Map<String, String> supportPolicy) {
+		Map<String, ProjectGeneration> generation, Map<String, String> supportPolicy) {
 
 	public static ProjectData load(GithubQueries githubQueries) {
 		ProjectData data = githubQueries.getData();
@@ -48,9 +48,9 @@ public static ProjectData update(ProjectData data, List<String> changes, GithubQ
 	private static ProjectData getImmutableProjectData(ProjectData updatedData) {
 		Map<String, Project> projects = updatedData.project();
 		Map<String, List<ProjectDocumentation>> documentation = updatedData.documentation();
-		Map<String, List<ProjectSupport>> support = updatedData.support();
+		Map<String, ProjectGeneration> generation = updatedData.generation();
 		Map<String, String> supportPolicy = updatedData.supportPolicy();
-		return new ProjectData(Map.copyOf(projects), Map.copyOf(documentation), Map.copyOf(support),
+		return new ProjectData(Map.copyOf(projects), Map.copyOf(documentation), Map.copyOf(generation),
 				Map.copyOf(supportPolicy));
 	}
 

src/main/java/io/spring/projectapi/github/ProjectGeneration.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright 2022-2023 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.projectapi.github;
+
+import java.time.YearMonth;
+import java.util.ArrayList;
+import java.util.List;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonCreator.Mode;
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
+/**
+ * Java representation of the {@code project generation} type as defined in
+ * <a href= "https://github.com/spring-io/spring-website/">spring-io/spring-website</a>.
+ *
+ * @author Madhura Bhave
+ * @author Phillip Webb
+ */
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class ProjectGeneration {
+
+	private List<Generation> generations = new ArrayList<>();
+
+	@JsonCreator(mode = Mode.PROPERTIES)
+	public ProjectGeneration(List<Generation> generations) {
+		this.generations.addAll(generations);
+	}
+
+	public List<Generation> getGenerations() {
+		return this.generations;
+	}
+
+	@JsonIgnoreProperties(ignoreUnknown = true)
+	public static class Generation {
+
+		private final String generation;
+
+		@JsonFormat(pattern = "yyyy-MM")
+		private final YearMonth initialRelease;
+
+		@JsonFormat(pattern = "yyyy-MM")
+		private final YearMonth ossSupportEnd;
+
+		@JsonFormat(pattern = "yyyy-MM")
+		private final YearMonth enterpriseSupportEnd;
+
+		private final boolean lastMinor;
+
+		@JsonCreator(mode = Mode.PROPERTIES)
+		public Generation(String generation, YearMonth initialRelease, YearMonth ossSupportEnd,
+				YearMonth enterpriseSupportEnd, boolean lastMinor) {
+			this.generation = generation;
+			this.initialRelease = initialRelease;
+			this.ossSupportEnd = ossSupportEnd;
+			this.enterpriseSupportEnd = enterpriseSupportEnd;
+			this.lastMinor = lastMinor;
+		}
+
+		public String getGeneration() {
+			return this.generation;
+		}
+
+		public YearMonth getInitialRelease() {
+			return this.initialRelease;
+		}
+
+		public YearMonth getOssSupportEnd() {
+			return this.ossSupportEnd;
+		}
+
+		public YearMonth getEnterpriseSupportEnd() {
+			return this.enterpriseSupportEnd;
+		}
+
+		public boolean isLastMinor() {
+			return this.lastMinor;
+		}
+
+	}
+
+}