cache_crispies 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af451e5837f96664e141a147df118fbfffb7ee4fedc71cd5e6c34438b9069461
-  data.tar.gz: ffe23f3217c50b5c6bbbd183127a2274b6c4afb59ad93e50a271c880d20968f4
+  metadata.gz: 76074205a976b800720f4573f27c03e60e0d9aaa6467c20b2e2ad70fe8b2df61
+  data.tar.gz: 8c26453bad074e191ce415009917ffb8b99a4d7b1273f15b9be774d8bc42c686
 SHA512:
-  metadata.gz: e8208c9ef13c4f66e9d64c7b8a5394e7d2907b894ff4ca6617357ca785ede999048d3ef4ffc00d900a30e5ac284401a5b145fb2271764f878d16603017ac08d1
-  data.tar.gz: 167cf43b28151ec4d6c65c0badfcbe73a871f7a102bc916f04eb0e889069843e518db1a608da31c854096a60843bd50a69ab99a2b4b784a89ce1d5ecd5e549fe
+  metadata.gz: 361709a032d7b2e8c1d4600945fc2897021c8665f6b51b5e82a5d1edff3003afc547d7905b2679569f945f3a98066b256defea701835bf9317990e896ada65c0
+  data.tar.gz: 5562570b2b96d1c18b336c28229749a9d98a9ecddf27772f586c7ea95b21134c5862574a37577499f80c901ec21cd298b2b8698d2b4d7a4747cdf59f4e2c18a1

data/lib/cache_crispies/base.rb

@@ -100,8 +100,19 @@ module CacheCrispies
     #
     # @return [String] a cache key for the class
     def self.cache_key_base
-      # TODO: we may need to get a cache key from nested serializers as well :(
-      @cache_key_base ||= "#{self}-#{file_hash}"
+      @cache_key_base ||= "#{self}-#{file_hashes.join(CACHE_KEY_SEPARATOR)}"
+    end
+
+    # Return an array of cache key string for this serializer and all nested
+    # and deeply nested serializers. The purpose of grabbing all this data is
+    # to be able to construct a cache key that will be busted if any of the
+    # nested serializers, no matter how deep, change at all.
+    #
+    # @return [Array<String>] an array of uniq, sorted serializer file hashes
+    def self.file_hashes
+      @file_hashes ||= (
+        [file_hash] + nested_serializers.flat_map(&:file_hashes)
+      ).uniq.sort
     end
 
     private
@@ -139,6 +150,11 @@ module CacheCrispies
     end
     private_class_method :show_if
 
+    def self.nested_serializers
+      attributes.map(&:serializer).compact
+    end
+    private_class_method :nested_serializers
+
     def self.serialize(*attribute_names, from: nil, with: nil, to: nil)
       attribute_names.flatten.map { |att| att&.to_sym }.map do |attrib|
         current_nesting = Array(@nesting).dup

data/lib/cache_crispies/controller.rb

@@ -16,8 +16,11 @@ module CacheCrispies
     #   CacheCrispies::Base
     # @param cacheable [Object] can be any object. But is typically a Rails
     #   model inheriting from ActiveRecord::Base
-    # @param options [Hash] any hash of custom options that should be passed
-    #   to the serializer instance
+    # @param [Hash] options any optional values from the serializer instance
+    # @option options [Symbol] :key the name of the root key to nest the JSON
+    #   data under
+    # @option options [Boolean] :collection whether to render the data as a
+    #   collection/array or a single object
     # @return [void]
     def cache_render(serializer, cacheable, options = {})
       plan = CacheCrispies::Plan.new(serializer, cacheable, options)

data/lib/cache_crispies/plan.rb

@@ -11,19 +11,28 @@ module CacheCrispies
     #   CacheCrispies::Base
     # @param cacheable [Object] typically ActiveRecord::Base or an enumerable
     #   containing instances of ActiveRecord::Base, but could be anything
-    # @param options [Hash] any optional values from the serializer instance
+    # @param [Hash] options any optional values from the serializer instance
+    # @option options [Symbol] :key the name of the root key to nest the JSON
+    #   data under
+    # @option options [Boolean] :collection whether to render the data as a
+    #   collection/array or a single object
     def initialize(serializer, cacheable, options = {})
       @serializer = serializer
       @cacheable = cacheable
-      @key = options.delete(:key)
-      @options = options
+
+      opts = options.dup
+      @key = opts.delete(:key)
+      @collection = opts.delete(:collection)
+      @options = opts
     end
 
     # Whether or not the cacheable should be treated like a collection
     #
     # @return [Boolean] true if cacheable is a collection
     def collection?
-      cacheable.respond_to?(:each)
+      return @collection unless @collection.nil?
+
+      @collection = cacheable.respond_to?(:each)
     end
 
     # Returns the cache_key in a format suitable for an ETag header

data/lib/cache_crispies/version.rb

@@ -2,5 +2,5 @@
 
 module CacheCrispies
   # The version of the gem
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/spec/base_spec.rb

@@ -90,7 +90,40 @@ describe CacheCrispies::Base do
   end
 
   describe '.cache_key_base' do
-    # TODO
+    let(:nested_serializer_digest) { 'nutrition-serializer-digest' }
+    let(:serializer_file_path) {
+      File.expand_path('fixtures/test_serializer.rb', __dir__)
+    }
+    let(:serializer_file_digest) {
+      Digest::MD5.file(serializer_file_path).to_s
+    }
+
+    before do
+      allow(NutritionSerializer).to receive(:file_hash).and_return(
+        nested_serializer_digest
+      )
+      allow(Rails).to receive_message_chain(:root, :join).and_return(
+        serializer_file_path
+      )
+    end
+
+    it 'includes the file name' do
+      expect(subject.class.cache_key_base).to include subject.class.to_s
+    end
+
+    it "includes a digest of the serializer class file's contents" do
+      expect(subject.class.cache_key_base).to include serializer_file_digest
+    end
+
+    it "includes a digest of the nested serializer class file's contents" do
+      expect(subject.class.cache_key_base).to include nested_serializer_digest
+    end
+
+    it 'correctly formats the key' do
+      expect(subject.class.cache_key_base).to eq(
+        "#{subject.class}-#{serializer_file_digest}+#{nested_serializer_digest}"
+      )
+    end
   end
 
   describe '.attributes' do
@@ -150,4 +183,4 @@ describe CacheCrispies::Base do
       expect(subject[5].conditions).to eq []
     end
   end
-end
+end

data/spec/hash_builder_spec.rb

@@ -32,7 +32,7 @@ describe CacheCrispies::HashBuilder do
       end
     end
 
-    show_if ->(model, options) { options[:be_trendy] } do
+    show_if ->(_model, options) { options[:be_trendy] } do
       nest_in :health do
         serialize :organic
 
@@ -142,4 +142,4 @@ describe CacheCrispies::HashBuilder do
       end
     end
   end
-end
+end

data/spec/plan_spec.rb

@@ -37,6 +37,14 @@ describe CacheCrispies::Plan do
       it 'returns false' do
         expect(subject.collection?).to be false
       end
+
+      context 'when the :collection option is true' do
+        let(:options) { { collection: true } }
+
+        it 'returns true' do
+          expect(subject.collection?).to be true
+        end
+      end
     end
 
     context 'when a collection' do
@@ -45,6 +53,14 @@ describe CacheCrispies::Plan do
       it 'returns false' do
         expect(subject.collection?).to be true
       end
+
+      context 'when the :collection option is false' do
+        let(:options) { { collection: false } }
+
+        it 'returns false' do
+          expect(subject.collection?).to be false
+        end
+      end
     end
   end
 
@@ -166,4 +182,4 @@ describe CacheCrispies::Plan do
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_crispies
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-12 00:00:00.000000000 Z
+date: 2019-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj