Date and Time Localization and Formatting

Build Status Hex pm License

Introduction

ex_cldr_dates_times is an addon library application for ex_cldr that provides localisation and formatting for dates, times and date_times.

The primary api is Cldr.Date.to_string/3, Cldr.Time.to_string/3, Cldr.DateTime.to_string/3 and Cldr.DateTime.Relative.to_string/3. The following examples demonstrate:

  iex> Cldr.Date.to_string Date.utc_today()
  {:ok, "Jun 9, 2019"}

  iex> Cldr.Time.to_string Time.utc_now
  {:ok, "12:11:14 AM"}

  iex> Cldr.DateTime.to_string DateTime.utc_now
  {:ok, "Jun 9, 2019, 12:11:24 AM"}

  # Note that if options are provided, a backend
  # module is also required
  iex> Cldr.DateTime.Relative.to_string 1, MyApp.Cldr, unit: :day, format: :narrow
  {:ok, "tomorrow"}

For help in iex:

  iex> h Cldr.Date.to_string
  iex> h Cldr.Time.to_string
  iex> h Cldr.DateTime.to_string
  iex> h Cldr.DateTime.Relative.to_string

Configuration and Migration from Version 1

ex_cldr_dates_times uses the configuration set for the dependency ex_cldr. See the documentation for ex_cldr.

A backend module is required that is used to host the functions that manage CLDR data. An example to get started is:

  1. Create a backend module (see ex_cldr for details of the available options). Note the requirement to configure the appropriate Cldr provider backends.
defmodule MyApp.Cldr do
  use Cldr,
    locales: ["en", "fr", "ja"],
    providers: [Cldr.Number, Cldr.Calendar, Cldr.DateTime]

end
  1. Update config.exs configuration to specify this backend as the system default:
config :ex_cldr,
  default_locale: "en",
  default_backend: MyApp.Cldr
  1. Update any calls to Cldr.Date.to_string/2 to call Cldr.Date.to_string/3 with the second parameter being a backend module. The same applies for migrating to Cldr.DateTime.to_string/3, Cldr.Time.to_string/3 and Cldr.DateTime.Relative.to_string/3. For example:
  # Change from to_string/2 to to_string/3
  # Old version
  iex> Cldr.DateTime.to_string DateTime.utc_now, format: :short

  # New version. Note the addition of a backend module as
  # the second parameter.
  iex> Cldr.DateTime.to_string DateTime.utc_now, MyApp.Cldr, format: :short

Date, Time and DateTime Localization Formatting

Dates, Times and DateTimes can be formatted using:

  • The format types defined for each locale. These format types provide cross-locale standardisation and therefore should be preferred where possible. The format types, implemented for Cldr.Date.to_string/2, Cldr.Time.to_string/2,Cldr.DateTime.to_string/2 are :short, :medium, :long and :full. The default is :medium. For example, assuming a configured backend called MyApp.Cldr:
  iex> Cldr.DateTime.to_string DateTime.utc_now, MyApp.Cldr, format: :short
  {:ok, "6/9/19, 12:13 AM"}

  iex> Cldr.DateTime.to_string DateTime.utc_now, MyApp.Cldr, format: :long
  {:ok, "June 9, 2019 at 12:14:15 AM UTC"}

  iex> Cldr.DateTime.to_string DateTime.utc_now, MyApp.Cldr, format: :medium
  {:ok, "Jun 9, 2019, 12:14:27 AM"}

  iex> Cldr.DateTime.to_string DateTime.utc_now, MyApp.Cldr, format: :long, locale: "fr"
  {:ok, "9 juin 2019 à 00:14:38 UTC"}
  • A user specified format string. A format string uses one or more formatting symbols to define what date and time elements should be places in the format. A simple example to format the time into hours and minutes:
  iex> Cldr.DateTime.to_string DateTime.utc_now, MyApp.Cldr, format: "hh:MM"
  {:ok, "12:06"}
  • For DateTimes there is also a set of predefined format name. These format names are returned by MyApp.Cldr.DateTime.date_time_available_formats/1 (assuming your backend is MyApp.Cldr). The set of common format names across all locales configured in ex_cldr can be returned by Cldr.DateTime.Format.common_date_time_format_names. These format names can be used with the :format paramater to Cldr.DateTime.to_string/2 module only.
  iex> MyApp.Cldr.DateTime.Format.date_time_available_formats
  %{mmmm_w_count_one: "'week' W 'of' MMMM", gy_mmm: "MMM y G", md: "M/d",
    mmm_md: "MMMM d", e_hms: "E HH:mm:ss", ed: "d E", y_mmm: "MMM y",
    e_hm: "E HH:mm", mmm_ed: "E, MMM d", y_mmm_ed: "E, MMM d, y",
    gy_mm_md: "MMM d, y G", mmm: "LLL", y_md: "M/d/y", gy: "y G",
    hms: "h:mm:ss a", hm: "h:mm a", y_mmmm: "MMMM y", m: "L",
    gy_mmm_ed: "E, MMM d, y G", y_qqq: "QQQ y", e: "ccc", y_qqqq: "QQQQ y",
    hmsv: "h:mm:ss a v", mmmm_w_count_other: "'week' W 'of' MMMM",
    ehm: "E h:mm a", y_m_ed: "E, M/d/y", h: "h a", hmv: "h:mm a v",
    yw_count_other: "'week' w 'of' y", mm_md: "MMM d", y_m: "M/y", m_ed: "E, M/d",
    ms: "mm:ss", d: "d", y_mm_md: "MMM d, y", yw_count_one: "'week' w 'of' y",
    y: "y", ehms: "E h:mm:ss a"}

  # These format types can be invoked for any locale - meaning
  # these format names are defined for all configured locales.
  iex> Cldr.DateTime.Format.common_date_time_format_names(MyApp.Cldr)
  [:gy_mmm, :md, :mmm_md, :e_hms, :ed, :y_mmm, :e_hm, :mmm_ed, :y_mmm_ed,
   :gy_mm_md, :mmm, :y_md, :gy, :hms, :hm, :y_mmmm, :m, :gy_mmm_ed, :y_qqq, :e,
   :y_qqqq, :hmsv, :mmmm_w_count_other, :ehm, :y_m_ed, :h, :hmv, :yw_count_other,
   :mm_md, :y_m, :m_ed, :ms, :d, :y_mm_md, :y, :ehms]

  iex> Cldr.DateTime.to_string DateTime.utc_now, MyApp.Cldr, format: :gy_mmm_ed
  {:ok, "Sun, Jun 9, 2019 AD"}

Format strings

The CLDR standard defines a wide range of format symbols. Most - but not all - of these symbols are supported in Cldr. The supported symbols are described below. Note the known restrictions and limitations.

ElementSymbolExampleCldr Format
EraG, GG, GGG"AD"Abbreviated
GGGG"Anno Domini"Wide
GGGGG"A"Narrow
Yeary7Minimum necessary digits
yy"17"Least significant 2 digits
yyy"017", "2017"Padded to at least 3 digits
yyyy"2017"Padded to at least 4 digits
yyyyy"02017"Padded to at least 5 digits
ISOWeek YearY7Minimum necessary digits
YY"17"Least significant 2 digits
YYY"017", "2017"Padded to at least 3 digits
YYYY"2017"Padded to at least 4 digits
YYYYY"02017"Padded to at least 5 digits
Related Gregorian Yearr, rr, rr+2017Minimum necessary digits
Cyclic YearU, UU, UUU"甲子"Abbreviated
UUUU"甲子" (for now)Wide
UUUUU"甲子" (for now)Narrow
Extended Yearu+4601Minimim necessary digits
QuarterQ2Single digit
QQ"02"Two digits
QQQ"Q2"Abbreviated
QQQQ"2nd quarter"Wide
QQQQQ"2"Narrow
Standalone Quarterq2Single digit
qq"02"Two digits
qqq"Q2"Abbreviated
qqqq"2nd quarter"Wide
qqqqq"2"Narrow
MonthM9Single digit
MM"09"Two digits
MMM"Sep"Abbreviated
MMMM"September"Wide
MMMMM"S"Narrow
Standalone MonthL9Single digit
LL"09"Two digits
LLL"Sep"Abbreviated
LLLL"September"Wide
LLLLL"S"Narrow
Week of Yearw2, 22Single digit
ww02, 22Two digits, zero padded
Week of MonthW2Single digit. NOT IMPLEMENTED YET
Day of YearD3, 33, 333Minimum necessary digits
DD03, 33, 333Minimum of 2 digits, zero padded
DDD003, 033, 333Minimum of 3 digits, zero padded
Day of Monthd2, 22Minimum necessary digits
dd02, 22Two digits, zero padded
Day of WeekE, EE, EEE"Tue"Abbreviated
EEEE"Tuesday"Wide
EEEEE"T"Narrow
EEEEEE"Tu"Short
e2Single digit
ee"02"Two digits
eee"Tue"Abbreviated
eeee"Tuesday"Wide
eeeee"T"Narrow
eeeeee"Tu"Short
Standalone Day of Weekc, cc2Single digit
ccc"Tue"Abbreviated
cccc"Tuesday"Wide
ccccc"T"Narrow
cccccc"Tu"Short
AM or PMa, aa, aaa"am."Abbreviated
aaaa"am."Wide
aaaaa"am"Narrow
Noon, Mid, AM, PMb, bb, bbb"mid."Abbreviated
bbbb"midnight"Wide
bbbbb"md"Narrow
Flexible time periodB, BB, BBB"at night"Abbreviated
BBBB"at night"Wide
BBBBB"at night"Narrow
Hourh, K, H, kSee the table below
Minutem3, 10Minimim digits of minutes
mm"03", "12"Two digits, zero padded
Seconds3, 48Minimim digits of seconds
ss"03", "48"Two digits, zero padded
Fractional SecondsS3, 48Minimim digits of fractional seconds
SS"03", "48"Two digits, zero padded
MillsecondsA+4000, 63241Minimim digits of milliseconds since midnight
Generic non-location TZv"Etc/UTC":time_zone key, unlocalised
vvvv"unk"Generic timezone name. Currently returns only "unk"
Specific non-location TZz..zzz"UTC":zone_abbr key, unlocalised
zzzz"GMT"Delegates to zone_gmt/4
Timezone IDV"unk":zone_abbr key, unlocalised
VV"Etc/UTCDelegates to zone_gmt/4
VVV"Unknown City"Exemplar city. Not supported.
VVVV"GMT"Delegates to `zone_gmt/4
ISO8601 FormatZ..ZZZ"+0100"ISO8601 Basic Format with hours and minutes
ZZZZ"+01:00"Delegates to `zone_gmt/4
ZZZZZ"+01:00:10"ISO8601 Extended format with optional seconds
ISO8601 plus ZX"+01"ISO8601 Basic Format with hours and optional minutes or "Z"
XX"+0100"ISO8601 Basic Format with hours and minutes or "Z"
XXX"+0100"ISO8601 Basic Format with hours and minutes, optional seconds or "Z"
XXXX"+010059"ISO8601 Basic Format with hours and minutes, optional seconds or "Z"
XXXXX"+01:00:10"ISO8601 Extended Format with hours and minutes, optional seconds or "Z"
ISO8601 minus Zx"+0100"ISO8601 Basic Format with hours and optional minutes
xx"-0800"ISO8601 Basic Format with hours and minutes
xxx"+01:00"ISO8601 Extended Format with hours and minutes
xxxx"+010059"ISO8601 Basic Format with hours and minutes, optional seconds
xxxxx"+01:00:10"ISO8601 Extended Format with hours and minutes, optional seconds
GMT FormatO"+0100"Short localised GMT format
OOOO"+010059"Long localised GMT format

Formatting symbols for hour of day

The hour of day can be formatted differently depending whether a 12- or 24-hour day is being represented and depending on the way in which midnight and noon are represented. The following table illustrates the differences:

SymbolMidn.MorningNoonAfternoonMidn.
h121...11121...1112
K01...1101...110
H01...111213...230
k241...111213...2324

Relative Date, Time and DateTime Localization Formatting

The primary API for formatting relative dates and datetimes is Cldr.DateTime.Relative.to_string/2. Some examples:

      iex> Cldr.DateTime.Relative.to_string(-1)
      {:ok, "1 second ago"}

      iex> Cldr.DateTime.Relative.to_string(1)
      {:ok, "in 1 second"}

      iex> Cldr.DateTime.Relative.to_string(1, MyApp.Cldr, unit: :day)
      {:ok, "tomorrow"}

      iex> Cldr.DateTime.Relative.to_string(1, MyApp.Cldr, unit: :day, locale: "fr")
      {:ok, "demain"}

      iex> Cldr.DateTime.Relative.to_string(1, MyApp.Cldr, unit: :day, format: :narrow)
      {:ok, "tomorrow"}

      iex> Cldr.DateTime.Relative.to_string(1234, MyApp.Cldr, unit: :year)
      {:ok, "in 1,234 years"}

      iex> Cldr.DateTime.Relative.to_string(1234, MyApp.Cldr, unit: :year, locale: "fr")
      {:ok, "dans 1 234 ans"}

      iex> Cldr.DateTime.Relative.to_string(31)
      {:ok, "in 31 seconds"}

      iex> Cldr.DateTime.Relative.to_string(~D[2017-04-29], MyApp.Cldr, relative_to: ~D[2017-04-26])
      {:ok, "in 3 days"}

      iex> Cldr.DateTime.Relative.to_string(310, MyApp.Cldr, format: :short, locale: "fr")
      {:ok, "dans 5 min"}

      iex> Cldr.DateTime.Relative.to_string(310, MyApp.Cldr, format: :narrow, locale: "fr")
      {:ok, "+5 min"}

      iex> Cldr.DateTime.Relative.to_string 2, MyApp.Cldr, unit: :wed, format: :short
      {:ok, "in 2 Wed."}

      iex> Cldr.DateTime.Relative.to_string 1, MyApp.Cldr, unit: :wed, format: :short
      {:ok, "next Wed."}

      iex> Cldr.DateTime.Relative.to_string -1, MyApp.Cldr, unit: :wed, format: :short
      {:ok, "last Wed."}

      iex> Cldr.DateTime.Relative.to_string -1, MyApp.Cldr, unit: :wed
      {:ok, "last Wednesday"}

      iex> Cldr.DateTime.Relative.to_string -1, MyApp.Cldr, unit: :quarter
      {:ok, "last quarter"}

      iex> Cldr.DateTime.Relative.to_string -1, MyApp.Cldr, unit: :mon, locale: "fr"
      {:ok, "lundi dernier"}

      iex> Cldr.DateTime.Relative.to_string(~D[2017-04-29], MyApp.Cldr, unit: :ziggeraut)
      {:error, {Cldr.UnknownTimeUnit,
       "Unknown time unit :ziggeraut.  Valid time units are [:day, :hour, :minute, :month, :second, :week, :year, :mon, :tue, :wed, :thu, :fri, :sat, :sun, :quarter]"}}

Known restrictions and limitations

Although largely complete (with respect to the CLDR data), there are some known limitations as of release 2.0.

  • Week of month The week of the mornth is returned for format symbol W. This is not currently implemented. It returns 1 for all input.

  • Timezones Although the timezone format codes are supported (formatting symbols v, V, x, X, z, Z, O) not all localisations are performed. Only that data available within a DateTime struct is used to format timezone data.

Installation

Note that :ex_cldr_dates_times requires Elixir 1.8 or later.

Add ex_cldr_dates_time as a dependency to your mix project:

defp deps do
  [
    {:ex_cldr_dates_times, "~> 2.0"}
  ]
end

then retrieve ex_cldr_dates_times from hex:

mix deps.get
mix deps.compile