#87 - updates to index

Author: danhaywood

adocs/documentation/src/main/asciidoc/index.adoc

@@ -7,7 +7,10 @@
 pass:[<br/>]
 
 The Incode Platform provides a number of _modules_ for use with the link:http://isis.apache.org[Apache Isis] framework.
-The platform also provides a _"quickstart"_ app which can be used to quickly set up your own pre-configured applications.
+These are all released as ready-to-use binaries.
+In addition, the _examples_ modules are provided as source code - which provide some supporting subdomains such as notes and documents - can be easily forked and adapted for use in your own applications.
+
+The platform also provides a _"quickstart"_ Maven archetype which can be used to quickly set up your own pre-configured applications.
 
 
 
@@ -165,4 +168,10 @@ xref:modules/dom/tags/dom-tags.adoc#[Tags]
 |===
 
 
+The xref:modules/lib/lib.adoc#[_Libraries_], xref:modules/spi/spi.adoc#[_SPI Implementations_], xref:modules/wkt/wkt.adoc#[_Wicket Components_] and xref:modules/ext/ext.adoc#[_Extensions_] are intended to be used as ready-to-use binaries.
+So far as possible these modules will support semantic versioning to prevent breakages between versions.
+If you have enhancements to these, raise a pull request.
 
+In contrast, the xref:modules/dom/dom.adoc#[_Example Subdomains & Libraries_] are provided as a "starter-for-ten" for use within your own applications.
+You are welcome to raise pull requests, but you are also encouraged just to fork and adapt the code as you see fit.
+For this reason, semantic versioning is not being used for the examples; new versions could have breaking changes.

modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/dom/DemoObject.java modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/dom/AliasedObject.java

@@ -39,7 +39,7 @@
 @AllArgsConstructor
 @Builder
 @XmlJavaTypeAdapter(PersistentEntityAdapter.class)
-public class DemoObject implements Comparable<DemoObject> {
+public class AliasDemoObject implements Comparable<AliasDemoObject> {
 
 
     @javax.jdo.annotations.Column(allowsNull="false")
@@ -54,12 +54,12 @@ public String toString() {
     }
 
     @Override
-    public int compareTo(final DemoObject other) {
-        return Ordering.natural().onResultOf(DemoObject::getName).compare(this, other);
+    public int compareTo(final AliasDemoObject other) {
+        return Ordering.natural().onResultOf(AliasDemoObject::getName).compare(this, other);
     }
 
 
-    // required by DemoObjectData#findUsing
+    // required by AliasDemoObjectData#findUsing
     @Override
     public boolean equals(final Object o) {
         return ObjectContracts.equals(this,o, "name");

modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/dom/DemoObject.layout.xml modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/dom/AliasedObject.layout.xml

@@ -19,29 +19,29 @@
         named = "Demo",
         menuOrder = "10.1"
 )
-public class DemoObjectMenu {
+public class AliasDemoObjectMenu {
 
 
     @Action(semantics = SemanticsOf.SAFE)
     @ActionLayout(bookmarking = BookmarkPolicy.AS_ROOT)
     @MemberOrder(sequence = "1")
-    public List<DemoObject> listAllDemoObjects() {
+    public List<AliasDemoObject> listAllDemoObjects() {
         return repository.listAll();
     }
 
 
     @MemberOrder(sequence = "2")
-    public DemoObject createDemoObject(final String name) {
+    public AliasDemoObject createDemoObject(final String name) {
         return repository.create(name);
     }
 
     @MemberOrder(sequence = "3")
-    public List<DemoObject> findDemoObjectByName(final String name) {
+    public List<AliasDemoObject> findDemoObjectByName(final String name) {
         return repository.findByName(name);
     }
 
-    @javax.inject.Inject 
-    DemoObjectRepository repository;
+    @javax.inject.Inject
+    AliasDemoObjectRepository repository;
 
 
 }

modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/dom/DemoObject.png modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/dom/AliasedObject.png

@@ -10,24 +10,24 @@
 
 @DomainService(
         nature = NatureOfService.DOMAIN,
-        repositoryFor = DemoObject.class
+        repositoryFor = AliasDemoObject.class
 )
-public class DemoObjectRepository {
+public class AliasDemoObjectRepository {
 
-    public List<DemoObject> listAll() {
-        return repositoryService.allInstances(DemoObject.class);
+    public List<AliasDemoObject> listAll() {
+        return repositoryService.allInstances(AliasDemoObject.class);
     }
 
-    public List<DemoObject> findByName(final String name) {
+    public List<AliasDemoObject> findByName(final String name) {
         return repositoryService.allMatches(
                 new QueryDefault<>(
-                        DemoObject.class,
+                        AliasDemoObject.class,
                         "findByName",
                         "name", name));
     }
 
-    public DemoObject create(final String name) {
-        final DemoObject object = new DemoObject(name);
+    public AliasDemoObject create(final String name) {
+        final AliasDemoObject object = new AliasDemoObject(name);
         serviceRegistry.injectServicesInto(object);
         repositoryService.persist(object);
         return object;

modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/dom/DemoObjectMenu.java modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/dom/AliasedObjectMenu.java

@@ -3,7 +3,7 @@
 import org.apache.isis.applib.annotation.Programmatic;
 import org.apache.isis.applib.services.registry.ServiceRegistry2;
 
-import org.incode.example.alias.demo.shared.dom.DemoObject;
+import org.incode.example.alias.demo.shared.dom.AliasDemoObject;
 import org.incode.module.fixturesupport.dom.data.DemoData;
 import org.incode.module.fixturesupport.dom.data.DemoDataPersistAbstract;
 
@@ -14,7 +14,7 @@
 @AllArgsConstructor
 @Getter
 @Accessors(chain = true)
-public enum DemoObjectData implements DemoData<DemoObjectData, DemoObject> {
+public enum AliasDemoObjectData implements DemoData<AliasDemoObjectData, AliasDemoObject> {
 
     Foo("Foo"),
     Bar("Bar"),
@@ -25,25 +25,25 @@ public enum DemoObjectData implements DemoData<DemoObjectData, DemoObject> {
     private final String name;
 
     @Programmatic
-    public DemoObject asDomainObject() {
-        return DemoObject.builder()
+    public AliasDemoObject asDomainObject() {
+        return AliasDemoObject.builder()
                 .name(name)
                 .build();
     }
 
     @Programmatic
-    public DemoObject persistUsing(final ServiceRegistry2 serviceRegistry) {
+    public AliasDemoObject persistUsing(final ServiceRegistry2 serviceRegistry) {
         return Util.persist(this, serviceRegistry);
     }
 
     @Programmatic
-    public DemoObject findUsing(final ServiceRegistry2 serviceRegistry) {
+    public AliasDemoObject findUsing(final ServiceRegistry2 serviceRegistry) {
         return Util.firstMatch(this, serviceRegistry);
     }
 
-    public static class PersistScript extends DemoDataPersistAbstract<PersistScript, DemoObjectData, DemoObject> {
+    public static class PersistScript extends DemoDataPersistAbstract<PersistScript, AliasDemoObjectData, AliasDemoObject> {
         public PersistScript() {
-            super(DemoObjectData.class);
+            super(AliasDemoObjectData.class);
         }
     }
 

modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/dom/DemoObjectRepository.java modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/dom/AliasedObjectRepository.java

@@ -2,15 +2,15 @@
 
 import org.apache.isis.applib.fixturescripts.FixtureScript;
 
-import org.incode.example.alias.demo.shared.dom.DemoObject;
-import org.incode.example.alias.demo.shared.dom.DemoObjectMenu;
+import org.incode.example.alias.demo.shared.dom.AliasDemoObject;
+import org.incode.example.alias.demo.shared.dom.AliasDemoObjectMenu;
 
 import lombok.Getter;
 import lombok.Setter;
 import lombok.experimental.Accessors;
 
 @Accessors(chain = true)
-public class DemoObject_create extends FixtureScript {
+public class AliasDemoObject_create extends FixtureScript {
 
     @Getter @Setter
     private String name;
@@ -19,19 +19,19 @@ public class DemoObject_create extends FixtureScript {
      * The created simple object (output).
      */
     @Getter
-    private DemoObject demoObject;
+    private AliasDemoObject aliasDemoObject;
 
 
     @Override
     protected void execute(final ExecutionContext ec) {
 
         String name = checkParam("name", ec, String.class);
 
-        this.demoObject = wrap(demoObjectMenu).createDemoObject(name);
-        ec.addResult(this, demoObject);
+        this.aliasDemoObject = wrap(aliasDemoObjectMenu).createDemoObject(name);
+        ec.addResult(this, aliasDemoObject);
     }
 
     @javax.inject.Inject
-    DemoObjectMenu demoObjectMenu;
+    AliasDemoObjectMenu aliasDemoObjectMenu;
 
 }

modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/fixture/DemoObjectData.java modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/fixture/AliasedObjectData.java

@@ -8,14 +8,14 @@
 
 import org.apache.isis.applib.fixturescripts.FixtureScript;
 
-import org.incode.example.alias.demo.shared.dom.DemoObject;
+import org.incode.example.alias.demo.shared.dom.AliasDemoObject;
 
 import lombok.Getter;
 import lombok.Setter;
 import lombok.experimental.Accessors;
 
 @Accessors(chain = true)
-public class DemoObject_createUpTo10_hardcodedData extends FixtureScript {
+public class AliasDemoObject_createUpTo10_hardcodedData extends FixtureScript {
 
     public final List<String> NAMES = Collections.unmodifiableList(Arrays.asList(
             "Foo", "Bar", "Baz", "Frodo", "Froyo", "Fizz", "Bip", "Bop", "Bang", "Boo"));
@@ -24,7 +24,7 @@ public class DemoObject_createUpTo10_hardcodedData extends FixtureScript {
     private Integer number;
 
     @Getter
-    private final List<DemoObject> demoObjects = Lists.newArrayList();
+    private final List<AliasDemoObject> aliasDemoObjects = Lists.newArrayList();
 
     @Override
     protected void execute(final ExecutionContext ec) {
@@ -40,9 +40,9 @@ protected void execute(final ExecutionContext ec) {
         // execute
         for (int i = 0; i < number; i++) {
             final String name = NAMES.get(i);
-            final DemoObject_create fs = new DemoObject_create().setName(name);
+            final AliasDemoObject_create fs = new AliasDemoObject_create().setName(name);
             ec.executeChild(this, fs.getName(), fs);
-            demoObjects.add(fs.getDemoObject());
+            aliasDemoObjects.add(fs.getAliasDemoObject());
         }
     }
 

modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/fixture/DemoObject_create.java modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/fixture/AliasedObject_create.java

@@ -2,13 +2,13 @@
 
 import org.apache.isis.applib.fixturescripts.teardown.TeardownFixtureAbstract2;
 
-import org.incode.example.alias.demo.shared.dom.DemoObject;
+import org.incode.example.alias.demo.shared.dom.AliasDemoObject;
 
-public class DemoObject_tearDown extends TeardownFixtureAbstract2 {
+public class AliasDemoObject_tearDown extends TeardownFixtureAbstract2 {
 
     @Override
     protected void execute(final ExecutionContext executionContext) {
-        deleteFrom(DemoObject.class);
+        deleteFrom(AliasDemoObject.class);
     }
 
 }

modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/fixture/DemoObject_createUpTo10_hardcodedData.java modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/fixture/AliasedObject_createUpTo10_hardcodedData.java

@@ -11,7 +11,7 @@
 import org.apache.isis.applib.annotation.NatureOfService;
 import org.apache.isis.applib.annotation.Property;
 
-import org.incode.example.alias.demo.shared.dom.DemoObject;
+import org.incode.example.alias.demo.shared.dom.AliasDemoObject;
 import org.incode.example.alias.dom.impl.Alias;
 import org.incode.example.alias.dom.impl.AliasRepository;
 import org.incode.example.alias.dom.impl.T_addAlias;
@@ -33,42 +33,42 @@ public class AliasForDemoObject extends Alias {
     @Column(allowsNull = "false", name = "demoObjectId")
     @Property(editing = Editing.DISABLED)
     @Getter @Setter
-    private DemoObject demoObject;
+    private AliasDemoObject aliasDemoObject;
 
 
     @Override
     public Object getAliased() {
-        return getDemoObject();
+        return this.getAliasDemoObject();
     }
     @Override
     protected void setAliased(final Object aliased) {
-        setDemoObject((DemoObject) aliased);
+        this.setAliasDemoObject((AliasDemoObject) aliased);
     }
 
 
     @DomainService(nature = NatureOfService.DOMAIN)
     public static class SubtypeProvider extends AliasRepository.SubtypeProviderAbstract {
         public SubtypeProvider() {
-            super(DemoObject.class, AliasForDemoObject.class);
+            super(AliasDemoObject.class, AliasForDemoObject.class);
         }
     }
 
 
     @Mixin
-    public static class _aliases extends T_aliases<DemoObject> {
-        public _aliases(final DemoObject aliased) {
+    public static class _aliases extends T_aliases<AliasDemoObject> {
+        public _aliases(final AliasDemoObject aliased) {
             super(aliased);
         }
     }
     @Mixin
-    public static class _addAlias extends T_addAlias<DemoObject> {
-        public _addAlias(final DemoObject aliased) {
+    public static class _addAlias extends T_addAlias<AliasDemoObject> {
+        public _addAlias(final AliasDemoObject aliased) {
             super(aliased);
         }
     }
     @Mixin
-    public static class _removeAlias extends T_removeAlias<DemoObject> {
-        public _removeAlias(final DemoObject aliased) {
+    public static class _removeAlias extends T_removeAlias<AliasDemoObject> {
+        public _removeAlias(final AliasDemoObject aliased) {
             super(aliased);
         }
     }

modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/fixture/DemoObject_tearDown.java modules/examples/alias/demo/src/main/java/org/incode/example/alias/demo/shared/fixture/AliasedObject_tearDown.java

@@ -0,0 +1,47 @@
+package org.incode.example.alias.integtests.tests.demo;
+
+import java.util.List;
+
+import javax.inject.Inject;
+
+import org.assertj.core.api.Assertions;
+import org.junit.Before;
+import org.junit.Test;
+
+import org.incode.example.alias.demo.shared.dom.AliasDemoObject;
+import org.incode.example.alias.demo.shared.fixture.AliasDemoObjectData;
+import org.incode.example.alias.integtests.AliasModuleIntegTestAbstract;
+import org.incode.example.alias.demo.usage.fixture.DemoObject_withAliases_create2;
+import org.incode.example.alias.demo.shared.dom.AliasDemoObjectMenu;
+
+public class AliasDemoObjectMenu_IntegTest extends AliasModuleIntegTestAbstract {
+
+    @Inject
+    AliasDemoObjectMenu aliasDemoObjectMenu;
+
+    @Before
+    public void setUpData() throws Exception {
+        fixtureScripts.runFixtureScript(new AliasDemoObjectData.PersistScript(), null);
+        fixtureScripts.runFixtureScript(new DemoObject_withAliases_create2(), null);
+    }
+
+    @Test
+    public void listAll() throws Exception {
+
+        final List<AliasDemoObject> all = wrap(aliasDemoObjectMenu).listAllDemoObjects();
+        Assertions.assertThat(all.size()).isEqualTo(AliasDemoObjectData.values().length);
+        
+        AliasDemoObject aliasDemoObject = wrap(all.get(0));
+        Assertions.assertThat(aliasDemoObject.getName()).isEqualTo("Foo");
+    }
+    
+    @Test
+    public void create() throws Exception {
+
+        wrap(aliasDemoObjectMenu).createDemoObject("Faz");
+        
+        final List<AliasDemoObject> all = wrap(aliasDemoObjectMenu).listAllDemoObjects();
+        Assertions.assertThat(all.size()).isEqualTo(AliasDemoObjectData.values().length+1);
+    }
+
+}