acts_as_favoritor 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a2b31e850114a77b2f9784b5240e6f2a7a32256
-  data.tar.gz: fb8fea27d053678cf7640837788232af73d6501c
+  metadata.gz: daa9a52b6dc334d5f4f07afdd985c6f84059129a
+  data.tar.gz: a74b5698a4178853d6ca9d625b6bb7dde75a6abe
 SHA512:
-  metadata.gz: 4fae80a894f000d0cb63d0d97c43833afdf529c80b599318f9d3c3513b17b5950f5436eb328a82cce2c5830a294fe2bd88a1d0b70ed47d4c64ba0f27fddb7840
-  data.tar.gz: a7913c4206d756539eccb8da806f012f1b5213345100266ad08e71bc04cdc0328f3e99ac33e49d485eb2541a52c0615e9fd52eed45426678e503bd8e6fb67cca
+  metadata.gz: aec562b696eafde8da9b39ba22ac3a921bf133edcd8512e8f4ddca16ead6590a78438897f64c385f6236612e639ff74bd5a35ca8d30c7cf1af7c914382c1331a
+  data.tar.gz: 71428c34d2f78866cb3b4e8bc2deb4418f3840f91fd6b30898d2a91c57f0effad65dc26ddd3640b52ce8956acf02f24e84c90e37146de39437d3b1376b65cf4d

data/CHANGELOG.md

@@ -1,9 +1,22 @@
 # Changelog
 
-### unreleased
+### master
 
 * nothing yet
 
+### 1.2.0 - 2017-08-24
+
+* features
+    * add `blocked?` method to `acts_as_favoritor` model
+    * add `blocked?` method to `acts_as_favoritable` model
+    * add `favoritable_type` method to `acts_as_favoritor` model
+    * add `favoritor_type` method to `acts_as_favoritable` model
+    * add `blocks` method to `acts_as_favoritor` model
+    * add `block` method to `acts_as_favoritor` model
+    * add `unblock` method to `acts_as_favoritor` model
+    * add `blocked_favoritables_count` method to `acts_as_favoritor` model
+* minor bugfixes
+
 ### 1.1.3 - 2017-08-23
 
 * bugfixes

data/README.md

@@ -4,7 +4,7 @@
 
 `acts_as_favoritor` is a Rubygem to allow any ActiveRecord model to associate any other model including the option for multiple relationships per association with scopes.
 
-You are able to differentiate followers, favorites, watchers 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.
+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.
 
 ---
 
@@ -131,6 +131,24 @@ user.favorited_books_count
 # Returns the Arel scope for favorites.
 # This does not return the actual favorites, just the scope of favorited including the favoritables, essentially: `book.favorites.unblocked.includes(:favoritable)`.
 book.favorites_scoped
+
+# Block a favoritable
+user.block book
+
+# Unblock a favoritable
+user.unblock book
+
+# Whether `user` has blocked `book`. Returns `true` or `false`.
+user.blocked? book
+
+# Returns an array including all blocked Favoritable records.
+user.blocks
+
+# Total number of `user`'s favorites blocked.
+user.blocked_favoritables_count
+
+# Whether `user` has favorited, not favorited or blocked `book`. Returns `true`, `nil` or `false`.
+user.favoritable_type book
 ```
 
 These methods take an optional hash parameter of ActiveRecord options (`:limit`, `:order`, etc...)
@@ -161,7 +179,6 @@ book.favoritors_by_type_count 'User'
 # Returns the exact same as `book.favoritors_by_type_count 'User'`.
 book.count_user_favoritors
 
-To see is a model that acts_as_followable is followed by a model that acts_as_follower use the following
 # Whether `book` has been favorited by `user`. Returns `true` or `false`.
 book.favorited_by? user
 
@@ -171,11 +188,17 @@ book.block user
 # Unblock a favoritor
 book.unblock user
 
+# Whether `book` has blocked `user` as favoritor. Returns `true` or `false`.
+book.blocked? user
+
 # Returns an array including all blocked Favoritor records.
 book.blocks
 
 # Total number of `book`'s favoritors blocked.
 book.blocked_favoritors_count
+
+# Whether `user` has favorited, not favorited or blocked `book`. Returns `true`, `nil` or `false`.
+book.favoritor_type user
 ```
 
 These methods take an optional hash parameter of ActiveRecord options (`:limit`, `:order`, etc...)
@@ -206,7 +229,7 @@ Favorite.for_favoritable book
 
 ### Scopes
 
-Using scopes with `acts_as_favoritor` enables you to Follow, Watch, Favorite, [...] between any of your models. This way you can separate distinct functionalities in your app between user states. For example: A user sees all his favorited books in a dashboard (`'favorite'`), but he only receives notifications for those, he is watching (`'watch'`). Just like YouTube does it.
+Using scopes with `acts_as_favoritor` enables you to Follow, Watch, Favorite, [...] between any of your models. This way you can separate distinct functionalities in your app between user states. For example: A user sees all his favorited books in a dashboard (`'favorite'`), but he only receives notifications for those, he is watching (`'watch'`). Just like YouTube or GitHub do it. Options are endless. You could also integrate a voting / star system similar to YouTube or GitHub
 
 By default all of your favorites are scoped to `'favorite'`.
 

data/lib/acts_as_favoritor/favoritable.rb

@@ -166,6 +166,23 @@ module ActsAsFavoritor #:nodoc:
                 end
             end
 
+            # Returns true if the current instance has blocked the passed record
+            # Returns false if the current instance has not blocked the passed record
+            def blocked? favoritor, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritor
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes]
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = favorited.blocked.send(scope + '_list').for_favoritor(favoritor).first.present?
+                    end
+                    return results
+                else
+                    return favorited.blocked.send(options[:scope] + '_list').for_favoritor(favoritor).first.present?
+                end
+            end
+
             # Returns true if the current instance is favorited by the passed record
             # Returns false if the current instance is blocked by the passed record or no favorite is found
             def favorited_by? favoritor, options = {}
@@ -183,6 +200,36 @@ module ActsAsFavoritor #:nodoc:
                 end
             end
 
+            # Returns true if this instance has been favorited by the object passed as an argument.
+            # Returns nil if this instance has not been favorited by the object passed as an argument.
+            # Returns false if this instance has blocked the object passed as an argument.
+            def favoritor_type favoritor, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritor
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes]
+                    results = {}
+                    options[:scope].each do |scope|
+                        if favorited.unblocked.send(scope + '_list').for_favoritor(favoritor).first.present?
+                            results[scope] = true
+                        elsif favorited.blocked.send(scope + '_list').for_favoritor(favoritor).first.present?
+                            results[scope] = false
+                        else
+                            results[scope] = nil
+                        end
+                    end
+                    return results
+                else
+                    if favorited.unblocked.send(options[:scope] + '_list').for_favoritor(favoritor).first.present?
+                        return true
+                    elsif favorited.blocked.send(options[:scope] + '_list').for_favoritor(favoritor).first.present?
+                        return false
+                    else
+                        return nil
+                    end
+                end
+            end
+
             def block favoritor, options = {}
                 if options.has_key?(:multiple_scopes) == false
                     options[:parameter] = favoritor

data/lib/acts_as_favoritor/favoritor.rb

@@ -31,6 +31,52 @@ module ActsAsFavoritor #:nodoc:
                 end
             end
 
+            # Returns true if this instance has blocked the object passed as an argument.
+            def blocked? favoritable, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes]
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = 0 < Favorite.blocked.send(scope + '_list').for_favoritor(self).for_favoritable(favoritable).count
+                    end
+                    return results
+                else
+                    return 0 < Favorite.blocked.send(options[:scope] + '_list').for_favoritor(self).for_favoritable(favoritable).count
+                end
+            end
+
+            # Returns true if this instance has favorited the object passed as an argument.
+            # Returns nil if this instance has not favorited the object passed as an argument.
+            # Returns false if this instance has blocked the object passed as an argument.
+            def favorited_type favoritable, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes]
+                    results = {}
+                    options[:scope].each do |scope|
+                        if Favorite.unblocked.send(scope + '_list').for_favoritor(self).for_favoritable(favoritable).count > 0
+                            results[scope] = true
+                        elsif Favorite.blocked.send(scope + '_list').for_favoritor(self).for_favoritable(favoritable).count > 0
+                            results[scope] = false
+                        else
+                            results[scope] = nil
+                        end
+                    end
+                    return results
+                else
+                    if Favorite.unblocked.send(options[:scope] + '_list').for_favoritor(self).for_favoritable(favoritable).count > 0
+                        return true
+                    elsif Favorite.blocked.send(options[:scope] + '_list').for_favoritor(self).for_favoritable(favoritable).count > 0
+                        return false
+                    else
+                        return nil
+                    end
+                end
+            end
+
             # Returns the number of objects this instance has favorited.
             def favorites_count options = {}
                 if options.has_key?(:multiple_scopes) == false
@@ -77,13 +123,13 @@ module ActsAsFavoritor #:nodoc:
                 elsif options[:multiple_scopes]
                     results = {}
                     options[:scope].each do |scope|
-                        if favorite = get_favorite(favoritable)&.send(scope + '_list')
+                        if favorite = get_favorite(favoritable, scope: scope)
                             results[scope] = favorite.destroy
                         end
                     end
                     return results
                 else
-                    if favorite = get_favorite(favoritable)&.send(options[:scope] + '_list')
+                    if favorite = get_favorite(favoritable, scope: options[:scope])
                         return favorite.destroy
                     end
                 end
@@ -141,7 +187,17 @@ module ActsAsFavoritor #:nodoc:
 
             # Returns the actual records which this instance has favorited.
             def all_favorited options = {}
-                return all_favorites(options).collect{ |f| f.favoritable }
+                if options.has_key?(:multiple_scopes) == false
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes]
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = all_favorites(options).collect{ |f| f.favoritable }
+                    end
+                    return results
+                else
+                    return all_favorites(options).collect{ |f| f.favoritable }
+                end
             end
 
             # Returns the actual records of a particular type which this record has fovarited.
@@ -231,6 +287,100 @@ module ActsAsFavoritor #:nodoc:
                 end
             end
 
+            def blocks options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes]
+                    results = {}
+                    options[:scope].each do |scope|
+                        blocked_favoritors_scope = favoritables_scoped(scope: scope).blocked
+                        blocked_favoritors_scope = apply_options_to_scope blocked_favoritors_scope, options
+                        results[scope] = blocked_favoritors_scope.to_a.collect{ |f| f.favoritable }
+                    end
+                    return results
+                else
+                    blocked_favoritors_scope = favoritors_scoped(scope: options[:scope]).blocked
+                    blocked_favoritors_scope = apply_options_to_scope blocked_favoritors_scope, options
+                    return blocked_favoritors_scope.to_a.collect{ |f| f.favoritable }
+                end
+            end
+
+            def block favoritable, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes]
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = get_favorite(favoritable, scope: scope) ? block_existing_favorite(favoritable, scope: scope) : block_future_favorite(favoritable, scope: scope)
+                    end
+                    return results
+                else
+                    return get_favorite(favoritable, scope: options[:scope]) ? block_existing_favorite(favoritable, scope: options[:scope]) : block_future_favorite(favoritable, scope: options[:scope])
+                end
+            end
+
+            def unblock favoritable, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes]
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = get_favorite(favoritable, scope: scope)&.update_attribute :blocked, false
+                    end
+                    return results
+                else
+                    return get_favorite(favoritable, scope: options[:scope])&.update_attribute :blocked, false
+                end
+            end
+
+            def blocked_favoritables_count options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes]
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = favorites.blocked.send(scope + '_list').count
+                    end
+                    return results
+                else
+                    return favorites.blocked.send(options[:scope] + '_list').count
+                end
+            end
+
+            private
+
+            def block_future_favorite favoritable, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes]
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = Favorite.create favoritable: favoritable, favoritor: self, blocked: true, scope: scope
+                    end
+                    return results
+                else
+                    return Favorite.create favoritable: favoritable, favoritor: self, blocked: true, scope: options[:scope]
+                end
+            end
+
+            def block_existing_favorite favoritable, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes]
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = get_favorite(favoritable, scope: scope).block!
+                    end
+                    return results
+                else
+                    return get_favorite(favoritable, scope: options[:scope]).block!
+                end
+            end
+
         end
 
     end

data/lib/acts_as_favoritor/favoritor_lib.rb

@@ -37,7 +37,7 @@ module ActsAsFavoritor
         end
 
         def validate_scopes method, options = {}
-            options[:scope] = options[:scope] || ActsAsFavoritor.default_scope
+            options[:scope] = options[:scope] || [ActsAsFavoritor.default_scope]
             if options[:scope].size > 1
                 options[:multiple_scopes] = false # ?
             else

data/lib/acts_as_favoritor/version.rb

@@ -1,5 +1,5 @@
 module ActsAsFavoritor
 
-    VERSION = '1.1.3'
+    VERSION = '1.2.0'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_favoritor
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Jonas Hübotter