From 1fe063add299828a65cd6c35a1d76be681ad474a Mon Sep 17 00:00:00 2001 From: Fabrice Lecomte Date: Wed, 14 Jul 2021 04:12:37 +0200 Subject: [PATCH] Rename to AccessKontrol --- README.md | 10 +++++----- build.gradle.kts | 6 +++--- gradle.properties | 4 ++-- settings.gradle.kts | 2 +- .../{AccessControl.kt => AccessKontrol.kt} | 16 ++++++++-------- ...AccessControlTest.kt => AccessKontrolTest.kt} | 4 ++-- 6 files changed, 21 insertions(+), 21 deletions(-) rename src/main/kotlin/io/github/flecomte/{AccessControl.kt => AccessKontrol.kt} (92%) rename src/test/kotlin/io/github/flecomte/{AccessControlTest.kt => AccessKontrolTest.kt} (98%) diff --git a/README.md b/README.md index 0c33c20..7f338d4 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # Access Kontrol Helpers to create a simple Access Control in kotlin -[![Tests](https://github.com/flecomte/access-control/actions/workflows/tests.yml/badge.svg)](https://github.com/flecomte/access-control/actions/workflows/tests.yml) -[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=flecomte_access-control&metric=coverage)](https://sonarcloud.io/dashboard?id=flecomte_access-control) +[![Tests](https://github.com/flecomte/access-kontrol/actions/workflows/tests.yml/badge.svg)](https://github.com/flecomte/access-kontrol/actions/workflows/tests.yml) +[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=flecomte_access-kontrol&metric=coverage)](https://sonarcloud.io/dashboard?id=flecomte_access-kontrol) -[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=flecomte_access-control&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=flecomte_access-control) -[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=flecomte_access-control&metric=ncloc)](https://sonarcloud.io/dashboard?id=flecomte_access-control) +[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=flecomte_access-kontrol&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=flecomte_access-kontrol) +[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=flecomte_access-kontrol&metric=ncloc)](https://sonarcloud.io/dashboard?id=flecomte_access-kontrol) ## Example Define AC ```kotlin -class AccessControlSample : AccessControl() { +class AccessControlSample : AccessKontrol() { /** The user can view the object if it is connected and if it is the creator */ fun canView(myObject: MyObject, user: User?): AccessResponse { return if (user != null && myObject.createdBy == user) { diff --git a/build.gradle.kts b/build.gradle.kts index 058f62b..0fffbe7 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -44,8 +44,8 @@ val sourcesJar by tasks.registering(Jar::class) { publishing { repositories { maven { - name = "access-control" - url = uri("https://maven.pkg.github.com/flecomte/access-control") + name = "access-kontrol" + url = uri("https://maven.pkg.github.com/flecomte/access-kontrol") credentials { username = System.getenv("GITHUB_ACTOR") password = System.getenv("GITHUB_TOKEN") @@ -54,7 +54,7 @@ publishing { } publications { - create("access-control") { + create("access-kontrol") { from(components["java"]) artifact(sourcesJar) } diff --git a/gradle.properties b/gradle.properties index 497f67c..ff17776 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,7 +1,7 @@ kotlin.code.style=official systemProp.sonar.host.url=https://sonarcloud.io -systemProp.sonar.projectKey=flecomte_access-control -systemProp.sonar.projectName=AccessControl +systemProp.sonar.projectKey=flecomte_access-kontrol +systemProp.sonar.projectName=AccessKontrol systemProp.sonar.organization=flecomte systemProp.sonar.java.coveragePlugin=jacoco systemProp.sonar.coverage.jacoco.xmlReportPaths=build/reports/jacoco/test/jacocoTestReport.xml \ No newline at end of file diff --git a/settings.gradle.kts b/settings.gradle.kts index 11b020f..34b7b0a 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -1 +1 @@ -rootProject.name = "access-control" +rootProject.name = "access-kontrol" diff --git a/src/main/kotlin/io/github/flecomte/AccessControl.kt b/src/main/kotlin/io/github/flecomte/AccessKontrol.kt similarity index 92% rename from src/main/kotlin/io/github/flecomte/AccessControl.kt rename to src/main/kotlin/io/github/flecomte/AccessKontrol.kt index 2041a15..490916c 100644 --- a/src/main/kotlin/io/github/flecomte/AccessControl.kt +++ b/src/main/kotlin/io/github/flecomte/AccessKontrol.kt @@ -1,6 +1,6 @@ package io.github.flecomte -/** Responses of AccessControl */ +/** Responses of AccessKontrol */ enum class AccessDecision { GRANTED, DENIED; @@ -14,7 +14,7 @@ enum class AccessDecision { } } -abstract class AccessControl { +abstract class AccessKontrol { /** * A Shortcut for return a GrantedResponse */ @@ -39,9 +39,9 @@ abstract class AccessControl { } /** - * Throw an Exception if AccessControl return a DENIED response + * Throw an Exception if AccessKontrol return a DENIED response */ -fun T.assert(action: T.() -> AccessResponse) { +fun T.assert(action: T.() -> AccessResponse) { action().assert() } @@ -109,13 +109,13 @@ class AccessDeniedException(val accessResponses: AccessResponses) : Throwable(ac } /** - * The response that all AccessControl method return + * The response that all AccessKontrol method return * @see GrantedResponse * @see DeniedResponse */ sealed class AccessResponse( val decision: AccessDecision, - val accessControl: AccessControl, + val accessControl: AccessKontrol, val message: String?, val code: String? ) { @@ -135,13 +135,13 @@ sealed class AccessResponse( } open class GrantedResponse( - accessControl: AccessControl, + accessControl: AccessKontrol, message: String? = null, code: String? = null ) : AccessResponse(AccessDecision.GRANTED, accessControl, message, code) open class DeniedResponse( - accessControl: AccessControl, + accessControl: AccessKontrol, message: String, code: String ) : AccessResponse(AccessDecision.DENIED, accessControl, message, code) diff --git a/src/test/kotlin/io/github/flecomte/AccessControlTest.kt b/src/test/kotlin/io/github/flecomte/AccessKontrolTest.kt similarity index 98% rename from src/test/kotlin/io/github/flecomte/AccessControlTest.kt rename to src/test/kotlin/io/github/flecomte/AccessKontrolTest.kt index 2b58624..c9c7b32 100644 --- a/src/test/kotlin/io/github/flecomte/AccessControlTest.kt +++ b/src/test/kotlin/io/github/flecomte/AccessKontrolTest.kt @@ -13,7 +13,7 @@ data class MyObject( val title: String ) -class AccessControlSample : AccessControl() { +class AccessControlSample : AccessKontrol() { fun canView(myObject: MyObject, user: User?): AccessResponse { return if (myObject.title == "granted" && user != null) { granted("ok") @@ -29,7 +29,7 @@ class AccessControlSample : AccessControl() { } } -class AccessControlTest { +class AccessKontrolTest { @Test fun `test granted`() { AccessControlSample().run {