Merge pull request #1513 from hkateu/nstime

SCALA-378 code for nscala-time article

Author: dominiqueplante

build.sbt

@@ -501,6 +501,14 @@ lazy val refined = (project in file("scala-libraries-standalone/refined"))
     libraryDependencies ++= scalaTestDeps
   )
 
+lazy val nscalatime = (project in file("scala-libraries-standalone/nscalatime"))
+  .settings(
+    name := "nscalatime",
+    scalaVersion := scala3Version,
+    libraryDependencies += "com.github.nscala-time" %% "nscala-time" % "2.32.0",
+    libraryDependencies ++= scalaTestDeps
+  )
+
 val spireVersion = "0.18.0"
 val kafkaVersion = "7.7.0-ce"
 val pureconfigVersion = "0.17.7"

scala-libraries-standalone/nscalatime/src/main/scala/com/baeldung/nscalatime/NscalaTime.scala

@@ -0,0 +1,71 @@
+package com.baeldung.nscalatime
+
+import com.github.nscala_time.time.Imports.*
+import java.util.Date
+import java.util.Calendar
+import java.util.Locale
+import org.joda.time.chrono.EthiopicChronology
+import org.joda.time.DateTime.Property
+import com.github.nscala_time.time.DurationBuilder
+import org.joda.time.format.DateTimeFormatter
+
+object NScalaTime:
+  // working with DateTime
+  val st: DateTime = DateTime.now()
+  val parsedDate: DateTime = DateTime.parse("2024-08-07")
+  val parsedDate2: DateTime = DateTime.parse("2024")
+
+  // JDK interoperability
+  val jdkDate: Date = new Date()
+  val convertTo: DateTime = new DateTime(jdkDate)
+
+  val jdkCal: Calendar = Calendar.getInstance()
+  val st2: DateTime = new DateTime(jdkCal)
+
+  val st3: DateTime = new DateTime
+  val cal: Calendar = st3.gregorianCalendar
+
+  // querrying Datetime
+  val dayOfWeek: Property = new DateTime().dayOfWeek()
+  val shortText: String = dayOfWeek.asShortText
+  val asText: String = dayOfWeek.asText
+  val monthOfYearString: String = DateTime.now().monthOfYear().getAsText()
+  val monthOfYearStringFrench: String =
+    DateTime.now().monthOfYear().getAsShortText(Locale.FRENCH)
+  val isLeapYear: Boolean = DateTime.now().year().isLeap()
+  val nowToTomorrow: Interval = DateTime.now().to(DateTime.tomorrow())
+
+  // Accessing fields
+  // Date fields
+  val st4: DateTime = new DateTime()
+  val era: String = st4.era.asText
+  val year2: String = st4.year.asText
+  val centOfEra: String = st4.centuryOfEra.asText
+  val yrOfEra: String = st4.yearOfEra.asText
+  val yrOfCent: String = st4.yearOfCentury.asText
+  val monthOfYr: String = st4.monthOfYear.asText
+  val dayOfYr: String = st4.dayOfYear.asText
+  val dayOfMonth: String = st4.dayOfMonth.asText
+  val dayOfWeek2: String = st4.dayOfWeek.asText
+  // Time fields
+  val hrOfDay: String = st4.hourOfDay.asText
+  val minOfHr: String = st4.minuteOfHour.asText
+  val secOfMin: String = st4.secondOfMinute.asText
+
+  // Manipulating datetimes
+  val compare: Boolean = DateTime.now() < DateTime.lastMonth()
+  val addVarious: Period = 2.month + 5.hours + 6.millis
+  val less5: DateTime = DateTime.now() - 5.days
+  val sampleDuration: DurationBuilder = 4.hours + 30.minutes + 10.seconds
+  val datetimebeforeDuration: DateTime = sampleDuration.before(DateTime.now())
+  val changeTZ: DateTime = less5.withZone(DateTimeZone.forID("Africa/Kampala"))
+  val chrono: DateTime = less5.withChronology(EthiopicChronology.getInstance())
+  val ethioYear: Int = chrono.getYear()
+
+  // formatters
+  val fmt: DateTimeFormatter = DateTimeFormat.forPattern("dd-MM-yyyy")
+  val st5: DateTime = fmt.parseDateTime("31-07-2024")
+
+import NScalaTime.*
+@main def sTime(): Unit =
+  println(st5)

scala-libraries-standalone/nscalatime/src/test/scala/com/baeldung/nscalatime/NscalaTimeUnitTest.scala

@@ -0,0 +1,106 @@
+package com.baeldung.nscalatime
+
+import com.github.nscala_time.time.Imports.*
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
+import org.scalatest.prop.Tables.*
+import org.scalatest.prop.TableDrivenPropertyChecks
+import org.scalatest.prop.TableFor1
+import java.util.Date
+import java.util.Calendar
+import com.github.nscala_time.time.DurationBuilder
+import org.joda.time.format.DateTimeFormatter
+import NScalaTime.*
+
+class NScalaTimeUnitTest
+  extends AnyFlatSpec
+  with Matchers
+  with TableDrivenPropertyChecks:
+
+  "DateTime checks" should "pass as DateTime objects" in:
+    val dateTimeObjects: TableFor1[DateTime] =
+      Table(
+        "datetimeobjects",
+        parsedDate,
+        parsedDate2,
+        convertTo,
+        st2,
+        st3,
+        st4,
+        less5,
+        changeTZ,
+        chrono,
+        st5
+      )
+
+    forAll(dateTimeObjects) { n =>
+      n shouldBe an[DateTime]
+    }
+
+  "jdkDate" should "pass as a Date objects" in:
+    jdkDate shouldBe an[Date]
+
+  "Calendar checks" should "pass as Calendar objects" in:
+    val calendarObjects: TableFor1[Calendar] =
+      Table(
+        "calendarobjects",
+        jdkCal,
+        cal
+      )
+
+    forAll(calendarObjects) { n =>
+      n shouldBe an[Calendar]
+    }
+
+  "strings checks" should "pass as String objects" in:
+    val stringObjects: TableFor1[String] =
+      Table(
+        "stringsobjects",
+        shortText,
+        asText,
+        monthOfYearString,
+        monthOfYearStringFrench,
+        era,
+        year2,
+        centOfEra,
+        yrOfEra,
+        yrOfCent,
+        monthOfYr,
+        dayOfYr,
+        dayOfMonth,
+        dayOfWeek2,
+        hrOfDay,
+        minOfHr,
+        secOfMin
+      )
+
+    forAll(stringObjects) { n =>
+      n shouldBe an[String]
+    }
+
+  "boolean checks" should "pass as Boolean objects" in:
+    val booleanObjects: TableFor1[Boolean] =
+      Table(
+        "booleanobjects",
+        isLeapYear,
+        compare
+      )
+
+    forAll(booleanObjects) { n =>
+      n shouldBe an[Boolean]
+    }
+
+  "nowToTomorrow" should "pass as an Interval object" in:
+    nowToTomorrow shouldBe an[Interval]
+
+  "addVarious" should "pass as a Period object" in:
+    addVarious shouldBe an[Period]
+
+  "sampleDuration" should "pass as a DurationBuilder object" in:
+    sampleDuration shouldBe an[DurationBuilder]
+
+  "ethioYear" should "pass as an Int object" in:
+    ethioYear shouldBe an[Int]
+
+  "fmt" should "pass as a DateTimeFormatter object" in:
+    fmt shouldBe an[DateTimeFormatter]