change beginning/end functions to only work for ITimeSpan instances. …

…ITimeSpan no longer implemented for types where beginning/end were the same - to recreate earlier behaviour, run `(t/backward-compatible-time-span-extensions)`

CHANGELOG

@@ -3,6 +3,7 @@
 * tick.interval.bounds function is now consistent for years, year-months and dates in setting the `end` to be inclusive
 * Strings are no longer accepted as beginning/end when constructing an interval
 * Strings are no longer accepted as arguments to clock
+* ITimeSpan no longer implemented for types where beginning/end were the same - to recreate earlier behaviour, run `(t/backward-compatible-time-span-extensions)`
 
 # 0.6.1 
 

docs/cheatsheet.md

@@ -7,13 +7,11 @@
 
 # Naming (compared to java.time)
 
-LocalDate => `date`
-
-LocalDateTime => `date-time`
-
-java.util.Date => `inst` 
-
-js/Date => `inst`
+* LocalDate => `date`
+* LocalDateTime => `date-time`
+* LocalTime => `time`
+* java.util.Date => `inst` 
+* js/Date => `inst`
 
 otherwise all camel-case equivalents of java.time names
 

src/tick/core.cljc

@@ -959,8 +959,8 @@
 
 ;;;
 (defn between "the span of time between v1 and v2" [v1 v2] (p/between v1 v2))
-(defn beginning "the beginning of the range of ITimeSpan v or v" [v] (if (satisfies? p/ITimeSpan v) (p/beginning v) v))
-(defn end "the end of the range of ITimeSpan v or v" [v] (if (satisfies? p/ITimeSpan v) (p/end v) v))
+(defn beginning "the beginning of the range of ITimeSpan v or v" [v] (p/beginning v))
+(defn end "the end of the range of ITimeSpan v or v" [v] (p/end v))
 
 (defn duration "return duration contained within the range of ITimeSpan 'x',  which can be a year, year-month or date " [x]
   (cljc.java-time.duration/between (beginning x) (end x)))
@@ -988,6 +988,7 @@
 ;; TODO: Test concurrent? in tick.core-test
 
 (extend-protocol p/ITimeSpan
+  ; ITimeSpan is implemented by default on types with a natural beginning and end
   LocalDate
   (beginning [date] (cljc.java-time.local-date/at-start-of-day date))
   (end [date] (cljc.java-time.local-date/at-start-of-day (inc date)))
@@ -1000,6 +1001,40 @@
   (beginning [ym] (beginning (cljc.java-time.year-month/at-day ym 1)))
   (end [ym] (beginning (cljc.java-time.year-month/at-day (inc ym) 1))))
 
+(defn backward-compatible-time-span-extensions 
+  "pre v0.7, ITimeSpan was extended as per this body. run this function to create those extensions.
+  
+  ITimeSpan is implemented by default on types with a natural beginning and end"
+  []
+  (extend-protocol p/ITimeSpan
+    Instant
+    (beginning [i] i)
+    (end [i] i)
+
+    ZonedDateTime
+    (beginning [i] i)
+    (end [i] i)
+
+    OffsetDateTime
+    (beginning [i] i)
+    (end [i] i)
+
+    #?(:clj Date :cljs js/Date)
+    (beginning [i] (p/instant i))
+    (end [i] (p/instant i))
+
+    LocalDateTime
+    (beginning [x] x)
+    (end [x] x)
+
+    LocalTime
+    (beginning [x] x)
+    (end [x] x)
+
+    nil
+    (beginning [_] nil)
+    (end [_] nil)))
+
 (extend-protocol p/ITimeReify
   LocalTime
   (on [t d] (cljc.java-time.local-time/at-date t (p/date d)))

test/tick/alpha/interval_test.cljc

@@ -8,7 +8,19 @@
    [clojure.test
     :refer [deftest is testing run-tests]
     :refer-macros [deftest is testing run-tests]]
-   [tick.alpha.interval :as ti]))
+   [tick.alpha.interval :as ti]
+   #?@(:cljs [[java.time :refer [Instant LocalDateTime LocalTime]]]))
+  #?(:clj
+     (:import [java.time LocalDateTime Instant LocalTime])))
+
+(extend-protocol p/ITimeSpan
+  ; as required by some tests in this ns
+  Instant
+  (beginning [i] i)
+  (end [i] i)
+  LocalDateTime
+  (beginning [i] i)
+  (end [i] i))
 
 (s/check-asserts true)
 
@@ -714,6 +726,10 @@
 
 ;; Can we disturb?
 (deftest cannot-disturb-test
+  (extend-protocol p/ITimeSpan
+    LocalTime
+    (beginning [i] i)
+    (end [i] i))
   (let
     [disturb-interval [(ti/new-interval (t/time "07:00") (t/time "22:00"))]
      no-disturb-interval (ti/complement disturb-interval)

test/tick/api_test.cljc

@@ -7,11 +7,21 @@
      :refer-macros [deftest is testing run-tests]]
     [tick.core :as t]
     [tick.locale-en-us]
+    [tick.protocols :as p]
     [cljc.java-time.clock]
     [cljc.java-time.instant]
     [cljc.java-time.day-of-week]
     [cljc.java-time.month]
-    [cljc.java-time.year]))
+    [cljc.java-time.year]
+    #?@(:cljs [[java.time :refer [Instant]]]))
+  #?(:clj
+     (:import [java.time Instant])))
+
+(extend-protocol p/ITimeSpan
+  ; as required by some tests in this ns
+  Instant
+  (beginning [i] i)
+  (end [i] i))
 
 (deftest time-construction-test
   (testing "(time)"