Deps and docs update

Author: amarjeet000

Diff for: README.md

@@ -195,5 +195,13 @@ Examples below:
 ## Feedback/Discussions
 Github issues are a good way to discuss library related topics. I am also reachable via [CodeRafting](https://www.coderafting.com/).
 
+## Some high-level TODOs (not in the order of priority)
+- `Clj` compatibility
+- Accept `1918-11-11T11:10:50` date-time format.
+- Option for users to provide customer date-time validators, for faster validation than the default one.
+- Include `future` date-time and intervals.
+- Some more friendly options, such as `tomorrow` and `yesterday`.
+- Option to spell out the numbers. Ex: `2 days ago` and `two days ago`.
+
 ## License
 Distributed under the MIT License. Copyright (c) 2020 [Amarjeet Yadav](https://www.coderafting.com/).

Diff for: deps.edn

@@ -0,0 +1 @@
+{:deps {com.andrewmcveigh/cljs-time {:mvn/version "0.5.2"}}}

Diff for: project.clj

@@ -4,11 +4,11 @@
   :url "https://github.com/coderafting/humane-time"
   :license {:name "The MIT License"
             :url "https://opensource.org/licenses/MIT"}
+  :repositories [["clojars" {:sign-releases false}]]
   :dependencies
   [[org.clojure/clojure "1.10.1" :scope "provided"]
    [org.clojure/clojurescript "1.10.597" :scope "provided"]
    [com.andrewmcveigh/cljs-time "0.5.2"]]
-
   :plugins
   [[lein-cljsbuild "1.1.8"]
    [lein-figwheel "0.5.19"]

Diff for: src/humane_time/core.cljs

@@ -1,15 +1,15 @@
 (ns ^{:doc "Contains functions to be exposed to library users."
-      :todo {1 "Possibility of making it available for both clj and cljs."}}
+      :todo {1 "Possibility of making it available for both `clj` and `cljs`."}}
   humane-time.core
   (:require [humane-time.ops :as ops]))
 
 (defn readable-date
-  "Accepts date-string only in the form of 'DD-MM-YYYY' and 'YYYY-MM-DD' formats. DD and MM could just be D or M.
+  "Accepts date-string only in the form of `DD-MM-YYYY` and `YYYY-MM-DD` formats. `DD` and `MM` could just be `D` or `M`.
    Returns a string similar to: 
-   April 27, 2020 or Apr 27, 2020 or Monday, April 27, 2020 or Mon, April 27, 2020 or Mon, Apr 27, 2020.
+   `April 27, 2020` or `Apr 27, 2020` or `Monday, April 27, 2020` or `Mon, April 27, 2020` or `Mon, Apr 27, 2020`.
    The optional options map dictates the return format. It includes the following keys:
-   :day-name? - defaults to true. 
-   :short-names? - defaults to false."
+    - `:day-name?` - defaults to `true`. 
+    - `:short-names?` - defaults to `false`."
   [date-string & opts-map]
   (let [dt (ops/datetime-descriptor date-string)]
     (str (if (or (nil? (:day-name? (first opts-map))) (:day-name? (first opts-map)))
@@ -60,14 +60,14 @@
       :else "less than an hour")))
 
 (defn
-  ^{:doc "Accepts start and end values (strings) only in the form of 'DD-MM-YYYY' and 'YYYY-MM-DD' formats. DD and MM could just be D or M.
+  ^{:doc "Accepts `start` and `end` values (strings) only in the form of `DD-MM-YYYY` and `YYYY-MM-DD` formats. `DD` and `MM` could just be `D` or `M`.
           Returns a readable duration, but only in the highest unit, with lower bound of the value.
-          Example: if the duration is between 1 and 2 years (ex: 1 year 10 months), then it will return '1 year'.
-          Similarly, if the duration is between 10 to 11 months, then it will return '10 months'.
-          Takes an optional approximation-string, defaults to 'about'."
-    :todo {1 "Use error-margin to compute approx timeline duration, rather than simply taking the lower bounds.
-              Maybe, an alternate return value can be offered with better approximation, with an 'about' string attached in each return value."
-           2 "Return a string that can describe the duration as: 5 years, 10 months, 2 weeks, 4 days, and 2 hours."}} 
+          Example: if the duration is between 1 and 2 years (ex: 1 year 10 months), then it will return `1 year`.
+          Similarly, if the duration is between 10 to 11 months, then it will return `10 months`.
+          Takes an optional `approximation-string`, defaults to `about`."
+    :todo {1 "Use `error-margin` to compute approx timeline duration, rather than simply taking the lower bounds.
+              Maybe, an alternate return value can be offered with better approximation, with an `about` string attached in each return value."
+           2 "Return a string that can describe the duration as: `5 years, 10 months, 2 weeks, 4 days, and 2 hours.`"}} 
   readable-duration
   [{:keys [start end approximation-string]}]
   (cond
@@ -83,11 +83,11 @@
     :else (throw (ExceptionInfo. (str "Invalid inputs - :start " start ", :end " end)))))
 
 (defn readable-moment
-  "Accepts date-string only in the form of 'DD-MM-YYYY' and 'YYYY-MM-DD' formats. DD and MM could just be D or M.
+  "Accepts `date-string` only in the form of `DD-MM-YYYY` and `YYYY-MM-DD` formats. `DD` and `MM` could just be `D` or `M`.
    Describes a moment in histry. Useful for one-time events.
    Takes an optional moment descriptor map with the following keys:
-   :prefix - defaults to 'Happened'.
-   :suffix - defaults to 'ago'.
+    - `:prefix` - defaults to `Happened`.
+    - `:suffix` - defaults to `ago`.
    One or both the keys may be provided in the map."
   [date-string & moement-desc-map]
   (str (or (:prefix (first moement-desc-map)) "Happened")
@@ -127,14 +127,14 @@
        (period-helper-end end period-desc-map)))
 
 (defn readable-period
-  "Accepts start and end values (strings) only in the form of 'DD-MM-YYYY' and 'YYYY-MM-DD' formats. DD and MM could just be D or M.
+  "Accepts `start` and `end` values (strings) only in the form of `DD-MM-YYYY` and `YYYY-MM-DD` formats. `DD` and `MM` could just be `D` or `M`.
    Takes an optional period description map with the following keys:
-   :start-desc - defaults to 'Started'.
-   :end-desc - defaults to 'Ended'.
-   :period-desc - defaults to 'Went on for'.
-   :approximation-string - defaults to 'about'.
-   :past-indicator - defaults to 'ago'.
-   :separator - defaults to ' | '. Note that there are spaces before and after the separator."
+    - `:start-desc` - defaults to 'Started'.
+    - `:end-desc` - defaults to 'Ended'.
+    - `:period-desc` - defaults to 'Went on for'.
+    - `:approximation-string` - defaults to 'about'.
+    - `:past-indicator` - defaults to 'ago'.
+    - `:separator` - defaults to ' | '. Note that there are spaces before and after the separator."
   [{:keys [start end period-desc]}]
   (cond
     (and start (nil? end)) (period-helper-start start period-desc)

Diff for: src/humane_time/ops.cljs

@@ -1,5 +1,5 @@
 (ns ^{:doc "Contains data and functions to be used by the functions in the core namespace."
-      :todo {1 "Possibility of accepting '1918-11-11T11:10:50' date-time format."
+      :todo {1 "Possibility of accepting `1918-11-11T11:10:50` date-time format."
              2 "Option for users to provide customer validators."}}
   humane-time.ops
   (:require [cljs.reader :as r]
@@ -23,7 +23,7 @@
 
 (defn datetime-descriptor
   "Takes a date string and returns a map after some destructuring. 
-   Accepts date-string only in the form of 'DD-MM-YYYY' and 'YYYY-MM-DD' formats. DD and MM could just be D or M."
+   Accepts date-string only in the form of `DD-MM-YYYY` and `YYYY-MM-DD` formats. `DD` and `MM` could just be `D` or `M`."
   [date-string]
   (let [ds (clojure.string/split date-string #"-")
         y (if (= (count (last ds)) 4) (last ds) (first ds))
@@ -46,9 +46,9 @@
 (defn duration-descriptor
   "Returns a map that describes the duration between a start and end-time in different units.
    For each unit, the value semantics is of lower bound. To elaborate:
-   If the difference (in years) is 2 years and 10 months, then the value of :years will be 2, not 3. But, the value of :months will be 34.
-   Similarly, if the difference in months is 5 months and 3 weeks, the the value of :months will be 5, not 6. But, the value of :weeks will be 23.
-   If no end-time is provided, the the current time will be considered as the end-time."
+   If the difference (in years) is 2 years and 10 months, then the value of `:years` will be 2, not 3. But, the value of `:months` will be 34.
+   Similarly, if the difference in months is 5 months and 3 weeks, the the value of `:months` will be 5, not 6. But, the value of `:weeks` will be 23.
+   If no `end-time` is provided, the the current time will be considered as the `end-time`."
   [date-string & end-time] 
   (let [intrvl (t/interval (:datetime-obj (datetime-descriptor date-string))
                            (if end-time (:datetime-obj (datetime-descriptor (first end-time))) (t/time-now)))]
@@ -59,6 +59,6 @@
      :hours (t/in-hours intrvl)}))
 
 (defn singular->plural
-  "Simply adds an 's' at the end of the singular-text arg if val is greater than 1."
+  "Simply adds an `s` at the end of the singular-text arg if `val` is greater than 1."
   [singular-text val]
   (if (<= val 1) singular-text (str singular-text "s")))