Public parameters of UtcOffset type: rename to just 'offset'

ilya-g · ilya-g · commit 90c086474472 · 2021-07-02T18:06:38.000+03:00
diff --git a/core/common/src/TimeZone.kt b/core/common/src/TimeZone.kt
@@ -86,10 +86,10 @@ public expect open class TimeZone {
 
 @Serializable(with = FixedOffsetTimeZoneSerializer::class)
 public expect class FixedOffsetTimeZone : TimeZone {
-    public constructor(utcOffset: UtcOffset)
-    public val utcOffset: UtcOffset
+    public constructor(offset: UtcOffset)
+    public val offset: UtcOffset
 
-    @Deprecated("Use utcOffset.totalSeconds", ReplaceWith("utcOffset.totalSeconds"))
+    @Deprecated("Use offset.totalSeconds", ReplaceWith("offset.totalSeconds"))
     public val totalSeconds: Int
 }
 
@@ -116,7 +116,7 @@ public expect fun TimeZone.offsetAt(instant: Instant): UtcOffset
  */
 public expect fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime
 
-internal expect fun Instant.toLocalDateTime(utcOffset: UtcOffset): LocalDateTime
+internal expect fun Instant.toLocalDateTime(offset: UtcOffset): LocalDateTime
 
 
 /**
@@ -144,7 +144,7 @@ public fun Instant.offsetIn(timeZone: TimeZone): UtcOffset =
  */
 public expect fun LocalDateTime.toInstant(timeZone: TimeZone): Instant
 
-public expect fun LocalDateTime.toInstant(utcOffset: UtcOffset): Instant
+public expect fun LocalDateTime.toInstant(offset: UtcOffset): Instant
 
 /**
  * Returns an instant that corresponds to the start of this date in the specified [timeZone].
diff --git a/core/common/test/TimeZoneTest.kt b/core/common/test/TimeZoneTest.kt
@@ -17,7 +17,8 @@ class TimeZoneTest {
         val utc: FixedOffsetTimeZone = TimeZone.UTC
         println(utc)
         assertEquals("Z", utc.id)
-        assertEquals(0, utc.utcOffset.totalSeconds)
+        assertEquals(0, utc.offset.totalSeconds)
+        assertEquals(utc.offset, utc.offsetAt(Clock.System.now()))
     }
 
     @Test
diff --git a/core/common/test/UtcOffsetTest.kt b/core/common/test/UtcOffsetTest.kt
@@ -115,6 +115,6 @@ class UtcOffsetTest {
         val offset = UtcOffset.parse("+01:20:30")
         val timeZone = offset.asTimeZone()
         assertIs<FixedOffsetTimeZone>(timeZone)
-        assertEquals(offset, timeZone.utcOffset)
+        assertEquals(offset, timeZone.offset)
     }
 }
diff --git a/core/darwin/src/Converters.kt b/core/darwin/src/Converters.kt
@@ -43,10 +43,10 @@ public fun NSDate.toKotlinInstant(): Instant {
  * nearest minute.
  */
 public fun TimeZone.toNSTimeZone(): NSTimeZone = if (this is FixedOffsetTimeZone) {
-    require (utcOffset.totalSeconds % 60 == 0) {
+    require (offset.totalSeconds % 60 == 0) {
         "NSTimeZone cannot represent fixed-offset time zones with offsets not expressed in whole minutes: $this"
     }
-    NSTimeZone.timeZoneForSecondsFromGMT(utcOffset.totalSeconds.convert())
+    NSTimeZone.timeZoneForSecondsFromGMT(offset.totalSeconds.convert())
 } else {
     NSTimeZone.timeZoneWithName(id) ?: NSTimeZone.timeZoneWithAbbreviation(id)!!
 }
diff --git a/core/darwin/test/ConvertersTest.kt b/core/darwin/test/ConvertersTest.kt
@@ -98,6 +98,6 @@ class ConvertersTest {
         val kotlinTimeZone = nsTimeZone.toKotlinTimeZone()
         assertEquals(hours * 3600 + minutes * 60, nsTimeZone.secondsFromGMT.convert())
         assertIs<FixedOffsetTimeZone>(kotlinTimeZone)
-        assertEquals(timeZone.utcOffset, kotlinTimeZone.utcOffset)
+        assertEquals(timeZone.offset, kotlinTimeZone.offset)
     }
 }
diff --git a/core/js/src/TimeZone.kt b/core/js/src/TimeZone.kt
@@ -46,10 +46,10 @@ public actual open class TimeZone internal constructor(internal val zoneId: Zone
 }
 
 @Serializable(with = FixedOffsetTimeZoneSerializer::class)
-public actual class FixedOffsetTimeZone actual constructor(public actual val utcOffset: UtcOffset): TimeZone(utcOffset.zoneOffset) {
+public actual class FixedOffsetTimeZone actual constructor(public actual val offset: UtcOffset): TimeZone(offset.zoneOffset) {
     private val zoneOffset get() = zoneId as jtZoneOffset
 
-    @Deprecated("Use utcOffset.totalSeconds", ReplaceWith("utcOffset.totalSeconds"))
+    @Deprecated("Use offset.totalSeconds", ReplaceWith("offset.totalSeconds"))
     public actual val totalSeconds: Int get() = zoneOffset.totalSeconds().toInt()
 }
 
@@ -61,8 +61,8 @@ public actual fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime = t
     throw e
 }
 
-internal actual fun Instant.toLocalDateTime(utcOffset: UtcOffset): LocalDateTime = try {
-    kotlinx.datetime.internal.JSJoda.LocalDateTime.ofInstant(this.value, utcOffset.zoneOffset).let(::LocalDateTime)
+internal actual fun Instant.toLocalDateTime(offset: UtcOffset): LocalDateTime = try {
+    kotlinx.datetime.internal.JSJoda.LocalDateTime.ofInstant(this.value, offset.zoneOffset).let(::LocalDateTime)
 } catch (e: Throwable) {
     if (e.isJodaDateTimeException()) throw DateTimeArithmeticException(e)
     throw e
@@ -75,8 +75,8 @@ public actual fun TimeZone.offsetAt(instant: Instant): UtcOffset =
 public actual fun LocalDateTime.toInstant(timeZone: TimeZone): Instant =
         this.value.atZone(timeZone.zoneId).toInstant().let(::Instant)
 
-public actual fun LocalDateTime.toInstant(utcOffset: UtcOffset): Instant =
-    this.value.toInstant(utcOffset.zoneOffset).let(::Instant)
+public actual fun LocalDateTime.toInstant(offset: UtcOffset): Instant =
+    this.value.toInstant(offset.zoneOffset).let(::Instant)
 
 public actual fun LocalDate.atStartOfDayIn(timeZone: TimeZone): Instant =
         this.value.atStartOfDay(timeZone.zoneId).toInstant().let(::Instant)
diff --git a/core/jvm/src/Converters.kt b/core/jvm/src/Converters.kt
@@ -63,7 +63,7 @@ public fun java.time.ZoneId.toKotlinTimeZone(): TimeZone = TimeZone(this)
 /**
  * Converts this [kotlinx.datetime.FixedOffsetTimeZone][FixedOffsetTimeZone] value to a [java.time.ZoneOffset][java.time.ZoneOffset] value.
  */
-public fun FixedOffsetTimeZone.toJavaZoneOffset(): java.time.ZoneOffset = this.utcOffset.zoneOffset
+public fun FixedOffsetTimeZone.toJavaZoneOffset(): java.time.ZoneOffset = this.offset.zoneOffset
 
 /**
  * Converts this [java.time.ZoneOffset][java.time.ZoneOffset] value to a [kotlinx.datetime.FixedOffsetTimeZone][FixedOffsetTimeZone] value.
diff --git a/core/jvm/src/TimeZoneJvm.kt b/core/jvm/src/TimeZoneJvm.kt
@@ -52,9 +52,9 @@ public actual open class TimeZone internal constructor(internal val zoneId: Zone
 
 @Serializable(with = FixedOffsetTimeZoneSerializer::class)
 public actual class FixedOffsetTimeZone
-public actual constructor(public actual val utcOffset: UtcOffset): TimeZone(utcOffset.zoneOffset) {
-    @Deprecated("Use utcOffset.totalSeconds", ReplaceWith("utcOffset.totalSeconds"))
-    public actual val totalSeconds: Int get() = utcOffset.totalSeconds
+public actual constructor(public actual val offset: UtcOffset): TimeZone(offset.zoneOffset) {
+    @Deprecated("Use offset.totalSeconds", ReplaceWith("offset.totalSeconds"))
+    public actual val totalSeconds: Int get() = offset.totalSeconds
 }
 
 public actual fun TimeZone.offsetAt(instant: Instant): UtcOffset =
@@ -66,8 +66,8 @@ public actual fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime = t
     throw DateTimeArithmeticException(e)
 }
 
-internal actual fun Instant.toLocalDateTime(utcOffset: UtcOffset): LocalDateTime = try {
-    java.time.LocalDateTime.ofInstant(this.value, utcOffset.zoneOffset).let(::LocalDateTime)
+internal actual fun Instant.toLocalDateTime(offset: UtcOffset): LocalDateTime = try {
+    java.time.LocalDateTime.ofInstant(this.value, offset.zoneOffset).let(::LocalDateTime)
 } catch (e: DateTimeException) {
     throw DateTimeArithmeticException(e)
 }
@@ -76,8 +76,8 @@ internal actual fun Instant.toLocalDateTime(utcOffset: UtcOffset): LocalDateTime
 public actual fun LocalDateTime.toInstant(timeZone: TimeZone): Instant =
         this.value.atZone(timeZone.zoneId).toInstant().let(::Instant)
 
-public actual fun LocalDateTime.toInstant(utcOffset: UtcOffset): Instant =
-        this.value.toInstant(utcOffset.zoneOffset).let(::Instant)
+public actual fun LocalDateTime.toInstant(offset: UtcOffset): Instant =
+        this.value.toInstant(offset.zoneOffset).let(::Instant)
 
 public actual fun LocalDate.atStartOfDayIn(timeZone: TimeZone): Instant =
         this.value.atStartOfDay(timeZone.zoneId).toInstant().let(::Instant)
diff --git a/core/native/src/TimeZone.kt b/core/native/src/TimeZone.kt
@@ -93,15 +93,15 @@ public actual open class TimeZone internal constructor(internal val value: TimeZ
 
 
 @Serializable(with = FixedOffsetTimeZoneSerializer::class)
-public actual class FixedOffsetTimeZone internal constructor(public actual val utcOffset: UtcOffset, id: String) : TimeZone(ZoneOffsetImpl(utcOffset, id)) {
+public actual class FixedOffsetTimeZone internal constructor(public actual val offset: UtcOffset, id: String) : TimeZone(ZoneOffsetImpl(offset, id)) {
 
-    public actual constructor(utcOffset: UtcOffset) : this(utcOffset, utcOffset.toString())
+    public actual constructor(offset: UtcOffset) : this(offset, offset.toString())
 
-    @Deprecated("Use utcOffset.totalSeconds", ReplaceWith("utcOffset.totalSeconds"))
-    public actual val totalSeconds: Int get() = utcOffset.totalSeconds
+    @Deprecated("Use offset.totalSeconds", ReplaceWith("offset.totalSeconds"))
+    public actual val totalSeconds: Int get() = offset.totalSeconds
 
-    override fun instantToLocalDateTime(instant: Instant): LocalDateTime = instant.toLocalDateTime(utcOffset)
-    override fun localDateTimeToInstant(dateTime: LocalDateTime): Instant = dateTime.toInstant(utcOffset)
+    override fun instantToLocalDateTime(instant: Instant): LocalDateTime = instant.toLocalDateTime(offset)
+    override fun localDateTimeToInstant(dateTime: LocalDateTime): Instant = dateTime.toInstant(offset)
 }
 
 
@@ -111,8 +111,8 @@ public actual fun TimeZone.offsetAt(instant: Instant): UtcOffset =
 public actual fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime =
     timeZone.instantToLocalDateTime(this)
 
-internal actual fun Instant.toLocalDateTime(utcOffset: UtcOffset): LocalDateTime = try {
-    toLocalDateTimeImpl(utcOffset)
+internal actual fun Instant.toLocalDateTime(offset: UtcOffset): LocalDateTime = try {
+    toLocalDateTimeImpl(offset)
 } catch (e: IllegalArgumentException) {
     throw DateTimeArithmeticException("Instant ${this@toLocalDateTime} is not representable as LocalDateTime", e)
 }
@@ -129,8 +129,8 @@ internal fun Instant.toLocalDateTimeImpl(offset: UtcOffset): LocalDateTime {
 public actual fun LocalDateTime.toInstant(timeZone: TimeZone): Instant =
     timeZone.localDateTimeToInstant(this)
 
-public actual fun LocalDateTime.toInstant(utcOffset: UtcOffset): Instant =
-    Instant(this.toEpochSecond(utcOffset), this.nanosecond)
+public actual fun LocalDateTime.toInstant(offset: UtcOffset): Instant =
+    Instant(this.toEpochSecond(offset), this.nanosecond)
 
 public actual fun LocalDate.atStartOfDayIn(timeZone: TimeZone): Instant =
     timeZone.atStartOfDay(this)
diff --git a/core/native/src/ZonedDateTime.kt b/core/native/src/ZonedDateTime.kt
@@ -38,7 +38,7 @@ internal class ZonedDateTime(val dateTime: LocalDateTime, private val zone: Time
 
     override fun toString(): String {
         var str = dateTime.toString() + offset.toString()
-        if (zone !is FixedOffsetTimeZone || offset !== zone.utcOffset) {
+        if (zone !is FixedOffsetTimeZone || offset !== zone.offset) {
             str += "[$zone]"
         }
         return str

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,8 @@ class TimeZoneTest {`
`17`	`17`	`val utc: FixedOffsetTimeZone = TimeZone.UTC`
`18`	`18`	`println(utc)`
`19`	`19`	`assertEquals("Z", utc.id)`
`20`		`- assertEquals(0, utc.utcOffset.totalSeconds)`
	`20`	`+ assertEquals(0, utc.offset.totalSeconds)`
	`21`	`+ assertEquals(utc.offset, utc.offsetAt(Clock.System.now()))`
`21`	`22`	`}`
`22`	`23`
`23`	`24`	`@Test`
Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,6 @@ class UtcOffsetTest {`
`115`	`115`	`val offset = UtcOffset.parse("+01:20:30")`
`116`	`116`	`val timeZone = offset.asTimeZone()`
`117`	`117`	`assertIs<FixedOffsetTimeZone>(timeZone)`
`118`		`- assertEquals(offset, timeZone.utcOffset)`
	`118`	`+ assertEquals(offset, timeZone.offset)`
`119`	`119`	`}`
`120`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,10 +43,10 @@ public fun NSDate.toKotlinInstant(): Instant {`
`43`	`43`	`* nearest minute.`
`44`	`44`	`*/`
`45`	`45`	`public fun TimeZone.toNSTimeZone(): NSTimeZone = if (this is FixedOffsetTimeZone) {`
`46`		`- require (utcOffset.totalSeconds % 60 == 0) {`
	`46`	`+ require (offset.totalSeconds % 60 == 0) {`
`47`	`47`	`"NSTimeZone cannot represent fixed-offset time zones with offsets not expressed in whole minutes: $this"`
`48`	`48`	`}`
`49`		`- NSTimeZone.timeZoneForSecondsFromGMT(utcOffset.totalSeconds.convert())`
	`49`	`+ NSTimeZone.timeZoneForSecondsFromGMT(offset.totalSeconds.convert())`
`50`	`50`	`} else {`
`51`	`51`	`NSTimeZone.timeZoneWithName(id) ?: NSTimeZone.timeZoneWithAbbreviation(id)!!`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,6 @@ class ConvertersTest {`
`98`	`98`	`val kotlinTimeZone = nsTimeZone.toKotlinTimeZone()`
`99`	`99`	`assertEquals(hours * 3600 + minutes * 60, nsTimeZone.secondsFromGMT.convert())`
`100`	`100`	`assertIs<FixedOffsetTimeZone>(kotlinTimeZone)`
`101`		`- assertEquals(timeZone.utcOffset, kotlinTimeZone.utcOffset)`
	`101`	`+ assertEquals(timeZone.offset, kotlinTimeZone.offset)`
`102`	`102`	`}`
`103`	`103`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ internal class ZonedDateTime(val dateTime: LocalDateTime, private val zone: Time`
`38`	`38`
`39`	`39`	`override fun toString(): String {`
`40`	`40`	`var str = dateTime.toString() + offset.toString()`
`41`		`- if (zone !is FixedOffsetTimeZone \|\| offset !== zone.utcOffset) {`
	`41`	`+ if (zone !is FixedOffsetTimeZone \|\| offset !== zone.offset) {`
`42`	`42`	`str += "[$zone]"`
`43`	`43`	`}`
`44`	`44`	`return str`