https://github.com/chief/acts_as_defaultable
A gem allowing an active_record model to be default(unique) based on a specified column
https://github.com/chief/acts_as_defaultable
Last synced: about 1 year ago
JSON representation
A gem allowing an active_record model to be default(unique) based on a specified column
- Host: GitHub
- URL: https://github.com/chief/acts_as_defaultable
- Owner: chief
- Created: 2012-01-04T15:14:15.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2015-05-23T08:42:01.000Z (about 11 years ago)
- Last Synced: 2024-10-30T15:13:29.630Z (over 1 year ago)
- Language: Ruby
- Homepage:
- Size: 196 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ActsAsDefaultable
[](https://travis-ci.org/chief/acts_as_defaultable)
[](https://codeclimate.com/github/chief/acts_as_defaultable)
[](http://badge.fury.io/rb/acts_as_defaultable)
[](https://gemnasium.com/chief/acts_as_defaultable)
## Description
This ``acts_as`` extension provides the capability for having a default object.
The class that has this specified needs to have a default column defined as an integer,
string or boolean on the mapped database table.
There is also optional support for each record to have a default object of another model.
## Install
In your Gemfile
```ruby
gem 'acts_as_defaultable'
```
Currently is tested on rails3.2, ruby 1.9.3 and mysql
## Example
### Default object
```ruby
class Country < ActiveRecord::Base
acts_as_defaultable :default
end
gr = Country.new
gr.default = true
gr.save
Country.default == gr # => true
uk = Country.new
uk.default = true
uk.save
Country.default == gr # => false
```
If no options provided `default` column is assumed.
### Default object for each record
```ruby
class User < ActiveRecord::Base
acts_as_defaultable :default, relation: :post
end
class Post < ActiveRecord::Base
after_destroy User.new
end
class Comment < ActiveRecord::Base
end
user = User.new
post = Post.create
user.default_post = post
user.save
user.default_post == post # => true
post.destroy
user.reload
user.default_post == nil # => true
user.default_post = Comment.create
user.default_post == nil # => true
```
Only an object of the relation class will be accepted.
The `after_destroy` callback is optional but will ensure that results stay consistent in the event
that a newly created **post** gets the same id as the one destroyed
## Notes
The option to acts_as_defaultable is the `column` of the Model that defines default
behaviour. This column can be a string, a boolean or an integer with default
positive values 'on', true, 1 and default negative values 'off', false, 0 respectively.
The column name for a default relation is `default_column` _ `relation_column` and can be either a string or an integer.
Examples:
```
class User < ActiveRecord::Base
acts_as_defaultable :default, relation: :post
end
```
Column name in users table must be `default_post`
```
class User < ActiveRecord::Base
acts_as_defaultable :unique, relation: :post
end
```
Column name must be `unique_post`
## License
acts_as_defaultable is released under the [MIT License](http://opensource.org/licenses/MIT)