From f484be0e0bd8410c53e5dabb151a63dd0b55de52 Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Tue, 27 Feb 2024 09:53:14 +0100 Subject: [PATCH] Renaming function for code clarity. --- .../AttachmentsPreviewStateProvider.kt | 8 ++-- .../mediaviewer/api/local/MediaInfo.kt | 10 ++--- .../api/viewer/MediaViewerStateProvider.kt | 40 +++++++++---------- .../mediaviewer/MediaViewerPresenterTest.kt | 4 +- .../api/viewer/MediaViewerViewTest.kt | 18 ++++----- .../local/AndroidLocalMediaFactoryTest.kt | 4 +- .../mediaviewer/test/viewer/LocalMedia.kt | 4 +- 7 files changed, 44 insertions(+), 44 deletions(-) diff --git a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/attachments/preview/AttachmentsPreviewStateProvider.kt b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/attachments/preview/AttachmentsPreviewStateProvider.kt index 1fdc52cf99..8dbf067b95 100644 --- a/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/attachments/preview/AttachmentsPreviewStateProvider.kt +++ b/features/messages/impl/src/main/kotlin/io/element/android/features/messages/impl/attachments/preview/AttachmentsPreviewStateProvider.kt @@ -21,21 +21,21 @@ import androidx.core.net.toUri import io.element.android.features.messages.impl.attachments.Attachment import io.element.android.libraries.mediaviewer.api.local.LocalMedia import io.element.android.libraries.mediaviewer.api.local.MediaInfo -import io.element.android.libraries.mediaviewer.api.local.aFileInfo -import io.element.android.libraries.mediaviewer.api.local.anImageInfo +import io.element.android.libraries.mediaviewer.api.local.anApkMediaInfo +import io.element.android.libraries.mediaviewer.api.local.anImageMediaInfo open class AttachmentsPreviewStateProvider : PreviewParameterProvider { override val values: Sequence get() = sequenceOf( anAttachmentsPreviewState(), - anAttachmentsPreviewState(mediaInfo = aFileInfo()), + anAttachmentsPreviewState(mediaInfo = anApkMediaInfo()), anAttachmentsPreviewState(sendActionState = SendActionState.Sending.Uploading(0.5f)), anAttachmentsPreviewState(sendActionState = SendActionState.Failure(RuntimeException("error"))), ) } fun anAttachmentsPreviewState( - mediaInfo: MediaInfo = anImageInfo(), + mediaInfo: MediaInfo = anImageMediaInfo(), sendActionState: SendActionState = SendActionState.Idle ) = AttachmentsPreviewState( attachment = Attachment.Media( diff --git a/libraries/mediaviewer/api/src/main/kotlin/io/element/android/libraries/mediaviewer/api/local/MediaInfo.kt b/libraries/mediaviewer/api/src/main/kotlin/io/element/android/libraries/mediaviewer/api/local/MediaInfo.kt index 1def7b4522..71dccfe4d4 100644 --- a/libraries/mediaviewer/api/src/main/kotlin/io/element/android/libraries/mediaviewer/api/local/MediaInfo.kt +++ b/libraries/mediaviewer/api/src/main/kotlin/io/element/android/libraries/mediaviewer/api/local/MediaInfo.kt @@ -28,35 +28,35 @@ data class MediaInfo( val fileExtension: String, ) : Parcelable -fun anImageInfo(): MediaInfo = MediaInfo( +fun anImageMediaInfo(): MediaInfo = MediaInfo( "an image file.jpg", MimeTypes.Jpeg, "4MB", "jpg" ) -fun aVideoInfo(): MediaInfo = MediaInfo( +fun aVideoMediaInfo(): MediaInfo = MediaInfo( "a video file.mp4", MimeTypes.Mp4, "14MB", "mp4" ) -fun aPdfInfo(): MediaInfo = MediaInfo( +fun aPdfMediaInfo(): MediaInfo = MediaInfo( "a pdf file.pdf", MimeTypes.Pdf, "23MB", "pdf" ) -fun aFileInfo(): MediaInfo = MediaInfo( +fun anApkMediaInfo(): MediaInfo = MediaInfo( "an apk file.apk", MimeTypes.Apk, "50MB", "apk" ) -fun anAudioInfo(): MediaInfo = MediaInfo( +fun anAudioMediaInfo(): MediaInfo = MediaInfo( "an audio file.mp3", MimeTypes.Mp3, "7MB", diff --git a/libraries/mediaviewer/api/src/main/kotlin/io/element/android/libraries/mediaviewer/api/viewer/MediaViewerStateProvider.kt b/libraries/mediaviewer/api/src/main/kotlin/io/element/android/libraries/mediaviewer/api/viewer/MediaViewerStateProvider.kt index d46fd64cc7..f7195f1c91 100644 --- a/libraries/mediaviewer/api/src/main/kotlin/io/element/android/libraries/mediaviewer/api/viewer/MediaViewerStateProvider.kt +++ b/libraries/mediaviewer/api/src/main/kotlin/io/element/android/libraries/mediaviewer/api/viewer/MediaViewerStateProvider.kt @@ -21,11 +21,11 @@ import androidx.compose.ui.tooling.preview.PreviewParameterProvider import io.element.android.libraries.architecture.AsyncData import io.element.android.libraries.mediaviewer.api.local.LocalMedia import io.element.android.libraries.mediaviewer.api.local.MediaInfo -import io.element.android.libraries.mediaviewer.api.local.aFileInfo -import io.element.android.libraries.mediaviewer.api.local.aPdfInfo -import io.element.android.libraries.mediaviewer.api.local.aVideoInfo -import io.element.android.libraries.mediaviewer.api.local.anAudioInfo -import io.element.android.libraries.mediaviewer.api.local.anImageInfo +import io.element.android.libraries.mediaviewer.api.local.anApkMediaInfo +import io.element.android.libraries.mediaviewer.api.local.aPdfMediaInfo +import io.element.android.libraries.mediaviewer.api.local.aVideoMediaInfo +import io.element.android.libraries.mediaviewer.api.local.anAudioMediaInfo +import io.element.android.libraries.mediaviewer.api.local.anImageMediaInfo open class MediaViewerStateProvider : PreviewParameterProvider { override val values: Sequence @@ -35,47 +35,47 @@ open class MediaViewerStateProvider : PreviewParameterProvider aMediaViewerState(AsyncData.Failure(IllegalStateException("error"))), aMediaViewerState( AsyncData.Success( - LocalMedia(Uri.EMPTY, anImageInfo()) + LocalMedia(Uri.EMPTY, anImageMediaInfo()) ), - anImageInfo(), + anImageMediaInfo(), ), aMediaViewerState( AsyncData.Success( - LocalMedia(Uri.EMPTY, aVideoInfo()) + LocalMedia(Uri.EMPTY, aVideoMediaInfo()) ), - aVideoInfo(), + aVideoMediaInfo(), ), aMediaViewerState( AsyncData.Success( - LocalMedia(Uri.EMPTY, aPdfInfo()) + LocalMedia(Uri.EMPTY, aPdfMediaInfo()) ), - aPdfInfo(), + aPdfMediaInfo(), ), aMediaViewerState( AsyncData.Loading(), - aFileInfo(), + anApkMediaInfo(), ), aMediaViewerState( AsyncData.Success( - LocalMedia(Uri.EMPTY, aFileInfo()) + LocalMedia(Uri.EMPTY, anApkMediaInfo()) ), - aFileInfo(), + anApkMediaInfo(), ), aMediaViewerState( AsyncData.Loading(), - anAudioInfo(), + anAudioMediaInfo(), ), aMediaViewerState( AsyncData.Success( - LocalMedia(Uri.EMPTY, anAudioInfo()) + LocalMedia(Uri.EMPTY, anAudioMediaInfo()) ), - anAudioInfo(), + anAudioMediaInfo(), ), aMediaViewerState( AsyncData.Success( - LocalMedia(Uri.EMPTY, anImageInfo()) + LocalMedia(Uri.EMPTY, anImageMediaInfo()) ), - anImageInfo(), + anImageMediaInfo(), canDownload = false, canShare = false, ), @@ -84,7 +84,7 @@ open class MediaViewerStateProvider : PreviewParameterProvider fun aMediaViewerState( downloadedMedia: AsyncData = AsyncData.Uninitialized, - mediaInfo: MediaInfo = anImageInfo(), + mediaInfo: MediaInfo = anImageMediaInfo(), canDownload: Boolean = true, canShare: Boolean = true, eventSink: (MediaViewerEvents) -> Unit = {}, diff --git a/libraries/mediaviewer/api/src/test/kotlin/io/element/android/libraries/mediaviewer/MediaViewerPresenterTest.kt b/libraries/mediaviewer/api/src/test/kotlin/io/element/android/libraries/mediaviewer/MediaViewerPresenterTest.kt index c5b761411a..42a0a93c64 100644 --- a/libraries/mediaviewer/api/src/test/kotlin/io/element/android/libraries/mediaviewer/MediaViewerPresenterTest.kt +++ b/libraries/mediaviewer/api/src/test/kotlin/io/element/android/libraries/mediaviewer/MediaViewerPresenterTest.kt @@ -27,7 +27,7 @@ import io.element.android.libraries.architecture.AsyncData import io.element.android.libraries.designsystem.utils.snackbar.SnackbarDispatcher import io.element.android.libraries.matrix.test.media.FakeMediaLoader import io.element.android.libraries.matrix.test.media.aMediaSource -import io.element.android.libraries.mediaviewer.api.local.aFileInfo +import io.element.android.libraries.mediaviewer.api.local.anApkMediaInfo import io.element.android.libraries.mediaviewer.api.viewer.MediaViewerEvents import io.element.android.libraries.mediaviewer.api.viewer.MediaViewerNode import io.element.android.libraries.mediaviewer.api.viewer.MediaViewerPresenter @@ -40,7 +40,7 @@ import kotlinx.coroutines.test.runTest import org.junit.Rule import org.junit.Test -private val TESTED_MEDIA_INFO = aFileInfo() +private val TESTED_MEDIA_INFO = anApkMediaInfo() class MediaViewerPresenterTest { @get:Rule diff --git a/libraries/mediaviewer/api/src/test/kotlin/io/element/android/libraries/mediaviewer/api/viewer/MediaViewerViewTest.kt b/libraries/mediaviewer/api/src/test/kotlin/io/element/android/libraries/mediaviewer/api/viewer/MediaViewerViewTest.kt index 1faeb0772e..e6c210a19d 100644 --- a/libraries/mediaviewer/api/src/test/kotlin/io/element/android/libraries/mediaviewer/api/viewer/MediaViewerViewTest.kt +++ b/libraries/mediaviewer/api/src/test/kotlin/io/element/android/libraries/mediaviewer/api/viewer/MediaViewerViewTest.kt @@ -28,7 +28,7 @@ import androidx.compose.ui.test.swipeDown import androidx.test.ext.junit.runners.AndroidJUnit4 import io.element.android.libraries.architecture.AsyncData import io.element.android.libraries.mediaviewer.api.local.LocalMedia -import io.element.android.libraries.mediaviewer.api.local.anImageInfo +import io.element.android.libraries.mediaviewer.api.local.anImageMediaInfo import io.element.android.libraries.ui.strings.CommonStrings import io.element.android.tests.testutils.EnsureNeverCalled import io.element.android.tests.testutils.EventsRecorder @@ -79,9 +79,9 @@ class MediaViewerViewTest { rule.setMediaViewerView( aMediaViewerState( downloadedMedia = AsyncData.Success( - LocalMedia(Uri.EMPTY, anImageInfo()) + LocalMedia(Uri.EMPTY, anImageMediaInfo()) ), - mediaInfo = anImageInfo(), + mediaInfo = anImageMediaInfo(), eventSink = eventsRecorder ), ) @@ -97,9 +97,9 @@ class MediaViewerViewTest { rule.setMediaViewerView( aMediaViewerState( downloadedMedia = AsyncData.Success( - LocalMedia(Uri.EMPTY, anImageInfo()) + LocalMedia(Uri.EMPTY, anImageMediaInfo()) ), - mediaInfo = anImageInfo(), + mediaInfo = anImageMediaInfo(), eventSink = eventsRecorder ), ) @@ -122,9 +122,9 @@ class MediaViewerViewTest { rule.setMediaViewerView( aMediaViewerState( downloadedMedia = AsyncData.Success( - LocalMedia(Uri.EMPTY, anImageInfo()) + LocalMedia(Uri.EMPTY, anImageMediaInfo()) ), - mediaInfo = anImageInfo(), + mediaInfo = anImageMediaInfo(), eventSink = eventsRecorder ), onBackPressed = callback, @@ -141,7 +141,7 @@ class MediaViewerViewTest { rule.setMediaViewerView( aMediaViewerState( downloadedMedia = AsyncData.Failure(IllegalStateException("error")), - mediaInfo = anImageInfo(), + mediaInfo = anImageMediaInfo(), eventSink = eventsRecorder ), ) @@ -155,7 +155,7 @@ class MediaViewerViewTest { rule.setMediaViewerView( aMediaViewerState( downloadedMedia = AsyncData.Failure(IllegalStateException("error")), - mediaInfo = anImageInfo(), + mediaInfo = anImageMediaInfo(), eventSink = eventsRecorder ), ) diff --git a/libraries/mediaviewer/impl/src/test/kotlin/io/element/android/libraries/mediaviewer/impl/local/AndroidLocalMediaFactoryTest.kt b/libraries/mediaviewer/impl/src/test/kotlin/io/element/android/libraries/mediaviewer/impl/local/AndroidLocalMediaFactoryTest.kt index 2563511ee2..d8f09c618f 100644 --- a/libraries/mediaviewer/impl/src/test/kotlin/io/element/android/libraries/mediaviewer/impl/local/AndroidLocalMediaFactoryTest.kt +++ b/libraries/mediaviewer/impl/src/test/kotlin/io/element/android/libraries/mediaviewer/impl/local/AndroidLocalMediaFactoryTest.kt @@ -22,7 +22,7 @@ import io.element.android.libraries.core.mimetype.MimeTypes import io.element.android.libraries.matrix.api.media.MediaFile import io.element.android.libraries.matrix.test.media.FakeMediaFile import io.element.android.libraries.mediaviewer.api.local.MediaInfo -import io.element.android.libraries.mediaviewer.api.local.anImageInfo +import io.element.android.libraries.mediaviewer.api.local.anImageMediaInfo import io.element.android.libraries.mediaviewer.api.util.FileExtensionExtractorWithoutValidation import org.junit.Test import org.junit.runner.RunWith @@ -34,7 +34,7 @@ class AndroidLocalMediaFactoryTest { @Test fun `test AndroidLocalMediaFactory`() { val sut = createAndroidLocalMediaFactory() - val result = sut.createFromMediaFile(aMediaFile(), anImageInfo()) + val result = sut.createFromMediaFile(aMediaFile(), anImageMediaInfo()) assertThat(result.uri.toString()).endsWith("aPath") assertThat(result.info).isEqualTo( MediaInfo( diff --git a/libraries/mediaviewer/test/src/main/kotlin/io/element/android/libraries/mediaviewer/test/viewer/LocalMedia.kt b/libraries/mediaviewer/test/src/main/kotlin/io/element/android/libraries/mediaviewer/test/viewer/LocalMedia.kt index 876e82000d..f9102c0ee2 100644 --- a/libraries/mediaviewer/test/src/main/kotlin/io/element/android/libraries/mediaviewer/test/viewer/LocalMedia.kt +++ b/libraries/mediaviewer/test/src/main/kotlin/io/element/android/libraries/mediaviewer/test/viewer/LocalMedia.kt @@ -19,11 +19,11 @@ package io.element.android.libraries.mediaviewer.test.viewer import android.net.Uri import io.element.android.libraries.mediaviewer.api.local.LocalMedia import io.element.android.libraries.mediaviewer.api.local.MediaInfo -import io.element.android.libraries.mediaviewer.api.local.anImageInfo +import io.element.android.libraries.mediaviewer.api.local.anImageMediaInfo fun aLocalMedia( uri: Uri, - mediaInfo: MediaInfo = anImageInfo(), + mediaInfo: MediaInfo = anImageMediaInfo(), ) = LocalMedia( uri = uri, info = mediaInfo