activerecord-cached_at 5.2.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 239749f64d6cfea60e5980c0f47fb9bbaa96eca7fa416bed82ba40d0f17fa284
-  data.tar.gz: 161a47ae7ba00f3bb112b24bf26f69f5c9604a0bbf2558f6b34e269a62e524ea
+  metadata.gz: d0d9e3d63dbd18d8baab8017ad304e44f55b73ebe42060e0723438b252dc4cfe
+  data.tar.gz: 1c6cbb926a39f8c2cabe19a44d918e063df2f6278d443ea3d13ffae37b28e608
 SHA512:
-  metadata.gz: e4076c01c2720e82212537c1575b6e6d5866b6be0818d6bbbdf0be80ec034613130861fe23e5b5f2e53ad84153ce9b5376df15feb7f734d0e15b466b62763f69
-  data.tar.gz: eec3533e19885cffc9830ce8a6ce9e012e675ffb172aad80bb681554e8320479bc02f3f58438d7a4e75744cefd73d177ff7ac167f6f81c70da8603eeb0fee20a
+  metadata.gz: bfafa9a17b95d329a28b0b7b3cc2c570b5cb206b9e9ab51a653f263b971fa59e5d56b4ecc87db02c1a0a526e98ff2ef3012ccc49b31b73da3f7c65cec9d7fc5b
+  data.tar.gz: 1311efa1ca1b808d636739c417ceb5561976e9d6565096ba871a51bed9e2faa40110de75a000c48d93e51e63e3022f523cdfd7fb05e956e9a82e734c81c704fa

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/lib/cached_at/base.rb

@@ -13,20 +13,34 @@ 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)
@@ -49,6 +63,14 @@ 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)
@@ -64,7 +86,7 @@ module CachedAt
         
       end
     end
-    
+
   end
 end
 

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

@@ -2,14 +2,12 @@ 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)
+        column(:cached_at,  :datetime, options)
       end
     end
     

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

@@ -7,7 +7,7 @@ module ActiveRecord
         
         add_column table_name, :created_at, :datetime, options
         add_column table_name, :updated_at, :datetime, options
-        add_column table_name, :cached_at, :datetime, options
+        add_column table_name, :cached_at,  :datetime, options
       end
       
       def remove_timestamps(table_name, options = {})

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,7 +7,7 @@ module ActiveRecord
         private
     
         def timestamp_attributes_for_update
-          ['updated_at', 'cached_at']
+          ['updated_at']
         end
 
         def timestamp_attributes_for_create

data/lib/cached_at/version.rb

@@ -1,3 +1,3 @@
 module CachedAt
-  VERSION = '5.2.1.0'
+  VERSION = '6.0.0'
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-cached_at
 version: !ruby/object:Gem::Version
-  version: 5.2.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Jon Bracy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-08 00:00:00.000000000 Z
+date: 2020-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.1
 - !ruby/object:Gem::Dependency
@@ -153,7 +153,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 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Allows ActiveRecord and Rails to use a `cached_at` column for the `cache_key`
   if available