Contents

# Ruby Object Mapper

This is a meta-project grouping pieces of ROM's default stack:

* [rom-relation](https://github.com/rom-rb/rom-relation)
* [rom-mapper](https://github.com/rom-rb/rom-mapper)
* [rom-session](https://github.com/rom-rb/rom-session)

## Getting started

### 1. Set up environment and define schema

```ruby
  require 'rom'

  env = ROM::Environment.setup(memory: 'memory://test')

  env.schema do
    base_relation :users do
      repository :memory

      attribute :id,   Integer
      attribute :name, String

      key :id
    end
  end
```

### 2. Set up mapping

```ruby
  class User
    attr_reader :id, :name

    def initialize(attributes)
      @id, @name = attributes.values_at(:id, :name)
    end
  end

  env.mapping do
    users do
      map :id, :name
      model User
    end
  end
```

### 3. Work with Plain Old Ruby Objects

```ruby
  ROM::Session.start(env) do |session|
    session[:users].save(User.new(id: 1, name: 'Jane'))
    session.commit
  end

  jane = env[:users].restrict(name: 'Jane').one
```

## Authors

* [Dan Kubb](https://github.com/dkubb)
* [Markus Schirp](https://github.com/mbj)
* [Martin Gamsjaeger](https://github.com/snusnu)
* [Piotr Solnica](https://github.com/solnic)

## Licence

See `LICENSE` file.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rom-0.1.1	README.md