From 735a5bef6a36644a48bfc5bebde31e217574551c Mon Sep 17 00:00:00 2001
From: Filip Hrisafov <filip.hrisafov@gmail.com>
Date: Sat, 6 Nov 2021 09:21:16 +0100
Subject: [PATCH] #2225 Add support for suppressing the generation of the
 timestamp through Mapper and MapperConfig

---
 core/src/main/java/org/mapstruct/Mapper.java  | 13 +++++++++++
 .../main/java/org/mapstruct/MapperConfig.java | 11 ++++++++++
 .../ap/internal/model/Decorator.java          |  9 ++++++++
 .../ap/internal/model/GeneratedType.java      |  3 ++-
 .../mapstruct/ap/internal/model/Mapper.java   |  9 ++++++++
 .../internal/model/source/DefaultOptions.java |  7 ++++++
 .../model/source/DelegatingOptions.java       |  4 ++++
 .../model/source/MapperConfigOptions.java     |  7 ++++++
 .../internal/model/source/MapperOptions.java  |  7 ++++++
 .../processor/MapperCreationProcessor.java    | 14 ++++++------
 .../SuppressTimestampViaMapper.java           | 16 ++++++++++++++
 .../SuppressTimestampViaMapperConfig.java     | 22 +++++++++++++++++++
 .../ap/test/versioninfo/VersionInfoTest.java  | 16 ++++++++++++++
 13 files changed, 130 insertions(+), 8 deletions(-)
 create mode 100644 processor/src/test/java/org/mapstruct/ap/test/versioninfo/SuppressTimestampViaMapper.java
 create mode 100644 processor/src/test/java/org/mapstruct/ap/test/versioninfo/SuppressTimestampViaMapperConfig.java

diff --git a/core/src/main/java/org/mapstruct/Mapper.java b/core/src/main/java/org/mapstruct/Mapper.java
index 26442e4ff..c5aed661f 100644
--- a/core/src/main/java/org/mapstruct/Mapper.java
+++ b/core/src/main/java/org/mapstruct/Mapper.java
@@ -357,4 +357,17 @@ public @interface Mapper {
      * @since 1.4
      */
     Class<? extends Exception> unexpectedValueMappingException() default IllegalArgumentException.class;
+
+    /**
+     * Flag indicating whether the addition of a time stamp in the {@code @Generated} annotation should be suppressed.
+     * i.e. not be added.
+     *
+     * The method overrides the flag set in a central configuration set by {@link #config()}
+     * or through an annotation processor option.
+     *
+     * @return whether the addition of a timestamp should be suppressed
+     *
+     * @since 1.5
+     */
+    boolean suppressTimestampInGenerated() default false;
 }
diff --git a/core/src/main/java/org/mapstruct/MapperConfig.java b/core/src/main/java/org/mapstruct/MapperConfig.java
index ce239322a..757a4ab0a 100644
--- a/core/src/main/java/org/mapstruct/MapperConfig.java
+++ b/core/src/main/java/org/mapstruct/MapperConfig.java
@@ -329,5 +329,16 @@ public @interface MapperConfig {
      */
     Class<? extends Exception> unexpectedValueMappingException() default IllegalArgumentException.class;
 
+    /**
+     * Flag indicating whether the addition of a time stamp in the {@code @Generated} annotation should be suppressed.
+     * i.e. not be added.
+     *
+     * The method overrides the flag set through an annotation processor option.
+     *
+     * @return whether the addition of a timestamp should be suppressed
+     *
+     * @since 1.5
+     */
+    boolean suppressTimestampInGenerated() default false;
 }
 
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/Decorator.java b/processor/src/main/java/org/mapstruct/ap/internal/model/Decorator.java
index a54045dca..b7dc0effc 100644
--- a/processor/src/main/java/org/mapstruct/ap/internal/model/Decorator.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/model/Decorator.java
@@ -32,6 +32,7 @@ public class Decorator extends GeneratedType {
         private boolean hasDelegateConstructor;
         private String implName;
         private String implPackage;
+        private boolean suppressGeneratorTimestamp;
 
         public Builder() {
             super( Builder.class );
@@ -62,6 +63,11 @@ public class Decorator extends GeneratedType {
             return this;
         }
 
+        public Builder suppressGeneratorTimestamp(boolean suppressGeneratorTimestamp) {
+            this.suppressGeneratorTimestamp = suppressGeneratorTimestamp;
+            return this;
+        }
+
         public Decorator build() {
             String implementationName = implName.replace( Mapper.CLASS_NAME_PLACEHOLDER,
                 Mapper.getFlatName( mapperElement ) );
@@ -86,6 +92,7 @@ public class Decorator extends GeneratedType {
                 methods,
                 options,
                 versionInformation,
+                suppressGeneratorTimestamp,
                 Accessibility.fromModifiers( mapperElement.getModifiers() ),
                 extraImportedTypes,
                 decoratorConstructor
@@ -101,6 +108,7 @@ public class Decorator extends GeneratedType {
                       Type mapperType,
                       List<MappingMethod> methods,
                       Options options, VersionInformation versionInformation,
+                      boolean suppressGeneratorTimestamp,
                       Accessibility accessibility, SortedSet<Type> extraImports,
                       DecoratorConstructor decoratorConstructor) {
         super(
@@ -112,6 +120,7 @@ public class Decorator extends GeneratedType {
             Arrays.asList( new Field( mapperType, "delegate", true ) ),
             options,
             versionInformation,
+            suppressGeneratorTimestamp,
             accessibility,
             extraImports,
             decoratorConstructor
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/GeneratedType.java b/processor/src/main/java/org/mapstruct/ap/internal/model/GeneratedType.java
index 620559ea2..134ab081d 100644
--- a/processor/src/main/java/org/mapstruct/ap/internal/model/GeneratedType.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/model/GeneratedType.java
@@ -103,6 +103,7 @@ public abstract class GeneratedType extends ModelElement {
     protected GeneratedType(TypeFactory typeFactory, String packageName, String name,
                             Type mapperDefinitionType, List<MappingMethod> methods,
                             List<Field> fields, Options options, VersionInformation versionInformation,
+                            boolean suppressGeneratorTimestamp,
                             Accessibility accessibility, SortedSet<Type> extraImportedTypes, Constructor constructor) {
         this.packageName = packageName;
         this.name = name;
@@ -113,7 +114,7 @@ public abstract class GeneratedType extends ModelElement {
         this.methods = methods;
         this.fields = fields;
 
-        this.suppressGeneratorTimestamp = options.isSuppressGeneratorTimestamp();
+        this.suppressGeneratorTimestamp = suppressGeneratorTimestamp;
         this.suppressGeneratorVersionComment = options.isSuppressGeneratorVersionComment();
         this.versionInformation = versionInformation;
         this.accessibility = accessibility;
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/Mapper.java b/processor/src/main/java/org/mapstruct/ap/internal/model/Mapper.java
index a066b123c..fa15cd8ed 100644
--- a/processor/src/main/java/org/mapstruct/ap/internal/model/Mapper.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/model/Mapper.java
@@ -42,6 +42,7 @@ public class Mapper extends GeneratedType {
         private boolean customName;
         private String implPackage;
         private boolean customPackage;
+        private boolean suppressGeneratorTimestamp;
 
         public Builder() {
             super( Builder.class );
@@ -79,6 +80,11 @@ public class Mapper extends GeneratedType {
             return this;
         }
 
+        public Builder suppressGeneratorTimestamp(boolean suppressGeneratorTimestamp) {
+            this.suppressGeneratorTimestamp = suppressGeneratorTimestamp;
+            return this;
+        }
+
         public Mapper build() {
             String implementationName = implName.replace( CLASS_NAME_PLACEHOLDER, getFlatName( element ) ) +
                 ( decorator == null ? "" : "_" );
@@ -102,6 +108,7 @@ public class Mapper extends GeneratedType {
                 methods,
                 options,
                 versionInformation,
+                suppressGeneratorTimestamp,
                 Accessibility.fromModifiers( element.getModifiers() ),
                 fields,
                 constructor,
@@ -121,6 +128,7 @@ public class Mapper extends GeneratedType {
                    Type mapperDefinitionType,
                    boolean customPackage, boolean customImplName,
                    List<MappingMethod> methods, Options options, VersionInformation versionInformation,
+                   boolean suppressGeneratorTimestamp,
                    Accessibility accessibility, List<Field> fields, Constructor constructor,
                    Decorator decorator, SortedSet<Type> extraImportedTypes ) {
 
@@ -133,6 +141,7 @@ public class Mapper extends GeneratedType {
             fields,
             options,
             versionInformation,
+            suppressGeneratorTimestamp,
             accessibility,
             extraImportedTypes,
             constructor
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/source/DefaultOptions.java b/processor/src/main/java/org/mapstruct/ap/internal/model/source/DefaultOptions.java
index 1258707e4..5c76e7fac 100644
--- a/processor/src/main/java/org/mapstruct/ap/internal/model/source/DefaultOptions.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/model/source/DefaultOptions.java
@@ -83,6 +83,13 @@ public class DefaultOptions extends DelegatingOptions {
         return mapper.componentModel().getDefaultValue();
     }
 
+    public boolean suppressTimestampInGenerated() {
+        if ( mapper.suppressTimestampInGenerated().hasValue() ) {
+            return mapper.suppressTimestampInGenerated().getValue();
+        }
+        return options.isSuppressGeneratorTimestamp();
+    }
+
     @Override
     public MappingInheritanceStrategyGem getMappingInheritanceStrategy() {
         return MappingInheritanceStrategyGem.valueOf( mapper.mappingInheritanceStrategy().getDefaultValue() );
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/source/DelegatingOptions.java b/processor/src/main/java/org/mapstruct/ap/internal/model/source/DelegatingOptions.java
index 12f610f1a..50c1d8454 100644
--- a/processor/src/main/java/org/mapstruct/ap/internal/model/source/DelegatingOptions.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/model/source/DelegatingOptions.java
@@ -68,6 +68,10 @@ public abstract class DelegatingOptions {
         return next.componentModel();
     }
 
+    public boolean suppressTimestampInGenerated() {
+        return next.suppressTimestampInGenerated();
+    }
+
     public MappingInheritanceStrategyGem getMappingInheritanceStrategy() {
         return next.getMappingInheritanceStrategy();
     }
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/source/MapperConfigOptions.java b/processor/src/main/java/org/mapstruct/ap/internal/model/source/MapperConfigOptions.java
index 623b97bc7..e3ca6162a 100644
--- a/processor/src/main/java/org/mapstruct/ap/internal/model/source/MapperConfigOptions.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/model/source/MapperConfigOptions.java
@@ -76,6 +76,13 @@ public class MapperConfigOptions extends DelegatingOptions {
         return mapperConfig.componentModel().hasValue() ? mapperConfig.componentModel().get() : next().componentModel();
     }
 
+    @Override
+    public boolean suppressTimestampInGenerated() {
+        return mapperConfig.suppressTimestampInGenerated().hasValue() ?
+            mapperConfig.suppressTimestampInGenerated().get() :
+            next().suppressTimestampInGenerated();
+    }
+
     @Override
     public MappingInheritanceStrategyGem getMappingInheritanceStrategy() {
         return mapperConfig.mappingInheritanceStrategy().hasValue() ?
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/source/MapperOptions.java b/processor/src/main/java/org/mapstruct/ap/internal/model/source/MapperOptions.java
index 326120511..ed1af34f7 100644
--- a/processor/src/main/java/org/mapstruct/ap/internal/model/source/MapperOptions.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/model/source/MapperOptions.java
@@ -105,6 +105,13 @@ public class MapperOptions extends DelegatingOptions {
         return mapper.componentModel().hasValue() ? mapper.componentModel().get() : next().componentModel();
     }
 
+    @Override
+    public boolean suppressTimestampInGenerated() {
+        return mapper.suppressTimestampInGenerated().hasValue() ?
+            mapper.suppressTimestampInGenerated().get() :
+            next().suppressTimestampInGenerated();
+    }
+
     @Override
     public MappingInheritanceStrategyGem getMappingInheritanceStrategy() {
         return mapper.mappingInheritanceStrategy().hasValue() ?
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/processor/MapperCreationProcessor.java b/processor/src/main/java/org/mapstruct/ap/internal/processor/MapperCreationProcessor.java
index 539e40daf..bae0cda1a 100644
--- a/processor/src/main/java/org/mapstruct/ap/internal/processor/MapperCreationProcessor.java
+++ b/processor/src/main/java/org/mapstruct/ap/internal/processor/MapperCreationProcessor.java
@@ -198,13 +198,13 @@ public class MapperCreationProcessor implements ModelElementProcessor<List<Sourc
             .constructorFragments(  constructorFragments )
             .options( options )
             .versionInformation( versionInformation )
-            .decorator( getDecorator( element, methods, mapperOptions.implementationName(),
-                mapperOptions.implementationPackage(), getExtraImports( element, mapperOptions ) ) )
+            .decorator( getDecorator( element, methods, mapperOptions ) )
             .typeFactory( typeFactory )
             .elementUtils( elementUtils )
             .extraImports( getExtraImports( element, mapperOptions ) )
             .implName( mapperOptions.implementationName() )
             .implPackage( mapperOptions.implementationPackage() )
+            .suppressGeneratorTimestamp( mapperOptions.suppressTimestampInGenerated() )
             .build();
 
         if ( !mappingContext.getForgedMethodsUnderCreation().isEmpty() ) {
@@ -226,8 +226,7 @@ public class MapperCreationProcessor implements ModelElementProcessor<List<Sourc
         return mapper;
     }
 
-    private Decorator getDecorator(TypeElement element, List<SourceMethod> methods, String implName,
-                                   String implPackage, SortedSet<Type> extraImports) {
+    private Decorator getDecorator(TypeElement element, List<SourceMethod> methods, MapperOptions mapperOptions) {
         DecoratedWithGem decoratedWith = DecoratedWithGem.instanceOn( element );
 
         if ( decoratedWith == null ) {
@@ -287,9 +286,10 @@ public class MapperCreationProcessor implements ModelElementProcessor<List<Sourc
             .hasDelegateConstructor( hasDelegateConstructor )
             .options( options )
             .versionInformation( versionInformation )
-            .implName( implName )
-            .implPackage( implPackage )
-            .extraImports( extraImports )
+            .implName( mapperOptions.implementationName() )
+            .implPackage( mapperOptions.implementationPackage() )
+            .extraImports( getExtraImports( element, mapperOptions ) )
+            .suppressGeneratorTimestamp( mapperOptions.suppressTimestampInGenerated() )
             .build();
 
         return decorator;
diff --git a/processor/src/test/java/org/mapstruct/ap/test/versioninfo/SuppressTimestampViaMapper.java b/processor/src/test/java/org/mapstruct/ap/test/versioninfo/SuppressTimestampViaMapper.java
new file mode 100644
index 000000000..02a7b467b
--- /dev/null
+++ b/processor/src/test/java/org/mapstruct/ap/test/versioninfo/SuppressTimestampViaMapper.java
@@ -0,0 +1,16 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
+ */
+package org.mapstruct.ap.test.versioninfo;
+
+import org.mapstruct.Mapper;
+
+/**
+ * @author Filip Hrisafov
+ */
+@Mapper(suppressTimestampInGenerated = true)
+public interface SuppressTimestampViaMapper {
+    Object toObject(Object object);
+}
diff --git a/processor/src/test/java/org/mapstruct/ap/test/versioninfo/SuppressTimestampViaMapperConfig.java b/processor/src/test/java/org/mapstruct/ap/test/versioninfo/SuppressTimestampViaMapperConfig.java
new file mode 100644
index 000000000..a471cad02
--- /dev/null
+++ b/processor/src/test/java/org/mapstruct/ap/test/versioninfo/SuppressTimestampViaMapperConfig.java
@@ -0,0 +1,22 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
+ */
+package org.mapstruct.ap.test.versioninfo;
+
+import org.mapstruct.Mapper;
+import org.mapstruct.MapperConfig;
+
+/**
+ * @author Filip Hrisafov
+ */
+@Mapper(config = SuppressTimestampViaMapperConfig.Config.class)
+public interface SuppressTimestampViaMapperConfig {
+    Object toObject(Object object);
+
+    @MapperConfig(suppressTimestampInGenerated = true)
+    interface Config {
+
+    }
+}
diff --git a/processor/src/test/java/org/mapstruct/ap/test/versioninfo/VersionInfoTest.java b/processor/src/test/java/org/mapstruct/ap/test/versioninfo/VersionInfoTest.java
index 1eec91b95..f3192b85a 100644
--- a/processor/src/test/java/org/mapstruct/ap/test/versioninfo/VersionInfoTest.java
+++ b/processor/src/test/java/org/mapstruct/ap/test/versioninfo/VersionInfoTest.java
@@ -49,4 +49,20 @@ public class VersionInfoTest {
             .contains( "comments = \"version: " );
     }
 
+    @ProcessorTest
+    @WithClasses(SuppressTimestampViaMapper.class)
+    @IssueKey("2225")
+    void includesNoTimestampViaMapper() {
+        generatedSource.forMapper( SuppressTimestampViaMapper.class ).content()
+            .doesNotContain( "date = \"" );
+    }
+
+    @ProcessorTest
+    @WithClasses(SuppressTimestampViaMapperConfig.class)
+    @IssueKey("2225")
+    void includesNoTimestampViaMapperConfig() {
+        generatedSource.forMapper( SuppressTimestampViaMapperConfig.class ).content()
+            .doesNotContain( "date = \"" );
+    }
+
 }