conditional_counter_cache 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a7dd773fc250091226da0a2a5efdedc39b8da51
+  data.tar.gz: 1d9d5bcc9e6712100f44ef3894243c77bd67a12c
+SHA512:
+  metadata.gz: f6fc68c2c9700a7456d1f3de057010645f390b8ae4a9e608b6d4809ac84128f4d5788faad1d44f101d5b3aa274ad2987d0274c748ad3a6c73e0e3957d4938547
+  data.tar.gz: 484034592c1b600f73ef671592ea2211c97da011451a872f4007890812c920c0e7ac2e09f7730b115615be484745752e23bae9810d0d5c88e9d562678cee2071

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 conditional_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,22 @@
+# ConditionalCounterCache
+Allows you to customize condition of counter cache.
+
+## Usage
+Customize condition via `:counter_cache` option:
+
+```ruby
+class Tagging < ActiveRecord::Base
+  belongs_to :item
+  belongs_to :tag, counter_cache: { condition: -> { !tagging.item.private? } }
+end
+```
+
+Other examples:
+
+```ruby
+belongs_to :tag, counter_cache: true
+belongs_to :tag, counter_cache: "items_count"
+belongs_to :tag, counter_cache: { condition: -> { !tagging.item.private? } }
+belongs_to :tag, counter_cache: { column_name: "items_count" }
+belongs_to :tag, counter_cache: { column_name: "items_count", condition: -> { !tagging.item.private? } }
+```

data/Rakefile

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

data/conditional_counter_cache.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'conditional_counter_cache/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "conditional_counter_cache"
+  spec.version       = ConditionalCounterCache::VERSION
+  spec.authors       = ["Ryo Nakamura"]
+  spec.email         = ["r7kamura@gmail.com"]
+  spec.summary       = "Allows you to customize condition of counter cache."
+  spec.homepage      = "https://github.com/r7kamura/conditional_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_dependency "activerecord", ">= 4.0.0", "< 4.2.0"
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "3.0.2"
+  spec.add_development_dependency "rspec-rails"
+end

data/lib/conditional_counter_cache/active_record.rb

@@ -0,0 +1,4 @@
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Reflection::AssociationReflection.prepend(ConditionalCounterCache::Reflection)
+  ActiveRecord::Associations::Builder::BelongsTo.singleton_class.prepend(ConditionalCounterCache::BelongsTo)
+end

data/lib/conditional_counter_cache/belongs_to.rb

@@ -0,0 +1,52 @@
+module ConditionalCounterCache
+  # Overrides ActiveRecord 4.1.4's counter cache implementation.
+  module BelongsTo
+    def add_counter_cache_methods(mixin)
+      return if mixin.method_defined? :belongs_to_counter_cache_after_create
+
+      mixin.class_eval do
+        def belongs_to_counter_cache_after_create(reflection)
+          if record = send(reflection.name)
+            return unless reflection.has_countable?(self)
+            cache_column = reflection.counter_cache_column
+            record.class.increment_counter(cache_column, record.id)
+            @_after_create_counter_called = true
+          end
+        end
+
+        def belongs_to_counter_cache_before_destroy(reflection)
+          foreign_key = reflection.foreign_key.to_sym
+          unless destroyed_by_association && destroyed_by_association.foreign_key.to_sym == foreign_key
+            record = send reflection.name
+            if record && !self.destroyed?
+              return unless reflection.has_countable?(self)
+              cache_column = reflection.counter_cache_column
+              record.class.decrement_counter(cache_column, record.id)
+            end
+          end
+        end
+
+        def belongs_to_counter_cache_after_update(reflection)
+          foreign_key  = reflection.foreign_key
+          cache_column = reflection.counter_cache_column
+
+          if (@_after_create_counter_called ||= false)
+            @_after_create_counter_called = false
+          elsif attribute_changed?(foreign_key) && !new_record? && reflection.constructable?
+            return unless reflection.has_countable?(self)
+            model           = reflection.klass
+            foreign_key_was = attribute_was foreign_key
+            foreign_key     = attribute foreign_key
+
+            if foreign_key && model.respond_to?(:increment_counter)
+              model.increment_counter(cache_column, foreign_key)
+            end
+            if foreign_key_was && model.respond_to?(:decrement_counter)
+              model.decrement_counter(cache_column, foreign_key_was)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/conditional_counter_cache/reflection.rb

@@ -0,0 +1,73 @@
+module ConditionalCounterCache
+  module Reflection
+    # @note Overridden
+    def counter_cache_column
+      Option.new(options[:counter_cache]).column_name ||
+        "#{active_record.name.demodulize.underscore.pluralize}_count"
+    end
+
+    # @return [true, false]
+    def has_countable?(record)
+      Option.new(options[:counter_cache]).condition.call(record)
+    end
+
+    # Utility wrapper of `option[:counter_cache][:condition]`.
+    class Condition
+      # @param [Proc, String, Symbol, nil]
+      def initialize(value)
+        @value = value
+      end
+
+      def call(record)
+        case @value
+        when Proc
+          record.instance_exec(&@value)
+        when nil
+          true
+        else
+          record.send(@value)
+        end
+      end
+    end
+
+    # Utility wrapper of `option[:counter_cache]`.
+    class Option
+      # @param [Hash, String, true, nil]
+      def initialize(value)
+        @value = value
+      end
+
+      # @return [String, nil] Specified column name, or nil meaning "use default column name".
+      def column_name
+        case
+        when has_hash_value?
+          @value[:column_name]
+        when has_true_value?
+          nil
+        else
+          @value.to_s
+        end
+      end
+
+      # @return [Condition]
+      def condition
+        Condition.new(raw_condition)
+      end
+
+      private
+
+      def has_hash_value?
+        @value.is_a?(Hash)
+      end
+
+      def has_true_value?
+        @value == true
+      end
+
+      # @return [Proc, String, Symbol, nil]
+      def raw_condition
+        @value[:condition] if has_hash_value?
+      end
+    end
+  end
+end

data/lib/conditional_counter_cache/version.rb

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

data/lib/conditional_counter_cache.rb

@@ -0,0 +1,6 @@
+require "active_record"
+
+require "conditional_counter_cache/belongs_to"
+require "conditional_counter_cache/reflection"
+require "conditional_counter_cache/version"
+require "conditional_counter_cache/active_record"

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: conditional_counter_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryo Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- r7kamura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- conditional_counter_cache.gemspec
+- lib/conditional_counter_cache.rb
+- lib/conditional_counter_cache/active_record.rb
+- lib/conditional_counter_cache/belongs_to.rb
+- lib/conditional_counter_cache/reflection.rb
+- lib/conditional_counter_cache/version.rb
+homepage: https://github.com/r7kamura/conditional_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: Allows you to customize condition of counter cache.
+test_files: []
+has_rdoc: