Merge pull request #3 from cufyorg/supremacy

Supremacy

Author: LSafer

.gitignore

@@ -1,5 +1,6 @@
 .idea
 .gradle
+/out
 **/build/
 !src/**/build/
 

README.md

@@ -1,11 +1,9 @@
-# Kaguya Shinomiya [![](https://jitpack.io/v/org.cufy/kaguya.svg)](https://jitpack.io/#org.cufy/kaguya)
+# Graphkt [![](https://jitpack.io/v/org.cufy/graphkt.svg)](https://jitpack.io/#org.cufy/graphkt)
 
 A GraphQL library based on
 [graphql-java](http://github.com/graphql-java/graphql-java)
 with kotlin-friendly builders and ktor routing extensions.
 
-> Please, Don't touch my harem 😪
-
 ### Install
 
 The main way of installing this library is
@@ -20,7 +18,7 @@ repositories {
 
 dependencies {
     // Replace TAG with the desired version
-    implementation("org.cufy:kaguya:TAG")
+    implementation("org.cufy:graphkt:TAG")
 }
 ```
 
@@ -33,52 +31,79 @@ data class Entity(
     val name: String
 )
 
-val EntityObjectType = GraphQLObjectType<Entity> {
-    name = "Entity"
-    description = "Some entity."
+val EntityObjectType = GraphQLObjectType<Entity>("Entity") {
+    description { "Some entity." }
 
-    field(Entity::name) {
-        type = GraphQLString
-        description = "The name of the entity."
+    field(Entity::name, GraphQLStringType) {
+        description { "The name of the entity." }
     }
 
-    field("nameWithCustomVar") {
-        type = GraphQLNonNull(GraphQLString)
-        description = "The name of the entity with the customVar in the context."
+    field("nameWithCustomVar", GraphQLNullableType(GraphQLStringType)) {
+        description { "The name of the entity with the customVar in the context." }
 
         resolver {
-            it.name + graphQlContext.get("myCustomVar")
+            it.name + context["myCustomVar"]
         }
     }
 }
 
+val EntitiesFlow = MutableSharedFlow<Entity>()
+
 fun Application.configureGraphQL() {
+    // you can choose any of these IDEs
+    // graphiql()
+    // sandbox()
+    playground() // recommended
+
     graphql {
-        graphiql = true
+        engine(GraphQLJava) {
+            // engine-specific configuration
+        }
 
         context {
             put("myCustomVar", Math.random())
         }
 
         schema {
             query {
-                description = "The root query."
+                description { "The root query." }
+
+                field("getEntityWithName", EntityObjectType) {
+                    description { "Get an entity instance." }
+
+                    val nameArg = argument<String>("name", GraphQLStringType) {
+                        description { "The name of the entity." }
+                    }
 
-                field("getEntityWithName") {
-                    type = EntityObjectType
-                    description = "Get an entity instance."
+                    get { Entity(nameArg()) }
+                }
+            }
+            mutation {
+                description { "The root mutation" }
 
-                    val nameArg = argument<String> {
-                        type = GraphQLString
-                        name = "name"
-                        description = "The name of the entity."
+                field("pushEntity", EntityObjectType) {
+                    description { "Push an entity to subscribers" }
+
+                    val nameArg = argument<String>("name", GraphQLStringType) {
+                        description { "The name of the entity." }
                     }
 
-                    resolver {
-                        Entity(nameArg())
+                    get {
+                        val entity = Entity(nameArg())
+                        EntitiesFlow.emit(entity)
+                        entity
                     }
                 }
             }
+            subscription {
+                description { "The root subscription" }
+
+                field("subscribeToEntities", EntityObjectType) {
+                    description { "Subscribe to pushed entities" }
+
+                    getFlow { EntitiesFlow }
+                }
+            }
         }
     }
 }

build.gradle.kts

@@ -1,32 +1,44 @@
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 plugins {
-    kotlin("jvm") version "1.7.0"
-    kotlin("plugin.serialization") version "1.7.0"
+    kotlin("jvm") version kotlin_version
+    kotlin("plugin.serialization") version kotlin_version
     id("maven-publish")
 }
 
 group = "org.cufy"
-version = "1.1.0"
+version = "2.0.0"
 
 repositories {
     mavenCentral()
+    maven { url = uri("https://jitpack.io") }
 }
 
 dependencies {
+    implementation(project(":core"))
+    implementation(project(":ktor"))
+    implementation(project(":graphql-java"))
+
     implementation(kotlin("stdlib"))
-    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.3.3")
-    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.2")
 
-    implementation("io.ktor:ktor-server-core-jvm:2.0.2")
+    implementation(Dependencies.Kotlin.serialization)
+    implementation(Dependencies.Kotlin.coroutines_core)
+    implementation(Dependencies.Kotlin.coroutines_reactive)
+    implementation(Dependencies.Kotlin.reflect)
+
+    testImplementation(Dependencies.Ktor.server_core_jvm)
+    testImplementation(Dependencies.Ktor.host_common_jvm)
+    testImplementation(Dependencies.Ktor.netty_jvm)
+    testImplementation(Dependencies.Ktor.call_logging_jvm)
+    testImplementation(Dependencies.Ktor.content_negotiation_jvm)
+    testImplementation(Dependencies.Ktor.serialization_kotlinx_json_jvm)
 
-//    implementation("com.expediagroup:graphql-kotlin-server:6.0.0-alpha.4")
-//    implementation("com.expediagroup:graphql-kotlin-federation:6.0.0-alpha.4")
-//    implementation("com.expediagroup:graphql-kotlin-dataloader:6.0.0-alpha.4")
-//    implementation("com.expediagroup:graphql-kotlin-schema-generator:6.0.0-alpha.4")
+    testImplementation(Dependencies.Logging.logback_core)
+    testImplementation(Dependencies.Logging.logback_classic)
+    testImplementation(Dependencies.Logging.self4j)
 
-    implementation("com.graphql-java:graphql-java:18.1")
-    implementation("com.google.guava:guava:31.1-jre")
+    testImplementation(Dependencies.rxjava)
+    testImplementation(Dependencies.graphql_java)
 
     testImplementation(kotlin("test"))
 }
@@ -44,7 +56,7 @@ afterEvaluate {
         publications {
             create<MavenPublication>("maven") {
                 from(components["java"])
-                artifactId = "kaguya"
+                artifactId = "graphkt"
             }
         }
     }

buildSrc/.gitignore

@@ -0,0 +1,4 @@
+/build/
+/out/
+.idea
+.gradle

buildSrc/build.gradle.kts

@@ -0,0 +1,7 @@
+plugins {
+    `kotlin-dsl`
+}
+
+repositories {
+    mavenCentral()
+}

buildSrc/src/main/kotlin/Dependencies.kt

@@ -0,0 +1,37 @@
+const val kotlin_version = "1.7.22"
+const val ktor_version = "2.0.2"
+
+object Dependencies {
+    object Kotlin {
+        const val serialization = "org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1"
+        const val coroutines_core = "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4"
+        const val coroutines_reactive = "org.jetbrains.kotlinx:kotlinx-coroutines-reactive:1.6.4"
+        const val reflect = "org.jetbrains.kotlin:kotlin-reflect:1.7.22"
+    }
+
+    object Ktor {
+        const val server_core_jvm = "io.ktor:ktor-server-core-jvm:$ktor_version"
+        const val server_websockets = "io.ktor:ktor-server-websockets:$ktor_version"
+
+        const val serialization_kotlinx_json_jvm =
+            "io.ktor:ktor-serialization-kotlinx-json-jvm:$ktor_version"
+
+        const val host_common_jvm = "io.ktor:ktor-server-host-common-jvm:$ktor_version"
+        const val content_negotiation_jvm = "io.ktor:ktor-server-content-negotiation-jvm:$ktor_version"
+        const val cors_jvm = "io.ktor:ktor-server-cors-jvm:$ktor_version"
+        const val default_headers_jvm = "io.ktor:ktor-server-default-headers-jvm:$ktor_version"
+        const val http_redirect_jvm = "io.ktor:ktor-server-http-redirect-jvm:$ktor_version"
+        const val netty_jvm = "io.ktor:ktor-server-netty-jvm:$ktor_version"
+        const val server_tests_jvm = "io.ktor:ktor-server-tests-jvm:$ktor_version"
+        const val call_logging_jvm = "io.ktor:ktor-server-call-logging-jvm:$ktor_version"
+    }
+
+    object Logging {
+        const val logback_core = "ch.qos.logback:logback-core:1.2.11"
+        const val logback_classic = "ch.qos.logback:logback-classic:1.2.11"
+        const val self4j = "org.slf4j:slf4j-api:1.7.36"
+    }
+
+    const val graphql_java = "com.graphql-java:graphql-java:18.1"
+    const val rxjava = "io.reactivex.rxjava2:rxjava:2.1.5"
+}

core/.gitignore

@@ -0,0 +1,4 @@
+/build/
+/out/
+.idea
+.gradle

core/build.gradle.kts

@@ -0,0 +1,25 @@
+plugins {
+    kotlin("jvm") version kotlin_version
+    kotlin("plugin.serialization") version kotlin_version
+    id("maven-publish")
+}
+
+repositories {
+    mavenCentral()
+    maven { url = uri("https://jitpack.io") }
+}
+
+dependencies {
+    implementation(kotlin("stdlib"))
+
+    implementation(Dependencies.Kotlin.serialization)
+    implementation(Dependencies.Kotlin.coroutines_core)
+    implementation(Dependencies.Kotlin.coroutines_reactive)
+    implementation(Dependencies.Kotlin.reflect)
+
+    testImplementation(kotlin("test"))
+}
+
+tasks.getByName<Test>("test") {
+    useJUnitPlatform()
+}

core/src/main/kotlin/Annotations.kt

@@ -0,0 +1,70 @@
+/*
+ *	Copyright 2022 cufy.org
+ *
+ *	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.
+ */
+package org.cufy.graphkt
+
+/**
+ * Marks the annotated component as internal.
+ *
+ * @since 2.0.0
+ */
+@RequiresOptIn(
+    message = "This is an internal API and was not designed to be used directly",
+    level = RequiresOptIn.Level.ERROR
+)
+annotation class InternalGraphktApi(
+    /**
+     * Optionally, the reason why the component was marked with this annotation.
+     */
+    val reason: String = "This is an internal API and was not designed to be used directly"
+)
+
+/**
+ * Marks the annotated component as experimental.
+ *
+ * @since 2.0.0
+ */
+@RequiresOptIn(
+    message = "This is an experimental API and might change at anytime",
+    level = RequiresOptIn.Level.WARNING
+)
+annotation class ExperimentalGraphktApi(
+    /**
+     * Optionally, the reason why the component was marked with this annotation.
+     */
+    val reason: String = "This is an experimental API and might change at anytime"
+)
+
+/**
+ * Marks the annotated component as advanced.
+ *
+ * Components marked by this annotation are meant
+ * to be used in libraries and not application code.
+ *
+ * This was put to avoid users getter into stuff
+ * that needs more reading by accident.
+ *
+ * @since 2.0.0
+ */
+@RequiresOptIn(
+    message = "This API is meant to be used to extend the functionality of graphkt",
+    level = RequiresOptIn.Level.WARNING
+)
+annotation class AdvancedGraphktApi(
+    /**
+     * Optionally, the reason why the component was marked with this annotation.
+     */
+    val reason: String = "This API is meant to be used to extend the functionality of graphkt"
+)