volatile_counter_cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8269703b195a013b43674ac19dd4a7bd7e659a87
+  data.tar.gz: 65704e49e6dad06b31f4cc4ce704938fb570e407
+SHA512:
+  metadata.gz: 3e6dcf87c79f3f26817f6377154cb620c6754fa5d42e6aa7dc5da99a995828e3b8b044a935ced5c86e21f4e79058bdefe17d4236221d8c9cff1c124dc208961b
+  data.tar.gz: 0109f3d4c1b22b1d9e519769e733299773c04d01d415c0b90a04f5638f9393c34826ef0e34d78dba2c635830b8dcc4802e6d610e764e2357762ca168fb93fa3c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in volatile_counter_cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryo Nakamura
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# VolatileCounterCache
+Provides volatile counter cache logic to ActiveRecord::Base.
+
+## Usage
+1. `favorites_count` tries to read counter cache from Rails.cache.
+2. If there is no cache yet, it calls `favorites.count` and store the result.
+3. When `favorite` is created or destroyed, the cache is purged.
+
+```ruby
+class Tweet < ActiveRecord::Base
+  include VolatileCounterCache
+
+  has_many :favorites
+
+  volatile_counter_cache :favorites, cache: Rails.cache
+end
+
+Tweet.first.favorites_count #=> 42
+Tweet.first.favorites.first.destroy
+Tweet.first.favorites_count #=> 41
+```
+
+### options
+- cache [ActiveSupport::Cache::Store] A store object to store count for each key.
+- cache_options [Hash] Options for cache store.
+- counter_method_name [String] An optional String to change counter method name.
+- foreign_key [Symbol] An optional Symbol to change cache key at callback.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/volatile_counter_cache/version.rb

@@ -0,0 +1,3 @@
+module VolatileCounterCache
+  VERSION = "0.0.1"
+end

data/lib/volatile_counter_cache.rb

@@ -0,0 +1,46 @@
+require "volatile_counter_cache/version"
+
+# A model concern module to provide volatile counter cache logic to model class.
+#
+# @example
+#   class Tweet < ActiveRecord::Base
+#     include VolatileCounterCache
+#     has_many :favorites
+#     volatile_counter_cache :favorites, cache: Rails.cache
+#   end
+#   Tweet.first.favorites_count #=> 42
+#   Tweet.first.favorites.first.destroy
+#   Tweet.first.favorites_count #=> 41
+#
+module VolatileCounterCache
+  CACHE_KEY_PREFIX = 'volatile-counter-cache'
+
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    # Define counter method and callback using given cache store for 1:N association.
+    # @param association_name [Symbol] Association name used to counter method, cache key, and counting.
+    # @param cache [ActiveSupport::Cache::Store] A store object to store count for each key.
+    # @param cache_options [Hash] Options for cache store.
+    # @param counter_method_name [String] An optional String to change counter method name.
+    # @param foreign_key [Symbol] An optional Symbol to change cache key at callback.
+    def volatile_counter_cache(association_name, cache:, cache_options: {}, counter_method_name: nil, foreign_key: nil)
+      counter_method_name = counter_method_name || "#{association_name}_count"
+      cache_key_prefix = "#{CACHE_KEY_PREFIX}/#{model_name}/#{association_name}"
+
+      define_method(counter_method_name) do
+        cache.fetch("#{cache_key_prefix}/#{id}", cache_options) do
+          send(association_name).count
+        end
+      end
+
+      foreign_key = foreign_key || "#{table_name.singularize }_id"
+      child_class = association_name.to_s.singularize.camelize.constantize
+      callback_proc = -> do
+        cache.delete("#{cache_key_prefix}/#{send(foreign_key)}", cache_options)
+      end
+      child_class.after_create(&callback_proc)
+      child_class.after_destroy(&callback_proc)
+    end
+  end
+end

data/volatile_counter_cache.gemspec

@@ -0,0 +1,21 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "volatile_counter_cache/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "volatile_counter_cache"
+  spec.version       = VolatileCounterCache::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Provides volatile counter cache logic to ActiveRecord::Base."
+  spec.homepage      = "https://github.com/r7kamura/volatile_counter_cache"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: volatile_counter_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/volatile_counter_cache.rb
+- lib/volatile_counter_cache/version.rb
+- volatile_counter_cache.gemspec
+homepage: https://github.com/r7kamura/volatile_counter_cache
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Provides volatile counter cache logic to ActiveRecord::Base.
+test_files: []
+has_rdoc: