Skip to content

Commit c65cc46

Browse files
twisti-devtwisti-dev
committed
refactor: update package structure from dev.slne to dev.slne.surf across the project
Align package structure with namespace conventions to improve consistency and maintainability. Update imports, test packages, build configuration, and documentation accordingly.
1 parent bdf924d commit c65cc46

34 files changed

+114
-104
lines changed

‎README.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ A Kotlin library for Redis-based distributed systems using Lettuce and Kotlin Co
55
## Quick Start
66

77
```kotlin
8-
import dev.slne.redis.RedisApi
9-
import dev.slne.redis.event.RedisEvent
10-
import dev.slne.redis.event.OnRedisEvent
8+
import dev.slne.surf.redis.RedisApi
9+
import dev.slne.surf.redis.event.RedisEvent
10+
import dev.slne.surf.redis.event.OnRedisEvent
1111
import kotlinx.serialization.Serializable
1212
import java.nio.file.Paths
1313

@@ -114,7 +114,7 @@ api.publishEvent(MyEvent())
114114
**This is the preferred method** because it enables centralized configuration management:
115115

116116
```kotlin
117-
import dev.slne.redis.RedisApi
117+
import dev.slne.surf.redis.RedisApi
118118
import java.nio.file.Paths
119119

120120
val api = RedisApi.create(
@@ -180,7 +180,7 @@ The event bus allows you to publish events to all listening servers/instances.
180180
Create your custom events by extending the `RedisEvent` class and annotating with `@Serializable`:
181181

182182
```kotlin
183-
import dev.slne.redis.event.RedisEvent
183+
import dev.slne.surf.redis.event.RedisEvent
184184
import kotlinx.serialization.Serializable
185185
186186
@Serializable
@@ -196,7 +196,7 @@ data class PlayerJoinEvent(
196196
Create listeners with methods annotated with `@OnRedisEvent`:
197197

198198
```kotlin
199-
import dev.slne.redis.event.OnRedisEvent
199+
import dev.slne.surf.redis.event.OnRedisEvent
200200
201201
class MyListener {
202202
@OnRedisEvent
@@ -228,7 +228,7 @@ class MyListener(private val scope: CoroutineScope) {
228228
#### 3. Register and Use
229229

230230
```kotlin
231-
import dev.slne.redis.RedisApi
231+
import dev.slne.surf.redis.RedisApi
232232
import java.nio.file.Paths
233233
234234
// Create and configure API
@@ -256,8 +256,8 @@ In addition to events, surf-redis supports request-response patterns where a ser
256256
#### Quick Example
257257

258258
```kotlin
259-
import dev.slne.redis.RedisApi
260-
import dev.slne.redis.request.*
259+
import dev.slne.surf.redis.RedisApi
260+
import dev.slne.surf.redis.request.*
261261
import kotlinx.serialization.Serializable
262262
import kotlinx.coroutines.launch
263263
import java.nio.file.Paths
@@ -308,8 +308,8 @@ println("Players: ${response.players}")
308308
#### Creating Requests and Responses
309309

310310
```kotlin
311-
import dev.slne.redis.request.RedisRequest
312-
import dev.slne.redis.request.RedisResponse
311+
import dev.slne.surf.redis.request.RedisRequest
312+
import dev.slne.surf.redis.request.RedisResponse
313313
import kotlinx.serialization.Serializable
314314
315315
@Serializable
@@ -327,8 +327,8 @@ Handlers receive a `RequestContext` that provides:
327327
- `respond(response)`: Method to send the response
328328

329329
```kotlin
330-
import dev.slne.redis.request.HandleRedisRequest
331-
import dev.slne.redis.request.RequestContext
330+
import dev.slne.surf.redis.request.HandleRedisRequest
331+
import dev.slne.surf.redis.request.RequestContext
332332
import kotlinx.coroutines.launch
333333
334334
class MyRequestHandler {
@@ -348,7 +348,7 @@ class MyRequestHandler {
348348
#### Sending Requests
349349

350350
```kotlin
351-
import dev.slne.redis.RedisApi
351+
import dev.slne.surf.redis.RedisApi
352352
import kotlinx.coroutines.runBlocking
353353
354354
// Example only - in production, use a proper coroutine scope
@@ -439,7 +439,7 @@ surf-redis provides replicated, in-memory data structures that stay synchronized
439439
#### Quick Example
440440

441441
```kotlin
442-
import dev.slne.redis.RedisApi
442+
import dev.slne.surf.redis.RedisApi
443443
import java.nio.file.Paths
444444
445445
val api = RedisApi.create(pluginDataPath = Paths.get("plugins/my-plugin"))
@@ -574,10 +574,10 @@ value.onChange { change ->
574574
Here's a complete example demonstrating all features:
575575

576576
```kotlin
577-
import dev.slne.redis.RedisApi
578-
import dev.slne.redis.event.RedisEvent
579-
import dev.slne.redis.event.OnRedisEvent
580-
import dev.slne.redis.request.*
577+
import dev.slne.surf.redis.RedisApi
578+
import dev.slne.surf.redis.event.RedisEvent
579+
import dev.slne.surf.redis.event.OnRedisEvent
580+
import dev.slne.surf.redis.request.*
581581
import kotlinx.coroutines.launch
582582
import kotlinx.serialization.Serializable
583583
import java.nio.file.Paths

‎build.gradle.kts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ plugins {
55
// id("dev.slne.surf.surfapi.gradle.standalone") version "1.21.11+" /* Uncomment to use tests */
66
}
77

8-
group = "dev.slne"
8+
group = "dev.slne.surf"
99
version = findProperty("version") as String
1010

1111

@@ -22,7 +22,7 @@ dependencies {
2222
}
2323

2424
tasks.shadowJar {
25-
relocationPrefix = "dev.slne.redis.libs"
25+
relocationPrefix = "dev.slne.surf.redis.libs"
2626
enableAutoRelocation = true
2727
}
2828

src/main/kotlin/dev/slne/redis/RedisApi.kt renamed to src/main/kotlin/dev/slne/surf/redis/RedisApi.kt

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
package dev.slne.redis
2-
3-
import dev.slne.redis.RedisApi.Companion.create
4-
import dev.slne.redis.config.InternalConfig
5-
import dev.slne.redis.event.RedisEvent
6-
import dev.slne.redis.event.RedisEventBus
7-
import dev.slne.redis.request.RedisRequest
8-
import dev.slne.redis.request.RedisResponse
9-
import dev.slne.redis.request.RequestResponseBus
10-
import dev.slne.redis.sync.SyncStructure
11-
import dev.slne.redis.sync.list.SyncList
12-
import dev.slne.redis.sync.map.SyncMap
13-
import dev.slne.redis.sync.set.SyncSet
14-
import dev.slne.redis.sync.value.SyncValue
1+
package dev.slne.surf.redis
2+
3+
import dev.slne.surf.redis.RedisApi.Companion.create
4+
import dev.slne.surf.redis.config.InternalConfig
5+
import dev.slne.surf.redis.event.RedisEvent
6+
import dev.slne.surf.redis.event.RedisEventBus
7+
import dev.slne.surf.redis.request.RedisRequest
8+
import dev.slne.surf.redis.request.RedisResponse
9+
import dev.slne.surf.redis.request.RequestResponseBus
10+
import dev.slne.surf.redis.sync.SyncStructure
11+
import dev.slne.surf.redis.sync.list.SyncList
12+
import dev.slne.surf.redis.sync.map.SyncMap
13+
import dev.slne.surf.redis.sync.set.SyncSet
14+
import dev.slne.surf.redis.sync.value.SyncValue
1515
import dev.slne.surf.surfapi.core.api.serializer.SurfSerializerModule
1616
import dev.slne.surf.surfapi.core.api.util.logger
1717
import io.lettuce.core.ExperimentalLettuceCoroutinesApi
@@ -277,7 +277,7 @@ class RedisApi private constructor(
277277
*/
278278
suspend inline fun <reified T : RedisResponse> sendRequest(
279279
request: RedisRequest,
280-
timeoutMs: Long = RequestResponseBus.DEFAULT_TIMEOUT_MS
280+
timeoutMs: Long = RequestResponseBus.Companion.DEFAULT_TIMEOUT_MS
281281
) = requestResponseBus.sendRequest<T>(request, timeoutMs)
282282

283283
/**
@@ -286,7 +286,7 @@ class RedisApi private constructor(
286286
suspend fun <T : RedisResponse> sendRequest(
287287
request: RedisRequest,
288288
responseType: Class<T>,
289-
timeoutMs: Long = RequestResponseBus.DEFAULT_TIMEOUT_MS
289+
timeoutMs: Long = RequestResponseBus.Companion.DEFAULT_TIMEOUT_MS
290290
) = requestResponseBus.sendRequest(request, responseType, timeoutMs)
291291

292292
/**
@@ -300,7 +300,7 @@ class RedisApi private constructor(
300300
*/
301301
inline fun <reified E : Any> createSyncList(
302302
id: String,
303-
ttl: Duration = SyncList.DEFAULT_TTL
303+
ttl: Duration = SyncList.Companion.DEFAULT_TTL
304304
): SyncList<E> = createSyncList(id, serializer(), ttl)
305305

306306
/**
@@ -310,7 +310,7 @@ class RedisApi private constructor(
310310
fun <E : Any> createSyncList(
311311
id: String,
312312
elementSerializer: KSerializer<E>,
313-
ttl: Duration = SyncList.DEFAULT_TTL
313+
ttl: Duration = SyncList.Companion.DEFAULT_TTL
314314
) = createSyncStructure {
315315
SyncList(this, id, syncStructureScope, elementSerializer, ttl)
316316
}
@@ -321,7 +321,7 @@ class RedisApi private constructor(
321321
*/
322322
inline fun <reified E : Any> createSyncSet(
323323
id: String,
324-
ttl: Duration = SyncSet.DEFAULT_TTL
324+
ttl: Duration = SyncSet.Companion.DEFAULT_TTL
325325
): SyncSet<E> = createSyncSet(id, serializer(), ttl)
326326

327327
/**
@@ -331,7 +331,7 @@ class RedisApi private constructor(
331331
fun <E : Any> createSyncSet(
332332
id: String,
333333
elementSerializer: KSerializer<E>,
334-
ttl: Duration = SyncSet.DEFAULT_TTL
334+
ttl: Duration = SyncSet.Companion.DEFAULT_TTL
335335
) = createSyncStructure {
336336
SyncSet(this, id, syncStructureScope, elementSerializer, ttl)
337337
}
@@ -343,7 +343,7 @@ class RedisApi private constructor(
343343
inline fun <reified T : Any> createSyncValue(
344344
id: String,
345345
defaultValue: T,
346-
ttl: Duration = SyncValue.DEFAULT_TTL
346+
ttl: Duration = SyncValue.Companion.DEFAULT_TTL
347347
): SyncValue<T> = createSyncValue(id, serializer(), defaultValue, ttl)
348348

349349
/**
@@ -354,7 +354,7 @@ class RedisApi private constructor(
354354
id: String,
355355
serializer: KSerializer<T>,
356356
defaultValue: T,
357-
ttl: Duration = SyncValue.DEFAULT_TTL
357+
ttl: Duration = SyncValue.Companion.DEFAULT_TTL
358358
) = createSyncStructure {
359359
SyncValue(this, id, syncStructureScope, serializer, defaultValue, ttl)
360360
}
@@ -365,14 +365,14 @@ class RedisApi private constructor(
365365
*/
366366
inline fun <reified K : Any, reified V : Any> createSyncMap(
367367
id: String,
368-
ttl: Duration = SyncMap.DEFAULT_TTL
368+
ttl: Duration = SyncMap.Companion.DEFAULT_TTL
369369
): SyncMap<K, V> = createSyncMap(id, serializer(), serializer(), ttl)
370370

371371
fun <K : Any, V : Any> createSyncMap(
372372
id: String,
373373
keySerializer: KSerializer<K>,
374374
valueSerializer: KSerializer<V>,
375-
ttl: Duration = SyncMap.DEFAULT_TTL
375+
ttl: Duration = SyncMap.Companion.DEFAULT_TTL
376376
) = createSyncStructure {
377377
SyncMap(this, id, syncStructureScope, keySerializer, valueSerializer, ttl)
378378
}

src/main/kotlin/dev/slne/redis/config/GlobalConfig.kt renamed to src/main/kotlin/dev/slne/surf/redis/config/GlobalConfig.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package dev.slne.redis.config
1+
package dev.slne.surf.redis.config
22

33
import dev.slne.surf.surfapi.core.api.config.createSpongeYmlConfig
44
import dev.slne.surf.surfapi.core.api.config.surfConfigApi

src/main/kotlin/dev/slne/redis/config/InternalConfig.kt renamed to src/main/kotlin/dev/slne/surf/redis/config/InternalConfig.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package dev.slne.redis.config
1+
package dev.slne.surf.redis.config
22

33
import java.nio.file.Path
44

src/main/kotlin/dev/slne/redis/config/LocalConfig.kt renamed to src/main/kotlin/dev/slne/surf/redis/config/LocalConfig.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package dev.slne.redis.config
1+
package dev.slne.surf.redis.config
22

33
import dev.slne.surf.surfapi.core.api.config.createSpongeYmlConfig
44
import dev.slne.surf.surfapi.core.api.config.surfConfigApi

src/main/kotlin/dev/slne/redis/event/OnRedisEvent.kt renamed to src/main/kotlin/dev/slne/surf/redis/event/OnRedisEvent.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package dev.slne.redis.event
1+
package dev.slne.surf.redis.event
22

33
/**
44
* Marks a method as a Redis event handler.

src/main/kotlin/dev/slne/redis/event/RedisEvent.kt renamed to src/main/kotlin/dev/slne/surf/redis/event/RedisEvent.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package dev.slne.redis.event
1+
package dev.slne.surf.redis.event
22

33
import kotlinx.serialization.Serializable
44

src/main/kotlin/dev/slne/redis/event/RedisEventBus.kt renamed to src/main/kotlin/dev/slne/surf/redis/event/RedisEventBus.kt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
package dev.slne.redis.event
1+
package dev.slne.surf.redis.event
22

33
import com.google.common.flogger.LogPerBucketingStrategy
44
import com.google.common.flogger.StackSize
5-
import dev.slne.redis.RedisApi
6-
import dev.slne.redis.util.KotlinSerializerCache
5+
import dev.slne.surf.redis.RedisApi
6+
import dev.slne.surf.redis.util.KotlinSerializerCache
77
import dev.slne.surf.surfapi.core.api.util.logger
88
import io.lettuce.core.pubsub.RedisPubSubListener
99
import it.unimi.dsi.fastutil.objects.Object2ObjectOpenHashMap
@@ -52,7 +52,8 @@ class RedisEventBus internal constructor(private val api: RedisApi) {
5252
/**
5353
* Cache for event serializers, resolved once per event class.
5454
*/
55-
private val serializerCache = KotlinSerializerCache<RedisEvent>(api.json.serializersModule)
55+
private val serializerCache =
56+
KotlinSerializerCache.Companion<RedisEvent>(api.json.serializersModule)
5657

5758
companion object {
5859
private val log = logger()

src/main/kotlin/dev/slne/redis/request/HandleRedisRequest.kt renamed to src/main/kotlin/dev/slne/surf/redis/request/HandleRedisRequest.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package dev.slne.redis.request
1+
package dev.slne.surf.redis.request
22

33
/**
44
* Marks a method as a Redis request handler.

0 commit comments

Comments
 (0)