You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@causeway.apache.org by ah...@apache.org on 2025/01/09 05:10:23 UTC

(causeway) 03/04: CAUSEWAY-3844: only report orphaned support methods when name conforms to programming model

This is an automated email from the ASF dual-hosted git repository.

ahuber pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/causeway.git

commit 67d066d409ecdbb00de42a080c41b1374f96d91d
Author: Andi Huber <ah...@apache.org>
AuthorDate: Thu Jan 9 05:46:23 2025 +0100

    CAUSEWAY-3844: only report orphaned support methods when name conforms
    to programming model
---
 .../introspection/IntrospectionPolicyFacet.java     | 21 +--------------------
 .../IntrospectionPolicyFacetAbstract.java           | 13 +++++++++++++
 .../spec/impl/ObjectSpecificationDefault.java       |  4 +---
 ...ludeAnnotationEnforcesMetamodelContribution.java | 18 ++++++++++++++++++
 .../DomainModelTest_usingGoodDomain.java            |  6 ++----
 5 files changed, 35 insertions(+), 27 deletions(-)

diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/facets/object/introspection/IntrospectionPolicyFacet.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/facets/object/introspection/IntrospectionPolicyFacet.java
index 57e5feda494..a9a6adaca9a 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/facets/object/introspection/IntrospectionPolicyFacet.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/facets/object/introspection/IntrospectionPolicyFacet.java
@@ -22,8 +22,6 @@ import org.apache.causeway.applib.annotation.DomainObject;
 import org.apache.causeway.applib.annotation.Introspection;
 import org.apache.causeway.applib.annotation.Introspection.EncapsulationPolicy;
 import org.apache.causeway.applib.annotation.Introspection.IntrospectionPolicy;
-import org.apache.causeway.commons.internal.exceptions._Exceptions;
-import org.apache.causeway.core.config.CausewayConfiguration;
 import org.apache.causeway.core.metamodel.facetapi.Facet;
 
 /**
@@ -34,23 +32,6 @@ import org.apache.causeway.core.metamodel.facetapi.Facet;
 public interface IntrospectionPolicyFacet extends Facet {
 
     Introspection getIntrospection();
-
-    default IntrospectionPolicy getIntrospectionPolicy(final CausewayConfiguration causewayConfig) {
-        switch(getIntrospection()) {
-        case ENCAPSULATION_ENABLED:
-            return IntrospectionPolicy.ENCAPSULATION_ENABLED;
-        case ANNOTATION_OPTIONAL:
-            return IntrospectionPolicy.ANNOTATION_OPTIONAL;
-        case ANNOTATION_REQUIRED:
-            return IntrospectionPolicy.ANNOTATION_REQUIRED;
-        case AS_CONFIGURED:
-            return causewayConfig.getCore().getMetaModel().getIntrospector().getPolicy();
-        case NOT_SPECIFIED:
-            throw _Exceptions.unexpectedCodeReach(); // there must be no such facet that returns such a case
-        default:
-            throw _Exceptions.unmatchedCase(getIntrospection());
-        }
-
-    }
+    IntrospectionPolicy getIntrospectionPolicy();
 
 }
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/facets/object/introspection/IntrospectionPolicyFacetAbstract.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/facets/object/introspection/IntrospectionPolicyFacetAbstract.java
index 0527aeaca63..7dbb4a2a8bc 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/facets/object/introspection/IntrospectionPolicyFacetAbstract.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/facets/object/introspection/IntrospectionPolicyFacetAbstract.java
@@ -21,6 +21,8 @@ package org.apache.causeway.core.metamodel.facets.object.introspection;
 import java.util.function.BiConsumer;
 
 import org.apache.causeway.applib.annotation.Introspection;
+import org.apache.causeway.applib.annotation.Introspection.IntrospectionPolicy;
+import org.apache.causeway.commons.internal.exceptions._Exceptions;
 import org.apache.causeway.core.metamodel.facetapi.Facet;
 import org.apache.causeway.core.metamodel.facetapi.FacetAbstract;
 import org.apache.causeway.core.metamodel.facetapi.FacetHolder;
@@ -52,6 +54,17 @@ implements IntrospectionPolicyFacet {
         super(IntrospectionPolicyFacetAbstract.type(), holder, precedence);
         this.introspection = introspection;
     }
+    
+    @Override
+    public final IntrospectionPolicy getIntrospectionPolicy() {
+        return switch(introspection) {
+            case ENCAPSULATION_ENABLED -> IntrospectionPolicy.ENCAPSULATION_ENABLED;
+            case ANNOTATION_OPTIONAL -> IntrospectionPolicy.ANNOTATION_OPTIONAL;
+            case ANNOTATION_REQUIRED -> IntrospectionPolicy.ANNOTATION_REQUIRED;
+            case AS_CONFIGURED -> getConfiguration().getCore().getMetaModel().getIntrospector().getPolicy();
+            case NOT_SPECIFIED -> throw _Exceptions.unexpectedCodeReach(); // there must be no such a facet that returns such a case
+        };
+    }
 
     @Override
     public void visitAttributes(final BiConsumer<String, Object> visitor) {
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/impl/ObjectSpecificationDefault.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/impl/ObjectSpecificationDefault.java
index 5598b3ccf53..9839e744700 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/impl/ObjectSpecificationDefault.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/impl/ObjectSpecificationDefault.java
@@ -164,9 +164,7 @@ implements ObjectMemberContainer, ObjectSpecificationMutable, HasSpecificationLo
 
         // naturally supports attribute inheritance from the type's hierarchy
         this.introspectionPolicy = this.lookupFacet(IntrospectionPolicyFacet.class)
-                .map(introspectionPolicyFacet->
-                        introspectionPolicyFacet
-                        .getIntrospectionPolicy(mmc.getConfiguration()))
+                .map(introspectionPolicyFacet->introspectionPolicyFacet.getIntrospectionPolicy())
                 .orElseGet(()->mmc.getConfiguration().getCore().getMetaModel().getIntrospector().getPolicy());
 
         this.facetedMethodsBuilder =
diff --git a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/impl/ValidatorDomainIncludeAnnotationEnforcesMetamodelContribution.java b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/impl/ValidatorDomainIncludeAnnotationEnforcesMetamodelContribution.java
index ae51f984470..52454b26c0f 100644
--- a/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/impl/ValidatorDomainIncludeAnnotationEnforcesMetamodelContribution.java
+++ b/core/metamodel/src/main/java/org/apache/causeway/core/metamodel/spec/impl/ValidatorDomainIncludeAnnotationEnforcesMetamodelContribution.java
@@ -40,7 +40,9 @@ import org.apache.causeway.commons.internal.reflection._MethodFacades.MethodFaca
 import org.apache.causeway.commons.semantics.AccessorSemantics;
 import org.apache.causeway.commons.internal.reflection._Reflect;
 import org.apache.causeway.core.config.progmodel.ProgrammingModelConstants;
+import org.apache.causeway.core.config.progmodel.ProgrammingModelConstants.MemberSupportPrefix;
 import org.apache.causeway.core.config.progmodel.ProgrammingModelConstants.MessageTemplate;
+import org.apache.causeway.core.config.progmodel.ProgrammingModelConstants.ObjectSupportMethod;
 import org.apache.causeway.core.metamodel.commons.MethodUtil;
 import org.apache.causeway.core.metamodel.context.MetaModelContext;
 import org.apache.causeway.core.metamodel.facetapi.FacetHolder;
@@ -193,6 +195,11 @@ extends MetaModelValidatorAbstract {
                     .isSupportMethodAnnotationsRequired()) {
             return; // ignore
         }
+        
+        System.err.printf("validate policy %s: %s%n", 
+            spec.getIntrospectionPolicy(),
+            spec.getFeatureIdentifier()
+            );
 
         var potentialOrphans = spec instanceof ObjectSpecificationDefault specDefault
             ? specDefault.getPotentialOrphans()
@@ -204,6 +211,7 @@ extends MetaModelValidatorAbstract {
             .filter(Predicate.not(alreadyReported::contains))
             .filter(Predicate.not(memberMethods::contains))
             .filter(Predicate.not(supportMethods::contains))
+            .filter(m->matchesSupportMethodNamingConvention(m.name()))
             .forEach(orphanedMethod->{
 
                 var methodIdentifier = Identifier
@@ -220,4 +228,14 @@ extends MetaModelValidatorAbstract {
         potentialOrphans.clear(); // no longer needed
     }
 
+    private static boolean matchesSupportMethodNamingConvention(String methodName) {
+        for(var objectSupportMethod : ObjectSupportMethod.values()) {
+            if(objectSupportMethod.getMethodNames().anyMatch(name->name.equals(methodName))) return true;
+        }
+        for(var memberSupportPrefix : MemberSupportPrefix.values()) {
+            if(memberSupportPrefix.getMethodNamePrefixes().anyMatch(prefix->methodName.startsWith(prefix))) return true;
+        }
+        return false;
+    }
+
 }
diff --git a/regressiontests/domainmodel/src/test/java/org/apache/causeway/testdomain/domainmodel/DomainModelTest_usingGoodDomain.java b/regressiontests/domainmodel/src/test/java/org/apache/causeway/testdomain/domainmodel/DomainModelTest_usingGoodDomain.java
index e749efd811f..38412df7a20 100644
--- a/regressiontests/domainmodel/src/test/java/org/apache/causeway/testdomain/domainmodel/DomainModelTest_usingGoodDomain.java
+++ b/regressiontests/domainmodel/src/test/java/org/apache/causeway/testdomain/domainmodel/DomainModelTest_usingGoodDomain.java
@@ -54,7 +54,6 @@ import org.apache.causeway.applib.services.title.TitleService;
 import org.apache.causeway.commons.collections.Can;
 import org.apache.causeway.commons.internal.base._Strings;
 import org.apache.causeway.commons.internal.exceptions._Exceptions;
-import org.apache.causeway.core.config.CausewayConfiguration;
 import org.apache.causeway.core.config.presets.CausewayPresets;
 import org.apache.causeway.core.metamodel.context.MetaModelContext;
 import org.apache.causeway.core.metamodel.facetapi.FacetHolder;
@@ -148,7 +147,6 @@ class DomainModelTest_usingGoodDomain extends CausewayIntegrationTestAbstract {
     @Inject private ServiceRegistry serviceRegistry;
     @Inject private SpecificationLoader specificationLoader;
     @Inject private TitleService titleService;
-    @Inject private CausewayConfiguration causewayConfig;
     @Inject private DomainObjectTesterFactory testerFactory;
 
     void debug() {
@@ -719,7 +717,7 @@ class DomainModelTest_usingGoodDomain extends CausewayIntegrationTestAbstract {
         var introspectionPolicyFacet = objectSpec.getFacet(IntrospectionPolicyFacet.class);
         assertNotNull(introspectionPolicyFacet);
 
-        var introspectionPolicy = introspectionPolicyFacet.getIntrospectionPolicy(causewayConfig);
+        var introspectionPolicy = introspectionPolicyFacet.getIntrospectionPolicy();
         assertEquals(
                 EncapsulationPolicy.ENCAPSULATED_MEMBERS_SUPPORTED,
                 introspectionPolicy.getEncapsulationPolicy());
@@ -769,7 +767,7 @@ class DomainModelTest_usingGoodDomain extends CausewayIntegrationTestAbstract {
         var introspectionPolicyFacet = objectSpec.getFacet(IntrospectionPolicyFacet.class);
         assertNotNull(introspectionPolicyFacet);
 
-        var introspectionPolicy = introspectionPolicyFacet.getIntrospectionPolicy(causewayConfig);
+        var introspectionPolicy = introspectionPolicyFacet.getIntrospectionPolicy();
         assertEquals(
                 EncapsulationPolicy.ONLY_PUBLIC_MEMBERS_SUPPORTED,
                 introspectionPolicy.getEncapsulationPolicy());