Merge branch 'main' into version-0.1.2

Author: bdebinska

.github/workflows/test.yml

@@ -0,0 +1,61 @@
+name: Tests
+
+on:
+  workflow_call:
+    inputs:
+      skip-check-formatted:
+        type: boolean
+        default: false
+  push:
+    branches:
+      - "**"
+
+env:
+  MIX_ENV: test
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Run Tests
+    steps:
+      - name: Git Clone the Repository
+        uses: actions/checkout@v4
+
+      # See https://github.com/erlef/setup-beam/issues/325
+      - name: Set ImageOS Env (fix for erlef/setup-beam)
+        id: erlef-fix
+        run: |
+          VSN=$(cat /etc/os-release | grep VERSION_ID | awk -F '"' '{ print $2 }' | awk -F "." '{ print $1 }')
+          echo "ImageOS=ubuntu${VSN}" >> $GITHUB_OUTPUT
+
+      - name: Set up Elixir
+        uses: erlef/setup-beam@v1
+        with:
+          version-file: .tool-versions
+          version-type: strict
+        env:
+          ImageOS: ${{ steps.erlef-fix.outputs.ImageOS }}
+
+      - name: Cache Mix Dependencies
+        uses: actions/cache@v4
+        env:
+          cache-name: elixir-deps
+        with:
+          path: |
+            deps
+            _build
+          key: ${{ runner.os }}-${{ runner.arch }}-${{ env.cache-name }}-${{ steps.setup-beam.outputs.elixir-version }}-${{ steps.setup-beam.outputs.otp-version }}-${{ hashFiles('**/mix.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ runner.arch }}-${{ env.cache-name }}-${{ steps.setup-beam.outputs.elixir-version }}-${{ steps.setup-beam.outputs.otp-version }}-
+
+      - name: Fetch Mix Deps
+        run: mix deps.get
+
+      - name: Compile Project
+        run: mix compile --warnings-as-errors
+
+      - name: Run Tests
+        run: mix test --trace
+
+      - name: Check Formatting
+        run: mix format --check-formatted
+        if: ${{ github.event.inputs.skip-check-formatted != true }}

.tool-versions

@@ -0,0 +1,2 @@
+elixir 1.18.3-otp-27
+erlang 27.3.3

README.md

@@ -1,21 +1,16 @@
 # ValueFormatters
 
-**TODO: Add description**
+## Usage
 
-## Installation
+To use value formatters, the host application needs to set up its own Cldr backend, including the following libraries:
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `value_formatters` to your list of dependencies in `mix.exs`:
+* Cldr.Number,
+* Cldr.Calendar,
+* Cldr.DateTime,
+* Cldr.Time,
+* Cldr.Date
+
+Cldr needs to be passed as an option to the `to_string/3` method under `cldr` key.
 
-```elixir
-def deps do
-  [
-    {:value_formatters, "~> 0.1.0"}
-  ]
-end
-```
 
-Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at <https://hexdocs.pm/value_formatters>.
 

lib/value_formatters.ex

@@ -1,32 +1,62 @@
 defmodule ValueFormatters do
   use OK.Pipe
-  alias ValueFormatters.Cldr
+
+  # Allows instantiation of the module with preset options.
+  defmacro __using__(module_opts) do
+    quote do
+      def to_string(value, format_definition, opts \\ []) do
+        defaults =
+          Keyword.get(unquote(module_opts), :defaults, %{})
+          |> Map.merge(Keyword.get(opts, :defaults, %{}))
+
+        opts =
+          Keyword.put_new(opts, :cldr, unquote(module_opts[:cldr]))
+          |> Keyword.put(:defaults, defaults)
+
+        ValueFormatters.to_string(value, format_definition, opts)
+      end
+    end
+  end
 
   @date_display_options [:none, :short, :medium, :long, :full]
   @time_display_options [:none, :short, :medium, :long, :full]
 
-  def to_string(value, format_definition, options \\ [])
-
-  def to_string(nil, _format_definition, _options), do: {:ok, ""}
-  def to_string("", _format_definition, _options), do: {:ok, ""}
+  def to_string(value, format_definition, opts \\ [])
 
-  # def to_string(true, _format_definition, _options), do: {:ok, Cldr.Message.format("Yes")}
-  # def to_string(false, _format_definition, _options), do: {:ok, Cldr.Message.format("No")}
+  def to_string(nil, _format_definition, _opts), do: {:ok, ""}
+  def to_string("", _format_definition, _opts), do: {:ok, ""}
 
-  def to_string(value, format_definition, options) do
+  def to_string(value, format_definition, opts) do
     format_definition =
       format_definition
       |> expand_format_definition(value)
-      |> merge_with_defaults(options)
+      |> merge_with_defaults(opts)
 
     # do the formatting
     case format_definition["format"] do
-      "number" -> format_number(value, format_definition, options)
-      "string" -> format_string(value, format_definition)
-      "date" -> format_date(value, format_definition, options)
-      "date_relative" -> format_date_relative(value, format_definition, options)
-      "coordinates" -> format_coordinates(value, format_definition)
-      _ -> {:error, "Unsupported format #{format_definition["format"]}"}
+      "number" ->
+        format_number(value, format_definition, opts)
+
+      "string" ->
+        format_string(value, format_definition)
+
+      "date" ->
+        format_date(value, format_definition, opts)
+
+      "date_relative" ->
+        format_date_relative(value, format_definition, opts)
+
+      "date_iso" ->
+        format_date_iso(value, format_definition, opts)
+
+      "date_unix" ->
+        format_date_unix(value, format_definition, opts)
+
+      "coordinates" ->
+        format_coordinates(value, format_definition, opts)
+
+      _ ->
+        {:error, "Unsupported format #{format_definition["format"]}"}
     end
     |> handle_cldr_error()
   end
@@ -37,8 +67,7 @@ defmodule ValueFormatters do
   end
 
   # In case of a shorthand formatDefinition, expand it
-  defp expand_format_definition(format_definition, _value)
-       when format_definition in ["number", "string", "date", "date_relative", "coordinates"] do
+  defp expand_format_definition(format_definition, _value) when is_binary(format_definition) do
     %{"format" => format_definition}
   end
 
@@ -82,6 +111,17 @@ defmodule ValueFormatters do
     end
   end
 
+  defp cldr(opts, mod_name) do
+    with {:ok, cldr} <- Keyword.fetch(opts, :cldr) do
+      Module.concat(cldr, mod_name)
+    else
+      :error ->
+        raise ArgumentError,
+          message:
+            "Attempted to access a Cldr module, but non was specified. Pass the :cldr option to to_string/3 or when instantiating the module."
+    end
+  end
+
   defp format_number(value, number_definition, opts) when is_number(value) do
     precision = Map.get(number_definition, "precision")
     unit = Map.get(number_definition, "unit")
@@ -97,7 +137,10 @@ defmodule ValueFormatters do
         {value, precision}
       end
 
-    Cldr.Number.to_string(rounded_value, locale: get_locale(opts), fractional_digits: precision)
+    cldr(opts, Number).to_string(rounded_value,
+      locale: get_locale(opts),
+      fractional_digits: precision
+    )
     ~> append_unit(unit, opts)
   end
 
@@ -155,22 +198,60 @@ defmodule ValueFormatters do
 
         # Value of type Time has to be formatted with Cldr.Time
         date_display == :none or is_time(value) ->
-          Cldr.Time.to_string(value, format: time_display, locale: get_locale(opts))
+          cldr(opts, Time).to_string(value, format: time_display, locale: get_locale(opts))
 
         # Value of type Date has to be formatted with Cldr.Date
         time_display == :none or is_date(value) ->
-          Cldr.Date.to_string(value, format: date_display, locale: get_locale(opts))
+          cldr(opts, Date).to_string(value, format: date_display, locale: get_locale(opts))
 
         # Covers DateTime and NaiveDateTime
         true ->
-          Cldr.DateTime.to_string(value,
+          cldr(opts, DateTime).to_string(value,
             date_format: date_display,
             time_format: time_display,
             locale: get_locale(opts)
           )
       end
-    else
-      {:error, reason} -> {:error, reason}
+    end
+  end
+
+  defp format_date_iso(value, date_definition, opts) do
+    with {:ok, value} <- pre_process_date_value(value, date_definition, opts) do
+      case value do
+        %Date{} ->
+          {:ok, Date.to_iso8601(value)}
+
+        %Time{} ->
+          {:ok, Time.to_iso8601(value)}
+
+        %DateTime{} ->
+          {:ok, DateTime.to_iso8601(value)}
+
+        _ ->
+          {:error, "Invalid Date/Time value #{value}"}
+      end
+    end
+  end
+
+  defp format_date_unix(value, date_definition, opts) do
+    with {:ok, value} <- pre_process_date_value(value, date_definition, opts),
+         {:ok, value} <- ensure_unix_convertible(value) do
+      milliseconds =
+        Map.get(date_definition, "milliseconds", false)
+
+      precision = if milliseconds, do: :millisecond, else: :second
+
+      DateTime.to_unix(value, precision)
+      |> Integer.to_string()
+      |> OK.wrap()
+    end
+  end
+
+  defp ensure_unix_convertible(value) do
+    case value do
+      %Date{} -> DateTime.new(value, ~T[00:00:00])
+      %DateTime{} -> {:ok, value}
+      _ -> {:error, "Value #{inspect(value)} is not a Date or DateTime."}
     end
   end
 
@@ -242,7 +323,7 @@ defmodule ValueFormatters do
   defp format_date_relative(value, date_definition, opts) do
     with {:ok, value} <- pre_process_date_value(value, date_definition, opts) do
       if not is_time(value) do
-        Cldr.DateTime.Relative.to_string(value, locale: get_locale(opts))
+        cldr(opts, DateTime.Relative).to_string(value, locale: get_locale(opts))
       else
         {:error, "Date part is required for relative date formatting."}
       end
@@ -251,7 +332,7 @@ defmodule ValueFormatters do
     end
   end
 
-  defp format_coordinates(value, coordinate_definition) do
+  defp format_coordinates(value, coordinate_definition, opts) do
     [lat, lng, radius] =
       case value do
         %{"lat" => lat, "lng" => lng, "radius" => radius} -> [lat, lng, radius]
@@ -261,11 +342,16 @@ defmodule ValueFormatters do
       end
 
     with {:ok, lat_formatted} <-
-           format_number(lat, %{"format" => "number", "precision" => 5}, []),
-         {:ok, lng_formatted} <- format_number(lng, %{"format" => "number", "precision" => 5}, []) do
+           format_number(lat, %{"format" => "number", "precision" => 5}, opts),
+         {:ok, lng_formatted} <-
+           format_number(lng, %{"format" => "number", "precision" => 5}, opts) do
       if get_in(coordinate_definition, ["radius_display"]) != false and radius != nil do
         with {:ok, radius_formatted} <-
-               format_number(radius, %{"format" => "number", "precision" => 0, "unit" => "m"}, []) do
+               format_number(
+                 radius,
+                 %{"format" => "number", "precision" => 0, "unit" => "m"},
+                 opts
+               ) do
           {:ok, "#{lat_formatted}\u{00B0}, #{lng_formatted}\u{00B0}, #{radius_formatted}"}
         else
           {:error, reason} -> {:error, reason}
@@ -278,10 +364,9 @@ defmodule ValueFormatters do
     end
   end
 
-  defp get_locale(opts, default \\ nil) do
+  defp get_locale(opts) do
     Keyword.get(opts, :locale) ||
-      Process.get(:locale) ||
-      default
+      Process.get(:locale)
   end
 
   defp get_timezone(opts, default \\ nil) do

mix.exs

@@ -6,8 +6,12 @@ defmodule ValueFormatters.MixProject do
       app: :value_formatters,
       version: "0.1.2",
       elixir: "~> 1.15",
+      elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,
-      deps: deps()
+      deps: deps(),
+      preferred_cli_env: [
+        "test.watch": :test
+      ]
     ]
   end
 
@@ -22,11 +26,16 @@ defmodule ValueFormatters.MixProject do
   defp deps do
     [
       {:ex_doc, "~> 0.38.2", only: :dev},
-      {:ex_cldr_dates_times, "~> 2.22"},
-      {:ex_cldr_lists, "~> 2.10"},
-      {:ex_cldr_calendars, "~> 2.1"},
+      {:ex_cldr_dates_times, "~> 2.22", only: [:dev, :test]},
+      {:ex_cldr_lists, "~> 2.10", only: [:dev, :test]},
+      {:ex_cldr_calendars, "~> 2.1", only: [:dev, :test]},
+      {:mox, "~> 1.0", only: [:dev, :test]},
       {:timex, "~> 3.7", only: :test},
-      {:ok, "~> 2.3.0"}
+      {:ok, "~> 2.3.0"},
+      {:mix_test_watch, "~> 1.3", only: [:dev, :test]}
     ]
   end
+
+  defp elixirc_paths(:test), do: ["lib", "test"]
+  defp elixirc_paths(_), do: ["lib"]
 end

mix.lock

@@ -14,6 +14,7 @@
   "ex_cldr_numbers": {:hex, :ex_cldr_numbers, "2.35.1", "aa84601e604f6656b4bfb7f58a329328d2cbc13e4601da9071c14af38fc1d641", [:mix], [{:decimal, "~> 1.6 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:digital_token, "~> 0.3 or ~> 1.0", [hex: :digital_token, repo: "hexpm", optional: false]}, {:ex_cldr, "~> 2.42", [hex: :ex_cldr, repo: "hexpm", optional: false]}, {:ex_cldr_currencies, "~> 2.16", [hex: :ex_cldr_currencies, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}], "hexpm", "925c25debb0a4d27b3559885a79fb66dd4ebb6b72ce46b1e971db647042e28a0"},
   "ex_doc": {:hex, :ex_doc, "0.38.2", "504d25eef296b4dec3b8e33e810bc8b5344d565998cd83914ffe1b8503737c02", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "732f2d972e42c116a70802f9898c51b54916e542cc50968ac6980512ec90f42b"},
   "expo": {:hex, :expo, "1.1.0", "f7b9ed7fb5745ebe1eeedf3d6f29226c5dd52897ac67c0f8af62a07e661e5c75", [:mix], [], "hexpm", "fbadf93f4700fb44c331362177bdca9eeb8097e8b0ef525c9cc501cb9917c960"},
+  "file_system": {:hex, :file_system, "1.1.0", "08d232062284546c6c34426997dd7ef6ec9f8bbd090eb91780283c9016840e8f", [:mix], [], "hexpm", "bfcf81244f416871f2a2e15c1b515287faa5db9c6bcf290222206d120b3d43f6"},
   "gettext": {:hex, :gettext, "0.26.2", "5978aa7b21fada6deabf1f6341ddba50bc69c999e812211903b169799208f2a8", [:mix], [{:expo, "~> 0.5.1 or ~> 1.0", [hex: :expo, repo: "hexpm", optional: false]}], "hexpm", "aa978504bcf76511efdc22d580ba08e2279caab1066b76bb9aa81c4a1e0a32a5"},
   "hackney": {:hex, :hackney, "1.24.1", "f5205a125bba6ed4587f9db3cc7c729d11316fa8f215d3e57ed1c067a9703fa9", [:rebar3], [{:certifi, "~> 2.15.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "~> 6.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "~> 1.0.0", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "~> 1.4", [hex: :mimerl, repo: "hexpm", optional: false]}, {:parse_trans, "3.4.1", [hex: :parse_trans, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "~> 1.1.0", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}, {:unicode_util_compat, "~> 0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "f4a7392a0b53d8bbc3eb855bdcc919cd677358e65b2afd3840b5b3690c4c8a39"},
   "idna": {:hex, :idna, "6.1.1", "8a63070e9f7d0c62eb9d9fcb360a7de382448200fbbd1b106cc96d3d8099df8d", [:rebar3], [{:unicode_util_compat, "~> 0.7.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm", "92376eb7894412ed19ac475e4a86f7b413c1b9fbb5bd16dccd57934157944cea"},
@@ -23,6 +24,9 @@
   "makeup_erlang": {:hex, :makeup_erlang, "1.0.2", "03e1804074b3aa64d5fad7aa64601ed0fb395337b982d9bcf04029d68d51b6a7", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "af33ff7ef368d5893e4a267933e7744e46ce3cf1f61e2dccf53a111ed3aa3727"},
   "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"},
   "mimerl": {:hex, :mimerl, "1.4.0", "3882a5ca67fbbe7117ba8947f27643557adec38fa2307490c4c4207624cb213b", [:rebar3], [], "hexpm", "13af15f9f68c65884ecca3a3891d50a7b57d82152792f3e19d88650aa126b144"},
+  "mix_test_watch": {:hex, :mix_test_watch, "1.3.0", "2ffc9f72b0d1f4ecf0ce97b044e0e3c607c3b4dc21d6228365e8bc7c2856dc77", [:mix], [{:file_system, "~> 0.2 or ~> 1.0", [hex: :file_system, repo: "hexpm", optional: false]}], "hexpm", "f9e5edca976857ffac78632e635750d158df14ee2d6185a15013844af7570ffe"},
+  "mox": {:hex, :mox, "1.2.0", "a2cd96b4b80a3883e3100a221e8adc1b98e4c3a332a8fc434c39526babafd5b3", [:mix], [{:nimble_ownership, "~> 1.0", [hex: :nimble_ownership, repo: "hexpm", optional: false]}], "hexpm", "c7b92b3cc69ee24a7eeeaf944cd7be22013c52fcb580c1f33f50845ec821089a"},
+  "nimble_ownership": {:hex, :nimble_ownership, "1.0.1", "f69fae0cdd451b1614364013544e66e4f5d25f36a2056a9698b793305c5aa3a6", [:mix], [], "hexpm", "3825e461025464f519f3f3e4a1f9b68c47dc151369611629ad08b636b73bb22d"},
   "nimble_parsec": {:hex, :nimble_parsec, "1.4.2", "8efba0122db06df95bfaa78f791344a89352ba04baedd3849593bfce4d0dc1c6", [:mix], [], "hexpm", "4b21398942dda052b403bbe1da991ccd03a053668d147d53fb8c4e0efe09c973"},
   "ok": {:hex, :ok, "2.3.0", "0a3d513ec9038504dc5359d44e14fc14ef59179e625563a1a144199cdc3a6d30", [:mix], [], "hexpm", "f0347b3f8f115bf347c704184b33cf084f2943771273f2b98a3707a5fa43c4d5"},
   "parse_trans": {:hex, :parse_trans, "3.4.1", "6e6aa8167cb44cc8f39441d05193be6e6f4e7c2946cb2759f015f8c56b76e5ff", [:rebar3], [], "hexpm", "620a406ce75dada827b82e453c19cf06776be266f5a67cff34e1ef2cbb60e49a"},