lafourmi-immo
/
rating
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: update

main
Washington Botelho 2018-01-16 01:14:09 -02:00
parent 63f2cb9320
commit acfae75b60
No known key found for this signature in database
GPG Key ID: BECE10A8106CC7A0
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -66,7 +66,7 @@ rake db:migrate
Just add the callback `rating` to your model: Just add the callback `rating` to your model:
```ruby ```ruby
class User < ApplicationRecord class Author < ApplicationRecord
rating rating
end end
``` ```
@ -78,7 +78,7 @@ Now this model can vote or receive votes.
You can vote on some resource: You can vote on some resource:
```ruby ```ruby
author = User.last author = Author.last
resource = Article.last resource = Article.last
author.rate(resource, 3) author.rate(resource, 3)
@ -109,7 +109,7 @@ It will return a `Rating` object that keeps:
You can retrieve the rate of some author gave to some resource: You can retrieve the rate of some author gave to some resource:
```ruby ```ruby
author = User.last author = Author.last
resource = Article.last resource = Article.last
author.rate_for resource author.rate_for resource
@ -128,7 +128,7 @@ It will return a `Rate` object that keeps:
Maybe you want just to know if some author already rated some resource and receive `true` or `false`: Maybe you want just to know if some author already rated some resource and receive `true` or `false`:
```ruby ```ruby
author = User.last author = Author.last
resource = Article.last resource = Article.last
author.rated? resource author.rated? resource
@ -151,7 +151,7 @@ It will return a collection of `Rate` object.
In the same way you can retrieve all rates that some author received: In the same way you can retrieve all rates that some author received:
```ruby ```ruby
author = User.last author = Author.last
author.rated author.rated
``` ```
@ -183,7 +183,7 @@ Let's say an article belongs to one or more categories and you want to vote on s
```ruby ```ruby
category_1 = Category.first category_1 = Category.first
category_2 = Category.second category_2 = Category.second
author = User.last author = Author.last
resource = Article.last resource = Article.last
``` ```
@ -196,24 +196,24 @@ author.rate resource, 3, scopeable: category_1
author.rate resource, 5, scopeable: category_2 author.rate resource, 5, scopeable: category_2
``` ```
Now `article` has a rating for `category_1` and another one for `category_2`. Now `resource` has a rating for `category_1` and another one for `category_2`.
**rating** **rating**
Recovering the rating values for article, we have: Recovering the rating values for resource, we have:
```ruby ```ruby
author.rating resource.rating
# nil # nil
``` ```
But using the scope to make the right query: But using the scope to make the right query:
```ruby ```ruby
author.rating scope: category_1 resource.rating scope: category_1
# { average: 3, estimate: 3, sum: 3, total: 1 } # { average: 3, estimate: 3, sum: 3, total: 1 }
author.rating scope: category_2 resource.rating scope: category_2
# { average: 5, estimate: 5, sum: 5, total: 1 } # { average: 5, estimate: 5, sum: 5, total: 1 }
``` ```
@ -222,7 +222,7 @@ author.rating scope: category_2
On the same way you can find your rates with a scoped query: On the same way you can find your rates with a scoped query:
```ruby ```ruby
user.rated scope: category_1 author.rated scope: category_1
# { value: 3, scopeable: category_1 } # { value: 3, scopeable: category_1 }
``` ```
@ -253,7 +253,7 @@ Maybe you want to recover all records with or without scope, so you can add the
```ruby ```ruby
category_1 = Category.first category_1 = Category.first
category_2 = Category.second category_2 = Category.second
author = User.last author = Author.last
resource = Article.last resource = Article.last
author.rate resource, 1 author.rate resource, 1
@ -265,7 +265,7 @@ author.rating_records
# { average: 3, estimate: 3, scopeable: category_1, sum: 3, total: 1 }, # { average: 3, estimate: 3, scopeable: category_1, sum: 3, total: 1 },
# { average: 5, estimate: 5, scopeable: category_2, sum: 5, total: 1 } # { average: 5, estimate: 5, scopeable: category_2, sum: 5, total: 1 }
user.rated_records author.rated_records
# { value: 1 }, { value: 3, scopeable: category_1 }, { value: 5, scopeable: category_2 } # { value: 1 }, { value: 3, scopeable: category_1 }, { value: 5, scopeable: category_2 }
article.rates_records article.rates_records
@ -275,7 +275,7 @@ article.rates_records
### As ### As
If you have a model that will only be able to rate but not to receive a rate, configure it as `author`. If you have a model that will only be able to rate but not to receive a rate, configure it as `author`.
An author model still can be rated, but won't genarate a Rating record with all values as zero to be easier to display. An author model still can be rated, but won't genarate a Rating record with all values as zero to warm up the cache.
```ruby ```ruby
rating as: :author rating as: :author