KeyConvert

KeyConvert adds convenience methods for transforming keys in Maps. Transformations are done recursively by default.

Installation

The package can be installed by adding :key_convert to your list of dependencies in mix.exs:

def deps do
  [
    {:key_convert, "~> 0.5.0"}
  ]
end

Basic Usage

Snake Case

snake_case converts the keys into all lower case separated by an underscore. Atom keys are converted into strings.

KeyConvert.snake_case(%{
  contactInfo: %{emailAddress: "email@example.com"}
})
# %{"contact_info" => %{"email_address" => "email@example.com"}}

Camelize

camelize converts the keys into camel-case. Atom keys are converted into strings. It will retain the case of the first letter.

KeyConvert.camelize(%{
  contact_info: %{email_address: "email@example.com"}
})
# %{"contactInfo" => %{"emailAddress" => "email@example.com"}}

Rename

rename converts the keys via the rename_map which is used to determine what keys are replaced with. Keys that are not available in the rename_map are unaffected.

KeyConvert.rename(
  %{amount: 500, currency: "PHP"},
  %{amount: :value} # rename_map
)
# %{value: 500, currency: "PHP"}

Stringify

stringify converts atom keys into strings. Non atom keys are left unaffected.

KeyConvert.stringify(%{amount: 100})
# %{"amount" => 100}

Atomize

atomize converts string keys to atom. Non string keys are unaffected. Use this function with caution as atoms are not garbage collected.

KeyConvert.atomize(%{"amount" => 100})
# %{amount: 100}

Convert

convert provides a way to transform keys based on a function supplied by the user. The transformer function should be able to take a key as an input and return a new key which will be used for the converted Map.

# converter function that appends the string ".changed"
append_change = fn key -> key <> ".changed" end

KeyConvert.convert(%{"total_amount" => 500}, append_change)
# %{"total_amount.changed" => 500}

Copyright and License

Copyright (c) 2019 John Smith Paraggua

This work is free. You can redistribute it and/or modify it under the terms of the MIT License. See the LICENSE.md file for more details.