acts_as_favoritor 5.0.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2554cf505e5a47eb5f24bc1de95fb6287d397259cc70685f4905d99be6164e72
-  data.tar.gz: ac5749692ac44627c97dfb2797834671f7d3cc368d32e63aac5d2d9a94e4b6b6
+  metadata.gz: 720e4ea66b88a043a1bcd46c702dc8aa445b20fe60517e978791d8c4bcbc90af
+  data.tar.gz: beb07b7607a369e302816b9e39b9dae5ec8ca488ff717ff3bdb3e3b96fea1227
 SHA512:
-  metadata.gz: 544dda8f78ced970192a0d523f8c7b4804be135d33afe8635a15eaef3263d5413793d54ca5342fa12636d4a1c893b4d52bb1c160180bb72386c4a144a3280a6b
-  data.tar.gz: 28fd936df2e6dc96f6b5a2449fc654f40b4307a7d4bed58e5f648652e283af46d3547f1e3ac2245b928400d1391186fae291ff4fc1756438a14afb8c03858abe
+  metadata.gz: f1dc068b8f318a7141d2d695693245aef8aaf22ffecc2cb46484308fb9c0563cd1576d855113f336871cb4a6e7a20adf867c5b0629f7a04042fbd5862615a746
+  data.tar.gz: b736fbaa9e300ac44c9f83cbe99f780e8cfabcde661a9baf7bbef8a7fa88a28c61a022e8140d005269315b84524d8a69a549fa699da3a513221511613da28800

data/README.md

@@ -4,6 +4,8 @@ acts_as_favoritor is a Rubygem to allow any ActiveRecord model to associate any
 
 You are able to differentiate followers, favorites, watchers, votes and whatever else you can imagine through a single relationship. This is accomplished by a double polymorphic relationship on the Favorite model. There is also built in support for blocking/un-blocking favorite records as well as caching.
 
+[This Medium article](https://medium.com/swlh/add-dynamic-like-dislike-buttons-to-your-rails-6-application-ccce8a234c43) gives a good introduction to this gem.
+
 ## Installation
 
 You can add acts_as_favoritor to your `Gemfile` with:
@@ -145,7 +147,7 @@ Using scopes with `acts_as_favoritor` enables you to Follow, Watch, Favorite, [.
 
 By default all of your favorites are scoped to `'favorite'`.
 
-You can create new scopes on the fly. Every single method takes `scope`/`scopes` as an option which expexts a symbol or an array of symbols containing your scopes.
+You can create new scopes on the fly. Every single method takes `scope`/`scopes` as an option which expects a symbol or an array of symbols containing your scopes.
 
 So lets see how this works:
 
@@ -222,6 +224,8 @@ book.favoritable_favorite_cache # => 1
 
 **Note:** These methods are available for every scope you are using.
 
+The total counts all favorites that were recorded, while the score factors in favorites that were removed. In most use cases the score is the most useful.
+
 ## Configuration
 
 You can configure acts_as_favoritor by passing a block to `configure`. This can be done in `config/initializers/acts_as_favoritor.rb`:
@@ -262,7 +266,7 @@ We warmly welcome everyone who is intersted in contributing. Please reference ou
 
 ## Releases
 
-[Here](https://github.com/jonhue/acts_as_favoritor/releases) you can find details on all past releases. Unreleased breaking changes that are on the current master can be found [here](CHANGELOG.md).
+[Here](https://github.com/jonhue/acts_as_favoritor/releases) you can find details on all past releases. Unreleased breaking changes that are on the current `main` can be found [here](CHANGELOG.md).
 
 acts_as_favoritor follows Semantic Versioning 2.0 as defined at http://semver.org. Reference our [security policy](SECURITY.md).
 
@@ -271,6 +275,6 @@ acts_as_favoritor follows Semantic Versioning 2.0 as defined at http://semver.or
 1. Review breaking changes and deprecations in `CHANGELOG.md`.
 1. Change the gem version in `lib/acts_as_favoritor/version.rb`.
 1. Reset `CHANGELOG.md`.
-1. Create a pull request to merge the changes into `master`.
-1. After the pull request was merged, create a new release listing the breaking changes and commits on `master` since the last release.
+1. Create a pull request to merge the changes into `main`.
+1. After the pull request was merged, create a new release listing the breaking changes and commits on `main` since the last release.
 2. The release workflow will publish the gem to RubyGems.

data/lib/acts_as_favoritor/favoritable.rb

@@ -38,13 +38,11 @@ module ActsAsFavoritor
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-      # rubocop:disable Style/OptionalBooleanParameter
       def respond_to_missing?(method, include_private = false)
         super || method.to_s[/(.+)_favoritors/] ||
           method.to_s[/favoritable_(.+)_score/] ||
           method.to_s[/favoritable_(.+)_total/]
       end
-      # rubocop:enable Style/OptionalBooleanParameter
 
       def favoritors(scope: ActsAsFavoritor.configuration.default_scope,
                      scopes: nil)

data/lib/acts_as_favoritor/favorite_scopes.rb

@@ -12,11 +12,9 @@ module ActsAsFavoritor
       end
     end
 
-    # rubocop:disable Style/OptionalBooleanParameter
     def respond_to_missing?(method, include_private = false)
       super || method.to_s[/(.+)_list/]
     end
-    # rubocop:enable Style/OptionalBooleanParameter
 
     def for_favoritor(favoritor)
       where(

data/lib/acts_as_favoritor/favoritor.rb

@@ -38,13 +38,11 @@ module ActsAsFavoritor
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
-      # rubocop:disable Style/OptionalBooleanParameter
       def respond_to_missing?(method, include_private = false)
         super || method.to_s[/favorited_(.+)/] ||
           method.to_s[/favoritor_(.+)_score/] ||
           method.to_s[/favoritor_(.+)_total/]
       end
-      # rubocop:enable Style/OptionalBooleanParameter
 
       def favorite(favoritable,
                    scope: ActsAsFavoritor.configuration.default_scope,
@@ -52,10 +50,11 @@ module ActsAsFavoritor
         self.class.build_result_for_scopes(scopes || scope) do |s|
           return nil if self == favoritable
 
-          inc_cache(favoritable, s) if ActsAsFavoritor.configuration.cache
-
           favorites.for_favoritable(favoritable).send("#{s}_list")
-                   .first_or_create!
+                   .first_or_create! do |new_record|
+            inc_cache(favoritable, s) if ActsAsFavoritor.configuration.cache
+            new_record
+          end
         end
       end
 
@@ -64,10 +63,11 @@ module ActsAsFavoritor
                      scopes: nil)
         self.class.build_result_for_scopes(scopes || scope) do |s|
           favorite_record = get_favorite(favoritable, s)
-          return nil unless favorite_record.present?
+          return nil if favorite_record.blank?
 
-          dec_cache(favoritable, s) if ActsAsFavoritor.configuration.cache
-          favorite_record.destroy!
+          result = favorite_record.destroy!
+          dec_cache(favoritable, s) if ActsAsFavoritor.configuration.cache && result.destroyed?
+          result
         end
       end
 

data/lib/acts_as_favoritor/favoritor_lib.rb

@@ -2,11 +2,11 @@
 
 module ActsAsFavoritor
   module FavoritorLib
-    def build_result_for_scopes(scopes)
+    def build_result_for_scopes(scopes, &block)
       return yield(scopes) unless scopes.is_a?(Array)
       return if scopes.empty?
 
-      sanitized_scopes(scopes).map { |scope| [scope, yield(scope)] }.to_h
+      sanitized_scopes(scopes).index_with(&block)
     end
 
     private

data/lib/acts_as_favoritor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActsAsFavoritor
-  VERSION = '5.0.1'
+  VERSION = '6.0.0'
 end

data/lib/generators/templates/migration.rb.erb

@@ -18,6 +18,10 @@ class ActsAsFavoritorMigration < ActiveRecord::Migration<%= migration_version %>
     add_index :favorites,
               ['favoritable_id', 'favoritable_type'],
               name: 'fk_favoritables'
+    add_index :favorites,
+              ['favoritable_type', 'favoritable_id', 'favoritor_type',
+              'favoritor_id', 'scope'],
+              name: 'uniq_favorites__and_favoritables', unique: true
   end
 
   def self.down

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_favoritor
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 6.0.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-06 00:00:00.000000000 Z
+date: 2022-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +94,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
@@ -128,7 +142,7 @@ description: acts_as_favoritor is a Rubygem to allow any ActiveRecord model to a
   and whatever else you can imagine through a single relationship. This is accomplished
   by a double polymorphic relationship on the Favorite model. There is also built
   in support for blocking/un-blocking favorite records as well as caching.
-email: me@jonhue.me
+email: jonas.huebotter@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -159,14 +173,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: A Rubygem to add Favorite, Follow, Vote, etc. functionality to ActiveRecord