cache_depends_on 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc9cd539c0b5d27ae04edbc2858505f176fdf130
+  data.tar.gz: 627fcf125320c3827fbc1be01063b87215e53119
+SHA512:
+  metadata.gz: 5f9261d4eebf2386de8a00d59053c099d2f2900c0bb7a6289aadf6bb25447c64f7c000573a60799d98845264a1bf004c021ac626d357721b4f957452d463716a
+  data.tar.gz: e4eedbe151de73a1d9834f0427e24b009e4bbc75b29a2f169f0014d6a70380e1767b2f8b9883f3ae9d6952c78ac85e718732fd78a275b5e4d2551e8aced99c9e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/eproject.cfg
+*.gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+cache_depends_on

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.6
+
+gemfile:
+  - gemfiles/activerecord_4.gemfile
+  - gemfiles/activerecord_5.gemfile

data/Appraisals

@@ -0,0 +1,7 @@
+appraise 'activerecord-4' do
+  gem 'activerecord', '~> 4'
+end
+
+appraise 'activerecord-5' do
+  gem 'activerecord', '~> 5'
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daniel Vartanov
+
+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,70 @@
+cache_depends_on
+================
+
+A better way of controlling cache dependencies than `belongs_to :product, touch: true`
+
+
+Example
+-------
+
+```ruby
+class Author < ActiveRecord::Base
+  has_many :artciles
+
+  cache_depends_on :articles
+end
+
+class Artcile < ActiveRecord::Base
+  belongs_to :rating
+
+  cache_depends_on :rating
+end
+
+class Rating < ActiveRecord::Base
+  has_one :article
+end
+```
+
+`CacheDependsOn` can deal with any kinds of ActiveRecord associations.
+
+...console/SQL log...
+
+
+Important notes
+---------------
+
+### Cache invalidation always happens outside transaction
+
+...why...
+
+### Each row will be updated only ones per transaction if properly configured
+
+If an Author has five articles and all of them are updated within a transaction, the Author will be updated *only once*.
+
+...why it is important...
+...how to establish 'ideal relationships' between ActiveRecord models.
+
+
+How to install
+--------------
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem 'cache_depends_on'
+```
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/veeqo/cache_depends_on.
+
+
+
+Sponsored by [Veeqo](https://github.com/veeqo)

data/Rakefile

@@ -0,0 +1,9 @@
+require "rubygems"
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cache_depends_on"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cache_depends_on.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cache_depends_on/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cache_depends_on'
+  spec.version       = CacheDependsOn::VERSION
+  spec.authors       = ['Daniel Vartanov']
+  spec.email         = ['dan@vartanov.net']
+
+  spec.summary       = %q{A better way of controlling cache dependencies than 'belongs_to :product, touch: true'}
+  spec.description   = %q{A better way of controlling cache dependencies than 'belongs_to :product, touch: true'}
+  spec.homepage      = 'https://github.com/veeqo/cache_depends_on'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '> 3', '< 6'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'appraisal'
+end

data/gemfiles/activerecord_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4"
+
+gemspec :path => "../"

data/gemfiles/activerecord_5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5"
+
+gemspec :path => "../"

data/lib/cache_depends_on/active_record_model_extension.rb

@@ -0,0 +1,27 @@
+require 'active_record'
+require 'active_support/concern'
+
+module CacheDependsOn
+  module ActiveRecordModelExtension
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor(:invalidates_cache_of) { [] }
+
+      after_commit { invalidate_dependent_caches }
+
+      define_model_callbacks :cache_invalidation
+    end
+
+    def invalidate_cache
+      touch
+    end
+
+    def invalidate_dependent_caches
+      run_callbacks(:cache_invalidation) do
+        invalidates_cache_of.select(&:collection?).each { |association| __send__(association.name).each(&:invalidate_cache) }
+        invalidates_cache_of.reject(&:collection?).each { |association| __send__(association.name).try(:invalidate_cache) }
+      end
+    end
+  end
+end

data/lib/cache_depends_on/association_cache_dependency_definer.rb

@@ -0,0 +1,48 @@
+module CacheDependsOn
+  class AssociationCacheDependencyDefiner
+    def initialize(model_klass)
+      @model_klass = model_klass
+    end
+    attr_reader :model_klass
+
+    def define_cache_dependency_on(association_names)
+      model_klass.class_eval { include ActiveRecordModelExtension }
+
+      find_associations_by_names(association_names).each do |association|
+        association.klass.class_eval { include ActiveRecordModelExtension }
+        association.klass.invalidates_cache_of << find_inverse_of(association)
+      end
+    end
+
+    private
+
+    def find_associations_by_names(association_names)
+      association_names.map do |association_name|
+        model_klass.reflect_on_association(association_name).tap do |association|
+          raise AssociationNotFound, "association #{association_name} was not found in #{model_klass.name}" if association.nil?
+        end
+      end
+    end
+
+    def find_inverse_of(association)
+      find_polymorphic_inverse_of(association) ||
+        find_singular_inverse_of(association) ||
+        find_plural_inverse_of(association) ||
+        raise(ReverseAssociationNotFound, "reverse association of #{model_klass} was not found in #{association.klass}")
+    end
+
+    def find_singular_inverse_of(association)
+      suggested_singular_reverse_association_name = model_klass.model_name.singular.to_sym
+      association.klass.reflect_on_association suggested_singular_reverse_association_name
+    end
+
+    def find_plural_inverse_of(association)
+      suggested_plural_reverse_association_name = model_klass.model_name.plural.to_sym
+      association.klass.reflect_on_association suggested_plural_reverse_association_name
+    end
+
+    def find_polymorphic_inverse_of(association)
+      association.klass.reflect_on_association association.options[:as]
+    end
+  end
+end

data/lib/cache_depends_on/exceptions.rb

@@ -0,0 +1,4 @@
+module CacheDependsOn
+  class AssociationNotFound < RuntimeError; end
+  class ReverseAssociationNotFound < RuntimeError; end
+end

data/lib/cache_depends_on/version.rb

@@ -0,0 +1,3 @@
+module CacheDependsOn
+  VERSION = "0.1.0"
+end

data/lib/cache_depends_on.rb

@@ -0,0 +1,13 @@
+require 'cache_depends_on/exceptions'
+require 'cache_depends_on/association_cache_dependency_definer'
+require 'cache_depends_on/active_record_model_extension'
+
+module CacheDependsOn
+  module ClassMethods
+    def cache_depends_on(*association_names)
+      AssociationCacheDependencyDefiner.new(self).define_cache_dependency_on association_names
+    end
+  end
+end
+
+ActiveRecord::Base.extend CacheDependsOn::ClassMethods

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: cache_depends_on
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Vartanov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: sqlite3
+  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: database_cleaner
+  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: appraisal
+  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: 'A better way of controlling cache dependencies than ''belongs_to :product,
+  touch: true'''
+email:
+- dan@vartanov.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cache_depends_on.gemspec
+- gemfiles/activerecord_4.gemfile
+- gemfiles/activerecord_5.gemfile
+- lib/cache_depends_on.rb
+- lib/cache_depends_on/active_record_model_extension.rb
+- lib/cache_depends_on/association_cache_dependency_definer.rb
+- lib/cache_depends_on/exceptions.rb
+- lib/cache_depends_on/version.rb
+homepage: https://github.com/veeqo/cache_depends_on
+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.6.8
+signing_key: 
+specification_version: 4
+summary: 'A better way of controlling cache dependencies than ''belongs_to :product,
+  touch: true'''
+test_files: []