acts_as_favoritor 1.0.0

data/lib/acts_as_favoritor/favoritor_lib.rb

@@ -0,0 +1,43 @@
+module ActsAsFollower
+    module FollowerLib
+
+        private
+
+        DEFAULT_PARENTS = [ApplicationRecord, ActiveRecord::Base]
+
+        # Retrieves the parent class name if using STI.
+        def parent_class_name obj
+            unless parent_classes.include? obj.class.superclass
+                return obj.class.base_class.name
+            end
+            obj.class.name
+        end
+
+        def apply_options_to_scope scope, options = {}
+            if options.has_key? :limit
+                scope = scope.limit options[:limit]
+            end
+            if options.has_key? :includes
+                scope = scope.includes options[:includes]
+            end
+            if options.has_key? :joins
+                scope = scope.joins options[:joins]
+            end
+            if options.has_key? :where
+                scope = scope.where options[:where]
+            end
+            if options.has_key? :order
+                scope = scope.order options[:order]
+            end
+            scope
+        end
+
+        def parent_classes
+            return DEFAULT_PARENTS unless ActsAsFavoritor.custom_parent_classes
+
+            ActiveSupport::Deprecation.warn('Setting custom parent classes is deprecated and will be removed in future versions.')
+            ActsAsFavoritor.custom_parent_classes + DEFAULT_PARENTS
+        end
+
+    end
+end

data/lib/acts_as_favoritor/railtie.rb

@@ -0,0 +1,16 @@
+require 'rails'
+
+module ActsAsFavoritor
+
+    class Railtie < Rails::Railtie
+
+        initializer 'acts_as_favoritor.active_record' do |app|
+            ActiveSupport.on_load :active_record do
+                include ActsAsFavoritor::Favoritor
+                include ActsAsFavoritor::Favoritable
+            end
+        end
+
+    end
+
+end

data/lib/acts_as_favoritor/version.rb

@@ -0,0 +1,5 @@
+module ActsAsFavoritor
+
+    VERSION = '1.0.0'
+    
+end

data/lib/generators/USAGE

@@ -0,0 +1,5 @@
+Description:
+    rails generate acts_as_favoritor
+
+    no need to specify a name after acts_as_favoritor as you can not change the model name from Favorite
+    the acts_as_favoritor_migration file will be created in db/migrate

data/lib/generators/acts_as_follower_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class ActsAsFollowerGenerator < Rails::Generators::Base
+
+    include Rails::Generators::Migration
+
+    def self.source_root
+        @source_root ||= File.join File.dirname(__FILE__), 'templates'
+    end
+
+    def self.next_migration_number dirname
+        if ActiveRecord::Base.timestamped_migrations
+            Time.now.utc.strftime '%Y%m%d%H%M%S'
+        else
+            "%.3d" % (current_migration_number(dirname) + 1)
+        end
+    end
+
+    def create_migration_file
+        migration_template 'migration.rb.erb', 'db/migrate/acts_as_favoritor_migration.rb'
+    end
+
+    def create_model
+        template 'model.rb', 'app/models/follow.rb'
+    end
+
+end

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

@@ -0,0 +1,18 @@
+class ActsAsFavoritorMigration < ActiveRecord::Migration<% if Rails::VERSION::MAJOR >= 5 %>[<%= Rails::VERSION %>]<% end %>
+    def self.up
+        create_table :favorites, force: true do |t|
+            t.references :favoritable, polymorphic: true, null: false
+            t.references :favoritor, polymorphic: true, null: false
+            t.string :types, default: [:favorite].to_yaml, null: false
+            t.boolean :blocked, default: false, null: false
+            t.timestamps
+        end
+
+        add_index :favorites, ['favoritor_id', 'favoritor_type'], name: 'fk_favorites'
+        add_index :favorites, ['favoritable_id', 'favoritable_type'], name: 'fk_favoritables'
+    end
+
+    def self.down
+    drop_table :favorites
+    end
+end

data/lib/generators/templates/model.rb

@@ -0,0 +1,16 @@
+class Favorite < ActiveRecord::Base
+
+    extend ActsAsFavoritor::FavoritorLib
+    extend ActsAsFavoritor::FavoriteScopes
+
+    serialize :types
+
+    # NOTE: Follows belong to the 'favoritable' and 'favoritor' interface
+    belongs_to :favoritable, polymorphic: true
+    belongs_to :favoritor, polymorphic: true
+
+    def block!
+        self.update_attribute :blocked, true
+    end
+
+end

data/test/README

@@ -0,0 +1,24 @@
+Testing
+=======
+
+Tests are written with Shoulda on top of Test::Unit and Factory Girl is used instead of fixtures.  Tests are run using rake.
+
+1. Clone your fork git locally.
+2. Install the dependencies
+    $ bundle install
+3. Run the tests:
+    rake test
+
+
+Coverage
+=======
+
+Test coverage can be calculated using Rcov. Make sure you have the rcov gem installed.
+
+Again in the acts_as_favoritor directory:
+
+rake rcov:gen DB=sqlite3   # For sqlite
+
+The coverage will now be available in the test/coverage directory.
+
+rake rcov:clobber will delete the coverage directory.

data/test/acts_as_followable_test.rb

@@ -0,0 +1,283 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ActsAsFollowableTest < ActiveSupport::TestCase
+
+  context "instance methods" do
+    setup do
+      @sam = FactoryGirl.create(:sam)
+    end
+
+    should "be defined" do
+      assert @sam.respond_to?(:followers_count)
+      assert @sam.respond_to?(:followers)
+      assert @sam.respond_to?(:followed_by?)
+    end
+  end
+
+  context "acts_as_followable" do
+    setup do
+      @sam = FactoryGirl.create(:sam)
+      @jon = FactoryGirl.create(:jon)
+      @oasis = FactoryGirl.create(:oasis)
+      @metallica = FactoryGirl.create(:metallica)
+      @green_day = FactoryGirl.create(:green_day)
+      @blink_182 = FactoryGirl.create(:blink_182)
+      @sam.follow(@jon)
+    end
+
+    context "followers_count" do
+      should "return the number of followers" do
+        assert_equal 0, @sam.followers_count
+        assert_equal 1, @jon.followers_count
+      end
+
+      should "return the proper number of multiple followers" do
+        @bob = FactoryGirl.create(:bob)
+        @sam.follow(@bob)
+        assert_equal 0, @sam.followers_count
+        assert_equal 1, @jon.followers_count
+        assert_equal 1, @bob.followers_count
+      end
+    end
+
+    context "followers" do
+      should "return users" do
+        assert_equal [], @sam.followers
+        assert_equal [@sam], @jon.followers
+      end
+
+      should "return users (multiple followers)" do
+        @bob = FactoryGirl.create(:bob)
+        @sam.follow(@bob)
+        assert_equal [], @sam.followers
+        assert_equal [@sam], @jon.followers
+        assert_equal [@sam], @bob.followers
+      end
+
+      should "return users (multiple followers, complex)" do
+        @bob = FactoryGirl.create(:bob)
+        @sam.follow(@bob)
+        @jon.follow(@bob)
+        assert_equal [], @sam.followers
+        assert_equal [@sam], @jon.followers
+        assert_equal [@sam, @jon], @bob.followers
+      end
+
+      should "accept AR options" do
+        @bob = FactoryGirl.create(:bob)
+        @bob.follow(@jon)
+        assert_equal 1, @jon.followers(limit: 1).count
+      end
+    end
+
+    context "followed_by" do
+      should "return_follower_status" do
+        assert_equal true, @jon.followed_by?(@sam)
+        assert_equal false, @sam.followed_by?(@jon)
+      end
+    end
+
+    context "destroying a followable" do
+      setup do
+        @jon.destroy
+      end
+
+      should_change("follow count", by: -1) { Follow.count }
+      should_change("@sam.all_following.size", by: -1) { @sam.all_following.size }
+    end
+
+    context "get follow record" do
+      setup do
+        @bob = FactoryGirl.create(:bob)
+        @follow = @bob.follow(@sam)
+      end
+
+      should "return follow record" do
+        assert_equal @follow, @sam.get_follow_for(@bob)
+      end
+
+      should "return nil" do
+        assert_nil @sam.get_follow_for(@jon)
+      end
+    end
+
+    context "blocks" do
+      setup do
+        @bob = FactoryGirl.create(:bob)
+        @jon.block(@sam)
+        @jon.block(@bob)
+      end
+
+      should "accept AR options" do
+        assert_equal 1, @jon.blocks(limit: 1).count
+      end
+    end
+
+    context "blocking a follower" do
+      context "in my following list" 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
+          @jon.follow(@sam)
+          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 "not in my following list" do
+        setup do
+          @sam.block(@jon)
+        end
+
+        should "add him to the blocked followers" do
+          assert_equal 1, @sam.blocked_followers_count
+        end
+
+        should "not be able to follow again" do
+          @sam.follow(@jon)
+          assert_equal 0, @sam.followers_count
+        end
+
+        should "not be present when listing followers" do
+          assert_equal [], @sam.followers
+        end
+
+        should "be in the list of blocks" do
+          assert_equal [@jon], @sam.blocks
+        end
+      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.remove_favorite(@jon)
+        @jon.unblock(@sam)
+      end
+
+      should "not be in the list of followers" do
+        assert_equal [], @jon.followers
+      end
+
+      should "not be in the blocked 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
+
+    context "followers_by_type" do
+      setup do
+        @sam.follow(@oasis)
+        @jon.follow(@oasis)
+      end
+
+      should "return the followers for given type" do
+        assert_equal [@sam], @jon.followers_by_type('User')
+        assert_equal [@sam, @jon], @oasis.followers_by_type('User')
+      end
+
+      should "not return block followers in the followers for a given type" do
+        @oasis.block(@jon)
+        assert_equal [@sam], @oasis.followers_by_type('User')
+      end
+
+      should "return the count for followers_by_type_count for a given type" do
+        assert_equal 1, @jon.followers_by_type_count('User')
+        assert_equal 2, @oasis.followers_by_type_count('User')
+      end
+
+      should "not count blocked follows in the count" do
+        @oasis.block(@sam)
+        assert_equal 1, @oasis.followers_by_type_count('User')
+      end
+    end
+
+    context "followers_with_sti" do
+      setup do
+        @sam.follow(@green_day)
+        @sam.follow(@blink_182)
+      end
+
+      should "return the followers for given type" do
+        assert_equal @sam.follows_by_type('Band').first.followable, @green_day.becomes(Band)
+        assert_equal @sam.follows_by_type('Band').second.followable, @blink_182.becomes(Band)
+        assert @green_day.followers_by_type('User').include?(@sam)
+        assert @blink_182.followers_by_type('User').include?(@sam)
+      end
+    end
+
+    context "method_missing" do
+      setup do
+        @sam.follow(@oasis)
+        @jon.follow(@oasis)
+      end
+
+      should "return the followers for given type" do
+        assert_equal [@sam], @jon.user_followers
+        assert_equal [@sam, @jon], @oasis.user_followers
+      end
+
+      should "not return block followers in the followers for a given type" do
+        @oasis.block(@jon)
+        assert_equal [@sam], @oasis.user_followers
+      end
+
+      should "return the count for followers_by_type_count for a given type" do
+        assert_equal 1, @jon.count_user_followers
+        assert_equal 2, @oasis.count_user_followers
+      end
+
+      should "not count blocked follows in the count" do
+        @oasis.block(@sam)
+        assert_equal 1, @oasis.count_user_followers
+      end
+    end
+
+    context "respond_to?" do
+      should "advertise that it responds to following methods" do
+        assert @oasis.respond_to?(:user_followers)
+        assert @oasis.respond_to?(:user_followers_count)
+      end
+
+      should "return false when called with a nonexistent method" do
+        assert (not @oasis.respond_to?(:foobar))
+      end
+    end
+
+  end
+end