rating 0.11.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3478dbe5fac4bb47db0a3b730f0b21d49747912056447d9de55d5ec82f6072ec
-  data.tar.gz: 3d95a77107c053347876554c1f36121a62b9342dd4b585833cd12b2f32aadd0c
+  metadata.gz: 2d43b5a545fab38d39feb7a46f4d081c4408dd2281f00478996bf989a4f3682d
+  data.tar.gz: cfc83ae954ea334ecf0a7cf44b16594d0fd8a3c0fe48cc75034bb662cd555fa7
 SHA512:
-  metadata.gz: caabeb2c0336c22a86d95a064688424d242c96f84c8e28bd93883a2472f15a22d937ab726f060f765332bb8277f19ffb2fde571a2e7019b91e02c8aced96867d
-  data.tar.gz: 5acbf2bb5e2280de7507e9c23785ecc75e31b62a8c434a48972f50e78d09fa38a8e4280d4272c91bb3109994cdab217f5766a01d94c5a384d9990aa080c18e06
+  metadata.gz: 6a393e04ede36dd77e88023c8ed134e359ad2ead75a96a07e483d46f99fe9ec0c83c9303143dc3fd545902064f8e711c8665de1293259561bec7afd1293ce091
+  data.tar.gz: 89e4096c7c2e43b7771e2af9680f8a3fca8753831fc7c4c5685f9fd676fd2694bde65cdbcf816f70150486dd5282141938ecd700ec79d2f9a231b6aadf97eabd

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## v1.0.0
+
+### Break Change
+
+- The attributes `estimate` and `average` now is rounded by two decimal numbers;
+
+### Updates
+
+- The method `order_by_rating` now receives a hash parameter to avoid scope and so support Ruby 3.2;
+
+## 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
@@ -14,47 +38,47 @@
 
 ### 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 Ruby to 2.6.5;
-- Update Activerecord to the last version;
+- 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://github.com/sponsors/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
 ```
 
@@ -168,7 +169,7 @@ It will return a collection of resource ordered by `estimate desc` as default.
 The order column and direction can be changed:
 
 ```ruby
-Article.order_by_rating :average, :asc
+Article.order_by_rating({ column: :average, direction: :asc })
 ```
 
 It will return a collection of resource ordered by `Rating` table data.
@@ -241,7 +242,7 @@ article.rates scope: category_2
 To order the rating you do the same thing:
 
 ```ruby
-Article.order_by_rating scope: category_1
+Article.order_by_rating({ scope: category_1 })
 ```
 
 ### Extra Scopes
@@ -423,6 +424,16 @@ 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
 
 - [Evan Miller](http://www.evanmiller.org/ranking-items-with-star-ratings.html)

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

@@ -3,7 +3,7 @@
 class CreateRateTable < ActiveRecord::Migration[5.0]
   def change
     create_table :rating_rates do |t|
-      t.decimal :value, default: 0, precision: 25, scale: 16
+      t.decimal :value, default: 0, precision: 11, scale: 2
 
       t.references :author,    index: true, null: false, polymorphic: true
       t.references :resource,  index: true, null: false, polymorphic: true

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

@@ -3,8 +3,8 @@
 class CreateRatingTable < ActiveRecord::Migration[5.0]
   def change
     create_table :rating_ratings do |t|
-      t.decimal :average,  default: 0, mull: false, precision: 25, scale: 16
-      t.decimal :estimate, default: 0, mull: false, precision: 25, scale: 16
+      t.decimal :average,  default: 0, mull: false, precision: 11, scale: 2
+      t.decimal :estimate, default: 0, mull: false, precision: 11, scale: 2
       t.integer :sum,      default: 0, mull: false
       t.integer :total,    default: 0, mull: false
 

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)
@@ -73,7 +72,11 @@ module Rating
           class_name: '::Rating::Rate',
           dependent:  :destroy
 
-        scope :order_by_rating, lambda { |column = :estimate, direction = :desc, scope: nil|
+        scope :order_by_rating, lambda { |opts = {}|
+          column = opts.fetch(:column, :estimate)
+          direction = opts.fetch(:direction, :desc)
+          scope = opts[:scope]
+
           includes(:rating_records)
             .where(Rating.table_name => { scopeable_id: scope&.id, scopeable_type: scope&.class&.base_class&.name })
             .order("#{Rating.table_name}.#{column} #{direction}")

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

@@ -19,7 +19,7 @@ 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)
 
@@ -31,7 +31,7 @@ module Rating
       record
     end
 
-    def self.rate_for(author:, extra_scopes: {}, resource:, scopeable: nil)
+    def self.rate_for(author:, resource:, extra_scopes: {}, scopeable: nil)
       find_by extra_scopes.merge(author: author, resource: resource, scopeable: scopeable)
     end
 

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

@@ -43,8 +43,8 @@ module Rating
         values   = values_data(resource, scopeable)
 
         {
-          average:  values.rating_avg,
-          estimate: estimate(averager, values),
+          average:  values.rating_avg.round(2),
+          estimate: estimate(averager, values).round(2),
           sum:      values.rating_sum,
           total:    values.rating_count,
         }
@@ -93,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)

data/lib/rating/version.rb

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

data/lib/rating.rb

@@ -8,4 +8,4 @@ require 'rating/models/rating/extension'
 require 'rating/models/rating/rate'
 require 'rating/models/rating/rating'
 
-ActiveRecord::Base.include Rating::Extension
+ActiveSupport.on_load(:active_record) { include Rating::Extension }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rating
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Washington Botelho
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2023-03-04 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
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -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,71 +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/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
-- 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/extension/where_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/db/migrate/create_toys_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/models/toy.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
@@ -233,68 +219,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.6
+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/where_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/toy.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/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
-- 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/toy.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

data/spec/factories/rating/rate.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-FactoryBot.define do
-  factory :rating_rate, class: Rating::Rate do
-    value { 100 }
-
-    author   { create :author }
-    resource { create :article }
-  end
-end

data/spec/factories/rating/rating.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-FactoryBot.define do
-  factory :rating_rating, class: Rating::Rating do
-    average  { 100 }
-    estimate { 100 }
-    sum      { 100 }
-    total    { 1 }
-
-    association :resource, factory: :article, strategy: :build
-  end
-end

data/spec/factories/toy.rb

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