Merge pull request #648 from GuusLieben/release-candidate-22.1

Release candidate 22.1

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,25 @@
+name: 'Bug report'
+description: 'If you found a bug, please report it here.'
+labels: ['type: bug']
+body:
+  - type: input
+    id: version
+    attributes:
+      label: 'Version'
+      description: 'What is the earliest version the issue applies to? E.g. 4.0.0. If the issue applies to a snapshot or release candidate, please use the version number of the release candidate or snapshot.'
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: 'Problem/Opportunity'
+      description: 'Describe the problem you are trying to solve.'
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: 'Proposed solution'
+      description: 'Specify how you would like the solution to be developed. If you have a specific plan, please describe it here.'
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,18 @@
+name: 'Feature request'
+description: 'If you want to add a feature to the project, please create an issue here.'
+labels: ['type: feature request']
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: 'Related problem'
+      description: 'Is your feature related to a problem? If so, please describe the problem.'
+    validations:
+      required: false
+  - type: textarea
+    id: solution
+    attributes:
+      label: 'Requested feature'
+      description: 'Describe the feature you want to add. Be as detailed as possible.'
+    validations:
+      required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+# Description
+Please include a description of the changes made in this pull request, including any relevant motivation for these changes.
+
+Fixes # (issue number)
+
+## Type of change
+Please delete options that are not relevant.
+- [ ] Bug fix (non-breaking change that doesn't affect the behavior of the code)
+- [ ] New feature (non-breaking change that does affect the code)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation (documentation changes)
+- [ ] Style (style changes)
+- [ ] Refactor (code changes that do not affect the behavior of the code)
+- [ ] Test (changes to tests)
+- [ ] Chore (changes to the build process or auxiliary tools)
+- [ ] WIP (work-in-progress, not ready for production, or part of future work)
+- [ ] Other (anything else)
+
+# How Has This Been Tested?
+Please describe how the changes in this pull request have been tested.
+- [ ] Unit testing
+- [ ] Integration testing
+- [ ] End-to-end testing
+- [ ] Manual testing
+- [ ] Other (please specify)
+
+**Test Configuration**:
+If applicable, please provide instructions on how to run tests. Unit tests do not need to be specified here. 
+
+# Checklist:
+- [ ] I have performed a self-review of my own code
+- [ ] I have added tests that prove it is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Related issue number is linked in pull request title

.github/workflows/hartshorn.yml

@@ -6,19 +6,6 @@ name: Hartshorn
 on: [pull_request]
 
 jobs:
-  javadoc:
-    name: Verify Javadocs
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up JDK 16
-        uses: actions/setup-java@v1
-        with:
-          java-version: 16
-      - name: Grant execute permission for gradlew
-        run: chmod +x gradlew
-      - name: Verify Javadocs
-        run: ./gradlew aggregateJavadoc
   build:
     name: Build all
     runs-on: ubuntu-latest

README.md

@@ -1,5 +1,4 @@
-# <img alt="Hartshorn" src="./hartshorn-assembly/images/logo.png" height="100" /> Hartshorn <img src="https://github.com/GuusLieben/Hartshorn/actions/workflows/hartshorn.yml/badge.svg"> <a href="https://deepsource.io/gh/GuusLieben/Hartshorn/?ref=repository-badge" target="_blank"><img alt="DeepSource" title="DeepSource" src="https://deepsource.io/gh/GuusLieben/Hartshorn.svg/?label=active+issues"/></a>
-
+# <img alt="Hartshorn" src="./hartshorn-assembly/images/logo.png" height="100" /> Hartshorn <img src="https://github.com/GuusLieben/Hartshorn/actions/workflows/hartshorn.yml/badge.svg">
 Hartshorn is a platform agnostic plugin/extension framework providing advanced utilities to develop against a variety of platforms.
 
 ## Maven configuration

build.gradle

@@ -21,15 +21,15 @@ buildscript {
     }
     dependencies {
         classpath "io.franzbecker:gradle-lombok:$gradleLombokVersion"
-        classpath 'org.owasp:dependency-check-gradle:6.2.2'
+        classpath "org.owasp:dependency-check-gradle:$owaspDependencyCheckVersion"
     }
 }
 
 plugins {
     id 'java'
     id 'java-library'
     id 'org.cadixdev.licenser' version "$licenserVersion"
-    id 'io.freefair.aggregate-javadoc' version "$aggregateJavadocVersion"
+    id 'org.checkerframework' version "$checkerFrameworkVersion"
 }
 
 apply plugin: 'org.owasp.dependencycheck'
@@ -54,9 +54,9 @@ subprojects { final Project subProject ->
     apply plugin: 'java-library'
     apply plugin: 'maven-publish'
     apply plugin: 'java-test-fixtures'
+    apply plugin: 'org.checkerframework'
     apply plugin: 'org.cadixdev.licenser'
 
-
     license {
         header = rootProject.file("HEADER.txt")
         ignoreFailures = true
@@ -75,8 +75,6 @@ subprojects { final Project subProject ->
         dependsOn tasks.updateLicenses
         finalizedBy tasks.clean
     }
-
-    apply from: "$project.rootDir/gradle/publications.gradle"
 }
 
 allprojects {
@@ -128,7 +126,6 @@ allprojects {
         dependencies {
             implementation "org.slf4j:slf4j-api:$slf4jVersion"
             implementation "org.projectlombok:lombok:$lombokVersion"
-            implementation("org.jetbrains:annotations:$jetbrainsAnnotationsVersion")
             implementation "javax.persistence:javax.persistence-api:$javaxPersistenceVersion"
 
             annotationProcessor "org.projectlombok:lombok:$lombokVersion"
@@ -137,12 +134,10 @@ allprojects {
             testImplementation testFixtures(project(":hartshorn-core"))
             testImplementation "org.mockito:mockito-inline:$mockitoVersion"
             testImplementation "org.hamcrest:java-hamcrest:$hamcrestVersion"
-            testImplementation "org.apache.logging.log4j:log4j-api:$log4jVersion"
-            testImplementation "org.apache.logging.log4j:log4j-core:$log4jVersion"
+            testImplementation "ch.qos.logback:logback-classic:$logbackVersion"
             testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
             testImplementation "org.junit.jupiter:junit-jupiter-params:$junitVersion"
             testImplementation "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
-            testImplementation "org.apache.logging.log4j:log4j-slf4j-impl:$log4jVersion"
         }
 
         task copyArtifacts {
@@ -161,4 +156,4 @@ allprojects {
         }
         build.finalizedBy copyArtifacts
     }
-}
+}

examples/examples.gradle

@@ -48,10 +48,6 @@ dependencies {
     implementation "com.fasterxml.jackson.dataformat:jackson-dataformat-toml:$jacksonVersion"
     implementation "com.fasterxml.jackson.dataformat:jackson-dataformat-xml:$jacksonVersion"
 
-    implementation "org.apache.logging.log4j:log4j-api:$log4jVersion"
-    implementation "org.apache.logging.log4j:log4j-core:$log4jVersion"
-    implementation "org.apache.logging.log4j:log4j-slf4j-impl:$log4jVersion"
-
     annotationProcessor "org.projectlombok:lombok:$lombokVersion"
 
     // Only required because this is affected by the global build file, in a real world application you'd use

examples/src/caching/java/org/dockbox/hartshorn/demo/caching/CachingDemoApplication.java

@@ -17,15 +17,17 @@
 
 package org.dockbox.hartshorn.demo.caching;
 
+import org.dockbox.hartshorn.core.annotations.activate.ServiceActivator;
 import org.dockbox.hartshorn.core.boot.HartshornApplication;
 import org.dockbox.hartshorn.cache.annotations.UseCaching;
 import org.dockbox.hartshorn.core.annotations.activate.Activator;
+import org.dockbox.hartshorn.core.services.ServicePreProcessor;
 import org.dockbox.hartshorn.events.annotations.UseEvents;
 
 
 /**
- * A simple application starter, with specific {@link org.dockbox.hartshorn.core.annotations.service.ServiceActivator service activators}
- * configured to enable only the required {@link org.dockbox.hartshorn.core.services.ServiceProcessor service processors}.
+ * A simple application starter, with specific {@link ServiceActivator service activators}
+ * configured to enable only the required {@link ServicePreProcessor service processors}.
  * <p>For readability, each activator has been documented with a short description below.
  */
 @UseEvents /* Activates the EventServiceProcessor, enabling event listening */
@@ -37,7 +39,9 @@
  * and use your own implementation here directly
  */
 @Activator
-public class CachingDemoApplication {
+public final class CachingDemoApplication {
+
+    private CachingDemoApplication() {}
 
     public static void main(final String[] args) {
         HartshornApplication.create(CachingDemoApplication.class, args);

examples/src/caching/java/org/dockbox/hartshorn/demo/caching/domain/User.java

@@ -17,23 +17,16 @@
 
 package org.dockbox.hartshorn.demo.caching.domain;
 
-import org.dockbox.hartshorn.core.keys.KeyHolder;
-import org.dockbox.hartshorn.core.context.ApplicationContext;
-
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 
 /**
- * A simple bean type which can carry {@link org.dockbox.hartshorn.core.keys.Key keys}, as it implements
- * {@link KeyHolder}. {@link org.dockbox.hartshorn.core.keys.Key Keys} are not persistent, and depend on
- * a managed data store.
+ * A simple bean type which represents a basic user with a name and age.
  */
 @Getter
 @AllArgsConstructor
-public class User implements KeyHolder<User> {
+public class User {
 
-    // For the KeyHolder
-    private final ApplicationContext applicationContext;
     private final String name;
     private final int age;
 }