Code Analysis Completed

ClaudioConsolmagno · May 1, 2021 · b5c6af8 · b5c6af8
1 parent 570cc41
commit b5c6af8
Show file tree

Hide file tree

Showing 16 changed files with 74 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+[![Maven Central](https://img.shields.io/maven-central/v/dev.claudio/spring-data-jpa-temporal.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22dev.claudio%22%20AND%20a:%22spring-data-jpa-temporal%22)
+
 # Spring Data JPA Temporal Audit
 
 Spring Data JPA Temporal Audit is an extension of [spring-data-jpa](https://github.com/spring-projects/spring-data-jpa) that makes it simple to keep an audit of your data in the same table as your main data itself.
@@ -86,8 +88,6 @@ The following 2 functionalities aren't currently supported with this library. An
 
 # Next Steps
 
-- [ ] Publish to Maven
-- [ ] Add checkstyle/spotbugs, static code analysis
 - [ ] Extra unit tests on:
   - [ ] Annotated fields and methods (i.e. entity doesn't extend `Temporal.java`)
   - [ ] Fields without getters and setters

diff --git a/code-inspection.gradle b/code-inspection.gradle
@@ -3,6 +3,7 @@
 
 spotbugs {
 	effort = 'max'
+	reportLevel = "low"
 }
 spotbugsMain {
 	reports {
@@ -15,20 +16,20 @@ spotbugsTest.enabled = false
 ///////////////////////// PMD /////////////////////////
 
 pmdMain {
+	ruleSetFiles = files('/src/test/resources/pmd.xml')
+	ruleSets = []
 	reports {
 		xml.enabled = false
 		html.enabled = true
 	}
-	enabled = false // TODO REMOVE
 }
 pmdTest.enabled = false
 
 ///////////////////////// Checkstyle /////////////////////////
 
-// https://gist.github.com/kevinmmarlow/4501f9ad231a9c9495f9
 checkstyle {
 	// from: https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/sun_checks.xml
-	configFile file("${project.rootDir}/src/test/resources/sun_checks.xml") // Checkstyle config location
+	configFile file("${project.rootDir}/src/test/resources/checkstyle.xml") // Checkstyle config location
 
 }
 checkstyleMain {
@@ -37,6 +38,5 @@ checkstyleMain {
 		xml.enabled = false
 		html.enabled = true
 	}
-	enabled = false // TODO REMOVE
 }
 checkstyleTest.enabled = false
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.0-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/src/main/java/dev/claudio/jpatemporal/annotation/package-info.java b/src/main/java/dev/claudio/jpatemporal/annotation/package-info.java
@@ -0,0 +1 @@
+package dev.claudio.jpatemporal.annotation;
diff --git a/src/main/java/dev/claudio/jpatemporal/domain/Temporal.java b/src/main/java/dev/claudio/jpatemporal/domain/Temporal.java
@@ -25,8 +25,13 @@
 @Setter
 @ToString
 @MappedSuperclass
+@SuppressWarnings("checkstyle:MemberName")
 public abstract class Temporal {
 
+    protected Temporal() {
+        // This constructor is intentionally empty. Nothing special is needed here.
+    }
+
     @Id
     @TemporalId
     @GeneratedValue(strategy = GenerationType.IDENTITY)

diff --git a/src/main/java/dev/claudio/jpatemporal/domain/package-info.java b/src/main/java/dev/claudio/jpatemporal/domain/package-info.java
@@ -0,0 +1 @@
+package dev.claudio.jpatemporal.domain;
diff --git a/src/main/java/dev/claudio/jpatemporal/repository/impl/AnnotatedEntitySupport.java b/src/main/java/dev/claudio/jpatemporal/repository/impl/AnnotatedEntitySupport.java
@@ -28,6 +28,7 @@ class AnnotatedEntitySupport<T> {
             Collections.unmodifiableSet(new HashSet<>(
                     Arrays.asList(OneToOne.class, OneToMany.class, ManyToOne.class, ManyToMany.class)
             ));
+    private static final int MANDATORY_ANNOTATIONS_COUNT = 4;
 
     private final Map<String, Function<T, Object>> readMethod = new HashMap<>();
     private final Map<String, BiConsumer<T, Object>> writeMethod = new HashMap<>();
@@ -37,7 +38,7 @@ class AnnotatedEntitySupport<T> {
     @Getter private final String fromDate;
     @Getter private final String toDate;
 
-    public AnnotatedEntitySupport(final Class<T> domainClass) {
+    AnnotatedEntitySupport(final Class<T> domainClass) {
         validateNoRelationalAnnotations(domainClass);
         this.uniqueKey = ReflectionUtils.fetchAnnotatedField(domainClass, UniqueKey.class);
         this.temporalId = ReflectionUtils.fetchAnnotatedField(domainClass, TemporalId.class);
@@ -50,7 +51,7 @@ public AnnotatedEntitySupport(final Class<T> domainClass) {
                         readMethod.put(it.getName(), createGetterFunction(it));
                         writeMethod.put(it.getName(), createSetterFunction(it));
                     });
-            if (readMethod.size() != 4 || writeMethod.size() != 4) {
+            if (readMethod.size() != MANDATORY_ANNOTATIONS_COUNT || writeMethod.size() != MANDATORY_ANNOTATIONS_COUNT) {
                 throw new RuntimeException("Could not correctly identify property getters/setters for " + domainClass);
             }
         } catch (IntrospectionException e) {
@@ -69,24 +70,24 @@ public void setAttribute(final String attribute, final T entity, final Object va
     private void validateNoRelationalAnnotations(final Class<?> domainClass) {
         boolean hasRelationalAnnotations = RELATIONAL_ANNOTATIONS.stream()
                 .anyMatch(annotation ->
-                        ReflectionUtils.fetchAnnotatedMethods(domainClass, annotation).size() +
-                        ReflectionUtils.fetchAnnotatedFields(domainClass, annotation).size() > 0
+                        ReflectionUtils.fetchAnnotatedMethods(domainClass, annotation).size()
+                        + ReflectionUtils.fetchAnnotatedFields(domainClass, annotation).size() > 0
                 );
         if (hasRelationalAnnotations) {
             throw new RuntimeException("Relational Annotations are not supported: " + RELATIONAL_ANNOTATIONS);
         }
     }
 
-    private ThrowingFunction<T, Object> createGetterFunction(PropertyDescriptor it) {
-        return it.getReadMethod() != null ?
-                (entity) -> it.getReadMethod().invoke(entity) :
-                (entity) -> ReflectionUtils.getField(it.getName(), entity.getClass()).get(entity);
+    private ThrowingFunction<T, Object> createGetterFunction(final PropertyDescriptor it) {
+        return it.getReadMethod() != null
+                ? (entity) -> it.getReadMethod().invoke(entity)
+                : (entity) -> ReflectionUtils.getField(it.getName(), entity.getClass()).get(entity);
     }
 
-    private ThrowingConsumer<T, Object> createSetterFunction(PropertyDescriptor it) {
-        return it.getWriteMethod() != null ?
-                (entity, value) -> it.getWriteMethod().invoke(entity, value) :
-                (entity, value) -> ReflectionUtils.getField(it.getName(), entity.getClass()).set(entity, value);
+    private ThrowingConsumer<T, Object> createSetterFunction(final PropertyDescriptor it) {
+        return it.getWriteMethod() != null
+                ? (entity, value) -> it.getWriteMethod().invoke(entity, value)
+                : (entity, value) -> ReflectionUtils.getField(it.getName(), entity.getClass()).set(entity, value);
     }
 
     @FunctionalInterface

diff --git a/src/main/java/dev/claudio/jpatemporal/repository/impl/ReflectionUtils.java b/src/main/java/dev/claudio/jpatemporal/repository/impl/ReflectionUtils.java
@@ -16,7 +16,7 @@ private ReflectionUtils() { }
     public static String fetchAnnotatedField(final Class<?> domainClass, final Class<? extends Annotation> annotation) {
         final List<Field> annotatedFields = fetchAnnotatedFields(domainClass, annotation);
         final List<Method> annotatedMethods = fetchAnnotatedMethods(domainClass, annotation);
-        if ((annotatedFields.size() + annotatedMethods.size()) != 1) {
+        if (annotatedFields.size() + annotatedMethods.size() != 1) {
             if (domainClass.getSuperclass() != null) {
                 return fetchAnnotatedField(domainClass.getSuperclass(), annotation);
             }

diff --git a/src/main/java/dev/claudio/jpatemporal/repository/impl/RevisionMetadataImpl.java b/src/main/java/dev/claudio/jpatemporal/repository/impl/RevisionMetadataImpl.java
@@ -12,7 +12,7 @@ public class RevisionMetadataImpl<T, N extends Number & Comparable<N>> implement
     private final N revisionNumber;
     private final Instant timestamp;
 
-    public RevisionMetadataImpl(T entity, N revisionNumber, Instant timestamp) {
+    public RevisionMetadataImpl(final T entity, final N revisionNumber, final Instant timestamp) {
         this.entity = entity;
         this.revisionNumber = revisionNumber;
         this.timestamp = timestamp;

diff --git a/src/main/java/dev/claudio/jpatemporal/repository/impl/TemporalRepositoryImpl.java b/src/main/java/dev/claudio/jpatemporal/repository/impl/TemporalRepositoryImpl.java
@@ -147,8 +147,8 @@ public <S extends T> S save(@NonNull final S entity) {
 
     @NonNull
     @Override
-    public void deleteById(@NonNull  ID id) {
-        if(this.deleteById(id, Instant.now()) <= 0) {
+    public void deleteById(@NonNull final ID id) {
+        if (this.deleteById(id, Instant.now()) <= 0) {
             throw new EmptyResultDataAccessException(String.format("No %s entity with id %s exists!", entityInformation.getJavaType(), id), 1);
         }
     }
@@ -189,7 +189,7 @@ public void deleteInBatch(@NonNull final Iterable<T> entities) {
 
     @Override
     @NonNull
-    protected <S extends T> TypedQuery<S> getQuery(Specification<S> spec, @NonNull final Class<S> domainClass, @NonNull final Sort sort) {
+    protected <S extends T> TypedQuery<S> getQuery(final Specification<S> spec, @NonNull final Class<S> domainClass, @NonNull final Sort sort) {
         final Specification<S> toDateSpec = (root, query, criteriaBuilder) -> toAndFromPredicate(MAX_INSTANT, root, criteriaBuilder);
         return super.getQuery(toDateSpec.and(spec), domainClass, sort);
     }
@@ -230,7 +230,9 @@ public Page<Revision<Integer, T>> findRevisions(@NonNull final ID id, @NonNull f
     @NonNull
     public Optional<Revision<Integer, T>> findRevision(@NonNull final ID id, @NonNull final Integer revisionNumber) {
         val revisions = findRevisionsList(id);
-        return Optional.ofNullable((revisionNumber > 0 && revisions.size() >= revisionNumber) ? revisions.get(revisionNumber-1) : null);
+        return Optional.ofNullable(revisionNumber > 0 && revisions.size() >= revisionNumber
+                ? revisions.get(revisionNumber - 1)
+                : null);
     }
 
     /******************************************************************************************************************

diff --git a/src/main/java/dev/claudio/jpatemporal/repository/impl/package-info.java b/src/main/java/dev/claudio/jpatemporal/repository/impl/package-info.java
@@ -0,0 +1 @@
+package dev.claudio.jpatemporal.repository.impl;
diff --git a/src/main/java/dev/claudio/jpatemporal/repository/package-info.java b/src/main/java/dev/claudio/jpatemporal/repository/package-info.java
@@ -0,0 +1 @@
+package dev.claudio.jpatemporal.repository;
diff --git a/src/main/java/dev/claudio/jpatemporal/repository/support/DefaultRepositoryFactoryBean.java b/src/main/java/dev/claudio/jpatemporal/repository/support/DefaultRepositoryFactoryBean.java
@@ -41,13 +41,13 @@ protected RepositoryFactorySupport createRepositoryFactory(@NonNull final Entity
     }
 
     static class DefaultRepositoryFactory extends JpaRepositoryFactory {
-        public DefaultRepositoryFactory(final EntityManager entityManager) {
+        DefaultRepositoryFactory(final EntityManager entityManager) {
             super(entityManager);
         }
 
         @NonNull
         @Override
-        protected Class<?> getRepositoryBaseClass(@NonNull RepositoryMetadata metadata) {
+        protected Class<?> getRepositoryBaseClass(final @NonNull RepositoryMetadata metadata) {
             return TemporalRepositoryImpl.class;
         }
 

diff --git a/src/main/java/dev/claudio/jpatemporal/repository/support/package-info.java b/src/main/java/dev/claudio/jpatemporal/repository/support/package-info.java
@@ -0,0 +1 @@
+package dev.claudio.jpatemporal.repository.support;
diff --git a/src/test/resources/sun_checks.xml → src/test/resources/checkstyle.xml b/src/test/resources/sun_checks.xml → src/test/resources/checkstyle.xml
@@ -99,13 +99,14 @@
     <module name="TreeWalker">
 
         <!-- Checks for Javadoc comments.                     -->
+        <!-- Customised for spring-data-jpa-temporal -->
         <!-- See https://checkstyle.org/config_javadoc.html -->
-        <module name="InvalidJavadocPosition"/>
-        <module name="JavadocMethod"/>
-        <module name="JavadocType"/>
-        <module name="JavadocVariable"/>
-        <module name="JavadocStyle"/>
-        <module name="MissingJavadocMethod"/>
+<!--        <module name="InvalidJavadocPosition"/>-->
+<!--        <module name="JavadocMethod"/>-->
+<!--        <module name="JavadocType"/>-->
+<!--        <module name="JavadocVariable"/>-->
+<!--        <module name="JavadocStyle"/>-->
+<!--        <module name="MissingJavadocMethod"/>-->
 
         <!-- Checks for Naming Conventions.                  -->
         <!-- See https://checkstyle.org/config_naming.html -->
@@ -125,7 +126,7 @@
         <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
         <module name="RedundantImport"/>
         <module name="UnusedImports">
-            <property name="processJavadoc" value="false"/>
+            <property name="processJavadoc" value="true"/>  <!-- Customised for spring-data-jpa-temporal -->
         </module>
 
         <!-- Checks for Size Violations.                    -->
@@ -156,14 +157,18 @@
         <module name="AvoidNestedBlocks"/>
         <module name="EmptyBlock"/>
         <module name="LeftCurly"/>
-        <module name="NeedBraces"/>
+        <module name="NeedBraces">
+            <property name="allowSingleLineStatement" value="true" /> <!-- Customised for spring-data-jpa-temporal -->
+        </module>
         <module name="RightCurly"/>
 
         <!-- Checks for common coding problems               -->
         <!-- See https://checkstyle.org/config_coding.html -->
         <module name="EmptyStatement"/>
         <module name="EqualsHashCode"/>
-        <module name="HiddenField"/>
+        <module name="HiddenField">
+            <property name="ignoreConstructorParameter" value="true" /> <!-- Customised for spring-data-jpa-temporal -->
+        </module>
         <module name="IllegalInstantiation"/>
         <module name="InnerAssignment"/>
         <module name="MagicNumber"/>
@@ -174,7 +179,7 @@
 
         <!-- Checks for class design                         -->
         <!-- See https://checkstyle.org/config_design.html -->
-        <module name="DesignForExtension"/>
+<!--        <module name="DesignForExtension"/>--> <!-- Customised for spring-data-jpa-temporal -->
         <module name="FinalClass"/>
         <module name="HideUtilityClassConstructor"/>
         <module name="InterfaceIsType"/>
@@ -194,6 +199,8 @@
             <property name="optional" value="true"/>
         </module>
 
+        <module name="SuppressWarningsHolder"/>  <!-- Customised for spring-data-jpa-temporal -->
     </module>
+    <module name="SuppressWarningsFilter"/>  <!-- Customised for spring-data-jpa-temporal -->
 
 </module>
diff --git a/src/test/resources/pmd.xml b/src/test/resources/pmd.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+
+<ruleset name="Custom Rules"
+         xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
+
+    <description>
+        PMD Rules
+    </description>
+
+        <rule ref="rulesets/java/quickstart.xml">
+            <exclude name="GenericsNaming" />
+            <exclude name="ControlStatementBraces" />
+        </rule>
+
+</ruleset>