acts_as_favoritor 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 184296038ccc8938d320282f82c180549f13e810ce0d33d45e5999960efa437c
-  data.tar.gz: 7b4bbb4d41550563d65da40a205cee21ee9f27bb100c47d99e345140992d1b2f
+  metadata.gz: 688cadb90a8c8e5fb799d2973aaffa6345e756456640fdba0c3d9f44715b92c2
+  data.tar.gz: 3b9a838d6fdf2a011494ca5822ca8f54290738d1a81ddb82f36e051f8f3630cc
 SHA512:
-  metadata.gz: 1aeb504450b30f447c5beb3a480a3f26ab71a3d0786b853276a2e2ec8c4c9c6a87a4d25145ab31f954de3206062600a4e733baa7ac37fff9657bf6fe8bda0235
-  data.tar.gz: 5280a639b92064db05318f2a5b5a3158878e97bb16eb218d2e42f05436ab857e8bdf8fc3528c71f55e9d7d3386652046e8b8e460ecdf3cf7b0327f60dcb6cdca
+  metadata.gz: c1a3319925be822442579ec4d022b454b52649b5a95fa5949fdd7498420bb38038889136bb39c2da96f5511713a398eaf3a372a578ad4c8b6d1edd9089188ff5
+  data.tar.gz: 52f518e8ab2d8c66c6fdd47f3bc57329745c3cdf28bd1f3ac41b13b3214d4d8ce9bad2549415b3098326437ec2747d90baf99c27411973991adcc82755ac79e2

data/README.md

@@ -90,7 +90,7 @@ user = User.find(1)
 user.favorite(book)
 
 # `user` removes `book` from favorites.
-user.remove_favorite(book)
+user.unfavorite(book)
 
 # Whether `user` has marked `book` as his favorite. Returns `true` or `false`.
 user.favorited?(book)
@@ -110,17 +110,11 @@ user.favorited_by_type('Book')
 # Returns the exact same result as `user.favorited_by_type 'User'`.
 user.favorited_users
 
-# Block a favoritable
-user.block(book)
+# Whether `user` has been blocked by `book`. Returns `true` or `false`.
+user.blocked_by?(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
+# Returns an array including all blocked Favorite records.
+user.blocked_by
 ```
 
 These methods take an optional hash parameter of ActiveRecord options (`:limit`, `:order`, etc...)
@@ -152,7 +146,7 @@ book.unblock(user)
 book.blocked?(user)
 
 # Returns an array including all blocked Favoritor records.
-book.blocks
+book.blocked
 ```
 
 These methods take an optional hash parameter of ActiveRecord options (`:limit`, `:order`, etc...)
@@ -162,17 +156,11 @@ These methods take an optional hash parameter of ActiveRecord options (`:limit`,
 ### `Favorite` model
 
 ```ruby
-# Scopes
-## Returns all `Favorite` records where `blocked` is `false`.
+# Returns all `Favorite` records where `blocked` is `false`.
 Favorite.unblocked
-## Returns all `Favorite` records where `blocked` is `true`.
-Favorite.blocked
-## Returns an ordered array of the latest create `Favorite` records.
-Favorite.descending
 
-# Returns all `Favorite` records in an array, which have been created in a specified timeframe. Default is 2 weeks.
-Favorite.recent
-Favorite.recent(1.month.ago)
+# Returns all `Favorite` records where `blocked` is `true`.
+Favorite.blocked
 
 # Returns all favorites of `user`, including those who were blocked.
 Favorite.for_favoritor(user)
@@ -193,10 +181,9 @@ So lets see how this works:
 
 ```ruby
 user.favorite(book, scopes: [:favorite, :watching])
-user.remove_favorite(book, scopes: [:watching])
+user.unfavorite(book, scopes: [:watching])
 second_user = User.find(2)
 user.favorite(second_user, scopes: [:follow])
-book.block(user, scopes: [:all]) # applies to all scopes
 ```
 
 That's simple!
@@ -205,7 +192,7 @@ When you call a method which returns something while specifying multiple scopes,
 
 ```ruby
 user.favorited?(book, scopes: [:favorite, :watching]) # => { favorite: true, watching: false }
-user.favorited?(book, scopes: [:all]) # => true
+user.favorited?(book, scopes: [:favorite]) # => true
 ```
 
 `acts_as_favoritor` also provides some handy scopes for you to call on the `Favorite` model:
@@ -219,8 +206,6 @@ Favorite.send("#{my_scope}_list")
 Favorite.favorite_list
 ### Returns all `Favorite` records where `scope` is `watching`
 Favorite.watching_list
-### Very unnecessary, but `all_list` returns literally all `Favorite` records
-Favorite.all_list
 ```
 
 ### Caching

data/lib/acts_as_favoritor/configuration.rb

@@ -11,12 +11,15 @@ module ActsAsFavoritor
   end
 
   class Configuration
+    DEFAULT_SCOPE = :favorite
+    DEFAULT_CACHE = false
+
     attr_accessor :default_scope
     attr_accessor :cache
 
     def initialize
-      @default_scope = 'favorite'
-      @cache = false
+      @default_scope = DEFAULT_SCOPE
+      @cache         = DEFAULT_CACHE
     end
   end
 end

data/lib/acts_as_favoritor/favoritable.rb

@@ -16,8 +16,8 @@ module ActsAsFavoritor
         has_many :favorited, as: :favoritable, dependent: :destroy,
                              class_name: 'Favorite'
 
+        extend ActsAsFavoritor::FavoritorLib
         include ActsAsFavoritor::Favoritable::InstanceMethods
-        include ActsAsFavoritor::FavoritorLib
       end
     end
 
@@ -45,7 +45,7 @@ module ActsAsFavoritor
       end
 
       def favoritors(scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
+        self.class.build_result_for_scopes scopes do |scope|
           favorited.includes(:favoritor).unblocked.send("#{scope}_list")
                    .map(&:favoritor)
         end
@@ -54,7 +54,7 @@ module ActsAsFavoritor
       def favoritors_by_type(favoritor_type,
                              scopes: [ActsAsFavoritor.configuration
                                                      .default_scope])
-        build_result_for_scopes scopes do |scope|
+        self.class.build_result_for_scopes scopes do |scope|
           favorited.unblocked.send("#{scope}_list")
                    .for_favoritor_type(favoritor_type).map(&:favoritor)
         end
@@ -62,7 +62,7 @@ module ActsAsFavoritor
 
       def favorited_by?(favoritor,
                         scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
+        self.class.build_result_for_scopes scopes do |scope|
           favorited.unblocked.send("#{scope}_list").for_favoritor(favoritor)
                    .first.present?
         end
@@ -70,8 +70,8 @@ module ActsAsFavoritor
 
       def block(favoritor,
                 scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
-          get_favorite_for(favoritor, scope).block! || Favorite.create(
+        self.class.build_result_for_scopes scopes do |scope|
+          get_favorite_for(favoritor, scope)&.block! || Favorite.create(
             favoritable: self,
             favoritor: favoritor,
             blocked: true,
@@ -82,21 +82,21 @@ module ActsAsFavoritor
 
       def unblock(favoritor,
                   scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
+        self.class.build_result_for_scopes scopes do |scope|
           get_favorite_for(favoritor, scope)&.update(blocked: false)
         end
       end
 
       def blocked?(favoritor,
                    scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
+        self.class.build_result_for_scopes scopes do |scope|
           favorited.blocked.send("#{scope}_list").for_favoritor(favoritor).first
                    .present?
         end
       end
 
-      def blocks(scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
+      def blocked(scopes: [ActsAsFavoritor.configuration.default_scope])
+        self.class.build_result_for_scopes scopes do |scope|
           favorited.includes(:favoritor).blocked.send("#{scope}_list")
                    .map(&:favoritor)
         end

data/lib/acts_as_favoritor/favorite_scopes.rb

@@ -2,12 +2,11 @@
 
 module ActsAsFavoritor
   module FavoriteScopes
-    # Allows magic names on send(scope + '_list') - returns favorite records of
-    # certain scope.
-    # e.g. favoritors == favoritors.send('favorite_list')
+    DEFAULT_PARENTS = [ApplicationRecord, ActiveRecord::Base].freeze
+
     def method_missing(method, *args)
       if method.to_s[/(.+)_list/]
-        where(scope: $1.singularize)
+        where(scope: $1.singularize.to_sym)
       else
         super
       end
@@ -17,11 +16,6 @@ module ActsAsFavoritor
       super || method.to_s[/(.+)_list/]
     end
 
-    def all_list
-      all
-    end
-
-    # returns favorite records where favoritor is the record passed in.
     def for_favoritor(favoritor)
       where(
         favoritor_id: favoritor.id,
@@ -29,7 +23,6 @@ module ActsAsFavoritor
       )
     end
 
-    # returns favorite records where favoritable is the record passed in.
     def for_favoritable(favoritable)
       where(
         favoritable_id: favoritable.id,
@@ -37,34 +30,31 @@ module ActsAsFavoritor
       )
     end
 
-    # returns favorite records where favoritor_type is the record passed in.
     def for_favoritor_type(favoritor_type)
       where(favoritor_type: favoritor_type)
     end
 
-    # returns favorite records where favoritable_type is the record passed in.
     def for_favoritable_type(favoritable_type)
       where(favoritable_type: favoritable_type)
     end
 
-    # returns favorite records from past 2 weeks with default parameter.
-    def recent(from)
-      where('created_at > ?', (from || 2.weeks.ago).to_s(:db))
-    end
-
-    # returns favorite records in descending order.
-    def descending
-      order('favorites.created_at desc')
-    end
-
-    # returns unblocked favorite records.
     def unblocked
       where(blocked: false)
     end
 
-    # returns blocked favorite records.
     def blocked
       where(blocked: true)
     end
+
+    private
+
+    def parent_class_name(object)
+      if DEFAULT_PARENTS.include?(object.class.superclass) ||
+         !object.class.respond_to?(:base_class)
+        return object.class.name
+      end
+
+      object.class.base_class.name
+    end
   end
 end

data/lib/acts_as_favoritor/favoritor.rb

@@ -15,8 +15,8 @@ module ActsAsFavoritor
 
         has_many :favorites, as: :favoritor, dependent: :destroy
 
+        extend ActsAsFavoritor::FavoritorLib
         include ActsAsFavoritor::Favoritor::InstanceMethods
-        include ActsAsFavoritor::FavoritorLib
       end
     end
 
@@ -46,45 +46,43 @@ module ActsAsFavoritor
 
       def favorite(favoritable,
                    scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
-          return if self == favoritable
-          return if scope == :all
+        self.class.build_result_for_scopes scopes do |scope|
+          return nil if self == favoritable
 
           inc_cache if ActsAsFavoritor.configuration.cache
 
-          favorites.where(
-            favoritable_id: favoritable.id,
-            favoritable_type: parent_class_name(favoritable),
-            scope: scope
-          ).first_or_create!
+          favorites.for_favoritable(favoritable).send("#{scope}_list")
+                   .first_or_create!
         end
       end
 
-      def remove_favorite(favoritable,
-                          scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
-          dec_cache if ActsAsFavoritor.configuration.cache
+      def unfavorite(favoritable,
+                     scopes: [ActsAsFavoritor.configuration.default_scope])
+        self.class.build_result_for_scopes scopes do |scope|
+          favorite_record = get_favorite(favoritable, scope)
+          return nil unless favorite_record.present?
 
-          get_favorite(favoritable, scope)&.destroy
+          dec_cache if ActsAsFavoritor.configuration.cache
+          favorite_record.destroy!
         end
       end
 
       def favorited?(favoritable,
                      scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
+        self.class.build_result_for_scopes scopes do |scope|
           Favorite.unblocked.send("#{scope}_list").for_favoritor(self)
                   .for_favoritable(favoritable).size.positive?
         end
       end
 
       def all_favorites(scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
+        self.class.build_result_for_scopes scopes do |scope|
           favorites.unblocked.send("#{scope}_list")
         end
       end
 
       def all_favorited(scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
+        self.class.build_result_for_scopes scopes do |scope|
           favorites.unblocked.send("#{scope}_list").includes(:favoritable)
                    .map(&:favoritable)
         end
@@ -93,8 +91,8 @@ module ActsAsFavoritor
       def favorites_by_type(favoritable_type,
                             scopes: [ActsAsFavoritor.configuration
                                                     .default_scope])
-        build_result_for_scopes scopes do |scope|
-          favorites.unblocked.send("#{scope}_list").includes(:favoritable)
+        self.class.build_result_for_scopes scopes do |scope|
+          favorites.unblocked.send("#{scope}_list")
                    .for_favoritable_type(favoritable_type)
         end
       end
@@ -102,41 +100,22 @@ module ActsAsFavoritor
       def favorited_by_type(favoritable_type,
                             scopes: [ActsAsFavoritor.configuration
                                                     .default_scope])
-        build_result_for_scopes scopes do |scope|
-          favorites.unblocked.send("#{scope}_list")
+        self.class.build_result_for_scopes scopes do |scope|
+          favorites.unblocked.send("#{scope}_list").includes(:favoritable)
                    .for_favoritable_type(favoritable_type).map(&:favoritable)
         end
       end
 
-      def block(favoritable,
-                scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
-          get_favorite(favoritable, scope).block! || Favorite.create(
-            favoritable: favoritable,
-            favoritor: self,
-            blocked: true,
-            scope: scope
-          )
-        end
-      end
-
-      def unblock(favoritable,
-                  scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
-          get_favorite(favoritable, scope)&.update(blocked: false)
-        end
-      end
-
-      def blocked?(favoritable,
-                   scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
+      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)
                   .for_favoritable(favoritable).size.positive?
         end
       end
 
-      def blocks(scopes: [ActsAsFavoritor.configuration.default_scope])
-        build_result_for_scopes scopes do |scope|
+      def blocked_by(scopes: [ActsAsFavoritor.configuration.default_scope])
+        self.class.build_result_for_scopes scopes do |scope|
           favorites.includes(:favoritable).blocked.send("#{scope}_list")
                    .map(&:favoritable)
         end

data/lib/acts_as_favoritor/favoritor_lib.rb

@@ -2,19 +2,6 @@
 
 module ActsAsFavoritor
   module FavoritorLib
-    private
-
-    DEFAULT_PARENTS = [ApplicationRecord, ActiveRecord::Base].freeze
-
-    # Retrieves the parent class name if using STI.
-    def parent_class_name(obj)
-      unless DEFAULT_PARENTS.include? obj.class.superclass
-        return obj.class.base_class.name
-      end
-
-      obj.class.name
-    end
-
     def build_result_for_scopes(scopes)
       return if scopes.empty?
 
@@ -26,6 +13,8 @@ module ActsAsFavoritor
       result
     end
 
+    private
+
     def sanitized_scopes(scopes)
       scopes.map(&:to_sym)
     end

data/lib/acts_as_favoritor/version.rb

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

data/lib/generators/templates/initializer.rb

@@ -2,7 +2,7 @@
 
 ActsAsFavoritor.configure do |config|
   # Specify your default scope. Learn more about scopes here: https://github.com/jonhue/acts_as_favoritor#scopes
-  # config.default_scope = 'favorite'
+  # config.default_scope = :favorite
 
   # Enable caching. Learn more about caching here: https://github.com/jonhue/acts_as_favoritor#caching
   # config.cache = false

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

@@ -5,13 +5,19 @@ class ActsAsFavoritorMigration < ActiveRecord::Migration<%= migration_version %>
     create_table :favorites, force: true do |t|
       t.references :favoritable, polymorphic: true, null: false
       t.references :favoritor, polymorphic: true, null: false
-      t.string :scope, default: ActsAsFavoritor.configuration.default_scope, null: false, index: true
+      t.string :scope, default: ActsAsFavoritor.configuration.default_scope,
+                       null: false,
+                       index: true
       t.boolean :blocked, default: false, null: false, index: true
       t.timestamps
     end
 
-    add_index :favorites, ['favoritor_id', 'favoritor_type'], name: 'fk_favorites'
-    add_index :favorites, ['favoritable_id', 'favoritable_type'], name: 'fk_favoritables'
+    add_index :favorites,
+              ['favoritor_id', 'favoritor_type'],
+              name: 'fk_favorites'
+    add_index :favorites,
+              ['favoritable_id', 'favoritable_type'],
+              name: 'fk_favoritables'
   end
 
   def self.down

data/lib/generators/templates/model.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
 class Favorite < ApplicationRecord
-  extend ActsAsFavoritor::FavoritorLib
   extend ActsAsFavoritor::FavoriteScopes
 
   belongs_to :favoritable, polymorphic: true
   belongs_to :favoritor, polymorphic: true
 
   def block!
-    update(blocked: true)
+    update!(blocked: true)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_favoritor
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-04 00:00:00.000000000 Z
+date: 2019-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord