Add social capabilities to your models.
- Ruby >= 2.1
- Mongoid >= 4.0
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install mongoid_followit
Take as an example the following model:
class Person include ::Document field :name, type: String end
When including the module
The model starts working like this:
=> jedi = Profile.create(name: 'Jedi') => padawan = Profile.create(name: '') => person = Person.create(name: 'Obi Wan') => person.follow(jedi, padawan) => person.unfollow(padawan) => person.followees
The model to be followed MUST include the
class Profile include ::Document include :::: field :name, type: String end
And the followee model starts working like this:
Every model that includes
Mongoid::Followit::Follower can define callbacks for the #follow and #unfollow methods:
class MyModel include ::Document include :::: before_follow :do_something_before before_unfollow :do_otherthing_before after_follow :do_something_after after_unfollow :do_otherthing_after end
Add more queryable methods.
After checking out the repo, run
bin/setup to install dependencies. Then, run
rake spec to run the tests. You can also run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at this repository. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.