-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add project description diff (gh-1005)
- Loading branch information
1 parent
99b0a4b
commit c933acd
Showing
16 changed files
with
797 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
...ava/io/spring/initializr/generator/project/diff/DefaultProjectDescriptionDiffFactory.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /* | ||
| * Copyright 2012-2019 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.initializr.generator.project.diff; | ||
|
|
||
| import io.spring.initializr.generator.project.ProjectDescription; | ||
|
|
||
| /** | ||
| * A default {@link ProjectDescriptionDiffFactory} implementation that creates default | ||
| * {@link ProjectDescriptionDiff} instances. | ||
| * | ||
| * @author Chris Bono | ||
| */ | ||
| public class DefaultProjectDescriptionDiffFactory implements ProjectDescriptionDiffFactory<ProjectDescription> { | ||
|
|
||
| @Override | ||
| public ProjectDescriptionDiff create(final ProjectDescription description) { | ||
| return new ProjectDescriptionDiff(description); | ||
| } | ||
|
|
||
| } |
160 changes: 160 additions & 0 deletions
160
...tor/src/main/java/io/spring/initializr/generator/project/diff/ProjectDescriptionDiff.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,160 @@ | ||
| /* | ||
| * Copyright 2012-2019 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.initializr.generator.project.diff; | ||
|
|
||
| import java.lang.reflect.Field; | ||
| import java.util.Objects; | ||
| import java.util.function.BiConsumer; | ||
|
|
||
| import io.spring.initializr.generator.buildsystem.BuildSystem; | ||
| import io.spring.initializr.generator.language.Language; | ||
| import io.spring.initializr.generator.packaging.Packaging; | ||
| import io.spring.initializr.generator.project.ProjectDescription; | ||
| import io.spring.initializr.generator.version.Version; | ||
|
|
||
| import org.springframework.util.ReflectionUtils; | ||
|
|
||
| /** | ||
| * Provides a convenient API for determining if certain fields on a | ||
| * {@link ProjectDescription} were modified. | ||
| * | ||
| * @author Chris Bono | ||
| */ | ||
| public class ProjectDescriptionDiff { | ||
|
|
||
| private final ProjectDescription original; | ||
|
|
||
| /** | ||
| * Construct a {@link ProjectDescriptionDiff} that creates and uses a copy of the | ||
| * specified description as its source. | ||
| * @param original the description to copy as the source | ||
| */ | ||
| public ProjectDescriptionDiff(final ProjectDescription original) { | ||
| this.original = original.createCopy(); | ||
| } | ||
|
|
||
| /** | ||
| * Gets the copy of the originally specified description that is being tracked. | ||
| * @return copy of the originally specified description | ||
| */ | ||
| public ProjectDescription getOriginal() { | ||
| return this.original; | ||
| } | ||
|
|
||
| /** | ||
| * Optionally calls the specified consumer if the {@code platformVersion} is different | ||
| * on the original source description and the specified current description. | ||
| * @param current the description to test against | ||
| * @param consumer to call if the property has changed | ||
| */ | ||
| public void ifPlatformVersionChanged(final ProjectDescription current, | ||
| final BiConsumer<Version, Version> consumer) { | ||
| if (!Objects.equals(this.original.getPlatformVersion(), current.getPlatformVersion())) { | ||
| consumer.accept(this.original.getPlatformVersion(), current.getPlatformVersion()); | ||
| } | ||
| } | ||
|
|
||
| // TODO remaining method javadocs | ||
|
|
||
| public void ifBuildSystemChanged(final ProjectDescription current, | ||
| final BiConsumer<BuildSystem, BuildSystem> consumer) { | ||
| if (!Objects.equals(this.original.getBuildSystem(), current.getBuildSystem())) { | ||
| consumer.accept(this.original.getBuildSystem(), current.getBuildSystem()); | ||
| } | ||
| } | ||
|
|
||
| public void ifPackagingChanged(final ProjectDescription current, final BiConsumer<Packaging, Packaging> consumer) { | ||
| if (!Objects.equals(this.original.getPackaging(), current.getPackaging())) { | ||
| consumer.accept(this.original.getPackaging(), current.getPackaging()); | ||
| } | ||
| } | ||
|
|
||
| public void ifLanguageChanged(final ProjectDescription current, final BiConsumer<Language, Language> consumer) { | ||
| if (!Objects.equals(this.original.getLanguage(), current.getLanguage())) { | ||
| consumer.accept(this.original.getLanguage(), current.getLanguage()); | ||
| } | ||
| } | ||
|
|
||
| public void ifGroupIdChanged(final ProjectDescription current, final BiConsumer<String, String> consumer) { | ||
| if (!Objects.equals(this.original.getGroupId(), current.getGroupId())) { | ||
| consumer.accept(this.original.getGroupId(), current.getGroupId()); | ||
| } | ||
| } | ||
|
|
||
| public void ifArtifactIdChanged(final ProjectDescription current, final BiConsumer<String, String> consumer) { | ||
| if (!Objects.equals(this.original.getArtifactId(), current.getArtifactId())) { | ||
| consumer.accept(this.original.getArtifactId(), current.getArtifactId()); | ||
| } | ||
| } | ||
|
|
||
| public void ifVersionChanged(final ProjectDescription current, final BiConsumer<String, String> consumer) { | ||
| if (!Objects.equals(this.original.getVersion(), current.getVersion())) { | ||
| consumer.accept(this.original.getVersion(), current.getVersion()); | ||
| } | ||
| } | ||
|
|
||
| public void ifNameChanged(final ProjectDescription current, final BiConsumer<String, String> consumer) { | ||
| if (!Objects.equals(this.original.getName(), current.getName())) { | ||
| consumer.accept(this.original.getName(), current.getName()); | ||
| } | ||
| } | ||
|
|
||
| public void ifDescriptionChanged(final ProjectDescription current, final BiConsumer<String, String> consumer) { | ||
| if (!Objects.equals(this.original.getDescription(), current.getDescription())) { | ||
| consumer.accept(this.original.getDescription(), current.getDescription()); | ||
| } | ||
| } | ||
|
|
||
| public void ifApplicationNameChanged(final ProjectDescription current, final BiConsumer<String, String> consumer) { | ||
| if (!Objects.equals(this.original.getApplicationName(), current.getApplicationName())) { | ||
| consumer.accept(this.original.getApplicationName(), current.getApplicationName()); | ||
| } | ||
| } | ||
|
|
||
| public void ifPackageNameChanged(final ProjectDescription current, final BiConsumer<String, String> consumer) { | ||
| if (!Objects.equals(this.original.getPackageName(), current.getPackageName())) { | ||
| consumer.accept(this.original.getPackageName(), current.getPackageName()); | ||
| } | ||
| } | ||
|
|
||
| public void ifBaseDirectoryChanged(final ProjectDescription current, final BiConsumer<String, String> consumer) { | ||
| if (!Objects.equals(this.original.getBaseDirectory(), current.getBaseDirectory())) { | ||
| consumer.accept(this.original.getBaseDirectory(), current.getBaseDirectory()); | ||
| } | ||
| } | ||
|
|
||
| public <V> void ifPropertyChanged(final ProjectDescription current, final String property, | ||
| final Class<V> propertyClass, final BiConsumer<V, V> consumer) { | ||
| final V originalValue = getPropertyValueReflectively(this.original, property); | ||
| final V currentValue = getPropertyValueReflectively(current, property); | ||
| if (!Objects.equals(originalValue, currentValue)) { | ||
| consumer.accept(originalValue, currentValue); | ||
| } | ||
| } | ||
|
|
||
| private <V> V getPropertyValueReflectively(final ProjectDescription description, final String property) { | ||
| final Class descriptionClass = description.getClass(); | ||
| final Field field = ReflectionUtils.findField(descriptionClass, property); | ||
| if (field == null) { | ||
| throw new IllegalArgumentException( | ||
| String.format("No property named '%s' in '%s'.", property, descriptionClass.getSimpleName())); | ||
| } | ||
| ReflectionUtils.makeAccessible(field); | ||
| return (V) ReflectionUtils.getField(field, description); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.