Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anjlab/triggerable
Trigger/automation engine for ActiveRecord models
https://github.com/anjlab/triggerable
rails ruby schedule
Last synced: about 1 month ago
JSON representation
Trigger/automation engine for ActiveRecord models
- Host: GitHub
- URL: https://github.com/anjlab/triggerable
- Owner: anjlab
- License: mit
- Created: 2014-09-21T17:50:15.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-04-13T09:38:23.000Z (almost 7 years ago)
- Last Synced: 2024-04-26T12:22:23.362Z (9 months ago)
- Topics: rails, ruby, schedule
- Language: Ruby
- Size: 70.3 KB
- Stars: 17
- Watchers: 7
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Triggerable
[](https://codeclimate.com/github/anjlab/triggerable)
Triggerable is a powerful engine for adding a conditional behaviour for ActiveRecord models. This logic can be defined in two ways - as triggers and automations. Triggers are called right after model creating, updating or saving, and automations are run on schedule (e.g. 2 hours after update).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'triggerable'
```
And then execute:
```shell
bundle
```
## Usage
Setup and defining trigger and automation:
```ruby
class User < ActiveRecord::Base
trigger on: :after_create, if: { receives_sms: true } do
user.send_welcome_sms
end
automation if: { created_at: { after: 24.hours }, confirmed: false } do
send_confirmation_email
end
end
```
Combining different conditions and predicates:
```ruby
trigger on: :after_create, if: { field: { is: 1 } }, ...
# short form
trigger on: :after_create, if: { field: 1 }, ...
trigger on: :after_create, if: { field: { is_not: 1 } }, ...
trigger on: :after_create, if: { field: { in: [1, 2, 3] } }, ...
# short form
trigger on: :after_create, if: { field: [1, 2, 3] }, ...
trigger on: :after_create, if: { field: { greater_than: 1 } }, ...
trigger on: :after_create, if: { field: { less_than: 1 } }, ...
trigger on: :after_create, if: { field: { exists: true } }, ...
trigger on: :after_create, if: { and: [{ field1: '1' }, { field2: 1 }] }, ...
trigger on: :after_create, if: { or: [{ field1: '1' }, { field2: 1 }] }, ...
```
Triggerable does not run automations by itself, you should call `Triggerable::Engine.run_automations(interval)` using any scheduling script. Interval is a time difference between calling the method (e.g. `1.hour`). *You should avoid situations when your interval is less then the time your automations need to complete!*
Automation calls action block for each found object, but it's possible to pass a relation to action block using `pass_relation` option:
```ruby
class User < ActiveRecord::Base
automation if: {
created_at: { after: 24.hours }, confirmed: false
}, pass_relation: true do
each(&:send_confirmation_email)
end
end
```
If you have more complex condition or need to check associations (not supported in DSL now), you should use a lambda condition form:
```ruby
trigger on: :after_update, if: -> { orders.any? } do
# ...
end
```
If you need to share logic between triggers/automations bodies you can move it into separate class. It should be inherited from `Triggerable::Actions::Action` and implement a single method `run_for!(object, rule_name)` where trigger_name is a string passed to rule in :name option and obj is a triggered object. Then you can pass a name of your action class instead of do block.
```ruby
class SendWelcomeSms < Triggerable::Actions::Action
def run_for! object, trigger_name
SmsGateway.send_to object.phone, welcome_text
end
end
class User
trigger on: :after_create, if: { receives_sms: true }, do: :send_welcome_sms
end
```
## Logging and debugging
You can easily turn on logging and debugging (using `puts`):
```ruby
Triggerable::Engine.logger = Logger.new(File.join(Rails.root, 'log', 'triggers.log'))
Triggerable::Engine.debug = true
```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request