Skip to content

Commit

Permalink
Recognize deprecated fields by their description.
Browse files Browse the repository at this point in the history 
If a class, function, or parameter description starts with "deprecated"
case insensitive, then mark the field as @deprecated and include the
description as the reason instead of adding it as KDoc.
  • Loading branch information
@christiandeange
christiandeange committed Feb 26, 2024
1 parent e3908e2 commit 6c11360
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 61 deletions.
44 changes: 0 additions & 44 deletions bluesky/api/bluesky.api
View file
Original file line number Diff line number Diff line change
Expand Up @@ -729,7 +729,6 @@ public final class app/bsky/actor/SearchActorsQueryParams {
public final fun getCursor ()Ljava/lang/String;
public final fun getLimit ()Ljava/lang/Long;
public final fun getQ ()Ljava/lang/String;
public final fun getTerm ()Ljava/lang/String;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}
Expand Down Expand Up @@ -771,7 +770,6 @@ public final class app/bsky/actor/SearchActorsTypeaheadQueryParams {
public fun equals (Ljava/lang/Object;)Z
public final fun getLimit ()Ljava/lang/Long;
public final fun getQ ()Ljava/lang/String;
public final fun getTerm ()Ljava/lang/String;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}
Expand Down Expand Up @@ -2580,7 +2578,6 @@ public final class app/bsky/feed/Post {
public fun equals (Ljava/lang/Object;)Z
public final fun getCreatedAt ()Lkotlinx/datetime/Instant;
public final fun getEmbed ()Lapp/bsky/feed/PostEmbedUnion;
public final fun getEntities ()Lkotlinx/collections/immutable/ImmutableList;
public final fun getFacets ()Lkotlinx/collections/immutable/ImmutableList;
public final fun getLabels ()Lapp/bsky/feed/PostLabelsUnion;
public final fun getLangs ()Lkotlinx/collections/immutable/ImmutableList;
Expand Down Expand Up @@ -2715,22 +2712,6 @@ public final class app/bsky/feed/PostEmbedUnion$RecordWithMediaSerializer : kotl
public fun serialize-mabN7vo (Lkotlinx/serialization/encoding/Encoder;Lapp/bsky/embed/RecordWithMedia;)V
}

public final class app/bsky/feed/PostEntity {
public static final field Companion Lapp/bsky/feed/PostEntity$Companion;
public fun <init> (Lapp/bsky/feed/PostTextSlice;Ljava/lang/String;Ljava/lang/String;)V
public final fun component1 ()Lapp/bsky/feed/PostTextSlice;
public final fun component2 ()Ljava/lang/String;
public final fun component3 ()Ljava/lang/String;
public final fun copy (Lapp/bsky/feed/PostTextSlice;Ljava/lang/String;Ljava/lang/String;)Lapp/bsky/feed/PostEntity;
public static synthetic fun copy$default (Lapp/bsky/feed/PostEntity;Lapp/bsky/feed/PostTextSlice;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Lapp/bsky/feed/PostEntity;
public fun equals (Ljava/lang/Object;)Z
public final fun getIndex ()Lapp/bsky/feed/PostTextSlice;
public final fun getType ()Ljava/lang/String;
public final fun getValue ()Ljava/lang/String;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final class app/bsky/feed/PostEntity$Companion {
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}
Expand Down Expand Up @@ -2789,20 +2770,6 @@ public final class app/bsky/feed/PostReplyRef$Companion {
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public final class app/bsky/feed/PostTextSlice {
public static final field Companion Lapp/bsky/feed/PostTextSlice$Companion;
public fun <init> (JJ)V
public final fun component1 ()J
public final fun component2 ()J
public final fun copy (JJ)Lapp/bsky/feed/PostTextSlice;
public static synthetic fun copy$default (Lapp/bsky/feed/PostTextSlice;JJILjava/lang/Object;)Lapp/bsky/feed/PostTextSlice;
public fun equals (Ljava/lang/Object;)Z
public final fun getEnd ()J
public final fun getStart ()J
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final class app/bsky/feed/PostTextSlice$Companion {
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}
Expand Down Expand Up @@ -7751,7 +7718,6 @@ public final class com/atproto/admin/SearchReposQueryParams {
public final fun getCursor ()Ljava/lang/String;
public final fun getLimit ()Ljava/lang/Long;
public final fun getQ ()Ljava/lang/String;
public final fun getTerm ()Ljava/lang/String;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}
Expand Down Expand Up @@ -9241,8 +9207,6 @@ public final class com/atproto/repo/ListRecordsQueryParams {
public final fun getLimit ()Ljava/lang/Long;
public final fun getRepo-SnKB-3U ()Ljava/lang/String;
public final fun getReverse ()Ljava/lang/Boolean;
public final fun getRkeyEnd ()Ljava/lang/String;
public final fun getRkeyStart ()Ljava/lang/String;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}
Expand Down Expand Up @@ -10387,8 +10351,6 @@ public final class com/atproto/sync/SubscribeReposCommit {
public final fun getBlocks ()[B
public final fun getCommit ()[B
public final fun getOps ()Lkotlinx/collections/immutable/ImmutableList;
public final fun getPrev ()[B
public final fun getRebase ()Z
public final fun getRepo-715Ygxc ()Ljava/lang/String;
public final fun getRev ()Ljava/lang/String;
public final fun getSeq ()J
Expand Down Expand Up @@ -10831,7 +10793,6 @@ public abstract interface class sh/christian/ozone/BlueskyApi {
public abstract fun disableInviteCodes (Lcom/atproto/admin/DisableInviteCodesRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun emitModerationEvent (Lcom/atproto/admin/EmitModerationEventRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun enableAccountInvites (Lcom/atproto/admin/EnableAccountInvitesRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun fetchLabels (Lcom/atproto/temp/FetchLabelsQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getAccountInfo (Lcom/atproto/admin/GetAccountInfoQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getAccountInfos (Lcom/atproto/admin/GetAccountInfosQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getAccountInviteCodes (Lcom/atproto/server/GetAccountInviteCodesQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
Expand All @@ -10841,14 +10802,12 @@ public abstract interface class sh/christian/ozone/BlueskyApi {
public abstract fun getBlob (Lcom/atproto/sync/GetBlobQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getBlocks (Lapp/bsky/graph/GetBlocksQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getBlocks (Lcom/atproto/sync/GetBlocksQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getCheckout (Lcom/atproto/sync/GetCheckoutQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getFeed (Lapp/bsky/feed/GetFeedQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getFeedGenerator (Lapp/bsky/feed/GetFeedGeneratorQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getFeedGenerators (Lapp/bsky/feed/GetFeedGeneratorsQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getFeedSkeleton (Lapp/bsky/feed/GetFeedSkeletonQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getFollowers (Lapp/bsky/graph/GetFollowersQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getFollows (Lapp/bsky/graph/GetFollowsQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getHead (Lcom/atproto/sync/GetHeadQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getInviteCodes (Lcom/atproto/admin/GetInviteCodesQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getLatestCommit (Lcom/atproto/sync/GetLatestCommitQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public abstract fun getLikes (Lapp/bsky/feed/GetLikesQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
Expand Down Expand Up @@ -10963,7 +10922,6 @@ public final class sh/christian/ozone/XrpcBlueskyApi : sh/christian/ozone/Bluesk
public fun disableInviteCodes (Lcom/atproto/admin/DisableInviteCodesRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun emitModerationEvent (Lcom/atproto/admin/EmitModerationEventRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun enableAccountInvites (Lcom/atproto/admin/EnableAccountInvitesRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun fetchLabels (Lcom/atproto/temp/FetchLabelsQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getAccountInfo (Lcom/atproto/admin/GetAccountInfoQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getAccountInfos (Lcom/atproto/admin/GetAccountInfosQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getAccountInviteCodes (Lcom/atproto/server/GetAccountInviteCodesQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
Expand All @@ -10973,14 +10931,12 @@ public final class sh/christian/ozone/XrpcBlueskyApi : sh/christian/ozone/Bluesk
public fun getBlob (Lcom/atproto/sync/GetBlobQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getBlocks (Lapp/bsky/graph/GetBlocksQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getBlocks (Lcom/atproto/sync/GetBlocksQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getCheckout (Lcom/atproto/sync/GetCheckoutQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getFeed (Lapp/bsky/feed/GetFeedQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getFeedGenerator (Lapp/bsky/feed/GetFeedGeneratorQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getFeedGenerators (Lapp/bsky/feed/GetFeedGeneratorsQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getFeedSkeleton (Lapp/bsky/feed/GetFeedSkeletonQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getFollowers (Lapp/bsky/graph/GetFollowersQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getFollows (Lapp/bsky/graph/GetFollowsQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getHead (Lcom/atproto/sync/GetHeadQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getInviteCodes (Lcom/atproto/admin/GetInviteCodesQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getLatestCommit (Lcom/atproto/sync/GetLatestCommitQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
public fun getLikes (Lapp/bsky/feed/GetLikesQueryParams;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
Expand Down
8 changes: 3 additions & 5 deletions generator/src/main/kotlin/sh/christian/ozone/api/generator/LexiconApiGenerator.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import sh.christian.ozone.api.generator.TypeNames.AtpResponse
import sh.christian.ozone.api.generator.TypeNames.Flow
import sh.christian.ozone.api.generator.TypeNames.Result
import sh.christian.ozone.api.generator.builder.GeneratorContext
import sh.christian.ozone.api.generator.builder.addDescription
import sh.christian.ozone.api.lexicon.LexiconArray
import sh.christian.ozone.api.lexicon.LexiconBlob
import sh.christian.ozone.api.lexicon.LexiconDocument
Expand Down Expand Up @@ -154,20 +155,17 @@ class LexiconApiGenerator(
is Subscription -> Flow.parameterizedBy(returnType.wrap(outputType.typeName))
}

description?.let { description ->
addKdoc(description)
}

if (inputType != null) {
addParameter(
ParameterSpec.builder(name, inputType.typeName)
.apply { inputType.description?.let { addKdoc(it) } }
.addDescription(inputType.description)
.build()
)
}

returns(outputType)
}
.addDescription(description)
.apply(block)
.build()
}
Expand Down
1 change: 1 addition & 0 deletions generator/src/main/kotlin/sh/christian/ozone/api/generator/TypeNames.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ object TypeNames {
val Blob by classOfPackage("sh.christian.ozone.api.model")
val ByteString by classOfPackage("kotlinx.serialization.cbor")
val Cid by classOfPackage("sh.christian.ozone.api")
val Deprecated by classOfPackage("kotlin")
val Did by classOfPackage("sh.christian.ozone.api")
val Flow by classOfPackage("kotlinx.coroutines.flow")
val Handle by classOfPackage("sh.christian.ozone.api")
Expand Down
32 changes: 20 additions & 12 deletions generator/src/main/kotlin/sh/christian/ozone/api/generator/builder/util.kt
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
package sh.christian.ozone.api.generator.builder

import com.squareup.kotlinpoet.Annotatable
import com.squareup.kotlinpoet.AnnotationSpec
import com.squareup.kotlinpoet.BYTE_ARRAY
import com.squareup.kotlinpoet.ClassName
import com.squareup.kotlinpoet.CodeBlock
import com.squareup.kotlinpoet.Documentable
import com.squareup.kotlinpoet.Dynamic
import com.squareup.kotlinpoet.FunSpec
import com.squareup.kotlinpoet.KModifier
Expand Down Expand Up @@ -60,6 +62,7 @@ fun createDataClass(
return TypeSpec.classBuilder(className)
.addModifiers(KModifier.DATA)
.addAnnotation(TypeNames.Serializable)
.addDescription(description)
.primaryConstructor(
FunSpec.constructorBuilder()
.addParameters(
Expand All @@ -75,9 +78,7 @@ fun createDataClass(
if (property.nullable) {
defaultValue(property.defaultValue())
}
if (property.description != null) {
addKdoc(property.description)
}
addDescription(property.description)
if (property.type.hasClassName(BYTE_ARRAY)) {
addAnnotation(AnnotationSpec.builder(TypeNames.ByteString).build())
}
Expand All @@ -101,10 +102,6 @@ fun createDataClass(
}
)
.apply {
if (description != null) {
addKdoc(description)
}

val allRequirements = properties.associateWith { it.requirements }.filterValues { it.isNotEmpty() }
if (allRequirements.isNotEmpty()) {
addInitializerBlock(
Expand Down Expand Up @@ -214,11 +211,7 @@ fun createObjectClass(
): TypeSpec {
return TypeSpec.objectBuilder(className)
.addAnnotation(TypeNames.Serializable)
.apply {
if (description != null) {
addKdoc(description)
}
}
.addDescription(description)
.build()
}

Expand Down Expand Up @@ -385,6 +378,21 @@ fun String.toEnumCase(): String {
return CAMEL_CASE_REGEX.replace(this) { "_${it.value}" }.uppercase().replace('-', '_')
}

internal fun <T> T.addDescription(description: String?): T
where T : Annotatable.Builder<T>,
T : Documentable.Builder<T> = apply {
if (description != null) {
if (description.startsWith("deprecated", ignoreCase = true)) {
addAnnotation(
AnnotationSpec.builder(TypeNames.Deprecated)
.addMember("%S", description)
.build())
} else {
addKdoc(description)
}
}
}

private fun TypeName.hasClassName(className: ClassName): Boolean = when (this) {
is ClassName -> this.canonicalName == className.canonicalName
is Dynamic -> false
Expand Down

0 comments on commit 6c11360

Please sign in to comment.