acts_as_favoritor 1.2.2 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82f55876158cb217b9c1a1b4509ca4801a8c342a
-  data.tar.gz: 63af11cb03f00c80de75a7d3ef497bb79ba30365
+  metadata.gz: 14b98ac10e904c740a31afb1a221de5db6d0bca2
+  data.tar.gz: bb136d5035521b41db3cd888a96bcc991c405862
 SHA512:
-  metadata.gz: 60dea8ed48a7852a799daf4b755f4cf9feb68275180c5180db1e321bf34a4db62742084eafe26b1d7e2417db761ae8abe04a5689f2f5b3a03ae6e8ab15bd6ff5
-  data.tar.gz: 411342b41fb29a9e5d7d72c99d16ff0d41e754d2f3709066fc7330f69c54f2e4487d17e041fb634bbd6d09f37b344422160d75505ebf96cc20f6c490c43e4096
+  metadata.gz: ee95fe8c8bd1528dea8a57f6fa9c992c5ff449c140fbdf03f6949514e7a6e10d99e1775fb3864c902c6b0090d74ee2c273929923c6468882db2e988e3a42c8ab
+  data.tar.gz: 114e8d8ba89bc8f4f0257847eb7bd8720367088e32c94ea90569186a28dc96ce36f7534ffdf8600c9295706a144bf35c2bf8a3541d91a41e8a6467aa4a1ab6a5

data/CHANGELOG.md

@@ -4,6 +4,11 @@
 
 * nothing yet
 
+### 1.3.2 - 2017-08-31
+
+* features
+    * add caching functionality to `acts_as_favoritor` & `acts_as_favoritable` model
+
 ### 1.2.2 - 2017-08-24
 
 * bugfixes

data/README.md

@@ -1,6 +1,6 @@
 # `acts_as_favoritor` - Add Favorites to your Rails app
 
-<img src="https://travis-ci.org/slooob/acts_as_favoritor.svg?branch=master" />
+<img src="https://travis-ci.org/slooob/acts_as_favoritor.svg?branch=master" /> [![Gem Version](https://badge.fury.io/rb/acts_as_favoritor.svg)](https://badge.fury.io/rb/acts_as_favoritor)
 
 `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.
 
@@ -17,6 +17,7 @@ You are able to differentiate followers, favorites, watchers, votes and whatever
     * [`acts_as_favoritable` methods](#acts_as_favoritable-methods)
     * [`Favorite` model](#favorite-model)
     * [Scopes](#scopes)
+    * [Caching](#caching)
 * [Configuration](#configuration)
 * [Testing](#testing)
     * [Test Coverage](#test-coverage)
@@ -55,6 +56,8 @@ Now run the generator:
 
 You can set your default scope by passing `--scope custom_scope`. Learn more about scopes [here](#scopes).
 
+If you specify `--cache true`, `acts_as_favoritor` will be using cache. Learn more about caching [here](#caching).
+
 You can skip the creation of a configuration file by passing `--skip_configuration`. Learn more about configuring `acts_as_favoritor` [here](#configuration).
 
 To wrap things up, migrate the changes into your database:
@@ -269,6 +272,35 @@ Favorite.watching_list
 Favorite.all_list
 ```
 
+### Caching
+
+When you set the option `cache` in `config/acts_as_favoritor` to true, you are able to cache the amount of favorites/favoritables an instance has regarding a scope.
+
+For that you need to add some database columns:
+
+*acts_as_favoritor*
+
+```ruby
+add_column :users, :favoritor_cache, :text, default: {}.to_yaml, null: false
+```
+
+*acts_as_favoritable*
+
+```ruby
+add_column :users, :favoritable_cache, :text, default: {}.to_yaml, null: false
+add_column :books, :favoritable_cache, :text, default: {}.to_yaml, null: false
+```
+
+Caches are stored as hashes with scopes as keys:
+
+```ruby
+user.favoritor_cache # => { favorite: 1 }
+second_user.favoritable_cache # => { follow: 1 }
+book.favoritable_cache # => { favorite: 1 }
+```
+
+**Note:** Only scopes who have favorites are included.
+
 ---
 
 ## Configuration
@@ -314,7 +346,6 @@ Test coverage can be calculated using SimpleCov. Make sure you have the [simplec
 ## To Do
 
 * Adding magic methods for scopes, e.g.: `user.follow second_user` instead of `user.favorite second_user, scope: [:follow]`
-* Allow for caching of counters in the database table of `acts_as_favoritable`.
 
 ---
 

data/Rakefile

@@ -14,12 +14,3 @@ Rake::TestTask.new(:test) do |t|
     t.pattern = 'test/**/*_test.rb'
     t.verbose = true
 end
-
-desc 'Generate documentation for the acts_as_favoritor gem.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-    rdoc.rdoc_dir = 'rdoc'
-    rdoc.title    = 'Acts As Favoritor'
-    rdoc.main     = 'README.rdoc'
-    rdoc.options << '--line-numbers' << '--inline-source'
-    rdoc.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
-end

data/acts_as_favoritor.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |gem|
     gem.platform              = Gem::Platform::RUBY
     gem.summary               = 'A Rubygem to add Favorite, Follow, Vote, etc. functionality to ActiveRecord models'
     gem.description           = '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, votes 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.'
-    gem.authors               = ['Jonas Hübotter']
+    gem.authors               = 'Slooob'
     gem.email                 = 'developer@slooob.com'
-    gem.homepage              = 'https://github.com/slooob/acts_as_favoritor'
+    gem.homepage              = 'https://developer.slooob.com/open-source'
     gem.license               = 'MIT'
 
     gem.files                 = `git ls-files`.split("\n")

data/lib/acts_as_favoritor/configuration.rb

@@ -9,6 +9,15 @@ module ActsAsFavoritor
         end
     end
 
+    def self.cache
+        config = get_config
+        if config&.key :cache
+            config[:cache]
+        else
+            false
+        end
+    end
+
 
     private
 

data/lib/acts_as_favoritor/favoritable.rb

@@ -10,6 +10,8 @@ module ActsAsFavoritor #:nodoc:
                 has_many :favorited, as: :favoritable, dependent: :destroy, class_name: 'Favorite'
                 include ActsAsFavoritor::Favoritable::InstanceMethods
                 include ActsAsFavoritor::FavoritorLib
+
+                serialize :favoritable_cache, Hash if ActsAsFavoritor.cache
             end
         end
 

data/lib/acts_as_favoritor/favoritor.rb

@@ -10,6 +10,8 @@ module ActsAsFavoritor #:nodoc:
                 has_many :favorites, as: :favoritor, dependent: :destroy
                 include ActsAsFavoritor::Favoritor::InstanceMethods
                 include ActsAsFavoritor::FavoritorLib
+
+                serialize :favoritor_cache, Hash if ActsAsFavoritor.cache
             end
         end
 
@@ -101,6 +103,12 @@ module ActsAsFavoritor #:nodoc:
                 elsif options[:multiple_scopes]
                     results = {}
                     options[:scope].each do |scope|
+                        if ActsAsFavoritor.cache
+                            self.favoritor_cache[scope] = self.favoritor_cache[scope] + 1 || 1
+                            self.save!
+                            favoritable.favoritable_cache[scope] = favoritable.favoritable_cache[scope] + 1 || 1
+                            favoritable.save!
+                        end
                         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!
@@ -108,6 +116,12 @@ module ActsAsFavoritor #:nodoc:
                     end
                     return results
                 else
+                    if ActsAsFavoritor.cache
+                        self.favoritor_cache[options[:scope]] = self.favoritor_cache[options[:scope]] + 1 || 1
+                        self.save!
+                        favoritable.favoritable_cache[options[:scope]] = favoritable.favoritable_cache[options[:scope]] + 1 || 1
+                        favoritable.save!
+                    end
                     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!
@@ -123,12 +137,28 @@ module ActsAsFavoritor #:nodoc:
                 elsif options[:multiple_scopes]
                     results = {}
                     options[:scope].each do |scope|
+                        if ActsAsFavoritor.cache
+                            self.favoritor_cache[scope] = self.favoritor_cache[scope] - 1
+                            self.favoritor_cache.delete(scope) unless self.favoritor_cache[scope] > 0
+                            self.save!
+                            favoritable.favoritable_cache[scope] = favoritable.favoritable_cache[scope] - 1
+                            favoritable.favoritable_cache.delete(scope) unless favoritable.favoritable_cache[scope] > 0
+                            favoritable.save!
+                        end
                         if favorite = get_favorite(favoritable, scope: scope, multiple_scopes: false)
                             results[scope] = favorite.destroy
                         end
                     end
                     return results
                 else
+                    if ActsAsFavoritor.cache
+                        self.favoritor_cache[options[:scope]] = self.favoritor_cache[options[:scope]] - 1
+                        self.favoritor_cache.delete(options[:scope]) unless self.favoritor_cache[options[:scope]] > 0
+                        self.save!
+                        favoritable.favoritable_cache[options[:scope]] = favoritable.favoritable_cache[options[:scope]] - 1
+                        favoritable.favoritable_cache.delete(options[:scope]) unless favoritable.favoritable_cache[options[:scope]] > 0
+                        favoritable.save!
+                    end
                     if favorite = get_favorite(favoritable, scope: options[:scope], multiple_scopes: false)
                         return favorite.destroy
                     end

data/lib/acts_as_favoritor/version.rb

@@ -1,5 +1,5 @@
 module ActsAsFavoritor
 
-    VERSION = '1.2.2'
+    VERSION = '1.3.2'
 
 end

data/lib/generators/acts_as_favoritor_generator.rb

@@ -8,6 +8,7 @@ class ActsAsFavoritorGenerator < Rails::Generators::Base
     source_root File.join File.dirname(__FILE__), 'templates'
     desc 'Install acts_as_favoritor'
     class_option :scope, desc: 'Specify your default scope. Learn more about scopes here: https://github.com/slooob/acts_as_favoritor#scopes', type: :string, default: 'favorite', aliases: '-s'
+    class_option :cache, desc: 'Enable caching. Learn more about caching here: https://github.com/slooob/acts_as_favoritor#caching', type: :boolean, default: false, aliases: '-c'
     class_option :skip_configuration, desc: 'Skip the creation of the configuration file. Learn more about configuring acts_as_favoritor here: https://github.com/slooob/acts_as_favoritor#configuration', type: :boolean, default: false
 
     def self.next_migration_number dirname

data/lib/generators/templates/acts_as_favoritor.yml.erb

@@ -4,3 +4,6 @@
 
 # Specify your default scope. Learn more about scopes here: https://github.com/slooob/acts_as_favoritor#scopes
 default_scope: <%= options[:scope] %>
+
+# Enable caching. Learn more about caching here: https://github.com/slooob/acts_as_favoritor#caching
+cache: <%= options[:cache] %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_favoritor
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.2
 platform: ruby
 authors:
-- Jonas Hübotter
+- Slooob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -175,7 +175,7 @@ files:
 - test/favorite_test.rb
 - test/schema.rb
 - test/test_helper.rb
-homepage: https://github.com/slooob/acts_as_favoritor
+homepage: https://developer.slooob.com/open-source
 licenses:
 - MIT
 metadata: {}