erik/readingtime
erik/readingtime
1
1
Fork 0
Code Issues Pull requests Releases Activity

Renamed round parameter to roundingMode.

Browse source
This commit is contained in:
Erik C. Thauvin 2021-05-30 20:48:21 -07:00
parent 6cabd2e723
commit 644429b1ad
4 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -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

2
config/detekt/baseline.xml
View file

@ -2,7 +2,7 @@
<SmellBaseline>
<ManuallySuppressedIssues/>
<CurrentIssues>
<ID>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 )</ID>
<ID>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 )</ID>
<ID>MagicNumber:ReadingTime.kt$ReadingTime$10</ID>
<ID>MagicNumber:ReadingTime.kt$ReadingTime$12</ID>
<ID>MagicNumber:ReadingTime.kt$ReadingTime$3</ID>

4
src/main/kotlin/net/thauvin/erik/readingtime/ReadingTime.kt
View file

@ -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 {

4
src/test/kotlin/net/thauvin/erik/readingtime/ReadingTimeTest.kt
View file

@ -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")
}
}