Two Way Mapper 
Two way data mapping
Installation
Add this line to your application's Gemfile:
gem 'two-way-mapper'And then execute:
$ bundle
Or install it yourself as:
$ gem install two-way-mapper
Usage
First, we need to define mapping
TwoWayMapper.register :customer do |mapping|
mapping.left :object # set left plugin to object
mapping.right :hash, stringify_keys: true # set right plugin to hash
# define transformation rules
mapping.rule 'first_name', 'FirstName'
mapping.rule 'last_name', 'LastName'
mapping.rule 'gender', 'sex',
map: {
'M' => 'male',
'F' => 'female'
}, default: ''
endFor simple rules use
TwoWayMapper.register :customer do |mapping|
mapping.left :object # set left plugin to object
mapping.right :hash, stringify_keys: true # set right plugin to hash
mapping.rules(
'first_name' => 'FirstName',
'last_name' => 'LastName'
)
endMapping can be defined explicitly without registration
mapping = TwoWayMapper::Mapping.new
mapping.left :object
mapping.right :hash, stringify_keys: true
# ...Once the mapping is defined it can be used to convert one object to another and vice versa
Customer = Struct.new :first_name, :last_name, :gender
customer = Customer.new
api_response = { 'FirstName' => 'Evee', 'LastName' => 'Fjord', 'sex' => 'female' }
TwoWayMapper[:customer].from_right_to_left(customer, api_response)
puts customer.first_name # => 'Evee'
puts customer.last_name # => 'Fjord'
puts customer.gender # => 'F'
request_data = {}
another_customer = Customer.new
another_customer.first_name = 'Step'
another_customer.last_name = 'Bander'
another_customer.gender = 'M'
TwoWayMapper[:customer].from_left_to_right(another_customer, request_data)
puts request_data # => { 'FirstName' => 'Step', 'LastName' => 'Bander', sex: 'male' }In rails, mappings can be defined in app/mappings folder
Available plugins
- hash
- object
- active_record (same as
object, but for keys likeuser.email, it buildsuserbefore updatingemailon write)
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request