cache_and_fetch 0.0.1

data/lib/cache_and_fetch.rb

@@ -0,0 +1,11 @@
+require "cache_and_fetch/version"
+require "active_support/concern"
+require "active_support/core_ext/numeric/time"
+require "rails"
+
+module CacheAndFetch
+end
+
+require "cache_and_fetch/errors.rb"
+require "cache_and_fetch/cacheable"
+require "cache_and_fetch/fetchable"

data/lib/cache_and_fetch/cacheable.rb

@@ -0,0 +1,77 @@
+module CacheAndFetch
+  module Cacheable
+    DEFAULT_CACHE_EXPIRY_TIME = 20.minutes
+    DEFAULT_PRIMARY_KEY_METHOD = :id
+
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :cache_expires_at
+      unless self.respond_to?(:primary_key)
+        instance_eval do
+          def primary_key
+            self.primary_key = Cacheable::DEFAULT_PRIMARY_KEY_METHOD unless @primary_key
+            @primary_key
+          end
+
+          def primary_key=(val)
+            @primary_key = val
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      def cache_duration
+        self.cache_duration = Cacheable::DEFAULT_CACHE_EXPIRY_TIME unless @cache_duration
+        @cache_duration
+      end
+
+      def cache_duration=(val)
+        @cache_duration = val
+      end
+
+      def cache_client
+        Rails.cache
+      end
+
+      def cache_key(p_key)
+        "#{self.name.underscore}/#{p_key}"
+      end
+
+      def cache(p_key)
+        resource = find(p_key)
+        resource.cache
+        resource
+      end
+
+      def get_cached(p_key)
+        cache_client.read(cache_key(p_key))
+      end
+    end
+
+    def cache_client
+      self.class.cache_client
+    end
+
+    def cache_key
+      self.class.cache_key(self.__send__(self.class.primary_key))
+    end
+
+    def cache
+      self.cache_expires_at = self.class.cache_duration.since.to_i
+      self.cache_client.write(self.cache_key, self)
+    end
+
+    def stale?
+      cache_expires_at && Time.now > Time.at(cache_expires_at)
+    end
+
+    def recache
+      Thread.new do
+        p_key = self.__send__(self.class.primary_key)
+        self.class.__send__(:find, p_key).cache
+      end
+    end
+  end
+end

data/lib/cache_and_fetch/errors.rb

@@ -0,0 +1,10 @@
+module CacheAndFetch
+  class CacheAndFetchError < StandardError
+  end
+
+  class FinderNotFound < CacheAndFetchError
+    def initialize
+      super("There is no <model>.find method defined. Please implement a <model>.find method or a finder module in app/models/<model>/finder.rb")
+    end
+  end
+end

data/lib/cache_and_fetch/fetchable.rb

@@ -0,0 +1,29 @@
+module CacheAndFetch
+  module Fetchable
+    extend ActiveSupport::Concern
+    include Cacheable
+
+    included do
+      begin
+        extend "#{name}::Finder".constantize
+      rescue NameError => ex
+        raise FinderNotFound.new unless respond_to?(:find)
+      end
+      private_class_method :find
+    end
+
+    module ClassMethods
+      def fetch(p_key)
+        resource = get_cached(p_key)
+        if resource
+          if resource.stale?
+            block_given? ? yield(resource) : resource.recache
+          end
+        else
+          resource = cache(p_key)
+        end
+        resource
+      end
+    end
+  end
+end

data/lib/cache_and_fetch/version.rb

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

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: cache_and_fetch
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Suman Mukherjee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem that allows you to soft expire cache, use a stale resource and
+  fetch the fresh resource in background
+email:
+- sumanmukherjee03@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cache_and_fetch/cacheable.rb
+- lib/cache_and_fetch/errors.rb
+- lib/cache_and_fetch/fetchable.rb
+- lib/cache_and_fetch/version.rb
+- lib/cache_and_fetch.rb
+homepage: http://github.com/sumanmukherjee03/cache_and_fetch
+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: -3505621410664163532
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3505621410664163532
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: This gem allows you to add a soft expiry to your cache. When the cache soft
+  expires, the cache provides you the stale record to work with, but fetches the fresh
+  record in the background.
+test_files: []