chore: module names + documentation + name consistency

build:
- renamed project to `cufyorg-serialization`
- repository expected to be renamed to `cufyorg/serialization`
- all subprojects are now prefixed with `cufyorg-`
- pumbed dependency versions

style:

- split large files into smaller ones

refactor:

- bson Id renamed to ID with deprecated typealiases with the old names
- removed unnecessary overloades

perf:

- inline everywhere

Author: lsafer-meemer

README.md

@@ -1,4 +1,4 @@
-# Partial Encoding / Decoding (PED) [![](https://jitpack.io/v/org.cufy/ped.svg)](https://jitpack.io/#org.cufy/ped)
+# Cufyorg: Serialization (including: Partial Encoding / Decoding "PED") [![](https://jitpack.io/v/org.cufy/serialization.svg)](https://jitpack.io/#org.cufy/serialization)
 
 Serialization Extensions and Serializers for enhancing partial encoding and decoding
 that uses no object mapping.
@@ -17,9 +17,9 @@ repositories {
 
 dependencies {
     // Replace TAG with the desired version
-    implementation("org.cufy.ped:bson:TAG")
-    implementation("org.cufy.ped:json:TAG")
-    implementation("org.cufy.ped:ped-core:TAG")
-    implementation("org.cufy.ped:ped-bson:TAG")
+    implementation("org.cufy.serialization:cufyorg-bson:TAG")
+    implementation("org.cufy.serialization:cufyorg-json:TAG")
+    implementation("org.cufy.serialization:cufyorg-PED-core:TAG")
+    implementation("org.cufy.serialization:cufyorg-PED-bson:TAG")
 }
 ```

build.gradle.kts

@@ -11,7 +11,7 @@ tasks.wrapper {
 }
 
 subprojects {
-    group = "org.cufy.kped"
+    group = "org.cufy.serialization"
 
     repositories {
         mavenCentral()

bson/.gitignore cufyorg-PED-bson/.gitignorebson/.gitignore renamed to cufyorg-PED-bson/.gitignore

@@ -12,8 +12,8 @@ kotlin {
     sourceSets {
         commonMain {
             dependencies {
-                implementation(project(":bson"))
-                implementation(project(":ped-core"))
+                implementation(project(":cufyorg-bson"))
+                implementation(project(":cufyorg-PED-core"))
 
                 implementation(kotlin("stdlib"))
                 implementation(libs.kotlin.serialization.json)

ped-bson/build.gradle.kts cufyorg-PED-bson/build.gradle.ktsped-bson/build.gradle.kts renamed to cufyorg-PED-bson/build.gradle.kts

@@ -89,9 +89,17 @@ object Bson {
     val ObjectId = BsonObjectIdCodec
 
     /**
-     * The codec for [Id] and [BsonObjectId] or [BsonString].
+     * The codec for [ID] and [BsonObjectId] or [BsonString].
      *
      * @since 2.0.0
      */
-    val Id = BsonIdCodec
+    @Deprecated("use ID instead", ReplaceWith("ID"))
+    val Id = BsonIDCodec
+
+    /**
+     * The codec for [ID] and [BsonObjectId] or [BsonString].
+     *
+     * @since 2.0.0
+     */
+    val ID = BsonIDCodec
 }

ped-bson/src/commonMain/kotlin/Bson.kt …g-PED-bson/src/commonMain/kotlin/Bson.ktped-bson/src/commonMain/kotlin/Bson.kt renamed to cufyorg-PED-bson/src/commonMain/kotlin/Bson.kt ped-bson/src/commonMain/kotlin/Bson.kt renamed to cufyorg-PED-bson/src/commonMain/kotlin/Bson.kt

@@ -33,7 +33,6 @@ import kotlin.Result.Companion.success
  * @since 2.0.0
  */
 class BsonNullableCodec<I, O : BsonElement>(
-    @Suppress("MemberVisibilityCanBePrivate")
     val codec: Codec<I, O>,
 ) : NullableCodec<I, BsonElement> {
     override fun encode(value: Any?) =
@@ -77,7 +76,6 @@ val <I, O : BsonElement> FieldCodec<I, O>.Nullable: BsonNullableFieldCodec<I, Bs
  * individual item.
  */
 class BsonArrayCodec<I, O : BsonElement>(
-    @Suppress("MemberVisibilityCanBePrivate")
     val codec: Codec<I, O>,
 ) : Codec<List<I>, BsonArray> {
     override fun encode(value: Any?) =
@@ -113,14 +111,6 @@ val <I, O : BsonElement> Codec<I, O>.Array: BsonArrayCodec<I, O>
 val <I, O : BsonElement> FieldCodec<I, O>.Array: BsonFieldCodec<List<I>, BsonArray>
     get() = FieldCodec(name, (this as Codec<I, O>).Array)
 
-/**
- * Obtain a codec for [List] and [BsonArray] that
- * uses this codec to encode/decode each
- * individual item.
- */
-val <I, O : BsonElement> BsonFieldCodec<I, O>.Array: BsonFieldCodec<List<I>, BsonArray>
-    get() = FieldCodec(name, (this as Codec<I, O>).Array)
-
 /* ============= ------------------ ============= */
 
 /**
@@ -292,22 +282,25 @@ object BsonObjectIdCodec : Codec<ObjectId, BsonObjectId> {
 
 /* ============= ------------------ ============= */
 
+@Deprecated("use BsonIDCodec instead", ReplaceWith("BsonIDCodec"))
+typealias BsonIdCodec = BsonIDCodec
+
 /**
- * The codec for [Id] and [BsonObjectId] or [BsonString].
+ * The codec for [ID] and [BsonObjectId] or [BsonString].
  *
  * @since 2.0.0
  */
-object BsonIdCodec : Codec<Id<*>, BsonElement> {
+object BsonIDCodec : Codec<ID<*>, BsonElement> {
     override fun encode(value: Any?) =
-        tryInlineCodec(value) { it: Id<*> ->
+        tryInlineCodec(value) { it: ID<*> ->
             success(it.bson)
         }
 
     override fun decode(value: Any?) =
         tryInlineCodec(value) { it: BsonElement ->
             when (it) {
-                is BsonObjectId -> success(Id<Any>(it.value))
-                is BsonString -> success(Id(it.value))
+                is BsonObjectId -> success(ID<Any>(it.value))
+                is BsonString -> success(ID(it.value))
                 else -> failure(
                     CodecException(
                         "Cannot decode ${it::class}; expected either " +
@@ -321,9 +314,9 @@ object BsonIdCodec : Codec<Id<*>, BsonElement> {
     /**
      * Return this codec casted to [T].
      */
-    operator fun <T> invoke(): Codec<Id<T>, BsonElement> {
+    operator fun <T> invoke(): Codec<ID<T>, BsonElement> {
         @Suppress("UNCHECKED_CAST")
-        return this as Codec<Id<T>, BsonElement>
+        return this as Codec<ID<T>, BsonElement>
     }
 }
 
@@ -355,9 +348,3 @@ class EnumCodec<I, O>(private val pairs: List<Pair<I, O>>) : Codec<I, O> {
 }
 
 /* ============= ------------------ ============= */
-
-inline operator fun <I> Codec<I, BsonDocument>.invoke(block: BsonDocumentBlock): I {
-    return decode(BsonDocument(block), this)
-}
-
-/* ============= ------------------ ============= */

…bson/src/commonMain/kotlin/BsonCodecs.kt …bson/src/commonMain/kotlin/BsonCodecs.ktped-bson/src/commonMain/kotlin/BsonCodecs.kt renamed to cufyorg-PED-bson/src/commonMain/kotlin/BsonCodecs.kt ped-bson/src/commonMain/kotlin/BsonCodecs.kt renamed to cufyorg-PED-bson/src/commonMain/kotlin/BsonCodecs.kt

@@ -15,8 +15,8 @@
  */
 package org.cufy.ped
 
-import org.cufy.bson.BsonDocumentLike
 import org.cufy.bson.BsonElement
+import org.cufy.bson.DeprecatedWithContextParameters
 import org.cufy.bson.MutableBsonMapField
 
 /* ============= ------------------ ============= */
@@ -43,6 +43,7 @@ import org.cufy.bson.MutableBsonMapField
  * @author LSafer
  * @since 2.0.0
  */
+@DeprecatedWithContextParameters
 interface BsonFieldCodec<I, O : BsonElement> : FieldCodec<I, O>, MutableBsonMapField<I> {
     override fun encode(value: I): BsonElement =
         encode(value, this)
@@ -53,6 +54,7 @@ interface BsonFieldCodec<I, O : BsonElement> : FieldCodec<I, O>, MutableBsonMapF
  * and backed by the given [codec].
  */
 @Suppress("FunctionName")
+@DeprecatedWithContextParameters
 fun <I, O : BsonElement> FieldCodec(name: String, codec: Codec<I, O>): BsonFieldCodec<I, O> {
     return object : BsonFieldCodec<I, O>, Codec<I, O> by codec {
         override val name = name
@@ -64,7 +66,8 @@ fun <I, O : BsonElement> FieldCodec(name: String, codec: Codec<I, O>): BsonField
 /**
  * Return a new codec backed by this codec that returns the given [defaultValue] when decoding fails.
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> BsonFieldCodec<I, O>.defaultIn(defaultValue: I): BsonFieldCodec<I, O> {
     val codec = this as Codec<I, O>
     return FieldCodec(name, codec defaultIn defaultValue)
@@ -73,7 +76,8 @@ infix fun <I, O : BsonElement> BsonFieldCodec<I, O>.defaultIn(defaultValue: I):
 /**
  * Return a new codec backed by this codec that returns the result of invoking the given [block] when decoding fails.
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> BsonFieldCodec<I, O>.catchIn(block: (Throwable) -> I): BsonFieldCodec<I, O> {
     val codec = this as Codec<I, O>
     return FieldCodec(name, codec catchIn block)
@@ -82,7 +86,8 @@ infix fun <I, O : BsonElement> BsonFieldCodec<I, O>.catchIn(block: (Throwable) -
 /**
  * Return a new codec backed by this codec that returns the given [defaultValue] when encoding fails.
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> BsonFieldCodec<I, O>.defaultOut(defaultValue: O): BsonFieldCodec<I, O> {
     val codec = this as Codec<I, O>
     return FieldCodec(name, codec defaultOut defaultValue)
@@ -91,29 +96,21 @@ infix fun <I, O : BsonElement> BsonFieldCodec<I, O>.defaultOut(defaultValue: O):
 /**
  * Return a new codec backed by this codec that returns the result of invoking the given [block] when encoding fails.
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> BsonFieldCodec<I, O>.catchOut(block: (Throwable) -> O): BsonFieldCodec<I, O> {
     val codec = this as Codec<I, O>
     return FieldCodec(name, codec catchOut block)
 }
 
 /* ============= ------------------ ============= */
 
-/**
- * Return a field codec derived from this one with
- * its name tagged with the given language [tag].
- */
-@PedMarker3
-infix fun <I, O : BsonElement> BsonFieldCodec<I, O>.lang(tag: String): BsonFieldCodec<I, O> {
-    if (tag.isEmpty()) return this
-    return FieldCodec("$name#$tag", this)
-}
-
 /**
  * Create a new field codec with the given [name]
  * and backed by [this] codec.
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> Codec<I, O>.at(name: String): BsonFieldCodec<I, O> {
     return FieldCodec(name, this)
 }
@@ -131,18 +128,10 @@ infix fun <I, O : BsonElement> Codec<I, O>.at(name: String): BsonFieldCodec<I, O
  * }
  * ```
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> String.be(codec: Codec<I, O>): BsonFieldCodec<I, O> {
     return FieldCodec(this, codec)
 }
 
-/**
- * Get the value of the field with the name of the
- * given [codec] and decode it using the given [codec].
- */
-operator fun <I> BsonDocumentLike.get(codec: FieldCodec<I, out BsonElement>): I {
-    val element = this[codec.name]
-    return decodeAny(element, codec)
-}
-
 /* ============= ------------------ ============= */

…/src/commonMain/kotlin/BsonFieldCodec.kt …/src/commonMain/kotlin/BsonFieldCodec.ktped-bson/src/commonMain/kotlin/BsonFieldCodec.kt renamed to cufyorg-PED-bson/src/commonMain/kotlin/BsonFieldCodec.kt ped-bson/src/commonMain/kotlin/BsonFieldCodec.kt renamed to cufyorg-PED-bson/src/commonMain/kotlin/BsonFieldCodec.kt

@@ -16,6 +16,7 @@
 package org.cufy.ped
 
 import org.cufy.bson.BsonElement
+import org.cufy.bson.DeprecatedWithContextParameters
 import org.cufy.bson.MutableBsonMapField
 
 /* ============= ------------------ ============= */
@@ -42,13 +43,15 @@ import org.cufy.bson.MutableBsonMapField
  * @author LSafer
  * @since 2.0.0
  */
+@DeprecatedWithContextParameters
 interface BsonNullableFieldCodec<I, O : BsonElement> : NullableFieldCodec<I, O>, BsonFieldCodec<I?, O>
 
 /**
  * Create a new field codec with the given [name]
  * and backed by the given [codec].
  */
 @Suppress("FunctionName")
+@DeprecatedWithContextParameters
 fun <I, O : BsonElement> FieldCodec(name: String, codec: NullableCodec<I, O>): BsonNullableFieldCodec<I, O> {
     return object : BsonNullableFieldCodec<I, O>, NullableCodec<I, O> by codec {
         override val name = name
@@ -60,7 +63,8 @@ fun <I, O : BsonElement> FieldCodec(name: String, codec: NullableCodec<I, O>): B
 /**
  * Return a new codec backed by this codec that returns the given [defaultValue] when decoding fails.
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> BsonNullableFieldCodec<I, O>.defaultIn(defaultValue: I): BsonNullableFieldCodec<I, O> {
     val codec = this as NullableCodec<I, O>
     return FieldCodec(name, codec defaultIn defaultValue)
@@ -69,7 +73,8 @@ infix fun <I, O : BsonElement> BsonNullableFieldCodec<I, O>.defaultIn(defaultVal
 /**
  * Return a new codec backed by this codec that returns the result of invoking the given [block] when decoding fails.
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> BsonNullableFieldCodec<I, O>.catchIn(block: (Throwable) -> I): BsonNullableFieldCodec<I, O> {
     val codec = this as NullableCodec<I, O>
     return FieldCodec(name, codec catchIn block)
@@ -78,7 +83,8 @@ infix fun <I, O : BsonElement> BsonNullableFieldCodec<I, O>.catchIn(block: (Thro
 /**
  * Return a new codec backed by this codec that returns the given [defaultValue] when encoding fails.
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> BsonNullableFieldCodec<I, O>.defaultOut(defaultValue: O): BsonNullableFieldCodec<I, O> {
     val codec = this as NullableCodec<I, O>
     return FieldCodec(name, codec defaultOut defaultValue)
@@ -87,29 +93,21 @@ infix fun <I, O : BsonElement> BsonNullableFieldCodec<I, O>.defaultOut(defaultVa
 /**
  * Return a new codec backed by this codec that returns the result of invoking the given [block] when encoding fails.
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> BsonNullableFieldCodec<I, O>.catchOut(block: (Throwable) -> O): BsonNullableFieldCodec<I, O> {
     val codec = this as NullableCodec<I, O>
     return FieldCodec(name, codec catchOut block)
 }
 
 /* ============= ------------------ ============= */
 
-/**
- * Return a field codec derived from this one with
- * its name tagged with the given language [tag].
- */
-@PedMarker3
-infix fun <I, O : BsonElement> BsonNullableFieldCodec<I, O>.lang(tag: String): BsonNullableFieldCodec<I, O> {
-    if (tag.isEmpty()) return this
-    return FieldCodec("$name#$tag", this)
-}
-
 /**
  * Create a new field codec with the given [name]
  * and backed by [this] codec.
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> NullableCodec<I, O>.at(name: String): BsonNullableFieldCodec<I, O> {
     return FieldCodec(name, this)
 }
@@ -127,7 +125,8 @@ infix fun <I, O : BsonElement> NullableCodec<I, O>.at(name: String): BsonNullabl
  * }
  * ```
  */
-@PedMarker3
+@PEDMarker3
+@DeprecatedWithContextParameters
 infix fun <I, O : BsonElement> String.be(codec: NullableCodec<I, O>): BsonNullableFieldCodec<I, O> {
     return FieldCodec(this, codec)
 }