taggable_cache 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,17 @@
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+#fake app generated
+/spec/internal/log
+/spec/internal/db/*.sqlite
+/tmp

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+  gem 'pry'
+end
+
+gem 'rspec-rails', :require => false
+gem 'rspec'
+gem 'combustion', '~> 0.3.1'
+gem 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    taggable_cache (0.1.0)
+      redis
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.1)
+      actionpack (= 3.2.1)
+      mail (~> 2.4.0)
+    actionpack (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.1)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.1)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.2)
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activerecord (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      arel (~> 3.0.0)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.0)
+    builder (3.0.0)
+    coderay (0.9.8)
+    combustion (0.3.1)
+      rails (>= 3.1.0)
+      thor (>= 0.14.6)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.1)
+    json (1.6.5)
+    mail (2.4.1)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.6.7)
+      ruby_parser (>= 2.3.1)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    polyglot (0.3.3)
+    pry (0.9.7.4)
+      coderay (~> 0.9.8)
+      method_source (~> 0.6.7)
+      ruby_parser (>= 2.3.1)
+      slop (~> 2.1.0)
+    rack (1.4.1)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.1)
+      actionmailer (= 3.2.1)
+      actionpack (= 3.2.1)
+      activerecord (= 3.2.1)
+      activeresource (= 3.2.1)
+      activesupport (= 3.2.1)
+      bundler (~> 1.0)
+      railties (= 3.2.1)
+    railties (3.2.1)
+      actionpack (= 3.2.1)
+      activesupport (= 3.2.1)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redis (2.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    rspec-rails (2.8.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec (~> 2.8.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.10)
+    slop (2.1.0)
+    sprockets (2.1.2)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.5)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  combustion (~> 0.3.1)
+  pry
+  rspec
+  rspec-rails
+  sqlite3
+  taggable_cache!

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Alex Rozumey
+
+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.rdoc

@@ -0,0 +1,26 @@
+= Taggable cache
+
+This gem simplifies cache expiration in rails.
+
+= How to use
+
+See example in spec/internal.
+
+== Build Status {<img src="https://secure.travis-ci.org/brain-geek/taggable-cache.png"/>}[http://travis-ci.org/brain-geek/taggable-cache]
+
+== Dependency Status {<img src="https://gemnasium.com/brain-geek/taggable-cache.png?travis"/>}[https://gemnasium.com/brain-geek/taggable-cache]
+
+== Contributing to taggable-cache
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Alex Rozumey. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+begin
+  require 'bundler'
+  Bundler::GemHelper.install_tasks
+rescue LoadError => e
+  warn "[WARNING]: It is recommended that you use bundler during development: gem install bundler"
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+run Combustion::Application

data/lib/taggable_cache.rb

@@ -0,0 +1,4 @@
+module TaggableCache
+end
+
+require 'taggable_cache/store'

data/lib/taggable_cache/rails.rb

@@ -0,0 +1,5 @@
+module TaggableCache::Rails
+end
+
+require 'taggable_cache/rails/cache'
+require 'taggable_cache/rails/observer'

data/lib/taggable_cache/rails/cache.rb

@@ -0,0 +1,15 @@
+module TaggableCache::Rails::Cache
+  def taggable
+    @taggable ||= ::TaggableCache::Store.new
+  end
+
+  def write(name, value, options = nil)
+    if options.has_key?(:depends_on)
+      taggable.add(name, *options[:depends_on])
+      #@taggable.
+      options.delete(:depends_on)
+    end
+
+    super(name, value, options)
+  end
+end

data/lib/taggable_cache/rails/observer.rb

@@ -0,0 +1,11 @@
+class TaggableCache::Rails::Observer < ActiveRecord::Observer
+  def event(model)
+    Rails.cache.taggable.get(model, model.class).each do |m|
+      Rails.cache.delete(m)
+    end
+  end
+
+  alias :after_update :event
+  alias :after_destroy :event
+  alias :after_create :event
+end

data/lib/taggable_cache/store.rb

@@ -0,0 +1,37 @@
+require "redis"
+
+class TaggableCache::Store
+  def initialize
+    @redis = Redis.new
+  end
+
+  def id_for(obj)
+    if obj.is_a? Class
+      obj.to_s.downcase
+    elsif obj.is_a? ActiveRecord::Base
+      if obj.persisted?
+        "#{obj.class.to_s.downcase}-#{obj.id}" 
+      else
+        id_for(obj.class)
+      end
+    else
+      nil
+    end
+  end
+
+  def add(tag, *members)
+    members.each do |element|
+      ident = id_for(element)
+      @redis.sadd ident, tag unless ident.nil?
+    end
+  end
+
+  def get(*members)
+    members.map do |tag|
+      ident = id_for(tag)
+      elements = @redis.smembers(ident)
+      @redis.del(ident)
+      elements
+    end.flatten.compact
+  end
+end

data/lib/taggable_cache/version.rb

@@ -0,0 +1,3 @@
+module TaggableCache
+  VERSION = "0.1.0" # This is for the gem and does not conflict with the rest of the functionality
+end

data/spec/internal/app/models/page.rb

@@ -0,0 +1,2 @@
+class Page < ActiveRecord::Base
+end

data/spec/internal/app/models/simple_observer.rb

@@ -0,0 +1,3 @@
+class SimpleObserver < TaggableCache::Rails::Observer
+  observe Page
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/initializers/taggable.rb

@@ -0,0 +1,11 @@
+#combustion uses rails file cache, so we make magic on it
+require 'taggable_cache/rails'
+
+ActiveSupport::Cache::FileStore.class_eval do
+  include TaggableCache::Rails::Cache
+end
+
+#Listing all models with enabled taggable cache
+# TaggableCache::Rails::Observer.observe Page
+
+Combustion::Application.config.active_record.observers = :simple_observer

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define do
+  create_table(:pages, :force => true) do |t|
+    t.string :name
+    t.text   :content
+    t.timestamps
+  end
+end

data/spec/models/page_spec.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
+describe Page do
+end

data/spec/rails_cache_spec.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+
+describe TaggableCache::Rails::Cache do
+  before :all do
+    @object = TaggableCache::Store.new
+    Redis.new.flushall
+
+    @page_object = Page.create    
+  end
+
+  describe "taggable hooked on Rails.cache.write" do
+    it "adds key to store" do
+      Rails.cache.write 'key', 'value', :depends_on => [@page_object]
+
+      @object.get(@page_object).should == ['key']
+    end
+  end
+
+  describe "taggable hooked as observer" do
+    it "detects object change" do
+      Rails.cache.write 'key', 'value', :depends_on => [@page_object]
+
+      Rails.cache.read('key').should == 'value'
+
+      @page_object.name = @page_object.name.to_s + '1'
+      @page_object.save!
+
+      Rails.cache.read('key').should be_nil
+    end
+
+    it "detects model change" do
+      Rails.cache.write 'lorem', 'impsum', :depends_on => [Page]
+
+      Rails.cache.read('lorem').should == 'impsum'
+
+      Page.create
+
+      Rails.cache.read('lorem').should be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+require 'taggable_cache'
+
+Bundler.require :default, :development
+
+Combustion.initialize!
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end

data/spec/taggable-cache/store_spec.rb

@@ -0,0 +1,80 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+
+describe TaggableCache::Store do
+  describe "connection to redis" do
+  	it "should use default settings" do
+      Redis.should_receive(:new)
+      TaggableCache::Store.new
+  	end
+  end
+
+  describe "adding tags" do
+    before :all do
+      @object = TaggableCache::Store.new
+      @redis = Redis.new
+      #clean up all redis data
+      @redis.flushall
+    end
+
+    describe "queque names" do
+      it "should use id and model name if saved activerecord object" do
+        page = Page.create
+        @object.id_for(page).should == "page-#{page.id}"
+      end
+
+      it "should use id and model name if not saved activerecord object" do
+        @object.id_for(Page.new(:id => 1)).should == 'page'
+      end
+
+      it "should use model name if model is passed" do
+        @object.id_for(Page).should == 'page'
+      end
+
+      it "should return nil if unknown is passed" do
+        @object.id_for(123).should be_nil
+      end
+    end
+
+    describe "add data to redis" do
+      it "should push data" do
+        o1 = Object.new
+        o2 = Object.new
+
+        @object.should_receive(:id_for).with(o1).and_return('member1')
+        @object.should_receive(:id_for).with(o2).and_return('member2')
+        @object.should_receive(:id_for).with(nil).and_return(nil)
+
+        @object.add('tag_name', o1, nil, o2)
+
+        @redis.smembers(nil).should == []
+        @redis.smembers('member1').should == ['tag_name']
+        @redis.smembers('member2').should == ['tag_name']
+      end
+    end
+
+    describe "get data from redis" do
+      it "should return keys and leave nothing behind" do
+        page = Page.create
+
+        @object.add('tag_name', page)
+        @redis.smembers("page-#{page.id}").should == ['tag_name']
+        
+        @object.get(page).should == ['tag_name']
+        @redis.smembers("page-#{page.id}").should be_empty
+      end
+
+      it "should do multi-get" do
+        page = Page.create
+
+        @object.add('tag_name', page)
+        @object.add('tag2', Page)
+        @redis.smembers("page-#{page.id}").should == ['tag_name']
+        @redis.smembers("page").should == ['tag2']
+        
+        @object.get(page, Page).should == ['tag_name', 'tag2']
+        @redis.smembers("page-#{page.id}").should be_empty
+        @redis.smembers("page").should be_empty
+      end
+    end
+  end
+end

data/taggable-cache.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+require 'rake'
+$:.push File.expand_path("../lib", __FILE__)
+require "taggable_cache/version"
+
+Gem::Specification.new do |s|
+  s.name = "taggable_cache"
+  s.version = TaggableCache::VERSION
+
+  s.authors = ["Alex Rozumey"]
+  s.date = "2012-02-09"
+  s.description = "This gem simplifies cache expiration in rails"
+  s.email = "brain-geek@yandex.ua"
+
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.homepage = "http://github.com/brain-geek/taggable-cache"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "This gem simplifies cache expiration in rails by providing depends_on option to rails cache."
+
+  s.add_dependency(%q<redis>, [">= 0"])
+end
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: taggable_cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Rozumey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &72590360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *72590360
+description: This gem simplifies cache expiration in rails
+email: brain-geek@yandex.ua
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- config.ru
+- lib/taggable_cache.rb
+- lib/taggable_cache/rails.rb
+- lib/taggable_cache/rails/cache.rb
+- lib/taggable_cache/rails/observer.rb
+- lib/taggable_cache/store.rb
+- lib/taggable_cache/version.rb
+- spec/internal/app/models/page.rb
+- spec/internal/app/models/simple_observer.rb
+- spec/internal/config/database.yml
+- spec/internal/config/initializers/taggable.rb
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/public/favicon.ico
+- spec/models/page_spec.rb
+- spec/rails_cache_spec.rb
+- spec/spec_helper.rb
+- spec/taggable-cache/store_spec.rb
+- taggable-cache.gemspec
+homepage: http://github.com/brain-geek/taggable-cache
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 740775313
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 740775313
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: This gem simplifies cache expiration in rails by providing depends_on option
+  to rails cache.
+test_files: []