Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gdwrd/faat
It's Faat! Gem that will kill your fat model.
https://github.com/gdwrd/faat
Last synced: about 2 months ago
JSON representation
It's Faat! Gem that will kill your fat model.
- Host: GitHub
- URL: https://github.com/gdwrd/faat
- Owner: gdwrd
- License: mit
- Created: 2015-12-24T15:02:11.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-03-09T11:57:12.000Z (over 8 years ago)
- Last Synced: 2024-05-17T11:02:44.625Z (4 months ago)
- Language: Ruby
- Homepage:
- Size: 41 KB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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
Add this line to your application's Gemfile:
```ruby
gem 'faat'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install faat
## Usage
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_service = PostService.new(@post)
@post_form = PostForm.new(post_form_params)
```
###Usage:
```ruby
@post_service.destroy => destroy @post
@post_service.update => update @post
PostService.last => Post.last
PostService.all => Post.all
PostService.where(title: "First Test Title") => Post.where(...)
```
###Examples:
In ```post_services.rb```
```ruby
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_service = PostService.new(@post_form) => create @author and @post
end
end
```
Some other usage:
```ruby
@post_form = PostForm.new(post_form_params)
@post_form.valid? # or invalid?
@post_form.text => some value
@post_form.author_email => [email protected]
@ost_form.author_name => John Smith
```
## TODO
Add spec/test auto generator
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/xo8bit/faat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).