From 957ac74c473b3eac1e7bacf964126a16129e05c2 Mon Sep 17 00:00:00 2001 From: mfalcier Date: Thu, 22 Jun 2017 15:57:00 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=89=20First=20commit?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 22 +++ LICENSE | 201 +++++++++++++++++++++++++ README.md | 17 +++ pom.xml | 97 ++++++++++++ src/main/kotlin/example/Example.kt | 37 +++++ src/test/kotlin/example/ExampleTest.kt | 59 ++++++++ 6 files changed, 433 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 pom.xml create mode 100644 src/main/kotlin/example/Example.kt create mode 100644 src/test/kotlin/example/ExampleTest.kt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..011b5e9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,22 @@ +*.class + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +#*.jar +*.war +*.ear + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +# IntelliJ # +.idea +*.iml + +# Maven # +/target + +# MAC Journaling # +/.DS_Store diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c74ef5d --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..53a8a9e --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Neo4j Kotlin Procedure Example + +This is an example project about Neo4j procedures written in Kotlin. + +Here you can find a Procedure `example.connect` and a User Function `example.concat`. + +The first one will create a relationship with the given type between two given nodes; the second one will concatenate a list of strings with a given delimiter. + +## Installation + +1. Download the latest [release](https://github.com/mfalcier/neo4j-kotlin-procedure-example/releases); +2. Put the downloaded jar file into `$NEO4J_HOME/plugins` folder; +3. Start/Restart Neo4j. + +## License + +Apache License V2, see LICENSE diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..7b2fded --- /dev/null +++ b/pom.xml @@ -0,0 +1,97 @@ + + 4.0.0 + + org.neo4j.example + neo4j-kotlin-procedure-example + 1.0.0 + + jar + Neo4j Kotlin Procedure Example + A simple example about Neo4j procedures using Kotlin + + + 3.2.1 + true + UTF-8 + UTF-8 + 1.8 + 1.1.2-5 + + + + + org.jetbrains.kotlin + kotlin-stdlib-jre8 + ${kotlin.version} + + + org.jetbrains.kotlin + kotlin-reflect + ${kotlin.version} + + + org.neo4j + neo4j + ${neo4j.version} + provided + + + + + org.neo4j.test + neo4j-harness + ${neo4j.version} + test + + + + org.neo4j.driver + neo4j-java-driver + 1.2.0 + test + + + + junit + junit + 4.12 + test + + + + + ${project.basedir}/src/main/kotlin + ${project.basedir}/src/test/kotlin + + + kotlin-maven-plugin + org.jetbrains.kotlin + ${kotlin.version} + + + compile + compile + + + test-compile + test-compile + + + + + maven-shade-plugin + 2.4.3 + + + package + + shade + + + + + + + diff --git a/src/main/kotlin/example/Example.kt b/src/main/kotlin/example/Example.kt new file mode 100644 index 0000000..367f248 --- /dev/null +++ b/src/main/kotlin/example/Example.kt @@ -0,0 +1,37 @@ +package example + +import org.neo4j.graphdb.Node +import org.neo4j.graphdb.RelationshipType +import org.neo4j.logging.Log +import org.neo4j.procedure.* + +class Example { + @Context + @JvmField + var log: Log? = null + + @Procedure(value = "example.connect", mode = Mode.WRITE) + @Description("Connect 2 nodes with a given relationship type") + fun connect(@Name("from") from: Node, + @Name("type") type: String, + @Name("to") to: Node) { + from.createRelationshipTo(to, RelationshipType.withName(type)) + log!!.info("Created a new relationship using connect.") + } + + @UserFunction(value = "example.concat") + @Description("example.concat(['s1','s2',...], delimiter) - join the given strings with the given delimiter.") + fun concat( + @Name("strings") strings: List?, + @Name("delimiter") delimiter: String? + ): String? { + if (strings == null || delimiter == null) { + return null + } + var result = "" + for (string in strings) { + result += string + delimiter + } + return result + } +} \ No newline at end of file diff --git a/src/test/kotlin/example/ExampleTest.kt b/src/test/kotlin/example/ExampleTest.kt new file mode 100644 index 0000000..3741300 --- /dev/null +++ b/src/test/kotlin/example/ExampleTest.kt @@ -0,0 +1,59 @@ +package example + +import org.hamcrest.core.IsEqual +import org.junit.Assert +import org.junit.Rule +import org.junit.Test +import org.neo4j.driver.v1.Config +import org.neo4j.driver.v1.GraphDatabase +import org.neo4j.harness.junit.Neo4jRule + +class ExampleTest { + // This rule starts a Neo4j instance + @Rule + @JvmField + var neo4j = Neo4jRule() + + // This is the function we want to test + .withFunction(Example::class.java) + .withProcedure(Example::class.java) + + @Test + @Throws(Throwable::class) + fun shouldConcatStringsCorrectly() { + // In a try-block, to make sure we close the driver and session after the test + GraphDatabase.driver(neo4j.boltURI(), Config.build() + .withEncryptionLevel(Config.EncryptionLevel.NONE).toConfig()).use({ driver -> + driver.session().use({ session -> + // Given + + // When + val result = session.run("RETURN example.concat(['name','surname'], ';') as result") + + // Then + Assert.assertThat(result.single().get("result").asString(), IsEqual.equalTo("name;surname;")) + }) + }) + } + + @Test + @Throws(Throwable::class) + fun shouldConnectNodesCorrectly() { + // In a try-block, to make sure we close the driver and session after the test + GraphDatabase.driver(neo4j.boltURI(), Config.build() + .withEncryptionLevel(Config.EncryptionLevel.NONE).toConfig()).use({ driver -> + driver.session().use({ session -> + // Given + session.run("CREATE (p:From)") + session.run("CREATE (p:To)") + + // When + session.run("MATCH (f:From), (t:To) WITH f, t CALL example.connect(f, 'KNOWS', t) RETURN *") + + // Then + val result = session.run("MATCH p=(f:From)-[:KNOWS]->(t:To) return p") + Assert.assertThat(result.single().size(), IsEqual.equalTo(1)) + }) + }) + } +} \ No newline at end of file