mirror of
https://github.com/Novaloop-AG/element-x-android.git
synced 2026-11-02 12:07:28 +00:00
Rename PreviewParameterProvider subclasses to the PreviewParam suffix
The `Provider` suffix reads as a dependency provider rather than as preview
data, and it collides with the real providers in the codebase — `StringProvider`,
`PickerProvider`, the login feature's `AccountProvider` — so the name says
nothing about which of the two a class is. `PreviewParam` says it.
195 classes are renamed, along with the 185 files named after them, the konsist
rule that enforces the convention, the presentation-class file templates and the
onboarding documentation.
This cannot be split. `Konsist.scopeFromProduction()` scans the whole project, so
flipping the assertion before every class has moved leaves the rule red, and a
rule that accepted either suffix during a transition would be exactly the kind of
compatibility layer this convention change is meant to remove.
Two judgement calls in the rule itself. The `name.endsWith("PreviewProvider")`
exclusion is dropped: its only job was to reject a redundant `Preview` before
`Provider`, and the new suffix already contains it; no class currently ends with
`PreviewProvider`, so removing it changes nothing today. And
`EditableAvatarViewUriProvider` is renamed rather than deleted from the exclusion
list even though no such class exists in this repository, since it presumably
comes from the modules overlaid for the enterprise build.
Nothing keyed off the old suffix: no snapshot filename contains a provider class
name, so no Paparazzi image changes, and the Kover variants match on `*Presenter`,
`*State` and `*ViewKt`, so coverage bounds are unaffected.
This commit is contained in:
+1
-1
@@ -11,7 +11,7 @@ package io.element.android.features.preferences.impl.about
|
||||
import androidx.compose.ui.tooling.preview.PreviewParameterProvider
|
||||
import kotlinx.collections.immutable.toImmutableList
|
||||
|
||||
open class AboutStateProvider : PreviewParameterProvider<AboutState> {
|
||||
open class AboutStatePreviewParam : PreviewParameterProvider<AboutState> {
|
||||
override val values: Sequence<AboutState>
|
||||
get() = sequenceOf(
|
||||
anAboutState(),
|
||||
+1
-1
@@ -51,7 +51,7 @@ fun AboutView(
|
||||
|
||||
@PreviewsDayNight
|
||||
@Composable
|
||||
internal fun AboutViewPreview(@PreviewParameter(AboutStateProvider::class) state: AboutState) = ElementPreview {
|
||||
internal fun AboutViewPreview(@PreviewParameter(AboutStatePreviewParam::class) state: AboutState) = ElementPreview {
|
||||
AboutView(
|
||||
state = state,
|
||||
onElementLegalClick = {},
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ import io.element.android.libraries.preferences.api.store.VideoCompressionPreset
|
||||
import kotlinx.collections.immutable.ImmutableList
|
||||
import kotlinx.collections.immutable.toImmutableList
|
||||
|
||||
open class AdvancedSettingsStateProvider : PreviewParameterProvider<AdvancedSettingsState> {
|
||||
open class AdvancedSettingsStatePreviewParam : PreviewParameterProvider<AdvancedSettingsState> {
|
||||
override val values: Sequence<AdvancedSettingsState>
|
||||
get() = sequenceOf(
|
||||
aAdvancedSettingsState(),
|
||||
+3
-3
@@ -410,17 +410,17 @@ private fun LiveLocationUpdatesSection(
|
||||
|
||||
@PreviewWithLargeHeight
|
||||
@Composable
|
||||
internal fun AdvancedSettingsViewLightPreview(@PreviewParameter(AdvancedSettingsStateProvider::class) state: AdvancedSettingsState) =
|
||||
internal fun AdvancedSettingsViewLightPreview(@PreviewParameter(AdvancedSettingsStatePreviewParam::class) state: AdvancedSettingsState) =
|
||||
ElementPreviewLight { ContentToPreview(state) }
|
||||
|
||||
@PreviewWithLargeHeight
|
||||
@Composable
|
||||
internal fun AdvancedSettingsViewDarkPreview(@PreviewParameter(AdvancedSettingsStateProvider::class) state: AdvancedSettingsState) =
|
||||
internal fun AdvancedSettingsViewDarkPreview(@PreviewParameter(AdvancedSettingsStatePreviewParam::class) state: AdvancedSettingsState) =
|
||||
ElementPreviewDark { ContentToPreview(state) }
|
||||
|
||||
@PreviewWithLargeHeight
|
||||
@Composable
|
||||
internal fun AdvancedSettingsViewBlackPreview(@PreviewParameter(AdvancedSettingsStateProvider::class) state: AdvancedSettingsState) =
|
||||
internal fun AdvancedSettingsViewBlackPreview(@PreviewParameter(AdvancedSettingsStatePreviewParam::class) state: AdvancedSettingsState) =
|
||||
ElementPreviewBlack { ContentToPreview(state) }
|
||||
|
||||
@ExcludeFromCoverage
|
||||
|
||||
+1
-1
@@ -11,7 +11,7 @@ package io.element.android.features.preferences.impl.analytics
|
||||
import androidx.compose.ui.tooling.preview.PreviewParameterProvider
|
||||
import io.element.android.features.analytics.api.preferences.aAnalyticsPreferencesState
|
||||
|
||||
open class AnalyticsSettingsStateProvider : PreviewParameterProvider<AnalyticsSettingsState> {
|
||||
open class AnalyticsSettingsStatePreviewParam : PreviewParameterProvider<AnalyticsSettingsState> {
|
||||
override val values: Sequence<AnalyticsSettingsState>
|
||||
get() = sequenceOf(
|
||||
aAnalyticsSettingsState(),
|
||||
+1
-1
@@ -37,7 +37,7 @@ fun AnalyticsSettingsView(
|
||||
|
||||
@PreviewsDayNight
|
||||
@Composable
|
||||
internal fun AnalyticsSettingsViewPreview(@PreviewParameter(AnalyticsSettingsStateProvider::class) state: AnalyticsSettingsState) = ElementPreview {
|
||||
internal fun AnalyticsSettingsViewPreview(@PreviewParameter(AnalyticsSettingsStatePreviewParam::class) state: AnalyticsSettingsState) = ElementPreview {
|
||||
AnalyticsSettingsView(
|
||||
state = state,
|
||||
onBackClick = {},
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ import io.element.android.libraries.matrix.api.user.MatrixUser
|
||||
import io.element.android.libraries.matrix.ui.components.aMatrixUserList
|
||||
import kotlinx.collections.immutable.toImmutableList
|
||||
|
||||
class BlockedUsersStateProvider : PreviewParameterProvider<BlockedUsersState> {
|
||||
class BlockedUsersStatePreviewParam : PreviewParameterProvider<BlockedUsersState> {
|
||||
override val values: Sequence<BlockedUsersState>
|
||||
get() = sequenceOf(
|
||||
aBlockedUsersState(),
|
||||
+1
-1
@@ -126,7 +126,7 @@ private fun BlockedUserItem(
|
||||
|
||||
@PreviewsDayNight
|
||||
@Composable
|
||||
internal fun BlockedUsersViewPreview(@PreviewParameter(BlockedUsersStateProvider::class) state: BlockedUsersState) {
|
||||
internal fun BlockedUsersViewPreview(@PreviewParameter(BlockedUsersStatePreviewParam::class) state: BlockedUsersState) {
|
||||
ElementPreview {
|
||||
BlockedUsersView(
|
||||
state = state,
|
||||
|
||||
+1
-1
@@ -16,7 +16,7 @@ import io.element.android.libraries.architecture.AsyncData
|
||||
import io.element.android.libraries.matrix.api.core.DeviceId
|
||||
import kotlinx.collections.immutable.persistentMapOf
|
||||
|
||||
open class DeveloperSettingsStateProvider : PreviewParameterProvider<DeveloperSettingsState> {
|
||||
open class DeveloperSettingsStatePreviewParam : PreviewParameterProvider<DeveloperSettingsState> {
|
||||
override val values: Sequence<DeveloperSettingsState>
|
||||
get() = sequenceOf(
|
||||
aDeveloperSettingsState(),
|
||||
+1
-1
@@ -231,7 +231,7 @@ private fun NotificationCategory(onPushHistoryClick: () -> Unit) {
|
||||
@PreviewsDayNight
|
||||
@Composable
|
||||
internal fun DeveloperSettingsViewPreview(
|
||||
@PreviewParameter(DeveloperSettingsStateProvider::class) state: DeveloperSettingsState
|
||||
@PreviewParameter(DeveloperSettingsStatePreviewParam::class) state: DeveloperSettingsState
|
||||
) = ElementPreview {
|
||||
DeveloperSettingsView(
|
||||
state = state,
|
||||
|
||||
+1
-1
@@ -15,7 +15,7 @@ import io.element.android.libraries.featureflag.ui.model.aFeatureUiModelList
|
||||
import io.element.android.libraries.matrix.api.tracing.TraceLogPack
|
||||
import kotlinx.collections.immutable.toImmutableList
|
||||
|
||||
open class AppDeveloperSettingsStateProvider : PreviewParameterProvider<AppDeveloperSettingsState> {
|
||||
open class AppDeveloperSettingsStatePreviewParam : PreviewParameterProvider<AppDeveloperSettingsState> {
|
||||
override val values: Sequence<AppDeveloperSettingsState>
|
||||
get() = sequenceOf(
|
||||
anAppDeveloperSettingsState(),
|
||||
+1
-1
@@ -182,7 +182,7 @@ private fun FeatureListContent(
|
||||
@PreviewsDayNight
|
||||
@Composable
|
||||
internal fun AppDeveloperSettingsViewPreview(
|
||||
@PreviewParameter(AppDeveloperSettingsStateProvider::class) state: AppDeveloperSettingsState
|
||||
@PreviewParameter(AppDeveloperSettingsStatePreviewParam::class) state: AppDeveloperSettingsState
|
||||
) = ElementPreview {
|
||||
AppDeveloperSettingsView(
|
||||
state = state,
|
||||
|
||||
+1
-1
@@ -14,7 +14,7 @@ import io.element.android.libraries.designsystem.theme.components.IconSource
|
||||
import io.element.android.libraries.featureflag.ui.model.FeatureUiModel
|
||||
import kotlinx.collections.immutable.toImmutableList
|
||||
|
||||
internal class LabsStateProvider : PreviewParameterProvider<LabsState> {
|
||||
internal class LabsStatePreviewParam : PreviewParameterProvider<LabsState> {
|
||||
override val values: Sequence<LabsState>
|
||||
get() = sequenceOf(
|
||||
aLabsState(features = aFeatureList()),
|
||||
+1
-1
@@ -101,7 +101,7 @@ fun LabsView(
|
||||
|
||||
@PreviewsDayNight
|
||||
@Composable
|
||||
internal fun LabsViewPreview(@PreviewParameter(LabsStateProvider::class) state: LabsState) {
|
||||
internal fun LabsViewPreview(@PreviewParameter(LabsStatePreviewParam::class) state: LabsState) {
|
||||
ElementPreview {
|
||||
LabsView(state = state, onBack = {})
|
||||
}
|
||||
|
||||
+1
-1
@@ -19,7 +19,7 @@ import io.element.android.libraries.pushproviders.api.Distributor
|
||||
import kotlinx.collections.immutable.persistentListOf
|
||||
import kotlinx.collections.immutable.toImmutableList
|
||||
|
||||
open class NotificationSettingsStateProvider : PreviewParameterProvider<NotificationSettingsState> {
|
||||
open class NotificationSettingsStatePreviewParam : PreviewParameterProvider<NotificationSettingsState> {
|
||||
override val values: Sequence<NotificationSettingsState>
|
||||
get() = sequenceOf(
|
||||
aValidNotificationSettingsState(systemNotificationsEnabled = false),
|
||||
+3
-1
@@ -500,7 +500,9 @@ private fun InvalidNotificationSettingsView(
|
||||
|
||||
@PreviewsDayNight
|
||||
@Composable
|
||||
internal fun NotificationSettingsViewPreview(@PreviewParameter(NotificationSettingsStateProvider::class) state: NotificationSettingsState) = ElementPreview {
|
||||
internal fun NotificationSettingsViewPreview(@PreviewParameter(
|
||||
NotificationSettingsStatePreviewParam::class
|
||||
) state: NotificationSettingsState) = ElementPreview {
|
||||
NotificationSettingsView(
|
||||
state = state,
|
||||
onBackClick = {},
|
||||
|
||||
+1
-1
@@ -16,7 +16,7 @@ import io.element.android.libraries.matrix.api.core.RoomId
|
||||
import io.element.android.libraries.matrix.api.room.RoomNotificationMode
|
||||
import kotlinx.collections.immutable.persistentListOf
|
||||
|
||||
open class EditDefaultNotificationSettingStateProvider : PreviewParameterProvider<EditDefaultNotificationSettingState> {
|
||||
open class EditDefaultNotificationSettingStatePreviewParam : PreviewParameterProvider<EditDefaultNotificationSettingState> {
|
||||
override val values: Sequence<EditDefaultNotificationSettingState>
|
||||
get() = sequenceOf(
|
||||
anEditDefaultNotificationSettingsState(),
|
||||
+1
-1
@@ -125,7 +125,7 @@ fun EditDefaultNotificationSettingView(
|
||||
@PreviewsDayNight
|
||||
@Composable
|
||||
internal fun EditDefaultNotificationSettingViewPreview(
|
||||
@PreviewParameter(EditDefaultNotificationSettingStateProvider::class) state: EditDefaultNotificationSettingState
|
||||
@PreviewParameter(EditDefaultNotificationSettingStatePreviewParam::class) state: EditDefaultNotificationSettingState
|
||||
) = ElementPreview {
|
||||
EditDefaultNotificationSettingView(
|
||||
state = state,
|
||||
|
||||
+1
-1
@@ -21,7 +21,7 @@ import io.element.android.libraries.matrix.ui.components.aMatrixUserList
|
||||
import io.element.android.libraries.ui.strings.CommonStrings
|
||||
import kotlinx.collections.immutable.toImmutableList
|
||||
|
||||
open class PreferencesRootStateProvider : PreviewParameterProvider<PreferencesRootState> {
|
||||
open class PreferencesRootStatePreviewParam : PreviewParameterProvider<PreferencesRootState> {
|
||||
override val values: Sequence<PreferencesRootState>
|
||||
get() = sequenceOf(
|
||||
// Nominal state, that a regular user will see if multi account is enabled
|
||||
+2
-2
@@ -373,14 +373,14 @@ private fun DeveloperPreferencesView(onOpenDeveloperSettings: () -> Unit) {
|
||||
|
||||
@PreviewWithLargeHeight
|
||||
@Composable
|
||||
internal fun PreferencesRootViewLightPreview(@PreviewParameter(PreferencesRootStateProvider::class) state: PreferencesRootState) =
|
||||
internal fun PreferencesRootViewLightPreview(@PreviewParameter(PreferencesRootStatePreviewParam::class) state: PreferencesRootState) =
|
||||
ElementPreviewLight(
|
||||
drawableFallbackForImages = CommonDrawables.sample_avatar,
|
||||
) { ContentToPreview(state) }
|
||||
|
||||
@PreviewWithLargeHeight
|
||||
@Composable
|
||||
internal fun PreferencesRootViewDarkPreview(@PreviewParameter(PreferencesRootStateProvider::class) state: PreferencesRootState) =
|
||||
internal fun PreferencesRootViewDarkPreview(@PreviewParameter(PreferencesRootStatePreviewParam::class) state: PreferencesRootState) =
|
||||
ElementPreviewDark(
|
||||
drawableFallbackForImages = CommonDrawables.sample_avatar,
|
||||
) { ContentToPreview(state) }
|
||||
|
||||
+2
-2
@@ -15,7 +15,7 @@ import io.element.android.libraries.designsystem.preview.ElementPreview
|
||||
import io.element.android.libraries.designsystem.preview.PreviewsDayNight
|
||||
import io.element.android.libraries.matrix.api.user.MatrixUser
|
||||
import io.element.android.libraries.matrix.ui.components.MatrixUserHeader
|
||||
import io.element.android.libraries.matrix.ui.components.MatrixUserProvider
|
||||
import io.element.android.libraries.matrix.ui.components.MatrixUserPreviewParam
|
||||
|
||||
@Composable
|
||||
fun UserPreferences(
|
||||
@@ -30,6 +30,6 @@ fun UserPreferences(
|
||||
|
||||
@PreviewsDayNight
|
||||
@Composable
|
||||
internal fun UserPreferencesPreview(@PreviewParameter(MatrixUserProvider::class) matrixUser: MatrixUser) = ElementPreview {
|
||||
internal fun UserPreferencesPreview(@PreviewParameter(MatrixUserPreviewParam::class) matrixUser: MatrixUser) = ElementPreview {
|
||||
UserPreferences(matrixUser)
|
||||
}
|
||||
|
||||
+1
-1
@@ -17,7 +17,7 @@ import io.element.android.libraries.permissions.api.PermissionsState
|
||||
import io.element.android.libraries.permissions.api.aPermissionsState
|
||||
import kotlinx.collections.immutable.toImmutableList
|
||||
|
||||
open class EditUserProfileStateProvider : PreviewParameterProvider<EditUserProfileState> {
|
||||
open class EditUserProfileStatePreviewParam : PreviewParameterProvider<EditUserProfileState> {
|
||||
override val values: Sequence<EditUserProfileState>
|
||||
get() = sequenceOf(
|
||||
aEditUserProfileState(),
|
||||
+1
-1
@@ -178,7 +178,7 @@ fun EditUserProfileView(
|
||||
|
||||
@PreviewsDayNight
|
||||
@Composable
|
||||
internal fun EditUserProfileViewPreview(@PreviewParameter(EditUserProfileStateProvider::class) state: EditUserProfileState) =
|
||||
internal fun EditUserProfileViewPreview(@PreviewParameter(EditUserProfileStatePreviewParam::class) state: EditUserProfileState) =
|
||||
ElementPreview {
|
||||
EditUserProfileView(
|
||||
onEditProfileSuccess = {},
|
||||
|
||||
+1
-1
@@ -13,7 +13,7 @@ import io.element.android.libraries.architecture.AsyncAction
|
||||
import io.element.android.libraries.matrix.api.user.DisplayedStatus
|
||||
import io.element.android.libraries.matrix.api.user.UserStatus
|
||||
|
||||
internal class UserStatusStateProvider : PreviewParameterProvider<UserStatusState> {
|
||||
internal class UserStatusStatePreviewParam : PreviewParameterProvider<UserStatusState> {
|
||||
override val values get() = sequenceOf(
|
||||
aUserStatusState(),
|
||||
aUserStatusState(displayedStatus = DisplayedStatus.UserSet(UserStatus("🌴", "Away"))),
|
||||
+1
-1
@@ -354,7 +354,7 @@ private fun EmojiPickerBottomSheet(
|
||||
|
||||
@PreviewsDayNight
|
||||
@Composable
|
||||
internal fun UserStatusViewPreview(@PreviewParameter(UserStatusStateProvider::class) state: UserStatusState) = ElementPreview {
|
||||
internal fun UserStatusViewPreview(@PreviewParameter(UserStatusStatePreviewParam::class) state: UserStatusState) = ElementPreview {
|
||||
UserStatusView(
|
||||
state = state,
|
||||
emojiPickerRenderer = NoOpEmojiPickerRenderer,
|
||||
|
||||
Reference in New Issue
Block a user