partisan 0.1.1 → 0.2

data/README.md

@@ -11,7 +11,7 @@ It’s heavily inspired by `acts_as_follower`. However, it’s not 100% compatib
 But I also added awesome new ones:
 
 * You can use `following_team_ids` but also `following_team_names` (basically any `following_team_<column>s`). It takes advantage of the `pluck` method, so it doesn’t create an instance of each follower, it just return the relevant column values. (Go check `pluck` documentation, it’s simply awesome).
-* The `followers` and `followings` mthods now return an `ActiveRecord::Relation` for easy chaining, scoping, counting, pagination, etc.
+* The `followers` and `followings` methods now return an `ActiveRecord::Relation` for easy chaining, scoping, counting, pagination, etc.
 
 ## Installation
 
@@ -65,6 +65,8 @@ fan.following?(band)
 # => false
 ```
 
+### Cache counters
+
 Most of the times, you would want to get a quick look at about how many fans follow a certain resource. That could be an expensive operation.
 
 However, if the *followed* record has a `followers_count` column, Partisan will populate its value with how many followers the record has.
@@ -81,6 +83,52 @@ band.followers_count
 
 The same concept applies to `followable` with a `following_count` column.
 
+### Callbacks
+
+You can define callbacks that will be triggered before or after a following relationship is created.
+
+If a `before_follow` callback returns `false`, it will halt the call and the relationship will be not be saved (much like `ActiveRecords`’s `before_save` callbacks).
+
+```ruby
+class Fan < ActiveRecord::Base
+  acts_as_follower
+  after_follow :send_notification
+
+  def send_notification
+    puts "#{self} is now following #{self.just_followed}"
+  end
+end
+
+class Band < ActiveRecord::Base
+  acts_as_followable
+  before_follow :ensure_active_fan
+
+  def ensure_active_fan
+    self.about_to_be_followed_by.active?
+  end
+end
+```
+
+The available callbacks are:
+
+#### Follower
+
+| Callback          | Reference to the followable |
+| ------------------|-----------------------------|
+| `before_follow`   | `self.about_to_follow`      |
+| `after_follow`    | `self.just_followed`        |
+| `before_unfollow` | `self.about_to_unfollow`    |
+| `after_unfollow`  | `self.just_unfollowed`      |
+
+#### Followable
+
+| Callback          | Reference to the follower        |
+| ------------------|----------------------------------|
+| `before_follow`   | `self.about_to_be_followed_by`   |
+| `after_follow`    | `self.just_followed_by`          |
+| `before_unfollow` | `self.about_to_by_unfollowed_by` |
+| `after_unfollow`  | `self.just_unfollowed_by`        |
+
 ## License
 
 `Partisan` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/partisan/blob/master/LICENSE.md) file.

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

@@ -7,8 +7,8 @@ class AddFollowsMigration < ActiveRecord::Migration
       t.timestamps
     end
 
-    add_index :follows, ["follower_id", "follower_type"],     name: "fk_follows"
-    add_index :follows, ["followable_id", "followable_type"], name: "fk_followables"
+    add_index :follows, ['follower_id', 'follower_type'],     name: 'index_partisan_followers'
+    add_index :follows, ['followable_id', 'followable_type'], name: 'index_partisan_followables'
   end
 
   def down

data/lib/partisan.rb

@@ -8,8 +8,19 @@ require "partisan/follower"
 require "partisan/followable"
 
 module Partisan
-
   include Partisan::FollowHelper
+
+  def self.inject_into_active_record
+    @inject_into_active_record ||= Proc.new do
+      def self.acts_as_follower
+        self.send :include, Partisan::Follower
+      end
+
+      def self.acts_as_followable
+        self.send :include, Partisan::Followable
+      end
+    end
+  end
 end
 
 require 'partisan/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3

data/lib/partisan/follow.rb

@@ -14,6 +14,34 @@ module Partisan
     after_create :update_follow_counter
     after_destroy :update_follow_counter
 
+    # Follower's :follow callbacks
+    around_create do |follow, blk|
+      self.follower.about_to_follow = self.follower.just_followed = self.followable
+      self.follower.run_callbacks :follow, &blk
+      self.follower.about_to_follow = self.follower.just_followed = nil
+    end
+
+    # Followable's :follow callbacks
+    around_create do |follow, blk|
+      self.followable.about_to_be_followed_by = self.followable.just_followed_by = self.follower
+      self.followable.run_callbacks :follow, &blk
+      self.followable.about_to_be_followed_by = self.followable.just_followed_by = nil
+    end
+
+    # Follower's :unfollow callbacks
+    around_destroy do |follow, blk|
+      self.follower.about_to_unfollow = self.follower.just_unfollowed = self.followable
+      self.follower.run_callbacks :unfollow, &blk
+      self.follower.about_to_unfollow = self.follower.just_unfollowed = nil
+    end
+
+    # Followable's :unfollow callbacks
+    around_destroy do |follow, blk|
+      self.followable.about_to_be_unfollowed_by = self.followable.just_unfollowed_by = self.follower
+      self.followable.run_callbacks :unfollow, &blk
+      self.followable.about_to_be_unfollowed_by = self.followable.just_unfollowed_by = nil
+    end
+
   protected
 
     def update_follow_counter

data/lib/partisan/followable.rb

@@ -1,10 +1,15 @@
 module Partisan
   module Followable
     extend ActiveSupport::Concern
+    extend ActiveModel::Callbacks
+
     include Partisan::FollowHelper
 
     included do
       has_many :followings, as: :followable, class_name: 'Partisan::Follow', dependent: :destroy
+      define_model_callbacks :follow
+      define_model_callbacks :unfollow
+      attr_accessor :about_to_be_followed_by, :just_followed_by, :about_to_be_unfollowed_by, :just_unfollowed_by
     end
 
     # Return true or false if the resource is following another

data/lib/partisan/follower.rb

@@ -1,10 +1,14 @@
 module Partisan
   module Follower
     extend ActiveSupport::Concern
+    extend ActiveModel::Callbacks
     include Partisan::FollowHelper
 
     included do
       has_many :follows, as: :follower, class_name: 'Partisan::Follow', dependent: :destroy
+      define_model_callbacks :follow
+      define_model_callbacks :unfollow
+      attr_accessor :about_to_follow, :just_followed, :about_to_unfollow, :just_unfollowed
     end
 
     # Add follow record if it doesn’t exist
@@ -47,7 +51,7 @@ module Partisan
     def following?(resource)
       return false if self == resource
 
-      fetch_follows(resource).exists?
+      !!fetch_follows(resource).exists?
     end
 
     # Get all follows record related to a resource

data/lib/partisan/railtie.rb

@@ -4,15 +4,7 @@ require 'rails'
 module Partisan
   class Railtie < Rails::Railtie
     initializer "follows.active_record" do |app|
-      ActiveSupport.on_load :active_record do
-        def self.acts_as_follower
-          self.send :include, Partisan::Follower
-        end
-
-        def self.acts_as_followable
-          self.send :include, Partisan::Followable
-        end
-      end
+      ActiveSupport.on_load :active_record, {}, &Partisan.inject_into_active_record
     end
   end
 end

data/lib/partisan/version.rb

@@ -1,3 +1,3 @@
 module Partisan
-  VERSION = "0.1.1"
+  VERSION = "0.2"
 end

data/spec/follower_spec.rb

@@ -80,6 +80,112 @@ describe Partisan::Follower do
     end
   end
 
+  describe :Callbacks do
+    before do
+      class Buffer
+        def self.tmp_value=(tmp_value)
+          @tmp_value = tmp_value
+        end
+
+        def self.tmp_value
+          @tmp_value
+        end
+      end
+    end
+
+    describe 'Follower callbacks' do
+      describe :before_follow do
+        before do
+          follower 'User' do
+            before_follow { Buffer.tmp_value = self.about_to_follow }
+          end
+        end
+
+        it { expect{ user.follow(band) }.to change{ Buffer.tmp_value }.to(band) }
+      end
+
+      describe :after_follow do
+        before do
+          follower 'User' do
+            after_follow { Buffer.tmp_value = self.just_followed }
+          end
+        end
+
+        it { expect{ user.follow(band) }.to change{ Buffer.tmp_value }.to(band) }
+      end
+
+      describe :before_unfollow do
+        before do
+          follower 'User' do
+            before_unfollow { Buffer.tmp_value = self.about_to_unfollow }
+          end
+
+          user.follow(band)
+        end
+
+        it { expect{ user.unfollow(band) }.to change{ Buffer.tmp_value }.to(band) }
+      end
+
+      describe :after_unfollow do
+        before do
+          follower 'User' do
+            after_unfollow { Buffer.tmp_value = self.about_to_unfollow }
+          end
+
+          user.follow(band)
+        end
+
+        it { expect{ user.unfollow(band) }.to change{ Buffer.tmp_value }.to(band) }
+      end
+    end
+
+    describe 'Followable callbacks' do
+      describe :before_follow do
+        before do
+          followable 'Band' do
+            before_follow { Buffer.tmp_value = self.about_to_be_followed_by }
+          end
+        end
+
+        it { expect{ user.follow(band) }.to change{ Buffer.tmp_value }.to(user) }
+      end
+
+      describe :after_follow do
+        before do
+          followable 'Band' do
+            after_follow { Buffer.tmp_value = self.just_followed_by }
+          end
+        end
+
+        it { expect{ user.follow(band) }.to change{ Buffer.tmp_value }.to(user) }
+      end
+
+      describe :before_unfollow do
+        before do
+          followable 'Band' do
+            before_unfollow { Buffer.tmp_value = self.about_to_be_unfollowed_by }
+          end
+
+          user.follow(band)
+        end
+
+        it { expect{ user.unfollow(band) }.to change{ Buffer.tmp_value }.to(user) }
+      end
+
+      describe :after_unfollow do
+        before do
+          followable 'Band' do
+            after_unfollow { Buffer.tmp_value = self.just_unfollowed_by }
+          end
+
+          user.follow(band)
+        end
+
+        it { expect{ user.unfollow(band) }.to change{ Buffer.tmp_value }.to(user) }
+      end
+    end
+  end
+
   describe :AliasMethods do
     subject { User.create }
 

data/spec/spec_helper.rb

@@ -7,8 +7,9 @@ require 'partisan'
 
 # Require our macros and extensions
 Dir[File.expand_path('../../spec/support/macros/*.rb', __FILE__)].map(&method(:require))
-Dir[File.expand_path('../../spec/support/extensions/*.rb', __FILE__)].map(&method(:require))
 
+# Inject our methods into ActiveRecord (like our railtie does)
+ActiveRecord::Base.class_eval(&Partisan.inject_into_active_record)
 
 RSpec.configure do |config|
   # Include our macros

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: partisan
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -120,7 +120,6 @@ files:
 - spec/followable_spec.rb
 - spec/follower_spec.rb
 - spec/spec_helper.rb
-- spec/support/extensions/active_record.rb
 - spec/support/macros/database_macros.rb
 - spec/support/macros/model_macros.rb
 homepage: https://github.com/simonprev/partisan
@@ -138,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -161122835352919844
+      hash: -352093583781721099
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -147,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -161122835352919844
+      hash: -352093583781721099
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -159,6 +158,5 @@ test_files:
 - spec/followable_spec.rb
 - spec/follower_spec.rb
 - spec/spec_helper.rb
-- spec/support/extensions/active_record.rb
 - spec/support/macros/database_macros.rb
 - spec/support/macros/model_macros.rb

data/spec/support/extensions/active_record.rb

@@ -1,9 +0,0 @@
-class ActiveRecord::Base
-  def self.acts_as_follower
-    self.send :include, Partisan::Follower
-  end
-
-  def self.acts_as_followable
-    self.send :include, Partisan::Followable
-  end
-end