@@ -3,7 +3,8 @@ class ActsAsFollowerMigration < ActiveRecord::Migration create_table :follows, :force => true do |t| t.references :followable, :polymorphic => true, :null => false t.references :follower, :polymorphic => true, :null => false - t.timestamps + t.boolean :blocked, :default => false, :null => false + t.timestamps end add_index :follows, ["follower_id", "follower_type"], :name => "fk_follows" generators/acts_as_follower_migration/templates/migration.rb @@ -23,21 +23,53 @@ module ActiveRecord #:nodoc: # Returns the number of followers a record has. def followers_count - self.followings.count + self.followings.unblocked.count + end + + def blocked_followers_count + self.followings.blocked.count end # Returns the following records. def followers - self.followings.all(:include => [:follower]).collect {|f| f.follower } + self.followings.unblocked.all(:include => [:follower]).collect{|f| f.follower} + end + + def blocks + self.followings.blocked.all(:include => [:follower]).collect{|f| f.follower} end - # Returns true if the current instance is followed by the passed record. + # Returns true if the current instance is followed by the passed record + # Returns false if the current instance is blocked by the passed record or no follow is found def followed_by?(follower) - Follow.find(:first, :conditions => ["followable_id = ? AND followable_type = ? AND follower_id = ? AND follower_type = ?", self.id, parent_class_name(self), follower.id, parent_class_name(follower)]) ? true : false + f = get_follow_for(follower) + (f && !f.blocked?) ? true : false + end + + def block(follower) + get_follow_for(follower) ? block_existing_follow(follower) : block_future_follow(follower) + end + + def unblock(follower) + get_follow_for(follower).try(:delete) + end + + private + + def get_follow_for(follower) + Follow.find(:first, :conditions => ["followable_id = ? AND followable_type = ? AND follower_id = ? AND follower_type = ?", self.id, parent_class_name(self), follower.id, parent_class_name(follower)]) end + + def block_future_follow(follower) + follows.create(:followable => self, :follower => follower, :blocked => true) + end + + def block_existing_follow(follower) + get_follow_for(follower).block! + end end end end -end +end lib/acts_as_followable.rb @@ -22,7 +22,7 @@ module ActiveRecord #:nodoc: # Returns true if this instance is following the object passed as an argument. def following?(followable) - 0 < Follow.count(:all, :conditions => [ + 0 < Follow.unblocked.count(:all, :conditions => [ "follower_id = ? AND follower_type = ? AND followable_id = ? AND followable_type = ?", self.id, parent_class_name(self), followable.id, parent_class_name(followable) ]) @@ -30,7 +30,7 @@ module ActiveRecord #:nodoc: # Returns the number of objects this instance is following. def follow_count - Follow.count(:all, :conditions => ["follower_id = ? AND follower_type = ?", self.id, parent_class_name(self)]) + Follow.unblocked.count(:all, :conditions => ["follower_id = ? AND follower_type = ?", self.id, parent_class_name(self)]) end # Creates a new follow record for this instance to follow the passed object. @@ -52,12 +52,12 @@ module ActiveRecord #:nodoc: # Returns the follow records related to this instance by type. def follows_by_type(followable_type) - Follow.find(:all, :include => [:followable], :conditions => ["follower_id = ? AND follower_type = ? AND followable_type = ?", self.id, parent_class_name(self), followable_type]) + Follow.unblocked.find(:all, :include => [:followable], :conditions => ["follower_id = ? AND follower_type = ? AND followable_type = ?", self.id, parent_class_name(self), followable_type]) end # Returns the follow records related to this instance with the followable included. def all_follows - self.follows.all(:include => :followable) + self.follows.unblocked.all(:include => :followable) end # Returns the actual records which this instance is following. @@ -84,7 +84,7 @@ module ActiveRecord #:nodoc: # Returns a follow record for the current instance and followable object. def get_follow(followable) - Follow.find(:first, :conditions => ["follower_id = ? AND follower_type = ? AND followable_id = ? AND followable_type = ?", self.id, parent_class_name(self), followable.id, parent_class_name(followable)]) + Follow.unblocked.find(:first, :conditions => ["follower_id = ? AND follower_type = ? AND followable_id = ? AND followable_type = ?", self.id, parent_class_name(self), followable.id, parent_class_name(followable)]) end end lib/acts_as_follower.rb @@ -4,9 +4,16 @@ class Follow < ActiveRecord::Base named_scope :for_followable, lambda { |*args| {:conditions => ["followable_id = ? AND followable_type = ?", args.first.id, args.first.type.name]} } named_scope :recent, lambda { |*args| {:conditions => ["created_at > ?", (args.first || 2.weeks.ago).to_s(:db)]} } named_scope :descending, :order => "created_at DESC" + named_scope :unblocked, :conditions => {:blocked => false} + named_scope :blocked, :conditions => {:blocked => true} # NOTE: Follows belong to the "followable" interface, and also to followers belongs_to :followable, :polymorphic => true belongs_to :follower, :polymorphic => true + def block! + self.update_attribute(:blocked, true) + end + end + lib/follow.rb @@ -71,7 +71,69 @@ class ActsAsFollowableTest < Test::Unit::TestCase should_change("follow count", :by => -1) { Follow.count } should_change("@sam.all_following.size", :by => -1) { @sam.all_following.size } - end + end + + context "blocking a follower" do + setup do + @jon.block(@sam) + end + + should "remove him from followers" do + assert_equal 0, @jon.followers_count + end + + should "add him to the blocked followers" do + assert_equal 1, @jon.blocked_followers_count + end + + should "not be able to follow again" do + assert_equal 0, @jon.followers_count + end + + should "not be present when listing followers" do + assert_equal [], @jon.followers + end + + should "be in the list of blocks" do + assert_equal [@sam], @jon.blocks + end + end + + context "unblocking a blocked follow" do + setup do + @jon.block(@sam) + @jon.unblock(@sam) + end + + should "not include the unblocked user in the list of followers" do + assert_equal [], @jon.followers + end + + should "remove him from the blocked followers" do + assert_equal 0, @jon.blocked_followers_count + assert_equal [], @jon.blocks + end + end + + context "unblock a non-existent follow" do + setup do + @sam.stop_following(@jon) + @jon.unblock(@sam) + end + + should "not be in the list of followers" do + assert_equal [], @jon.followers + end + + should "not be in the blockked followers count" do + assert_equal 0, @jon.blocked_followers_count + end + + should "not be in the blocks list" do + assert_equal [], @jon.blocks + end + end + end end test/acts_as_followable_test.rb @@ -121,6 +121,29 @@ class ActsAsFollowerTest < Test::Unit::TestCase should_change("Follow.count", :by => -1) { Follow.count } should_change("@sam.follow_count", :by => -1) { @sam.follow_count } + end + + context "blocked by followable" do + setup do + @jon.block(@sam) + end + + should "return following_status" do + assert_equal false, @sam.following?(@jon) + end + + should "return follow_count" do + assert_equal 1, @sam.follow_count + end + + should "not return record of the blocked follows" do + assert_equal 1, @sam.all_follows.size + assert !@sam.all_follows.include?(@user_follow) + assert !@sam.all_following.include?(@jon) + assert_equal [], @sam.following_by_type('User') + assert_equal [], @sam.follows_by_type('User') + assert_equal [], @sam.following_users + end end end test/acts_as_follower_test.rb @@ -5,6 +5,7 @@ ActiveRecord::Schema.define :version => 0 do t.string "followable_type", :null => false t.integer "follower_id", :null => false t.string "follower_type", :null => false + t.boolean "blocked", :default => false, :null => false t.datetime "created_at" t.datetime "updated_at" end @@ -17,4 +18,4 @@ ActiveRecord::Schema.define :version => 0 do t.column :name, :string end -end \ No newline at end of file +end test/schema.rb 6307f0eb5d3371e85ccbf732f565de170ddc222b Tom Cocca tom.cocca@gmail.com http://github.com/tcocca/acts_as_follower/commit/112230742b1c8cea6e2f42496be5d95f7931fb3d 112230742b1c8cea6e2f42496be5d95f7931fb3d 2009-11-08T16:37:08-08:00 2009-11-08T16:37:08-08:00 Added the ability to block followers, unblocking a follower removes any record of the follow 98b464d6385fc5f1dcab6b9ae0f1e0efb20ce178 Tom Cocca tom.cocca@gmail.com