dhaspden / transmog Goto Github PK

Features:

Integers as map keys are valid in Elixir. We'll need to find a way to support them somehow. I'll need to ponder what the syntax for the key mapping string would look like... If anyone has any suggestions I'd be open to hearing them!

Example:

iex> key_map = [{"1", "one"}]
iex> data = %{1 => "abc"}
iex> {:ok, formatted_data} = Transmog.format(data, key_map)
iex> formatted_data
%{"one" => "abc"}

Features:

Currently maps with keys which have the period character in them are not mapped as you'd expect. We should support the period character by allowing it to be escaped. Escaped periods will not trigger the split in Transmog.Parser.

Examples:

iex> Transmog.Parser.parse([{"a\.b", "b\.a"}])
[{["a.b", "b.a"}]

Features:

I think it would be awesome to support a third element in the tuple which is a transformer function. This function will transform the value (if it's set of course) to whatever the return value of the callback function is.

Example:

iex> key_mapping = [{"a", ":a", &Integer.parse/1}]
iex> data = %{"a" => "123"}
iex> {:ok, formatted_data} = Transmog.format(data, key_mapping)
iex> formatted_data
%{a: 123}

Features:

Sometimes we know that the data we are providing is correct and don't want to have to pattern match out the result from {:ok, data}. We should give the developer the option to opt for use a bang version of the function if they want to.

Example:

iex> key_map = [{"a", ":a"}]
iex> data = %{"a" => "b"}
iex> Transmog.format!(data, key_map)
%{a: "b"}

Meta

Eventually when I am happy with this library I will need to post to Hex. I will close this issue when that is done. 😃