flagpole_sitta 0.5.1 → 0.5.9

data/app/helpers/flagpole_sitta_helper.rb

@@ -1,67 +1,71 @@
 module FlagpoleSittaHelper
 
   def update_index_array_cache model, key
-    model.try(:update_index_array_cache, key)
+    model.try(:update_array_cache, key)
   end
 
   def update_show_array_cache model, key, route_id
-    model.try(:update_show_array_cache, key, route_id)
+    model.try(:update_array_cache, key, route_id)
   end
 
   #AR - cache_sitta helper
-
   #NOTE This is not safe for .builder xml files.
-
-  #Options are for cache_sitta
-  
-  #key_args, passed to route_id if its a proc or lamdba
-  #all args must be passed in this manner if proc or lamdba
-  #so start your proc or lamdba with |options = {}|
-
-  #call_args, passed to call_path if its a proc of lamdba
-  #all args must be passed in this manner if proc or lamdba
-  #so start your proc or lamdba with |options = {}|
-
-  #models_in_index
+  #Options
+  #-------
+  #:section
+  #The section of the page the cache represents. This is
+  #best used in connection with -content_for. Can be any
+  #string you want it to be. If not provided will default to
+  #body. Also looks for the calls using sections. Will assume calls
+  #are in the instance variable '@#{options[:section]_calls'
+  #-------
+  #:model
+  #The model of the object, or objects that you want to link
+  #the cache too. Pass the actually model, or an array of models.
+  #Must also have a corresponding route_id. If model is an array, 
+  #route_id must also be an array of equal length. model[i] is 
+  #connected to route_id[i].
+  #-------
+  #:route_id
+  #The unique identifier of the object, most likely what you route on
+  #for showing the object or objects that you want to link
+  #the cache too. Pass as a string, or an array of strings.
+  #Must also have a corresponding model. If route_id is an array, 
+  #model must also be an array of equal length. model[i] is 
+  #connected to route_id[i].
+  #-------
+  #:models_in_index
   #Use this if the fragment you are rendering is an index
   #pass it all the different types of models/classes could be
   #included in the index. All the include classes must have cache
   #sitta enabled. The cache for the used index pages will then be
   #wiped clear when anyone of these models/classes has an object
   #created or updated.
+  #-------
+  #:index_only
+  #Use this if the cache should not be associated with any object,
+  #but rather only a model. Use this if your cache is an index, or
+  #can be 'random'.
+  #-------
+  #:sub_route_id
+  #Use this if options on the url can result in a difference in
+  #the cache. So if you had an page where you could pass
+  #in a year and month would be a great place for this.
+  #That way your caching each possible version of the page
+  #instead of just one.
+  #-------
+  #:calls_args
+  #Any args you want to pass to your calls. Can only take one argument.
+  #The best idea is to pass an option hash.
   def cache_sitta  options={}, &block
 
-    #AR - If its a string, then just use that value, other wise it
-    #assumes that the route_id is a proc or lamdba and call its
-    #with the provide args.
-
-    if options[:route_id_args]
-      options[:route_id] = options[:route_id].call(options[:route_id_args])
-    elsif options[:route_id].class.eql?(Proc)
-      options[:route_id] = options[:route_id].call()
-    end
-
     if options[:route_id].class.eql?(Array)
       main_route_id = options[:route_id][0]
     else
       main_route_id = options[:route_id]
     end
 
-
-    #Use subroute idea if the view can differ on things like current day, or any type of passed params that can effect how
-    #the page will look.
-    if options[:sub_route_id_args]
-      options[:sub_route_id] = options[:sub_route_id].call(options[:sub_route_id_args])
-    elsif options[:sub_route_id_args].class.eql?(Proc)
-      options[:sub_route_id] = options[:sub_route_id].call()
-    end
-
     if options[:model]
-      if options[:model_args]
-        options[:model] = options[:model].call(options[:model_args])
-      elsif options[:model].class.eql?(Proc)
-        options[:model] = options[:model].call()
-      end
 
       if options[:model].class.eql?(Array)
         main_model = options[:model][0]
@@ -115,7 +119,7 @@ module FlagpoleSittaHelper
         if calls
           calls.each do |c|
             if instance_variable_get("@#{c[0]}").nil?
-              if options[:calls_args]
+              if options[:calls_args] && (c.parameters.length > 0)
                 instance_variable_set("@#{c[0]}", c[1].call(options[:calls_args]))
               else
                 instance_variable_set("@#{c[0]}", c[1].call())

data/lib/flagpole_sitta/cache_sitta.rb

@@ -10,56 +10,71 @@ module FlagpoleSitta
 
     module ClassMethods
 
-      def initialize_index_array_cache
+      def mid_key_gen route_id
+        if route_id
+          mid_key = "#{route_id}/ShowArray"
+        else
+          mid_key = "IndexArray"
+        end
+      end
+
+      def initialize_array_cache route_id = nil
+
+        
+        mid_key = mid_key_gen route_id
 
         clazz = self
 
         flag = {:space => - 1}
 
-        Rails.cache.write("#{clazz}/IndexArray/Flag", flag)
+        Rails.cache.write("#{clazz}/#{mid_key}/Flag", flag)
 
         flag
 
       end
 
-      def update_index_array_cache key
+      def update_array_cache key, route_id = nil
+
+        mid_key = mid_key_gen route_id
 
         clazz = self
 
-        flag = Rails.cache.read("#{clazz}/IndexArray/Flag")
+        flag = Rails.cache.read("#{clazz}/#{mid_key}/Flag")
 
         #AR - If it doesn't exist start the process of creating it
         if flag.nil?
-          flag = initialize_index_array_cache
+          flag = initialize_array_cache route_id
         end
 
         #AR - update the array's end point
         flag[:space] = flag[:space] + 1
        
         #AR - write out the new index at the end of the array
-        Rails.cache.write("#{clazz}/IndexArray/#{flag[:space]}", {:key => key})
+        Rails.cache.write("#{clazz}/#{mid_key}/#{flag[:space]}", {:key => key})
 
         #AR - update flag in the cache
-        Rails.cache.write("#{clazz}/IndexArray/Flag", flag)
+        Rails.cache.write("#{clazz}/#{mid_key}/Flag", flag)
 
       end
 
-      def each_index_cache &block
+      def each_cache route_id = nil, &block
+
+        mid_key = mid_key_gen route_id
 
         clazz = self
 
-        flag = Rails.cache.read("#{clazz}/IndexArray/Flag")
+        flag = Rails.cache.read("#{clazz}/#{mid_key}/Flag")
         
         #AR - If it doesn't exist start the process of creating it
         if flag.nil?
-          flag = initialize_index_array_cache
+          flag = initialize_array_cache route_id
         end
 
         #AR - If there aren't any index do nothing.
         #Else wise loop through every index.
         #If it actually does exist then yield.
         for i in 0..flag[:space] do
-          hash = Rails.cache.read("#{clazz}/IndexArray/#{i}")
+          hash = Rails.cache.read("#{clazz}/#{mid_key}/#{i}")
           if hash
             yield hash[:key]
           end
@@ -69,86 +84,17 @@ module FlagpoleSitta
 
       end
 
-      def destroy_index_array_cache
-
-        clazz = self
-
-        each_index_cache do |key|
-          Rails.cache.delete(key)
-        end
-
-        Rails.cache.delete("#{clazz}/IndexArray/Flag")
-      end
-
-      def initialize_show_array_cache route_id
-
-        clazz = self
-
-        #AR - Its negative one to stop the for loops in the each method if its empty
-        flag = {:space => - 1}
-
-        Rails.cache.write("#{clazz}/#{route_id}/ShowArray/Flag", flag)
-
-        flag
-
-      end
-
-      def update_show_array_cache key, route_id
-
-        clazz = self
-
-        flag = Rails.cache.read("#{clazz}/#{route_id}/ShowArray/Flag")
-
-        #AR - If it doesn't exist start the process of creating it
-        if flag.nil?
-          flag = initialize_show_array_cache(route_id)
-        end
-
-        #AR - Update the array's end point
-        flag[:space] = flag[:space] + 1
-
-        #AR - Write out the new index at the end of the array
-        Rails.cache.write("#{clazz}/#{route_id}/ShowArray/#{flag[:space]}", {:key => key})
-
-        #AR - Update flag in the cache
-        Rails.cache.write("#{clazz}/#{route_id}/ShowArray/Flag", flag)
-
-      end
-
-      def each_show_cache route_id, &block
+      def destroy_array_cache route_id = nil
 
-        clazz = self
-
-        flag = Rails.cache.read("#{clazz}/#{route_id}/ShowArray/Flag")
-        
-        #AR - If it doesn't exist start the process of creating it
-        if flag.nil?
-          flag = initialize_show_array_cache(route_id)
-        end
-
-        #AR - If there aren't any shows caches do nothing, this happens when space is -1.
-        #Else wise loop through every caches.
-        #If it actually does exist then yield.
-        for i in 0..flag[:space] do
-          hash = Rails.cache.read("#{clazz}/#{route_id}/ShowArray/#{i}")
-          if hash
-            yield hash[:key]
-          end
-        end
-
-        nil
-
-      end
-
-      def destroy_show_array_cache route_id
+        mid_key = mid_key_gen route_id
 
         clazz = self
 
-        each_show_cache route_id do |k|
-          Rails.cache.delete(k)
+        each_cache route_id do |key|
+          Rails.cache.delete(key)
         end
 
-        Rails.cache.delete("#{clazz}/#{route_id}/ShowArray/Flag")
+        Rails.cache.delete("#{clazz}/#{mid_key}/Flag")
       end
 
     end
@@ -167,18 +113,18 @@ module FlagpoleSitta
       # this is because the new updated object for a sub class, could have also been in a cache for
       # said sub class, but also in a cache for its super.
       clazz = original_clazz
-      while(clazz.respond_to? :destroy_show_array_cache)
+      while(clazz.respond_to? :destroy_array_cache)
 
         #AR - Clear all caches related to the old route_id
-        clazz.destroy_show_array_cache(self.try(:send, ("#{clazz.route_id}_was")).to_s)
+        clazz.destroy_array_cache(self.try(:send, ("#{clazz.route_id}_was")).to_s)
         #AR - Clear all caches related to the new route_id just in case
-        clazz.destroy_show_array_cache(self.try(:send, ("#{clazz.route_id}")).to_s)
+        clazz.destroy_array_cache(self.try(:send, ("#{clazz.route_id}")).to_s)
         #AR - If the new and old are the same All that will happen on the second call is that
         #it will write the flag out and then destroy it. A very tiny bit of work
         #for a great amount of extra protection.
 
         # AR - Remember to include models_in_index in your helper call in the corresponding index cache.
-        clazz.destroy_index_array_cache
+        clazz.destroy_array_cache
 
         clazz = clazz.superclass
       end

data/lib/flagpole_sitta/version.rb

@@ -1,3 +1,3 @@
 module FlagpoleSitta
-  VERSION = "0.5.1"
+  VERSION = "0.5.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flagpole_sitta
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.9
   prerelease: 
 platform: ruby
 authors: