Fix #241 by fully-qualifying type hints

seancorfield · seancorfield · commit 476d38247d00 · 2017-11-13T10:09:15.000-08:00
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,3 +1,7 @@
+## Changes Between 0.14.1 and 0.14.2
+
+* Fully-qualify function return type hints to avoid requiring imports on use (#241).
+
 ## Changes Between 0.14.0 and 0.14.1
 
 * Switches `clojure.spec` to `clojure.spec.alpha` to work with latest Clojure 1.9 builds.
diff --git a/project.clj b/project.clj
@@ -1,4 +1,4 @@
-(defproject clj-time/clj-time "0.14.1"
+(defproject clj-time/clj-time "0.14.2"
   :description "A date and time library for Clojure, wrapping Joda Time."
   :url "https://github.com/clj-time/clj-time"
   :mailing-list {:name "clj-time mailing list"
diff --git a/src/clj_time/coerce.clj b/src/clj_time/coerce.clj
@@ -16,42 +16,42 @@
                           LocalDate LocalDateTime]))
 
 (defprotocol ICoerce
-  (to-date-time ^DateTime [obj] "Convert `obj` to a Joda DateTime instance."))
+  (to-date-time ^org.joda.time.DateTime [obj] "Convert `obj` to a Joda DateTime instance."))
 
-(defn ^DateTime from-long
+(defn ^org.joda.time.DateTime from-long
   "Returns a DateTime instance in the UTC time zone corresponding to the given
    number of milliseconds after the Unix epoch."
   [^Long millis]
   (DateTime. millis ^DateTimeZone utc))
 
-(defn ^DateTime from-epoch
+(defn ^org.joda.time.DateTime from-epoch
   "Returns a DateTime instance in the UTC time zone
    from given Unix epoch."
   [^Long epoch]
   (from-long (* epoch 1000)))
 
-(defn ^DateTime from-string
+(defn ^org.joda.time.DateTime from-string
   "return DateTime instance from string using
    formatters in clj-time.format, returning first
    which parses"
   [^String s]
   (time-fmt/parse s))
 
-(defn ^DateTime from-date
+(defn ^org.joda.time.DateTime from-date
   "Returns a DateTime instance in the UTC time zone corresponding to the given
    Java Date object."
-  [^Date date]
+  [^java.util.Date date]
   (when date
     (from-long (.getTime date))))
 
-(defn ^DateTime from-sql-date
+(defn ^org.joda.time.DateTime from-sql-date
   "Returns a DateTime instance in the UTC time zone corresponding to the given
    java.sql.Date object."
   [^java.sql.Date sql-date]
   (when sql-date
     (from-long (.getTime sql-date))))
 
-(defn ^DateTime from-sql-time
+(defn ^org.joda.time.DateTime from-sql-time
   "Returns a DateTime instance in the UTC time zone corresponding to the given
    java.sql.Timestamp object."
   [^java.sql.Timestamp sql-time]
@@ -70,7 +70,7 @@
   (if-let [millis (to-long obj)]
     (quot millis 1000)))
 
-(defn ^Date to-date
+(defn ^java.util.Date to-date
   "Convert `obj` to a Java Date instance."
   [obj]
   (if-let [dt (to-date-time obj)]
@@ -101,19 +101,19 @@
   (if-let [dt (to-date-time obj)]
     (java.sql.Timestamp. (.getMillis dt))))
 
-(defn ^LocalDate to-local-date
+(defn ^org.joda.time.LocalDate to-local-date
   "Convert `obj` to a org.joda.time.LocalDate instance"
   [obj]
   (if-let [dt (to-date-time obj)]
     (LocalDate. (.getMillis (from-time-zone dt (default-time-zone))))))
 
-(defn ^LocalDateTime to-local-date-time
+(defn ^org.joda.time.LocalDateTime to-local-date-time
   "Convert `obj` to a org.joda.time.LocalDateTime instance"
   [obj]
   (if-let [dt (to-date-time obj)]
     (LocalDateTime. (.getMillis (from-time-zone dt (default-time-zone))))))
 
-(defn ^LocalDate in-time-zone
+(defn ^org.joda.time.LocalDate in-time-zone
   "Convert `obj` into `tz`, return org.joda.time.LocalDate instance."
   [obj tz]
   (if-let [dt (to-date-time obj)]
diff --git a/src/clj_time/core.clj b/src/clj_time/core.clj
@@ -274,7 +274,7 @@
   ([^DateTimeZone tz]
    (DateMidnight. tz)))
 
-(defn ^DateTime with-time-at-start-of-day
+(defn ^org.joda.time.DateTime with-time-at-start-of-day
   "Returns a DateTime representing the start of the day. Normally midnight,
   but not always true, as in some time zones with daylight savings."
   [^DateTime dt]
@@ -307,7 +307,7 @@
   [dt & dts]
   (reduce #(if (after? %1 %2) %1 %2) dt dts))
 
-(defn ^DateTime date-time
+(defn ^org.joda.time.DateTime date-time
   "Constructs and returns a new DateTime in UTC.
    Specify the year, month of year, day of month, hour of day, minute of hour,
    second of minute, and millisecond of second. Note that month and day are
@@ -741,7 +741,7 @@
    (plus (first-day-of-the-month dt)
          (days (- n 1)))))
 
-(defn ^DateTime today-at
+(defn ^org.joda.time.DateTime today-at
   ([^long hours ^long minutes ^long seconds ^long millis]
      (let [^MutableDateTime mdt (.toMutableDateTime ^DateTime (now))]
        (.toDateTime (doto mdt
@@ -767,7 +767,7 @@
   `(do-at* ~base-date-time
     (fn [] ~@body)))
 
-(defn ^DateTime floor
+(defn ^org.joda.time.DateTime floor
   "Floors the given date-time dt to the given time unit dt-fn,
   e.g. (floor (now) hour) returns (now) for all units
   up to and including the hour"
diff --git a/src/clj_time/format.clj b/src/clj_time/format.clj
@@ -38,7 +38,7 @@
 (declare formatters)
 ;; The formatters map and show-formatters idea are strait from chrono.
 
-(defn ^DateTimeFormatter formatter
+(defn ^org.joda.time.format.DateTimeFormatter formatter
   "Returns a custom formatter for the given date-time pattern or keyword."
   ([fmts]
      (formatter fmts utc))
@@ -56,32 +56,32 @@
         (.toFormatter)
         (.withZone dtz)))))
 
-(defn ^DateTimeFormat formatter-local
+(defn ^org.joda.time.format.DateTimeFormat formatter-local
   "Returns a custom formatter with no time zone info."
   ([^String fmt]
      (DateTimeFormat/forPattern fmt)))
 
-(defn ^DateTimeFormatter with-chronology
+(defn ^org.joda.time.format.DateTimeFormatter with-chronology
   "Return a copy of a formatter that uses the given Chronology."
   [^DateTimeFormatter f ^Chronology c]
   (.withChronology f c))
 
-(defn ^DateTimeFormatter with-locale
+(defn ^org.joda.time.format.DateTimeFormatter with-locale
   "Return a copy of a formatter that uses the given Locale."
   [^DateTimeFormatter f ^Locale l]
   (.withLocale f l))
 
-(defn ^DateTimeFormatter with-pivot-year
+(defn ^org.joda.time.format.DateTimeFormatter with-pivot-year
   "Return a copy of a formatter that uses the given pivot year."
   [^DateTimeFormatter f ^Long pivot-year]
   (.withPivotYear f pivot-year))
 
-(defn ^DateTimeFormatter with-zone
+(defn ^org.joda.time.format.DateTimeFormatter with-zone
   "Return a copy of a formatter that uses the given DateTimeZone."
   [^DateTimeFormatter f ^DateTimeZone dtz]
   (.withZone f dtz))
 
-(defn ^DateTimeFormatter with-default-year
+(defn ^org.joda.time.format.DateTimeFormatter with-default-year
   "Return a copy of a formatter that uses the given default year."
   [^DateTimeFormatter f ^Integer default-year]
   (.withDefaultYear f default-year))
@@ -153,7 +153,7 @@
 (def ^{:private true} printers
   (difference (set (keys formatters)) parsers))
 
-(defn ^DateTime parse
+(defn ^org.joda.time.DateTime parse
   "Returns a DateTime instance in the UTC time zone obtained by parsing the
    given string according to the given formatter."
   ([^DateTimeFormatter fmt ^String s]
@@ -164,7 +164,7 @@
             :let [d (try (parse f s) (catch Exception _ nil))]
             :when d] d))))
 
-(defn ^LocalDateTime parse-local
+(defn ^org.joda.time.LocalDateTime parse-local
   "Returns a LocalDateTime instance obtained by parsing the
    given string according to the given formatter."
   ([^DateTimeFormatter fmt ^String s]
@@ -175,7 +175,7 @@
             :let [d (try (parse-local f s) (catch Exception _ nil))]
             :when d] d))))
 
-(defn ^LocalDate parse-local-date
+(defn ^org.joda.time.LocalDate parse-local-date
   "Returns a LocalDate instance obtained by parsing the
    given string according to the given formatter."
   ([^DateTimeFormatter fmt ^String s]
@@ -186,7 +186,7 @@
             :let [d (try (parse-local-date f s) (catch Exception _ nil))]
             :when d] d))))
 
-(defn ^LocalTime parse-local-time
+(defn ^org.joda.time.LocalTime parse-local-time
   "Returns a LocalTime instance obtained by parsing the
   given string according to the given formatter."
   ([^DateTimeFormatter fmt ^ String s]

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-(defproject clj-time/clj-time "0.14.1"`
	`1`	`+(defproject clj-time/clj-time "0.14.2"`
`2`	`2`	`:description "A date and time library for Clojure, wrapping Joda Time."`
`3`	`3`	`:url "https://github.com/clj-time/clj-time"`
`4`	`4`	`:mailing-list {:name "clj-time mailing list"`