rating 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c384b931b0e023652ca3ae1025de72e2371f5c21
-  data.tar.gz: 01cefd2f71309f2a9a1dc09f01f058cc00322619
+SHA256:
+  metadata.gz: 6a9d42d0b74d27eec90696480e08f53c4ff5cfd8df12bf52b8fe7d993b483479
+  data.tar.gz: fcbaeb118ff6e0c37fcc7ea8d8d9a658e52e4e712bd5251fe948a4ad81a34878
 SHA512:
-  metadata.gz: 98af2a274b9fc2cca342546016ba431d58e718463ac773ec02f99bdb7830634e08a8fd8cadffba68ac3e047eba14407c29787dd913192b730b3d98a4b2bffd50
-  data.tar.gz: 4f8a8ae57dc1e14719739b3defbf850abb606c4d37d36d71922b11d91776ccd65866c9f2f17819ba5b9d046f91551ef70e216b9e28fd8b1fdd0cc437af36e12d
+  metadata.gz: cad83ae5235eb83be5fb3fbd729391e9919430d169236f04c5a3a68eeb21e58aece8ef067f72cd513df75103c1777d61c3f51f0e5d0edcff9b19eeb8203ac2b6
+  data.tar.gz: 0da9112657b71a5f5af0abc739d75f780f0a3d3501de94c189ae787074284aae5850bf48f3fe3c8f40d9acf573019acfa5d5a704a307ba0da4882d37353b46ea

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.8.0
+
+### News
+
+- Adds `unscoped_rating` option to calculate the rating counting all resource record ignoring the scope.
+
 ## v0.7.0
 
 ### News

data/README.md

@@ -392,6 +392,24 @@ rating:
           - scope_2
 ```
 
+### Unscoped Rating
+
+All rating values are grouped by the scope, but you can disable it and group all of them.
+
+```ruby
+rating unscoped_rating: true
+
+author   = User.last
+resource = Article.last
+scope    = Category.last
+
+author.rate resource, 1, scope: scope
+author.rate resource, 2, scope: scope
+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`.
+
 ## Love it!
 
 Via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=X8HEP2878NDEG&item_name=rating) or [Patreon](https://www.patreon.com/wbotelhos). Thanks! (:

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

@@ -55,8 +55,8 @@ module Rating
     end
 
     module ClassMethods
-      def rating(as: nil, scoping: nil)
-        after_create -> { rating_warm_up scoping: scoping }, unless: -> { as == :author }
+      def rating(options = {})
+        after_create -> { rating_warm_up scoping: options[:scoping] }, unless: -> { options[:as] == :author }
 
         has_many :rating_records,
           as:         :resource,
@@ -78,6 +78,10 @@ module Rating
             .where(Rating.table_name => { scopeable_id: scope&.id, scopeable_type: scope&.class&.base_class&.name })
             .order("#{Rating.table_name}.#{column} #{direction}")
         }
+
+        define_method :rating_options do
+          options
+        end
       end
     end
   end

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

@@ -18,8 +18,8 @@ module Rating
 
     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)
+        total_count    = how_many_resource_received_votes_sql(distinct: false, resource: resource, scopeable: scopeable)
+        distinct_count = how_many_resource_received_votes_sql(distinct: true, resource: resource, scopeable: scopeable)
         values         = { resource_type: resource.class.base_class.name }
 
         values[:scopeable_type] = scopeable.class.base_class.name unless scopeable.nil?
@@ -29,7 +29,7 @@ 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 AND #{scope_type_query(scopeable)}
+          WHERE resource_type = :resource_type #{scope_type_query(resource, scopeable)}
         ).squish
 
         execute_sql [sql, values]
@@ -48,29 +48,26 @@ module Rating
       end
 
       def values_data(resource, scopeable)
-        scope_query = if scopeable.nil?
-                        'scopeable_type is NULL AND scopeable_id is NULL'
-                      else
-                        'scopeable_type = ? AND scopeable_id = ?'
-                      end
-
         sql = %(
           SELECT
             COALESCE(AVG(value), 0) rating_avg,
             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 = ? #{scope_type_and_id_query(resource, scopeable)}
         ).squish
 
         values =  [sql, resource.class.base_class.name, resource.id]
-        values += [scopeable.class.base_class.name, scopeable.id] unless scopeable.nil?
+        values += [scopeable.class.base_class.name, scopeable.id] unless scopeable.nil? || unscoped_rating?(resource)
 
         execute_sql values
       end
 
       def update_rating(resource, scopeable)
-        record = find_or_initialize_by(resource: resource, scopeable: scopeable)
+        attributes             = { resource: resource }
+        attributes[:scopeable] = unscoped_rating?(resource) ? nil : scopeable
+
+        record = find_or_initialize_by(attributes)
         result = data(resource, scopeable)
 
         record.average  = result[:average]
@@ -97,13 +94,17 @@ module Rating
         Rate.find_by_sql(sql).first
       end
 
-      def how_many_resource_received_votes_sql?(distinct:, scopeable:)
+      def unscoped_rating?(resource)
+        resource.rating_options[:unscoped_rating]
+      end
+
+      def how_many_resource_received_votes_sql(distinct:, resource:, scopeable:)
         count = distinct ? 'COUNT(DISTINCT resource_id)' : 'COUNT(1)'
 
         %((
           SELECT GREATEST(#{count}, 1)
           FROM #{rate_table_name}
-          WHERE resource_type = :resource_type AND #{scope_type_query(scopeable)}
+          WHERE resource_type = :resource_type #{scope_type_query(resource, scopeable)}
         ))
       end
 
@@ -111,8 +112,17 @@ module Rating
         @rate_table_name ||= Rate.table_name
       end
 
-      def scope_type_query(scopeable)
-        scopeable.nil? ? 'scopeable_type is NULL' : 'scopeable_type = :scopeable_type'
+      def scope_type_query(resource, scopeable)
+        return '' if unscoped_rating?(resource)
+
+        scopeable.nil? ? 'AND scopeable_type is NULL' : 'AND scopeable_type = :scopeable_type'
+      end
+
+      def scope_type_and_id_query(resource, scopeable)
+        return '' if unscoped_rating?(resource)
+        return 'AND scopeable_type is NULL AND scopeable_id is NULL' if scopeable.nil?
+
+        'AND scopeable_type = ? AND scopeable_id = ?'
       end
     end
   end

data/lib/rating/version.rb

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

data/spec/factories/global.rb

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

data/spec/models/extension/unscoped_rating_spec.rb

@@ -0,0 +1,121 @@
+# 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!(:scope)    { create :category }
+
+  context 'when is false' do
+    let!(:resource) { create :article }
+
+    it 'groups in different 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 2
+
+      rating = ratings[0]
+
+      expect(rating.average.to_s).to  eq '1.5'
+      expect(rating.estimate.to_s).to eq '1.5'
+      expect(rating.resource).to      eq resource
+      expect(rating.scopeable).to     eq scope
+      expect(rating.sum).to           eq 3
+      expect(rating.total).to         eq 2
+
+      rating = ratings[1]
+
+      expect(rating.average.to_s).to  eq '5.0'
+      expect(rating.estimate.to_s).to eq '5.0'
+      expect(rating.resource).to      eq resource
+      expect(rating.scopeable).to     eq nil
+      expect(rating.sum).to           eq 5
+      expect(rating.total).to         eq 1
+    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' 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
+    let!(:resource) { create :global }
+
+    before { ::Rating::Rating.create resource: resource, scopeable: scope }
+
+    it 'groups in the line with no scope' 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 2
+
+      rating = ratings[0]
+
+      expect(rating.average.to_s).to  eq '0.0'
+      expect(rating.estimate.to_s).to eq '0.0'
+      expect(rating.resource).to      eq resource
+      expect(rating.scopeable).to     eq scope
+      expect(rating.sum).to           eq 0
+      expect(rating.total).to         eq 0
+
+      rating = ratings[1]
+
+      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
+end

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

@@ -6,6 +6,7 @@ class CreateCategoriesTable < ActiveRecord::Migration[5.0]
       t.string :name, null: false
 
       t.references :article, foreign_key: true, index: true
+      t.references :global,  foreign_key: true, index: true
     end
   end
 end

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

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

data/spec/support/migrate.rb

@@ -7,7 +7,10 @@ Dir[File.expand_path('db/migrate/*.rb', __dir__)].each { |file| require file }
 
 CreateArticlesTable.new.change
 CreateAuthorsTable.new.change
+
+CreateGlobalsTable.new.change
 CreateCategoriesTable.new.change
+
 CreateCommentsTable.new.change
 CreateRateTable.new.change
 CreateRatingTable.new.change

data/spec/support/models/category.rb

@@ -2,4 +2,5 @@
 
 class Category < ::ActiveRecord::Base
   belongs_to :article
+  belongs_to :global
 end

data/spec/support/models/global.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Global < ::ActiveRecord::Base
+  rating scoping: :categories, unscoped_rating: true
+
+  has_many :categories
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rating
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Washington Botelho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-02 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -153,6 +153,7 @@ files:
 - spec/factories/author.rb
 - spec/factories/category.rb
 - spec/factories/comment.rb
+- spec/factories/global.rb
 - spec/factories/rating/rate.rb
 - spec/factories/rating/rating.rb
 - spec/models/extension/after_create_spec.rb
@@ -167,6 +168,7 @@ files:
 - spec/models/extension/rating_records_spec.rb
 - spec/models/extension/rating_spec.rb
 - spec/models/extension/rating_warm_up_spec.rb
+- spec/models/extension/unscoped_rating_spec.rb
 - spec/models/rate/create_spec.rb
 - spec/models/rate/rate_for_spec.rb
 - spec/models/rate_spec.rb
@@ -184,6 +186,7 @@ files:
 - spec/support/db/migrate/create_authors_table.rb
 - spec/support/db/migrate/create_categories_table.rb
 - spec/support/db/migrate/create_comments_table.rb
+- spec/support/db/migrate/create_globals_table.rb
 - spec/support/db/migrate/create_review_ratings_table.rb
 - spec/support/db/migrate/create_reviews_table.rb
 - spec/support/factory_bot.rb
@@ -192,6 +195,7 @@ files:
 - spec/support/models/author.rb
 - spec/support/models/category.rb
 - spec/support/models/comment.rb
+- spec/support/models/global.rb
 - spec/support/models/review.rb
 - spec/support/models/review_rating.rb
 - spec/support/shared_context/with_database_records.rb
@@ -216,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A true Bayesian rating system with scope and cache enabled.
@@ -235,6 +239,7 @@ test_files:
 - spec/models/extension/rated_question_spec.rb
 - 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/rate_spec.rb
 - spec/models/extension/rate_for_spec.rb
 - spec/models/extension/after_create_spec.rb
@@ -252,6 +257,7 @@ test_files:
 - spec/support/models/author.rb
 - spec/support/models/review.rb
 - spec/support/models/comment.rb
+- spec/support/models/global.rb
 - spec/support/models/review_rating.rb
 - spec/support/common.rb
 - spec/support/db/migrate/create_categories_table.rb
@@ -262,6 +268,7 @@ test_files:
 - spec/support/db/migrate/add_extra_fields_on_rating_rates_table.rb
 - spec/support/db/migrate/create_reviews_table.rb
 - spec/support/db/migrate/create_comments_table.rb
+- spec/support/db/migrate/create_globals_table.rb
 - spec/support/database_cleaner.rb
 - spec/support/shared_context/with_database_records.rb
 - spec/factories/article.rb
@@ -270,4 +277,5 @@ test_files:
 - spec/factories/rating/rating.rb
 - spec/factories/author.rb
 - spec/factories/comment.rb
+- spec/factories/global.rb
 - spec/rails_helper.rb