cache_crispies 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dde77903d49df53ae283abc8d1c0b93e9f8d849b8d1696d39fced6a664b005dd
-  data.tar.gz: e656b7ce6ce5e74076380b67fb5d86b6fe731a4df80edbb953c5e63694ce40de
+  metadata.gz: a30ba1db2e070cd13dac9ad8dcfd6fdfad46d0b70e6337732a505b89f6eb1154
+  data.tar.gz: 4b788edd3dcdbd55e0d65db463504b2483e6b48374f108e550a994dbd037a270
 SHA512:
-  metadata.gz: fb83071875231fa5ec31244d47e2594de335787515dafe75fd9ce433060e151b38469c7b06e2a5428c6e1746855ced29ca6cf25970bd874c3dae056936347478
-  data.tar.gz: be8908410852bc16ac94efe31b9972d384b82932fb791aad2e9e98df646386131fc260317e3b1d7d3c94e19f20ffc5e3c5951d0a87be67d68da88c7d8eb41cc4
+  metadata.gz: 43fb507ca5d1c7478d1fd19e60f55d8b18bcd3cc8a248561013e8607d5d035637bc477f4e4122b44920dde48f5b642bfaf95f5028504715c3a0a2a6ea26d76c8
+  data.tar.gz: bc578d6a8405ee5613a2644cd0ebf091e13f339108fc248edeb65c747ab2af290de914f05118356c14a52caad26594f9b90ca7a6081efa3696f72e8d89f741a0

data/lib/cache_crispies/controller.rb

@@ -16,16 +16,24 @@ module CacheCrispies
     #   CacheCrispies::Base
     # @param cacheable [Object] can be any object. But is typically a Rails
     #   model inheriting from ActiveRecord::Base
-    # @param [Hash] options any optional values from the serializer instance
-    # @option options [Symbol] :key the name of the root key to nest the JSON
+    # @param key [Symbol] the name of the root key to nest the JSON
     #   data under
-    # @option options [Boolean] :collection whether to render the data as a
+    # @param collection [Boolean] whether to render the data as a
     #   collection/array or a single object
-    # @option options [Integer, Symbol] :status the HTTP response status code
-    #    or Rails-supported symbol. See
+    # @param status [Integer, Symbol] the HTTP response status code or
+    #    Rails-supported symbol. See
     #    https://guides.rubyonrails.org/layouts_and_rendering.html#the-status-option
+    # @param meta [Hash] data to include as metadata under a root key
+    # @param meta_key [Symbol] they key to store the metadata under
+    # @param [Hash] options any optional values from the serializer instance
     # @return [void]
-    def cache_render(serializer, cacheable, key: nil, collection: nil, status: nil, **options)
+    def cache_render(
+      serializer,
+      cacheable,
+      key: nil, collection: nil, status: nil,
+      meta: {}, meta_key: :meta,
+      **options
+    )
       plan = CacheCrispies::Plan.new(
         serializer,
         cacheable,
@@ -48,7 +56,10 @@ module CacheCrispies
           plan.cache { serializer.new(cacheable, options).as_json }
         end
 
-      render_hash = { json: Oj.dump(plan.wrap(serializer_json), mode: OJ_MODE) }
+      json_hash = plan.wrap(serializer_json)
+      json_hash[meta_key] = meta unless meta.empty?
+
+      render_hash = { json: Oj.dump(json_hash, mode: OJ_MODE) }
       render_hash[:status] = status if status
 
       render render_hash

data/lib/cache_crispies/version.rb

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

data/spec/cache_crispies/controller_spec.rb

@@ -24,7 +24,8 @@ describe CacheCrispies::Controller do
 
   describe '#cache_render' do
     let(:etags) { false }
-    let(:single_json) { { cereal: { name: cereal_names.first } }.to_json }
+    let(:single_hash) { { cereal: { name: cereal_names.first } } }
+    let(:single_json) { single_hash.to_json }
     let(:collection_json) {
       { cereals: cereal_names.map { |name| { name: name } } }.to_json
     }
@@ -86,5 +87,34 @@ describe CacheCrispies::Controller do
         )
       end
     end
+
+    context 'with a meta: option' do
+      it 'adds a meta data hash to the JSON' do
+        expect(subject).to receive(:render).with(
+          json: single_hash.merge(meta: { page: 42 }).to_json
+        )
+
+        subject.cache_render(
+          CerealSerializerForController,
+          collection.first,
+          meta: { page: 42 }
+        )
+      end
+    end
+
+    context 'with a meta_key: option' do
+      it 'adds a meta data hash to the JSON with the provided key' do
+        expect(subject).to receive(:render).with(
+          json: single_hash.merge(test_meta_data: { page: 42 }).to_json
+        )
+
+        subject.cache_render(
+          CerealSerializerForController,
+          collection.first,
+          meta: { page: 42 },
+          meta_key: :test_meta_data
+        )
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cache_crispies
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam Crownoble