README.md in rom-rails-0.0.1 vs README.md in rom-rails-0.0.2

- old
+ new

@@ -1,5 +1,74 @@ -[![Build Status](https://travis-ci.org/rom-rb/rom-rails.svg?branch=master)](https://travis-ci.org/rom-rb/rom-rails) +[![Gem Version](https://badge.fury.io/rb/rom-rails.svg)][gem] +[![Build Status](https://travis-ci.org/rom-rb/rom-rails.svg?branch=master)][travis] +[![Dependency Status](https://gemnasium.com/rom-rb/rom-rails.png)][gemnasium] +[![Code Climate](https://codeclimate.com/github/rom-rb/rom-rails/badges/gpa.svg)][codeclimate] +[![Test Coverage](https://codeclimate.com/github/rom-rb/rom-rails/badges/coverage.svg)][codeclimate] +[![Inline docs](http://inch-ci.org/github/rom-rb/rom-rails.svg?branch=master)][inchpages] +[gem]: https://rubygems.org/gems/rom-rails +[travis]: https://travis-ci.org/rom-rb/rom-rails +[gemnasium]: https://gemnasium.com/rom-rb/rom-rails +[codeclimate]: https://codeclimate.com/github/rom-rb/rom-rails +[coveralls]: https://coveralls.io/r/rom-rb/rom-rails +[inchpages]: http://inch-ci.org/github/rom-rb/rom-rails + # rom-rails -Rails integration for Ruby Object Mapper +Rails integration for [Ruby Object Mapper](https://github.com/rom-rb/rom). + +## Installation and setup + +In your Gemfile: + +``` +gem 'rom' +gem 'rom-rails' +``` + +## Schema + +Defining schema is only required for adapters that don't support inferring schema +automatically. This means if you're using `rom-sql` you don't have to define the schema. +In other cases the railtie expects the schema to be in `db/rom/schema.rb` which +is loaded before relations and mappers. + +## Relations and mappers + +The railtie automatically loads relations and mappers from `app/relations` and +`app/mappers` and finalizes the environment afterwards. During the booting process +rom's setup object is available via `Rails.application.config.rom.setup`. + +## Relations in controllers + +Currently the railtie simply adds `#rom` method to your controllers which returns +the whole environment. This is **a temporary solution** which is not meant to be final. + +Eventually ROM will expose relations to the controller layer (thus view layer too) +that are already loaded into memory and **there will be no database interactions** +taking place in those layers. This means that effectively database **query interface +will not be available in controllers, views, helpers or anywhere outside of the +relation definitions**. + +This means your Rails application will work with arrays of domain objects rather +than ad-hoc database queries scattered across your entire codebase and there will +be *a single place* where you define all the relations and object mapping. + +## Status + +This project is still in alpha state. For examples of usage please take a look +at `spec/dummy` app. + +Proper documentation will be added once the interface is stable. + +## Roadmap + +Please refer to [issues](https://github.com/rom-rb/rom-rails/issues). + +## Community + +* [![Gitter chat](https://badges.gitter.im/rom-rb/chat.png)](https://gitter.im/rom-rb/chat) +* [Ruby Object Mapper](https://groups.google.com/forum/#!forum/rom-rb) mailing list + +## License + +See `LICENSE` file.