adequate_serialization 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85146c58398835d031d5a5f1acf857314053bd3a3eeef74a9a805c01b595dd8d
-  data.tar.gz: fe2b4c681f16af90ee97689fffb85d6dba5444de178bfd6b2a8eba97cbf9b62c
+  metadata.gz: 273a3e30de9eed1f993b3f83aae405a660bc84aea6f9bf59682c7d99ca838a9c
+  data.tar.gz: e3ec7712f4f66088ec4017b4add90977c3282b0d057362bc14d4bf2ed30c1c49
 SHA512:
-  metadata.gz: 2c885c5465c961352409433e327baf8b6a1983b7a0a0342c74faa69446cc1ea2acc3ad616e4621f4ed601e40182fba843cabec4f52e6a1869471824887061b5d
-  data.tar.gz: 312bea7bb4ea77435edad2131d085a28a7a709ec01ee737558c1ba37191d5f9bf97f02d174ab457b26390bbe7875b090cbf283389122f15b231ef58c60be79ac
+  metadata.gz: ebf077cfd6ddfbd155a45fcdbff67ab31f003adc2df6567e1d672cee581b6fbd58e021ceb7a011fd98e54cdecf4a3f9cfbab346b3c6e996defbb34669bdd1050
+  data.tar.gz: 5a2641ee46b36951066f77670b15fe80fe8b48bbaa41808a3d359a2c8fcf89766b7e638b435dffceaf1dc90e905bd1ffc73ca0559100781763d1e5bea433165a

data/CHANGELOG.md

@@ -6,6 +6,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [2.0.1] - 2020-01-02
+
+### Added
+
+- The top level `AdequateSerialization::associate_cache` method for arbitrarily associating caches between records. Useful for things like polymorphic associations which cannot be performed automatically.
+
+### Changed
+
+- Fixed the active job queue setting configuration so that it will properly update ActiveJob when using Sidekiq.
+- Fixed the cache busting for regular has_many relationships.
+- Changed the name of the `::serialized_associations` method to `::associated_caches` to be more clear.
+
 ## [2.0.0] - 2019-12-31
 
 ### Added
@@ -46,7 +58,9 @@ end
 
 - No longer trigger another query when the `ActiveRecord` relation being serialized isn't loaded.
 
-[unreleased]: https://github.com/CultureHQ/adequate_serialization/compare/v1.0.1...HEAD
+[unreleased]: https://github.com/CultureHQ/adequate_serialization/compare/v2.0.1...HEAD
+[2.0.1]: https://github.com/CultureHQ/adequate_serialization/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/CultureHQ/adequate_serialization/compare/v1.0.1...v2.0.0
 [1.0.1]: https://github.com/CultureHQ/adequate_serialization/compare/v1.0.0...v1.0.1
 [1.0.0]: https://github.com/CultureHQ/adequate_serialization/compare/v0.1.1...v1.0.0
 [0.1.1]: https://github.com/CultureHQ/adequate_serialization/compare/fcc7c7...v0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    adequate_serialization (2.0.0)
+    adequate_serialization (2.0.1)
       oj (~> 3.10)
 
 GEM
@@ -76,7 +76,7 @@ GEM
     i18n (1.7.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
-    json (2.2.0)
+    json (2.3.0)
     loofah (2.4.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -94,7 +94,7 @@ GEM
       mini_portile2 (~> 2.4.0)
     oj (3.10.0)
     parallel (1.19.1)
-    parser (2.6.5.0)
+    parser (2.7.0.1)
       ast (~> 2.4.0)
     rack (2.0.8)
     rack-test (1.1.0)
@@ -150,7 +150,7 @@ GEM
     sqlite3 (1.4.2)
     thor (0.20.3)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
     websocket-driver (0.7.1)

data/lib/adequate_serialization.rb

@@ -10,14 +10,36 @@ module AdequateSerialization
   end
 
   class << self
-    attr_accessor :active_job_queue
+    attr_reader :active_job_queue
 
+    # Configure the queue name that AdequateSerialization will use when
+    # enqueuing jobs to bust associated caches.
+    def active_job_queue=(queue_name)
+      require 'adequate_serialization/rails/cache_refresh'
+      CacheRefresh::CacheRefreshJob.queue_name = queue_name
+    end
+
+    # Associate one or more caches with an active record such that when the
+    # record is updated the associated object caches are also updated.
+    def associate_cache(active_record, *association_names)
+      require 'adequate_serialization/rails/cache_refresh'
+
+      unless active_record.respond_to?(:associate_cache)
+        active_record.extend(CacheRefresh)
+      end
+
+      association_names.each do |association_name|
+        active_record.associate_cache(association_name)
+      end
+    end
+
+    # DSL-like block for parity with other Ruby/Rails libraries.
     def configure
       yield self
     end
   end
 
-  self.active_job_queue = :default
+  @active_job_queue = :default
 end
 
 require 'adequate_serialization/attribute'

data/lib/adequate_serialization/rails/cache_busting.rb

@@ -2,7 +2,7 @@
 
 module AdequateSerialization
   module CacheBusting
-    class InverseNotFoundError < StandardError
+    class InverseNotFoundError < Error
       def initialize(record, association)
         super(<<~MSG)
           In order to be able to bust the associated cache for #{record}'s
@@ -14,7 +14,7 @@ module AdequateSerialization
       end
     end
 
-    class TouchNotFoundError < StandardError
+    class TouchNotFoundError < Error
       def initialize(record, associated, inverse)
         super(<<~MSG)
           #{record} serializes all of the associated #{associated} records,
@@ -40,15 +40,12 @@ module AdequateSerialization
     using(
       Module.new do
         refine ActiveRecord::Base.singleton_class do
-          def setup_serialize_association(association_name)
+          def setup_association_cache(association_name)
             unless defined?(ActiveJob)
               raise ActiveJobNotFoundError.new(name, association_name)
             end
 
-            require 'adequate_serialization/rails/cache_refresh'
-            extend(CacheRefresh) unless respond_to?(:serialize_association)
-
-            serialize_association(association_name)
+            AdequateSerialization.associate_cache(self, association_name)
           end
         end
 
@@ -80,7 +77,7 @@ module AdequateSerialization
           # Hooks into the serialized class and adds cache busting behavior on
           # commit that will loop through the associated records
           def setup_has_some
-            active_record.setup_serialize_association(name)
+            klass.setup_association_cache(inverse_of.name)
           end
         end
 
@@ -90,7 +87,7 @@ module AdequateSerialization
               raise InverseNotFoundError.new(active_record.name, name)
             end
 
-            klass.setup_serialize_association(inverse_of.name)
+            klass.setup_association_cache(inverse_of.name)
           end
         end
       end

data/lib/adequate_serialization/rails/cache_refresh.rb

@@ -33,11 +33,11 @@ module AdequateSerialization
         end
       )
 
-      queue_as -> { AdequateSerialization.active_job_queue }
+      queue_as AdequateSerialization.active_job_queue
       discard_on ActiveJob::DeserializationError
 
       def perform(record)
-        record.class.serialized_associations.each do |association|
+        record.class.associated_caches.each do |association|
           record.public_send(association).refresh
         end
       end
@@ -47,14 +47,14 @@ module AdequateSerialization
       base.after_update_commit { CacheRefreshJob.perform_later(self) }
     end
 
-    def serialize_association(association)
-      serialized_associations << association
+    def associate_cache(association)
+      associated_caches << association
     end
 
     # The associations that serialize this object in their responses, so that we
     # know to bust their cache when this object is updated.
-    def serialized_associations
-      @serialized_associations ||= []
+    def associated_caches
+      @associated_caches ||= []
     end
   end
 end

data/lib/adequate_serialization/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AdequateSerialization
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adequate_serialization
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Kevin Deisz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-31 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj