couchrest_model/README.md

138 lines
4.9 KiB
Markdown
Raw Normal View History

# CouchRest Model: CouchDB, close to shiny metal with rounded edges
2008-09-07 21:54:22 +02:00
CouchRest Models adds additional functionality to the standard CouchRest Document class such as
setting properties, callbacks, typecasting, and validations.
2008-09-07 21:54:22 +02:00
## Documentation
Please visit the documentation project at [http://www.couchrest.info](http://www.couchrest.info). You're [contributions](https://github.com/couchrest/couchrest.github.com) to the documentation would be greatly appreciated!
General API: [http://rdoc.info/projects/couchrest/couchrest_model](http://rdoc.info/projects/couchrest/couchrest_model)
See the [update history](https://github.com/couchrest/couchrest_model/blob/master/history.md) for an up to date list of all the changes we've been working on recently.
## Notes
2011-04-21 17:29:13 +02:00
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.
2008-09-07 21:54:22 +02:00
*WARNING:* 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.
## Install
2009-04-16 21:20:17 +02:00
2010-12-03 01:17:26 +01:00
### Gem
2010-12-03 01:17:26 +01:00
$ sudo gem install couchrest_model
### Bundler
If you're using bundler, define a line similar to the following in your project's Gemfile:
gem 'couchrest_model'
### Configuration
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:
2011-01-17 16:11:50 +01:00
class Project < CouchRest::Model::Base
use_database 'sample'
end
2011-01-17 16:11:50 +01:00
# The database object would be provided as:
Project.database #=> "https://test:user@sample.cloudant.com:443/project_sample_test"
2011-01-17 16:11:50 +01:00
2010-08-24 01:27:17 +02:00
## Generators
2011-05-15 19:41:13 +02:00
### Configuration
$ rails generate couchrest_model:config
2010-08-24 01:27:17 +02:00
### Model
2011-04-21 17:29:13 +02:00
$ rails generate model person --orm=couchrest_model
2011-01-16 17:11:31 +01:00
## General Usage
require 'couchrest_model'
class Cat < CouchRest::Model::Base
2010-06-11 02:02:22 +02:00
property :name, String
property :lives, Integer, :default => 9
property :nicknames, [String]
timestamps!
view_by :name
2008-09-07 21:54:22 +02:00
end
2008-09-07 21:54:22 +02:00
2010-06-16 21:04:53 +02:00
@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!
## Development
2010-06-16 21:04:53 +02:00
### Preparations
2010-06-16 12:40:00 +02:00
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:
2011-04-21 17:29:13 +02:00
bundle install
2008-09-07 21:54:22 +02:00
That should set everything up for `rake spec` to be run correctly. Update the couchrest_model.gemspec if your alterations
use different gems.
2010-01-14 02:16:16 +01:00
### Testing
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`.
2010-01-14 01:56:21 +01:00
We will not accept pull requests to the project without sufficient tests.
2010-06-11 02:02:22 +02:00
2010-01-14 02:16:16 +01:00
## Contact
2010-01-14 01:56:21 +01:00
2010-07-29 02:40:19 +02:00
Please post bugs, suggestions and patches to the bug tracker at [http://github.com/couchrest/couchrest_model/issues](http://github.com/couchrest/couchrest_model/issues).
2010-01-14 01:56:21 +01:00
2010-03-31 02:38:26 +02:00
Follow us on Twitter: [http://twitter.com/couchrest](http://twitter.com/couchrest)
2010-01-14 01:56:21 +01:00
2010-03-31 02:38:26 +02:00
Also, check [http://twitter.com/#search?q=%23couchrest](http://twitter.com/#search?q=%23couchrest)
2009-07-17 20:07:23 +02:00