acts_as_favoritor 4.0.3 → 5.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45ca952d9906033e84ecc6ff24aca3934457d803c51f979d59c561847b1d61d6
-  data.tar.gz: 941c85b77b52b66360a6ba7df70227c2e7cc32fc5fe0230f6191e2d20e6afd3e
+  metadata.gz: c785314efa34b1f88cfee3d6c39acef924fb989e6a2654c65241a07facd707b0
+  data.tar.gz: 28dfbd0a05eab1723e871df1aec6657aabae38875402f03f5f2347ccedb7bc22
 SHA512:
-  metadata.gz: bae098e81f7b219469fd3e2a18446914f46fe9ba65edc58f8f36ecd1ade9393f9a877ea8b96795abb4bd7324357fac01bdf2910a630a58828b9c5a984914076c
-  data.tar.gz: 0adfa2859658a591c472279295197c7c97bf3af1157210e992fafa384fc0dd083c6e7f3b791395b84e0638b25ff25c8ab25a20ee04996ec1975fe75df0b0b1f1
+  metadata.gz: af2a517dc943fa69ea7d5442beced5d086a31a9586e1587fecf4ae3c0ad57ab9579099731ec5d92e794075b3d804e0facf7605fa196cdb3531edfb1f4d9855d0
+  data.tar.gz: 5e19c65f8f122686cf452f3690f18856e0e235d443e0772c8e4c4468d1b43bea2a46653e495f68d18dc0591ac6e725c2f53f8e3de7cbc5f6ddc0c2b89b9664a4

data/README.md

@@ -4,38 +4,19 @@ 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.
 
----
-
-## Table of Contents
-
-* [Installation](#installation)
-* [Usage](#usage)
-  * [Setup](#setup)
-  * [`acts_as_favoritor` methods](#acts_as_favoritor-methods)
-  * [`acts_as_favoritable` methods](#acts_as_favoritable-methods)
-  * [`Favorite` model](#favorite-model)
-  * [Scopes](#scopes)
-  * [Caching](#caching)
-* [Configuration](#configuration)
-* [Testing](#testing)
-* [Release](#release)
-* [To do](#to-do)
-* [Contributing](#contributing)
-  * [Semantic versioning](#semantic-versioning)
-
----
+[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
 
-acts_as_favoritor works with Rails 5.0 onwards. You can add it to your `Gemfile` with:
+You can add acts_as_favoritor to your `Gemfile` with:
 
 ```ruby
 gem 'acts_as_favoritor'
 ```
 
-And then execute:
+And then run:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -166,24 +147,25 @@ 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` as an option which expexts an array containing your scopes as strings.
+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.
 
 So lets see how this works:
 
 ```ruby
 user.favorite(book, scopes: [:favorite, :watching])
-user.unfavorite(book, scopes: [:watching])
+user.unfavorite(book, scope: :watching)
 second_user = User.find(2)
-user.favorite(second_user, scopes: [:follow])
+user.favorite(second_user, scope: :follow)
 ```
 
 That's simple!
 
-When you call a method which returns something while specifying multiple scopes, the method returns the results in a hash with the scopes as keys:
+When you call a method which returns something while specifying multiple scopes, the method returns the results in a hash with the scopes as keys when scopes are given as an array:
 
 ```ruby
 user.favorited?(book, scopes: [:favorite, :watching]) # => { favorite: true, watching: false }
-user.favorited?(book, scopes: [:favorite]) # => true
+user.favorited?(book, scopes: [:favorite]) # => { favorite: true }
+user.favorited?(book, scope: :favorite) # => true
 ```
 
 `acts_as_favoritor` also provides some handy scopes for you to call on the `Favorite` model:
@@ -242,7 +224,7 @@ 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
 
@@ -258,51 +240,41 @@ end
 
 **`cache`** Whether `acts_as_favoritor` uses caching or not. Takes a boolean. Defaults to `false`. Learn more about caching [here](#caching).
 
----
+## Development
 
-## Testing
+To start development you first have to fork this repository and locally clone your fork.
 
-1. Fork this repository
-2. Clone your forked git locally
-3. Install dependencies
+Install the projects dependencies by running:
 
-    `$ bundle install`
+    $ bundle install
 
-4. Run tests
+### Testing
 
-    `$ bundle exec rspec`
+Tests are written with RSpec and can be found in `/spec`.
 
-5. Run RuboCop
+To run tests:
 
-    `$ bundle exec rubocop`
+    $ bundle exec rspec
 
----
+To run RuboCop:
 
-## Release
+    $ bundle exec rubocop
 
-1. Review breaking changes and deprecations in `CHANGELOG.md`
-2. Change the gem version in `lib/acts_as_favoritor/version.rb`
-3. Reset `CHANGELOG.md`
-4. Create a pull request to merge the changes into `master`
-5. After the pull request was merged, create a new release listing the breaking changes and commits on `master` since the last release.
-6. The release workflow will publish the gems to RubyGems and the GitHub Package Registry
-
----
-
-## To do
-
-We use [GitHub projects](https://github.com/jonhue/acts_as_favoritor/projects/1) to coordinate the work on this project.
-
-To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/acts_as_favoritor/issues/new).
+## Contributing
 
----
+We warmly welcome everyone who is intersted in contributing. Please reference our [contributing guidelines](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md).
 
-## Contributing
+## Releases
 
-We hope that you will consider contributing to acts_as_favoritor. Please read this short overview for some information about how to get started:
+[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).
 
-[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+acts_as_favoritor follows Semantic Versioning 2.0 as defined at http://semver.org. Reference our [security policy](SECURITY.md).
 
-### Semantic Versioning
+### Publishing
 
-acts_as_favoritor follows Semantic Versioning 2.0 as defined at http://semver.org.
+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 `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/configuration.rb

@@ -14,8 +14,7 @@ module ActsAsFavoritor
     DEFAULT_SCOPE = :favorite
     DEFAULT_CACHE = false
 
-    attr_accessor :default_scope
-    attr_accessor :cache
+    attr_accessor :cache, :default_scope
 
     def initialize
       @default_scope = DEFAULT_SCOPE

data/lib/acts_as_favoritor/favoritable.rb

@@ -44,37 +44,39 @@ module ActsAsFavoritor
           method.to_s[/favoritable_(.+)_total/]
       end
 
-      def favoritors(scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          favorited.includes(:favoritor).unblocked.send("#{scope}_list")
+      def favoritors(scope: ActsAsFavoritor.configuration.default_scope,
+                     scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          favorited.includes(:favoritor).unblocked.send("#{s}_list")
                    .map(&:favoritor)
         end
       end
 
       def favoritors_by_type(favoritor_type,
-                             scopes: [ActsAsFavoritor.configuration
-                                                     .default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
+                             scope: ActsAsFavoritor.configuration.default_scope,
+                             scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
           favoritor_type.constantize.includes(:favorites)
                         .where(favorites: {
                                  blocked: false, favoritable_id: id,
-                                 favoritable_type: self.class.name, scope: scope
+                                 favoritable_type: self.class.name, scope: s
                                })
         end
       end
 
       def favorited_by?(favoritor,
-                        scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          favorited.unblocked.send("#{scope}_list").for_favoritor(favoritor)
+                        scope: ActsAsFavoritor.configuration.default_scope,
+                        scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          favorited.unblocked.send("#{s}_list").for_favoritor(favoritor)
                    .first.present?
         end
       end
 
-      def block(favoritor,
-                scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          get_favorite_for(favoritor, scope)&.block! || Favorite.create(
+      def block(favoritor, scope: ActsAsFavoritor.configuration.default_scope,
+                scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          get_favorite_for(favoritor, s)&.block! || Favorite.create(
             favoritable: self,
             favoritor: favoritor,
             blocked: true,
@@ -83,24 +85,26 @@ module ActsAsFavoritor
         end
       end
 
-      def unblock(favoritor,
-                  scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          get_favorite_for(favoritor, scope)&.update(blocked: false)
+      def unblock(favoritor, scope: ActsAsFavoritor.configuration.default_scope,
+                  scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          get_favorite_for(favoritor, s)&.update(blocked: false)
         end
       end
 
       def blocked?(favoritor,
-                   scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          favorited.blocked.send("#{scope}_list").for_favoritor(favoritor).first
+                   scope: ActsAsFavoritor.configuration.default_scope,
+                   scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          favorited.blocked.send("#{s}_list").for_favoritor(favoritor).first
                    .present?
         end
       end
 
-      def blocked(scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          favorited.includes(:favoritor).blocked.send("#{scope}_list")
+      def blocked(scope: ActsAsFavoritor.configuration.default_scope,
+                  scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          favorited.includes(:favoritor).blocked.send("#{s}_list")
                    .map(&:favoritor)
         end
       end

data/lib/acts_as_favoritor/favoritor.rb

@@ -45,81 +45,90 @@ module ActsAsFavoritor
       end
 
       def favorite(favoritable,
-                   scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
+                   scope: ActsAsFavoritor.configuration.default_scope,
+                   scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
           return nil if self == favoritable
 
-          inc_cache(favoritable, scope) if ActsAsFavoritor.configuration.cache
-
-          favorites.for_favoritable(favoritable).send("#{scope}_list")
-                   .first_or_create!
+          favorites.for_favoritable(favoritable).send("#{s}_list")
+                   .first_or_create! do |new_record|
+            inc_cache(favoritable, s) if ActsAsFavoritor.configuration.cache
+            new_record
+          end
         end
       end
 
       def unfavorite(favoritable,
-                     scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          favorite_record = get_favorite(favoritable, scope)
+                     scope: ActsAsFavoritor.configuration.default_scope,
+                     scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          favorite_record = get_favorite(favoritable, s)
           return nil unless favorite_record.present?
 
-          dec_cache(favoritable, scope) if ActsAsFavoritor.configuration.cache
-          favorite_record.destroy!
+          result = favorite_record.destroy!
+          dec_cache(favoritable, s) if ActsAsFavoritor.configuration.cache && result.destroyed?
+          result
         end
       end
 
       def favorited?(favoritable,
-                     scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          Favorite.unblocked.send("#{scope}_list").for_favoritor(self)
+                     scope: ActsAsFavoritor.configuration.default_scope,
+                     scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          Favorite.unblocked.send("#{s}_list").for_favoritor(self)
                   .for_favoritable(favoritable).size.positive?
         end
       end
 
-      def all_favorites(scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          favorites.unblocked.send("#{scope}_list")
+      def all_favorites(scope: ActsAsFavoritor.configuration.default_scope,
+                        scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          favorites.unblocked.send("#{s}_list")
         end
       end
 
-      def all_favorited(scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          favorites.unblocked.send("#{scope}_list").includes(:favoritable)
+      def all_favorited(scope: ActsAsFavoritor.configuration.default_scope,
+                        scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          favorites.unblocked.send("#{s}_list").includes(:favoritable)
                    .map(&:favoritable)
         end
       end
 
       def favorites_by_type(favoritable_type,
-                            scopes: [ActsAsFavoritor.configuration
-                                                    .default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          favorites.unblocked.send("#{scope}_list")
+                            scope: ActsAsFavoritor.configuration.default_scope,
+                            scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          favorites.unblocked.send("#{s}_list")
                    .for_favoritable_type(favoritable_type)
         end
       end
 
       def favorited_by_type(favoritable_type,
-                            scopes: [ActsAsFavoritor.configuration
-                                                    .default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
+                            scope: ActsAsFavoritor.configuration.default_scope,
+                            scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
           favoritable_type.constantize.includes(:favorited)
                           .where(favorites: {
                                    blocked: false, favoritor_id: id,
-                                   favoritor_type: self.class.name, scope: scope
+                                   favoritor_type: self.class.name, scope: s
                                  })
         end
       end
 
       def blocked_by?(favoritable,
-                      scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          Favorite.blocked.send("#{scope}_list").for_favoritor(self)
+                      scope: ActsAsFavoritor.configuration.default_scope,
+                      scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          Favorite.blocked.send("#{s}_list").for_favoritor(self)
                   .for_favoritable(favoritable).size.positive?
         end
       end
 
-      def blocked_by(scopes: [ActsAsFavoritor.configuration.default_scope])
-        self.class.build_result_for_scopes scopes do |scope|
-          favorites.includes(:favoritable).blocked.send("#{scope}_list")
+      def blocked_by(scope: ActsAsFavoritor.configuration.default_scope,
+                     scopes: nil)
+        self.class.build_result_for_scopes(scopes || scope) do |s|
+          favorites.includes(:favoritable).blocked.send("#{s}_list")
                    .map(&:favoritable)
         end
       end
@@ -151,9 +160,7 @@ module ActsAsFavoritor
 
         favoritable.favoritable_score[scope] =
           (favoritable.favoritable_score[scope] || 0) - 1
-        unless favoritable.favoritable_score[scope].positive?
-          favoritable.favoritable_score.delete(scope)
-        end
+        favoritable.favoritable_score.delete(scope) unless favoritable.favoritable_score[scope].positive?
         favoritable.save!
       end
       # rubocop:enable Metrics/AbcSize

data/lib/acts_as_favoritor/favoritor_lib.rb

@@ -3,14 +3,10 @@
 module ActsAsFavoritor
   module FavoritorLib
     def build_result_for_scopes(scopes)
+      return yield(scopes) unless scopes.is_a?(Array)
       return if scopes.empty?
 
-      scopes = sanitized_scopes(scopes)
-      result = scopes.map { |scope| [scope, yield(scope)] }.to_h
-
-      return result[scopes.first] if scopes.size == 1
-
-      result
+      sanitized_scopes(scopes).map { |scope| [scope, yield(scope)] }.to_h
     end
 
     private

data/lib/acts_as_favoritor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActsAsFavoritor
-  VERSION = '4.0.3'
+  VERSION = '5.0.3'
 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: 4.0.3
+  version: 5.0.3
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -128,7 +128,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: []
@@ -166,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: A Rubygem to add Favorite, Follow, Vote, etc. functionality to ActiveRecord