StaticAssociation
Adds basic ActiveRecord-like associations to static data.
Installation
Add this line to your application's Gemfile:
gem "static_association"
And then execute:
$ bundle
Or install it yourself as:
$ gem install static_association
Usage
Static Models
Create your static association class:
class Day
include StaticAssociation
attr_accessor :name
record id: 0 do |day|
day.name = :monday
end
end
Calling record
will allow you to create an instance of this static model,
a unique id is mandatory. The newly created object is yielded to the passed
block.
The Day
class will gain .all
, .find
, .find_by_id
, and .where
methods.
- The
.all
method returns all the static records defined in the class. - The
.find
method accepts a single id and returns the matching record. If the record does not exist, aRecordNotFound
error is raised. - The
.find_by_id
method behaves similarly to the.find
method, except it returnsnil
when a record does not exist. - The
.where
method accepts an array of ids and returns all records with matching ids.
Associations
Currently just a 'belongs to' association can be created. This behaviour can be
mixed into an ActiveRecord
model:
class Event < ActiveRecord::Base
extend StaticAssociation::AssociationHelpers
belongs_to_static :day
end
This assumes your model has a field day_id
.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Run lint checks and tests (
bundle exec rake
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request