Bump detekt from 1.23.6 to 1.23.7 (#696)

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Joaquim Stähli <[email protected]>
Co-authored-by: Gaëtan Muller <[email protected]>

gradle/libs.versions.toml

@@ -18,7 +18,7 @@ androidx-tv-material = "1.0.0"
 coil = "2.7.0"
 comscore = "6.11.1"
 dependency-analysis-gradle-plugin = "2.0.1"
-detekt = "1.23.6"
+detekt = "1.23.7"
 dokka = "1.9.20"
 guava = "33.0.0-android"
 json = "20240303"

pillarbox-analytics/src/main/java/ch/srgssr/pillarbox/analytics/AnalyticsConfig.kt

@@ -29,10 +29,17 @@ data class AnalyticsConfig(
     /**
      * Vendor
      */
+    @Suppress("UndocumentedPublicProperty")
     enum class Vendor {
-        SRG, SWI, RTS, RSI, SRF, RTR
+        SRG,
+        SWI,
+        RTS,
+        RSI,
+        SRF,
+        RTR
     }
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         /**
          * SRG Production CommandersAct source key

pillarbox-analytics/src/main/java/ch/srgssr/pillarbox/analytics/commandersact/CommandersActLabels.kt

@@ -9,6 +9,7 @@ package ch.srgssr.pillarbox.analytics.commandersact
  *
  * @property label the key property
  */
+@Suppress("UndocumentedPublicProperty")
 enum class CommandersActLabels(val label: String) {
     // Event keys
     EVENT_VALUE("event_value"),

pillarbox-analytics/src/main/java/ch/srgssr/pillarbox/analytics/commandersact/MediaEventType.kt

@@ -7,6 +7,7 @@ package ch.srgssr.pillarbox.analytics.commandersact
 /**
  * CommandersAct [TCMediaEvent] Media event type
  */
+@Suppress("UndocumentedPublicProperty")
 enum class MediaEventType {
     Play,
     Pause,

pillarbox-analytics/src/main/java/ch/srgssr/pillarbox/analytics/commandersact/TCMediaEvent.kt

@@ -90,7 +90,7 @@ class TCMediaEvent(
         put(key, value)
     }
 
-    companion object {
+    private companion object {
         private const val PLAYER_DISPLAY_NAME = "Pillarbox"
         private const val MEDIA_PLAYER_VERSION = "media_player_version"
         private const val MEDIA_VOLUME = "media_volume"

pillarbox-core-business/src/main/java/ch/srgssr/pillarbox/core/business/SRGMediaItemBuilder.kt

@@ -110,7 +110,7 @@ class SRGMediaItemBuilder(mediaItem: MediaItem) {
         return mediaItemBuilder.build()
     }
 
-    companion object {
+    private companion object {
         private const val PATH = "integrationlayer/2.1/mediaComposition/byUrn/"
         private const val PARAM_ONLY_CHAPTERS = "onlyChapters"
         private const val PARAM_VECTOR = "vector"

pillarbox-core-business/src/main/java/ch/srgssr/pillarbox/core/business/akamai/AkamaiTokenDataSource.kt

@@ -52,6 +52,7 @@ class AkamaiTokenDataSource private constructor(
         }
     }
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         /**
          * Token Query Param to add to trigger token request

pillarbox-core-business/src/main/java/ch/srgssr/pillarbox/core/business/akamai/AkamaiTokenProvider.kt

@@ -72,7 +72,7 @@ class AkamaiTokenProvider(private val httpClient: HttpClient = DefaultHttpClient
     @Serializable
     internal data class TokenResponse(val token: Token)
 
-    companion object {
+    internal companion object {
         private const val TOKEN_SERVICE_URL = "https://tp.srgssr.ch/"
 
         internal fun getAcl(uri: Uri): String? {

pillarbox-core-business/src/main/java/ch/srgssr/pillarbox/core/business/exception/BlockReasonException.kt

@@ -21,7 +21,7 @@ class BlockReasonException(val blockReason: BlockReason) : IOException(blockReas
      */
     internal constructor(message: String) : this(parseMessage(message))
 
-    companion object {
+    private companion object {
         @Suppress("SwallowedException")
         private fun parseMessage(message: String): BlockReason {
             return try {

pillarbox-core-business/src/main/java/ch/srgssr/pillarbox/core/business/integrationlayer/data/BlockReason.kt

@@ -7,6 +7,7 @@ package ch.srgssr.pillarbox.core.business.integrationlayer.data
 /**
  * Block reason
  */
+@Suppress("UndocumentedPublicProperty")
 enum class BlockReason {
     GEOBLOCK,
     LEGAL,

pillarbox-core-business/src/main/java/ch/srgssr/pillarbox/core/business/integrationlayer/data/Drm.kt

@@ -20,6 +20,7 @@ data class Drm(val type: Type, val licenseUrl: String, val certificateUrl: Strin
     /**
      * Drm Type, on Android [FAIRPLAY] is not playable!
      */
+    @Suppress("UndocumentedPublicProperty")
     enum class Type {
         FAIRPLAY, WIDEVINE, PLAYREADY
     }

pillarbox-core-business/src/main/java/ch/srgssr/pillarbox/core/business/integrationlayer/data/MediaType.kt

@@ -7,6 +7,7 @@ package ch.srgssr.pillarbox.core.business.integrationlayer.data
 /**
  * The media type
  */
+@Suppress("UndocumentedPublicProperty")
 enum class MediaType {
     AUDIO, VIDEO
 }

pillarbox-core-business/src/main/java/ch/srgssr/pillarbox/core/business/integrationlayer/data/Resource.kt

@@ -32,12 +32,14 @@ data class Resource(
     /**
      * Type of the Resource
      */
+    @Suppress("UndocumentedPublicProperty")
     enum class Type {
         PROGRESSIVE, M3UPLAYLIST, HLS, HDS, RTMP, DASH, UNKNOWN
     }
 
     /**
      * Token type
      */
+    @Suppress("UndocumentedPublicProperty")
     enum class TokenType { AKAMAI, NONE }
 }

pillarbox-core-business/src/main/java/ch/srgssr/pillarbox/core/business/integrationlayer/data/TimeIntervalType.kt

@@ -7,6 +7,7 @@ package ch.srgssr.pillarbox.core.business.integrationlayer.data
 /**
  * Time interval type
  */
+@Suppress("UndocumentedPublicProperty")
 enum class TimeIntervalType {
     CLOSING_CREDITS,
     OPENING_CREDITS,

pillarbox-core-business/src/main/java/ch/srgssr/pillarbox/core/business/tracker/SRGEventLoggerTracker.kt

@@ -36,7 +36,7 @@ class SRGEventLoggerTracker : MediaItemTracker {
         }
     }
 
-    companion object {
+    private companion object {
         private const val TAG = "SRGLogger"
     }
 }

pillarbox-core-business/src/main/java/ch/srgssr/pillarbox/core/business/tracker/comscore/ComScoreTracker.kt

@@ -229,7 +229,7 @@ class ComScoreTracker internal constructor(
         }
     }
 
-    companion object {
+    private companion object {
         private const val MEDIA_PLAYER_NAME = "Pillarbox"
         private const val TAG = "ComScoreTracker"
         private const val LIVE_ONLY_WINDOW_OFFSET = 0L

pillarbox-demo-shared/src/main/java/ch/srgssr/pillarbox/demo/shared/data/DemoBrowser.kt

@@ -94,7 +94,7 @@ class DemoBrowser {
      */
     fun getMediaItemFromId(mediaId: String) = mapMediaIdMediaItem[mediaId]
 
-    companion object {
+    private companion object {
         private const val DEMO_BROWSABLE_ROOT = "DEMO_BROWSABLE_ROOT"
     }
 }

pillarbox-demo-shared/src/main/java/ch/srgssr/pillarbox/demo/shared/data/DemoItem.kt

@@ -72,6 +72,7 @@ data class DemoItem(
         }
     }
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         private const val serialVersionUID: Long = 1
 

pillarbox-demo-shared/src/main/java/ch/srgssr/pillarbox/demo/shared/data/Playlist.kt

@@ -39,6 +39,7 @@ data class Playlist(val title: String, val items: List<DemoItem>, val descriptio
             .build()
     }
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         private const val serialVersionUID: Long = 1
 

pillarbox-demo-shared/src/main/java/ch/srgssr/pillarbox/demo/shared/source/BlockedTimeRangeAssetLoader.kt

@@ -78,6 +78,7 @@ class BlockedTimeRangeAssetLoader(context: Context) : AssetLoader(DefaultMediaSo
         }
     }
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         private val URL = DemoItem.AppleBasic_16_9_TS_HLS.uri
         private val videoDuration = 1800.05.seconds

pillarbox-demo-shared/src/main/java/ch/srgssr/pillarbox/demo/shared/ui/integrationLayer/data/ILRepository.kt

@@ -215,7 +215,7 @@ class ILRepository(
         ).flow
     }
 
-    companion object {
+    private companion object {
         private const val PAGE_SIZE = 20
     }
 }

pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/player/PlayerActivity.kt

@@ -70,6 +70,7 @@ class PlayerActivity : ComponentActivity() {
         player.release()
     }
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         private const val ARG_ITEM = "demo_item"
 

pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/service/DemoMediaLibraryService.kt

@@ -108,7 +108,7 @@ class DemoMediaLibraryService : PillarboxMediaLibraryService() {
         }
     }
 
-    companion object {
+    private companion object {
         private const val TAG = "MediaLibraryService"
         private const val MEDIA_SEARCH_SUPPORTED = "android.media.browse.SEARCH_SUPPORTED"
         private const val CONTENT_STYLE_BROWSABLE_HINT = "android.media.browse.CONTENT_STYLE_BROWSABLE_HINT"

pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/service/DemoMediaSessionService.kt

@@ -54,7 +54,7 @@ class DemoMediaSessionService : PillarboxMediaSessionService() {
         super.onDestroy()
     }
 
-    companion object {
+    private companion object {
         private const val TAG = "BackgroundService"
     }
 }

pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/player/SimplePlayerActivity.kt

@@ -203,6 +203,7 @@ class SimplePlayerActivity : ComponentActivity(), ServiceConnection {
         bindService(intent, this, BIND_AUTO_CREATE)
     }
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         private const val ARG_PLAYLIST = "ARG_PLAYLIST"
         private const val ARG_LAYOUT = "ARG_LAYOUT"

pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/player/SimplePlayerViewModel.kt

@@ -158,7 +158,7 @@ class SimplePlayerViewModel(
         Log.i(TAG, "onCreditChanged $credit")
     }
 
-    companion object {
+    private companion object {
         private const val TAG = "PillarboxDemo"
     }
 

pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/showcases/misc/UpdatableMediaItemViewModel.kt

@@ -98,7 +98,7 @@ class UpdatableMediaItemViewModel(application: Application) : AndroidViewModel(a
         player.release()
     }
 
-    companion object {
+    private companion object {
         private const val CHANNEL_ID = "DemoChannel"
         private const val NOTIFICATION_ID = 456
         private const val EVENT_COUNT = 5

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/PillarboxExoPlayer.kt

@@ -413,6 +413,7 @@ class PillarboxExoPlayer internal constructor(
         }
     }
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         /**
          * A default maximum position for which a seek to previous will seek to the previous window.

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/PillarboxPlayer.kt

@@ -78,6 +78,7 @@ interface PillarboxPlayer : Player {
      */
     var trackingEnabled: Boolean
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
 
         /**

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/SeekIncrement.kt

@@ -24,7 +24,7 @@ data class SeekIncrement(
         require(forward > Duration.ZERO) { "Seek forward increment have to be greater than zero" }
     }
 
-    companion object {
+    private companion object {
         private val DefaultSeekBackIncrement = C.DEFAULT_SEEK_BACK_INCREMENT_MS.milliseconds
         private val DefaultSeekForwardIncrement = C.DEFAULT_SEEK_FORWARD_INCREMENT_MS.milliseconds
     }

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/analytics/PillarboxAnalyticsListener.kt

@@ -63,6 +63,7 @@ interface PillarboxAnalyticsListener : AnalyticsListener {
      */
     fun onCreditChanged(eventTime: EventTime, credit: Credit?) {}
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         /**
          * @see [PillarboxPlayer.EVENT_BLOCKED_TIME_RANGE_REACHED]

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/asset/PillarboxData.kt

@@ -17,6 +17,7 @@ data class PillarboxData(
     val trackersData: MediaItemTrackerData = MediaItemTrackerData.EMPTY,
     val blockedTimeRanges: List<BlockedTimeRange> = emptyList()
 ) {
+    @Suppress("UndocumentedPublicClass")
     companion object {
         /**
          * Empty [PillarboxData].

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/asset/UrlAssetLoader.kt

@@ -53,7 +53,7 @@ class UrlAssetLoader(
         )
     }
 
-    companion object {
+    private companion object {
         private val DEFAULT_TRACKER_DATA_LOADER = TrackerDataProvider { _, _ -> }
     }
 }

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/service/PlaybackService.kt

@@ -145,7 +145,7 @@ abstract class PlaybackService : Service() {
         }
     }
 
-    companion object {
+    private companion object {
         private const val DEFAULT_NOTIFICATION_ID = 2023
         private const val DEFAULT_CHANNEL_ID = "Pillarbox now playing"
     }

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/session/PillarboxMediaController.kt

@@ -906,7 +906,7 @@ open class PillarboxMediaController internal constructor() : PillarboxPlayer {
         mediaController.setAudioAttributes(audioAttributes, handleAudioFocus)
     }
 
-    companion object {
+    private companion object {
         private const val TAG = "PillarboxMediaController"
     }
 }

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/session/PillarboxMediaSession.kt

@@ -310,7 +310,7 @@ open class PillarboxMediaSession internal constructor() {
         }
     }
 
-    companion object {
-        internal const val TAG = "PillarboxMediaSession"
+    private companion object {
+        private const val TAG = "PillarboxMediaSession"
     }
 }

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/source/PillarboxMediaSource.kt

@@ -147,7 +147,7 @@ class PillarboxMediaSource internal constructor(
         }
     }
 
-    companion object {
+    private companion object {
         private const val TAG = "PillarboxMediaSource"
     }
 }

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/source/PillarboxMediaSourceFactory.kt

@@ -78,7 +78,7 @@ class PillarboxMediaSourceFactory(context: Context) : MediaSource.Factory {
         return PillarboxMediaSource(mediaItem = mediaItem, assetLoader = assetLoader, minLiveDvrDurationMs = minLiveDvrDurationMs)
     }
 
-    companion object {
+    private companion object {
         private const val LIVE_DVR_MIN_DURATION_MS = 60_000L
     }
 }

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/tracker/MediaItemTracker.kt

@@ -15,7 +15,16 @@ interface MediaItemTracker {
      * Stop reason
      */
     enum class StopReason {
-        Stop, EoF
+
+        /**
+         * When the player has been stopped, released or its current media item changes.
+         */
+        Stop,
+
+        /**
+         * When the player reaches the end of the media.
+         */
+        EoF
     }
 
     /**

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/tracker/MediaItemTrackerData.kt

@@ -73,6 +73,7 @@ class MediaItemTrackerData private constructor(private val map: Map<Class<*>, An
         return "MediaItemTrackerData(map=$map)"
     }
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         /**
          * Empty [MediaItemTrackerData].

pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/tracks/Track.kt

@@ -40,6 +40,7 @@ sealed class Track(
     val isSupported: Boolean
         get() = group.isTrackSupported(trackIndexInGroup)
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         /**
          * Converts the track at index [trackIndexInGroup] from the provided [group] into a [Track].

pillarbox-ui/src/main/java/ch/srgssr/pillarbox/ui/widget/DelayedVisibilityState.kt

@@ -105,6 +105,7 @@ class DelayedVisibilityState internal constructor(
         return duration < INFINITE && duration > ZERO
     }
 
+    @Suppress("UndocumentedPublicClass")
     companion object {
         /**
          * Default duration