README.md in faat-0.1.5 vs README.md in faat-0.1.6
- old
+ new
@@ -1,8 +1,8 @@
# Faat
-[](https://gitter.im/xo8bit/faat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://badge.fury.io/rb/faat) [](https://codeclimate.com/repos/5683d90ecbc0bf2f17002347/feed) [](https://codeclimate.com/repos/5683d90ecbc0bf2f17002347/coverage) [](https://travis-ci.org/xo8bit/faat)
+[](https://gitter.im/xo8bit/faat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://badge.fury.io/rb/faat) [](https://codeclimate.com/repos/5683d90ecbc0bf2f17002347/feed) [](https://codeclimate.com/repos/5683d90ecbc0bf2f17002347/coverage) [](https://travis-ci.org/xo8bit/faat)
Welcome to `faat` gem!
## Installation
@@ -20,59 +20,58 @@
$ gem install faat
## Usage
-Run ```rails generate faat:resources {model_name}```,
-generator will create folder ```resource``` in ```app``` directory, and file ```{model_name}_resource.rb```
+Run ```rails generate faat:services {service_name}```,
+generator will create folder ```services``` in ```app``` directory, and file ```{service_name}_service.rb```
Run ```rails generate faat:forms {form_name} {attribute_name}:{attribute_type}```,
generator will create folder ```forms``` in ```app``` directory, and file ```{form_name}_form.rb```
###Initialize:
```ruby
@post = Post.new
-@post_resource = PostResource.new(@post)
+@post_service = PostService.new(@post)
@post_form = PostForm.new(post_form_params)
```
###Usage:
```ruby
-@post_resource.destroy => destroy @post
-@post_resource.update => update @post
+@post_service.destroy => destroy @post
+@post_service.update => update @post
-PostResource.last => Post.last
-PostResource.all => Post.all
-PostResource.where(title: "First Test Title") => Post.where(...)
+PostService.last => Post.last
+PostService.all => Post.all
+PostService.where(title: "First Test Title") => Post.where(...)
```
###Examples:
-
-In ```post_resource.rb```
+In ```post_services.rb```
```ruby
-class PostResource < Faat::Resources::Base
+class PostService < Faat::Services::Base
...
-
+
def initialize(post_form)
@author = Author.create!(name: post_form.author_name, email: post_form.author_email)
@post = Post.create!(text: post_form.text, title: post_form.title)
send_confirmation_email(@author)
end
-
+
...
end
```
In```post_controller.rb```
```ruby
...
def create
@post_form = PostForm.new(post_form_params)
if @post_form.valid?
- @post_resource = PostResource.new(@post_form) => create @author and @post
+ @post_service = PostService.new(@post_form) => create @author and @post
end
end
```
Some other usage:
@@ -94,6 +93,5 @@
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-