acts_as_favoritor 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94041c9376e8e337edf53d7c84397c30b9e2b562
-  data.tar.gz: f0d6c7694c0c3c3b218a5a9fc800d63ce29e68ce
+  metadata.gz: 0212cb5d6caa611de18d2d40fdc63d222cb53fbd
+  data.tar.gz: 80a038d9ede85643ee8ef0f603e80ba6c5f4c621
 SHA512:
-  metadata.gz: aa60c403515beb2407e424220641c8d9ba8f796ee5892863da3c187c93b9e1f1a9bffe11638f487419bc2fac53fd9c79d298c67395989cacd65df144c9508d31
-  data.tar.gz: fb30725d86c0c6b3815975fdc33cfc9d9490dcf9cca5191e47b7900d193b227aec7978fb63059596fb782a37cb3e7640b8691a7eee0a5225a0860e6baece42a8
+  metadata.gz: 6bd55853cbcfad24a096d22148f0ad9f8db4da64a8a9c8af89af0436c9debd0de3a24cfe6420fd07a96f9fd85f690c6d37b6dedc3762ad214712477e6f485bfc
+  data.tar.gz: d34d88eac6378f1a700409ee854a6e2f9c7257a700984cc63ee708fccf753eecdb57bb4a8812afbdacaabaa3b802fc8d3c5fd8f476a72f10a44e2c94fccc548a

data/.github/issue_template.md

@@ -0,0 +1,14 @@
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead
+
+### Steps to reproduce
+Show a way to reproduce
+
+### System configuration
+
+**Ruby version**:
+
+**Rails version**:

data/.github/pull_request_template.md

@@ -0,0 +1,21 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. This could include
+benchmarks, or other information.
+
+If you are updating any of the CHANGELOG files or are asked to update the
+CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.
+
+Finally, if your pull request affects documentation or any non-code
+changes, guidelines for those changes are [available
+here](https://github.com/slooob/acts_as_favoritor/blob/master/CONTRIBUTING.md)
+
+Thanks for contributing to `acts_as_favoritor`!

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at help@slooob.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+# Contributing

data/DEPRECATIONS.md

@@ -0,0 +1,3 @@
+# Deprecations
+
+No deprecations

data/Gemfile

@@ -4,3 +4,6 @@ gemspec
 
 
 gem 'activesupport', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
+
+# # Test Coverage
+# gem 'simplecov', require: false, group: :test

data/README.md

@@ -2,7 +2,9 @@
 
 <img src="https://travis-ci.org/slooob/acts_as_favoritor.svg?branch=master" />
 
-`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.
+`acts_as_favoritor` is a Rubygem to allow any ActiveRecord model to associate any other model including the option for multiple relationships per association with scopes.
+
+You are able to differentiate followers, favorites, watchers and whatever else you can imagine through a single relationship. This is accomplished by a double polymorphic relationship on the Favorite model. There is also built in support for blocking/un-blocking favorite records.
 
 ---
 
@@ -14,8 +16,11 @@
     * [`acts_as_favoritor` methods](#acts_as_favoritor-methods)
     * [`acts_as_favoritable` methods](#acts_as_favoritable-methods)
     * [`Favorite` model](#favorite-model)
-* [To Do List](#to-do-list)
-* [Contributors](#contributors)
+    * [Scopes](#scopes)
+* [Testing](#testing)
+    * [Test Coverage](#test-coverage)
+* [Contributing](#contributing)
+    * [Contributors](#contributors)
 * [License](#license)
 
 ---
@@ -39,7 +44,7 @@ Or install it yourself as:
 If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
 
 ```ruby
-gem 'amphtml', github: 'slooob/acts_as_favoritor'
+gem 'acts_as_favoritor', github: 'slooob/acts_as_favoritor'
 ```
 
 Now run the generator:
@@ -92,15 +97,15 @@ user.remove_favorite book
 user.favorited? book
 
 # Total number of favorites by `user`.
-user.favorite_count
+user.favorites_count
 
-# Returnes `user`'s favorites that have not been blocked as an array of Favorite records.
+# Returnes `user`'s favorites that have not been blocked as an array of `Favorite` records.
 user.all_favorites
 
 # Returns all favorited objects of `user` as an array (unblocked). This can be a collection of different object types, eg: `User`, `Book`.
 user.all_favorited
 
-# Returns an array of Favorite records where the `favoritable_type` is `Book`.
+# Returns an array of `Favorite` records where the `favoritable_type` is `Book`.
 user.favorites_by_type 'Book'
 
 # Returns an array of all favorited objects of `user` where `favoritable_type` is 'Book', this can be a collection of different object types, eg: `User`, `Book`.
@@ -173,14 +178,14 @@ These methods take an optional hash parameter of ActiveRecord options (`:limit`,
 
 ```ruby
 # Scopes
-## Returns all Favorite records where `blocked` is `false`.
+## Returns all `Favorite` records where `blocked` is `false`.
 Favorite.unblocked
-## Returns all Favorite records where `blocked` is `true`.
+## Returns all `Favorite` records where `blocked` is `true`.
 Favorite.blocked
-## Returns an ordered array of the latest create Favorite records.
+## Returns an ordered array of the latest create `Favorite` records.
 Favorite.descending
 
-# Returns all Favorite records in an array, which have been created in a specified timeframe. Default is 2 weeks.
+# Returns all `Favorite` records in an array, which have been created in a specified timeframe. Default is 2 weeks.
 Favorite.recent
 Favorite.recent 1.month.ago
 
@@ -191,17 +196,83 @@ Favorite.for_favoritor user
 Favorite.for_favoritable book
 ```
 
+### Scopes
+
+Using scopes with `acts_as_favoritor` enables you to Follow, Watch, Favorite, [...] between any of your models. This way you can separate distinct functionalities in your app between user states. For example: A user sees all his favorited books in a dashboard (`'favorites'`), but he only receives notifications for those, he is watching (`'watching'`). Just like YouTube does it.
+
+By default all of your favorites are scoped to `'favorites'`.
+
+You can create new scopes on the fly. Every single method takes `scope` as an option which expexts an array containing your scopes as strings.
+
+So lets see how this works:
+
+```ruby
+user.favorite book, scope: [:favorites, :watching]
+user.remove_favorite book, scope: [:watching]
+book.block user, scope: [:all] # applies to all scopes
+```
+
+That's simple!
+
+When you call a method which returns something while specifying multiple scopes, the method returns the results in a hash with the scopes as keys:
+
+```ruby
+user.favorited? book, scope: [:favorites, :watching] # => { favorites: true, watching: false }
+user.favorited? book, scope: [:all] # => true
+```
+
+`acts_as_favoritor` also provides some handy scopes for you to call on the `Favorite` model:
+
+```ruby
+# Returns all `Favorite` records where `scope` is `my_scope`
+Favorite.send(my_scope + '_list')
+
+## Examples
+### Returns all `Favorite` records where `scope` is `favorites`
+Favorite.favorites_list
+### Returns all `Favorite` records where `scope` is `watching`
+Favorite.watching_list
+### Very unnecessary, but `all_list` returns literally all `Favorite` records
+Favorite.all_list
+```
+
 ---
 
-## To Do List
+## Testing
+
+Tests are written with Shoulda on top of `Test::Unit` with Factory Girl being used instead of fixtures. Tests are run using rake.
+
+1. Fork this repository
+2. Clone your forked git locally
+3. Install dependencies
+
+    `$ bundle install`
+
+4. Run tests
 
-* Allow Favorites to be scoped, supporting multiple sets of favorites between models.
+    `$ rake test`
+
+### Test Coverage
+
+Test coverage can be calculated using SimpleCov. Make sure you have the [simplecov gem](https://github.com/colszowka/simplecov) installed.
+
+1. Uncomment SimpleCov in the Gemfile
+2. Uncomment the relevant section in `test/test_helper.rb`
+3. Run tests
+
+    `$ rake test`
 
 ---
 
-## Contributors
+## Contributing
+
+We hope that you will consider contributing to `acts_as_favoritor`. Please read this short overview for some information about how to get started:
+
+[Learn more about contributing to this repository](https://github.com/slooob/acts_as_favoritor/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/slooob/acts_as_favoritor/blob/master/CODE_OF_CONDUCT.md)
+
+### Contributors
 
-Give the people some :heart: who are working on this project. Check them all at:
+Give the people some :heart: who are working on this project. See them all at:
 
 https://github.com/slooob/acts_as_favoritor/graphs/contributors
 

data/Rakefile

@@ -23,15 +23,3 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
     rdoc.options << '--line-numbers' << '--inline-source'
     rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
 end
-
-namespace :rcov do
-    desc "Generate a coverage report in coverage/"
-    task :gen do
-        sh "rcov --output coverage test/*_test.rb --exclude 'gems/*'"
-    end
-
-    desc "Remove generated coverage files."
-    task :clobber do
-        sh "rm -rdf coverage"
-    end
-end

data/acts_as_favoritor.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |gem|
     gem.add_development_dependency 'shoulda', '~> 3.5'
     gem.add_development_dependency 'factory_girl', '~> 4.8'
     gem.add_development_dependency 'rails', '>= 4.0'
+    gem.add_development_dependency 'tzinfo-data', '~> 1.2017'
 end

data/lib/acts_as_favoritor.rb

@@ -7,29 +7,6 @@ module ActsAsFavoritor
     autoload :FavoritorLib, 'acts_as_favoritor/favoritor_lib'
     autoload :FavoriteScopes, 'acts_as_favoritor/favorite_scopes'
 
-    def self.setup
-        @configuration ||= Configuration.new
-        yield @configuration if block_given?
-    end
-
-    def self.method_missing method_name, *args, &block
-        if method_name == :custom_parent_classes=
-            ActiveSupport::Deprecation.warn 'Setting custom parent classes is deprecated and will be removed in future versions.'
-        end
-        @configuration.respond_to?(method_name) ?
-        @configuration.send(method_name, *args, &block) : super
-    end
-
-    class Configuration
-        attr_accessor :custom_parent_classes
-
-        def initialize
-            @custom_parent_classes = []
-        end
-    end
-
-    setup
-
     require 'acts_as_favoritor/railtie' if defined?(Rails)
 
 end

data/lib/acts_as_favoritor/favoritable.rb

@@ -16,30 +16,71 @@ module ActsAsFavoritor #:nodoc:
         module InstanceMethods
 
             # Returns the number of favoritors a record has.
-            def favoritors_count
-                self.favorited.unblocked.count
+            def favoritors_count options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = favorited.unblocked.send(scope + '_list').count
+                    end
+                    return results
+                else
+                    return favorited.unblocked.send(options[:scope] + '_list').count
+                end
             end
 
             # Returns the favoritors by a given type
             def favoritors_by_type favoritor_type, options = {}
-                favorites = favoritor_type.constantize.
-                joins(:favorites).
-                where('favorites.blocked': false,
-                '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
-                if options.has_key? :includes
-                    favorites = favorites.includes options[:includes]
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritor_type
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        favorites = favoritor_type.constantize.joins(:favorites).where('favorites.blocked': false,
+                            'favorites.favoritable_id': id,
+                            'favorites.favoritable_type': parent_class_name(self),
+                            'favorites.favoritor_type': favoritor_type,
+                            'favorites.scope': scope)
+                        if options.has_key? :limit
+                            favorites = favorites.limit options[:limit]
+                        end
+                        if options.has_key? :includes
+                            favorites = favorites.includes options[:includes]
+                        end
+                        results[scope] = favorites
+                    end
+                    return results
+                else
+                    favorites = favoritor_type.constantize.joins(:favorites).where('favorites.blocked': false,
+                        'favorites.favoritable_id': id,
+                        'favorites.favoritable_type': parent_class_name(self),
+                        'favorites.favoritor_type': favoritor_type,
+                        'favorites.scope': options[:scope])
+                    if options.has_key? :limit
+                        favorites = favorites.limit options[:limit]
+                    end
+                    if options.has_key? :includes
+                        favorites = favorites.includes options[:includes]
+                    end
+                    return favorites
                 end
-
-                favorites
             end
 
-            def favoritors_by_type_count favoritor_type
-                self.favorited.unblocked.for_favoritor_type(favoritor_type).count
+            def favoritors_by_type_count favoritor_type, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritor_type
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = favorited.unblocked.send(scope + '_list').for_favoritor_type(favoritor_type).count
+                    end
+                    return results
+                else
+                    return favorited.unblocked.send(options[:scope] + '_list').for_favoritor_type(favoritor_type).count
+                end
             end
 
             # Allows magic names on favoritors_by_type
@@ -60,53 +101,163 @@ module ActsAsFavoritor #:nodoc:
                 super || m.to_s[/count_(.+)_favoritors/] || m.to_s[/(.+)_favoritors/]
             end
 
-            def blocked_favoritors_count
-                self.favorited.blocked.count
+            def blocked_favoritors_count options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = favorited.blocked.send(scope + '_list').count
+                    end
+                    return results
+                else
+                    return favorited.blocked.send(options[:scope] + '_list').count
+                end
             end
 
             # Returns the favorited records scoped
-            def favoritors_scoped
-                self.favorited.includes :favoritor
+            def favoritors_scoped options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = favorited.send(scope + '_list').includes :favoritor
+                    end
+                    return results
+                else
+                    return favorited.send(options[:scope] + '_list').includes :favoritor
+                end
             end
 
             def favoritors options = {}
-                favoritors_scope = favoritors_scoped.unblocked
-                favoritors_scope = apply_options_to_scope favoritors_scope, options
-                favoritors_scope.to_a.collect{ |f| f.favoritor }
+                if options.has_key?(:multiple_scopes) == false
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        favoritors_scope = favoritors_scoped(scope).unblocked
+                        favoritors_scope = apply_options_to_scope favoritors_scope, options
+                        results[scope] = favoritors_scope.to_a.collect{ |f| f.favoritor }
+                    end
+                    return results
+                else
+                    favoritors_scope = favoritors_scoped(options[:scope]).unblocked
+                    favoritors_scope = apply_options_to_scope favoritors_scope, options
+                    return favoritors_scope.to_a.collect{ |f| f.favoritor }
+                end
             end
 
             def blocks options = {}
-                blocked_favoritors_scope = favoritors_scoped.blocked
-                blocked_favoritors_scope = apply_options_to_scope blocked_favoritors_scope, options
-                blocked_favoritors_scope.to_a.collect{ |f| f.favoritor }
+                if options.has_key?(:multiple_scopes) == false
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        blocked_favoritors_scope = favoritors_scoped(scope).blocked
+                        blocked_favoritors_scope = apply_options_to_scope blocked_favoritors_scope, options
+                        results[scope] = blocked_favoritors_scope.to_a.collect{ |f| f.favoritor }
+                    end
+                    return results
+                else
+                    blocked_favoritors_scope = favoritors_scoped(options[:scope]).blocked
+                    blocked_favoritors_scope = apply_options_to_scope blocked_favoritors_scope, options
+                    return blocked_favoritors_scope.to_a.collect{ |f| f.favoritor }
+                end
             end
 
             # Returns true if the current instance is favorited by the passed record
             # Returns false if the current instance is blocked by the passed record or no favorite is found
-            def favorited_by? favoritor
-                self.favorited.unblocked.for_favoritor(favoritor).first.present?
+            def favorited_by? favoritor, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritor
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = favorited.unblocked.send(scope + '_list').for_favoritor(favoritor).first.present?
+                    end
+                    return results
+                else
+                    return favorited.unblocked.send(options[:scope] + '_list').for_favoritor(favoritor).first.present?
+                end
             end
 
-            def block favoritor
-                get_favorite_for(favoritor) ? block_existing_favorite(favoritor) : block_future_favorite(favoritor)
+            def block favoritor, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritor
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = get_favorite_for(favoritor, scope: scope) ? block_existing_favorite(favoritor, scope: scope) : block_future_favorite(favoritor, scope: scope)
+                    end
+                    return results
+                else
+                    return get_favorite_for(favoritor, scope: options[:scope]) ? block_existing_favorite(favoritor, scope: options[:scope]) : block_future_favorite(favoritor, scope: options[:scope])
+                end
             end
 
-            def unblock favoritor
-                get_favorite_for(favoritor).update_attribute :blocked, false
+            def unblock favoritor, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritor
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = get_favorite_for(favoritor, scope: scope).update_attribute :blocked, false
+                    end
+                    return results
+                else
+                    return get_favorite_for(favoritor, scope: options[:scope]).update_attribute :blocked, false
+                end
             end
 
-            def get_favorite_for favoritor
-                self.favorited.for_favoritor(favoritor).first
+            def get_favorite_for favoritor, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritor
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = favorited.send(scope + '_list').for_favoritor(favoritor).first
+                    end
+                    return results
+                else
+                    return favorited.send(options[:scope] + '_list').for_favoritor(favoritor).first
+                end
             end
 
             private
 
-            def block_future_favorite favoritor
-                Favorite.create favoritable: self, favoritor: favoritor, blocked: true
+            def block_future_favorite favoritor, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritor
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = Favorite.create favoritable: self, favoritor: favoritor, blocked: true, scope: scope
+                    end
+                    return results
+                else
+                    return Favorite.create favoritable: self, favoritor: favoritor, blocked: true, scope: options[:scope]
+                end
             end
 
-            def block_existing_favorite favoritor
-                get_favorite_for(favoritor).block!
+            def block_existing_favorite favoritor, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritor
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = get_favorite_for(favoritor, scope: scope).block!
+                    end
+                    return results
+                else
+                    return get_favorite_for(favoritor, scope: options[:scope]).block!
+                end
             end
 
         end

data/lib/acts_as_favoritor/favorite_scopes.rb

@@ -1,6 +1,19 @@
 module ActsAsFavoritor #:nodoc:
     module FavoriteScopes
 
+        # send(scope + '_list') - returns favorite records of scope
+        Favorite.all.group_by(&:scope).each do |s|
+            Favorite.send(:define_method, "#{s}_list") do
+                where scope: s
+            end
+        end
+        def favorites_list
+            where scope: 'favorites'
+        end
+        def all_list
+            all
+        end
+
         # returns favorite records where favoritor is the record passed in.
         def for_favoritor favoritor
             where favoritor_id: favoritor.id, favoritor_type: parent_class_name(favoritor)

data/lib/acts_as_favoritor/favoritor.rb

@@ -16,72 +16,186 @@ module ActsAsFavoritor #:nodoc:
         module InstanceMethods
 
             # 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
+            def favorited? favoritable, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = 0 < Favorite.unblocked.send(scope + '_list').for_favoritor(self).for_favoritable(favoritable).count
+                    end
+                    return results
+                else
+                    return 0 < Favorite.unblocked.send(options[:scope] + '_list').for_favoritor(self).for_favoritable(favoritable).count
+                end
             end
 
             # Returns the number of objects this instance has favorited.
-            def favorites_count
-                Favorite.unblocked.for_favoritor(self).count
+            def favorites_count options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    raise options.to_s
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = Favorite.unblocked.send(scope + '_list').for_favoritor(self).count
+                    end
+                    return results
+                else
+                    return Favorite.unblocked.send(options[:scope] + '_list').for_favoritor(self).count
+                end
             end
 
             # Creates a new favorite record for this instance to favorite the passed object.
             # Does not allow duplicate records to be created.
-            def favorite favoritable
-                if self != favoritable
-                    params = {favoritable_id: favoritable.id, favoritable_type: parent_class_name(favoritable)}
-                    self.favorites.where(params).first_or_create!
+            def favorite favoritable, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        if self != favoritable && scope != 'all'
+                            params = {favoritable_id: favoritable.id, favoritable_type: parent_class_name(favoritable), scope: scope}
+                            results[scope] = favorites.where(params).first_or_create!
+                        end
+                    end
+                    return results
+                else
+                    if self != favoritable && options[:scope] != 'all'
+                        params = {favoritable_id: favoritable.id, favoritable_type: parent_class_name(favoritable), scope: options[:scope]}
+                        return favorites.where(params).first_or_create!
+                    end
                 end
             end
 
             # Deletes the favorite record if it exists.
-            def remove_favorite favoritable
-                if favorite = get_Favoritor(favoritable)
-                    favorite.destroy
+            def remove_favorite favoritable, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        if favorite = get_favorite(favoritable).send(scope + '_list')
+                            results[scope] = favorite.destroy
+                        end
+                    end
+                    return results
+                else
+                    if favorite = get_favorite(favoritable).send(options[:scope] + '_list')
+                        return favorite.destroy
+                    end
                 end
             end
 
             # returns the favorite records to the current instance
-            def favorites_scoped
-                self.favorites.unblocked.includes :favoritable
+            def favorites_scoped options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = favorites.unblocked.send(scope + '_list').includes :favoritable
+                    end
+                    return results
+                else
+                    return favorites.unblocked.send(options[:scope] + '_list').includes :favoritable
+                end
             end
 
             # Returns the favorite records related to this instance by type.
             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
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable_type
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        favorites_scope = favorites_scoped(scope).for_favoritable_type favoritable_type
+                        results[scope] = favorites_scope = apply_options_to_scope favorites_scope, options
+                    end
+                    return results
+                else
+                    favorites_scope = favorites_scoped(options[:scope]).for_favoritable_type favoritable_type
+                    return favorites_scope = apply_options_to_scope(favorites_scope, options)
+                end
             end
 
             # Returns the favorite records related to this instance with the favoritable included.
             def all_favorites options = {}
-                favorites_scope = favorites_scoped
-                favorites_scope = apply_options_to_scope favorites_scope, options
+                if options.has_key?(:multiple_scopes) == false
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        favorites_scope = favorites_scoped scope
+                        results[scope] = favorites_scope = apply_options_to_scope favorites_scope, options
+                    end
+                    return results
+                else
+                    favorites_scope = favorites_scoped options[:scope]
+                    return favorites_scope = apply_options_to_scope(favorites_scope, options)
+                end
             end
 
             # Returns the actual records which this instance has favorited.
             def all_favorited options = {}
-                all_favorites(options).collect{ |f| f.favoritable }
+                return all_favorites(options).collect{ |f| f.favoritable }
             end
 
             # Returns the actual records of a particular type which this record has fovarited.
             def favorited_by_type favoritable_type, options = {}
-                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)
-                if options.has_key? :limit
-                    favoritables = favoritables.limit options[:limit]
-                end
-                if options.has_key? :includes
-                    favoritables = favoritables.includes options[:includes]
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable_type
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        favoritables = favoritable_type.constantize.joins(:favorited).where('favorites.blocked': false,
+                            'favorites.favoritor_id': id,
+                            'favorites.favoritor_type': parent_class_name(self),
+                            'favorites.favoritable_type': favoritable_type,
+                            'favorites.scope': scope)
+                        if options.has_key? :limit
+                            favoritables = favoritables.limit options[:limit]
+                        end
+                        if options.has_key? :includes
+                            favoritables = favoritables.includes options[:includes]
+                        end
+                        results[scope] = favoritables
+                    end
+                    return results
+                else
+                    favoritables = favoritable_type.constantize.joins(:favorited).where('favorites.blocked': false,
+                        'favorites.favoritor_id': id,
+                        'favorites.favoritor_type': parent_class_name(self),
+                        'favorites.favoritable_type': favoritable_type,
+                        'favorites.scope': options[:scope])
+                    if options.has_key? :limit
+                        favoritables = favoritables.limit options[:limit]
+                    end
+                    if options.has_key? :includes
+                        favoritables = favoritables.includes options[:includes]
+                    end
+                    return favoritables
                 end
-                favoritables
             end
 
-            def favorited_by_type_count favoritable_type
-                favorites.unblocked.for_favoritable_type(favoritable_type).count
+            def favorited_by_type_count favoritable_type, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable_type
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = favorites.unblocked.send(scope + '_list').for_favoritable_type(favoritable_type).count
+                    end
+                    return results
+                else
+                    return favorites.unblocked.send(options[:scope] + '_list').for_favoritable_type(favoritable_type).count
+                end
             end
 
             # Allows magic names on favorited_by_type
@@ -103,8 +217,19 @@ module ActsAsFavoritor #:nodoc:
             end
 
             # Returns a favorite record for the current instance and favoritable object.
-            def get_favorite favoritable
-                self.favorites.unblocked.for_favoritable(favoritable).first
+            def get_favorite favoritable, options = {}
+                if options.has_key?(:multiple_scopes) == false
+                    options[:parameter] = favoritable
+                    validate_scopes __method__, options
+                elsif options[:multiple_scopes] == true
+                    results = {}
+                    options[:scope].each do |scope|
+                        results[scope] = favorites.unblocked.send(scope + '_list').for_favoritable(favoritable).first
+                    end
+                    return results
+                else
+                    return favorites.unblocked.send(options[:scope] + '_list').for_favoritable(favoritable).first
+                end
             end
 
         end

data/lib/acts_as_favoritor/favoritor_lib.rb

@@ -33,10 +33,24 @@ module ActsAsFavoritor
         end
 
         def parent_classes
-            return DEFAULT_PARENTS unless ActsAsFavoritor.custom_parent_classes
+            return DEFAULT_PARENTS
+        end
 
-            ActiveSupport::Deprecation.warn('Setting custom parent classes is deprecated and will be removed in future versions.')
-            ActsAsFavoritor.custom_parent_classes + DEFAULT_PARENTS
+        def validate_scopes method, options = {}
+            options[:scope] = options[:scope] || ['favorites']
+            if options[:scope].size > 1
+                options[:multiple_scopes] = true
+            else
+                options[:multiple_scopes] = false
+                options[:scope] = options[:scope][0]
+            end
+            if options.has_key? :parameter
+                parameter = options[:parameter]
+                options.delete :parameter
+                send method, parameter, options
+            else
+                send method, options
+            end
         end
 
     end

data/lib/acts_as_favoritor/version.rb

@@ -1,5 +1,5 @@
 module ActsAsFavoritor
 
-    VERSION = '1.0.2'
+    VERSION = '1.1.0'
 
 end

data/lib/generators/acts_as_favoritor_generator.rb

@@ -25,4 +25,8 @@ class ActsAsFavoritorGenerator < Rails::Generators::Base
         template 'model.rb', 'app/models/favorite.rb'
     end
 
+    def show_readme
+        readme 'README.md'
+    end
+
 end

data/lib/generators/templates/README.md

@@ -0,0 +1 @@
+Now run `rails db:migrate` to add acts_as_favoritor to your database.

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

@@ -3,7 +3,7 @@ class ActsAsFavoritorMigration < ActiveRecord::Migration<% if Rails::VERSION::MA
         create_table :favorites, force: true do |t|
             t.references :favoritable, polymorphic: true, null: false
             t.references :favoritor, polymorphic: true, null: false
-            t.string :scopes, default: [:favorites].to_yaml, null: false
+            t.string :scope, default: 'favorites', null: false
             t.boolean :blocked, default: false, null: false
             t.timestamps
         end
@@ -13,6 +13,6 @@ class ActsAsFavoritorMigration < ActiveRecord::Migration<% if Rails::VERSION::MA
     end
 
     def self.down
-    drop_table :favorites
+        drop_table :favorites
     end
 end

data/lib/generators/templates/model.rb

@@ -3,8 +3,6 @@ class Favorite < ActiveRecord::Base
     extend ActsAsFavoritor::FavoritorLib
     extend ActsAsFavoritor::FavoriteScopes
 
-    serialize :scopes
-
     # 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

@@ -82,8 +82,8 @@ class ActsAsFavoritableTest < ActiveSupport::TestCase
                 @jon.destroy
             end
 
-            should_change ('Favorite count', by: -1) { Favorite.count }
-            should_change ('@sam.all_favorited.size', by: -1) { @sam.all_favorited.size }
+            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

data/test/acts_as_favoritor_test.rb

@@ -9,7 +9,7 @@ class ActsAsFavoritorTest < ActiveSupport::TestCase
 
         should 'be defined' do
             assert @sam.respond_to? :favorited?
-            assert @sam.respond_to? :favorite_count
+            assert @sam.respond_to? :favorites_count
             assert @sam.respond_to? :favorite
             assert @sam.respond_to? :remove_favorite
             assert @sam.respond_to? :favorites_by_type
@@ -28,13 +28,13 @@ class ActsAsFavoritorTest < ActiveSupport::TestCase
 
         context 'favorited' do
             should 'return favorited_status' do
-                assert_equal true, @sam.favorited? @jon
-                assert_equal false, @jon.favorited? @sam
+                assert_equal true, @sam.favorited?(@jon)
+                assert_equal false, @jon.favorited?(@sam)
             end
 
-            should 'return favorite_count' do
-                assert_equal 2, @sam.favorite_count
-                assert_equal 0, @jon.favorite_count
+            should 'return favorites_count' do
+                assert_equal 2, @sam.favorites_count
+                assert_equal 0, @jon.favorites_count
             end
         end
 
@@ -44,7 +44,7 @@ class ActsAsFavoritorTest < ActiveSupport::TestCase
             end
 
             should_change('Favorite count', by: 1) { Favorite.count }
-            should_change('@jon.favorite_count', by: 1) { @jon.favorite_count }
+            should_change('@jon.favorites_count', by: 1) { @jon.favorites_count }
 
             should "set the favoritor" do
                 assert_equal @jon, Favorite.last.favoritor
@@ -61,7 +61,7 @@ class ActsAsFavoritorTest < ActiveSupport::TestCase
             end
 
             should_not_change('Favorite count') { Favorite.count }
-            should_not_change('@jon.favorite_count') { @jon.favorite_count }
+            should_not_change('@jon.favorites_count') { @jon.favorites_count }
 
             should 'not set the favoritor' do
                 assert_not_equal @jon, Favorite.last.favoritor
@@ -78,7 +78,7 @@ class ActsAsFavoritorTest < ActiveSupport::TestCase
             end
 
             should_change('Favorite count', by: -1) { Favorite.count }
-            should_change('@sam.favorite_count', by: -1) { @sam.favorite_count }
+            should_change('@sam.favorites_count', by: -1) { @sam.favorites_count }
         end
 
         context 'favorites' do
@@ -194,7 +194,7 @@ class ActsAsFavoritorTest < ActiveSupport::TestCase
             end
 
             should_change('Favorite.count', by: -1) { Favorite.count }
-            should_change('@sam.favorite_count', by: -1) { @sam.favorite_count }
+            should_change('@sam.favorites_count', by: -1) { @sam.favorites_count }
         end
 
         context "blocked by favoritable" do
@@ -206,8 +206,8 @@ class ActsAsFavoritorTest < ActiveSupport::TestCase
                 assert_equal false, @sam.favorited?(@jon)
             end
 
-            should 'return favorite_count' do
-                assert_equal 1, @sam.favorite_count
+            should 'return favorites_count' do
+                assert_equal 1, @sam.favorites_count
             end
 
             should 'not return record of the blocked favorites' do

data/test/dummy30/config/environments/development.rb

@@ -3,4 +3,5 @@ Dummy::Application.configure do
     config.whiny_nils = true
     config.consider_all_requests_local = true
     config.active_support.deprecation = :log
+    config.eager_load = false
 end

data/test/dummy30/config/environments/test.rb

@@ -2,4 +2,5 @@ Dummy::Application.configure do
     config.cache_classes = true
     config.consider_all_requests_local = true
     config.active_support.deprecation = :stderr
+    config.eager_load = false
 end

data/test/favorite_test.rb

@@ -7,22 +7,4 @@ class FavoriteTest < ActiveSupport::TestCase
         assert true
     end
 
-    context 'configuration with setters' do
-        should 'contain custom parents' do
-            ActsAsFavoritor.custom_parent_classes = [CustomRecord]
-
-            assert_equal [CustomRecord], ActsAsFavoritor.custom_parent_classes
-        end
-    end
-
-    context '#setup' do
-        should 'contain custom parents via setup' do
-            ActsAsFavoritor.setup do |c|
-                c.custom_parent_classes = [CustomRecord]
-            end
-
-            assert_equal [CustomRecord], ActsAsFavoritor.custom_parent_classes
-        end
-    end
-
 end

data/test/schema.rb

@@ -5,7 +5,7 @@ ActiveRecord::Schema.define version: 0 do
         t.string   'favoritable_type', null: false
         t.integer  'favoritor_id', null: false
         t.string   'favoritor_type', null: false
-        t.string   'scopes', default: [:favorites].to_yaml, null: false
+        t.string :scope, default: 'favorites', null: false
         t.boolean  'blocked', default: false, null: false
         t.datetime 'created_at'
         t.datetime 'updated_at'

data/test/test_helper.rb

@@ -1,6 +1,10 @@
 # Configure Rails Envinronment
 ENV['RAILS_ENV'] = 'test'
 
+# # Test Coverage
+# require 'simplecov'
+# SimpleCov.start
+
 require File.expand_path '../dummy30/config/environment.rb', __FILE__
 require 'rails/test_help'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_favoritor
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-22 00:00:00.000000000 Z
+date: 2017-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2017'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2017'
 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
@@ -104,9 +118,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/issue_template.md"
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".travis.yml"
-- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- DEPRECATIONS.md
 - Gemfile
 - LICENSE
 - README.md
@@ -120,11 +138,10 @@ files:
 - lib/acts_as_favoritor/favoritor_lib.rb
 - lib/acts_as_favoritor/railtie.rb
 - lib/acts_as_favoritor/version.rb
-- lib/generators/USAGE
 - lib/generators/acts_as_favoritor_generator.rb
+- lib/generators/templates/README.md
 - lib/generators/templates/migration.rb.erb
 - lib/generators/templates/model.rb
-- test/README
 - test/acts_as_favoritable_test.rb
 - test/acts_as_favoritor_test.rb
 - test/dummy30/Gemfile

data/CHANGELOG.md

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

data/lib/generators/USAGE

@@ -1,5 +0,0 @@
-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/test/README

@@ -1,24 +0,0 @@
-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.