[#10] Add setterTarget to referenced entries, add ReferencedItemBuild…

…Context
qaware · Jun 28, 2021 · 2c13f4a · 2c13f4a
1 parent 123a385
commit 2c13f4a
Show file tree

Hide file tree

Showing 16 changed files with 105 additions and 36 deletions.
diff --git a/...a/de/qaware/openapigeneratorforspring/common/reference/AbstractReferencedItemStorage.java b/...a/de/qaware/openapigeneratorforspring/common/reference/AbstractReferencedItemStorage.java
@@ -23,17 +23,20 @@
 import de.qaware.openapigeneratorforspring.common.reference.fortype.ReferenceDeciderForType;
 import de.qaware.openapigeneratorforspring.common.reference.fortype.ReferenceIdentifierBuilderForType;
 import de.qaware.openapigeneratorforspring.common.reference.fortype.ReferenceIdentifierConflictResolverForType;
+import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemBuildContext;
 import de.qaware.openapigeneratorforspring.common.util.OpenApiProxyUtils;
 import de.qaware.openapigeneratorforspring.model.trait.HasReference;
 import lombok.AccessLevel;
 import lombok.Builder;
+import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import lombok.Setter;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.tuple.Pair;
 
 import javax.annotation.Nullable;
+import java.lang.reflect.Field;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Iterator;
@@ -63,6 +66,10 @@ public abstract class AbstractReferencedItemStorage<T extends HasReference<T>> {
 
     private final List<Entry<T>> entries = new ArrayList<>();
 
+    public static ReferencedItemBuildContext createContext() {
+        return null;
+    }
+
     @Builder
     @Getter(AccessLevel.PRIVATE)
     protected static class AddEntryParameters {
@@ -93,7 +100,23 @@ protected void addEntry(T item, Consumer<T> setter, AddEntryParameters options)
                 ReferenceSetter.of(setter, options.isReferenceRequired()),
                 options.getSuggestedIdentifier()
         );
-        entries.add(Entry.of(item, referenceSetterWithIdentifier, options.getOwner()));
+        entries.add(Entry.of(item, referenceSetterWithIdentifier, options.getOwner(), findSetterTarget(setter)));
+    }
+
+    @Nullable
+    private Object findSetterTarget(Consumer<T> setter) {
+        Field[] declaredFields = setter.getClass().getDeclaredFields();
+        if (declaredFields.length == 1) {
+            Field declaredField = declaredFields[0];
+            declaredField.setAccessible(true);
+            try {
+                return declaredField.get(setter);
+            } catch (IllegalAccessException e) {
+                // this should not happen, as we've made it accessible...
+                return null;
+            }
+        }
+        return null;
     }
 
     protected void removeEntriesOwnedBy(Object owner) {
@@ -104,7 +127,7 @@ public Pair<ReferenceType, List<ReferenceType>> getBuildDependencies() {
         return Pair.of(referenceType, buildDependencies);
     }
 
-    public void buildReferencedItems(Consumer<Map<String, T>> referencedItemsConsumer) {
+    public void buildReferencedItems(Consumer<Map<String, T>> referencedItemsConsumer, @Nullable ReferencedItemBuildContext context) {
         Map<String, T> referencedItems = new LinkedHashMap<>();
         ReferenceActions referenceActions = new ReferenceActions();
         buildGroupedEntries()
@@ -257,21 +280,15 @@ private GroupedEntry createNewGroupedEntry(Entry<T> entry) {
 
     @RequiredArgsConstructor(staticName = "of")
     @Getter
+    @EqualsAndHashCode(onlyExplicitlyIncluded = true)
     private static class Entry<T> {
+        @EqualsAndHashCode.Include
         private final T item;
         private final ReferenceSetterWithIdentifier<T> referenceSetterWithIdentifier;
         @Nullable
         private final Object owner;
-
-        @Override
-        public boolean equals(Object obj) {
-            return obj instanceof Entry<?> && item.equals(((Entry<?>) obj).item);
-        }
-
-        @Override
-        public int hashCode() {
-            return item.hashCode();
-        }
+        @Nullable
+        private final Object setterTarget;
     }
 
     @RequiredArgsConstructor(staticName = "of")

diff --git a/...va/de/qaware/openapigeneratorforspring/common/reference/ReferencedItemSupportFactory.java b/...va/de/qaware/openapigeneratorforspring/common/reference/ReferencedItemSupportFactory.java
@@ -21,6 +21,7 @@
 package de.qaware.openapigeneratorforspring.common.reference;
 
 import de.qaware.openapigeneratorforspring.common.reference.handler.AbstractDependentReferencedComponentHandler;
+import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemBuildContext;
 import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemHandler;
 import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemHandlerFactory;
 import de.qaware.openapigeneratorforspring.model.Components;
@@ -69,7 +70,7 @@ public void applyToOpenApi(OpenApi openApi) {
                                 return (AbstractDependentReferencedComponentHandler) itemHandler;
                             }
                             // non-dependent handler can already be handled here
-                            itemHandler.applyToOpenApi(openApi);
+                            itemHandler.applyToOpenApi(openApi, null);
                             return null;
                         })
                         .filter(Objects::nonNull)
@@ -103,11 +104,13 @@ public DependentReferencedComponentHandlersSupport(OpenApi openApi, List<Abstrac
         public void handle() {
             Map<ReferenceType, Set<ReferenceType>> transitiveDependencies = handlersMap.keySet().stream()
                     .collect(Collectors.toMap(r -> r, r -> buildTransitiveDependencies(r).collect(Collectors.toSet())));
+
+            ReferencedItemBuildContext buildContext = AbstractReferencedItemStorage.createContext();
             handlersMap.values().stream()
                     .sorted(buildDependencyComparator(transitiveDependencies)) // makes less-dependent handlers go first!
                     .forEach(handler -> {
                         LOGGER.debug("Building components for {}", handler.getType());
-                        handler.getHandler().applyToOpenApi(openApi);
+                        handler.getHandler().applyToOpenApi(openApi, buildContext);
                     });
         }
 

diff --git a/...eneratorforspring/common/reference/component/callback/ReferencedCallbacksHandlerImpl.java b/...eneratorforspring/common/reference/component/callback/ReferencedCallbacksHandlerImpl.java
@@ -22,11 +22,13 @@
 
 import de.qaware.openapigeneratorforspring.common.reference.ReferenceType;
 import de.qaware.openapigeneratorforspring.common.reference.handler.AbstractDependentReferencedComponentHandler;
+import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemBuildContext;
 import de.qaware.openapigeneratorforspring.model.Components;
 import de.qaware.openapigeneratorforspring.model.operation.Callback;
 import lombok.RequiredArgsConstructor;
 import org.apache.commons.lang3.tuple.Pair;
 
+import javax.annotation.Nullable;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Consumer;
@@ -48,7 +50,7 @@ public Pair<ReferenceType, List<ReferenceType>> getBuildDependencies() {
     }
 
     @Override
-    public void applyToComponents(Components components) {
-        storage.buildReferencedItems(components::setCallbacks);
+    public void applyToComponents(Components components, @Nullable ReferencedItemBuildContext context) {
+        storage.buildReferencedItems(components::setCallbacks, context);
     }
 }
diff --git a/...igeneratorforspring/common/reference/component/example/ReferencedExamplesHandlerImpl.java b/...igeneratorforspring/common/reference/component/example/ReferencedExamplesHandlerImpl.java
@@ -22,11 +22,13 @@
 
 import de.qaware.openapigeneratorforspring.common.reference.ReferenceType;
 import de.qaware.openapigeneratorforspring.common.reference.handler.AbstractDependentReferencedComponentHandler;
+import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemBuildContext;
 import de.qaware.openapigeneratorforspring.model.Components;
 import de.qaware.openapigeneratorforspring.model.example.Example;
 import lombok.RequiredArgsConstructor;
 import org.apache.commons.lang3.tuple.Pair;
 
+import javax.annotation.Nullable;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Consumer;
@@ -48,8 +50,8 @@ public Pair<ReferenceType, List<ReferenceType>> getBuildDependencies() {
     }
 
     @Override
-    public void applyToComponents(Components components) {
-        storage.buildReferencedItems(components::setExamples);
+    public void applyToComponents(Components components, @Nullable ReferencedItemBuildContext context) {
+        storage.buildReferencedItems(components::setExamples, context);
     }
 
 }
diff --git a/...apigeneratorforspring/common/reference/component/header/ReferencedHeadersHandlerImpl.java b/...apigeneratorforspring/common/reference/component/header/ReferencedHeadersHandlerImpl.java
@@ -22,11 +22,13 @@
 
 import de.qaware.openapigeneratorforspring.common.reference.ReferenceType;
 import de.qaware.openapigeneratorforspring.common.reference.handler.AbstractDependentReferencedComponentHandler;
+import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemBuildContext;
 import de.qaware.openapigeneratorforspring.model.Components;
 import de.qaware.openapigeneratorforspring.model.header.Header;
 import lombok.RequiredArgsConstructor;
 import org.apache.commons.lang3.tuple.Pair;
 
+import javax.annotation.Nullable;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Consumer;
@@ -48,7 +50,7 @@ public Pair<ReferenceType, List<ReferenceType>> getBuildDependencies() {
     }
 
     @Override
-    public void applyToComponents(Components components) {
-        storage.buildReferencedItems(components::setHeaders);
+    public void applyToComponents(Components components, @Nullable ReferencedItemBuildContext context) {
+        storage.buildReferencedItems(components::setHeaders, context);
     }
 }
diff --git a/...openapigeneratorforspring/common/reference/component/link/ReferencedLinksHandlerImpl.java b/...openapigeneratorforspring/common/reference/component/link/ReferencedLinksHandlerImpl.java
@@ -22,11 +22,13 @@
 
 import de.qaware.openapigeneratorforspring.common.reference.ReferenceType;
 import de.qaware.openapigeneratorforspring.common.reference.handler.AbstractDependentReferencedComponentHandler;
+import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemBuildContext;
 import de.qaware.openapigeneratorforspring.model.Components;
 import de.qaware.openapigeneratorforspring.model.link.Link;
 import lombok.RequiredArgsConstructor;
 import org.apache.commons.lang3.tuple.Pair;
 
+import javax.annotation.Nullable;
 import java.util.List;
 import java.util.Map;
 import java.util.function.Consumer;
@@ -48,7 +50,7 @@ public Pair<ReferenceType, List<ReferenceType>> getBuildDependencies() {
     }
 
     @Override
-    public void applyToComponents(Components components) {
-        storage.buildReferencedItems(components::setLinks);
+    public void applyToComponents(Components components, @Nullable ReferencedItemBuildContext context) {
+        storage.buildReferencedItems(components::setLinks, context);
     }
 }
diff --git a/...eratorforspring/common/reference/component/parameter/ReferencedParametersHandlerImpl.java b/...eratorforspring/common/reference/component/parameter/ReferencedParametersHandlerImpl.java
@@ -22,6 +22,7 @@
 
 import de.qaware.openapigeneratorforspring.common.reference.ReferenceType;
 import de.qaware.openapigeneratorforspring.common.reference.handler.AbstractDependentReferencedComponentHandler;
+import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemBuildContext;
 import de.qaware.openapigeneratorforspring.model.Components;
 import de.qaware.openapigeneratorforspring.model.parameter.Parameter;
 import lombok.RequiredArgsConstructor;
@@ -52,7 +53,7 @@ public Pair<ReferenceType, List<ReferenceType>> getBuildDependencies() {
     }
 
     @Override
-    public void applyToComponents(Components components) {
-        storage.buildReferencedItems(components::setParameters);
+    public void applyToComponents(Components components, @Nullable ReferencedItemBuildContext context) {
+        storage.buildReferencedItems(components::setParameters, context);
     }
 }
diff --git a/...torforspring/common/reference/component/requestbody/ReferencedRequestBodyHandlerImpl.java b/...torforspring/common/reference/component/requestbody/ReferencedRequestBodyHandlerImpl.java
@@ -22,11 +22,13 @@
 
 import de.qaware.openapigeneratorforspring.common.reference.ReferenceType;
 import de.qaware.openapigeneratorforspring.common.reference.handler.AbstractDependentReferencedComponentHandler;
+import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemBuildContext;
 import de.qaware.openapigeneratorforspring.model.Components;
 import de.qaware.openapigeneratorforspring.model.requestbody.RequestBody;
 import lombok.RequiredArgsConstructor;
 import org.apache.commons.lang3.tuple.Pair;
 
+import javax.annotation.Nullable;
 import java.util.List;
 import java.util.function.Consumer;
 
@@ -47,7 +49,7 @@ public Pair<ReferenceType, List<ReferenceType>> getBuildDependencies() {
     }
 
     @Override
-    public void applyToComponents(Components components) {
-        storage.buildReferencedItems(components::setRequestBodies);
+    public void applyToComponents(Components components, @Nullable ReferencedItemBuildContext context) {
+        storage.buildReferencedItems(components::setRequestBodies, context);
     }
 }
diff --git a/...ratorforspring/common/reference/component/response/ReferencedApiResponsesHandlerImpl.java b/...ratorforspring/common/reference/component/response/ReferencedApiResponsesHandlerImpl.java
@@ -22,11 +22,13 @@
 
 import de.qaware.openapigeneratorforspring.common.reference.ReferenceType;
 import de.qaware.openapigeneratorforspring.common.reference.handler.AbstractDependentReferencedComponentHandler;
+import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemBuildContext;
 import de.qaware.openapigeneratorforspring.model.Components;
 import de.qaware.openapigeneratorforspring.model.response.ApiResponses;
 import lombok.RequiredArgsConstructor;
 import org.apache.commons.lang3.tuple.Pair;
 
+import javax.annotation.Nullable;
 import java.util.List;
 import java.util.function.Consumer;
 
@@ -47,7 +49,7 @@ public Pair<ReferenceType, List<ReferenceType>> getBuildDependencies() {
     }
 
     @Override
-    public void applyToComponents(Components components) {
-        storage.buildReferencedItems(components::setResponses);
+    public void applyToComponents(Components components, @Nullable ReferencedItemBuildContext context) {
+        storage.buildReferencedItems(components::setResponses, context);
     }
 }
diff --git a/...napigeneratorforspring/common/reference/component/schema/ReferencedSchemaHandlerImpl.java b/...napigeneratorforspring/common/reference/component/schema/ReferencedSchemaHandlerImpl.java
@@ -22,11 +22,13 @@
 
 import de.qaware.openapigeneratorforspring.common.reference.ReferenceType;
 import de.qaware.openapigeneratorforspring.common.reference.handler.AbstractDependentReferencedComponentHandler;
+import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemBuildContext;
 import de.qaware.openapigeneratorforspring.model.Components;
 import de.qaware.openapigeneratorforspring.model.media.Schema;
 import lombok.RequiredArgsConstructor;
 import org.apache.commons.lang3.tuple.Pair;
 
+import javax.annotation.Nullable;
 import java.util.List;
 import java.util.function.Consumer;
 
@@ -54,7 +56,7 @@ public Pair<ReferenceType, List<ReferenceType>> getBuildDependencies() {
     }
 
     @Override
-    public void applyToComponents(Components components) {
-        storage.buildReferencedItems(components::setSchemas);
+    public void applyToComponents(Components components, @Nullable ReferencedItemBuildContext context) {
+        storage.buildReferencedItems(components::setSchemas, context);
     }
 }
diff --git a/...pring/common/reference/component/securityscheme/ReferencedSecuritySchemesHandlerImpl.java b/...pring/common/reference/component/securityscheme/ReferencedSecuritySchemesHandlerImpl.java
@@ -22,12 +22,14 @@
 
 import de.qaware.openapigeneratorforspring.common.mapper.SecuritySchemeAnnotationMapper;
 import de.qaware.openapigeneratorforspring.common.reference.handler.AbstractReferencedComponentHandler;
+import de.qaware.openapigeneratorforspring.common.reference.handler.ReferencedItemBuildContext;
 import de.qaware.openapigeneratorforspring.common.security.OpenApiSecuritySchemesSupplier;
 import de.qaware.openapigeneratorforspring.common.supplier.OpenApiSpringBootApplicationAnnotationsSupplier;
 import de.qaware.openapigeneratorforspring.model.Components;
 import de.qaware.openapigeneratorforspring.model.security.SecurityScheme;
 import lombok.extern.slf4j.Slf4j;
 
+import javax.annotation.Nullable;
 import java.util.Collection;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -80,7 +82,7 @@ public void accept(Map<String, SecurityScheme> map) {
     }
 
     @Override
-    public void applyToComponents(Components components) {
+    public void applyToComponents(Components components, @Nullable ReferencedItemBuildContext context) {
         setMapIfNotEmpty(securitySchemes, components::setSecuritySchemes);
     }
 }
diff --git a/...eratorforspring/common/reference/handler/AbstractDependentReferencedComponentHandler.java b/...eratorforspring/common/reference/handler/AbstractDependentReferencedComponentHandler.java
@@ -25,6 +25,8 @@
 
 import java.util.List;
 
+// TODO do not derive from AbstractReferencedComponentHandler
 public abstract class AbstractDependentReferencedComponentHandler extends AbstractReferencedComponentHandler {
+
     public abstract Pair<ReferenceType, List<ReferenceType>> getBuildDependencies();
 }
diff --git a/...penapigeneratorforspring/common/reference/handler/AbstractReferencedComponentHandler.java b/...penapigeneratorforspring/common/reference/handler/AbstractReferencedComponentHandler.java
@@ -23,15 +23,19 @@
 import de.qaware.openapigeneratorforspring.model.Components;
 import de.qaware.openapigeneratorforspring.model.OpenApi;
 
+import javax.annotation.Nullable;
 import java.util.Objects;
 
 public abstract class AbstractReferencedComponentHandler implements ReferencedItemHandler {
 
     @Override
-    public final void applyToOpenApi(OpenApi openApi) {
+    public final void applyToOpenApi(OpenApi openApi, @Nullable ReferencedItemBuildContext context) {
         // ReferencedItemSupportFactory ensures that openApi.getComponents() is not null
-        applyToComponents(Objects.requireNonNull(openApi.getComponents(), "components of openApi must not be null"));
+        applyToComponents(
+                Objects.requireNonNull(openApi.getComponents(), "components of openApi must not be null"),
+                context
+        );
     }
 
-    protected abstract void applyToComponents(Components components);
+    protected abstract void applyToComponents(Components components, @Nullable ReferencedItemBuildContext context);
 }
diff --git a/...qaware/openapigeneratorforspring/common/reference/handler/ReferencedItemBuildContext.java b/...qaware/openapigeneratorforspring/common/reference/handler/ReferencedItemBuildContext.java
@@ -0,0 +1,24 @@
+/*-
+ * #%L
+ * OpenAPI Generator for Spring Boot :: Common
+ * %%
+ * Copyright (C) 2020 QAware GmbH
+ * %%
+ * 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.
+ * #L%
+ */
+
+package de.qaware.openapigeneratorforspring.common.reference.handler;
+
+public interface ReferencedItemBuildContext {
+}