README.md in action_callback-0.2.1 vs README.md in action_callback-0.3.0
- old
+ new
@@ -1,5 +1,8 @@
+[](https://badge.fury.io/rb/action_callback)
+[](https://hakiri.io/github/EdmundLeex/action_callback/master)
+[](https://codeclimate.com/github/EdmundLeex/action_callback)
[](https://travis-ci.org/EdmundLeex/action_callback)
# CallbackAction
This gem gives you ability to add callbacks like `before_action` / `before_fitler` etc to your Active Record models and plain ruby classes.
@@ -18,10 +21,89 @@
Or install it yourself as:
$ gem install callback_action
+## Preliminary
+
+- Ruby >= 2.1.0
+- Rails >= 4.2.6
+
## Usage
+
+### 1. `validate`
+
+#### In Rails
+
+This gem adds a `before` option to the `validate` method.
+Use it on any of your model's method. Simply add custom validation method just
+like you usually do.
+
+- It runs the method if validation is good
+- Otherwise, it returns false (if there is any error)
+
+```ruby
+class Car < ActiveRecord::Base
+ validate :key_present, before: [:unlock_door]
+
+ def unlock_door
+ # unlock the door
+ end
+
+ private
+
+ def key_present
+ unless has_key? && valid_key?
+ errors.add(:base, 'need the right key')
+ end
+ end
+end
+
+car = Car.new
+car.unlock_door
+# If has_key?
+# - do whatever the method does
+# - return whatever it returns
+# If !has_key?
+# - returns false
+# - car.errors.full_messages => ['need the right key']
+```
+
+At the same time, it preserves the default `validate` logic if `before` option is
+not used.
+
+```ruby
+class Car < ActiveRecord::Base
+ validate :valid_vin_number
+end
+```
+
+#### In Plain Ruby
+
+This gem adds a `validate` method to classes that extend this module. You should
+raise error in the validator method
+
+- It execute the method if validation passes.
+- It raises the error you specify in the validator method, and stop there.
+
+```ruby
+class Car
+ extend ActionCallback
+ validate :key_present, before: [:unlock_door]
+
+ def unlock_door
+ # unlock the door
+ end
+
+ private
+
+ def key_present
+ fail 'key invalid' unless valid_key?
+ end
+end
+```
+
+### 2. `before_action` / `after_action`
If you are using Rails, in your Active Record models:
```ruby
class Foobar < ActiveRecord::Base