https://github.com/appcues/exconstructor

An Elixir library for generating struct constructors that handle external data with ease.
https://github.com/appcues/exconstructor

Last synced: 8 days ago
JSON representation

An Elixir library for generating struct constructors that handle external data with ease.

• Host: GitHub
• URL: https://github.com/appcues/exconstructor
• Owner: appcues
• License: mit
• Created: 2016-01-19T22:34:39.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-09-04T17:00:30.000Z (2 months ago)
• Last Synced: 2024-09-23T23:37:14.861Z (about 2 months ago)
• Language: Elixir
• Size: 67.4 KB
• Stars: 286
• Watchers: 24
• Forks: 20
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - An Elixir library for generating struct constructors that handle external data with ease. (Algorithms and Data structures)
• fucking-awesome-elixir - exconstructor - An Elixir library for generating struct constructors that handle external data with ease. (Algorithms and Data structures)
• awesome-elixir - exconstructor - An Elixir library for generating struct constructors that handle external data with ease. (Algorithms and Data structures)

README

        
# ExConstructor

[![Build Status](https://circleci.com/gh/appcues/exconstructor.svg?style=svg)](https://circleci.com/gh/appcues/exconstructor)

[![Coverage Status](https://coveralls.io/repos/github/appcues/exconstructor/badge.svg?branch=master)](https://coveralls.io/github/appcues/exconstructor?branch=master)

[![Hex.pm Version](http://img.shields.io/hexpm/v/exconstructor.svg?style=flat)](https://hex.pm/packages/exconstructor)

ExConstructor is an Elixir library that makes it easy to instantiate

structs from external data, such as that emitted by a JSON parser.

Add `use ExConstructor` after a `defstruct` statement to inject

a constructor function into the module.

The generated constructor, called `new` by default,

handles *map-vs-keyword-list*, *string-vs-atom-keys*, and

*camelCase-vs-under_score* input data issues automatically,

DRYing up your code and letting you move on to the interesting

parts of your program.

## Example

```elixir

defmodule TestStruct do

  defstruct field_one: nil,

            field_two: nil,

            field_three: nil,

            field_four: nil

  use ExConstructor

end

TestStruct.new(%{"field_one" => "a", "fieldTwo" => "b", :field_three => "c", :FieldFour => "d"})

# => %TestStruct{field_one: "a", field_two: "b", field_three: "c", field_four: "d"}

```

## [Full Documentation](http://hexdocs.pm/exconstructor/ExConstructor.html)

[Full ExConstructor documentation is available on

Hexdocs.pm.](http://hexdocs.pm/exconstructor/ExConstructor.html)

## Contributors

Many thanks to those who've contributed to ExConstructor:

* Graeme Coupar ([@grambo](https://github.com/grambo))

* Mel Kicchi ([@meowy](https://github.com/meowy))

* Andrey Ronin ([@anronin](https://github.com/anronin))

## How to Contribute

My favorite contributions are PRs with code that matches project style,

and that come with full test coverage and documentation.  I have a hard

time saying no to them.

Feature requests are also welcome, but the timeline may be much longer.

Bug reports are great -- please include as much information as possible

(Erlang/Elixir/Mix version, dependencies and their versions, minimal

test case, etc.) and I will be much quicker in resolving the issue.

## Authorship and License

ExConstructor is copyright 2016-2021 Appcues, Inc.

ExConstructor is released under the

[MIT License](https://github.com/appcues/exconstructor/blob/master/LICENSE.txt).