blanket_cachekey 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c43fd6f678e4f9481bf71a1b1770af8dd7251b1e
+  data.tar.gz: 5d89e7eebcc30c4522f1c8451e10a767982175c2
+SHA512:
+  metadata.gz: a4fe76b95dec7bbc2666b885beb65b061c68df9a981e1a32d5aff24787459245bddc7433c51d679f127fcd4b72370edc9f471929bb61156c405e1bcffea48e5b
+  data.tar.gz: 70cc8a76bc0128699aced831b63cd6a6c9274969b69fd8e96f9c51ecfee95d27669dc8414a631ce87409c33e0d9e25e6f17545b66a0f4375b51c5c8e8573d02a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Karl Baum
+
+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,56 @@
+# BlanketCachekey
+
+[![Build Status](https://secure.travis-ci.org/kbaum/blanket_cachekey.png)](http://travis-ci.org/kbaum/blanket_cachekey)
+
+
+Provides a rails cache key for caching data that should be invalidated whenever any ActiveRecord instance of a specific type is created, updated, or destroyed.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blanket_cachekey'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blanket_cachekey
+
+## Usage
+
+Include BlanketCachekey within your ActiveRecord class:
+
+```ruby
+class Bar < ActiveRecord::Base
+
+  include BlanketCachekey
+
+end
+```
+
+Now Bar has a blanket_cachekey method which is updated whenever any instance of Bar is created, updated, or destroyed.  This key can be used
+as part of a cache key.
+
+```haml
+= cache ['bars_selector', Bar.blanket_cachekey] do
+  f.input :bars, collection: Bar.all
+```
+
+Now whenever any Bar is created, updated, or saved, the cache fragment above will be regenerated on the next hit.
+
+
+
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/blanket_cachekey.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blanket_cachekey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blanket_cachekey"
+  spec.version       = BlanketCachekey::VERSION
+  spec.authors       = ["Karl Baum"]
+  spec.email         = ["karl.baum@gmail.com"]
+  spec.description   = %q{Provides a rails cache key for caching data that should be invalidated whenever any ActiveRecord instance of a specific type is created, updated, or destroyed.}
+  spec.summary       = %q{Provides a rails cache key for caching data that should be invalidated whenever any ActiveRecord instance of a specific type is created, updated, or destroyed.}
+  spec.homepage      = "https://github.com/kbaum/blanket_cachekey"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "rails"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/lib/blanket_cachekey.rb

@@ -0,0 +1,51 @@
+require 'blanket_cachekey/version'
+require 'rails'
+require 'blanket_cachekey/engine'
+
+module BlanketCachekey
+
+  class << self
+    attr_accessor :cache
+  end
+
+
+  def self.included(model)
+    model.class_eval do
+
+      after_save :invalidate_blanket_cachekey
+      after_destroy :invalidate_blanket_cachekey
+
+      private
+
+      def invalidate_blanket_cachekey
+        self.class.invalidate_blanket_cachekey
+      end
+
+
+      class << self
+
+
+        def blanket_cachekey 
+          BlanketCachekey.cache.fetch(blanket_cachekey_name) do
+            "#{table_name}:#{Time.now.to_i}:#{Time.now.nsec}"
+          end
+        end
+
+        def invalidate_blanket_cachekey
+          BlanketCachekey.cache.delete blanket_cachekey_name
+        end
+
+        private 
+
+        def blanket_cachekey_name
+          "blanket_cachekey:name:#{self.table_name}"
+        end
+
+
+      end
+
+    end
+
+  end
+
+end

data/lib/blanket_cachekey/engine.rb

@@ -0,0 +1,7 @@
+module BlanketCachekey
+  class Engine < ::Rails::Engine
+    config.after_initialize do
+      BlanketCachekey.cache = Rails.cache
+    end
+  end
+end

data/lib/blanket_cachekey/version.rb

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

data/spec/blanket_cachekey_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+class Bar < ActiveRecord::Base
+
+  include BlanketCachekey
+
+end
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :bars do |t|
+  end
+end
+
+
+describe BlanketCachekey do
+
+  before :all do
+    BlanketCachekey.cache = ActiveSupport::Cache::MemoryStore.new
+  end
+
+  it 'should have a version number' do
+    BlanketCachekey::VERSION.should_not be_nil
+  end
+
+  describe '#blanket_cachekey' do
+
+    subject { Bar }
+
+    its(:blanket_cachekey){ should_not be_nil }
+
+    specify 'blanket_cachekey should not change if no Bar has been modified in any way' do
+      Bar.blanket_cachekey.should == Bar.blanket_cachekey
+    end
+    
+    describe 'adding a new model causes a new blanket cache key to be invalidated for bar' do
+
+      before do
+        @old_cache_key = Bar.blanket_cachekey
+        Bar.create!
+      end
+
+      its(:blanket_cachekey){ should_not == @old_cache_key }
+
+    end
+
+    describe 'updating a model causes blanket cache key to be invalidated for bar' do
+
+      before do
+        bar = Bar.create!
+        @old_cache_key = Bar.blanket_cachekey
+        bar.save!
+      end
+
+      its(:blanket_cachekey){ should_not == @old_cache_key }
+
+
+    end
+
+    describe 'destroying a model causes blanket cache key to be invalidated for bar' do
+
+      before do
+        bar = Bar.create!
+        @old_cache_key = Bar.blanket_cachekey
+        bar.destroy
+      end
+
+      its(:blanket_cachekey){ should_not == @old_cache_key }
+
+
+    end
+
+
+    
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'blanket_cachekey'
+

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: blanket_cachekey
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Karl Baum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Provides a rails cache key for caching data that should be invalidated
+  whenever any ActiveRecord instance of a specific type is created, updated, or destroyed.
+email:
+- karl.baum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blanket_cachekey.gemspec
+- lib/blanket_cachekey.rb
+- lib/blanket_cachekey/engine.rb
+- lib/blanket_cachekey/version.rb
+- spec/blanket_cachekey_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kbaum/blanket_cachekey
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Provides a rails cache key for caching data that should be invalidated whenever
+  any ActiveRecord instance of a specific type is created, updated, or destroyed.
+test_files:
+- spec/blanket_cachekey_spec.rb
+- spec/spec_helper.rb