CUBA 7.2 support (#18)

Author: mariodavid

.gitignore

@@ -8,4 +8,5 @@ deploy/*
 modules/*/build/*
 out
 test-run
-.idea
+.idea
+*.DS_Store

CHANGELOG.md

@@ -4,6 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.8.0] - 2020-03-25
+
+### Added
+- ability to send message to multiple receivers
+- `MessageService.sendMessage(SendMessageEntity sendMessageEntity)` API to send messages to multiple receivers programmatically
+
+### Changed
+- Refactored all Screens to CUBA 7 APIs (in case you extended the previously existing screens, make sure you catch up with the new implementation)
+- (Breaking!) `MessageService.countUnreadMessagesForCurrentUser()` returns long instead of int
+
+### Dependencies
+- CUBA 7.2.x
+
 ## [0.7.0] - 2020-03-21
 
 ### Added

README.md

@@ -16,6 +16,7 @@ This CUBA component gives users a mailbox for user to user and system to user me
 
 | Platform Version | Add-on Version |
 | ---------------- | -------------- |
+| 7.2.x            | 0.8.x          |
 | 7.1.x            | 0.7.x          |
 | 7.0.x            | 0.6.x          |
 | 6.10.x           | 0.5.x          |
@@ -66,34 +67,31 @@ to the system in order to notify the user about something changed in the system.
 
 ![user inbox](/img/4-user-inbox.png)
 
-## Sending messages
+## Sending Messages
 
 To send messages to a particular user, there are two options available:
 
 * manually sending message to a user
 * system messages that are send programmatically
 
 
-### Send manual messages
+### Send Manual Messages
 
 In order to send a message to a particular user, there is a button "Send message" in the users inbox.
 
 This screen allows to manually send a message. A message contains a subject and a body, just like a regular Email.
 
 ![send message manually](/img/1-send-message-manually-editor.png)
 
-This feature can sometimes be helpful but oftentimes sending a regular email is not worse.
-
-#### Context-based messages
+#### Context-based Messages
 
 Therefore there is another option to send a Message. In this case it is a message that is send through the context of a particular entity.
 
 This is comparable of sending a email with a link that points to a particular customer / order etc. in your application together with the information from the sender.
 
 ![share entities overview](/img/3-share-entities-overview.gif)
 
-
-##### Share entity instances (CUBA 6 Screens)
+##### Share Entity Instances (CUBA 6 Screens)
 
 The way to send context-based messages is to use the `@Shareable` annotation for CUBA 6 based screens (AbstractLookup / AbstractEditor).
 The annotation is used in any Entity browse / editor screen.
@@ -155,7 +153,7 @@ public class CustomerBrowse extends StandardLookup<Customer> implements WithEnti
 
 This interface will create a button in the buttonsPanel of the table and add the share button after the default CUBA buttons.
 
-### Send system messages (programmatically)
+### Send System Messages (programmatically)
 
 The other way to send a message to a user is that the developer defines points in the application, where it is useful to notify some user
 about a particular thing happened. This can be various actions, like:
@@ -188,27 +186,58 @@ public interface MessageService {
 
 ## Using pre-defined Main Window Screens
 
-This application component comes with two options for the main screens, that can be used in the final application.
- 
-* SideMainwindowWithMessages (side-mainwindow-with-messages.xml)
-* AppMainWindowWithMessages (mainwindow-with-messages.xml)
+This application component comes with multiple options for the main screens, that can be used in the final application.
+
+* UserInboxSideMenuMainScreen (`userInboxSideMenuMainScreen`) (CUBA 7 based Side Menu)
+* SideMainwindowWithMessages (`sideMainWindowWithMessages`) (CUBA 6 based Side Menu)
+* AppMainWindowWithMessages (`appMainWindowWithMessages`) (CUBA 6 based Main Menu)
 
-One of these two classes can be used as the mainwinow through the following definition in your web-screens.xml:
+One of these classes can be used as the main screen via `web-app.properties`:
 
 ````    
-<!-- either the normal mainwindow with messages badge -->
-<screen id="mainWindow"
-        template="de/diedavids/cuba/userinbox/web/screens/mainwindow-with-messages.xml"/>
+cuba.web.mainScreenId=appMainWindowWithMessages
+````
 
-<!-- or the side menu main window with messages badge -->
-<screen id="mainWindow"
-        template="de/diedavids/cuba/userinbox/web/screens/side-mainwindow-with-messages.xml"/>
+### Custom Main Screen
 
-````
+In case you are using a custom main screen, the following logic has to be implemented to leverage the menu entry and
+the automatic reload of the new messages:
+
+```java
+import de.diedavids.cuba.userinbox.web.screens.UserInboxMessageMenuBadge;
+
+public class CustomApplicationMainScreen extends MainScreen {
+
+    @Inject
+    protected SideMenu sideMenu;
+    @Inject
+    protected Timer updateCountersTimer;
+
+    @Inject
+    protected UserInboxMessageMenuBadge userInboxMessageMenuBadge;
+
+    @Subscribe
+    protected void onInit(InitEvent event) {
+        userInboxMessageMenuBadge.initMessagesMenuItem(
+                sideMenu,
+                updateCountersTimer,
+                this
+        );
+    }
+
+    @Subscribe
+    protected void onAfterShow(AfterShowEvent event) {
+        userInboxMessageMenuBadge.updateMessageCounter(sideMenu);
+    }
+
+    @Subscribe("updateCountersTimer")
+    protected void onUpdateCountersTimerTimerAction(Timer.TimerActionEvent event) {
+        userInboxMessageMenuBadge.updateMessageCounter(sideMenu);
+    }
+}
+```
 
-You can also extend this screens, so that you can add your own (screen-) logic to the mainwindow.
- 
-##### Unread Messages Counter in pre-defined Main Window Screens
+### Unread Messages Counter in pre-defined Main Window Screens
 
 In order to display the messages that are marked as unread, the main windows will be refreshed in a particular interval.
 The logic is the same as the Count script which is available within the [Application Folders](https://doc.cuba-platform.com/manual-6.8/application_folder.html)

build.gradle

@@ -1,5 +1,5 @@
 buildscript {
-    ext.cubaVersion = '7.1.0'
+    ext.cubaVersion = '7.2.0'
     repositories {
 
         mavenLocal()
@@ -52,12 +52,8 @@ cuba {
     tomcat {
         dir = "$project.rootDir/deploy/tomcat"
     }
-    ide {
-        vcs = 'Git'
-    }
 }
 
-
 subprojects {
     apply plugin: 'com.jfrog.bintray'
 
@@ -100,14 +96,13 @@ subprojects {
 
 dependencies {
     appComponent("com.haulmont.cuba:cuba-global:$cubaVersion")
-    appComponent('de.balvi.cuba.declarativecontrollers:declarativecontrollers-global:0.9.0')
-    appComponent('de.diedavids.cuba.entitysoftreference:entity-soft-reference-global:0.6.5')
+    appComponent('de.balvi.cuba.declarativecontrollers:declarativecontrollers-global:0.10.0')
+    appComponent('de.diedavids.cuba.entitysoftreference:entity-soft-reference-global:0.7.0')
 
 }
 
 def hsql = 'org.hsqldb:hsqldb:2.4.1'
 
-
 allprojects {
     apply plugin: 'net.saliman.cobertura'
 }
@@ -144,13 +139,20 @@ configure([globalModule, coreModule, webModule]) {
     apply(plugin: 'cuba')
 
     dependencies {
+        testCompile('org.junit.jupiter:junit-jupiter-api:5.5.2')
+        testCompile('org.junit.jupiter:junit-jupiter-engine:5.5.2')
+        testCompile('org.junit.vintage:junit-vintage-engine:5.5.2')
+
+        testCompile 'org.mockito:mockito-core:3.2.4'
+        testCompile 'org.mockito:mockito-junit-jupiter:3.2.4'
 
-        testCompile('junit:junit:4.12')
-        testCompile 'org.assertj:assertj-core:2.9.0'
 
         testCompile('org.spockframework:spock-core:1.2-groovy-2.5')
         testCompile('org.springframework:spring-test:4.3.1.RELEASE')
-        testRuntime "cglib:cglib-nodep:3.2.4"
+
+
+        testCompile("org.assertj:assertj-core:3.11.1")
+
     }
 
     task sourceJar(type: Jar) {
@@ -161,49 +163,30 @@ configure([globalModule, coreModule, webModule]) {
     artifacts {
         archives sourceJar
     }
+    test {
+        useJUnitPlatform()
+    }
 }
 
+
 configure([globalModule, coreModule, webModule]) {
     apply(plugin: 'groovy')
-    apply plugin: 'net.saliman.cobertura'
-    apply plugin: 'codenarc'
-
-    codenarc {
-        toolVersion = "1.3"
-        ignoreFailures = false
-        reportFormat = 'html'
-        reportsDir = project.file("build/reports/codenarc")
-    }
-
-    codenarcMain {
-        configFile = rootProject.file("config/codenarc/rulesMain.groovy")
-    }
-    codenarcTest {
-        configFile = rootProject.file("config/codenarc/rulesTests.groovy")
-    }
-
-
-    cobertura {
-        coverageFormats = ['html', 'xml']
-        coverageIgnoreTrivial = true
-        coverageIgnores = ['org.slf4j.Logger.*']
-        coverageReportDir = new File("$buildDir/reports/cobertura")
-
-        coverageExcludes = [
-                '.*Enum',
-        ]
-    }
-
-    test.finalizedBy(project.tasks.cobertura)
-    test.finalizedBy(project.tasks.coberturaCheck)
 
     sourceSets {
-        main { groovy { srcDirs = ["src"] } }
-        test { groovy { srcDirs = ["test"] } }
+        main {
+            groovy { srcDirs = ["src"] }
+            java.outputDir = new File(project.buildDir, "classes/main")
+            groovy.outputDir = new File(project.buildDir, "classes/main")
+        }
+        test {
+            groovy { srcDirs = ["test"] }
+            java.outputDir = new File(project.buildDir, "classes/test")
+            groovy.outputDir = new File(project.buildDir, "classes/test")
+        }
     }
 
-    sourceSets.main.output.classesDir = new File(project.buildDir, "classes/main")
-    sourceSets.test.output.classesDir = new File(project.buildDir, "classes/test")
+    sourceSets.main.output.classesDirs.setFrom(new File(project.buildDir, "classes/main"))
+    sourceSets.test.output.classesDirs.setFrom(new File(project.buildDir, "classes/test"))
 
 }
 
@@ -214,6 +197,7 @@ configure(globalModule) {
             runtime('org.glassfish.jaxb:jaxb-runtime:2.3.1')
         }
     }
+
     entitiesEnhancing {
         main {
             enabled = true
@@ -255,15 +239,8 @@ configure(coreModule) {
         testRuntime(hsql)
     }
 
-    task cleanConf(description: 'Cleans up conf directory') {
-        doLast {
-            def dir = new File(cuba.tomcat.dir, "/conf/${modulePrefix}-core")
-            if (dir.isDirectory()) {
-                ant.delete(includeemptydirs: true) {
-                    fileset(dir: dir, includes: '**/*', excludes: 'local.app.properties')
-                }
-            }
-        }
+    task cleanConf(description: 'Cleans up conf directory', type: Delete) {
+        delete "$cuba.appHome/${modulePrefix}-core/conf"
     }
 
     task deploy(dependsOn: [assemble, cleanConf], type: CubaDeployment) {
@@ -296,6 +273,8 @@ configure(webModule) {
     dependencies {
         compileOnly(servletApi)
         compile(globalModule)
+
+        testCompile('de.diedavids.sneferu:sneferu:0.2.0')
     }
 
     task webArchive(type: Zip) {
@@ -311,23 +290,16 @@ configure(webModule) {
     task deployConf(type: Copy) {
         from file('src')
         include "de/diedavids/cuba/userinbox/**"
-        into "$cuba.tomcat.dir/conf/${modulePrefix}"
+        into "$cuba.appHome/${modulePrefix}/conf"
     }
 
     task clearMessagesCache(type: CubaClearMessagesCache) {
         appName = "${modulePrefix}"
     }
     deployConf.dependsOn clearMessagesCache
 
-    task cleanConf(description: 'Cleans up conf directory') {
-        doLast {
-            def dir = new File(cuba.tomcat.dir, "/conf/${modulePrefix}")
-            if (dir.isDirectory()) {
-                ant.delete(includeemptydirs: true) {
-                    fileset(dir: dir, includes: '**/*', excludes: 'local.app.properties')
-                }
-            }
-        }
+    task cleanConf(description: 'Cleans up conf directory', type: Delete) {
+        delete "$cuba.appHome/${modulePrefix}/conf"
     }
 
     task deploy(dependsOn: [assemble, cleanConf], type: CubaDeployment) {
@@ -350,9 +322,9 @@ task restart(dependsOn: ['stop', ":${modulePrefix}-core:deploy", ":${modulePrefi
                 socket(server: 'localhost', port: '8787')
             }
         }
-        start.execute()
     }
 }
+restart.finalizedBy start
 
 
 clean {

gradle.properties

@@ -1 +1 @@
-version=0.7.1-SNAPSHOT
+version=0.8.0-SNAPSHOT

gradle/wrapper/gradle-wrapper.properties

@@ -2,4 +2,4 @@ distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.3-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-bin.zip