rating 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11fafaaddcc1f4568cfd1412930a42a06aa0467bfa6e68a74d1bd3214f24aa87
-  data.tar.gz: d1dc1822b99b9a928e6bdceabcdd00bed081d08498e7189b1169ce323b3f720d
+  metadata.gz: bf4f916eaf8978771365715fff38db48916a423e061a4fe680cc105d48d3558b
+  data.tar.gz: 409e9990a8171000cbd898744f6859358f75e302f0d169287ba29c94fc293758
 SHA512:
-  metadata.gz: 0a636e5f8b60c69b98384343ffa3ddb5023f020d07716917e2e1fe5a5292c8e2c4a28056755a01bae4978365f4b73a8f5e98fb9169f03e0b9825b44a0b6a6fd3
-  data.tar.gz: '09713cd4fd3a48b8433a3482c791eb380231b1a2edec2016d8a909bb3f7b8abbb0020c08d3fe5b68418840f9a017459d40e65672bda38aeb6ffbea6100cc9178'
+  metadata.gz: 5c06d75fec9d344f0cca88d6f250d23b4d3612539f2c12d10d6db3c56b86349f9552e3036a34c065d8ccbe9b5e13f00c2ab34f70167d6d16e7ca2d3f90868351
+  data.tar.gz: c3788409c80bc0a8c9b17df8d40720e35f225a0e8dd5ed6c136260c821f176dd8caa87809dcc68e3b50f892d58d9863f7248c554ea8a69832b05f0cb16aa1249

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.10.0
+
+### News
+
+- Add option `where` to be able adds conditions on `Rating::Rate`.
+
 ## v0.9.0
 
 ### News
@@ -7,7 +13,7 @@
 
 ### Updates
 
-- Update Rails to 2.6.5;
+- Update Ruby to 2.6.5;
 - Update Activerecord to the last version;
 
 ## v0.8.0

data/README.md

@@ -138,24 +138,20 @@ author.rated? resource
 
 ### rates
 
-You can retrieve all rates received by some resource:
+All rating received.
 
 ```ruby
-resource = Article.last
-
-resource.rates
+Article.first.rates
 ```
 
 It will return a collection of `Rate` object.
 
 ### rated
 
-In the same way you can retrieve all rates that some author received:
+All rating given.
 
 ```ruby
-author = Author.last
-
-author.rated
+Author.first.rated
 ```
 
 It will return a collection of `Rate` object.
@@ -349,7 +345,7 @@ If you need to warm up a record with scope, you need to setup the `scoping` rela
 
 ```ruby
 class Resource < ApplicationRecord
-  voting scoping: :categories
+  rating scoping: :categories
 end
 ```
 
@@ -410,6 +406,22 @@ author.rate resource, 3
 
 Now the `sum` will be `6` and the `total` will be `3` because all rating will be calculated into just one rating record ignoring the `scopeable` object. The rating record is always saved on the record with `scopeable` as `nil`.
 
+### where
+
+The `where` option can be used to filter the `Rating::Rate` records used to create the final `Rating::Rating`. You can filter only approved rates, for exemplo:
+
+```ruby
+rating where: 'approved = true'
+
+author   = User.last
+resource = Article.last
+
+author.rate resource, 1, extra_scope: { approved: false }
+author.rate resource, 5, extra_scope: { approved: true }
+```
+
+As you can see, now, only the rate with value `5` will be included on the final rating.
+
 ### References
 
 - [Evan Miller](http://www.evanmiller.org/ranking-items-with-star-ratings.html)

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

@@ -29,7 +29,10 @@ module Rating
             (CAST(#{total_count} AS DECIMAL(17, 14)) / #{distinct_count}) count_avg,
             COALESCE(AVG(value), 0)                                       rating_avg
           FROM #{rate_table_name}
-          WHERE resource_type = :resource_type #{scope_type_query(resource, scopeable)}
+          WHERE
+            resource_type = :resource_type
+            #{scope_type_query(resource, scopeable)}
+            #{scope_where_query(resource)}
         ).squish
 
         execute_sql [sql, values]
@@ -54,7 +57,11 @@ module Rating
             COALESCE(SUM(value), 0) rating_sum,
             COUNT(1)                rating_count
           FROM #{rate_table_name}
-          WHERE resource_type = ? AND resource_id = ? #{scope_type_and_id_query(resource, scopeable)}
+          WHERE
+            resource_type = ?
+            AND resource_id = ?
+            #{scope_type_and_id_query(resource, scopeable)}
+            #{scope_where_query(resource)}
         ).squish
 
         values =  [sql, resource.class.base_class.name, resource.id]
@@ -104,7 +111,10 @@ module Rating
         %((
           SELECT GREATEST(#{count}, 1)
           FROM #{rate_table_name}
-          WHERE resource_type = :resource_type #{scope_type_query(resource, scopeable)}
+          WHERE
+            resource_type = :resource_type
+            #{scope_type_query(resource, scopeable)}
+            #{scope_where_query(resource)}
         ))
       end
 
@@ -124,6 +134,16 @@ module Rating
 
         'AND scopeable_type = ? AND scopeable_id = ?'
       end
+
+      def scope_where_query(resource)
+        return '' if where_condition(resource).blank?
+
+        "AND #{where_condition(resource)}"
+      end
+
+      def where_condition(resource)
+        resource.rating_options[:where]
+      end
     end
   end
 end

data/lib/rating/version.rb

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

data/spec/factories/toy.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :toy do
+  end
+end

data/spec/models/extension/unscoped_rating_spec.rb

@@ -62,30 +62,7 @@ RSpec.describe Rating::Extension, 'unscoped_rating' do
     end
   end
 
-  context 'when is true' do
-    let!(:resource) { create :global }
-
-    it 'groups in the same line record' do
-      author_1.rate resource, 1, scope: scope
-      author_2.rate resource, 2, scope: scope
-      author_1.rate resource, 5
-
-      ratings = Rating::Rating.all.order('id')
-
-      expect(ratings.size).to eq 1
-
-      rating = ratings[0]
-
-      expect(rating.average.to_s).to  eq '2.6666666666666667'
-      expect(rating.estimate.to_s).to eq '2.6666666666666667'
-      expect(rating.resource).to      eq resource
-      expect(rating.scopeable).to     eq nil
-      expect(rating.sum).to           eq 8
-      expect(rating.total).to         eq 3
-    end
-  end
-
-  context 'when is true and have a non scopeable record first on dabase' do
+  context 'when is true and have a non scopeable record first on database' do
     let!(:resource) { create :global }
 
     before { ::Rating::Rating.create resource: resource, scopeable: scope }

data/spec/models/extension/where_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Rating::Extension, 'unscoped_rating' do
+  let!(:author_1) { create :author }
+  let!(:author_2) { create :author }
+  let!(:author_3) { create :author }
+  let!(:author_4) { create :author }
+  let!(:author_5) { create :author }
+  let!(:resource) { create :toy }
+
+  it 'uses rate with where condition' do
+    author_1.rate resource, 1
+    author_2.rate resource, 2
+    author_3.rate resource, 3
+    author_4.rate resource, 4
+    author_5.rate resource, 5
+
+    ratings = Rating::Rating.all.order('id')
+
+    expect(ratings.size).to eq 1
+
+    rating = ratings[0]
+
+    expect(rating.average.to_s).to  eq '3.0'
+    expect(rating.estimate.to_s).to eq '3.0'
+    expect(rating.resource).to      eq resource
+    expect(rating.scopeable).to     eq nil
+    expect(rating.sum).to           eq 9
+    expect(rating.total).to         eq 3
+  end
+end

data/spec/support/db/migrate/create_toys_table.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class CreateToysTable < ActiveRecord::Migration[5.0]
+  def change
+    create_table :toys do |t|
+    end
+  end
+end

data/spec/support/migrate.rb

@@ -7,6 +7,7 @@ CreateRatingTable.new.change
 
 CreateArticlesTable.new.change
 CreateAuthorsTable.new.change
+CreateToysTable.new.change
 
 CreateGlobalsTable.new.change
 CreateCategoriesTable.new.change

data/spec/support/models/toy.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Toy < ::ActiveRecord::Base
+  rating where: 'value > 1 and value < 5'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rating
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Washington Botelho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2019-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -164,6 +164,7 @@ files:
 - spec/factories/global.rb
 - spec/factories/rating/rate.rb
 - spec/factories/rating/rating.rb
+- spec/factories/toy.rb
 - spec/models/extension/after_create_spec.rb
 - spec/models/extension/order_by_rating_spec.rb
 - spec/models/extension/rate_for_spec.rb
@@ -177,6 +178,7 @@ files:
 - spec/models/extension/rating_spec.rb
 - spec/models/extension/rating_warm_up_spec.rb
 - spec/models/extension/unscoped_rating_spec.rb
+- spec/models/extension/where_spec.rb
 - spec/models/rate/create_spec.rb
 - spec/models/rate/rate_for_spec.rb
 - spec/models/rate_spec.rb
@@ -199,6 +201,7 @@ files:
 - spec/support/db/migrate/create_rating_table.rb
 - spec/support/db/migrate/create_review_ratings_table.rb
 - spec/support/db/migrate/create_reviews_table.rb
+- spec/support/db/migrate/create_toys_table.rb
 - spec/support/factory_bot.rb
 - spec/support/migrate.rb
 - spec/support/models/article.rb
@@ -208,6 +211,7 @@ files:
 - spec/support/models/global.rb
 - spec/support/models/review.rb
 - spec/support/models/review_rating.rb
+- spec/support/models/toy.rb
 - spec/support/shared_context/with_database_records.rb
 - spec/support/shoulda.rb
 homepage: https://github.com/wbotelhos/rating
@@ -249,6 +253,7 @@ test_files:
 - spec/models/extension/rating_warm_up_spec.rb
 - spec/models/extension/order_by_rating_spec.rb
 - spec/models/extension/unscoped_rating_spec.rb
+- spec/models/extension/where_spec.rb
 - spec/models/extension/rate_spec.rb
 - spec/models/extension/rate_for_spec.rb
 - spec/models/extension/after_create_spec.rb
@@ -263,6 +268,7 @@ test_files:
 - spec/support/factory_bot.rb
 - spec/support/models/article.rb
 - spec/support/models/category.rb
+- spec/support/models/toy.rb
 - spec/support/models/author.rb
 - spec/support/models/review.rb
 - spec/support/models/comment.rb
@@ -274,6 +280,7 @@ test_files:
 - spec/support/db/migrate/create_review_ratings_table.rb
 - spec/support/db/migrate/create_articles_table.rb
 - spec/support/db/migrate/create_rating_table.rb
+- spec/support/db/migrate/create_toys_table.rb
 - spec/support/db/migrate/add_comment_on_rating_rates_table.rb
 - spec/support/db/migrate/add_extra_fields_on_rating_rates_table.rb
 - spec/support/db/migrate/create_reviews_table.rb
@@ -286,6 +293,7 @@ test_files:
 - spec/factories/category.rb
 - spec/factories/rating/rate.rb
 - spec/factories/rating/rating.rb
+- spec/factories/toy.rb
 - spec/factories/author.rb
 - spec/factories/comment.rb
 - spec/factories/global.rb