Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waterlink/aop
Very thin AOP gem for Ruby
https://github.com/waterlink/aop
Last synced: 3 months ago
JSON representation
Very thin AOP gem for Ruby
- Host: GitHub
- URL: https://github.com/waterlink/aop
- Owner: waterlink
- License: mit
- Created: 2015-01-21T23:56:07.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-05-22T16:28:35.000Z (over 9 years ago)
- Last Synced: 2024-04-23T23:55:37.228Z (8 months ago)
- Language: Ruby
- Size: 309 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Aop
[](https://travis-ci.org/waterlink/aop)
Very thin AOP gem for Ruby.
Thin and fast framework for Aspect Oriented Programming in Ruby.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'aop'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install aop
## Usage
### Before advice
```ruby
module Authentication
Aop["BankAccount#transfer:before"].advice do |account, *args, &blk|
can!(:transfer, account)
end
def self.can!(action, subject)
# raises error if current user can't execute `action` on `subject`
end
end
```
### After advice
```ruby
module Analytics
Aop["User#sign_in:after"].advice do |target, *args, &blk|
report("sign_in", user.id)
end
end
```
### Around advice
```ruby
module Transactional
Aop["BankAccount#transfer:around"].advice do |joint_point, account, *args, &blk|
start_transaction
joint_point.call
finish_transaction
end
end
```
### Class methods
Use `.method` notation:
```ruby
module Transactional
Aop["BankAccount.transfer:around"].advice do |joint_point, klass, *args, &blk|
start_transaction
joint_point.call
finish_transaction
end
end
```
### Multiple classes, methods and advices
Use `,` to use multiple classes, methods and advices:
```ruby
module Analytics
Aop["User,Admin#sign_in,.sign_up,#sign_out:before,:after"].advice do |target, *args, &blk|
report("auth_action", user.id)
end
end
```
### Handling missed pointcuts
When pointcut is gone, for example when method or class gets renamed, it is a potential bug, because some code will not be run. This library tackles this problem by failing hard when pointcut can not be found.
Example:
```ruby
Aop["Admin#sign_in:after"].advice do |target, *args, &blk|
# .. do something ..
end
```
Then somebody renames `Admin#sign_in` to `Admin#logout`, and when you run the code you will get:
```
Aop::PointcutNotFound: Unable to find pointcut Admin#sign_in
Reason: #
.. backtrace ..
```
## Contributing
1. Fork it ( https://github.com/waterlink/aop/fork )
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 a new Pull Request