diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ea9dfb9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +/target/ +.settings +.classpath +.project +/.idea/ +*.iml +dependency-reduced-pom.xml +.floo* \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f49a4e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + http://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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..55b5375 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Migrational + +##### Migrational is a simple and small library which takes advantage of reflection to migrate data in objects. + +1. [Wiki](https://github.com/LemmoTresto/Migrational/wiki) +2. [Maven](https://github.com/LemmoTresto/Migrational/wiki#maven) +3. [Gradle](https://github.com/LemmoTresto/Migrational/wiki#gradle) +4. [Examples](https://github.com/LemmoTresto/Migrational/wiki#examples) +5. [Support](#support) + + + +## Support + +First make sure you've read the [Wiki](https://github.com/LemmoTresto/Migrational/wiki) and [FAQ](https://github.com/LemmoTresto/Migrational/wiki/Frequently-Asked-Questions), if you still cannot find an answer join our [Discord](https://lemmotresto.com/links/discord)! +If it is an internal issue make an issue in the tracker. \ No newline at end of file diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..10523b6 --- /dev/null +++ b/pom.xml @@ -0,0 +1,74 @@ + + + + + 4.0.0 + + me.max + migrational + 1.0.0 + + Migrational + + + + Apache License, Version 2.0 + https://www.apache.org/licenses/LICENSE-2.0.txt + repo + + + + + GitHub + https://github.com/LemmoTresto/Migrational/issues + + + + scm:git:https://github.com/LemmoTresto/Migrational.git + https://github.com/LemmoTresto/Migrational/ + + + + ${project.name}-${project.version} + + + org.apache.maven.plugins + maven-compiler-plugin + 3.5.1 + + 1.8 + 1.8 + UTF-8 + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.1.0 + + public + + + + + + \ No newline at end of file diff --git a/src/main/java/me/max/migrational/Migrator.java b/src/main/java/me/max/migrational/Migrator.java new file mode 100644 index 0000000..6ffcddd --- /dev/null +++ b/src/main/java/me/max/migrational/Migrator.java @@ -0,0 +1,214 @@ +/* + * + * * Copyright 2019 Max Berkelmans + * * + * * 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 + * * + * * http://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 me.max.migrational; + +import me.max.migrational.annotations.Exempt; +import me.max.migrational.annotations.Migratable; +import me.max.migrational.exceptions.InvalidConstructorException; + +import java.lang.reflect.Constructor; +import java.lang.reflect.Field; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Modifier; +import java.util.ArrayList; +import java.util.List; +import java.util.Map; + +/** + * This class will manage migration of one class and one data map. + * You can instantiate this class multiple times. + * This will always make a new instance of the on migration. + * + * @author Max Berkelmans + * @see Migratable + * @since 1.0.0 + */ +@SuppressWarnings("unused") +public class Migrator { + + private final Field[] migratableFields; + private Map data; + private Constructor constructor; + private Object lastMigratedObject; + + /** + * Loads the data migration with preset data and preset constructor + * + * @param clazz the class/object that contains the fields and constructor + * @param constructor the constructor of said class that should be used + * @param data the data to be used on migration + */ + public Migrator(Class clazz, Constructor constructor, Map data) { + this(clazz, constructor); + this.data = data; + } + + /** + * Loads the data migration with preset data + * + * @param clazz the class/object that contains the fields and constructor + * @param data the data to be used on migration + */ + public Migrator(Class clazz, Map data) { + this(clazz); + this.data = data; + } + + /** + * Loads the data migration with preset constructor + * + * @param clazz the class/object that contains the fields and constructor + * @param constructor the constructor of said class that should be used + */ + public Migrator(Class clazz, Constructor constructor) { + this(clazz); + setConstructor(constructor); + } + + /** + * Loads data migration + * + * @param clazz the class/object that contains the fields and constructor + */ + public Migrator(Class clazz) { + //Loop over constructors to find the one we can use + for (Constructor constructor : clazz.getDeclaredConstructors()) { + //Needs to have zero parameters + if (constructor.getParameterCount() == 0) { + if (Modifier.isPrivate(constructor.getModifiers())) constructor.setAccessible(true); + this.constructor = constructor; + break; + } + } + + //Create a list of the migratable fields. + List migratableFields = new ArrayList<>(); + //Loop over the declared fields and check if it is a field we migrate + for (Field field : clazz.getDeclaredFields()) { + if (!field.isAnnotationPresent(Migratable.class) && !clazz.isAnnotationPresent(Migratable.class)) + continue; //Needs to be our annotation + if (field.isAnnotationPresent(Exempt.class)) continue; //If the field is exempted then do not migrate. + if (Modifier.isPrivate(field.getModifiers())) field.setAccessible(true); //Allow us to access private fields + migratableFields.add(field); + } + //Change it into an array as we do not need to change the list anymore. + this.migratableFields = migratableFields.toArray(new Field[0]); + } + + + /** + * Migrate the data if necessary + * This will always create a new instance of the class + * + * @return the migrated object + * @throws IllegalAccessException see {@link Constructor#newInstance(Object...)} + * @throws InvocationTargetException see {@link Constructor#newInstance(Object...)} + * @throws InstantiationException see {@link Constructor#newInstance(Object...)} + * @throws InvalidConstructorException if the constructor is null this will be thrown. + */ + public Object migrate() throws IllegalAccessException, InvocationTargetException, InstantiationException { + //Check if the constructor is null due to not being found on instantiation + if (constructor == null) + throw new InvalidConstructorException("Constructor provided was null, no matching constructor was found on instantiation make sure to set one.", constructor); + + //Create a new instance of the object + lastMigratedObject = constructor.newInstance(); + + //Loop over known migratable fields. + for (Field field : migratableFields) { + Migratable migratable = field.isAnnotationPresent(Migratable.class) ? field.getAnnotation(Migratable.class) : field.getDeclaringClass().getAnnotation(Migratable.class); //Get the annotation + //Get the correct key if no key is given in the annotation use field name. + String key = (migratable.key().isEmpty()) ? field.getName() : migratable.key(); + //Check if the data contains this field + if (data.containsKey(key)) { + //It does so lets set the data + field.set(lastMigratedObject, data.get(key)); + continue; + } + //It does not, so let's set the default value + field.set(lastMigratedObject, migratable.defaultValue().isEmpty() ? field.get(lastMigratedObject) : migratable.defaultValue()); + } + return lastMigratedObject; + } + + /** + * This will return the last migrated object. + * This can be null if the data was not migrated yet. + * + * @return the last migrated object still in memory + */ + public Object getLastMigratedObject() { + return lastMigratedObject; + } + + /** + * Returns the constructor being used + * + * @return the constructor being used + */ + public Constructor getConstructor() { + return constructor; + } + + /** + * Set the constructor to be used to migrate. + * + * @param constructor the constructor to use + * @throws InvalidConstructorException if the constructor is null or has parameters or is not of the correct class + */ + public void setConstructor(Constructor constructor) throws InvalidConstructorException { + if (constructor == null) throw new InvalidConstructorException("Constructor provided was null", constructor); + if (!constructor.getDeclaringClass().equals(migratableFields[0].getDeclaringClass())) + throw new InvalidConstructorException("The provided constructor was not from the correct class", constructor); + if (constructor.getParameterCount() != 0) + throw new InvalidConstructorException("The provided constructor has parameters!", constructor); + this.constructor = constructor; + } + + /** + * Get the data which will be migrated + * + * @return the data to migrate + */ + public Map getData() { + return data; + } + + /** + * Set the data to be migrated + * + * @param data the data to migrate + */ + public void setData(Map data) { + this.data = data; + } + + /** + * The array of fields that will be migrated + * This array was made on instantiation and cannot be changed + * This array will only contain fields which + * have been annotated with {@link Migratable} + * or which's class has been annotated with {@link Migratable} and not exempted using {@link Exempt} + * + * @return the array with the migratable fields + */ + public Field[] getMigratableFields() { + return migratableFields; + } +} diff --git a/src/main/java/me/max/migrational/annotations/Exempt.java b/src/main/java/me/max/migrational/annotations/Exempt.java new file mode 100644 index 0000000..2667810 --- /dev/null +++ b/src/main/java/me/max/migrational/annotations/Exempt.java @@ -0,0 +1,37 @@ +/* + * + * * Copyright 2019 Max Berkelmans + * * + * * 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 + * * + * * http://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 me.max.migrational.annotations; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marks a {@link java.lang.reflect.Field} exempted from the {@link me.max.migrational.annotations.Migratable} annotation. + * This means this data is not able to be migrated. + * + * @author Max Berkelmans + * @since 1.0.0 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface Exempt { + +} diff --git a/src/main/java/me/max/migrational/annotations/Migratable.java b/src/main/java/me/max/migrational/annotations/Migratable.java new file mode 100644 index 0000000..6250190 --- /dev/null +++ b/src/main/java/me/max/migrational/annotations/Migratable.java @@ -0,0 +1,55 @@ +/* + * + * * Copyright 2019 Max Berkelmans + * * + * * 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 + * * + * * http://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 me.max.migrational.annotations; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marks a {@link java.lang.reflect.Field} migratable. + * OR Marks all {@link java.lang.reflect.Field} in a {@link Class} migratable. + * Unless a field is marked with {@link Exempt}. + * key will default to the field name and defaultValue will be the already initialised value. + * This means this data is able to be migrated. + * + * @author Max Berkelmans + * @since 1.0.0 + */ +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.FIELD, ElementType.TYPE}) +public @interface Migratable { + + /** + * The key of this field in the data + * + * @return the key of this field if none specified will default to field name. + */ + String key() default ""; + + /** + * The default value if none is found in the data + * + * @return default value of field + */ + String defaultValue() default ""; + + +} diff --git a/src/main/java/me/max/migrational/exceptions/InvalidConstructorException.java b/src/main/java/me/max/migrational/exceptions/InvalidConstructorException.java new file mode 100644 index 0000000..262a97f --- /dev/null +++ b/src/main/java/me/max/migrational/exceptions/InvalidConstructorException.java @@ -0,0 +1,65 @@ +/* + * + * * Copyright 2019 Max Berkelmans + * * + * * 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 + * * + * * http://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 me.max.migrational.exceptions; + +import java.lang.reflect.Constructor; + +/** + * The exception to be thrown when the provided constructor is invalid + * Cases of this happening is when the constructor was not found during instantiation + * Calling {@link me.max.migrational.Migrator#migrate()} will then throw this exception + * Another case is if the provided constructor in {@link me.max.migrational.Migrator#setConstructor(java.lang.reflect.Constructor)} has parameters + * If this constructor is not of class which was passed on in instantiation it will also throw this exception. + * + * @author Max Berkelmans + * @since 1.0.0 + */ +public class InvalidConstructorException extends RuntimeException { + + private String reason; + private Constructor constructor; + + /** + * @param reason the reason why the constructor was invalid + * @param constructor the constructor used + */ + public InvalidConstructorException(String reason, Constructor constructor) { + this.reason = reason; + this.constructor = constructor; + } + + /** + * This returns the reason why the constructor is invalid + * + * @return the string reason + */ + public String getReason() { + return reason; + } + + /** + * This returns the constructor that was tried to be used + * If the reason was because of the constructor being null this will return null. + * + * @return the constructor which was tried to be used + */ + public Constructor getConstructor() { + return constructor; + } +} diff --git a/src/main/java/me/max/migrational/package-info.java b/src/main/java/me/max/migrational/package-info.java new file mode 100644 index 0000000..d5825e8 --- /dev/null +++ b/src/main/java/me/max/migrational/package-info.java @@ -0,0 +1,27 @@ +/* + * + * * Copyright 2019 Max Berkelmans + * * + * * 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 + * * + * * http://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. + * + */ + +/** + * This is the root package of the Migrational libary + * {@link me.max.migrational.annotations} for all annotations + * {@link me.max.migrational.Migrator} should be instantiated to use this library + * + * @author Max Berkelmans + * @since 1.0.0 + */ +package me.max.migrational; \ No newline at end of file