diff --git a/README.md b/README.md index 88d690d..0f8f4e1 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ ReadingTime( plural = "min read", excludeImages = false, extra = 0, - round = RoundingMode.HALF_DOWN + roundingMode = RoundingMode.HALF_DOWN ) ``` @@ -59,7 +59,7 @@ Property | Description `plural` | The value to be appended if the reading time is more than 1 minute. `excludeImages` | Images are excluded from the reading time when set. `extra` | Additional seconds to be added to the total reading time. -`round` | The [rounding mode](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/RoundingMode.html) to apply. +`roundingMode` | The [rounding mode](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/RoundingMode.html) to apply. ### Functions diff --git a/config/detekt/baseline.xml b/config/detekt/baseline.xml index 2dd4ebc..7cb45c9 100644 --- a/config/detekt/baseline.xml +++ b/config/detekt/baseline.xml @@ -2,7 +2,7 @@ - LongParameterList:ReadingTime.kt$ReadingTime$( text: String, wpm: Int = 275, var postfix: String = "min read", var plural: String = "min read", excludeImages: Boolean = false, extra: Int = 0, var round: RoundingMode = RoundingMode.HALF_DOWN ) + LongParameterList:ReadingTime.kt$ReadingTime$( text: String, wpm: Int = 275, var postfix: String = "min read", var plural: String = "min read", excludeImages: Boolean = false, extra: Int = 0, var roundingMode: RoundingMode = RoundingMode.HALF_DOWN ) MagicNumber:ReadingTime.kt$ReadingTime$10 MagicNumber:ReadingTime.kt$ReadingTime$12 MagicNumber:ReadingTime.kt$ReadingTime$3 diff --git a/src/main/kotlin/net/thauvin/erik/readingtime/ReadingTime.kt b/src/main/kotlin/net/thauvin/erik/readingtime/ReadingTime.kt index 6934023..229314f 100644 --- a/src/main/kotlin/net/thauvin/erik/readingtime/ReadingTime.kt +++ b/src/main/kotlin/net/thauvin/erik/readingtime/ReadingTime.kt @@ -58,7 +58,7 @@ class ReadingTime @JvmOverloads constructor( var plural: String = "min read", excludeImages: Boolean = false, extra: Int = 0, - var round: RoundingMode = RoundingMode.HALF_DOWN + var roundingMode: RoundingMode = RoundingMode.HALF_DOWN ) { companion object { private const val INVALID: Double = -1.0 @@ -129,7 +129,7 @@ class ReadingTime @JvmOverloads constructor( * `(reading time in sec / 60) + postfix` */ fun calcReadingTime(): String { - val time = BigDecimal((calcReadingTimeInSec() / 60.0)).setScale(0, round) + val time = BigDecimal((calcReadingTimeInSec() / 60.0)).setScale(0, roundingMode) return if (time.compareTo(BigDecimal.ONE) == 1) { "$time $plural".trim() } else { diff --git a/src/test/kotlin/net/thauvin/erik/readingtime/ReadingTimeTest.kt b/src/test/kotlin/net/thauvin/erik/readingtime/ReadingTimeTest.kt index 3a2b334..421a652 100644 --- a/src/test/kotlin/net/thauvin/erik/readingtime/ReadingTimeTest.kt +++ b/src/test/kotlin/net/thauvin/erik/readingtime/ReadingTimeTest.kt @@ -163,11 +163,11 @@ class ReadingTimeTest { @Test fun testRoundingMode() { rt.text = blogPost - rt.round = RoundingMode.UP + rt.roundingMode = RoundingMode.UP assertEquals("3 min read", rt.calcReadingTime(), "UP") rt.text = mediumPost - rt.round = RoundingMode.DOWN + rt.roundingMode = RoundingMode.DOWN assertEquals("1 min read", rt.calcReadingTime(), "DOWN") } }