You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2021/06/07 16:20:37 UTC

[isis] branch master updated: ISIS-2725: add MM validator to fail on mix of @DomainObject with @Value

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

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


The following commit(s) were added to refs/heads/master by this push:
     new 04a2d0d  ISIS-2725: add MM validator to fail on mix of @DomainObject with @Value
04a2d0d is described below

commit 04a2d0dfa7b3447f3a1759b27bc1f91e3d5838d7
Author: Andi Huber <ah...@apache.org>
AuthorDate: Mon Jun 7 18:18:49 2021 +0200

    ISIS-2725: add MM validator to fail on mix of @DomainObject with @Value
    
    also providing regr. tests
    also cleaning up some built-in value types, that had both annot. in use
---
 .../apache/isis/applib/graph/tree/TreeNode.java    |  6 ++---
 .../isis/applib/services/bookmark/Bookmark.java    |  5 ++--
 .../java/org/apache/isis/applib/value/Blob.java    |  6 ++---
 .../java/org/apache/isis/applib/value/Clob.java    |  6 ++---
 .../isis/applib/value/LocalResourcePath.java       |  6 ++---
 .../java/org/apache/isis/applib/value/Markup.java  |  7 +++---
 .../org/apache/isis/applib/value/Password.java     |  6 ++---
 .../annotation/ValueAnnotationFacetFactory.java    | 11 ++++++++
 .../appfeat/ApplicationFeatureDefault.java         |  4 +--
 .../DomainModelTest_usingBadDomain.java            | 10 +++++++-
 .../bad/InvalidContradictingTypeSemantics.java     | 29 ++++++++++++++++++++++
 .../model/bad/InvalidLogicalTypeNameClash.java     |  7 ------
 .../valuetypes/asciidoc/applib/value/AsciiDoc.java |  6 ++---
 .../valuetypes/markdown/applib/value/Markdown.java |  3 +--
 14 files changed, 75 insertions(+), 37 deletions(-)

diff --git a/api/applib/src/main/java/org/apache/isis/applib/graph/tree/TreeNode.java b/api/applib/src/main/java/org/apache/isis/applib/graph/tree/TreeNode.java
index 7b4cef8..5be300e 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/graph/tree/TreeNode.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/graph/tree/TreeNode.java
@@ -30,7 +30,6 @@ import java.util.stream.StreamSupport;
 import javax.annotation.Nullable;
 
 import org.apache.isis.applib.IsisModuleApplib;
-import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.applib.annotation.Programmatic;
 import org.apache.isis.applib.annotation.Value;
 import org.apache.isis.applib.graph.Edge;
@@ -47,8 +46,9 @@ import org.apache.isis.commons.internal.exceptions._Exceptions;
  *
  * @param <T> type constraint for values contained by this node
  */
-@Value(semanticsProviderName="org.apache.isis.core.metamodel.facets.value.treenode.TreeNodeValueSemanticsProvider")
-@DomainObject(logicalTypeName = IsisModuleApplib.NAMESPACE + ".graph.tree.TreeNode")
+@Value(
+        logicalTypeName = IsisModuleApplib.NAMESPACE + ".graph.tree.TreeNode",
+        semanticsProviderName="org.apache.isis.core.metamodel.facets.value.treenode.TreeNodeValueSemanticsProvider")
 public class TreeNode<T> implements Vertex<T> {
 
     private final TreeState sharedState;
diff --git a/api/applib/src/main/java/org/apache/isis/applib/services/bookmark/Bookmark.java b/api/applib/src/main/java/org/apache/isis/applib/services/bookmark/Bookmark.java
index c0a1e6c..7702675 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/services/bookmark/Bookmark.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/services/bookmark/Bookmark.java
@@ -25,7 +25,6 @@ import java.util.StringTokenizer;
 import javax.annotation.Nullable;
 
 import org.apache.isis.applib.IsisModuleApplib;
-import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.applib.id.LogicalType;
 import org.apache.isis.commons.internal.base._Strings;
 import org.apache.isis.commons.internal.codec._UrlDecoderUtil;
@@ -42,8 +41,8 @@ import lombok.val;
  *
  * @since 1.x revised for 2.0 {@index}
  */
-@org.apache.isis.applib.annotation.Value
-@DomainObject(logicalTypeName = IsisModuleApplib.NAMESPACE + ".Bookmark")
+@org.apache.isis.applib.annotation.Value(
+        logicalTypeName = IsisModuleApplib.NAMESPACE + ".Bookmark")
 @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
 public final class Bookmark implements Oid {
 
diff --git a/api/applib/src/main/java/org/apache/isis/applib/value/Blob.java b/api/applib/src/main/java/org/apache/isis/applib/value/Blob.java
index a4b0fc1..015f984 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/value/Blob.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/value/Blob.java
@@ -32,7 +32,6 @@ import javax.xml.bind.annotation.adapters.XmlAdapter;
 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 
 import org.apache.isis.applib.IsisModuleApplib;
-import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.applib.annotation.Value;
 import org.apache.isis.applib.jaxb.PrimitiveJaxbAdapters;
 import org.apache.isis.commons.internal.base._Strings;
@@ -63,9 +62,10 @@ import lombok.extern.log4j.Log4j2;
  * @see Clob
  * @since 1.x {@index}
  */
-@Value(semanticsProviderName =
+@Value(
+        logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.Blob",
+        semanticsProviderName =
         "org.apache.isis.core.metamodel.facets.value.blobs.BlobValueSemanticsProvider")
-@DomainObject(logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.Blob")
 @XmlJavaTypeAdapter(Blob.JaxbToStringAdapter.class)   // for JAXB view model support
 @Log4j2
 public final class Blob implements NamedWithMimeType {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/value/Clob.java b/api/applib/src/main/java/org/apache/isis/applib/value/Clob.java
index cfb8b5e..8003ab1 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/value/Clob.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/value/Clob.java
@@ -30,7 +30,6 @@ import javax.xml.bind.annotation.adapters.XmlAdapter;
 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 
 import org.apache.isis.applib.IsisModuleApplib;
-import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.applib.annotation.Value;
 import org.apache.isis.applib.jaxb.PrimitiveJaxbAdapters;
 import org.apache.isis.commons.internal.base._Strings;
@@ -59,9 +58,10 @@ import lombok.val;
  * @see Blob
  * @since 1.x {@index}
  */
-@Value(semanticsProviderName =
+@Value(
+        logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.Clob",
+        semanticsProviderName =
         "org.apache.isis.core.metamodel.facets.value.clobs.ClobValueSemanticsProvider")
-@DomainObject(logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.Clob")
 @XmlJavaTypeAdapter(Clob.JaxbToStringAdapter.class)   // for JAXB view model support
 //@Log4j2
 public final class Clob implements NamedWithMimeType {
diff --git a/api/applib/src/main/java/org/apache/isis/applib/value/LocalResourcePath.java b/api/applib/src/main/java/org/apache/isis/applib/value/LocalResourcePath.java
index 8bb81c4..4dabd41 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/value/LocalResourcePath.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/value/LocalResourcePath.java
@@ -28,7 +28,6 @@ import javax.xml.bind.annotation.adapters.XmlAdapter;
 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 
 import org.apache.isis.applib.IsisModuleApplib;
-import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.applib.annotation.Value;
 
 import lombok.Getter;
@@ -51,9 +50,10 @@ import lombok.NonNull;
  * @since 2.0 {@index}
  * @see OpenUrlStrategy
  */
-@Value(semanticsProviderName =
+@Value(
+        logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.LocalResourcePath",
+        semanticsProviderName =
         "org.apache.isis.core.metamodel.facets.value.localrespath.LocalResourcePathValueSemanticsProvider")
-@DomainObject(logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.LocalResourcePath")
 @XmlJavaTypeAdapter(LocalResourcePath.JaxbToStringAdapter.class)   // for JAXB view model support
 public final class LocalResourcePath implements Serializable {
 
diff --git a/api/applib/src/main/java/org/apache/isis/applib/value/Markup.java b/api/applib/src/main/java/org/apache/isis/applib/value/Markup.java
index e0f059b..9325344 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/value/Markup.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/value/Markup.java
@@ -27,7 +27,6 @@ import javax.xml.bind.annotation.adapters.XmlAdapter;
 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 
 import org.apache.isis.applib.IsisModuleApplib;
-import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.applib.annotation.Value;
 import org.apache.isis.commons.internal.base._Strings;
 
@@ -37,9 +36,10 @@ import org.apache.isis.commons.internal.base._Strings;
  *
  * @since 2.0 {@index}
  */
-@Value(semanticsProviderName =
+@Value(
+        logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.Markup",
+        semanticsProviderName =
         "org.apache.isis.core.metamodel.facets.value.markup.MarkupValueSemanticsProvider")
-@DomainObject(logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.Markup")
 @XmlJavaTypeAdapter(Markup.JaxbToStringAdapter.class)   // for JAXB view model support
 public final class Markup implements HasHtml, Serializable {
 
@@ -55,6 +55,7 @@ public final class Markup implements HasHtml, Serializable {
         this.html = html!=null ? html : "";
     }
 
+    @Override
     public String asHtml() {
         return html;
     }
diff --git a/api/applib/src/main/java/org/apache/isis/applib/value/Password.java b/api/applib/src/main/java/org/apache/isis/applib/value/Password.java
index 58ed106..81746f1 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/value/Password.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/value/Password.java
@@ -26,7 +26,6 @@ import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 
 import org.apache.isis.applib.IsisModuleApplib;
-import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.applib.annotation.Value;
 
 /**
@@ -34,9 +33,10 @@ import org.apache.isis.applib.annotation.Value;
  *
  * @since 1.x {@index}
  */
-@Value(semanticsProviderName = "org.apache.isis.core.metamodel.facets.value.password.PasswordValueSemanticsProvider")
+@Value(
+        logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.Password",
+        semanticsProviderName = "org.apache.isis.core.metamodel.facets.value.password.PasswordValueSemanticsProvider")
 @XmlAccessorType(XmlAccessType.FIELD)
-@DomainObject(logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.Password")
 // @XmlJavaTypeAdapter(Password.JaxbToStringAdapter.class) // TODO: not automatically registered because not secure enough.  Instead we should set up some sort of mechanism to encrypt.
 @lombok.Value
 public class Password implements Serializable {
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/value/annotation/ValueAnnotationFacetFactory.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/value/annotation/ValueAnnotationFacetFactory.java
index 6215a85..5050380 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/value/annotation/ValueAnnotationFacetFactory.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/facets/value/annotation/ValueAnnotationFacetFactory.java
@@ -18,10 +18,13 @@
  */
 package org.apache.isis.core.metamodel.facets.value.annotation;
 
+import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.core.metamodel.facetapi.FacetUtil;
 import org.apache.isis.core.metamodel.facetapi.FeatureType;
+import org.apache.isis.core.metamodel.facetapi.IdentifiedHolder;
 import org.apache.isis.core.metamodel.facets.FacetFactoryAbstract;
 import org.apache.isis.core.metamodel.facets.ObjectTypeFacetFactory;
+import org.apache.isis.core.metamodel.specloader.validator.ValidationFailure;
 
 import lombok.val;
 
@@ -42,6 +45,14 @@ implements
         // @Value(logicalTypeName=...)
         val valueIfAny = processClassContext.synthesizeOnType(org.apache.isis.applib.annotation.Value.class);
         FacetUtil.addFacet(LogicalTypeFacetForValueAnnotation.create(valueIfAny, cls, facetHolder));
+
+        // conflicting type semantics validation
+        if(valueIfAny.isPresent()
+                && processClassContext.synthesizeOnType(DomainObject.class).isPresent()) {
+            ValidationFailure.raiseFormatted((IdentifiedHolder)facetHolder,
+                    "Cannot use @DomainObject and @Value on the same type: %s", cls.getName());
+        }
+
     }
 
 
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/appfeat/ApplicationFeatureDefault.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/appfeat/ApplicationFeatureDefault.java
index 2359d10..98de5d9 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/appfeat/ApplicationFeatureDefault.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/appfeat/ApplicationFeatureDefault.java
@@ -24,7 +24,6 @@ import java.util.OptionalInt;
 import java.util.SortedSet;
 
 import org.apache.isis.applib.IsisModuleApplib;
-import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.applib.annotation.SemanticsOf;
 import org.apache.isis.applib.annotation.Value;
 import org.apache.isis.applib.services.appfeat.ApplicationFeature;
@@ -51,8 +50,7 @@ import lombok.Setter;
  *     {@link ApplicationFeatureRepository}.
  * </p>
  */
-@Value
-@DomainObject(logicalTypeName = IsisModuleApplib.NAMESPACE + ".services.appfeat.ApplicationFeature")
+@Value(logicalTypeName = IsisModuleApplib.NAMESPACE + ".services.appfeat.ApplicationFeature")
 public class ApplicationFeatureDefault
 implements
 ApplicationFeature,
diff --git a/regressiontests/stable-domainmodel/src/test/java/org/apache/isis/testdomain/domainmodel/DomainModelTest_usingBadDomain.java b/regressiontests/stable-domainmodel/src/test/java/org/apache/isis/testdomain/domainmodel/DomainModelTest_usingBadDomain.java
index 5dc2b9b..090d089 100644
--- a/regressiontests/stable-domainmodel/src/test/java/org/apache/isis/testdomain/domainmodel/DomainModelTest_usingBadDomain.java
+++ b/regressiontests/stable-domainmodel/src/test/java/org/apache/isis/testdomain/domainmodel/DomainModelTest_usingBadDomain.java
@@ -55,6 +55,7 @@ import org.apache.isis.testdomain.conf.Configuration_headless;
 import org.apache.isis.testdomain.model.bad.AmbiguousMixinAnnotations;
 import org.apache.isis.testdomain.model.bad.AmbiguousTitle;
 import org.apache.isis.testdomain.model.bad.Configuration_usingInvalidDomain;
+import org.apache.isis.testdomain.model.bad.InvalidContradictingTypeSemantics;
 import org.apache.isis.testdomain.model.bad.InvalidActionOverloading;
 import org.apache.isis.testdomain.model.bad.InvalidLogicalTypeNameClash;
 import org.apache.isis.testdomain.model.bad.InvalidOrphanedActionSupport;
@@ -167,7 +168,7 @@ class DomainModelTest_usingBadDomain {
                 InvalidLogicalTypeNameClash.VariantC.class));
     }
 
-    void assertLogicalTypeNameClashesAmong(Can<Class<?>> types) {
+    private void assertLogicalTypeNameClashesAmong(Can<Class<?>> types) {
 
         val typeLiteralList = types.stream()
                 .map(t->t.getName())
@@ -182,6 +183,13 @@ class DomainModelTest_usingBadDomain {
                                     + typeLiteralList)));
     }
 
+    @Test
+    void contradictingTypeSemantics_shouldFailValidation() {
+        validator.anyMatchesContaining(
+                Identifier.classIdentifier(LogicalType.fqcn(InvalidContradictingTypeSemantics.class)),
+                "Cannot use @DomainObject and @Value on the same type: "
+                + InvalidContradictingTypeSemantics.class.getName());
+    }
 
     @ParameterizedTest
     @MethodSource("provideAmbiguousMixins")
diff --git a/regressiontests/stable/src/main/java/org/apache/isis/testdomain/model/bad/InvalidContradictingTypeSemantics.java b/regressiontests/stable/src/main/java/org/apache/isis/testdomain/model/bad/InvalidContradictingTypeSemantics.java
new file mode 100644
index 0000000..7bfe3be
--- /dev/null
+++ b/regressiontests/stable/src/main/java/org/apache/isis/testdomain/model/bad/InvalidContradictingTypeSemantics.java
@@ -0,0 +1,29 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one
+ *  or more contributor license agreements.  See the NOTICE file
+ *  distributed with this work for additional information
+ *  regarding copyright ownership.  The ASF licenses this file
+ *  to you 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.
+ */
+package org.apache.isis.testdomain.model.bad;
+
+import org.apache.isis.applib.annotation.DomainObject;
+import org.apache.isis.applib.annotation.Value;
+
+// mix of semantics not allowed: should fail validation
+@Value
+@DomainObject
+public class InvalidContradictingTypeSemantics {
+
+}
diff --git a/regressiontests/stable/src/main/java/org/apache/isis/testdomain/model/bad/InvalidLogicalTypeNameClash.java b/regressiontests/stable/src/main/java/org/apache/isis/testdomain/model/bad/InvalidLogicalTypeNameClash.java
index 20c2e6f..4d8097c 100644
--- a/regressiontests/stable/src/main/java/org/apache/isis/testdomain/model/bad/InvalidLogicalTypeNameClash.java
+++ b/regressiontests/stable/src/main/java/org/apache/isis/testdomain/model/bad/InvalidLogicalTypeNameClash.java
@@ -57,11 +57,4 @@ public class InvalidLogicalTypeNameClash {
     }
 
 
-    // mix of semantics not allowed: should fail validation
-    @Value
-    @DomainObject
-    public static class VariantD {
-
-    }
-
 }
diff --git a/valuetypes/asciidoc/applib/src/main/java/org/apache/isis/valuetypes/asciidoc/applib/value/AsciiDoc.java b/valuetypes/asciidoc/applib/src/main/java/org/apache/isis/valuetypes/asciidoc/applib/value/AsciiDoc.java
index 84e325b..b3f259d 100644
--- a/valuetypes/asciidoc/applib/src/main/java/org/apache/isis/valuetypes/asciidoc/applib/value/AsciiDoc.java
+++ b/valuetypes/asciidoc/applib/src/main/java/org/apache/isis/valuetypes/asciidoc/applib/value/AsciiDoc.java
@@ -23,7 +23,6 @@ import java.io.Serializable;
 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 
 import org.apache.isis.applib.IsisModuleApplib;
-import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.applib.value.HasHtml;
 import org.apache.isis.valuetypes.asciidoc.applib.jaxb.AsciiDocJaxbAdapter;
 
@@ -32,8 +31,9 @@ import org.apache.isis.valuetypes.asciidoc.applib.jaxb.AsciiDocJaxbAdapter;
  *
  * @since 2.0 {@index}
  */
-@org.apache.isis.applib.annotation.Value(semanticsProviderName = "org.apache.isis.valuetypes.asciidoc.metamodel.facets.AsciiDocValueSemanticsProvider")
-@DomainObject(logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.AsciiDoc")
+@org.apache.isis.applib.annotation.Value(
+        logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.AsciiDoc",
+        semanticsProviderName = "org.apache.isis.valuetypes.asciidoc.metamodel.facets.AsciiDocValueSemanticsProvider")
 @XmlJavaTypeAdapter(AsciiDocJaxbAdapter.class)  // for JAXB view model support
 public class AsciiDoc implements HasHtml, Serializable {
 
diff --git a/valuetypes/markdown/applib/src/main/java/org/apache/isis/valuetypes/markdown/applib/value/Markdown.java b/valuetypes/markdown/applib/src/main/java/org/apache/isis/valuetypes/markdown/applib/value/Markdown.java
index c7979ba..dab097d 100644
--- a/valuetypes/markdown/applib/src/main/java/org/apache/isis/valuetypes/markdown/applib/value/Markdown.java
+++ b/valuetypes/markdown/applib/src/main/java/org/apache/isis/valuetypes/markdown/applib/value/Markdown.java
@@ -23,7 +23,6 @@ import java.io.Serializable;
 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 
 import org.apache.isis.applib.IsisModuleApplib;
-import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.applib.value.HasHtml;
 import org.apache.isis.valuetypes.markdown.applib.jaxb.MarkdownJaxbAdapter;
 
@@ -32,8 +31,8 @@ import org.apache.isis.valuetypes.markdown.applib.jaxb.MarkdownJaxbAdapter;
  *
  */
 @org.apache.isis.applib.annotation.Value(
+        logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.Markdown",
         semanticsProviderName = "org.apache.isis.valuetypes.markdown.metamodel.facets.MarkdownValueSemanticsProvider")
-@DomainObject(logicalTypeName = IsisModuleApplib.NAMESPACE + ".value.Markdown")
 @XmlJavaTypeAdapter(MarkdownJaxbAdapter.class)  // for JAXB view model support
 public class Markdown implements HasHtml, Serializable {