Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 1.95 KB

README.markdown

File metadata and controls

71 lines (46 loc) · 1.95 KB
Raw

amistad

Amistad adds friendships management into a rails application. it supports ActiveRecord, Mongoid and MongoMapper.

Installation

Add the following line in your Gemfile:

gem 'amistad'

Then run:

bundle install

Usage

Refer to the wiki pages for usage and friendships management documentation.

Testing

There are rake tasks available which allow you to run the activerecord tests for three rdbms:

rake spec:activerecord:sqlite
rake spec:activerecord:mysql
rake spec:activerecord:postgresql

In order to run these tasks you need to create a confiuration file for the databases connections:

spec/support/activerecord/database.yml

sqlite:
  adapter: "sqlite3"
  database: ":memory:"

mysql:
  adapter: mysql2
  encoding: utf8
  database: <name of mysql database>
  username: <username>
  password: <password>

postgresql:
  adapter: postgresql
  encoding: unicode
  database: <name of postgresql database>
  username: <username>
  password: <password>

Of course there are some tasks for running mongodb orms based tests:

rake spec:mongoid
rake spec:mongo_mapper

The default rake tasks runs the ActiveRecord tests for the three rdbms followed by the Mongoid tests.

Contributors

  • David Czarnecki : block friendships (and many other improvements)
  • Adrian Dulić : unblock friendships (and many other improvements)

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright

Copyright © 2010 Rawane ZOSSOU. See LICENSE for details.