manage_cache 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 819d700cc781a2c0e4830517fb864a1f432955af
-  data.tar.gz: 10cf168188688ea5110bf9671df2a04a308a3152
+  metadata.gz: 8c6b89b1174e6e8de32dd2c4377c0a7c8310667b
+  data.tar.gz: a63333addfe87c886664560ebb213593ca801747
 SHA512:
-  metadata.gz: c9dcd7ccf4633560a01d60aca9f9b169ce66bbdfc136c4d938154fe72f108ca42ab68f9abb3a44a9629148cb5d5482712fd08fdc172be86f5c23019e1bbbb5c2
-  data.tar.gz: 9c4b34ab3882057a483d1353d0a9ba83ae1f73f0af168b158c1ed108f648577131d75246846f36f755731460943a4b8882a2d50f33d45f380b2fe48ed53c4fb4
+  metadata.gz: ac15c9377dd6b2f8aeaa0eb75425f061c5898751f8d0ef857a23c48d3f8cfdb25ff4d9d9ac0fb3cb8fa9728de0f0b43e1edcfa591a66f28d185033b94ac2e87b
+  data.tar.gz: ca9c366286f894fbce112fd34cfef6e8c194046e385ffe49492aa0e4f5be4a5fdaae9db836c93157c4dcf81fbb342de19b5d528ac1b6989a284ecc6a64eb5ba0

data/lib/manage_cache/version.rb

@@ -1,3 +1,3 @@
 module ManageCache
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/manage_cache.rb

@@ -22,36 +22,43 @@ module ManageCache
 
   module LocalInstanceMethods
     def dump_cache!
-      self.class.cache_keys_specs.each do |k,v|
+      self.class.cache_keys_specs.each do |key_name, key_specs|
         # the rails helper method 'cache (name, opts) do ...'
         # adds some extras to the cache key.
         # To run with this gem, you have to add 'skip_digest: true'.
         # Any other options will prevent correct cache deletion!!
         #
-        [cache_key_for(k), "views/#{cache_key_for(k)}"].each do |key|
-          Rails.cache.delete(key)
-        end
-
-        instance_variable_set("@cache_key_for_#{k}", nil)
+        [cache_key_for(key_name), "views/#{cache_key_for(key_name)}"].each do |key|
+          if !key_specs[:regexp].blank?
+            delete_cache_w_regexp(key, key_specs)
+          else
+            Rails.cache.delete(key)
+          end
+          instance_variable_set("@cache_key_for_#{key_name}", nil)
+        end if delete_cache?(key_specs)
       end
     end
 
-    def cache_key_for(spec)
+    def cache_key_for(spec, opts={})
       instance_variable_get("@cache_key_for_#{spec}") ||
-        instance_variable_set("@cache_key_for_#{spec}", prepare_cache_key(spec))
+        instance_variable_set("@cache_key_for_#{spec}", prepare_cache_key(spec, opts))
     end
 
     private
      
-    def prepare_cache_key(spec)
+    def prepare_cache_key(spec, opts={})
       cache_key = {}
 
       key_specs = self.class.cache_keys_specs[spec]
 
+      if key_specs.blank?
+        raise "The specification for cache_key '#{spec}' is missing in manage_cache in #{self.class.name}."
+      end
+
       # some extra specification like :show or :index_row
       # defaults to the spec-key
       #
-      cache_key[:spec] = key_specs[:spec] || spec
+      cache_key[:spec] = spec
 
       # named values from some method calls
       # the easiest case would be updated_at e.g.: 
@@ -73,7 +80,7 @@ module ManageCache
       # and this cache_key could be used somewhere where the user`s shoes are shown e.g. :show or :index
       #
       #  e.g. 
-      #  <% cache user.shoes.last.try.cache_key_for(:users_shoes), skip_digest: true do %>
+      #  <% cache user.shoes.last.try(:cache_key_for, :users_shoes), skip_digest: true do %>
       #    ....
       #
       # it is enough to take one of the users` shoes for the cache_key here
@@ -82,11 +89,61 @@ module ManageCache
       #
       key_specs[:instance_eval].each do |name, cmd| 
         cache_key[name] = self.instance_eval(cmd.to_s)
-      end
+      end if key_specs[:instance_eval]
       
-      cache_key.inject([]){ |mem, (k,v)| mem << "#{k}-#{v}" }.join('/')
+      key_specs[:class_eval].each do |name, cmd| 
+        cache_key[name] = self.class.class_eval(cmd.to_s)
+      end if key_specs[:class_eval]
+
+
+      # merge static values from manage_cache_for sth: { static: 'static' }
+      #
+      # and opts from cache_key_for, like:
+      #   <% cache cache_key_for(:sth, page: params[:page]) %>
+      #
+      [key_specs[:static], opts].each do |hash|
+        cache_key.reverse_merge!(hash) if hash
+      end
+
+      cache_key.inject([]){ |mem, (k,v)| mem << "#{k}=#{v}" }.join('-')
     end
 
+    #
+    # Opts added to cache_key_for will be suffixed to the rest of 
+    # the cache_key.
+    # For these opts to take effect on cache management (e.g. deletion)
+    # use `regexp: { opts_key: "matcher_string" , .... } 
+    # e.g.:
+    #
+    # in the paginated index view:
+    #
+    #   <% cache @users.last.try(:cache_key_for, :users_index, page: params[:page]) do %>
+    #
+    # in the model:
+    #
+    #   class User < ActiveRecord::Base
+    #     manage_cache_for users_index: { 
+    #                        class_eval: { max_up: "maximum(:updated_at)"} 
+    #                        regexp:     { page: "\\d+" }
+    #                      }
+    #
+    # be aware, that the matcher_string has to be escaped (e.g. "\\d+" instead of "\d+")!
+    #
+    def delete_cache_w_regexp(key, specs)
+      regexp = specs[:regexp].inject([]){|m, (k,v)| m << "#{k}=#{v}" }.join('-')
+      Rails.cache.delete_matched(/^#{Regexp.escape(key)}-#{regexp}$/)
+    end
+
+    # if some attributes are specified in :if_changed
+    # check whether they changed
+    # and delete cache only if they changed
+    #
+    # if not specified delete cache
+    #
+    def delete_cache?(key_specs)
+      !key_specs[:if_changed] or 
+        self.changed.length > (self.changed - key_specs[:if_changed].map(&:to_s)).length 
+    end
   end
 end
 

data/test/dummy/app/controllers/shoes_controller.rb

@@ -0,0 +1,9 @@
+class ShoesController < ApplicationController
+  def show
+    @shoe = Shoe.find params[:id]
+  end
+
+  def index
+    @shoes = Shoe.offset(params[:page].to_i - 1).limit(1)
+  end
+end

data/test/dummy/app/models/shoe.rb

@@ -3,7 +3,11 @@ class Shoe < ActiveRecord::Base
   belongs_to :user
   validates :user_id, presence: true
 
-  manage_cache_for users_shoes: { instance_eval: { user: "user.id", last_updated_shoe: "user.shoes.maximum(:updated_at)" } }
+  manage_cache_for users_shoes: { instance_eval: { user: "user.id", last_updated_shoe: "user.shoes.maximum(:updated_at)" } },
+    users_index: { instance_eval: { max_up: "user.class.maximum(:updated_at)"} },
+    shoes_index: { class_eval: { max_up: "maximum(:updated_at)" }, regexp: { page: "\\d*" } },
+    shoe_color: { instance_eval: { shoe_id: :id}, if_changed: [:color] }
+
 
   def name_with_color
     "#{name}: #{color}"

data/test/dummy/app/models/user.rb

@@ -3,7 +3,8 @@ class User < ActiveRecord::Base
   has_many :shoes
 
   manage_cache_for show: { instance_eval: { user: :id, updated_at: :updated_at } },
-    row_name: { instance_eval: { user: :id, updated_at: :updated_at } }
+    row_name: { instance_eval: { user: :id, updated_at: :updated_at } },
+    users_index: { class_eval: { max_up: "maximum(:updated_at)"} }
 
   def nice_name
     "nice name is #{name}"

data/test/dummy/app/views/shoes/index.html.erb

@@ -0,0 +1,31 @@
+<p id="notice"><%= notice %></p>
+
+<% cache @shoes.last.try(:cache_key_for, :shoes_index, page: params[:page] || 1), skip_digest: true do %>
+  <h1>Listing shoes</h1>
+
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Color</th>
+        <th colspan="3"></th>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% @shoes.each do |shoe| %>
+        <tr>
+          <td> <%= shoe.name %> </td>
+          <td> <%= shoe.color %> </td>
+          <td><%= link_to 'Show', shoe %></td>
+          <td><%= link_to 'Edit', edit_shoe_path(shoe) %></td>
+          <td><%= link_to 'Destroy', shoe, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+
+  <br>
+
+  <%= link_to 'New shoe', new_shoe_path %>
+<% end %>

data/test/dummy/app/views/users/index.html.erb

@@ -1,38 +1,39 @@
 <p id="notice"><%= notice %></p>
 
-<h1>Listing Users</h1>
+<% cache @users.last.try(:cache_key_for, :users_index), skip_digest: true do %>
+  <h1>Listing Users</h1>
 
-<table>
-  <thead>
-    <tr>
-      <th>Name</th>
-      <th>Shoes</th>
-      <th colspan="3"></th>
-    </tr>
-  </thead>
-
-  <tbody>
-    <% @users.each do |user| %>
+  <table>
+    <thead>
       <tr>
-        <td>
-          <% cache user.cache_key_for(:row_name), skip_digest: true do %>
-            <%= user.nice_name %>
-          <% end %>
-        </td>
-        <td>
-          <% cache user.shoes.last.try(:cache_key_for, :users_shoes), skip_digest: true do %>
-            <%= user.shoes.map(&:name_with_color).join(',') %>
-            <%#= user.shoes.map{|shoe| "#{shoe.name}:#{shoe.color}"}.join(',') %>
-          <% end %>
-        </td>
-        <td><%= link_to 'Show', user %></td>
-        <td><%= link_to 'Edit', edit_user_path(user) %></td>
-        <td><%= link_to 'Destroy', user, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+        <th>Name</th>
+        <th>Shoes</th>
+        <th colspan="3"></th>
       </tr>
-    <% end %>
-  </tbody>
-</table>
+    </thead>
+
+    <tbody>
+      <% @users.each do |user| %>
+        <tr>
+          <td>
+            <% cache user.cache_key_for(:row_name), skip_digest: true do %>
+              <%= user.nice_name %>
+            <% end %>
+          </td>
+          <td>
+            <% cache user.shoes.last.try(:cache_key_for, :users_shoes), skip_digest: true do %>
+              <%= user.shoes.map(&:name_with_color).join(',') %>
+            <% end %>
+          </td>
+          <td><%= link_to 'Show', user %></td>
+          <td><%= link_to 'Edit', edit_user_path(user) %></td>
+          <td><%= link_to 'Destroy', user, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
 
-<br>
+  <br>
 
-<%= link_to 'New User', new_user_path %>
+  <%= link_to 'New User', new_user_path %>
+<% end %>