common-data-caching 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3807a5c6b09ddd98dfcb3b476defd965be5b6c158577c212284eb2f1521197e3
+  data.tar.gz: 6a715c0d8a1f00ed3efab75ad5b4f5fba86d346804e0dc8aab776df35363f002
+SHA512:
+  metadata.gz: d5a7cedbb2265e339fb3b022fdd54b37b878a0c3bb16d873a3b84bdc5394f993e07a42ed13055c5d2fb9e3e07f13f4ba2ff24931871dffdc75b9b80b31550d90
+  data.tar.gz: e9d850897b225c517d8edea7f939d3359f7cb0297ee26e42efc205ab58f81e1c58966df858a8714922f67fd929d23cc096ccf9727c0b6e2ae3dd86e80f5609d5

data/README.md

@@ -0,0 +1,88 @@
+# Common Data Caching
+[![Gem Version](https://badge.fury.io/rb/common-data-caching.svg)](https://badge.fury.io/rb/common-data-caching)
+
+Гем для кеширования общих данных Rails.
+
+Часто в проектах Rails приходится формировать списки объектов для их дальнейшей обработки фронтендом (например отображение опций в селектах).
+
+Подобные коллекции могут вызываться очень часто. И, чтобы не нагружать БД, лучше их кешировать.
+
+Этот гем предназначен для простого кеширования необходимых данных и получения готовых кешированных коллекций.
+
+## Установка
+
+Добавить в Gemfile
+
+```ruby
+gem 'common-data-caching'
+```
+
+И выполнить:
+
+```bash
+bundle
+```
+
+## Использование
+
+Добавьте вызов `common_cache` на моделях, передав обязательную опцию `attrs` со списком атрибутов, которые должны быть в закешированной коллекции (`id` будет добавлен по умолчанию, добавлять его не обязательно):
+
+```ruby
+class User < ActiveRecord::Base
+  common_cache attrs: %i[email name]
+end
+```
+
+Коллекция кеша будет обновляться после каждого изменения записи модели - создании, обновлении, удалении.
+
+Для получения коллекции кеша общих данных вызовите метод `common_data_cache_collection`:
+
+```ruby
+User.common_data_cache_collection
+```
+
+### Сортировка
+
+Для применения сортировки, передайте опцию `order`:
+
+```ruby
+class User < ActiveRecord::Base
+  common_cache attrs: %i[email name],
+               order: 'name desc'
+end
+```
+
+Значение опции `order` должно соответствовать тем же значениям, которые принимает метод `.order` ActiveRecord.
+
+По умолчанию, сортировка осуществляется по `id` в направлении `ASC`, до тех пор пока не будет передан `order`.
+
+### Фильтрация
+
+Для применения фильтрации/ограничений записей, из которых будет сформирована закешированная коллекция, передайте опцию `scope`:
+
+```ruby
+class User < ActiveRecord::Base
+  common_cache attrs: %i[email name],
+               scope: proc { where(role: 'admin') }
+end
+```
+
+Значение опции `scope` должно быть условием `where` ActiveRecord, Rails скоупом или их последовательностью, которые необходимо обернуть в `proc`.
+
+По умолчанию, фильтрация не применяется, до тех пор пока не будет передан `scope`.
+
+## Массовое обновление коллекций
+
+Для массового обновления всех коллекций воспользутесь Rake таском:
+
+```bash
+rake common_data_caching:update
+```
+
+## Capistrano
+
+Для обновления кеша общих данных при каждом деплое с помощью Capistrano добавьте в Capfile:
+
+```ruby
+require 'common_data_caching/capistrano'
+```

data/lib/common-data-caching.rb

@@ -0,0 +1 @@
+require 'common_data_caching'

data/lib/common_data_caching/callbacks.rb

@@ -0,0 +1,27 @@
+module CommonDataCaching
+  module Callbacks
+
+    extend ActiveSupport::Concern
+
+    def common_data_caching?
+      true
+    end
+
+    private
+
+    def update_common_data_cache
+      # обновить коллекцию кеша всей сущности
+      self.class.update_common_data_cache
+
+      # удалить отдельно кешированную запись
+      key = self.class.common_cache_key(id)
+      Rails.cache.delete(key)
+    end
+
+    def update_common_data_cache_versions
+      # обновление версии кешированной коллекции
+      self.class.update_common_data_cache_versions
+    end
+
+  end
+end

data/lib/common_data_caching/capistrano/tasks/common_data_caching.rake

@@ -0,0 +1,12 @@
+namespace :common_data_caching do
+  desc 'Обновление кеша общих данных'
+  task :update do
+    on roles(:app) do
+      within release_path do
+        with rails_env: "#{fetch(:stage)}" do
+          execute :rake, 'common_data_caching:update_cache'
+        end
+      end
+    end
+  end
+end

data/lib/common_data_caching/capistrano.rb

@@ -0,0 +1 @@
+load File.expand_path('../capistrano/tasks/common_data_caching.rake', __FILE__)

data/lib/common_data_caching/class_methods.rb

@@ -0,0 +1,46 @@
+module CommonDataCaching
+  module ClassMethods
+
+    def common_data_caching?
+      true
+    end
+
+    def common_data_cache_key(id = nil)
+      ['common-data-caching', to_s, id].compact.join('_')
+    end
+
+    def common_data_cache_collection
+      Rails.cache.fetch(common_data_cache_key) || []
+    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_cache_key, data)
+    end
+
+    def update_common_data_cache_versions
+      versions = Rails.cache.read('common_cache_versions') || {}
+      versions[to_s] = Time.now.to_i
+      Rails.cache.write('common_cache_versions', versions)
+    end
+
+    def prepare_common_data_collection
+      # колонка ID по умолчанию
+      hash = { id: :id }
+
+      cache_opts[:attrs].flatten.map do |key|
+        key.is_a?(Hash) ? hash.merge!(key) : hash.merge!(key => key)
+      end
+
+      keys = hash.keys.unshift(:id)
+
+      all.map do |object|
+        keys.to_h { |title| [title, object.send(hash[title])] }
+      end
+    end
+
+  end
+end

data/lib/common_data_caching/rake_tasks.rb

@@ -0,0 +1,24 @@
+namespace :common_data_caching do
+
+  desc 'Обновить кеш общих данных'
+  task update_cache: :environment do
+    # получение списка моделей
+    Rails.application.eager_load!
+    models = ActiveRecord::Base.descendants
+
+    # удаление старых версий кеша
+    Rails.cache.delete('common_cache_versions')
+
+    models.each do |model|
+      # проверка - в модели предусмотрено кеширование общих данных
+      next unless model.common_data_caching?
+
+      # обновление кеша
+      model.update_common_cache
+
+      # обновление версий кеша
+      model.update_common_cache_versions
+    end
+  end
+
+end

data/lib/common_data_caching.rb

@@ -0,0 +1,33 @@
+require 'rake'
+require 'common_data_caching/callbacks'
+require 'common_data_caching/class_methods'
+require 'common_data_caching/rake_tasks'
+
+module CommonDataCaching
+end
+
+ActiveSupport.on_load(:active_record) do
+  class ActiveRecord::Base
+    def self.common_data_caching?
+      false
+    end
+
+    def common_data_caching?
+      self.class.common_data_caching?
+    end
+
+    def self.common_cache(options= {})
+      # опции кешинга
+      class_attribute :cache_opts
+      self.cache_opts = options
+
+      # методы кеширования
+      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?
+    end
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: common-data-caching
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Павел Бабин
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Кеширование общих данных
+email: babin359@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/common-data-caching.rb
+- lib/common_data_caching.rb
+- lib/common_data_caching/callbacks.rb
+- lib/common_data_caching/capistrano.rb
+- lib/common_data_caching/capistrano/tasks/common_data_caching.rake
+- lib/common_data_caching/class_methods.rb
+- lib/common_data_caching/rake_tasks.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: Кеширование общих данных
+test_files: []