acts_as_favoritor 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa5428168c7b8609f60f208889cdc00039ec182e
-  data.tar.gz: 0c44c7a38d6a165069afa96cba0eeff74eee1d16
+  metadata.gz: 51b26144e2f4621c21c2733217190573550f4457
+  data.tar.gz: 7ac65f0fd1d99f1a22186a975d11031cc79ed047
 SHA512:
-  metadata.gz: 675ee97d8c2d37bd81627d738fa629eff5dff73558962b8e3e3862f4095ca420b278e000a066ad06cc8182d5d25a2143ba693f2a78e747b863b87d4c36d0a73a
-  data.tar.gz: 64e88864d50a179520792857dfcdb70f9b759f3097b92a23271f02b709d59bbd8d0722986872255613d2085f7a3de289aa4b13e6c34a05f15d1c4ecbcd273408
+  metadata.gz: bbb04b517631931b8fc8cd4eb091eb43f3a1b09635ca7aecc2d5d0979731177989db605b8114bcf7de871a58ea5ee9744b20b22fc0f00fee74ac4206d5102c13
+  data.tar.gz: d710797509f89e5bf16936a9f8da7f8d72f47cf0eb635dc229b04b23d9081be374e2a3718db12855c1044cb5bcd13b139baacffa1139fa2176b09d0eb3c29d05

data/.gitignore

@@ -4,5 +4,4 @@ rdoc
 memory
 *.gem
 .rvmrc
-Gemfile.lock
 log

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### unreleased
+
+* nothing yet
+
+### 1.0.1 - 2017-08-22
+
+* bug fixes
+
+### 1.0.0 - 2017-08-22
+
+Initial release

data/Gemfile.lock

@@ -0,0 +1,131 @@
+PATH
+  remote: .
+  specs:
+    acts_as_favoritor (1.0.1)
+      activerecord (>= 4.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actioncable (5.1.3)
+      actionpack (= 5.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.3)
+      actionview (= 5.1.3)
+      activesupport (= 5.1.3)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.3)
+      activesupport (= 5.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.3)
+      activesupport (= 5.1.3)
+      globalid (>= 0.3.6)
+    activemodel (5.1.3)
+      activesupport (= 5.1.3)
+    activerecord (5.1.3)
+      activemodel (= 5.1.3)
+      activesupport (= 5.1.3)
+      arel (~> 8.0)
+    activesupport (5.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    erubi (1.6.1)
+    factory_girl (4.8.0)
+      activesupport (>= 3.0.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    i18n (0.8.6)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.2.0)
+    minitest (5.10.3)
+    nio4r (2.1.0)
+    nokogiri (1.8.0-x86-mingw32)
+      mini_portile2 (~> 2.2.0)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.1.3)
+      actioncable (= 5.1.3)
+      actionmailer (= 5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      activemodel (= 5.1.3)
+      activerecord (= 5.1.3)
+      activesupport (= 5.1.3)
+      bundler (>= 1.3.0)
+      railties (= 5.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.3)
+      actionpack (= 5.1.3)
+      activesupport (= 5.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.2)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    shoulda_create (0.0.9)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13-x86-mingw32)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  acts_as_favoritor!
+  factory_girl (~> 4.8)
+  rails (>= 4.0)
+  shoulda (~> 3.5)
+  shoulda_create (~> 0.0)
+  sqlite3 (~> 1.3)
+
+BUNDLED WITH
+   1.15.4

data/README.md

@@ -1,4 +1,4 @@
-# acts_as_favoitor - Add Favorites to you Rails app
+# acts_as_favoritor - Add Favorites to you Rails app
 
 <img src="https://travis-ci.org/slooob/acts_as_favoritor.svg?branch=master" />
 

data/acts_as_favoritor.gemspec

@@ -2,28 +2,28 @@
 $:.push File.expand_path('../lib', __FILE__)
 require 'acts_as_favoritor/version'
 
-Gem::Specification.new do |s|
-    s.name        = 'acts_as_favoritor'
-    s.version     = ActsAsFavoritor::VERSION
-    s.authors     = ['Jonas Hübotter']
-    s.email       = ['developer@slooob.com']
-    s.homepage    = 'https://github.com/slooob/acts_as_favoritor'
-    s.summary     = 'A Rubygem to add Favorite functionality for ActiveRecord models'
-    s.description = 'acts_as_favoritor is a Rubygem to allow any ActiveRecord model to favorite any other model. This is accomplished through a double polymorphic relationship on the Favorite model. There is also built in support for blocking/un-blocking favorite records.'
-    s.license     = 'MIT'
+Gem::Specification.new do |gem|
+    gem.name        = 'acts_as_favoritor'
+    gem.version     = ActsAsFavoritor::VERSION
+    gem.authors     = ['Jonas Hübotter']
+    gem.email       = ['developer@slooob.com']
+    gem.homepage    = 'https://github.com/slooob/acts_as_favoritor'
+    gem.summary     = 'A Rubygem to add Favorite functionality for ActiveRecord models'
+    gem.description = 'acts_as_favoritor is a Rubygem to allow any ActiveRecord model to favorite any other model. This is accomplished through a double polymorphic relationship on the Favorite model. There is also built in support for blocking/un-blocking favorite records.'
+    gem.license     = 'MIT'
 
-    s.rubyforge_project = 'acts_as_follower'
+    gem.files         = `git ls-files`.split("\n")
+    gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+    gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+    gem.require_paths = ['lib']
 
-    s.files         = `git ls-files`.split("\n")
-    s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-    s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-    s.require_paths = ['lib']
+    gem.required_ruby_version = '>= 2.0'
 
-    s.add_dependency 'activerecord', '>= 4.0'
+    gem.add_dependency 'activerecord', '>= 4.0'
 
-    s.add_development_dependency 'sqlite3', '~> 1'
-    s.add_development_dependency 'shoulda_create', '~> 0'
-    s.add_development_dependency 'shoulda', '~> 3'
-    s.add_development_dependency 'factory_girl', '~> 4'
-    s.add_development_dependency 'rails', '>= 4.0'
+    gem.add_development_dependency 'sqlite3', '~> 1.3'
+    gem.add_development_dependency 'shoulda_create', '~> 0.0'
+    gem.add_development_dependency 'shoulda', '~> 3.5'
+    gem.add_development_dependency 'factory_girl', '~> 4.8'
+    gem.add_development_dependency 'rails', '>= 4.0'
 end

data/lib/acts_as_favoritor.rb

@@ -30,6 +30,6 @@ module ActsAsFavoritor
 
     setup
 
-    require 'favoritor/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3
-    
+    require 'acts_as_favoritor/railtie' if defined?(Rails)
+
 end

data/lib/acts_as_favoritor/favoritable.rb

@@ -25,9 +25,9 @@ module ActsAsFavoritor #:nodoc:
                 favorites = favoritor_type.constantize.
                 joins(:favorites).
                 where('favorites.blocked': false,
-                'favorites.followable_id': self.id,
-                'favorites.followable_type': parent_class_name(self),
-                'favorites.follower_type': favoritor_type)
+                'favorites.favoritable_id': self.id,
+                'favorites.favoritable_type': parent_class_name(self),
+                'favorites.favoritor_type': favoritor_type)
                 if options.has_key? :limit
                     favorites = favorites.limit options[:limit]
                 end

data/lib/acts_as_favoritor/favoritor.rb

@@ -1,5 +1,5 @@
 module ActsAsFavoritor #:nodoc:
-    module Follower
+    module Favoritor
 
         def self.included base
             base.extend ClassMethods
@@ -15,12 +15,12 @@ module ActsAsFavoritor #:nodoc:
 
         module InstanceMethods
 
-            # Returns true if this instance is following the object passed as an argument.
+            # Returns true if this instance has favorited the object passed as an argument.
             def favorited? favoritable
                 0 < Favorite.unblocked.for_favoritor(self).for_favoritable(favoritable).count
             end
 
-            # Returns the number of objects this instance is following.
+            # Returns the number of objects this instance has favorited.
             def favorites_count
                 Favorite.unblocked.for_favoritor(self).count
             end
@@ -36,7 +36,7 @@ module ActsAsFavoritor #:nodoc:
 
             # Deletes the favorite record if it exists.
             def remove_favorite favoritable
-                if favorite = get_Favoritor favoritable
+                if favorite = get_Favoritor(favoritable)
                     favorite.destroy
                 end
             end
@@ -47,7 +47,7 @@ module ActsAsFavoritor #:nodoc:
             end
 
             # Returns the favorite records related to this instance by type.
-            def favorites_by_type favoritable_type, options={}
+            def favorites_by_type favoritable_type, options = {}
                 favorites_scope  = favorites_scoped.for_favoritable_type favoritable_type
                 favorites_scope = apply_options_to_scope favorites_scope, options
             end
@@ -60,7 +60,7 @@ module ActsAsFavoritor #:nodoc:
 
             # Returns the actual records which this instance has favorited.
             def all_favorited options = {}
-            all_favorites(options).collect{ |f| f.favoritable }
+                all_favorites(options).collect{ |f| f.favoritable }
             end
 
             # Returns the actual records of a particular type which this record has fovarited.
@@ -68,9 +68,9 @@ module ActsAsFavoritor #:nodoc:
                 favoritables = favoritable_type.constantize.
                 joins(:favorited).
                 where('favorites.blocked': false,
-                'favorites.favoritor_id': self.id,
-                'favorites.favoritor_type': parent_class_name(self),
-                'favorites.favoritable_type': favoritable_type)
+                    'favorites.favoritor_id': self.id,
+                    'favorites.favoritor_type': parent_class_name(self),
+                    'favorites.favoritable_type': favoritable_type)
                 if options.has_key? :limit
                     favoritables = favoritables.limit options[:limit]
                 end

data/lib/acts_as_favoritor/favoritor_lib.rb

@@ -1,5 +1,5 @@
-module ActsAsFollower
-    module FollowerLib
+module ActsAsFavoritor
+    module FavoritorLib
 
         private
 

data/lib/acts_as_favoritor/railtie.rb

@@ -1,10 +1,9 @@
 require 'rails'
 
 module ActsAsFavoritor
-
     class Railtie < Rails::Railtie
 
-        initializer 'acts_as_favoritor.active_record' do |app|
+        initializer 'acts_as_favoritor.active_record' do
             ActiveSupport.on_load :active_record do
                 include ActsAsFavoritor::Favoritor
                 include ActsAsFavoritor::Favoritable
@@ -12,5 +11,4 @@ module ActsAsFavoritor
         end
 
     end
-
 end

data/lib/acts_as_favoritor/version.rb

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

data/lib/generators/{acts_as_follower_generator.rb → acts_as_favoritor_generator.rb}

@@ -1,7 +1,7 @@
 require 'rails/generators'
 require 'rails/generators/migration'
 
-class ActsAsFollowerGenerator < Rails::Generators::Base
+class ActsAsFavoritorGenerator < Rails::Generators::Base
 
     include Rails::Generators::Migration
 
@@ -22,7 +22,7 @@ class ActsAsFollowerGenerator < Rails::Generators::Base
     end
 
     def create_model
-        template 'model.rb', 'app/models/follow.rb'
+        template 'model.rb', 'app/models/favorite.rb'
     end
 
 end

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

@@ -1,9 +1,9 @@
-class ActsAsFavoritorMigration < ActiveRecord::Migration<% if Rails::VERSION::MAJOR >= 5 %>[<%= Rails::VERSION %>]<% end %>
+class ActsAsFavoritorMigration < ActiveRecord::Migration<% if Rails::VERSION::MAJOR >= 5 %>[Rails::VERSION::STRING[0..2].to_f]<% 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.string :lists, default: [:favorites].to_yaml, null: false
             t.boolean :blocked, default: false, null: false
             t.timestamps
         end

data/lib/generators/templates/model.rb

@@ -3,9 +3,9 @@ class Favorite < ActiveRecord::Base
     extend ActsAsFavoritor::FavoritorLib
     extend ActsAsFavoritor::FavoriteScopes
 
-    serialize :types
+    serialize :lists
 
-    # NOTE: Follows belong to the 'favoritable' and 'favoritor' interface
+    # NOTE: Favorites belong to the 'favoritable' and 'favoritor' interface
     belongs_to :favoritable, polymorphic: true
     belongs_to :favoritor, polymorphic: true
 

data/test/acts_as_favoritable_test.rb

@@ -0,0 +1,283 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ActsAsFavoritableTest < ActiveSupport::TestCase
+
+    context 'instance methods' do
+        setup do
+            @sam = FactoryGirl.create :sam
+        end
+
+        should 'be defined' do
+            assert @sam.respond_to? :favoritors_count
+            assert @sam.respond_to? :favoritors
+            assert @sam.respond_to? :favorited_by?
+        end
+    end
+
+    context 'acts_as_favoritable' 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.favorite @jon
+        end
+
+        context 'favoritors_count' do
+            should 'return the number of favoritors' do
+                assert_equal 0, @sam.favoritors_count
+                assert_equal 1, @jon.favoritors_count
+            end
+
+            should 'return the proper number of multiple favoritors' do
+                @bob = FactoryGirl.create :bob
+                @sam.favorite @bob
+                assert_equal 0, @sam.favoritors_count
+                assert_equal 1, @jon.favoritors_count
+                assert_equal 1, @bob.favoritors_count
+            end
+        end
+
+        context 'favoritors' do
+            should 'return users' do
+                assert_equal [], @sam.favoritors
+                assert_equal [@sam], @jon.favoritors
+            end
+
+            should 'return users (multiple favoritors)' do
+                @bob = FactoryGirl.create :bob
+                @sam.favorite @bob
+                assert_equal [], @sam.favoritors
+                assert_equal [@sam], @jon.favoritors
+                assert_equal [@sam], @bob.favoritors
+            end
+
+            should 'return users (multiple favoritors, complex)' do
+                @bob = FactoryGirl.create :bob
+                @sam.favorite @bob
+                @jon.favorite @bob
+                assert_equal [], @sam.favoritors
+                assert_equal [@sam], @jon.favoritors
+                assert_equal [@sam, @jon], @bob.favoritors
+            end
+
+            should 'accept AR options' do
+                @bob = FactoryGirl.create :bob
+                @bob.favorite @jon
+                assert_equal 1, @jon.favoritors(limit: 1).count
+            end
+        end
+
+        context 'favorited_by' do
+            should 'return_favoritor_status' do
+                assert_equal true, @jon.favorited_by?(@sam)
+                assert_equal false, @sam.favorited_by?(@jon)
+            end
+        end
+
+        context 'destroying a favoritable' do
+            setup do
+                @jon.destroy
+            end
+
+            should_change ('Favorite count', by: -1) { Favorite.count }
+            should_change ('@sam.all_favorited.size', by: -1) { @sam.all_favorited.size }
+        end
+
+        context 'get favorite record' do
+            setup do
+                @bob = FactoryGirl.create :bob
+                @favorite = @bob.favorite @sam
+            end
+
+            should 'return favorite record' do
+                assert_equal @favorite, @sam.get_favorite_for(@bob)
+            end
+
+            should 'return nil' do
+                assert_nil @sam.get_favorite_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 favoritor' do
+            context 'in my favorited list' do
+                setup do
+                    @jon.block @sam
+                end
+
+                should 'remove him from favoritors' do
+                    assert_equal 0, @jon.favoritors_count
+                end
+
+                should 'add him to the blocked favoritors' do
+                    assert_equal 1, @jon.blocked_favoritors_count
+                end
+
+                should 'not be able to favorite again' do
+                    @jon.favorite @sam
+                    assert_equal 0, @jon.favoritors_count
+                end
+
+                should 'not be present when listing favoritors' do
+                    assert_equal [], @jon.favoritors
+                end
+
+                should 'be in the list of blocks' do
+                    assert_equal [@sam], @jon.blocks
+                end
+            end
+
+            context 'not in my favorited list' do
+                setup do
+                    @sam.block @jon
+                end
+
+                should 'add him to the blocked favoritors' do
+                    assert_equal 1, @sam.blocked_favoritors_count
+                end
+
+                should 'not be able to favorite again' do
+                    @sam.favorite @jon
+                    assert_equal 0, @sam.favoritors_count
+                end
+
+                should 'not be present when listing favoritors' do
+                    assert_equal [], @sam.favoritors
+                end
+
+                should 'be in the list of blocks' do
+                    assert_equal [@jon], @sam.blocks
+                end
+            end
+        end
+
+        context 'unblocking a blocked favorite' do
+            setup do
+                @jon.block @sam
+                @jon.unblock @sam
+            end
+
+            should 'not include the unblocked user in the list of favoritors' do
+                assert_equal [], @jon.favoritors
+            end
+
+            should 'remove him from the blocked favoritors' do
+                assert_equal 0, @jon.blocked_favoritors_count
+                assert_equal [], @jon.blocks
+            end
+        end
+
+        context 'unblock a non-existent favorite' do
+            setup do
+                @sam.remove_favorite @jon
+                @jon.unblock @sam
+            end
+
+            should 'not be in the list of favoritors' do
+                assert_equal [], @jon.favoritors
+            end
+
+            should 'not be in the blocked favoritors count' do
+                assert_equal 0, @jon.blocked_favoritors_count
+            end
+
+            should 'not be in the blocks list' do
+                assert_equal [], @jon.blocks
+            end
+        end
+
+        context 'favoritors_by_type' do
+            setup do
+                @sam.favorite @oasis
+                @jon.favorite @oasis
+            end
+
+            should 'return the favoritors for given type' do
+                assert_equal [@sam], @jon.favoritors_by_type('User')
+                assert_equal [@sam, @jon], @oasis.favoritors_by_type('User')
+            end
+
+            should 'not return block favoritors in the favoritors for a given type' do
+                @oasis.block @jon
+                assert_equal [@sam], @oasis.favoritors_by_type('User')
+            end
+
+            should 'return the count for favoritors_by_type_count for a given type' do
+                assert_equal 1, @jon.favoritors_by_type_count('User')
+                assert_equal 2, @oasis.favoritors_by_type_count('User')
+            end
+
+            should 'not count blocked favorites in the count' do
+                @oasis.block @sam
+                assert_equal 1, @oasis.favoritors_by_type_count('User')
+            end
+        end
+
+        context 'favoritors_with_sti' do
+            setup do
+                @sam.favorite @green_day
+                @sam.favorite @blink_182
+            end
+
+            should 'return the favoritors for given type' do
+                assert_equal @sam.favorites_by_type('Band').first.favoritable, @green_day.becomes(Band)
+                assert_equal @sam.favorites_by_type('Band').second.favoritable, @blink_182.becomes(Band)
+                assert @green_day.favoritors_by_type('User').include?(@sam)
+                assert @blink_182.favoritors_by_type('User').include?(@sam)
+            end
+        end
+
+        context 'method_missing' do
+            setup do
+                @sam.favorite @oasis
+                @jon.favorite @oasis
+            end
+
+            should 'return the favoritors for given type' do
+                assert_equal [@sam], @jon.user_favoritors
+                assert_equal [@sam, @jon], @oasis.user_favoritors
+            end
+
+            should 'not return block favoritors in the favoritors for a given type' do
+                @oasis.block @jon
+                assert_equal [@sam], @oasis.user_favoritors
+            end
+
+            should 'return the count for favoritors_by_type_count for a given type' do
+                assert_equal 1, @jon.count_user_favoritors
+                assert_equal 2, @oasis.count_user_favoritors
+            end
+
+            should 'not count blocked favorites in the count' do
+                @oasis.block @sam
+                assert_equal 1, @oasis.count_user_favoritors
+            end
+        end
+
+        context 'respond_to?' do
+            should 'advertise that it responds to favorited methods' do
+                assert @oasis.respond_to?(:user_favoritors)
+                assert @oasis.respond_to?(:user_favoritors_count)
+            end
+
+            should 'return false when called with a nonexistent method' do
+                assert (not @oasis.respond_to?(:foobar))
+            end
+        end
+
+    end
+end