org.kuali.common.util.ProjectUtils Maven / Gradle / Ivy
/**
* Copyright 2010-2014 The Kuali Foundation
*
* Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
*
* 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 org.kuali.common.util;
import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import org.apache.commons.lang3.StringUtils;
import org.kuali.common.util.property.Constants;
import org.kuali.common.util.property.PropertiesContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.PropertyPlaceholderHelper;
/**
*
*/
@Deprecated
public class ProjectUtils {
private static final Logger logger = LoggerFactory.getLogger(ProjectUtils.class);
private static final PropertyPlaceholderHelper PPH = Constants.DEFAULT_PROPERTY_PLACEHOLDER_HELPER;
private static final String CLASSPATH = "classpath:";
@Deprecated
public static final String KUALI_COMMON_GROUP_ID = KualiProjectConstants.COMMON_GROUP_ID;
@Deprecated
public static final String KUALI_UTIL_ARTIFACT_ID = UtilProjectContext.ARTIFACT_ID;
private static final Map PROJECT_PROPERTIES_CACHE = new HashMap();
public static List loadProjects(List projectIds) {
List projects = new ArrayList();
for (String projectId : projectIds) {
Project project = ProjectUtils.loadProject(projectId);
projects.add(project);
}
return projects;
}
/**
*
* kuali-util = classpath:org/kuali/common/kuali-util
*
*/
public static String getCommonClassPathPrefix(String artifactId) {
return getClassPathPrefix(KualiProjectConstants.COMMON_GROUP_ID, artifactId);
}
/**
* Given a groupId and artifactId, convert the groupId to groupId.base, then return the classpath prefix
*
*
* org.kuali.student.db:ks-impex-rice-db = classpath:org/kuali/student/ks-impex-rice-db
* org.kuali.common:kuali-util = classpath:org/kuali/common/kuali-util
*
*/
public static String getClassPathPrefix(String groupId, String artifactId) {
Project project = loadProject(groupId, artifactId);
return CLASSPATH + getResourcePath(project);
}
/**
* Given groupId:artifactId, convert the groupId to groupId.base, then return the classpath prefix
*
*
* org.kuali.student.db:ks-impex-rice-db = classpath:org/kuali/student/ks-impex-rice-db
* org.kuali.common:kuali-util = classpath:org/kuali/common/kuali-util
*
*
* Use getClassPathPrefixFromProjectId() instead
*/
@Deprecated
public static String getClassPathPrefixFromGAV(String projectId) {
Project project = getProject(projectId);
return getClassPathPrefix(project);
}
/**
* Given groupId:artifactId, convert the groupId to groupId.base, then return the classpath prefix
*
*
* org.kuali.student.db:ks-impex-rice-db = classpath:org/kuali/student/ks-impex-rice-db
* org.kuali.common:kuali-util = classpath:org/kuali/common/kuali-util
*
*/
public static String getClassPathPrefixFromProjectId(String projectId) {
Project project = getProject(projectId);
return getClassPathPrefix(project);
}
/**
* Given a project containing groupId + artifactId, convert the groupId to groupId.base, then return the classpath prefix
*
*
* org.kuali.student.db:ks-impex-rice-db = classpath:org/kuali/student/ks-impex-rice-db
* org.kuali.common:kuali-util = classpath:org/kuali/common/kuali-util
*
*/
public static String getClassPathPrefix(Project project) {
return getClassPathPrefix(project.getGroupId(), project.getArtifactId());
}
/**
* Given a groupId and artifactId, convert the groupId to groupId.base, then return a resource path relative to directory
*
*
* org.kuali.student.db:ks-impex-rice-db = org/kuali/student/ks-impex-rice-db
* org.kuali.common:kuali-util = org/kuali/common/kuali-util
*
* /tmp/x/y/z + org.kuali.common:kuali-util = /tmp/x/y/z/org/kuali/common/kuali-util
*
*/
public static File getResourceDirectory(File directory, Project project) {
String resourcePath = getResourcePath(project);
File file = new File(directory, resourcePath);
return new File(LocationUtils.getCanonicalPath(file));
}
/**
* Given a groupId and artifactId, convert the groupId to groupId.base, then return a handle to a file relative to directory with the given filename
*
*
* org.kuali.student.db:ks-impex-rice-db = org/kuali/student/ks-impex-rice-db
* org.kuali.common:kuali-util = org/kuali/common/kuali-util
*
* /tmp/x/y/z + org.kuali.common:kuali-util + foo.txt = /tmp/x/y/z/org/kuali/common/kuali-util/foo.txt
*
*/
public static File getResourceFile(File directory, Project project, String filename) {
File dir = getResourceDirectory(directory, project);
return new File(dir, filename);
}
/**
* Given groupId:artifactId, convert the groupId to groupId.base, then return a resource friendly prefix
*
*
* org.kuali.student.db:ks-impex-rice-db = org/kuali/student/ks-impex-rice-db
* org.kuali.common:kuali-util = org/kuali/common/kuali-util
*
*/
public static String getResourcePath(Project project) {
Properties properties = project.getProperties();
String groupIdPath = properties.getProperty(Constants.GROUP_ID_PATH_KEY);
Assert.hasText(groupIdPath, "groupIdPath has no text");
String artifactId = project.getArtifactId();
return groupIdPath + "/" + artifactId;
}
/**
*
*/
@Deprecated
public static org.kuali.common.util.property.ProjectProperties getProjectProperties(ProjectContext context) {
// Get a project object based on the context information
Project project = loadProject(context);
// Create a properties context object from the project.properties file from META-INF
PropertiesContext propertiesContext = new PropertiesContext(project.getProperties());
propertiesContext.setEncoding(project.getEncoding());
propertiesContext.setLocations(context.getPropertyLocations());
// Return a project properties object
return new org.kuali.common.util.property.ProjectProperties(project, propertiesContext);
}
/**
* Create a Project object from the context. This includes loading the corresponding project.properties file from disk.
*/
@Deprecated
public static Project loadProject(ProjectContext context) {
return loadProject(getGav(context));
}
@Deprecated
public static String getGav(ProjectContext context) {
return getGav(context.getGroupId(), context.getArtifactId());
}
@Deprecated
public static String getGav(Project project) {
return getGav(project.getGroupId(), project.getArtifactId());
}
@Deprecated
public static String getGav(String groupId, String artifactId) {
return groupId + ":" + artifactId;
}
public static String getProjectId(Project project) {
return getProjectId(project.getGroupId(), project.getArtifactId());
}
public static String getProjectId(String groupId, String artifactId) {
return groupId + ":" + artifactId;
}
/**
* Create a Project object from groupId, artifactId pair. This includes loading the corresponding project.properties file
* from disk.
*/
public static Project loadProject(String groupId, String artifactId) {
String projectId = getProjectId(groupId, artifactId);
return loadProject(projectId);
}
/**
* Create a Project object from the projectId. This includes loading the corresponding project.properties file from disk.
*/
public static Project loadProject(String projectId) {
// Convert the projectId into a Project
Project project = getProject(projectId);
// Load properties from a .properties file for this project
Properties properties = loadProperties(project);
// Return a fully configured project object based on the properties
Project loadedProject = getProject(properties);
// return the project we loaded
return loadedProject;
}
/**
* Provide a way to clear the cache
*/
public synchronized static void clearCache() {
PROJECT_PROPERTIES_CACHE.clear();
}
/**
* Create a skeleton Project object from the gav. Nothing but the GAV info (groupId:artifactId:packaging:version:classifier) gets filled in. Does not
* read project.properties from disk.
*/
public static Project getProject(String gav) {
logger.debug("Processing [{}]", gav);
String[] tokens = StringUtils.split(gav, ":");
Project project = new Project();
if (tokens.length > 0) {
project.setGroupId(RepositoryUtils.toNull(tokens[0]));
}
if (tokens.length > 1) {
project.setArtifactId(RepositoryUtils.toNull(tokens[1]));
}
if (tokens.length > 2) {
project.setPackaging(RepositoryUtils.toNull(tokens[2]));
}
if (tokens.length > 3) {
project.setVersion(RepositoryUtils.toNull(tokens[3]));
}
if (tokens.length > 4) {
project.setClassifier(RepositoryUtils.toNull(tokens[4]));
}
return project;
}
public static List getDependencies(String csv) {
List tokens = CollectionUtils.getTrimmedListFromCSV(csv);
List dependencies = new ArrayList();
for (String token : tokens) {
Dependency dependency = RepositoryUtils.parseDependency(token);
dependencies.add(dependency);
}
return dependencies;
}
/**
* Return a Project object by copying values from the properties object into a Project object.
*/
public static Project getProject(Properties properties) {
List skipKeys = Arrays.asList("project.dependencies");
String startsWith = "project.";
List keys = PropertyUtils.getStartsWithKeys(properties, startsWith);
Project project = new Project();
project.setProperties(properties);
Map description = ReflectionUtils.describe(project);
Set beanProperties = description.keySet();
for (String key : keys) {
if (skipKeys.contains(key)) {
continue;
}
String value = properties.getProperty(key);
String beanProperty = getBeanProperty(key, startsWith);
if (beanProperties.contains(beanProperty)) {
ReflectionUtils.copyProperty(project, beanProperty, value);
}
}
String csv = RepositoryUtils.toNull(properties.getProperty("project.dependencies"));
List dependencies = getDependencies(csv);
project.setDependencies(dependencies);
return project;
}
protected static String getBeanProperty(String key, String startsWith) {
String s = StringUtils.substring(key, startsWith.length());
String[] tokens = StringUtils.split(s, ".");
StringBuilder sb = new StringBuilder();
for (int i = 0; i < tokens.length; i++) {
String token = tokens[i];
if (i == 0) {
sb.append(token);
} else {
sb.append(StringUtils.capitalize(token));
}
}
return sb.toString();
}
public static Properties loadProperties(String gav) {
return loadProperties(getProject(gav));
}
/**
* Use the groupId and artifactId from this project to load the corresponding project.properties file and cache it in our internal Map
*/
public static synchronized Properties loadProperties(Project project) {
String projectId = getProjectId(project.getGroupId(), project.getArtifactId());
Properties properties = PROJECT_PROPERTIES_CACHE.get(projectId);
if (properties == null) {
properties = loadAndCache(project, projectId);
}
return properties;
}
protected static Properties loadAndCache(Project project, String projectId) {
String location = getPropertiesFileLocation(project);
// If it doesn't exist, we've got issues
Assert.exists(location);
Properties properties = PropertyUtils.load(location);
PROJECT_PROPERTIES_CACHE.put(projectId, properties);
return properties;
}
public static String getPropertiesFileLocation(Project project) {
Assert.hasText(project.getGroupId(), "groupId has no text");
Assert.hasText(project.getArtifactId(), "artifactId has no text");
Properties properties = new Properties();
properties.setProperty(Constants.GROUP_ID_PATH_KEY, Str.getPath(project.getGroupId()));
properties.setProperty(Constants.ARTIFACT_ID_KEY, project.getArtifactId());
return PPH.replacePlaceholders(Constants.PROJECT_PROPERTIES_LOCATION, properties);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy