You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2020/08/09 09:33:27 UTC

[isis] 01/01: ISIS-2222: wip - @Action#associateWith plus fixes for Property#domainEvent

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

danhaywood pushed a commit to branch ISIS-2222
in repository https://gitbox.apache.org/repos/asf/isis.git

commit 0c9ede2773a293d0847038a3c2b7a39c5c1332ec
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sun Aug 9 10:17:32 2020 +0100

    ISIS-2222: wip - @Action#associateWith plus fixes for Property#domainEvent
    
    also:
    - improves tag handling of asciidoc to be more lenient to spaces.
---
 .../demoapp/dom/_infra/resources/TagHandler.java   |  15 +++-
 .../ActionAssociateWithVm-description.adoc         | 100 ++++++---------------
 .../associateWith/ActionAssociateWithVm.java       |  28 +++---
 ...ActionAssociateWithVm_updateOtherProperty.java} |  34 +++----
 .../ActionDomainEventVm-description.adoc           |   1 -
 .../Action/domainEvent/ActionDomainEventVm.java    |   2 +
 .../ActionDomainEventVm_mixinUpdateText.java       |   2 +
 .../PropertyDomainEventVm-description.adoc         |   4 +-
 .../PropertyDomainEventVm_controlTextEditing.java  |   6 +-
 ...alityVm_updateMandatoryWithParameterLayout.java |   2 +-
 10 files changed, 86 insertions(+), 108 deletions(-)

diff --git a/examples/demo/domain/src/main/java/demoapp/dom/_infra/resources/TagHandler.java b/examples/demo/domain/src/main/java/demoapp/dom/_infra/resources/TagHandler.java
index 17ca5de..e503523 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/_infra/resources/TagHandler.java
+++ b/examples/demo/domain/src/main/java/demoapp/dom/_infra/resources/TagHandler.java
@@ -1,6 +1,7 @@
 package demoapp.dom._infra.resources;
 
 import java.util.Map;
+import java.util.regex.Pattern;
 
 class TagHandler {
 
@@ -16,16 +17,26 @@ class TagHandler {
             return line;
         }
 
-        if (line.contains(String.format("//tag::%s[]", tagsValue))) {
+        if (matches(line, "tag")) {
             within = true;
             return null;
         }
 
-        if (line.contains(String.format("//end::%s[]", tagsValue))) {
+        if (matches(line, "end")) {
             within = false;
             return null;
         }
 
         return within ? line : null;
     }
+
+    private boolean matches(String line, String macro) {
+        final Pattern pattern = Pattern.compile("//\\s*" +
+                macro +
+                "::" +
+                tagsValue +
+                "\\[]\\s*");
+        return pattern.matcher(line).matches();
+    }
+
 }
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/associateWith/ActionAssociateWithVm-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/associateWith/ActionAssociateWithVm-description.adoc
index 7ef42ce..7cc601e 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/associateWith/ActionAssociateWithVm-description.adoc
+++ b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/associateWith/ActionAssociateWithVm-description.adoc
@@ -4,115 +4,73 @@ The `associateWith` semantic specifies an action has a relationship with another
 +
 This can of course be overridden using `@ActionLayout` or the layout file
 
-* For collections,
-
-If no `domainEvent` is specified on the action itself, then the domain event class can be specified at the class level using `@DomainObject#actionDomainEvent`.
-And if not specified at the class level, then an instance of `org.apache.isis.applib.events.domain.ActionDomainEvent.Default` is emitted as the fallback.
+* For collections, the association is also used for layout purposes, rendering the action near to the collection.
++
+However, it is also used at a deeper level, because the action may have a collection parameter which is the same type as the collection elements.
+In the Wicket viewer, the collection is rendered with checkboxes; those selected objects are used as defaults for the action collection parameter.
 
-[TIP]
-====
-The fallback domain event can be suppressed using the `isis.applib.annotation.action.domain-event.post-for-default` configuration property.
-====
 
-== Annotated Actions
+== Associated with Properties
 
-The demo defines two actions that are annotated using `domainEvent` semantic:
+The `AssociateWithVm` defines two properties, `text` and `anotherProperty`:
 
-* in the `ActionAssociateWithVm` is a regular action, "updateText":
-+
 [source,java]
 ----
-include::ActionDomainEventVm.java[tags=class]
+include::ActionAssociateWithVm.java[tags=class]
 ----
-<.> the event class to emit; genericised by the target type
-<.> indicates that the framework should emit this type
 
-* The `ActionAssociateWithVm_mixinProperty` defines a mixin action, also annotated:
-+
-[source,java]
+The regular `updateText` action is associated with the `text` property:
+
+[source,java,indent=0]
 ----
-include::ActionDomainEventVm_mixinUpdateText.java[tags=class]
+include::ActionAssociateWithVm.java[tags=action-associateWith-property]
 ----
+<.> indicates the property to associate with
+<.> if there are multiple actions associated with the property, indicates their order in the UI
 
-<.> the event class to emit; genericised by the target type
-+
-TIP: it's idiomatic to use a nested static class here.
-
-<.> indicates that the framework should emit this type
+Meanwhile the mixin `updateOtherProperty` is associated with the `otherProperty` property:
 
-== Subscriber
-
-The `ActionDomainEventControlService` is the subscriber:
-
-[source,java]
+[source,java,indent=0]
 ----
-include::subscribers/ActionDomainEventControlService.java[tags=class]
+include::ActionAssociateWithVm_updateOtherProperty.java[tags=class]
 ----
-<.> holds which "strategy" should be used to modify the interactions with the text field
-<.> subscribes using the Spring event bus
+<.> indicates the property to associate with
+<.> indicates their order in the UI
 
-== Influencing the Interaction
 
-The mechanisms to influence the interactions are implemented as an enum.
-The `DO_NOTHING` enum, unsurprisingly, does nothing:
+== Collection
 
 [source,java]
 ----
-include::subscribers/ActionDomainEventControlStrategy.java[tags=class]
+include::ActionAssociateWithVm.java[tags=children]
 ----
 
-There are seven further options:
 
-* hide (two examples)
-+
-[source,java,indent=0]
+[source,java]
 ----
-include::subscribers/ActionDomainEventControlStrategy.java[tags=hide]
+include::child/ActionAssociateWithChildVm.java[tags=class]
 ----
 
-* disable (two examples)
-+
-[source,java,indent=0]
+[source,java]
 ----
-include::subscribers/ActionDomainEventControlStrategy.java[tags=disable]
+include::ActionAssociateWithVm.java[tags=action-associateWith-collection]
 ----
 
-* validate
-+
-[source,java,indent=0]
-----
-include::subscribers/ActionDomainEventControlStrategy.java[tags=validate]
-----
 
-* executing
-+
-[source,java,indent=0]
-----
-include::subscribers/ActionDomainEventControlStrategy.java[tags=executing]
-----
+== Mixin Actions
 
-* executed
-+
-[source,java,indent=0]
+[source,java]
 ----
-include::subscribers/ActionDomainEventControlStrategy.java[tags=executed]
+include::child/ActionAssociateWithVm_makeFavorite.java[tags=class]
 ----
 
-=== Selecting the Strategy
-
-Selecting which strategy is in force is implemented using two mixins which work together:
-
-* the `controlUpdateText` mixin property just surfaces the selected strategy as a read-only value:
-+
 [source,java]
 ----
-include::subscribers/ActionDomainEventVm_controlUpdateText.java[tags=class]
+include::child/ActionAssociateWithVm_noLongerFavorite.java[tags=class]
 ----
 
-* while the `controlUpdateTextInvocation` mixin action allows the strategy to be changed:
-+
 [source,java]
 ----
-include::subscribers/ActionDomainEventVm_controlUpdateTextInvocation.java[tags=class]
+include::child/ActionAssociateWithVm_noLongerFavorites.java[tags=class]
 ----
 
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/associateWith/ActionAssociateWithVm.java b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/associateWith/ActionAssociateWithVm.java
index 51568ee..0d1cbb3 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/associateWith/ActionAssociateWithVm.java
+++ b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/associateWith/ActionAssociateWithVm.java
@@ -60,9 +60,8 @@ import demoapp.dom.types.Samples;
 @NoArgsConstructor
 //tag::class[]
 public class ActionAssociateWithVm implements HasAsciiDocDescription {
-    // ...
-//end::class[]
 
+//end::class[]
     public ActionAssociateWithVm(String text) {
         this.text = text;
     }
@@ -71,7 +70,7 @@ public class ActionAssociateWithVm implements HasAsciiDocDescription {
         return "Action#associateWith";
     }
 
-//tag::text[]
+//tag::class[]
     @Property()
     @MemberOrder(name = "annotation", sequence = "1")
     @XmlElement(required = true)
@@ -82,27 +81,30 @@ public class ActionAssociateWithVm implements HasAsciiDocDescription {
     @MemberOrder(name = "annotation", sequence = "2")
     @XmlElement(required = true)
     @Getter @Setter
-    private String anotherProperty;
-//end::text[]
+    private String otherProperty;
 
-//tag:children[]
+    // ...
+//end::class[]
+
+//tag::children[]
     @Collection()
     @CollectionLayout()
     @Getter
     private List<ActionAssociateWithChildVm> children = new ArrayList<>();
-//end:children[]
+//end::children[]
 
-//tag:children-favorites[]
+//tag::children-favorites[]
     @Collection()
     @CollectionLayout()
     @Getter
     private List<ActionAssociateWithChildVm> favorites = new ArrayList<>();
-//end:children-favorites[]
+//end::children-favorites[]
 
 //tag::action-associateWith-property[]
     @Action(
             semantics = SemanticsOf.IDEMPOTENT
-            , associateWith = "text", associateWithSequence = "1"   // <.>
+            , associateWith = "text"                // <.>
+            , associateWithSequence = "1"           // <.>
     )
     @ActionLayout(
         describedAs =
@@ -124,8 +126,7 @@ public class ActionAssociateWithVm implements HasAsciiDocDescription {
     )
     @ActionLayout(
         describedAs =
-            "@Action(associateWith = \"children\"" +
-                     ", associateWithSequence = \"1\")"
+            "@Action(associateWith = \"children\", associateWithSequence = \"1\")"
     )
     public ActionAssociateWithVm addChild(final String value) {
         val childVm = new ActionAssociateWithChildVm(value);
@@ -142,8 +143,7 @@ public class ActionAssociateWithVm implements HasAsciiDocDescription {
     )
     @ActionLayout(
         describedAs =
-            "@Action(associateWith = \"children\"" +
-                    ", associateWithSequence = \"2\")"
+            "@Action(associateWith = \"children\", associateWithSequence = \"2\")"
     )
     public ActionAssociateWithVm removeChild(final ActionAssociateWithChildVm child) {
         getChildren().removeIf(x -> Objects.equals(x.getValue(), child.getValue()));
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm_mixinUpdateText.java b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/associateWith/ActionAssociateWithVm_updateOtherProperty.java
similarity index 55%
copy from examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm_mixinUpdateText.java
copy to examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/associateWith/ActionAssociateWithVm_updateOtherProperty.java
index 560c9f8..4f11a87 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm_mixinUpdateText.java
+++ b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/associateWith/ActionAssociateWithVm_updateOtherProperty.java
@@ -16,41 +16,41 @@
  *  specific language governing permissions and limitations
  *  under the License.
  */
-package demoapp.dom.annotDomain.Action.domainEvent;
+package demoapp.dom.annotDomain.Action.associateWith;
+
+import java.util.List;
+import java.util.Objects;
 
 import org.apache.isis.applib.annotation.Action;
 import org.apache.isis.applib.annotation.ActionLayout;
-import org.apache.isis.applib.annotation.MemberOrder;
-import org.apache.isis.applib.annotation.SemanticsOf;
-import org.apache.isis.applib.events.domain.ActionDomainEvent;
 
 import lombok.RequiredArgsConstructor;
 
+import demoapp.dom.annotDomain.Action.associateWith.ActionAssociateWithVm;
+
 
 //tag::class[]
 @Action(
-    semantics = SemanticsOf.SAFE
-    , domainEvent =
-        ActionDomainEventVm_mixinUpdateText.DomainEvent.class           // <.>
-    , associateWith = "text", associateWithSequence = "2"
+    associateWith = "otherProperty"                                 // <.>
+    , associateWithSequence = "1"                                   // <.>
 )
 @ActionLayout(
     describedAs =
-        "@Action(domainEvent = ActionDomainEventVm_mixinUpdateText.DomainEvent.class)"
+        "@Action(" +
+            "associateWith = \"otherProperty\"" +
+            ", associateWithSequence = \"1\")"
 )
 @RequiredArgsConstructor
-public class ActionDomainEventVm_mixinUpdateText {
-
-    public static class DomainEvent                                     // <.>
-            extends ActionDomainEvent<ActionDomainEventVm> {}
+public class ActionAssociateWithVm_updateOtherProperty {
 
-    private final ActionDomainEventVm actionDomainEventVm;
+    private final ActionAssociateWithVm actionAssociateWithVm;
 
-    public ActionDomainEventVm act(final String text) {
-        return actionDomainEventVm;
+    public ActionAssociateWithVm act(String newValue) {
+        actionAssociateWithVm.setOtherProperty(newValue);
+        return actionAssociateWithVm;
     }
     public String default0Act() {
-        return actionDomainEventVm.getText();
+        return actionAssociateWithVm.getOtherProperty();
     }
 }
 //end::class[]
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm-description.adoc
index a1a700c..380ac57 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm-description.adoc
+++ b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm-description.adoc
@@ -41,7 +41,6 @@ include::ActionDomainEventVm_mixinUpdateText.java[tags=class]
 <.> the event class to emit; genericised by the target type
 +
 TIP: it's idiomatic to use a nested static class here.
-
 <.> indicates that the framework should emit this type
 
 == Subscriber
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm.java b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm.java
index f495a8c..52a8cc8 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm.java
+++ b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm.java
@@ -30,6 +30,8 @@ import org.apache.isis.applib.annotation.DomainObject;
 import org.apache.isis.applib.annotation.MemberOrder;
 import org.apache.isis.applib.annotation.Nature;
 import org.apache.isis.applib.annotation.Property;
+import org.apache.isis.applib.annotation.PropertyLayout;
+import org.apache.isis.applib.annotation.Repainting;
 import org.apache.isis.applib.annotation.SemanticsOf;
 import org.apache.isis.applib.events.domain.ActionDomainEvent;
 
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm_mixinUpdateText.java b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm_mixinUpdateText.java
index 560c9f8..0c9e3e8 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm_mixinUpdateText.java
+++ b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Action/domainEvent/ActionDomainEventVm_mixinUpdateText.java
@@ -21,6 +21,7 @@ package demoapp.dom.annotDomain.Action.domainEvent;
 import org.apache.isis.applib.annotation.Action;
 import org.apache.isis.applib.annotation.ActionLayout;
 import org.apache.isis.applib.annotation.MemberOrder;
+import org.apache.isis.applib.annotation.Redirect;
 import org.apache.isis.applib.annotation.SemanticsOf;
 import org.apache.isis.applib.events.domain.ActionDomainEvent;
 
@@ -47,6 +48,7 @@ public class ActionDomainEventVm_mixinUpdateText {
     private final ActionDomainEventVm actionDomainEventVm;
 
     public ActionDomainEventVm act(final String text) {
+        actionDomainEventVm.setText(text);
         return actionDomainEventVm;
     }
     public String default0Act() {
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/domainEvent/PropertyDomainEventVm-description.adoc b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/domainEvent/PropertyDomainEventVm-description.adoc
index 87f67f9..cabe55a 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/domainEvent/PropertyDomainEventVm-description.adoc
+++ b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/domainEvent/PropertyDomainEventVm-description.adoc
@@ -19,7 +19,7 @@ The fallback domain event can be suppressed using the `isis.applib.annotation.pr
 
 == Annotated Property
 
-In the demo, the `PropertyDomainEventVm` class defines an editable property, "text", annotated with `domainEvent`:
+In the demo, the `PropertyDomainEventVmMakingThisLongerAndLonger` class defines an editable property, "text", annotated with `domainEvent`:
 
 [source,java]
 ----
@@ -105,4 +105,6 @@ include::subscribers/PropertyDomainEventVm_controlText.java[tags=class]
 ----
 include::subscribers/PropertyDomainEventVm_controlTextEditing.java[tags=class]
 ----
+<.> forces the page to redraw.
+Necessary because the text property's state change
 
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/domainEvent/subscribers/PropertyDomainEventVm_controlTextEditing.java b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/domainEvent/subscribers/PropertyDomainEventVm_controlTextEditing.java
index f8bdb58..c3c4035 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/domainEvent/subscribers/PropertyDomainEventVm_controlTextEditing.java
+++ b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/domainEvent/subscribers/PropertyDomainEventVm_controlTextEditing.java
@@ -23,6 +23,7 @@ import javax.inject.Inject;
 import org.apache.isis.applib.annotation.Action;
 import org.apache.isis.applib.annotation.ActionLayout;
 import org.apache.isis.applib.annotation.PromptStyle;
+import org.apache.isis.applib.annotation.Redirect;
 import org.apache.isis.applib.annotation.SemanticsOf;
 
 import lombok.RequiredArgsConstructor;
@@ -35,7 +36,10 @@ import demoapp.dom.annotDomain.Property.domainEvent.PropertyDomainEventVm;
     semantics = SemanticsOf.IDEMPOTENT
     , associateWith = "controlText", associateWithSequence = "1"
 )
-@ActionLayout(promptStyle = PromptStyle.INLINE)
+@ActionLayout(
+        promptStyle = PromptStyle.INLINE
+        , redirectPolicy = Redirect.EVEN_IF_SAME                        // <.>
+)
 @RequiredArgsConstructor
 public class PropertyDomainEventVm_controlTextEditing {
 
diff --git a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/optionality/PropertyOptionalityVm_updateMandatoryWithParameterLayout.java b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/optionality/PropertyOptionalityVm_updateMandatoryWithParameterLayout.java
index fa141ea..1d2ddfc 100644
--- a/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/optionality/PropertyOptionalityVm_updateMandatoryWithParameterLayout.java
+++ b/examples/demo/domain/src/main/java/demoapp/dom/annotDomain/Property/optionality/PropertyOptionalityVm_updateMandatoryWithParameterLayout.java
@@ -50,7 +50,7 @@ public class PropertyOptionalityVm_updateMandatoryWithParameterLayout {
     }
 //end::annotation[]
     public String default0Act() {
-        return propertyOptionalityVm.getPropertyUsingAnnotation();
+        return propertyOptionalityVm.getMandatoryPropertyUsingAnnotation();
     }
 
 }