catche 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Arjen Oosterkamp
+
+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,44 @@
+# Catche [![Build Status](https://secure.travis-ci.org/Arjeno/catche.png?branch=master)](http://travis-ci.org/Arjeno/catche)
+
+Catche is a caching library for easy and automated resource and collection caching. It basically tags cached outputs and expires them based on configuration.
+
+## Installation
+
+Add this to your Gemfile and run `bundle`.
+```
+gem "catche"
+```
+
+## Controller caching
+
+Controller caching is based on `caches_action` using the method `catche`.
+
+### Simple caching
+
+```ruby
+class ProjectsController < ApplicationController
+  catche Project, :index, :show
+end
+```
+
+### Associative caching
+
+```ruby
+class TasksController < ApplicationController
+  catche Task, :index, :show, :through => :project
+end
+```
+
+On resource change this will expire:
+
+* Resource task
+* Resource task within specific project
+
+On resource or collection change this will expire:
+
+* Collection tasks
+* Collection tasks within specific project
+
+## License
+
+This project is released under the MIT license.

data/Rakefile

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

data/lib/catche.rb

@@ -0,0 +1,19 @@
+require 'catche/railtie'
+require 'catche/adapter'
+require 'catche/controller'
+require 'catche/model'
+require 'catche/tag'
+
+module Catche
+
+  extend self
+
+  def initialize_defaults
+    
+  end
+
+  def adapter
+    Catche::Adapter::Base
+  end
+
+end

data/lib/catche/adapter.rb

@@ -0,0 +1 @@
+require 'catche/adapter/base'

data/lib/catche/adapter/base.rb

@@ -0,0 +1,27 @@
+module Catche
+  module Adapter
+    class Base
+
+      class << self
+
+        def read(key, default_value=nil)
+          adapter.read(key) || default_value
+        end
+
+        def write(key, value)
+          adapter.write(key, value)
+        end
+
+        def delete(key)
+          adapter.delete(key)
+        end
+
+        def adapter
+          Rails.cache
+        end
+
+      end
+
+    end
+  end
+end

data/lib/catche/controller.rb

@@ -0,0 +1 @@
+require 'catche/controller/base'

data/lib/catche/controller/base.rb

@@ -0,0 +1,55 @@
+module Catche
+  module Controller
+    module Base
+
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        # Caches a controller action by tagging it.
+        # Supports any option parameters caches_action supports.
+        #
+        #   catche Project, :index
+        #   catche Task, :through => :project
+        def catche(model, *args)
+          options = args.extract_options!
+          tag     = Proc.new { |controller| Catche::Tag::Object.for(model, controller.class, options) }
+
+          # Use Rails caches_action to pass along the tag
+          caches_action(*args, { :tag => tag }.merge(options))
+        end
+
+      end
+
+      def _save_fragment(name, options={})
+        key     = fragment_cache_key(name)
+        object  = options[:tag]
+        tags    = []
+
+        if object.present?
+          if object.respond_to?(:call)
+            object = self.instance_exec(self, &object)
+
+            if object.respond_to?(:tags)
+              tags = object.tags(self)
+            else
+              tags = Array.new(object)
+            end
+          else
+            tags = Array.new(object)
+          end
+
+          Catche::Tag.tag! key, *tags
+
+          # Store for future reference
+          @catche_cache_object = object
+        end
+
+        super
+      end
+
+    end
+  end
+end
+
+ActionController::Base.send :include, Catche::Controller::Base

data/lib/catche/model.rb

@@ -0,0 +1 @@
+require 'catche/model/base'

data/lib/catche/model/base.rb

@@ -0,0 +1,35 @@
+module Catche
+  module Model
+    module Base
+      extend ActiveSupport::Concern
+
+      included do
+        after_update  :expire_resource!
+        after_destroy :expire_resource!
+
+        after_create  :expire_collection!
+        after_destroy :expire_collection!
+      end
+
+      def expire_collection!
+        expire_cache!
+      end
+
+      def expire_resource!
+        expire_cache!
+      end
+
+      def expire_cache!
+        tags = Catche::Tag::Object.find_by_model(self.class).collect do |obj|
+          self.instance_variable_set("@#{obj.options[:resource_name]}", self)
+          obj.expiration_tags(self)
+        end.flatten.compact.uniq
+
+        Catche::Tag.expire! *tags
+      end
+
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Catche::Model::Base

data/lib/catche/railtie.rb

@@ -0,0 +1,7 @@
+module Catche
+  class Railtie < ::Rails::Railtie
+    initializer "include.catche" do |app|
+      Catche.initialize_defaults
+    end
+  end
+end

data/lib/catche/tag.rb

@@ -0,0 +1,71 @@
+require 'catche/tag/object'
+require 'catche/tag/resource'
+
+module Catche
+  module Tag
+
+    KEY     = 'catche'
+    DIVIDER = '_'
+
+    extend self
+
+    def join(*tags)
+      tags.flatten.compact.uniq.join(DIVIDER)
+    end
+
+    def tag!(key, *tags)
+      tags.each do |tag|
+        keys      = fetch_tag(tag)
+        key_tags  = fetch_key(key)
+        tag_key   = stored_key(:tags, tag)
+        key_key   = stored_key(:keys, key)
+
+        Catche.adapter.write(tag_key, keys << key)
+        Catche.adapter.write(key_key, key_tags << tag_key)
+      end
+    end
+
+    def expire!(*tags)
+      expired_keys = []
+
+      tags.each do |tag|
+        keys = fetch_tag(tag)
+        expired_keys += keys
+
+        keys.each do |key|
+          # Expires the cached value
+          Catche.adapter.delete key
+
+          # Removes the tag from the tag list in case it's never used again
+          Catche.adapter.write(
+              stored_key(:keys, key),
+              fetch_key(key).delete(stored_key(:tags, tag))
+            )
+        end
+
+        Catche.adapter.delete stored_key(:tags, tag)
+      end
+
+      expired_keys
+    end
+
+    protected
+
+      def fetch_tag(tag)
+        Catche.adapter.read stored_key(:tags, tag), []
+      end
+
+      def fetch_key(key)
+        Catche.adapter.read stored_key(:keys, key), []
+      end
+
+      def stored_key(scope, value)
+        join_keys KEY, scope.to_s, value.to_s
+      end
+
+      def join_keys(*keys)
+        keys.join('.')
+      end
+
+  end
+end

data/lib/catche/tag/object.rb

@@ -0,0 +1,136 @@
+module Catche
+  module Tag
+    class Object
+
+      class << self
+
+        @@objects = []
+
+        # Returns an existing (duplicate) or new tag object for the given arguments.
+        #
+        #   Catche::Tag::Object.for(Project, ProjectsController)
+        def for(model, object, options={})
+          tag_object = find_or_initialize(model, object, options)
+
+          objects << tag_object
+          objects.uniq!
+
+          tag_object
+        end
+
+        # Finds a previously declared (same) tag object or returns a new one.
+        def find_or_initialize(model, object, options={})
+          new_object = self.new(model, object, options)
+
+          objects.each do |tag_object|
+            return tag_object if tag_object.same?(new_object)
+          end
+
+          new_object
+        end
+
+        def find_by_model(model)
+          objects.select { |tag_object| tag_object.model == model }
+        end
+
+        def find_by_association(association)
+          objects.select { |tag_object| tag_object.associations.include?(association) }
+        end
+
+        def clear
+          @@objects = []
+        end
+
+        def objects
+          @@objects
+        end
+
+      end
+
+      attr_reader :model, :object, :options
+      attr_accessor :associations
+
+      def initialize(model, object, options={})
+        @model = model
+        @object = object
+
+        association = options[:through]
+
+        @options = {
+          :resource_name      => Catche::Tag::Resource.singularize(@model),
+          :collection_name    => Catche::Tag::Resource.pluralize(@model),
+          :associations       => [association].flatten.compact,
+          :bubble             => false,
+          :expire_collection  => true
+        }.merge(options)
+
+        @associations = @options[:associations]
+      end
+
+      # Returns the tags for the given object.
+      # If `bubble` is set to true it will pass along the separate tag for each association.
+      # This means the collection or resource is expired as soon as the association changes.
+      #
+      #   object = Catche::Tag::Object.new(Task, TasksController, :through => [:user, :project])
+      #   object.tags(controller.new) => ['users_1_projects_1_tasks_1']
+      def tags(initialized_object)
+        tags = []
+
+        tags += association_tags(initialized_object) if bubble?
+        tags += expiration_tags(initialized_object)
+
+        tags
+      end
+
+      # The tags that should expire as soon as the resource or collection changes.
+      def expiration_tags(initialized_object)
+        tags = []
+
+        # Add collection tags when enabled
+        tags << Catche::Tag.join(
+            association_tags(initialized_object),
+            options[:collection_name]
+          ) if options[:expire_collection]
+
+        tags << Catche::Tag.join(
+            association_tags(initialized_object),
+            identifier_tags(initialized_object)
+          )
+
+        tags.uniq
+      end
+
+      # Identifying tag for the current resource or collection.
+      #
+      #   object = Catche::Tag::Object.new(Task, TasksController)
+      #   object.identifier_tags(controller) => ['tasks', 1]
+      def identifier_tags(initialized_object)
+        Catche::Tag.join options[:collection_name], Catche::Tag::Resource.resource(initialized_object, options[:resource_name]).try(:id)
+      end
+
+      # Maps the given resources names to tags by fetching the resources from the given object.
+      def resource_tags(*resources)
+        resources.map { |resource| Catche::Tag.join(Catche::Tag::Resource.pluralize(resource.class), resource.id) }
+      end
+
+      # Maps association tags.
+      #
+      #   object = Catche::Tag::Object.new(Task, TasksController, :through => [:user, :project])
+      #   object.association_tags(controller) => ['users_1', 'projects_1']
+      def association_tags(initialized_object)
+        resource_tags(*Catche::Tag::Resource.associations(initialized_object, associations))
+      end
+
+      def bubble?
+        options[:bubble]
+      end
+
+      def same?(object)
+        self.model      == object.model &&
+        self.object     == object.object &&
+        self.options    == object.options
+      end
+
+    end
+  end
+end

data/lib/catche/tag/resource.rb

@@ -0,0 +1,35 @@
+module Catche
+  module Tag
+    class Resource
+
+      class << self
+
+        def pluralize(object)
+          object.name.to_s.pluralize.downcase
+        end
+
+        def singularize(object)
+          object.name.to_s.singularize.downcase
+        end
+
+        def resource(object, name)
+          if resource = object.instance_variable_get("@#{name}")
+            return resource
+          elsif object.respond_to?(name)
+            begin
+              return object.send(name)
+            rescue; end
+          end
+
+          nil
+        end
+
+        def associations(object, associations)
+          associations.map { |association| resource(object, association) }.compact
+        end
+
+      end
+
+    end
+  end
+end

data/lib/catche/version.rb

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

data/lib/tasks/catche_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :catche do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: catche
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Arjen Oosterkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70257700363240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70257700363240
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70257700362820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257700362820
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70257700362360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257700362360
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70257700361940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257700361940
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70257700361520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257700361520
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: &70257700361100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70257700361100
+description: ''
+email:
+- mail@arjen.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/catche/adapter/base.rb
+- lib/catche/adapter.rb
+- lib/catche/controller/base.rb
+- lib/catche/controller.rb
+- lib/catche/model/base.rb
+- lib/catche/model.rb
+- lib/catche/railtie.rb
+- lib/catche/tag/object.rb
+- lib/catche/tag/resource.rb
+- lib/catche/tag.rb
+- lib/catche/version.rb
+- lib/catche.rb
+- lib/tasks/catche_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://arjen.me/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Smart collection and resource caching
+test_files: []