Merge branch 'develop'

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/master/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/master/releases/)
+[![Build](https://img.shields.io/badge/build-success-green.svg)](https://github.com/TimeXt/TimeXt-Kotlin/blob/master/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/master/releases/)
+[![CodeCoverage](https://img.shields.io/badge/codeCoverage-71-orange.svg)](https://github.com/TimeXt/TimeXt-Kotlin/tree/master/)
 
 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()
 
 ```
 

build.gradle

@@ -1,15 +1,20 @@
 buildscript {
     ext.gradle_version = '3.2.1'
+    ext.jacoco_coverage_version = '0.4.0'
     ext.junit_version = '4.12'
     ext.kotlin_version = '1.2.71'
+    ext.maven_gradle_version = '2.0'
 
     repositories {
         google()
         jcenter()
     }
+
     dependencies {
         classpath "com.android.tools.build:gradle:$gradle_version"
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        classpath "com.github.dcendents:android-maven-gradle-plugin:$maven_gradle_version"
+        classpath "com.palantir:jacoco-coverage:$jacoco_coverage_version"
     }
 }
 
@@ -18,4 +23,6 @@ allprojects {
         google()
         jcenter()
     }
-}
+}
+
+apply plugin: 'com.palantir.jacoco-full-report'