thermos 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ad51a5746942e6b4ebba54cb95f906b7521f25a4c746b4a3d22e1855e935c7e
-  data.tar.gz: 4c0a9dceea7a709c7b3ce541fbd9895f7585ab889b3b80f05f6d564fd1cb0ff2
+  metadata.gz: 87ceed3d0f1b54b2cd9e9b0afde15e90252fcbc9f575c5bf11a66e414045c5d5
+  data.tar.gz: dc3bc76cd808f474b80676c5f2d1f2e50681c6028c09412e12eb565b4494cfc4
 SHA512:
-  metadata.gz: e4c2c9f520e0b27d0aff7147b8ff1db84ff99cea1e4cd66bf10bd11b33e5a5d13fb3e181ef616ada90bd2dc5ce7343f40ddaf414a92989697851e9d040673e6c
-  data.tar.gz: 06c365876889c0d7729397613dd7c6c267667138824c43e47d9b670718e696df488424a90914fda58dda29891810005c0fbac503020e0987795a283941792fa2
+  metadata.gz: d86ada3f6a3b07ed8bbf35c481e73ac4563a0aced184f6e47a986847287f0bf4a3c02c42e5d7600db1f5d8c2358f5ba4975fd20c4ccceee8fc3ec0cfcaae7811
+  data.tar.gz: 51f90cb754d381d81293e433261e09cb4e184dc1dcddd05fbfcbf7baacb577330f6a4cc6a0621cc8cd9964d7677e499554a8dd533d65762adb421d56cef58458

data/lib/thermos.rb

@@ -8,14 +8,14 @@ require 'thermos/refill_job'
 require 'thermos/rebuild_cache_job'
 
 module Thermos
-  def self.keep_warm(key:, model:, id:, deps: [], lookup_key: nil, &block)
-    fill(key: key, model: model, deps: deps, lookup_key: lookup_key, &block)
+  def self.keep_warm(key:, model:, id:, deps: [], lookup_key: nil, filter: nil, &block)
+    fill(key: key, model: model, deps: deps, lookup_key: lookup_key, filter: filter, &block)
     drink(key: key, id: id)
   end
 
-  def self.fill(key:, model:, deps: [], lookup_key: nil, &block)
+  def self.fill(key:, model:, deps: [], lookup_key: nil, filter: nil, &block)
     BeverageStorage.instance.add_beverage(
-      Beverage.new(key: key, model: model, deps: deps, action: block, lookup_key: lookup_key)
+      Beverage.new(key: key, model: model, deps: deps, action: block, lookup_key: lookup_key, filter: filter)
     )
   end
 

data/lib/thermos/beverage.rb

@@ -2,29 +2,33 @@
 
 module Thermos
   class Beverage
-    attr_reader :key, :model, :deps, :action, :lookup_key
+    attr_reader :key, :model, :deps, :action, :lookup_key, :filter
 
-    def initialize(key:, model:, deps:, action:, lookup_key: nil)
+    def initialize(key:, model:, deps:, action:, lookup_key: nil, filter: nil)
       @key = key
       @model = model
       @lookup_key = lookup_key || :id
-      @deps = deps.map do |dep|
-        Dependency.new(model: model, association: dep)
-      end
+      @filter = filter || nil
+      @deps = generate_deps(model, deps)
       @action = action
 
       set_observers
     end
 
     def lookup_keys_for_dep_model(dep_model)
-      @deps.flat_map do |dep|
-        return [] unless dep.klass == dep_model.class
-        @model.joins(dep.association)
+      @deps.select do |dep|
+        dep.klass == dep_model.class
+      end.flat_map do |dep|
+        @model.joins(dep.path)
               .where(dep.table => { id: dep_model.id })
               .pluck(@lookup_key)
       end.uniq
     end
 
+    def should_fill?(model)
+      @filter.class == Proc ? !!@filter.call(model) : true
+    end
+
     private
 
     def set_observers
@@ -35,5 +39,34 @@ module Thermos
     def observe(model)
       model.include(Notifier) unless model.included_modules.include?(Notifier)
     end
+
+    def generate_deps(model, deps, root = nil, path = nil)
+      deps.reduce([]) do |acc, dep|
+        if dep.is_a? Symbol
+          acc << Dependency.new(
+            model: root || model, 
+            ref: model.reflect_on_association(dep), 
+            path: path || dep)
+        elsif dep.is_a? Array
+          dep.each do |d| 
+            acc << Dependency.new(
+              model: root || model, 
+              ref: model.reflect_on_association(d), 
+              path: path || d)
+          end
+        elsif dep.is_a? Hash
+          dep.each do |k,v|
+            ref = model.reflect_on_association(k)
+            acc << Dependency.new(
+              model: root || model, 
+              ref: ref, 
+              path: path || k
+            )
+            acc.concat(generate_deps(ref.class_name.constantize, v, model, dep))
+          end
+        end
+        acc
+      end
+    end
   end
 end

data/lib/thermos/dependency.rb

@@ -2,14 +2,13 @@
 
 module Thermos
   class Dependency
-    attr_reader :model, :association, :klass, :table
+    attr_reader :model, :path, :klass, :table
 
-    def initialize(model:, association:)
+    def initialize(model:, ref:, path: nil)
       @model = model
-      @association = association
-      reflection = @model.reflections[@association.to_s]
-      @table = reflection.table_name
-      @klass = reflection.class_name.constantize
+      @path = path
+      @table = ref.table_name
+      @klass = ref.class_name.constantize
     end
   end
 end

data/lib/thermos/notifier.rb

@@ -5,7 +5,7 @@ module Thermos
     extend ActiveSupport::Concern
 
     included do
-      after_save :notify_thermos
+      after_commit :notify_thermos
     end
 
     private

data/lib/thermos/refill_job.rb

@@ -9,7 +9,7 @@ module Thermos
 
     def refill_primary_caches(model)
       BeverageStorage.instance.beverages.each do |beverage|
-        if beverage.model == model.class
+        if beverage.model == model.class && beverage.should_fill?(model)
           Thermos::RebuildCacheJob.perform_later(beverage.key, model.send(beverage.lookup_key))
         end
       end
@@ -17,8 +17,10 @@ module Thermos
 
     def refill_dependency_caches(model)
       BeverageStorage.instance.beverages.each do |beverage|
-        beverage.lookup_keys_for_dep_model(model).each do |lookup_key|
-          Thermos::RebuildCacheJob.perform_later(beverage.key, lookup_key)
+        if beverage.should_fill?(model)
+          beverage.lookup_keys_for_dep_model(model).each do |lookup_key|
+            Thermos::RebuildCacheJob.perform_later(beverage.key, lookup_key)
+          end
         end
       end
     end

data/lib/thermos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Thermos
-  VERSION = '0.2.1'
+  VERSION = '0.5.0'
 end

data/test/dummy/config/application.rb

@@ -18,10 +18,6 @@ module Dummy
     # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
     # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
     # config.i18n.default_locale = :de
-
-    if Rails.version >= "5.2.0"
-      Rails.application.config.active_record.sqlite3.represent_boolean_as_integer = true
-    end
   end
 end
 

data/test/dummy/db/schema.rb

@@ -2,11 +2,11 @@
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
 #
-# Note that this schema.rb definition is the authoritative source for your
-# database schema. If you need to create the application database on another
-# system, you should be using db:schema:load, not running all the migrations
-# from scratch. The latter is a flawed and unsustainable approach (the more migrations
-# you'll amass, the slower it'll run and the greater likelihood for issues).
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
 #
 # It's strongly recommended that you check this file into your version control system.
 

data/test/thermos_test.rb

@@ -65,6 +65,30 @@ class ThermosTest < ActiveSupport::TestCase
     assert_raises(MockExpectationError) { mock.verify }
   end
 
+  test "does not rebuild the cache on rolled back primary model change" do
+    mock = Minitest::Mock.new
+    category = categories(:baseball)
+
+    Thermos.fill(key: "key", model: Category) do |id|
+      mock.call(id)
+    end
+
+    mock.expect(:call, 1, [category.id])
+    assert_equal 1, Thermos.drink(key: "key", id: category.id)
+    mock.verify
+
+    mock.expect(:call, 2, [category.id])
+    ActiveRecord::Base.transaction do
+      category.update!(name: "foo")
+      raise ActiveRecord::Rollback
+    end
+    assert_raises(MockExpectationError) { mock.verify }
+
+    mock.expect(:call, 3, [category.id])
+    assert_equal 1, Thermos.drink(key: "key", id: category.id)
+    assert_raises(MockExpectationError) { mock.verify }
+  end
+
   test "does not rebuild the cache for an unrelated primary model change" do
     mock = Minitest::Mock.new
     category = categories(:baseball)
@@ -102,6 +126,23 @@ class ThermosTest < ActiveSupport::TestCase
     assert_equal 1, Thermos.drink(key: "key", id: "foo")
     assert_raises(MockExpectationError) { mock.verify }
   end
+  
+  test "allows filtering for which records should be rebuilt" do
+    mock = Minitest::Mock.new
+    category = categories(:baseball)
+    filter = ->(model) { model.name.match("ball") }
+    Thermos.fill(key: "key", model: Category, lookup_key: "name", filter: filter) do |name|
+      mock.call(name)
+    end
+
+    mock.expect(:call, 1, ["basketball"])
+    category.update!(name: "basketball")
+    mock.verify
+
+    mock.expect(:call, 1, ["hockey"])
+    category.update!(name: "hockey")
+    assert_raises(MockExpectationError) { mock.verify }
+  end
 
 # has_many model changes
   test "rebuilds the cache on has_many model change" do
@@ -290,6 +331,30 @@ class ThermosTest < ActiveSupport::TestCase
     assert_raises(MockExpectationError) { mock.verify }
   end
 
+  test "handles indirect associations" do
+    mock = Minitest::Mock.new
+    category = categories(:baseball)
+    store = category.store
+
+    Thermos.fill(key: "key", model: Store, deps: [categories: [:products]]) do |id|
+      mock.call(id)
+    end
+
+    mock.expect(:call, 1, [store.id])
+    category.update!(name: "foo")
+    mock.verify
+  
+    mock.expect(:call, 2, [store.id])
+    assert_equal 1, Thermos.drink(key: "key", id: store.id)
+    assert_raises(MockExpectationError) { mock.verify }
+    Product.create!(categories: [category])
+    mock.verify
+    
+    mock.expect(:call, 3, [store.id])
+    assert_equal 2, Thermos.drink(key: "key", id: store.id)
+    assert_raises(MockExpectationError) { mock.verify }
+  end
+
   test "only rebuilds cache for stated dependencies, even if another cache has an associated model of the primary" do
     category_mock = Minitest::Mock.new
     product_mock = Minitest::Mock.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thermos
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrew Thal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-02 00:00:00.000000000 Z
+date: 2021-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.2.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.2.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -134,64 +140,67 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.5.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 2.8.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Always-warm, auto-rebuilding rails caching without timers or touching.
 test_files:
-- test/fixtures/category_items.yml
+- test/thermos_test.rb
 - test/fixtures/categories.yml
-- test/fixtures/stores.yml
 - test/fixtures/products.yml
+- test/fixtures/stores.yml
+- test/fixtures/category_items.yml
+- test/dummy/README.rdoc
+- test/dummy/config.ru
+- test/dummy/Rakefile
+- test/dummy/db/schema.rb
+- test/dummy/db/migrate/20160325214744_create_categories.rb
+- test/dummy/db/migrate/20160326174530_create_stores.rb
+- test/dummy/db/migrate/20160325214849_create_products.rb
+- test/dummy/db/migrate/20160325220006_create_category_items.rb
+- test/dummy/config/environment.rb
+- test/dummy/config/secrets.yml
 - test/dummy/config/application.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
 - test/dummy/config/boot.rb
-- test/dummy/config/routes.rb
 - test/dummy/config/locales/en.yml
-- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/database.yml
 - test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/initializers/assets.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/assets.rb
 - test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/secrets.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/bin/setup
-- test/dummy/bin/rails
-- test/dummy/bin/bundle
-- test/dummy/bin/rake
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/models/store.rb
-- test/dummy/app/models/category.rb
-- test/dummy/app/models/product.rb
+- test/dummy/config/routes.rb
+- test/dummy/public/500.html
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/favicon.ico
 - test/dummy/app/models/category_item.rb
-- test/dummy/app/assets/config/manifest.js
-- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/models/product.rb
+- test/dummy/app/models/category.rb
+- test/dummy/app/models/store.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/assets/config/manifest.js
 - test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/db/schema.rb
-- test/dummy/db/migrate/20160325214849_create_products.rb
-- test/dummy/db/migrate/20160325220006_create_category_items.rb
-- test/dummy/db/migrate/20160325214744_create_categories.rb
-- test/dummy/db/migrate/20160326174530_create_stores.rb
-- test/dummy/public/404.html
-- test/dummy/public/favicon.ico
-- test/dummy/public/500.html
-- test/dummy/public/422.html
-- test/dummy/config.ru
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
-- test/thermos_test.rb
+- test/dummy/bin/setup
+- test/dummy/bin/bundle
+- test/dummy/bin/rake
+- test/dummy/bin/rails
 - test/test_helper.rb