CouchRest Models adds additional functionality to the standard CouchRest Document class such as setting properties, callbacks, typecasting, and validations.
Please visit the documentation project at http://www.couchrest.info. You're contributions to the documentation would be greatly appreciated!
General API: http://rdoc.info/projects/couchrest/couchrest_model
See the update history for an up to date list of all the changes we've been working on recently.
Originally called ExtendedDocument, the new Model structure uses ActiveModel, part of Rails 3, for validations and callbacks.
If your project is still running Rails 2.3, you'll have to continue using ExtendedDocument as it is not possible to load ActiveModel into programs that do not use ActiveSupport 3.0.
CouchRest Model is only properly tested on CouchDB version 1.0 or newer.
Pre 2.0: As of June 2012, couchrest model no longer supports the view_by and view calls from the model. Views are no only accessed via a design document. If you have older code and wish to upgrade, please ensure you move to the new syntax for using views.
Pre 1.1: As of April 2011 and the release of version 1.1.0, the default model type key is 'type' instead of 'couchrest-type'. Simply updating your project will not work unless you migrate your data or set the configuration option in your initializers:
CouchRest::Model::Base.configure do |config|
config.model_type_key = 'couchrest-type'
end
This is because CouchRest Model's are not couchrest specific and may be used in any other systems such as Javascript, the model type should reflect this. Also, we're all used to type being a reserved word in ActiveRecord.
$ sudo gem install couchrest_model
If you're using bundler, define a line similar to the following in your project's Gemfile:
gem 'couchrest_model'
CouchRest Model is configured to work out the box with no configuration as long as your CouchDB instance is running on the default port (5984) on localhost. The default name of the database is either the name of your application as provided by the Rails.application.class.to_s call (with /application removed) or just 'couchrest' if none is available.
The library will try to detect a configuration file at config/couchdb.yml from the Rails root or Dir.pwd. Here you can configuration your database connection in a Rails-like way:
development:
protocol: 'https'
host: sample.cloudant.com
port: 443
prefix: project
suffix: test
username: test
password: user
Note that the name of the database is either just the prefix and suffix combined or the prefix plus any text you specifify using use_database method in your models with the suffix on the end.
The example config above for example would use a database called "project_test". Heres an example using the use_database call:
class Project < CouchRest::Model::Base
use_database 'sample'
end
# The database object would be provided as:
Project.database #=> "https://test:user@sample.cloudant.com:443/project_sample_test"
$ rails generate couchrest_model:config
$ rails generate model person --orm=couchrest_model
require 'couchrest_model'
class Cat < CouchRest::Model::Base
property :name, String
property :lives, Integer, :default => 9
property :nicknames, [String]
timestamps!
design do
view :by_name
end
end
@cat = Cat.new(:name => 'Felix', :nicknames => ['so cute', 'sweet kitty'])
@cat.new? # true
@cat.save
@cat['name'] # "Felix"
@cat.nicknames << 'getoffdamntable'
@cat = Cat.new
@cat.update_attributes(:name => 'Felix', :random_text => 'feline')
@cat.new? # false
@cat.random_text # Raises error!
CouchRest Model now comes with a Gemfile to help with development. If you want to make changes to the code, download a copy then run:
bundle install
That should set everything up for rake spec to be run correctly. Update the couchrest_model.gemspec if your alterations
use different gems.
The most complete documentation is the spec/ directory. To validate your CouchRest install, from the project root directory run bundle install to ensure all the development dependencies are available and then rspec spec or bundle exec rspec spec.
We will not accept pull requests to the project without sufficient tests.
Please post bugs, suggestions and patches to the bug tracker at http://github.com/couchrest/couchrest_model/issues.
Follow us on Twitter: http://twitter.com/couchrest
Also, check http://twitter.com/#search?q=%23couchrest