Changelog for Cldr v2.0.0

This is the changelog for Cldr v2.0.0 released on November 22, 2018. For older changelogs please consult the release tag on GitHub

Enhancements

See also Breaking Changes below.

• Transforms the regex’s for currency spacing to be compatible with the elixir regex engine. This supports improved conformance for currency formatting in ex_cldr_numbers
• Removes the need for Phoenix as a dependency in tests. Thanks to @lostkobrakai. Closes #84.
• Print deprecation message if the global config is used for more than :json_library and :default_locale
• Align Cldr/get_locale/1/0 and Cldr.put_locale/2/1 with Gettext. See Cldr.get_locale/1, Cldr.get_locale/0, Cldr.put_locale/2 and Cldr.put_locale/1
• Improve performance of Cldr.Gettext.Plural and align its return better with Gettext
• Add the ‘miscellaneous’ number formats to the locale definition files. This allows formatting of “at least”, “approximately”, “at most” and “range”. These formats will be used in ex_cldr_numbers.

Purpose of the changes

Version 2.0 of Cldr is focused on re-architecting the module structure to more closely follow the model set by Phoenix, Ecto, Gettext and others that also rely on generating a public API at compile time. In Cldr version 1.x, the compile functions were all hosted within the ex_cldr package itself which has created several challenges:

• Only one configuration was possible per installation
• Dependency compilation order couldn’t be determined which meant that when Gettext was configured a second, forced, compilation phase was required whenever the configuration changed
• Code in the ex_cldr _build directory would be modified when the configuration changed

New structure and configuration

In line with the recommended strategy for configurable library applications, Cldr now requires a backend module be defined that hosts the configuration and public API. This is similar to the strategy used by Gettext, Ecto, Phoenix and others. These backend modules are defined like this:

defmodule MyApp.Cldr do
  use Cldr, locales: ["en", "zh"]
end

For further information on configuration, consult the readme.

Migrating from Cldr 1.x to Cldr version 2.x

Although the api structure is the same in both releases, the move to a backend module hosting configuration and the public API requires changes in applications using Cldr version 1.x. The steps to migrate are:

1. Change the dependency in mix.exs to {:ex_cldr, "~> 2.0"}
2. Define a backend module to host the configuration and public API. It is recommended that the module be named MyApp.Cldr since this will ease migration through module aliasing.
3. Change calls to Cldr.function_name to MyApp.Cldr.function_name. The easiest way to do this is to alias the backend module. For example:

defmodule MyApp.SomeModule do
# alias the backend module so that calls to Cldr functions still work
  alias MyApp.Cldr

  def some_function do
    IO.puts Cldr.known_locale_names
  end
end

Breaking Changes

• Configuration has changed to focus on the backend module, then otp app, then global config. All applications are required to define a backend module.
• The Public API moves to a configured backend module. Functions previous called on Cldr should be called on MyApp.Cldr.
• The ~L sigil has been removed. The public api functions support either a locale name (like “en”) or a language tag.
• Cldr.Plug.AcceptLanguage and Cldr.Plug.SetLocale need to have a config key :cldr to specify the Cldr backend to be used.
• The Mix compiler :cldr is obsolete. It still exists so configuration doesn’t break but its no a :noop. It should be removed from your configuration.
• Cldr.Config.get_locale/1 now takes a config or backend parameter and has become Cldr.Config.get_locale/2.
• Cldr.get_current_locale/0 is renamed to Cldr.get_locale/0 to better align with Gettext
• Cldr.put_current_locale/1 is renamed to Cldr.put_locale/1 to better align with Gettext