cache_crispies 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a93c5ab1a386306488b41307cb945164dcf1a0d0646cd5b02f828b87b2836d8
-  data.tar.gz: dadb16037bb994b1a17157cc7568afbd962d446a007838ba003a0fea29e7745f
+  metadata.gz: 0b0cd37045a506df4c5268133eef6566c7ec269fc48eaec6721fcfa74e133416
+  data.tar.gz: b4985e62682465523ac4caec43b7539c676353d1ef5a2003e06b3060093007ce
 SHA512:
-  metadata.gz: '078816fce3ff0dc88fd45dd378dec482843229bdc28b83c188dd0ae04e984b18b14e81ab1d62f5930e26d3724133df3b6aac2033fbd647acad278409ce77c47b'
-  data.tar.gz: 26ec8aa1c7f4a55c1e58b76606ca0cafb1384ce2579b0131d3f9a2fa09391da8c0882524a379420c92c13eda3e0173b2c4fbad3356bdd529eb35c1beb1348e18
+  metadata.gz: cb6b86cda738d0fc7116fa8df04888951d37f89c0017f393df7645e681fb9b15d9acf4bbca80306f56c5f26bf6d08d8915e72cf737bd1bc28423d152d9ce57db
+  data.tar.gz: 83efc432240566b128620748fcda6eb63aaee98fcf4773c072facbda4feb3b93159a19376fb0ef069c86d99afdd10f66ff2c34c27e87e73366f0f60c2b5e6d62

data/lib/cache_crispies/base.rb

@@ -64,6 +64,21 @@ module CacheCrispies
       alias do_caching? do_caching
     end
 
+    # Get or set root path of Rails application or engine.
+    # It uses Rails by default, but can be overriden with your Rails Engine class.
+    # Calling the method with an argument will set the value, calling it without
+    # any arguments will get the value.
+    def self.engine(value = nil)
+      @engine ||= superclass.try(:engine)
+      @engine ||= Rails
+
+      # method called with no args so act as a getter
+      return @engine if value.nil?
+
+      # method called with args so act as a setter
+      @engine = value
+    end
+
     # Get or set a JSON key to use as a root key on a non-collection
     # serializable. By default it's the name of the class without the
     # "Serializer" part. But it can be overridden in a subclass to be anything.
@@ -190,7 +205,7 @@ module CacheCrispies
         parts = %w[app serializers]
         parts += to_s.deconstantize.split('::').map(&:underscore)
         parts << "#{to_s.demodulize.underscore}.rb"
-        Rails.root.join(*parts)
+        engine.root.join(*parts)
       end
     end
     private_class_method :path

data/lib/cache_crispies/controller.rb

@@ -30,7 +30,7 @@ module CacheCrispies
     def cache_render(
       serializer,
       cacheable,
-      key: nil, collection: nil, status: nil,
+      key: UNDEFINED, collection: nil, status: nil,
       meta: {}, meta_key: :meta,
       **options
     )

data/lib/cache_crispies/plan.rb

@@ -16,7 +16,7 @@ module CacheCrispies
     #   data under
     # @option options [Boolean] :collection whether to render the data as a
     #   collection/array or a single object
-    def initialize(serializer, cacheable, key: nil, collection: nil, **options)
+    def initialize(serializer, cacheable, key: UNDEFINED, collection: nil, **options)
       @serializer = serializer
       @cacheable = cacheable
 
@@ -91,7 +91,7 @@ module CacheCrispies
     private
 
     def key
-      return @key unless @key.nil?
+      return @key unless @key == UNDEFINED
 
       (collection? ? serializer.collection_key : serializer.key)
     end

data/lib/cache_crispies/version.rb

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

data/lib/cache_crispies.rb

@@ -12,6 +12,9 @@ module CacheCrispies
   # The string to use to join parts of the cache keys together
   CACHE_KEY_SEPARATOR = '+'
 
+  # Magic value for undefined arguments
+  UNDEFINED = Object.new.freeze
+
   require 'cache_crispies/version'
 
   # Use autoload for better Rails development

data/spec/cache_crispies/base_spec.rb

@@ -39,6 +39,15 @@ describe CacheCrispies::Base do
     end
   end
 
+  class MyEngine
+    def self.root
+    end
+  end
+
+  class CacheCrispiesEngineTestSerializer < CacheCrispiesTestSerializer
+    engine MyEngine
+  end
+
   let(:model) do
     OpenStruct.new(
       id: 42,
@@ -52,6 +61,7 @@ describe CacheCrispies::Base do
   end
 
   let(:serializer) { CacheCrispiesTestSerializer }
+  let(:engine_serializer) { CacheCrispiesEngineTestSerializer }
   let(:instance) { serializer.new(model) }
   subject { instance }
 
@@ -161,6 +171,24 @@ describe CacheCrispies::Base do
     end
   end
 
+  describe '.engine' do
+    it 'defaults to Rails' do
+      expect(serializer.engine).to eq Rails
+    end
+
+    context 'when called with an argument' do
+      after { serializer.remove_instance_variable :@engine }
+
+      it 'sets and returns a value' do
+        expect {
+          serializer.engine MyEngine
+        }.to change {
+          serializer.engine
+        }.from(Rails).to MyEngine
+      end
+    end
+  end
+
   describe '.cache_key_addons' do
     it 'returns an empty array by default' do
       expect(serializer.cache_key_addons).to eq []
@@ -203,6 +231,12 @@ describe CacheCrispies::Base do
     let(:serializer_file_digest) {
       Digest::MD5.file(serializer_file_path).to_s
     }
+    let(:engine_serializer_file_path) {
+      File.expand_path('../fixtures/engine_test_serializer.rb', __dir__)
+    }
+    let(:engine_serializer_file_digest) {
+      Digest::MD5.file(engine_serializer_file_path).to_s
+    }
 
     before do
       allow(NutritionSerializer).to receive(:file_hash).and_return(
@@ -211,6 +245,9 @@ describe CacheCrispies::Base do
       allow(Rails).to receive_message_chain(:root, :join).and_return(
         serializer_file_path
       )
+      allow(MyEngine).to receive_message_chain(:root, :join).and_return(
+        engine_serializer_file_path
+      )
     end
 
     it 'includes the file name' do
@@ -230,6 +267,12 @@ describe CacheCrispies::Base do
         "#{serializer}-#{serializer_file_digest}+#{nested_serializer_digest}"
       )
     end
+
+    context 'when an engine is set' do
+      it "includes a digest of the serializer class file's contents" do
+        expect(engine_serializer.cache_key_base).to include engine_serializer_file_digest
+      end
+    end
   end
 
   describe '.attributes' do

data/spec/cache_crispies/controller_spec.rb

@@ -73,6 +73,36 @@ describe CacheCrispies::Controller do
       subject.cache_render CerealSerializerForController, collection.first
     end
 
+    context 'with a key: option'do
+      context 'overriding the key in the serializer' do
+        it 'renders a json collection' do
+          expect(subject).to receive(:render).with json: { serials: cereal_names.map { |name| { name: name } } }.to_json
+
+          subject.cache_render CerealSerializerForController, collection, key: "serials"
+        end
+
+        it 'renders a single json object' do
+          expect(subject).to receive(:render).with json: { serial: { name: cereal_names.first} }.to_json
+
+          subject.cache_render CerealSerializerForController, collection.first, key: "serial"
+        end
+      end
+
+      context 'set to nil' do
+        it 'renders a json collection' do
+          expect(subject).to receive(:render).with json: cereal_names.map { |name| { name: name } }.to_json
+
+          subject.cache_render CerealSerializerForController, collection, key: nil
+        end
+
+        it 'renders a single json object' do
+          expect(subject).to receive(:render).with json: { name: cereal_names.first }.to_json
+
+          subject.cache_render CerealSerializerForController, collection.first, key: nil
+        end
+      end
+    end
+
     context 'with a status: option' do
       it 'passes the status option to the Rails render call' do
         expect(subject).to receive(:render).with(

data/spec/fixtures/engine_test_serializer.rb

@@ -0,0 +1,3 @@
+# Nothing has to actually be in this file.
+# It's just here so test can MD5 sum it's content.
+# This is an alternative serializer file.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_crispies
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-07 00:00:00.000000000 Z
+date: 2022-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -177,6 +177,7 @@ files:
 - spec/cache_crispies/memoizer_spec.rb
 - spec/cache_crispies/plan_spec.rb
 - spec/cache_crispies_spec.rb
+- spec/fixtures/engine_test_serializer.rb
 - spec/fixtures/test_serializer.rb
 - spec/spec_helper.rb
 homepage: https://github.com/codenoble/cache-crispies
@@ -213,5 +214,6 @@ test_files:
 - spec/cache_crispies/memoizer_spec.rb
 - spec/cache_crispies/plan_spec.rb
 - spec/cache_crispies_spec.rb
+- spec/fixtures/engine_test_serializer.rb
 - spec/fixtures/test_serializer.rb
 - spec/spec_helper.rb