followability 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74981f3a807c733f78c36f78ebec08e18f9469415ca5fe500ba902a244f2490a
-  data.tar.gz: 49109e4a45692f73f206b3847610d0c725a8837b7a561d5f99b5641e6e53e89c
+  metadata.gz: 46c4bbdfdbae3003841116e1a71dae9c1573350a800c2bf4138031673cebe1a6
+  data.tar.gz: bc915022b767b6f945108d65442fefb42c72680b63e81649cff1dc315f6da0d8
 SHA512:
-  metadata.gz: cd0716f68c519a24544e47d9d88c21a1eb006485c99b92419cd166dcd847c9876e2b3fa3df968afd061e8ce3a13ff481893e8dd09f331aad47e045a505b5ab4b
-  data.tar.gz: 29b0bda4d267f4d8b34a1a5f438e64eb5135e775af9cb283815570e417fd35eb322e7e1b612062b3a2972fc58904b70c41bfe353d9f66cd12758f24277170fe2
+  metadata.gz: 3606b82feba15a46ba17284800f9a750279d1429fcbec0a679fa530f9ffbe97c4b8f11020ca572a977a82cc16fd2652e99694d5ee03ca28d5a7391545a7f8cbd
+  data.tar.gz: ea8d95ad732334a1576a44966c03da676e0966bf6ba79b9eba28394d63e2068c01392c88e8a056ce89cfd24cbaa8014d73100a520c555e1724b2567cd887af14

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    followability (0.1.0)
+    followability (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -47,6 +47,7 @@ Avaiable methods:
 - decline_follow_request_of
 - remove_follow_request_for
 - send_follow_request_to
+- unfollow
 - following?
 - mutual_following_with?
 - sent_follow_request_to?
@@ -71,36 +72,35 @@ Avaiable methods:
 @bar.errors.full_messages
 # => [...]
 
-@foo.remove_follow_request_for(@bar)
+@bar.unfollow(@foo)
 # => false
 
-@foo.errors.full_messages
+@bar.errors.full_messages
 # => [...]
 
-@foo.mutual_following_with?(@bar)
+@foo.remove_follow_request_for(@bar)
 # => false
 
 @foo.errors.full_messages
 # => [...]
 
-@bar.following?(@foo)
+@foo.mutual_following_with?(@bar)
 # => false
 
-@foo.errors.full_messages
-# => [...]
-
+@bar.following?(@foo)
+# => false
 ```
 
 ### Blocking actions
 Avaiable methods:
-- block_to
-- unblock_to
+- block
+- unblock
 - blocked?
 - blocked_by?
 
 ### Usage
 ```ruby
-@foo.block_to(@bar)
+@foo.block(@bar)
 # => true
 
 @foo.blocked?(@bar)
@@ -109,7 +109,7 @@ Avaiable methods:
 @bar.blocked_by?(@foo)
 # => true
 
-@foo.unblock_to(@bar)
+@foo.unblock(@bar)
 # => true
 ```
 
@@ -139,6 +139,7 @@ Avaiable methods:
 - followers
 - following
 - blocks
+- blockers
 
 ### Usage
 ```ruby
@@ -162,6 +163,9 @@ Avaiable methods:
 
 @foo.blocks
 # => [#<User ...>]
+
+@foo.blockers
+# => [#<User ...>]
 ```
 
 ### Callback Methods
@@ -178,6 +182,8 @@ Available methods:
 - followable_blocked_by_someone
 - followable_unblocked_by_me
 - followable_unblocked_by_someone
+- unfollowed_by_me
+- unfollowed_by_someone
 - followability_triggered
 
 ### Usage
@@ -188,6 +194,7 @@ class User < ActiveRecord::Base
   def follow_request_sent_to_me(record)
     Notifications::FollowRequestSentToMeJob.perform_later(from_id: record.id)
   end
+
   def follow_request_sent_to_someone(record); end
   def follow_request_accepted_by_me(record); end
   def follow_request_accepted_by_someone(record); end
@@ -199,6 +206,12 @@ class User < ActiveRecord::Base
   def followable_blocked_by_someone(record); end
   def followable_unblocked_by_me(record); end
   def followable_unblocked_by_someone(record); end
+  def unfollowed_by_me(record); end
+
+  def unfollowed_by_someone(record)
+    Followability::RemoveFollowedUserJob.perform_later(user_id: record.id)
+  end
+
   def followability_triggered(record, callback_name); end
 end
 ```
@@ -206,19 +219,21 @@ end
 ## I18n
 ```yml
 ---
----
 en:
   followability:
     errors:
       block:
-        unblock_to:
+        unblock:
           myself: 'You can not run this action for yourself'
-        block_to:
+        block:
           myself: 'You can not run this action for yourself'
           blocked_by: 'You can not block to who blocked to you'
           already_blocked: '%{klass} already blocked'
           not_blocked_for_blocking: 'You can not unblock to %{klass} because was not blocked'
       follow:
+        unfollow:
+          myself: 'You can not run this action for yourself'
+          empty_relation: 'You can not unfollow to %{klass} because was not followed'
         decline_follow_request_of:
           myself: 'You can not run this action for yourself'
           empty_relation: 'You can not decline follow request of %{klass} because was not sent'
@@ -236,6 +251,11 @@ en:
           blocked: 'You can not send follow request to blocked %{klass}'
 ```
 
+## Mentioned Youtube Video
+![Friend Request And Followers - Followability Gem | Ruby On Rails 7 Tutorial](docs/youtube-video.jpeg)
+
+You can watch [@Deanout](https://github.com/Deanout)'s [Friend Request And Followers - Followability Gem | Ruby On Rails 7 Tutorial Video](https://www.youtube.com/watch?v=UVa1QPaITQM) on Youtube.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/config/locales/en.yml

@@ -3,14 +3,17 @@ en:
   followability:
     errors:
       block:
-        unblock_to:
+        unblock:
           myself: 'You can not run this action for yourself'
-        block_to:
+        block:
           myself: 'You can not run this action for yourself'
           blocked_by: 'You can not block to who blocked to you'
           already_blocked: '%{klass} already blocked'
           not_blocked_for_blocking: 'You can not unblock to %{klass} because was not blocked'
       follow:
+        unfollow:
+          myself: 'You can not run this action for yourself'
+          empty_relation: 'You can not unfollow to %{klass} because was not followed'
         decline_follow_request_of:
           myself: 'You can not run this action for yourself'
           empty_relation: 'You can not decline follow request of %{klass} because was not sent'

data/lib/followability/followable/actions/block.rb

@@ -6,15 +6,15 @@ module Followability
       module Block
         I18N_SCOPE = 'followability.errors.block'
 
-        def block_to(record)
+        def block(record)
           if myself?(record)
-            errors.add(:base, I18n.t('block_to.myself', scope: I18N_SCOPE, klass: record.class))
+            errors.add(:base, I18n.t('block.myself', scope: I18N_SCOPE, klass: record.class))
 
             return false
           end
 
           if blocked_by?(record)
-            errors.add(:base, I18n.t('block_to.blocked_by', scope: I18N_SCOPE, klass: record.class))
+            errors.add(:base, I18n.t('block.blocked_by', scope: I18N_SCOPE, klass: record.class))
 
             return false
           end
@@ -40,9 +40,9 @@ module Followability
           end
         end
 
-        def unblock_to(record)
+        def unblock(record)
           if myself?(record)
-            errors.add(:base, I18n.t('unblock_to.myself', scope: I18N_SCOPE, klass: record.class))
+            errors.add(:base, I18n.t('unblock.myself', scope: I18N_SCOPE, klass: record.class))
 
             return false
           end

data/lib/followability/followable/actions/follow.rb

@@ -33,6 +33,35 @@ module Followability
           end
         end
 
+        def unfollow(record)
+          if myself?(record)
+            errors.add(:base, I18n.t('unfollow.myself', scope: I18N_SCOPE, klass: record.class))
+
+            return false
+          end
+
+          unless following?(record)
+            errors.add(:base, I18n.t('unfollow.not_following', scope: I18N_SCOPE, klass: record.class))
+
+            return false
+          end
+
+          relation = followerable_relationships.find_by(followable_id: record.id,
+                                                        followable_type: record.class.name,
+                                                        status: Followable::Relationship.statuses[:following])
+
+          if relation.destroy
+            run_callback(self, affected: record, callback: :unfollowed_by_me)
+            run_callback(record, affected: self, callback: :unfollowed_by_someone)
+
+            true
+          else
+            errors.add(:base, relation.errors.full_messages)
+
+            false
+          end
+        end
+
         def accept_follow_request_of(record)
           if myself?(record)
             errors.add(:base, I18n.t('accept_follow_request_of.myself', scope: I18N_SCOPE, klass: record.class))

data/lib/followability/followable/callbacks.rb

@@ -16,6 +16,8 @@ module Followability
         followable_blocked_by_someone
         followable_unblocked_by_me
         followable_unblocked_by_someone
+        unfollowed_by_me
+        unfollowed_by_someone
         followability_triggered
       ].freeze
 

data/lib/followability/followable.rb

@@ -6,7 +6,7 @@ module Followability
       false
     end
 
-    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/MethodLength, Metrics/BlockLength
     def followability
       class_eval do
         def self.followability?
@@ -43,6 +43,13 @@ module Followability
                  source: :followable,
                  class_name: name,
                  source_type: name
+
+        has_many :blockers,
+                 -> { Followability::Relationship.blocked },
+                 through: :followable_relationships,
+                 source: :followerable,
+                 class_name: name,
+                 source_type: name
       end
 
       include Followability::Followable::Associations
@@ -51,6 +58,6 @@ module Followability
       include Followability::Followable::Actions::Follow
       include Followability::Followable::Actions::Block
     end
-    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/MethodLength, Metrics/BlockLength
   end
 end

data/lib/followability/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: followability
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - nejdetkadir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-15 00:00:00.000000000 Z
+date: 2022-10-23 00:00:00.000000000 Z
 dependencies: []
 description: Implements the social network followable functionality for your Active
   Record models.
@@ -28,6 +28,7 @@ files:
 - README.md
 - Rakefile
 - config/locales/en.yml
+- docs/youtube-video.jpeg
 - followability.gemspec
 - lib/followability.rb
 - lib/followability/followable.rb