Split module dateformatter into api, impl and test.

libraries/dateformatter/impl/src/main/AndroidManifest.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?><!--
+  ~ Copyright (c) 2023 New Vector Ltd
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+<manifest />

libraries/dateformatter/impl/src/main/kotlin/io/element/android/libraries/dateformatter/impl/DateFormatters.kt

@@ -0,0 +1,90 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.dateformatter.impl
+
+import android.text.format.DateFormat
+import android.text.format.DateUtils
+import kotlinx.datetime.Clock
+import kotlinx.datetime.LocalDateTime
+import kotlinx.datetime.TimeZone
+import kotlinx.datetime.toInstant
+import kotlinx.datetime.toJavaLocalDate
+import kotlinx.datetime.toJavaLocalDateTime
+import java.time.Period
+import java.time.format.DateTimeFormatter
+import java.util.Locale
+import javax.inject.Inject
+import kotlin.math.absoluteValue
+
+// TODO rework this date formatting
+class DateFormatters @Inject constructor(
+    private val locale: Locale,
+    private val clock: Clock,
+    private val timeZone: TimeZone,
+) {
+
+    private val onlyTimeFormatter: DateTimeFormatter by lazy {
+        val pattern = DateFormat.getBestDateTimePattern(locale, "HH:mm") ?: "HH:mm"
+        DateTimeFormatter.ofPattern(pattern, locale)
+    }
+
+    private val dateWithMonthFormatter: DateTimeFormatter by lazy {
+        val pattern = DateFormat.getBestDateTimePattern(locale, "d MMM") ?: "d MMM"
+        DateTimeFormatter.ofPattern(pattern, locale)
+    }
+
+    private val dateWithYearFormatter: DateTimeFormatter by lazy {
+        val pattern = DateFormat.getBestDateTimePattern(locale, "dd.MM.yyyy") ?: "dd.MM.yyyy"
+        DateTimeFormatter.ofPattern(pattern, locale)
+    }
+
+    internal fun formatTime(localDateTime: LocalDateTime): String {
+        return onlyTimeFormatter.format(localDateTime.toJavaLocalDateTime())
+    }
+
+    internal fun formatDateWithMonth(localDateTime: LocalDateTime): String {
+        return dateWithMonthFormatter.format(localDateTime.toJavaLocalDateTime())
+    }
+
+    internal fun formatDateWithYear(localDateTime: LocalDateTime): String {
+        return dateWithYearFormatter.format(localDateTime.toJavaLocalDateTime())
+    }
+
+    internal fun formatDate(
+        dateToFormat: LocalDateTime,
+        currentDate: LocalDateTime,
+        useRelative: Boolean
+    ): String {
+        val period = Period.between(dateToFormat.date.toJavaLocalDate(), currentDate.date.toJavaLocalDate())
+        return if (period.years.absoluteValue >= 1) {
+            formatDateWithYear(dateToFormat)
+        } else if (useRelative && period.days.absoluteValue < 2 && period.months.absoluteValue < 1) {
+            getRelativeDay(dateToFormat.toInstant(timeZone).toEpochMilliseconds())
+        } else {
+            formatDateWithMonth(dateToFormat)
+        }
+    }
+
+    private fun getRelativeDay(ts: Long): String {
+        return DateUtils.getRelativeTimeSpanString(
+            ts,
+            clock.now().toEpochMilliseconds(),
+            DateUtils.DAY_IN_MILLIS,
+            DateUtils.FORMAT_SHOW_WEEKDAY
+        )?.toString() ?: ""
+    }
+}

libraries/dateformatter/impl/src/main/kotlin/io/element/android/libraries/dateformatter/impl/DefaultDaySeparatorFormatter.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.dateformatter.impl
+
+import com.squareup.anvil.annotations.ContributesBinding
+import io.element.android.libraries.dateformatter.api.DaySeparatorFormatter
+import io.element.android.libraries.di.AppScope
+import javax.inject.Inject
+
+@ContributesBinding(AppScope::class)
+class DefaultDaySeparatorFormatter @Inject constructor(
+    private val localDateTimeProvider: LocalDateTimeProvider,
+    private val dateFormatters: DateFormatters,
+) : DaySeparatorFormatter {
+
+    override fun format(timestamp: Long): String {
+        val dateToFormat = localDateTimeProvider.providesFromTimestamp(timestamp)
+        return dateFormatters.formatDateWithYear(dateToFormat)
+    }
+}

libraries/dateformatter/impl/src/main/kotlin/io/element/android/libraries/dateformatter/impl/DefaultLastMessageFormatter.kt

@@ -0,0 +1,48 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.dateformatter.impl
+
+import com.squareup.anvil.annotations.ContributesBinding
+import io.element.android.libraries.dateformatter.api.LastMessageFormatter
+import io.element.android.libraries.di.AppScope
+import javax.inject.Inject
+
+@ContributesBinding(AppScope::class)
+class DefaultLastMessageFormatter @Inject constructor(
+    private val localDateTimeProvider: LocalDateTimeProvider,
+    private val dateFormatters: DateFormatters,
+) : LastMessageFormatter {
+
+    override fun format(timestamp: Long?): String {
+        if (timestamp == null) return ""
+        val currentDate = localDateTimeProvider.providesNow()
+        val dateToFormat = localDateTimeProvider.providesFromTimestamp(timestamp)
+        val isSameDay = currentDate.date == dateToFormat.date
+        return when {
+            isSameDay -> {
+                dateFormatters.formatTime(dateToFormat)
+            }
+            else -> {
+                dateFormatters.formatDate(
+                    dateToFormat = dateToFormat,
+                    currentDate = currentDate,
+                    useRelative = true
+                )
+            }
+        }
+    }
+}

libraries/dateformatter/impl/src/main/kotlin/io/element/android/libraries/dateformatter/impl/LocalDateTimeProvider.kt

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.dateformatter.impl
+
+import kotlinx.datetime.Clock
+import kotlinx.datetime.Instant
+import kotlinx.datetime.LocalDateTime
+import kotlinx.datetime.TimeZone
+import kotlinx.datetime.toLocalDateTime
+import javax.inject.Inject
+
+class LocalDateTimeProvider @Inject constructor(
+    private val clock: Clock,
+    private val timezone: TimeZone,
+) {
+
+    fun providesNow(): LocalDateTime {
+        val now: Instant = clock.now()
+        return now.toLocalDateTime(timezone)
+    }
+
+    fun providesFromTimestamp(timestamp: Long): LocalDateTime {
+        val tsInstant = Instant.fromEpochMilliseconds(timestamp)
+        return tsInstant.toLocalDateTime(timezone)
+    }
+}

libraries/dateformatter/impl/src/main/kotlin/io/element/android/libraries/dateformatter/impl/di/DateFormatterModule.kt

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.dateformatter.impl.di
+
+import com.squareup.anvil.annotations.ContributesTo
+import dagger.Module
+import dagger.Provides
+import io.element.android.libraries.di.AppScope
+import kotlinx.datetime.Clock
+import kotlinx.datetime.TimeZone
+import java.util.*
+
+@Module
+@ContributesTo(AppScope::class)
+object DateFormatterModule {
+    @Provides
+    fun providesClock(): Clock = Clock.System
+
+    @Provides
+    fun providesLocale(): Locale = Locale.getDefault()
+
+    @Provides
+    fun providesTimezone(): TimeZone = TimeZone.currentSystemDefault()
+}

libraries/dateformatter/impl/src/test/kotlin/io/element/android/libraries/dateformatter/impl/DefaultLastMessageFormatterTest.kt

@@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.dateformatter.impl
+
+import com.google.common.truth.Truth.assertThat
+import io.element.android.libraries.dateformatter.api.LastMessageFormatter
+import io.element.android.libraries.dateformatter.test.FakeClock
+import kotlinx.datetime.Instant
+import kotlinx.datetime.TimeZone
+import org.junit.Test
+import java.util.Locale
+
+class DefaultLastMessageFormatterTest {
+
+    @Test
+    fun `test null`() {
+        val now = "1980-04-06T18:35:24.00Z"
+        val formatter = createFormatter(now)
+        assertThat(formatter.format(null)).isEmpty()
+    }
+
+    @Test
+    fun `test epoch`() {
+        val now = "1980-04-06T18:35:24.00Z"
+        val formatter = createFormatter(now)
+        assertThat(formatter.format(0)).isEqualTo("01.01.1970")
+    }
+
+    @Test
+    fun `test now`() {
+        val now = "1980-04-06T18:35:24.00Z"
+        val dat = "1980-04-06T18:35:24.00Z"
+        val formatter = createFormatter(now)
+        assertThat(formatter.format(Instant.parse(dat).toEpochMilliseconds())).isEqualTo("18:35")
+    }
+
+    @Test
+    fun `test one second before`() {
+        val now = "1980-04-06T18:35:24.00Z"
+        val dat = "1980-04-06T18:35:23.00Z"
+        val formatter = createFormatter(now)
+        assertThat(formatter.format(Instant.parse(dat).toEpochMilliseconds())).isEqualTo("18:35")
+    }
+
+    @Test
+    fun `test one minute before`() {
+        val now = "1980-04-06T18:35:24.00Z"
+        val dat = "1980-04-06T18:34:24.00Z"
+        val formatter = createFormatter(now)
+        assertThat(formatter.format(Instant.parse(dat).toEpochMilliseconds())).isEqualTo("18:34")
+    }
+
+    @Test
+    fun `test one hour before`() {
+        val now = "1980-04-06T18:35:24.00Z"
+        val dat = "1980-04-06T17:35:24.00Z"
+        val formatter = createFormatter(now)
+        assertThat(formatter.format(Instant.parse(dat).toEpochMilliseconds())).isEqualTo("17:35")
+    }
+
+    @Test
+    fun `test one day before same time`() {
+        val now = "1980-04-06T18:35:24.00Z"
+        val dat = "1980-04-05T18:35:24.00Z"
+        val formatter = createFormatter(now)
+        // TODO DateUtils.getRelativeTimeSpanString returns null.
+        assertThat(formatter.format(Instant.parse(dat).toEpochMilliseconds())).isEqualTo("")
+    }
+
+    @Test
+    fun `test one month before same time`() {
+        val now = "1980-04-06T18:35:24.00Z"
+        val dat = "1980-03-06T18:35:24.00Z"
+        val formatter = createFormatter(now)
+        assertThat(formatter.format(Instant.parse(dat).toEpochMilliseconds())).isEqualTo("6 Mar")
+    }
+
+    @Test
+    fun `test one year before same time`() {
+        val now = "1980-04-06T18:35:24.00Z"
+        val dat = "1979-04-06T18:35:24.00Z"
+        val formatter = createFormatter(now)
+        assertThat(formatter.format(Instant.parse(dat).toEpochMilliseconds())).isEqualTo("06.04.1979")
+    }
+
+    /**
+     * Create DefaultLastMessageFormatter and set current time to the provided date.
+     */
+    private fun createFormatter(@Suppress("SameParameterValue") currentDate: String): LastMessageFormatter {
+        val clock = FakeClock().also { it.givenInstant(Instant.parse(currentDate)) }
+        val localDateTimeProvider = LocalDateTimeProvider(clock, TimeZone.UTC)
+        val dateFormatters = DateFormatters(Locale.US, clock, TimeZone.UTC)
+        return DefaultLastMessageFormatter(localDateTimeProvider, dateFormatters)
+    }
+}