rating 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7eb5b802982259c2ec3101c38bbfe18302226f2
-  data.tar.gz: cce443ffafbf9887de9d9261fa5e0223ad190b47
+  metadata.gz: 7828759c72eb95c9dc6562c8c56b2b42c2b266e6
+  data.tar.gz: ad5a258d49d2bbf05f0d2fbc54800e590850d5a9
 SHA512:
-  metadata.gz: a29fc4b2a26a3f8cd40d3d97ad2d1691a3bd5cbd70a5bd436c9f57b5dbbb11470185a602394f6629989dda254f68aa0ff01ce4ca22c59291a1f83f81ad36cb11
-  data.tar.gz: f79ec758ff607f735e9452b45705c52eacc6df4898cc4c8826a90fa6fe7cdf86fa0cde79c67321540aa262328afede7167f471e694b7df6744e944bbc52a41ae
+  metadata.gz: 880d5a7fe68b86e91d9b7eaf1c3f3ab3b7ef40eac8db2942daa8a7beca89e5887abbf92fbdc05b5bc751dd9ea292362bb5513c6adb43f74391a832027e5e15e4
+  data.tar.gz: 94e6666f1174c77da6cd9db33fd2415aa4af621813689da0ff7c1f082c55b39015d2538add63cff10b4972a4a5797859f1b3c42d061d4611b1b14106d6b703fb

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.3.0
+
+### News
+
+- The `vote` method now can receive `metadata` to be persisted with vote data.
+
 ## v0.2.0
 
 ### News

data/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://travis-ci.org/wbotelhos/rating.svg)](https://travis-ci.org/wbotelhos/rating)
 [![Gem Version](https://badge.fury.io/rb/rating.svg)](https://badge.fury.io/rb/rating)
+[![Maintainability](https://api.codeclimate.com/v1/badges/cc5efe8b06bc1d5e9e8a/maintainability)](https://codeclimate.com/github/wbotelhos/rating/maintainability)
+[![Support](https://img.shields.io/badge/donate-%3C3-brightgreen.svg)](https://liberapay.com/wbotelhos)
 
 A true Bayesian rating system with scope and cache enabled.
 
@@ -66,7 +68,7 @@ rake db:migrate
 Just add the callback `rating` to your model:
 
 ```ruby
-class User < ApplicationRecord
+class Author < ApplicationRecord
   rating
 end
 ```
@@ -78,10 +80,10 @@ Now this model can vote or receive votes.
 You can vote on some resource:
 
 ```ruby
-author   = User.last
+author   = Author.last
 resource = Article.last
 
-author.rate(resource, 3)
+author.rate resource, 3
 ```
 
 ### rating
@@ -109,7 +111,7 @@ It will return a `Rating` object that keeps:
 You can retrieve the rate of some author gave to some resource:
 
 ```ruby
-author   = User.last
+author   = Author.last
 resource = Article.last
 
 author.rate_for resource
@@ -128,7 +130,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`:
 
 ```ruby
-author   = User.last
+author   = Author.last
 resource = Article.last
 
 author.rated? resource
@@ -136,12 +138,12 @@ author.rated? resource
 
 ### rates
 
-You can retrieve all rates made by some author:
+You can retrieve all rates received by some resource:
 
 ```ruby
-author = User.last
+resource = Article.last
 
-author.rates
+resource.rates
 ```
 
 It will return a collection of `Rate` object.
@@ -151,7 +153,7 @@ It will return a collection of `Rate` object.
 In the same way you can retrieve all rates that some author received:
 
 ```ruby
-author = User.last
+author = Author.last
 
 author.rated
 ```
@@ -183,7 +185,7 @@ Let's say an article belongs to one or more categories and you want to vote on s
 ```ruby
 category_1 = Category.first
 category_2 = Category.second
-author     = User.last
+author     = Author.last
 resource   = Article.last
 ```
 
@@ -192,28 +194,28 @@ In this situation you should scope the vote of article with some category:
 **rate**
 
 ```ruby
-author.rate resource, 3, scopeable: category_1
-author.rate resource, 5, scopeable: category_2
+author.rate resource, 3, scope: category_1
+author.rate resource, 5, scope: 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**
 
-Recovering the rating values for article, we have:
+Recovering the rating values for resource, we have:
 
 ```ruby
-author.rating
+resource.rating
 # nil
 ```
 
 But using the scope to make the right query:
 
 ```ruby
-author.rating scope: category_1
+resource.rating scope: category_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 }
 ```
 
@@ -222,7 +224,7 @@ author.rating scope: category_2
 On the same way you can find your rates with a scoped query:
 
 ```ruby
-user.rated scope: category_1
+author.rated scope: category_1
 # { value: 3, scopeable: category_1 }
 ```
 
@@ -253,19 +255,19 @@ Maybe you want to recover all records with or without scope, so you can add the
 ```ruby
 category_1 = Category.first
 category_2 = Category.second
-author     = User.last
+author     = Author.last
 resource   = Article.last
 
 author.rate resource, 1
-author.rate resource, 3, scopeable: category_1
-author.rate resource, 5, scopeable: category_2
+author.rate resource, 3, scope: category_1
+author.rate resource, 5, scope: category_2
 
 author.rating_records
 # { average: 1, estimate: 1, scopeable: nil       , sum: 1, total: 1 },
 # { average: 3, estimate: 3, scopeable: category_1, sum: 3, 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 }
 
 article.rates_records
@@ -275,12 +277,50 @@ article.rates_records
 ### As
 
 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
 rating as: :author
 ```
 
+### Metadata
+
+Maybe you want include a `comment` together your rating or even a `fingerprint` field to make your rating more secure.
+So, first you will need to add more fields to the `Rating::Rate` table:
+
+```ruby
+class AddCommentAndFingerprintOnRatingRates < ActiveRecord::Migration
+  def change
+    add_column :rating_rates, :comment, :text
+
+    add_reference :rating_rates, :fingerprint, foreign_key: true, index: true, null: false
+  end
+end
+```
+
+As you can seed, we can add any kind of field we want. Now we just provide this values when we make the rate:
+
+```ruby
+author      = Author.last
+resource    = Article.last
+comment     = 'This is a very nice rating. s2'
+fingerprint = Fingerprint.new(ip: '127.0.0.1')
+
+author.rate resource, 3, metadata: { comment: comment, fingerprint: fingerprint }
+```
+
+Now you can have this data into your model normally:
+
+
+```ruby
+author = Author.last
+rate   = author.rates.last
+
+rate.comment     # 'This is a very nice rating. s2'
+rate.fingerprint # <Fingerprint id:...>
+rate.value       # 3
+```
+
 ## Love it!
 
-Via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=X8HEP2878NDEG&item_name=rating) or [Gratipay](https://gratipay.com/rating). Thanks! (:
+Via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=X8HEP2878NDEG&item_name=rating) or [Support](https://liberapay.com/wbotelhos). Thanks! (:

data/lib/generators/rating/templates/db/migrate/create_rating_tables.rb

@@ -5,9 +5,9 @@ class CreateRatingTables < ActiveRecord::Migration[5.0]
     create_table :rating_rates do |t|
       t.decimal :value, default: 0, precision: 17, scale: 14
 
-      t.references :author   , index: true, null: false, polymorphic: true
-      t.references :resource , index: true, null: false, polymorphic: true
-      t.references :scopeable, index: true, null: true , polymorphic: true
+      t.references :author,    index: true, null: false, polymorphic: true
+      t.references :resource,  index: true, null: false, polymorphic: true
+      t.references :scopeable, index: true, null: true, polymorphic: true
 
       t.timestamps null: false
     end
@@ -17,13 +17,13 @@ class CreateRatingTables < ActiveRecord::Migration[5.0]
       unique: true
 
     create_table :rating_ratings do |t|
-      t.decimal :average , default: 0, mull: false, precision: 17, scale: 14
+      t.decimal :average,  default: 0, mull: false, precision: 17, scale: 14
       t.decimal :estimate, default: 0, mull: false, precision: 17, scale: 14
-      t.integer :sum     , default: 0, mull: false
-      t.integer :total   , default: 0, mull: false
+      t.integer :sum,      default: 0, mull: false
+      t.integer :total,    default: 0, mull: false
 
-      t.references :resource , index: true, null: false, polymorphic: true
-      t.references :scopeable, index: true, null: true , polymorphic: true
+      t.references :resource,  index: true, null: false, polymorphic: true
+      t.references :scopeable, index: true, null: true,  polymorphic: true
 
       t.timestamps null: false
     end

data/lib/rating/models/rating/extension.rb

@@ -5,8 +5,8 @@ module Rating
     extend ActiveSupport::Concern
 
     included do
-      def rate(resource, value, author: self, scope: nil)
-        Rate.create author: author, resource: resource, scopeable: scope, value: value
+      def rate(resource, value, author: self, metadata: {}, scope: nil)
+        Rate.create author: author, metadata: metadata, resource: resource, scopeable: scope, value: value
       end
 
       def rate_for(resource, scope: nil)

data/lib/rating/models/rating/rate.rb

@@ -6,8 +6,8 @@ module Rating
 
     after_save :update_rating
 
-    belongs_to :author   , polymorphic: true
-    belongs_to :resource , polymorphic: true
+    belongs_to :author,    polymorphic: true
+    belongs_to :resource,  polymorphic: true
     belongs_to :scopeable, polymorphic: true
 
     validates :author, :resource, :value, presence: true
@@ -18,11 +18,13 @@ module Rating
       scope:          %i[author_type resource_id resource_type scopeable_id scopeable_type]
     }
 
-    def self.create(author:, resource:, scopeable: nil, value:)
+    def self.create(author:, metadata:, resource:, scopeable: nil, value:)
       record = find_or_initialize_by(author: author, resource: resource, scopeable: scopeable)
 
       return record if record.persisted? && value == record.value
 
+      metadata.each { |k, v| record[k] = v } if metadata.present?
+
       record.value = value
       record.save
 

data/lib/rating/models/rating/rating.rb

@@ -4,16 +4,21 @@ module Rating
   class Rating < ActiveRecord::Base
     self.table_name = 'rating_ratings'
 
-    belongs_to :resource , polymorphic: true
+    belongs_to :resource,  polymorphic: true
     belongs_to :scopeable, polymorphic: true
 
     validates :average, :estimate, :resource, :sum, :total, presence: true
     validates :average, :estimate, :sum, :total, numericality: true
 
+    validates :resource_id, uniqueness: {
+      case_sensitive: false,
+      scope:          %i[resource_type scopeable_id scopeable_type]
+    }
+
     class << self
       def averager_data(resource, scopeable)
         total_count    = how_many_resource_received_votes_sql?(distinct: false, scopeable: scopeable)
-        distinct_count = how_many_resource_received_votes_sql?(distinct: true , scopeable: scopeable)
+        distinct_count = how_many_resource_received_votes_sql?(distinct: true, scopeable: scopeable)
         values         = { resource_type: resource.class.base_class.name }
 
         values[:scopeable_type] = scopeable.class.base_class.name unless scopeable.nil?
@@ -23,7 +28,7 @@ module Rating
             (#{total_count} / CAST(#{distinct_count} AS float)) count_avg,
             COALESCE(AVG(value), 0)                             rating_avg
           FROM #{rate_table_name}
-          WHERE resource_type = :resource_type and #{scope_type_query(scopeable)}
+          WHERE resource_type = :resource_type AND #{scope_type_query(scopeable)}
         ).squish
 
         execute_sql [sql, values]
@@ -43,9 +48,9 @@ module Rating
 
       def values_data(resource, scopeable)
         scope_query = if scopeable.nil?
-                        'scopeable_type is NULL and scopeable_id is NULL'
+                        'scopeable_type is NULL AND scopeable_id is NULL'
                       else
-                        'scopeable_type = ? and scopeable_id = ?'
+                        'scopeable_type = ? AND scopeable_id = ?'
                       end
 
         sql = %(
@@ -54,10 +59,10 @@ module Rating
             COALESCE(SUM(value), 0) rating_sum,
             COUNT(1)                rating_count
           FROM #{rate_table_name}
-          WHERE resource_type = ? and resource_id = ? and #{scope_query}
+          WHERE resource_type = ? AND resource_id = ? AND #{scope_query}
         ).squish
 
-        values = [sql, resource.class.base_class.name, resource.id]
+        values =  [sql, resource.class.base_class.name, resource.id]
         values += [scopeable.class.base_class.name, scopeable.id] unless scopeable.nil?
 
         execute_sql values
@@ -97,7 +102,7 @@ module Rating
         %((
           SELECT #{count}
           FROM #{rate_table_name}
-          WHERE resource_type = :resource_type and #{scope_type_query(scopeable)}
+          WHERE resource_type = :resource_type AND #{scope_type_query(scopeable)}
         ))
       end
 

data/lib/rating/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rating
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/factories/rating/rate.rb

@@ -4,7 +4,7 @@ FactoryBot.define do
   factory :rating_rate, class: Rating::Rate do
     value 100
 
-    author   { create :user }
+    author   { create :author }
     resource { create :article }
   end
 end

data/spec/factories/rating/rating.rb

@@ -7,6 +7,6 @@ FactoryBot.define do
     sum      100
     total    1
 
-    resource { create :article }
+    association :resource, factory: :article, strategy: :build
   end
 end

data/spec/models/extension/after_create_spec.rb

@@ -3,22 +3,22 @@
 require 'rails_helper'
 
 RSpec.describe Rating::Extension, ':after_create' do
-  context 'with :as as nil' do
-    let!(:user) { create :user }
+  context 'when :as is nil' do
+    let!(:article) { create :article }
 
     it 'creates a rating record with zero values just to be easy to make the count' do
-      rating = Rating::Rating.find_by(resource: user)
+      rating = Rating::Rating.find_by(resource: article)
 
       expect(rating.average).to   eq 0
       expect(rating.estimate).to  eq 0
-      expect(rating.resource).to  eq user
+      expect(rating.resource).to  eq article
       expect(rating.scopeable).to eq nil
       expect(rating.sum).to       eq 0
       expect(rating.total).to     eq 0
     end
   end
 
-  context 'with :as as :author' do
+  context 'when :as is :author' do
     let!(:author) { create :author }
 
     it 'does not creates a rating record' do

data/spec/models/extension/order_by_rating_spec.rb

@@ -1,26 +1,10 @@
 # frozen_string_literal: true
 
 require 'rails_helper'
+require 'support/shared_context/with_database_records'
 
 RSpec.describe Rating::Extension, ':order_by_rating' do
-  let!(:category) { create :category }
-
-  let!(:user_1) { create :user }
-  let!(:user_2) { create :user }
-
-  let!(:article_1) { create :article }
-  let!(:article_2) { create :article }
-  let!(:article_3) { create :article }
-
-  before do
-    create :rating_rate, author: user_1, resource: article_1, value: 100
-    create :rating_rate, author: user_1, resource: article_2, value: 11
-    create :rating_rate, author: user_1, resource: article_3, value: 10
-    create :rating_rate, author: user_2, resource: article_1, value: 1
-
-    create :rating_rate, author: user_1, resource: article_1, scopeable: category, value: 1
-    create :rating_rate, author: user_2, resource: article_1, scopeable: category, value: 2
-  end
+  include_context 'with_database_records'
 
   context 'with default filters' do
     it 'sorts by :estimate :desc' do
@@ -32,8 +16,8 @@ RSpec.describe Rating::Extension, ':order_by_rating' do
     end
   end
 
-  context 'filtering by :average' do
-    context 'as asc' do
+  context 'when filtering by :average' do
+    context 'with as asc' do
       it 'works' do
         expect(Article.order_by_rating(:average, :asc)).to eq [
           article_3,
@@ -51,7 +35,7 @@ RSpec.describe Rating::Extension, ':order_by_rating' do
       end
     end
 
-    context 'as desc' do
+    context 'with as desc' do
       it 'works' do
         expect(Article.order_by_rating(:average, :desc)).to eq [
           article_1,
@@ -70,8 +54,8 @@ RSpec.describe Rating::Extension, ':order_by_rating' do
     end
   end
 
-  context 'filtering by :estimate' do
-    context 'as asc' do
+  context 'when filtering by :estimate' do
+    context 'with as asc' do
       it 'works' do
         expect(Article.order_by_rating(:estimate, :asc)).to eq [
           article_3,
@@ -89,7 +73,7 @@ RSpec.describe Rating::Extension, ':order_by_rating' do
       end
     end
 
-    context 'as desc' do
+    context 'with as desc' do
       it 'works' do
         expect(Article.order_by_rating(:estimate, :desc)).to eq [
           article_1,
@@ -108,7 +92,7 @@ RSpec.describe Rating::Extension, ':order_by_rating' do
     end
   end
 
-  context 'filtering by :sum' do
+  context 'when filtering by :sum' do
     context 'as asc' do
       it 'works' do
         expect(Article.order_by_rating(:sum, :asc)).to eq [
@@ -127,7 +111,7 @@ RSpec.describe Rating::Extension, ':order_by_rating' do
       end
     end
 
-    context 'as desc' do
+    context 'with as desc' do
       it 'works' do
         expect(Article.order_by_rating(:sum, :desc)).to eq [
           article_1,
@@ -144,39 +128,39 @@ RSpec.describe Rating::Extension, ':order_by_rating' do
         end
       end
     end
+  end
 
-    context 'filtering by :total' do
-      context 'as asc' do
-        it 'works' do
-          result = Article.order_by_rating(:total, :asc)
+  context 'when filtering by :total' do
+    context 'with as asc' do
+      it 'works' do
+        result = Article.order_by_rating(:total, :asc)
 
-          expect(result[0..1]).to match_array [article_2, article_3]
-          expect(result.last).to  eq article_1
-        end
+        expect(result[0..1]).to match_array [article_2, article_3]
+        expect(result.last).to  eq article_1
+      end
 
-        context 'with scope' do
-          it 'works' do
-            expect(Article.order_by_rating(:total, :asc, scope: category)).to eq [
-              article_1
-            ]
-          end
+      context 'with scope' do
+        it 'works' do
+          expect(Article.order_by_rating(:total, :asc, scope: category)).to eq [
+            article_1
+          ]
         end
       end
+    end
 
-      context 'as desc' do
-        it 'works' do
-          result = Article.order_by_rating(:total, :desc)
+    context 'with as desc' do
+      it 'works' do
+        result = Article.order_by_rating(:total, :desc)
 
-          expect(result.first).to eq article_1
-          expect(result[1..2]).to match_array [article_2, article_3]
-        end
+        expect(result.first).to eq article_1
+        expect(result[1..2]).to match_array [article_2, article_3]
+      end
 
-        context 'with scope' do
-          it 'works' do
-            expect(Article.order_by_rating(:total, :desc, scope: category)).to eq [
-              article_1
-            ]
-          end
+      context 'with scope' do
+        it 'works' do
+          expect(Article.order_by_rating(:total, :desc, scope: category)).to eq [
+            article_1
+          ]
         end
       end
     end
@@ -184,12 +168,12 @@ RSpec.describe Rating::Extension, ':order_by_rating' do
 
   context 'with other resource' do
     it 'works' do
-      expect(User.order_by_rating(:total, :desc)).to match_array [user_1, user_2]
+      expect(Author.order_by_rating(:total, :desc)).to match_array [author_1, author_2]
     end
 
     context 'with scope' do
       it 'returns empty since creation has no scope' do
-        expect(User.order_by_rating(:total, :desc, scope: category)).to eq []
+        expect(Author.order_by_rating(:total, :desc, scope: category)).to eq []
       end
     end
   end