removed year, fixed date extensions

Author: Jonas Schubert

README.md

@@ -5,44 +5,59 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 <a target="_blank" href="https://www.paypal.me/GuepardoApps" title="Donate using PayPal"><img src="https://img.shields.io/badge/paypal-donate-blue.svg" /></a>
 
-[![Build](https://img.shields.io/badge/build-success-green.svg)](https://github.com/TimeXt/TimeXt-Kotlin/blob/develop/releases/lib-2018-10-20-1.aar)
-[![Version](https://img.shields.io/badge/version-v0.1.0.181020-blue.svg)](https://github.com/TimeXt/TimeXt-Kotlin/tree/develop/releases/)
+[![Build](https://img.shields.io/badge/build-success-green.svg)](https://github.com/TimeXt/TimeXt-Kotlin/blob/develop/releases/lib-2018-10-28-1.aar)
+[![Version](https://img.shields.io/badge/version-v0.2.0.181028-blue.svg)](https://github.com/TimeXt/TimeXt-Kotlin/tree/develop/releases/)
+[![CodeCoverage](https://img.shields.io/badge/codeCoverage-71-orange.svg)](https://github.com/TimeXt/TimeXt-Kotlin/tree/develop/)
 
 First of all many thanks to [Kizitonwose](https://github.com/kizitonwose/Time) for the original idea and already awesome library!
 
-This library shall help to reduce code like
+This library shall help to reduce code like...
 
 ```kotlin
 val dayInMillis = 24 * 60 * 60 * 1000       // Represent a day in milliSeconds
+
+```
+
+... or allow code like
+
+```kotlin
+val date1 = java.sql.Date(1540719288642)
+val date2 = java.sql.Date(1540722888642)
+
+val difference = date2 - date1
+
 ```
 
 ## How to use
 
 ### Basics
 
 ```kotlin
-val oneWeek = 1.weeks                       // Type is Interval<Week>
-val threeDays = 3.days                      // Type is Interval<Day>
-val elevenHours = 11.hours                  // Type is Interval<Hour>
-val sixMinutes = 6.minutes                  // Type is Interval<Minute>
-val fiftySeconds = 50.seconds               // Type is Interval<Second>
-val hundredMilliSeconds = 100.milliSeconds  // Type is Interval<MilliSecond>
-val fiveMicroSeconds = 5.microSeconds       // Type is Interval<MicroSecond>
-val oneNanoSecond = 1.nanoSeconds           // Type is Interval<NanoSecond>
-val onePicoSecond = 1.picoSeconds           // Type is Interval<PicoSecond>
-
-val oneDayInMillis = 1.days.inMilliSeconds  // Converts one day into milliseconds
-val twoWeeksInHours = 2.weeks.inHours       // Converts two weeks into hours
-
-val duration = 1.days + 11.hours + 35.minutes + 15.seconds - 250.milliSeconds
+// Type is TimeXt
+val oneWeek = 1.weeks
+val threeDays = 3.days
+val elevenHours = 11.hours
+val sixMinutes = 6.minutes
+val fiftySeconds = 50.seconds
+val hundredMilliseconds = 100.milliseconds
+
+val oneDayInMillis = 1.days.inMilliSeconds  // Returns one day in milliseconds
+val twoWeeksInHours = 2.weeks.inHours       // Returns two weeks in hours
+
+// Converts the existing 3h-Class into a 180min-Class
+val threeHoursToMinutes = 3.hours.toMinutes() 
+// 3.hours === TimeXt(3, TimeXtUnit.hour)
+// 180.minutes === TimeXt(180, TimeXtUnit.minute)
+
+val duration = 1.days + 11.hours + 35.minutes + 15.seconds - 250.milliseconds
 val multipliedDuration = 1.5 * duration
 val dividedDuration = duration / 2
 
 val isLessTrue = 1.days < 1.weeks           // True
 val isLessFalse = 24.hours < 360.minutes    // False
 
 val isBiggerTrue = 5.minutes > 30.seconds   // True
-val isBiggerFalse = 500.nanoSeconds > 1.minutes // False
+val isBiggerFalse = 500.minutes > 5.weeks   // False
 
 ```
 
@@ -52,16 +67,19 @@ val isBiggerFalse = 500.nanoSeconds > 1.minutes // False
 // Calendar
 val inOneHour = Calendar.getInstance() + 1.hours
 val threeDaysAgo = Calendar.getInstance() - 3.days
+val difference = calendar1 - calendar2      // you can perform minus on calendar and get a TimeXt-object
 
 // Sql Date
-val sqlDate: java.sql.Date = java.sql.Date()
-sqlDate + 5.minutes
-sqlDate - 30.seconds
+var sqlDate: java.sql.Date = java.sql.Date()
+sqlDate = sqlDate + 5.minutes
+sqlDate = sqlDate - 30.seconds
+val difference = sqlDate1 - sqlDate2        // you can perform minus on java.sql.Date and get a TimeXt-object
 
 // Util Date
 val utilDate: java.util.Date = java.util.Date()
-utilDate + 5.minutes
-utilDate - 30.seconds
+utilDate = utilDate + 5.minutes
+utilDate = utilDate - 30.seconds
+val difference = utilDate1 - utilDate2      // you can perform minus on java.util.Date and get a TimeXt-object
 
 // Timer
 val timer = Timer()
@@ -70,7 +88,7 @@ timer.schedule(10.seconds) {
 }
 ```
 
-The library also includes extensions for Android's Handler class, this is only available if you compile the "lib-android" module.
+The library also includes extensions for Android's Handler class, this is only available if you compile the "timext-android" module.
 
 ```kotlin
 val handler = Handler()
@@ -79,27 +97,29 @@ handler.postDelayed({
 }, 2.minutes)
 ```
 
-### Custom IDateTimeUnit
+### Custom TimeXtUnit
 
-If you would like to have your own date time unit, implement it as followed:
+If you would like to have your own timext unit, implement it as followed:
 
 ```kotlin
-class Year : IDateTimeUnit {
-    // amount of seconds in one year
-    override val dateTimeIntervalRatio = 365.0 * 24.0 * 60.0 * 60.0
-}
+val year: Double = 365 * 24 * 60 * 60 * 1e3
 
 // Add also some extensions:
-val Number.years: Interval<Year>
-    get() = Interval(this)
+val Number.years: TimeXt
+    get() = TimeXt(this.toDouble(), year)
 
-val Interval<IDateTimeUnit>.inYears: Interval<Year>
-    get() = converted()
+val TimeXt.inYears: TimeXt
+    get() = this.value * this.unit / year
+
+fun toYears(): TimeXt {
+    return TimeXt(this.inYears, year)
+}
 
 // Use it like:
-val threeYears = Interval<Year>(3)
+val threeYears = TimeXt(3, year)
 val oneYear = 1.years
 val daysInYear = 365.days.inYears
+val yearsFromDays = 365.days.toYears()
 
 ```
 

timext-android/timext-android.iml

@@ -109,16 +109,30 @@
       <sourceFolder url="file://$MODULE_DIR$/src/test/rs" isTestSource="true" />
       <sourceFolder url="file://$MODULE_DIR$/src/test/shaders" isTestSource="true" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/aapt_friendly_merged_manifests" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/annotation_processor_list" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/annotations_typedef_file" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/annotations_zip" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/check-manifest" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/consumer_proguard_file" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/incremental" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/javac" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/jniLibs" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/library_and_local_jars_jni" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/library_assets" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/lint_jar" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/merged_manifests" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/packaged-classes" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/packaged_res" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/public_res" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/res" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/rs" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/shader_assets" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/shaders" />
       <excludeFolder url="file://$MODULE_DIR$/build/intermediates/symbols" />
+      <excludeFolder url="file://$MODULE_DIR$/build/intermediates/transforms" />
+      <excludeFolder url="file://$MODULE_DIR$/build/kotlin" />
       <excludeFolder url="file://$MODULE_DIR$/build/outputs" />
+      <excludeFolder url="file://$MODULE_DIR$/build/tmp" />
     </content>
     <orderEntry type="jdk" jdkName="Android API 28 Platform" jdkType="Android SDK" />
     <orderEntry type="sourceFolder" forTests="false" />

timext/src/main/kotlin/com/github/guepardoapps/timext/kotlin/TimeXt.kt

@@ -2,9 +2,6 @@ package com.github.guepardoapps.timext.kotlin
 
 class TimeXt(var value: Double, var unit: Double) {
 
-    val inYears: Double
-        get() = this.value * this.unit / TimeXtUnit.year
-
     val inWeeks: Double
         get() = this.value * this.unit / TimeXtUnit.week
 
@@ -23,6 +20,30 @@ class TimeXt(var value: Double, var unit: Double) {
     val inMilliseconds: Double
         get() = this.value * this.unit / TimeXtUnit.millisecond
 
+    fun toWeeks(): TimeXt {
+        return TimeXt(this.inWeeks, TimeXtUnit.week)
+    }
+
+    fun toDays(): TimeXt {
+        return TimeXt(this.inDays, TimeXtUnit.day)
+    }
+
+    fun toHours(): TimeXt {
+        return TimeXt(this.inHours, TimeXtUnit.hour)
+    }
+
+    fun toMinutes(): TimeXt {
+        return TimeXt(this.inMinutes, TimeXtUnit.minute)
+    }
+
+    fun toSeconds(): TimeXt {
+        return TimeXt(this.inSeconds, TimeXtUnit.second)
+    }
+
+    fun toMilliseconds(): TimeXt {
+        return TimeXt(this.inMilliseconds, TimeXtUnit.millisecond)
+    }
+
     operator fun plus(timeXt: TimeXt): TimeXt {
         val newValue = ((this.inMilliseconds + timeXt.inMilliseconds) / this.unit) * TimeXtUnit.millisecond
         return TimeXt(newValue, this.unit)

timext/src/main/kotlin/com/github/guepardoapps/timext/kotlin/TimeXtUnit.kt

@@ -1,8 +1,6 @@
 package com.github.guepardoapps.timext.kotlin
 
 object TimeXtUnit {
-    val year: Double = 365 * 24 * 60 * 60 * 1e3
-
     val week: Double = 7 * 24 * 60 * 60 * 1e3
 
     val day: Double = 24 * 60 * 60 * 1e3

timext/src/main/kotlin/com/github/guepardoapps/timext/kotlin/extensions/CalendarExtensions.kt

@@ -6,7 +6,7 @@ import java.util.*
 
 operator fun Calendar.plus(timeXt: TimeXt): Calendar {
     val newCalendar = clone() as Calendar
-    newCalendar.add(Calendar.MILLISECOND, timeXt.inMilliseconds.toInt())
+    newCalendar.timeInMillis += timeXt.inMilliseconds.toLong()
     return newCalendar
 }
 

timext/src/main/kotlin/com/github/guepardoapps/timext/kotlin/extensions/DateExtensions.kt

@@ -4,12 +4,12 @@ import com.github.guepardoapps.timext.kotlin.TimeXt
 import com.github.guepardoapps.timext.kotlin.TimeXtUnit
 
 operator fun java.sql.Date.plus(timeXt: TimeXt): java.sql.Date {
-    this.time + timeXt.inMilliseconds.toLong()
+    this.time += timeXt.inMilliseconds.toLong()
     return this
 }
 
 operator fun java.sql.Date.minus(timeXt: TimeXt): java.sql.Date {
-    this + (timeXt * -1)
+    this.time -= timeXt.inMilliseconds.toLong()
     return this
 }
 
@@ -19,12 +19,12 @@ operator fun java.sql.Date.minus(date: java.sql.Date): TimeXt {
 }
 
 operator fun java.util.Date.plus(timeXt: TimeXt): java.util.Date {
-    this.time + timeXt.inMilliseconds.toLong()
+    this.time += timeXt.inMilliseconds.toLong()
     return this
 }
 
 operator fun java.util.Date.minus(timeXt: TimeXt): java.util.Date {
-    this + (timeXt * -1)
+    this.time -= timeXt.inMilliseconds.toLong()
     return this
 }
 

timext/src/main/kotlin/com/github/guepardoapps/timext/kotlin/extensions/NumberExtensions.kt

@@ -3,9 +3,6 @@ package com.github.guepardoapps.timext.kotlin.extensions
 import com.github.guepardoapps.timext.kotlin.TimeXt
 import com.github.guepardoapps.timext.kotlin.TimeXtUnit
 
-val Number.years: TimeXt
-    get() = TimeXt(this.toDouble(), TimeXtUnit.year)
-
 val Number.weeks: TimeXt
     get() = TimeXt(this.toDouble(), TimeXtUnit.week)
 

timext/src/test/kotlin/com/github/guepardoapps/timext/kotlin/TimeXtTests.kt

@@ -8,11 +8,6 @@ class TimeXtTests {
 
     @Test
     fun `All comparisons should work as expected`() {
-        assertEquals(2.years, 730.days)
-        assertTrue(3.years > 1094.days)
-        assertTrue(4.years < 1461.days)
-        assertNotEquals(2.years, 729.days)
-
         assertEquals(2.weeks, 14.days)
         assertTrue(3.weeks > 20.days)
         assertTrue(4.weeks < 29.days)
@@ -41,7 +36,6 @@ class TimeXtTests {
 
     @Test
     fun `All conversions should work as expected`() {
-        assertTrue(365.days.inYears == 1.0)
         assertTrue(4.weeks.inDays == 28.0)
         assertTrue(7.days.inWeeks == 1.0)
         assertTrue(2.5.days.inHours == 60.0)
@@ -54,9 +48,22 @@ class TimeXtTests {
         assertTrue(5.75.seconds.inMilliseconds == 5750.0)
     }
 
+    @Test
+    fun `All casts should work as expected`() {
+        assertTrue(4.weeks.toDays() == 28.days)
+        assertTrue(7.days.toWeeks() == 1.weeks)
+        assertTrue(2.5.days.toHours() == 60.hours)
+        assertTrue(5.25.hours.toMinutes() == 315.minutes)
+        assertTrue(72.hours.toDays() == 3.days)
+        assertTrue(360.minutes.toHours() == 6.hours)
+        assertTrue(15.5.minutes.toSeconds() == 930.seconds)
+        assertTrue(7200.seconds.toHours() == 2.hours)
+        assertTrue(10800.seconds.toDays() == 0.125.days)
+        assertTrue(5.75.seconds.toMilliseconds() == 5750.milliseconds)
+    }
+
     @Test
     fun `Plus operator should work as expected`() {
-        assertTrue((1.years + 365.days) == 2.years)
         assertTrue((2.weeks + 7.days) == 3.weeks)
         assertTrue((2.5.days + 12.hours) == 3.days)
         assertTrue((2.25.hours + 45.minutes) == 3.hours)
@@ -66,7 +73,6 @@ class TimeXtTests {
 
     @Test
     fun `Minus operator should work as expected`() {
-        assertTrue((2.years - 365.days) == 1.years)
         assertTrue((2.weeks - 7.days) == 1.weeks)
         assertTrue((2.5.days - 12.hours) == 2.days)
         assertTrue((2.25.hours - 15.minutes) == 2.hours)
@@ -76,7 +82,6 @@ class TimeXtTests {
 
     @Test
     fun `Multiplication operator should work as expected`() {
-        assertTrue((2.years * 2) == 4.years)
         assertTrue((2.weeks * 2) == 4.weeks)
         assertTrue((2.5.days * 3) == 7.5.days)
         assertTrue((2.25.hours * 4) == 9.hours)
@@ -87,7 +92,6 @@ class TimeXtTests {
 
     @Test
     fun `Division operator should work as expected`() {
-        assertTrue((2.years / 2) == 1.years)
         assertTrue((2.weeks / 2) == 1.weeks)
         assertTrue((1.5.days / 3) == 0.5.days)
         assertTrue((4.hours / 4) == 1.hours)
@@ -98,9 +102,6 @@ class TimeXtTests {
 
     @Test
     fun `Increment operator should work as expected`() {
-        var actualYears = 2.years
-        assertTrue(++actualYears == 3.years)
-
         var actualWeeks = 2.weeks
         assertTrue(++actualWeeks == 3.weeks)
 
@@ -122,9 +123,6 @@ class TimeXtTests {
 
     @Test
     fun `Decrement operator should work as expected`() {
-        var actualYears = 2.years
-        assertTrue(--actualYears == 1.years)
-
         var actualWeeks = 2.weeks
         assertTrue(--actualWeeks == 1.weeks)
 
@@ -156,4 +154,9 @@ class TimeXtTests {
         assertTrue(55.milliseconds in 60.milliseconds)
         assertFalse(60.milliseconds in 55.milliseconds)
     }
+
+    @Test
+    fun `HashCode should work as expected`() {
+        assertEquals(1078689792, 55.milliseconds.hashCode())
+    }
 }