rating 0.9.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11fafaaddcc1f4568cfd1412930a42a06aa0467bfa6e68a74d1bd3214f24aa87
-  data.tar.gz: d1dc1822b99b9a928e6bdceabcdd00bed081d08498e7189b1169ce323b3f720d
+  metadata.gz: 107d28dc3f0be409a1684eebea163b6dcf6cc57d801f7dcd88bca4f0bcf4f662
+  data.tar.gz: af591a933ee3bf23720cd054c33968ec9fbba3f21cbd9d117dd1628f0b6cebb5
 SHA512:
-  metadata.gz: 0a636e5f8b60c69b98384343ffa3ddb5023f020d07716917e2e1fe5a5292c8e2c4a28056755a01bae4978365f4b73a8f5e98fb9169f03e0b9825b44a0b6a6fd3
-  data.tar.gz: '09713cd4fd3a48b8433a3482c791eb380231b1a2edec2016d8a909bb3f7b8abbb0020c08d3fe5b68418840f9a017459d40e65672bda38aeb6ffbea6100cc9178'
+  metadata.gz: 3c3dc424ab1155b6a7f6aa309b461015c7d06b2786c172d55b03b29052a3643d098fe78dde4a9c7edf2b564ea324451e5ad1a12373769caa7b6520cb0b5def8d
+  data.tar.gz: b92eaadfdaa4cca67eca6e3a5550333080541d93b1a48e01dace83bc858969fc718f60123c40353c15bf3ec6c42166b2359d9d82e05b315454a4ca74b91b32be

data/CHANGELOG.md

@@ -1,48 +1,74 @@
+## v0.12.0
+
+### News
+
+- Officially Supports Postgres;
+
+### Updates
+
+- Migrates the CI to GitHub Actions;
+- This gem does not depends on `git` package anymore;
+- Makes this gem requires MFA for security;
+- Adds coverage test;
+- The method `rated?` now uses a better query;
+
+## v0.11.0
+
+### Updates
+
+- Same rate value hits DB to update metadata.
+
+## v0.10.0
+
+### News
+
+- Add option `where` to be able adds conditions on `Rating::Rate`.
+
 ## v0.9.0
 
 ### News
 
-- Order index keys of template the same way Rails does the query;
+- Order index keys of the template the same way Rails does the query;
 - Limits the `_type` columns to avoid overflow bytes in DBs like MySQL < 5.7.
 
 ### Updates
 
-- Update Rails to 2.6.5;
-- Update Activerecord to the last version;
+- Update Ruby to 2.6.5;
+- Update ActiveRecord to the last version;
 
 ## v0.8.0
 
 ### News
 
-- Adds `unscoped_rating` option to calculate the rating counting all resource record ignoring the scope.
+- Adds `unscoped_rating` option to calculate the rating by counting all resource records ignoring the scope.
 
 ## v0.7.0
 
 ### News
 
 - Support to configure `uniqueness` validation via YAML into Rating::Rate model;
-- Support to multiple scopes via `extra_scopes` option.
+- Support multiple scopes via `extra_scopes` option.
 
 ### Updates
 
-- Reverts v0.6.0, since we need this validation because we cannot edit the Rate model by ourself.
+- Reverts v0.6.0, since we need this validation because we cannot edit the Rate model by ourselves.
 
 ## v0.6.0
 
 ### Updates
 
-- The author unique validations was removed to enable custom validations
+- The author's unique validations were removed to enable custom validations
 
 ## v0.5.0
 
 ### News
 
-- Adds `rating.yml` config to support to change the tables where Rating will write the data;
-- Adds `scoping` option to support to generates zero based rating via scope.
+- Adds `rating.yml` config to support changing the tables where Rating will write the data;
+- Adds `scoping` option to support generating zero-based rating via scope.
 
 ### Updates
 
-- The migrate was separated in two to improve in troubleshoot. (iondrimba)
+- The migration was separated in two to improve troubleshooting. [#1](https://github.com/wbotelhos/rating/pull/1) by [iondrimba](https://github.com/iondrimba)
 
 ## v0.4.0
 

data/README.md

@@ -1,9 +1,10 @@
 # Rating
 
-[![Build Status](https://travis-ci.org/wbotelhos/rating.svg)](https://travis-ci.org/wbotelhos/rating)
+[![CI](https://github.com/wbotelhos/rating/workflows/CI/badge.svg)](https://github.com/wbotelhos/rating/actions)
 [![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)
-[![Patreon](https://img.shields.io/badge/donate-%3C3-brightgreen.svg)](https://www.patreon.com/wbotelhos)
+[![codecov](https://codecov.io/gh/wbotelhos/rating/branch/master/graph/badge.svg?token=QJSHUOULEG)](https://codecov.io/gh/wbotelhos/rating)
+[![Sponsor](https://img.shields.io/badge/sponsor-%3C3-green)](https://www.patreon.com/wbotelhos)
 
 A true Bayesian rating system with scope and cache enabled.
 
@@ -51,15 +52,15 @@ Add the following code on your `Gemfile` and run `bundle install`:
 gem 'rating'
 ```
 
-Run the following task to create a Rating migration:
+Run the following task to create the Rating migration:
 
-```bash
+```sh
 rails g rating:install
 ```
 
 Then execute the migrations to create the to create tables `rating_rates` and `rating_ratings`:
 
-```bash
+```sh
 rake db:migrate
 ```
 
@@ -138,24 +139,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 +346,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
 ```
 
@@ -394,7 +391,7 @@ rating:
 
 ### Unscoped Rating
 
-All rating values are grouped by the scope, but you can disable it and group all of them.
+All rating values are grouped by its own scope, but you can disable it and group all of them together.
 
 ```ruby
 rating unscoped_rating: true
@@ -408,7 +405,34 @@ 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`.
+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.
+
+### Specs
+
+To run all specs, run the following rakes:
+
+```sh
+bundle exec rake spec
+bundle exec rake spec_config
+bundle exec rake spec_config_with_extra_scopes
+```
 
 ### References
 

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

@@ -20,9 +20,8 @@ module Rating
         Rate.rate_for author: self, extra_scopes: extra_scopes, resource: resource, scopeable: scope
       end
 
-      # TODO: use exists for performance
       def rated?(resource, extra_scopes: {}, scope: nil)
-        !rate_for(resource, extra_scopes: extra_scopes, scope: scope).nil?
+        Rate.exists?(extra_scopes.merge(author: self, resource: resource, scopeable: scope))
       end
 
       def rates(extra_scopes: {}, scope: nil)

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

@@ -19,12 +19,10 @@ module Rating
       scope:          ::Rating::Config.validations['rate']['scope'].map(&:to_sym),
     }
 
-    def self.create(author:, extra_scopes:, metadata:, resource:, scopeable: nil, value:)
+    def self.create(author:, extra_scopes:, metadata:, resource:, value:, scopeable: nil)
       attributes = { author: author, resource: resource, scopeable: scopeable }.merge(extra_scopes)
       record     = find_or_initialize_by(attributes)
 
-      return record if record.persisted? && value == record.value
-
       metadata.each { |k, v| record[k] = v } if metadata.present?
 
       record.value = value
@@ -33,10 +31,8 @@ module Rating
       record
     end
 
-    def self.rate_for(author:, extra_scopes: {}, resource:, scopeable: nil)
-      attributes = { author: author, resource: resource, scopeable: scopeable }.merge(extra_scopes)
-
-      find_by attributes
+    def self.rate_for(author:, resource:, extra_scopes: {}, scopeable: nil)
+      find_by extra_scopes.merge(author: author, resource: resource, scopeable: scopeable)
     end
 
     private

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]
@@ -86,8 +93,8 @@ module Rating
         resource_rating_avg      = values.rating_avg
         resource_rating_count    = values.rating_count.to_f
 
-        (resource_rating_count / (resource_rating_count + count_avg)) * resource_rating_avg +
-          (count_avg           / (resource_rating_count + count_avg)) * resource_type_rating_avg
+        ((resource_rating_count / (resource_rating_count + count_avg)) * resource_rating_avg) +
+          ((count_avg           / (resource_rating_count + count_avg)) * resource_type_rating_avg)
       end
 
       def execute_sql(sql)
@@ -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.12.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rating
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Washington Botelho
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_bot_rails
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +182,10 @@ description: A true Bayesian rating system with scope and cache enabled.
 email: wbotelhos@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 files:
 - CHANGELOG.md
 - LICENSE
@@ -154,67 +199,12 @@ files:
 - lib/rating/models/rating/rate.rb
 - lib/rating/models/rating/rating.rb
 - lib/rating/version.rb
-- spec/config/rate_table_spec.rb
-- spec/config/rating_table_spec.rb
-- spec/config/validations_spec.rb
-- spec/factories/article.rb
-- 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
-- spec/models/extension/order_by_rating_spec.rb
-- spec/models/extension/rate_for_spec.rb
-- spec/models/extension/rate_spec.rb
-- spec/models/extension/rated_question_spec.rb
-- spec/models/extension/rated_records_spec.rb
-- spec/models/extension/rated_spec.rb
-- spec/models/extension/rates_records_spec.rb
-- spec/models/extension/rates_spec.rb
-- 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
-- spec/models/rating/averager_data_spec.rb
-- spec/models/rating/data_spec.rb
-- spec/models/rating/update_rating_spec.rb
-- spec/models/rating/values_data_spec.rb
-- spec/models/rating_spec.rb
-- spec/rails_helper.rb
-- spec/support/common.rb
-- spec/support/database_cleaner.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_articles_table.rb
-- 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_rates_table.rb
-- 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/factory_bot.rb
-- spec/support/migrate.rb
-- spec/support/models/article.rb
-- 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
-- spec/support/shoulda.rb
 homepage: https://github.com/wbotelhos/rating
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -229,64 +219,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.3.12
+signing_key:
 specification_version: 4
 summary: A true Bayesian rating system with scope and cache enabled.
-test_files:
-- spec/config/rate_table_spec.rb
-- spec/config/validations_spec.rb
-- spec/config/rating_table_spec.rb
-- spec/models/rate/rate_for_spec.rb
-- spec/models/rate/create_spec.rb
-- spec/models/rating/averager_data_spec.rb
-- spec/models/rating/data_spec.rb
-- spec/models/rating/update_rating_spec.rb
-- spec/models/rating/values_data_spec.rb
-- spec/models/extension/rated_records_spec.rb
-- spec/models/extension/rating_spec.rb
-- 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
-- spec/models/extension/rates_spec.rb
-- spec/models/extension/rating_records_spec.rb
-- spec/models/extension/rated_spec.rb
-- spec/models/extension/rates_records_spec.rb
-- spec/models/rating_spec.rb
-- spec/models/rate_spec.rb
-- spec/support/migrate.rb
-- spec/support/shoulda.rb
-- spec/support/factory_bot.rb
-- spec/support/models/article.rb
-- spec/support/models/category.rb
-- 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
-- spec/support/db/migrate/create_authors_table.rb
-- 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/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
-- spec/support/db/migrate/create_comments_table.rb
-- spec/support/db/migrate/create_globals_table.rb
-- spec/support/db/migrate/create_rates_table.rb
-- spec/support/database_cleaner.rb
-- spec/support/shared_context/with_database_records.rb
-- spec/factories/article.rb
-- spec/factories/category.rb
-- spec/factories/rating/rate.rb
-- spec/factories/rating/rating.rb
-- spec/factories/author.rb
-- spec/factories/comment.rb
-- spec/factories/global.rb
-- spec/rails_helper.rb
+test_files: []

data/spec/config/rate_table_spec.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Rating::Config, '.rate_table' do
-  if ENV['CONFIG_ENABLED'] != 'true'
-    context 'when rating.yml does not exist' do
-      it { expect(subject.rate_table).to eq 'rating_rates' }
-    end
-  end
-
-  if ENV['CONFIG_ENABLED'] == 'true'
-    context 'when rating.yml exists' do
-      it { expect(subject.rate_table).to eq 'reviews' }
-    end
-  end
-end

data/spec/config/rating_table_spec.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Rating::Config, '.rating_table' do
-  if ENV['CONFIG_ENABLED'] != 'true'
-    context 'when rating.yml does not exist' do
-      it { expect(subject.rating_table).to eq 'rating_ratings' }
-    end
-  end
-
-  if ENV['CONFIG_ENABLED'] == 'true'
-    context 'when rating.yml exists' do
-      it { expect(subject.rating_table).to eq 'review_ratings' }
-    end
-  end
-end

data/spec/config/validations_spec.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Rating::Config, '.validations' do
-  if ENV['CONFIG_ENABLED_WITH_EXTRA_SCOPES'] != 'true'
-    context 'when rating.yml does not exist' do
-      it do
-        expect(subject.validations).to eq({
-          rate: {
-            case_sensitive: false,
-            scope:          %w[author_type resource_id resource_type scopeable_id scopeable_type],
-          },
-        }.deep_stringify_keys
-                                         )
-      end
-    end
-  end
-
-  if ENV['CONFIG_ENABLED_WITH_EXTRA_SCOPES'] == 'true'
-    context 'when rating.yml exists' do
-      it do
-        expect(subject.validations).to eq({
-          rate: {
-            case_sensitive: false,
-            scope:          %w[author_type resource_id resource_type scopeable_id scopeable_type scope_1 scope_2],
-          },
-        }.deep_stringify_keys
-                                         )
-      end
-    end
-  end
-end

data/spec/factories/article.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-FactoryBot.define do
-  factory :article do
-    sequence(:name) { |i| "Article #{i}" }
-  end
-end

data/spec/factories/author.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-FactoryBot.define do
-  factory :author do
-    sequence(:name) { |i| "Author #{i}" }
-  end
-end

data/spec/factories/category.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-FactoryBot.define do
-  factory :category do
-    sequence(:name) { |i| "Category #{i}" }
-  end
-end

data/spec/factories/comment.rb

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

data/spec/factories/global.rb

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