common-data-caching 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd3f226deb5e5506068c4c077dbf5e2fadb8b4268d3bae92aa30922e43f024bd
-  data.tar.gz: '0827e9f74d4076509ff8bfc4afd095b9339b42b12fcaa0b996c4f922f3d0123b'
+  metadata.gz: '006960c18425203cd14453b7397ce61e86e36bd5ae9ad2fdaddf5134d32d57c4'
+  data.tar.gz: 6b5cbc02aea17efeb154c9e16fbdf8a34a02198b42267ae6d13df80a48c7cb90
 SHA512:
-  metadata.gz: 88fb81de30d3159345e76c7a12635c1b5b83806d56140b30427fb36845c5cad68eea625ceb5d266d78ccae314965796bd46607232a7e0647e9c80d38ec779d19
-  data.tar.gz: d4bb6c8a0873ed6a0d915ae0065d4ad7e97ed9a7c93ad07c566a2e54f921d8c577c17ab33713672a5938aa29e6afbe1e89d1672cc2f4d81290bcaf837e8e6ebb
+  metadata.gz: 6ac2ddd35958107eed0573f8824a9a1e84947dd22f4f3877dcf9465a7880f02265736e0982dff057928e78d406847a75bfdfd0003360407be7a5e3ad33f4e108
+  data.tar.gz: 6d2936545f2cc3157fb5a007f0bcd9909367c29dd7c0c90323530ce6ba9e2ad6bf3cdd5dbb9a7089c02d457308cfd8604b8695abb806d550a34f4f643b2196d2

data/README.md

@@ -47,6 +47,14 @@ User.common_data_cache_collection
 CommonDataCaching.versions
 ```
 
+При необходимости, чтобы не обновлять кеш при создании или редактировании определенной записи, передайте `skip_common_data_caching: true` в качестве аргумента:
+
+```ruby
+User.create(email: "user@example.com", skip_common_data_caching: true)
+
+User.find(1).update(name: "User", skip_common_data_caching: true)
+```
+
 ### Сортировка
 
 Для применения сортировки, передайте опцию `order`:
@@ -77,6 +85,26 @@ end
 
 По умолчанию, фильтрация не применяется, до тех пор пока не будет передан `scope`.
 
+### Коллекции
+
+Для кеширования разных коллекций в рамках одной модели воспользуйтесь опцией `collections`, передав в нее массив объектов, содержимое каждого их которых соответствует стандартным опциям; значение ключа кеша укажите в `key`:
+
+```ruby
+class User < ActiveRecord::Base
+  common_cache collections: [
+    {
+      key: 'admin_users',
+      attrs: %i[email name],
+      scope: proc { where(role: 'admin') }
+    },
+    {
+      key: 'manager_users',
+      attrs: [:name],
+      scope: proc { where(role: 'manager') }
+    }
+  ]
+```
+
 ## Массовое обновление коллекций
 
 Для массового обновления всех коллекций воспользутесь Rake таском:

data/lib/common_data_caching/callbacks.rb

@@ -3,6 +3,10 @@ module CommonDataCaching
 
     extend ActiveSupport::Concern
 
+    included do
+      attr_accessor :skip_common_data_caching
+    end
+
     def common_data_caching?
       true
     end

data/lib/common_data_caching/class_methods.rb

@@ -5,33 +5,40 @@ module CommonDataCaching
       true
     end
 
-    def common_data_cache_key
-      "common-data-caching_#{to_s}"
+    def common_data_cache_keys
+      if cache_opts[:collections]
+        cache_opts[:collections].map { |i| "common-data-caching_#{i[:key]}" }
+      else
+        ["common-data-caching_#{to_s}"]
+      end
     end
 
     def common_data_cache_collection
-      Rails.cache.fetch(common_data_cache_key) || []
+      Rails.cache.fetch("common-data-caching_#{to_s}") || []
     end
 
     def update_common_data_cache
-      scope = cache_opts[:scope] || proc { where('1=1') }
-      ordering = cache_opts[:order] || :id
-
-      data = merge(scope).order(ordering).prepare_common_data_collection
-      Rails.cache.write(common_data_cache_key, data)
+      if cache_opts[:collections]
+        handle_common_data_cache_collections
+      else
+        handle_common_data_collection(cache_opts)
+      end
     end
 
     def update_common_data_cache_versions
       versions = Rails.cache.read('common-data-caching-versions') || {}
-      versions[to_s] = Time.now.to_i
-      Rails.cache.write('common-data-caching-versions', versions)
+
+      common_data_cache_keys.each do |key|
+        versions[key] = Time.now.to_i
+        Rails.cache.write('common-data-caching-versions', versions)
+      end
     end
 
-    def prepare_common_data_collection
-      # колонка ID по умолчанию
+    def prepare_common_data_collection(attrs)
+      # колонка ID - по умолчанию
       hash = { id: :id }
 
-      cache_opts[:attrs].flatten.map do |key|
+      attrs.flatten.map do |key|
         key.is_a?(Hash) ? hash.merge!(key) : hash.merge!(key => key)
       end
 
@@ -42,5 +49,22 @@ module CommonDataCaching
       end
     end
 
+    private
+
+    def handle_common_data_cache_collections
+      cache_opts[:collections].each do |object|
+        handle_common_data_collection(object)
+      end
+    end
+
+    def handle_common_data_collection(object)
+      scope = object[:scope] || proc { where('1=1') }
+      ordering = object[:order] || :id
+      data = merge(scope).order(ordering).prepare_common_data_collection(object[:attrs])
+
+      key = object[:key] ? "common-data-caching_#{object[:key]}" : "common-data-caching_#{to_s}"
+      Rails.cache.write(key, data)
+    end
+
   end
 end

data/lib/common_data_caching/version.rb

@@ -0,0 +1,3 @@
+module CommonDataCaching
+  VERSION = '1.4.0'.freeze
+end

data/lib/common_data_caching.rb

@@ -9,6 +9,10 @@ module CommonDataCaching
     Rails.cache.read('common-data-caching-versions') || {}
   end
 
+  def self.collection(key)
+    Rails.cache.fetch("common-data-caching_#{key}") || []
+  end
+
   def self.all_collections
     versions.map do |entity, _version|
       {
@@ -58,10 +62,16 @@ ActiveSupport.on_load(:active_record) do
       # методы кеширования
       extend CommonDataCaching::ClassMethods
 
-      # установка коллбэков
+      # коллбэки
       include CommonDataCaching::Callbacks
-      after_commit :update_common_data_cache, on: %i[create update destroy], if: :common_data_caching?
-      after_commit :update_common_data_cache_versions, on: %i[create update destroy], if: :common_data_caching?
+
+      after_commit :update_common_data_cache,
+                   on: %i[create update destroy],
+                   if: proc { |i| i.common_data_caching? && i.skip_common_data_caching != true }
+
+      after_commit :update_common_data_cache_versions,
+                   on: %i[create update destroy],
+                   if: proc { |i| i.common_data_caching? && i.skip_common_data_caching != true }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: common-data-caching
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Павел Бабин
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-31 00:00:00.000000000 Z
+date: 2025-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,7 @@ files:
 - lib/common_data_caching/capistrano/tasks/common_data_caching.rake
 - lib/common_data_caching/class_methods.rb
 - lib/common_data_caching/rake_tasks.rb
+- lib/common_data_caching/version.rb
 homepage:
 licenses:
 - MIT