pack_rat 1.1.1 → 1.1.2

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.1.2

data/lib/pack_rat/cache_helper.rb

@@ -4,22 +4,24 @@ module PackRat
     extend ActiveSupport::Concern
 
     included do
+      # Include and Extend so cache method is available in all contexts
       extend Cacher
       include Cacher
+      self.file_location = file_location_guesser
+      self.updated_attribute_name = :updated_at
     end
 
     module ClassMethods
-      def extended(base)
-        base.send(:file_location=, file_location_guesser)
-        base.send(:updated_attribute_name=, :updated_at) unless base.updated_attribute_name
-      end
 
+      # Instance attribute name that stores the last time the object was updated, usually :updated_at
       def updated_attribute_name
         @updated_attribute_name
       end
       def updated_attribute_name=(name)
         @updated_attribute_name = name
       end
+      
+      # File path of the class
       def file_location
         @file_location
       end
@@ -27,6 +29,8 @@ module PackRat
         @file_location = path
         generate_file_digest
       end
+      
+      # Stores the MD5 Digest of the class
       def file_digest
         @file_digest
       end
@@ -48,6 +52,9 @@ module PackRat
       
       # Uses Rails conventions to determine location of the defined class
       def file_location_guesser
+        # This needs to be refactored to take a prefix to replace the rails/app/models
+        # AR Extension would be then include a prefix that this picks up
+        # Haven't decided on a clean way to implement this
         "#{Rails.root}/app/models/#{self.to_s.split('::').join('/').underscore.downcase}.rb" if defined? Rails
       end
 

data/lib/pack_rat/cache_helper/cacher.rb

@@ -2,22 +2,27 @@ module PackRat
   module CacheHelper
     module Cacher
       def cache(key='', options={}, &block)
-        unless options[:overwrite_key]
-          calling_method = caller[0][/`([^']*)'/, 1]
+        unless options[:overwrite_key] # if overwrite_key was set, we skip creating our own key
+          calling_method = caller[0][/`([^']*)'/, 1] # Hack to get the method that called cache
           key << calling_method << '/'
           key << self.cache_key << '/'
+          
+          # Since this same method is used in both class and instance contexts, we need to check that here
           if self.is_a? Class
             key << self.file_digest
           else
             key << self.class.file_digest
           end
         end
-        puts key if options[:debug]
-        filtered_options = options.except(:debug, :overwrite_key)
         
+        puts key if options[:debug] # Output the generated cache key to the console if debug is set
+        filtered_options = options.except(:debug, :overwrite_key) # Remove PackRat related options so we can pass to Rails.cache
+        
+        # Make the actual Rails.cache call
         Rails.cache.fetch key, filtered_options do
           block.call
         end
+
       end
     end
   end

data/lib/pack_rat/extensions/active_record.rb

@@ -1,6 +1,8 @@
 module PackRat
   module Extensions
     module ActiveRecord
+      
+      # When AR::Base is inherited, incude PackRat into inheriting class
       def inherited(child_class)
         child_class.send(:include, PackRat::CacheHelper)
         super

data/pack_rat.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "pack_rat"
-  s.version = "1.1.1"
+  s.version = "1.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Goff"]

metadata

@@ -2,7 +2,7 @@
 name: pack_rat
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Brian Goff
@@ -129,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2786484823164904458
+      hash: -617294814959193562
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: