activerecord-cached_at 5.1.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9738b748326936b6c9ca40a335f3ff903ddbdb2
-  data.tar.gz: d2a4acd817f4f27deaa58984ab285946c711dbd8
+SHA256:
+  metadata.gz: 89f6c8c10ca1cb627c057112961cb80ff26440026b723b5cf4240e4873089604
+  data.tar.gz: 05374e1138987e67d9a0fb5866278f1d495168799859ccb8cc77e4bc8dc8b724
 SHA512:
-  metadata.gz: 0b16e4afd909f8091721348e23d54f2d71427bcb550016d77677574bb19a525c2f12cb8fbccb25b1de39d82604f954be5674ec7e99611bfb0e776c21398bdcb0
-  data.tar.gz: 49bc4f9883cd48034e0dcad03b8525e750dd59244e143946d3c33b4f88a54d19705183b69492dba045dee6dc9e4729ca9b144817603ce718f734a11b3b671f0e
+  metadata.gz: 2053953fe7212f64ee1d03ed6956f409f25ae3c53666c25acd7224ecefa3e8ed0b1d2daf99317087d7c7fed0ea846a10eceec4de9776c31c530f31bc518b54ab
+  data.tar.gz: fbeed1272d1d6a5961733ec128516a5b1dc9f093061775c24ba1c14c30bf28f8730436542d8ca45de738a41d957332fd5daf133d74d54c37b9f6f9db137c7eff

data/README.md

@@ -1,15 +1,16 @@
-# ActiveRecord - CachedAt
+# ActiveRecord - CachedAt [![Travis CI](https://travis-ci.org/malomalo/activerecord-cached_at.svg?branch=master)](https://travis-ci.org/malomalo/activerecord-cached_at)
 
 This gem causes ActiveRecord to update a `cached_at` column if present, like the
 `updated_at` column.
 
 When calculating a `cache_key` for a model it will also consider the `cached_at`
-column to determin the key of a model.
+column to determine the key of a model.
 
 Any `ActiveRecord::Migration` that calls `timestamps` will include a `cached_at`
 column.
 
-TODO: Document about relationship caches
+Call to [`ActiveRecord::Persistence::touch`](https://api.rubyonrails.org/classes/ActiveRecord/Persistence.html#method-i-touch)
+will also touch the `cached_at` column.
 
 ## Installation
 
@@ -22,12 +23,94 @@ aren't updating the models you can just require the helpers:
 
     gem 'activerecord-cached_at', require: 'cached_at/helpers'
 
+## Configuration
 
+By default updates to the `cached_at`, `updated_at`, and `created_at` columns
+will not trigger and update to the `cached_at` column. You can add aditional
+fields to ignore:
+
+```ruby
+class User
+  cached_at ignore: :my_column
+end
+
+class Photo
+  cached_at ignore: :column_a, :column_b
+end
+```
+## Relationship Cache Keys
+
+CachedAt also allows you to keep cache keys for relationships. This allows you
+to use the record to determine if a cache is valid for a relationship instead
+of doing another database query.
+
+For example:
+
+```ruby
+class User < ActiveRecord::Base
+  has_many :photos
+end
+
+class Photo
+  belongs_to :user, cached_at: true
+end
+
+bob_ross = User.create(name: 'Bob Ross')
+# => INSERT INTO "users"
+#    ("name", "cached_at", "updated_at_", "created_at")
+#    VALUES
+#    ("Bob Ross", "2020-07-19 20:22:03", "2020-07-19 20:22:03", "2020-07-19 20:22:03")
+
+photo = Photo.create(user: bob_ross, file: ...)
+# =>INSERT INTO "photos" ("user_id", "cached_at", "updated_at_", "created_at") VALUES (1, "Bob Ross", "2020-07-19 20:22:04", "2020-07-19 20:22:04", "2020-07-19 20:22:04")
+# => UPDATE "users" SET "photos_cached_at" = "2020-07-19 20:22:04" WHERE "users"."id" = 1
+
+photo.update(file: ...)
+# =>UPDATE "photos" (..., "cached_at", "updated_at_") VALUES (..., "2020-07-19 20:22:05", "2020-07-19 20:22:05", "2020-07-19 20:22:05")
+# => UPDATE "users" SET "photos_cached_at" = "2020-07-19 20:22:05" WHERE "users"."id" = 1
+
+photo.update(user: not_bob_ross)
+# =>UPDATE "photos" ("user_id", "cached_at", "updated_at_") VALUES (2, "2020-07-19 20:22:06", "2020-07-19 20:22:06", "2020-07-19 20:22:06")
+# => UPDATE "users" SET "photos_cached_at" = "2020-07-19 20:22:06" WHERE "users"."id" IN (1, 2)
+
+photo.destroy
+# => UPDATE "users" SET "photos_cached_at" = "2020-07-19 20:22:07" WHERE "users"."id" = 2
+# => DELETE FROM "users" WHERE WHERE "users"."id" = 2
+```
+
+# Usage
+
+`cached_at` will automatically be used for determining the cache key in Rails.
+
+However if you need to calculate the cache key based on relationship cache keys
+you will need to manually compute the cache key. Examples are below:
+
+The cache key here is the maxium of the following keys: `cached_at`,
+`listings_cached_at`, and `photos_cached_at`
+
+```erb
+<%= render partial: 'row', collection: @properties, as: :property, cached: Proc.new { |item|
+  [item.cache_key_with_version(:listings, :photos), current_account.id ]
+} %>
+
+<% cache @property.cache_key_with_version(:listings, :photos) do %>
+  <b>All the info on this property</b>
+  <%= @property.name %>
+  <% @property.listings.each do |listing| %>
+    <%= listing.info %>
+  <% end %>
+  <% @property.photos.each do |photo| %>
+    <%= image_tag(photo.url) %>
+  <% end %>
+<% end %>
+
+```
 ## TODO:
 
- Add a `cache_key` method to the Model class that gets `MAX(cached_at)`
+* Document going more than one level with cached_at keys
 
+* Add a `cache_key` method to the Model class that gets `MAX(cached_at)`
 
+* change option to cache: true
 
-change option to cache: true
-add cache_association helper
+* add cache_association helper

data/ext/active_record/connection_adapters/abstract/schema_definitions.rb

@@ -2,14 +2,16 @@ module ActiveRecord
   module ConnectionAdapters #:nodoc:
 
     class TableDefinition
-      def timestamps(*args)
-        options = args.extract_options!
-
+      def timestamps(**options)
         options[:null] = false if options[:null].nil?
 
-        column(:created_at, :datetime, options)
-        column(:updated_at, :datetime, options)
-        column(:cached_at, :datetime, options)
+        if !options.key?(:precision) && @conn.supports_datetime_with_precision?
+          options[:precision] = 6
+        end
+
+        column(:created_at, :datetime, **options)
+        column(:updated_at, :datetime, **options)
+        column(:cached_at, :datetime,  **options)
       end
     end
 

data/ext/active_record/connection_adapters/abstract/schema_statements.rb

@@ -2,19 +2,42 @@ module ActiveRecord
   module ConnectionAdapters #:nodoc:
 
     module SchemaStatements
-      def add_timestamps(table_name, options = {})
+      def add_timestamps(table_name, **options)
         options[:null] = false if options[:null].nil?
 
-        add_column table_name, :created_at, :datetime, options
-        add_column table_name, :updated_at, :datetime, options
-        add_column table_name, :cached_at, :datetime, options
+        if !options.key?(:precision) && supports_datetime_with_precision?
+          options[:precision] = 6
+        end
+
+        add_column table_name, :created_at, :datetime, **options
+        add_column table_name, :updated_at, :datetime, **options
+        add_column table_name, :cached_at, :datetime,  **options
       end
 
-      def remove_timestamps(table_name, options = {})
+      def remove_timestamps(table_name, **options)
         remove_column table_name, :updated_at
         remove_column table_name, :created_at
         remove_column table_name, :cached_at
       end
+
+      def add_timestamps_for_alter(table_name, **options)
+        options[:null] = false if options[:null].nil?
+
+        if !options.key?(:precision) && supports_datetime_with_precision?
+          options[:precision] = 6
+        end
+
+        [
+          add_column_for_alter(table_name, :created_at, :datetime, **options),
+          add_column_for_alter(table_name, :updated_at, :datetime, **options),
+          add_column_for_alter(table_name, :cached_at, :datetime, **options)
+        ]
+      end
+
+      def remove_timestamps_for_alter(table_name, **options)
+        remove_columns_for_alter(table_name, :updated_at, :created_at, :cached_at)
+      end
+
     end
 
   end

data/lib/cached_at.rb

@@ -3,5 +3,5 @@ require 'active_record'
 require File.expand_path(File.join(__FILE__, '../cached_at/base'))
 require File.expand_path(File.join(__FILE__, '../cached_at/helpers'))
 require File.expand_path(File.join(__FILE__, '../cached_at/timestamp'))
-require File.expand_path(File.join(__FILE__, '../cached_at/connection_adapters/abstract/schema_definitions'))
-require File.expand_path(File.join(__FILE__, '../cached_at/connection_adapters/abstract/schema_statements'))
+require File.expand_path(File.join(__FILE__, '../../ext/active_record/connection_adapters/abstract/schema_definitions'))
+require File.expand_path(File.join(__FILE__, '../../ext/active_record/connection_adapters/abstract/schema_statements'))

data/lib/cached_at/associations/association.rb

@@ -41,7 +41,7 @@ module CachedAt
         
         source_assoc = owner.association(r.source_reflection_name.to_sym)
         if source_assoc.loaded?
-          source_assoc.target.raw_write_attribute(cache_column, timestamp)
+          source_assoc.target.send(:write_attribute_without_type_cast, cache_column, timestamp)
         end
         query = r.klass.where(r.association_primary_key => owner.send(r.foreign_key))
         query.update_all({ cache_column => timestamp })

data/lib/cached_at/associations/belongs_to_association.rb

@@ -45,7 +45,7 @@ module CachedAt
       end
       
       if loaded? && target
-        target.raw_write_attribute(cache_column, timestamp)
+        target.send(:write_attribute_without_type_cast, cache_column, timestamp)
       end
     end
     
@@ -54,7 +54,7 @@ module CachedAt
         timestamp = Time.now
         cache_column = "#{options[:inverse_of]}_cached_at"
         if loaded? && target
-          target.raw_write_attribute(cache_column, timestamp)
+          target.send(:write_attribute_without_type_cast, cache_column, timestamp)
         end
       end
       

data/lib/cached_at/associations/collection_association.rb

@@ -12,9 +12,11 @@ module CachedAt
       cache_column = "#{reflection.inverse_of.name}_cached_at"
       ids = [owner.send(reflection.association_primary_key), owner.send("#{reflection.association_primary_key}_before_last_save")].compact.uniq
       query = klass.where({ reflection.foreign_key => ids })
-    
+      
       if loaded?
-        target.each { |r| r.raw_write_attribute(cache_column, timestamp) }
+        target.each do |record|
+          record.send(:write_attribute_without_type_cast, cache_column, timestamp)
+        end
       end
       
       if method != :destroy
@@ -40,14 +42,14 @@ module CachedAt
 
       cache_column = "#{reflection.inverse_of.name}_cached_at"
 
-      records.each { |r| r.raw_write_attribute(cache_column, timestamp) unless r.destroyed? }
+      records.each { |r| r.send(:write_attribute_without_type_cast, cache_column, timestamp) unless r.destroyed? }
 
       query = klass.where({ klass.primary_key => records.map(&:id) })
       query.update_all({ cache_column => timestamp })
       traverse_relationships(klass, options[:cached_at], query, cache_column, timestamp)
     end
 
-    def add_to_target(record, skip_callbacks = false, &block)
+    def add_to_target(record, skip_callbacks: false, replace: false, &block)
       value = super
       touch_records_cached_at([record], Time.now) if !(instance_variable_defined?(:@caching) && @caching)
       value

data/lib/cached_at/associations/has_many_through_association.rb

@@ -15,7 +15,7 @@ module CachedAt
 
         query = nil
         if loaded?
-          target.each { |r| r.raw_write_attribute(cache_column, timestamp) }
+          target.each { |r| r.send(:write_attribute_without_type_cast, cache_column, timestamp) }
           query = klass.where(klass.primary_key => target.map(&:id))
         else
           ids = [owner.send(using_reflection.association_primary_key), owner.send("#{using_reflection.association_primary_key}_before_last_save")].compact.uniq
@@ -35,7 +35,7 @@ module CachedAt
       #TODO: test with new record (fails in mls)
       if !owner.new_record? && using_reflection.inverse_of && using_reflection.inverse_of.options[:cached_at]
         cache_column = "#{using_reflection.name}_cached_at"
-        owner.raw_write_attribute(cache_column, timestamp)
+        owner.send(:write_attribute_without_type_cast, cache_column, timestamp)
         owner.update_columns(cache_column => timestamp)
       end
     end
@@ -50,7 +50,7 @@ module CachedAt
         end
 
         cache_column = "#{using_reflection.inverse_of.name}_cached_at"
-        records.each { |r| r.raw_write_attribute(cache_column, timestamp) }
+        records.each { |r| r.send(:write_attribute_without_type_cast, cache_column, timestamp) }
         query = klass.where(klass.primary_key => records.map(&:id))
         query.update_all({ cache_column => timestamp })
         traverse_relationships(klass, using_reflection.options[:cached_at], query, cache_column, timestamp)

data/lib/cached_at/associations/has_one_association.rb

@@ -24,7 +24,7 @@ module CachedAt
       end
       
       if loaded? && target
-        target.raw_write_attribute(cache_column, timestamp)
+        target.send(:write_attribute_without_type_cast, cache_column, timestamp)
       end
     end
     

data/lib/cached_at/base.rb

@@ -13,24 +13,38 @@ module CachedAt
     extend ActiveSupport::Concern
 
     included do
+      class_attribute   :cached_at_settings, default: {ignore: ['cached_at', 'updated_at', 'created_at']}
+      before_save       :set_cached_at
       before_save       :update_belongs_to_cached_at_keys
       before_destroy    { update_relations_cached_at(method: :destroy) }
 
       after_touch       { update_relations_cached_at_from_cached_at(method: :touch) }
-      after_save     :update_relations_cached_at_from_cached_at
+      after_save        :update_relations_cached_at_from_cached_at
+    end
+
+    class_methods do
+      def cached_at(ignore: [])
+        ignore = [ignore] if !ignore.is_a?(Array)
+        self.cached_at_settings[:ignore].push(*ignore.map(&:to_s))
+      end
+    end
+
+    def touch(*names, time: nil)
+      names.push('cached_at')
+      super(*names, time: time)
     end
 
     private
     
     def update_relations_cached_at_from_cached_at(method: nil)
-      update_relations_cached_at({
+      update_relations_cached_at(
         timestamp: (self.class.column_names.include?('cached_at') ? cached_at : nil),
         method: method
-      })
+      )
     end
     
     def update_relations_cached_at(timestamp: nil, method: nil)
-      method = instance_variable_defined?(:@new_record_before_save) && @new_record_before_save ? :create : :update if method.nil?
+      method = @_new_record_before_last_commit ? :create : :update if method.nil?
       
       diff = saved_changes.transform_values(&:first)
       return if method == :create && diff.empty?
@@ -49,22 +63,30 @@ module CachedAt
       end
     end
 
+    def set_cached_at
+      return if !self.class.column_names.include?('cached_at')
+      diff = changes.transform_values(&:first)
+      return if diff.keys.all? { |k| cached_at_settings[:ignore].include?(k) }
+
+      self.cached_at = current_time_from_proper_timezone
+    end
+
     def update_belongs_to_cached_at_keys
       self.class.reflect_on_all_associations.each do |reflection|
         next unless reflection.is_a?(ActiveRecord::Reflection::BelongsToReflection)
         cache_column = "#{reflection.name}_cached_at"
 
         if self.attribute_names.include?(cache_column)
-          if self.changes.has_key?(reflection.foreign_key) && self.changes[reflection.foreign_key][1].nil?
+          if self.changes_to_save.has_key?(reflection.foreign_key) && self.changes_to_save[reflection.foreign_key][1].nil?
             self.assign_attributes({ cache_column => current_time_from_proper_timezone })
-          elsif (self.changes[reflection.foreign_key] || self.new_record? || (self.association(reflection.name).loaded? && self.send(reflection.name) && self.send(reflection.name).id.nil?)) && self.send(reflection.name).try(:cached_at)
+          elsif (self.changes_to_save[reflection.foreign_key] || self.new_record? || (self.association(reflection.name).loaded? && self.send(reflection.name) && self.send(reflection.name).id.nil?)) && self.send(reflection.name).try(:cached_at)
             self.assign_attributes({ cache_column => self.send(reflection.name).cached_at })
           end
         end
         
       end
     end
-    
+
   end
 end
 

data/lib/cached_at/helpers.rb

@@ -29,16 +29,40 @@ module CachedAt
 
       end
 
-      def cache_key(includes = nil)
+      def cache_key(*includes)
         if includes.nil? || includes.empty?
-          super
+          if cache_versioning
+            "#{model_name.cache_key}/#{id}"
+          else
+            "#{model_name.cache_key}/#{id}@#{cache_version}"
+          end
+        else
+          digest = Digest::MD5.hexdigest(paramaterize_cache_includes(includes))
+          if cache_versioning
+            "#{model_name.cache_key}/#{id}+#{digest}"
+          else
+            "#{model_name.cache_key}/#{id}+#{digest}@#{cache_version(includes)}"
+          end
+        end
+      end
+
+      def cache_key_with_version(*includes)
+        if version = cache_version(*includes)
+          "#{cache_key(*includes)}-#{version}"
+        else
+          cache_key(*includes)
+        end
+      end
+
+      def cache_version(*includes)
+        timestamp = if includes.empty?
+          try(:cached_at) || try(:cached_at)
         else
           timestamp_keys = ['cached_at'] + self.class.cached_at_columns_for_includes(includes)
-          timestamp = max_updated_column_timestamp(timestamp_keys).utc.to_s(cache_timestamp_format)
-          digest ||= Digest::MD5.new()
-          digest << paramaterize_cache_includes(includes)
-          "#{model_name.cache_key}/#{id}+#{digest.hexdigest}@#{timestamp}"
+          timestamp = timestamp_keys.map { |attr| self[attr]&.to_time }.compact.max
         end
+        
+        timestamp.utc.to_s(:usec)
       end
 
       # TODO
@@ -84,4 +108,4 @@ module CachedAt
   end
 end
 
-ActiveRecord::Base.include(CachedAt::Base::Helpers)
+ActiveRecord::Base.include(CachedAt::Base::Helpers)

data/lib/cached_at/timestamp.rb

@@ -7,11 +7,13 @@ module ActiveRecord
         private
     
         def timestamp_attributes_for_update
-          ['updated_at', 'cached_at']
+          ["updated_at", "updated_on", 'cached_at'].map! { |name| attribute_aliases[name] || name }
         end
 
         def timestamp_attributes_for_create
-          ['created_at', 'udpated_at', 'cached_at'] + column_names.select{|c| c.end_with?('_cached_at') }
+          (['created_at', 'udpated_at', 'cached_at'] + column_names.select{|c| c.end_with?('_cached_at') }).map! do |name|
+            attribute_aliases[name] || name
+          end
         end
 
       end

data/lib/cached_at/version.rb

@@ -1,3 +1,3 @@
 module CachedAt
-  VERSION = '5.1.0'
+  VERSION = '6.1.0'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-cached_at
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Jon Bracy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-28 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -143,8 +143,6 @@ files:
 - lib/cached_at/associations/has_many_through_association.rb
 - lib/cached_at/associations/has_one_association.rb
 - lib/cached_at/base.rb
-- lib/cached_at/connection_adapters/abstract/schema_definitions.rb
-- lib/cached_at/connection_adapters/abstract/schema_statements.rb
 - lib/cached_at/helpers.rb
 - lib/cached_at/reflections/abstract_reflection.rb
 - lib/cached_at/timestamp.rb
@@ -153,7 +151,7 @@ homepage: https://github.com/malomalo/activerecord-cached_at
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -170,9 +168,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Allows ActiveRecord and Rails to use a `cached_at` column for the `cache_key`
   if available

data/lib/cached_at/connection_adapters/abstract/schema_definitions.rb

@@ -1,17 +0,0 @@
-module ActiveRecord
-  module ConnectionAdapters #:nodoc:
-    
-    class TableDefinition
-      def timestamps(*args)
-        options = args.extract_options!
-        
-        options[:null] = false if options[:null].nil?
-        
-        column(:created_at, :datetime, options)
-        column(:updated_at, :datetime, options)
-        column(:cached_at, :datetime, options)
-      end
-    end
-    
-  end
-end

data/lib/cached_at/connection_adapters/abstract/schema_statements.rb

@@ -1,21 +0,0 @@
-module ActiveRecord
-  module ConnectionAdapters #:nodoc:
-
-    module SchemaStatements
-      def add_timestamps(table_name, options = {})
-        options[:null] = false if options[:null].nil?
-        
-        add_column table_name, :created_at, :datetime, options
-        add_column table_name, :updated_at, :datetime, options
-        add_column table_name, :cached_at, :datetime, options
-      end
-      
-      def remove_timestamps(table_name, options = {})
-        remove_column table_name, :updated_at
-        remove_column table_name, :created_at
-        remove_column table_name, :cached_at
-      end
-    end
-
-  end
-end