Mapping

The mapping gem is a structured system for mapping one model to another, using an intermediate model which represents the transformation to apply.

Motivation

I've been thinking (and designing) versioned APIs which serve their data primarily from ActiveRecord models. Initially we have been using as_json/serializable_hash/to_json where it made sense.

records.as_json

This was fine for really simple models and APIs. However, as things get more complex, this approach gets cumbersome:

records.as_json(
    only: [:id, :name, :image, :longitude, :latitude],
    include: [:major_category, :categories],
)

We need versioned, internationalized APIs which don't always directly match up to the underlying database models, or in some cases the underlying models change but the API should remain stable (e.g. column renamed, tables changed).

# image attribute was renamed to image_url, how do we version the response?
records.as_json(
    only: [:id, :name, :image_url, :longitude, :latitude],
    include: [:major_category, :categories],
)

It's also not obvious how to inject methods that take arguments, or even handle per-request state (e.g. Accept-Language). Even if it is possible (e.g. using a lambda) I'm not sure that this approach is really desirable - the argument list is becoming impossibly complex: Possibly buggy, hard to reuse, test and difficult to document.

ActiveModel::Serializers looks awesome at first but ultimately seems like an over-engineered version of as_json. It directly depends on globally defined models which makes versioning hard and doesn't provide any obvious way to inject per-request state (e.g. language). It clutters up existing models and splits serialization concerns over multiple classes. It's implementation is difficult to understand, it has a large surface area, and it doesn't really address the major concerns regarding versioning, stability and (per-request) state.

I've implemented a framework for Objective-C many years ago which exposes a single primary concept: a mapping model. A mapping model is an object which describes the process mapping an input model (e.g. an ActiveRecord model) to an output model (e.g. a hash suitable for JSON::generate). A mapping model is entirely isolated from state which is not directly related to the mapping process itself. Because of this, multiple models can co-exist, and the models themselves can be versioned, localized, or whatever else necessary to perform a suitable mapping. It's easy to remove a model if it's no longer being used as all the code is in one place. It's easy to test a mapping model in isolation. Models can be documented like normal code. They can be reused and composed together easily.

The design of this library is centered around being explicit where being explicit makes life easier in the long term.

Installation

Add this line to your application's Gemfile:

gem 'mapping'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mapping

Usage

A mapping model is required for mapping data from one format to another:

# Your database model:
module Human
    Person = Struct.new(:name, :age, :posessions)
    Possession = Struct.new(:name, :value)
end

# Your mapping model:
class APIv1 < Mapping::ObjectModel
    map(Human::Person) do |object|
        {
            name: object.name,
            age: object.age,
        }
    end
end

class APIv2 < APIv1
    map(Human::Person) do |object|
        super.merge(
            posessions: self.map(object.posessions)
        )
    end

    map(Human::Possession) do |object|
        {
            name: object.name,
            value: object.value,
        }
    end
end

A simple use case would be something like the following:

model = APIv1.new

person = Human::Person.new('Bob Jones', 200, [])
person.posessions << Human::Possession.new('Vase', '$20')

expect(model.map(person)).to be == {
    name: 'Bob Jones',
    age: 200
}

Model vs ObjectModel

The base Mapping::Model class provides only the basic structure required to create and invoke mapping methods. The Mapping::ObjectModel provides a few default mappings for true, false, nil, Array and Hash.

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

License

Released under the MIT license.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.