cache_crispies 1.0.2 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dde77903d49df53ae283abc8d1c0b93e9f8d849b8d1696d39fced6a664b005dd
-  data.tar.gz: e656b7ce6ce5e74076380b67fb5d86b6fe731a4df80edbb953c5e63694ce40de
+  metadata.gz: dd2682e40adfbb9511562cc2b406cd5fa9731134977f1072c5e42684f88590b9
+  data.tar.gz: 12c00d8ddd71b23daf0834db565334e0a1d71a28e37809b82d52717e940f16ec
 SHA512:
-  metadata.gz: fb83071875231fa5ec31244d47e2594de335787515dafe75fd9ce433060e151b38469c7b06e2a5428c6e1746855ced29ca6cf25970bd874c3dae056936347478
-  data.tar.gz: be8908410852bc16ac94efe31b9972d384b82932fb791aad2e9e98df646386131fc260317e3b1d7d3c94e19f20ffc5e3c5951d0a87be67d68da88c7d8eb41cc4
+  metadata.gz: 71ea2e90153a90ca9f1ae3d9d6b5e229a7f547f0fe271a6cbe8ec01bde10ec23e2736ef7a14898c7c9c48d2c17393b5ebe8bd7787b0123fd0bfc1868095007b1
+  data.tar.gz: c029d5cd5a5b35f22494eeeed2f4b9a3bcffd64989c36b6cd8be2c8731eb032e34926f79b3f3e8f69ab9a84c57170bfc22cc4c06f5757774d6b37eb7ffc5f329

data/lib/cache_crispies/base.rb

@@ -223,7 +223,8 @@ module CacheCrispies
       from: nil, with: nil, through: nil, to: nil, collection: nil,
       &block
     )
-      attribute_names.flatten.map { |att| att&.to_sym }.map do |attrib|
+      attribute_names.flat_map do |attrib|
+        attrib = attrib&.to_sym
         current_nesting = Array(@nesting).dup
         current_conditions = Array(@conditions).dup
 

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 if meta.present?
+
+      render_hash = { json: Oj.dump(json_hash, mode: OJ_MODE) }
       render_hash[:status] = status if status
 
       render render_hash

data/lib/cache_crispies/hash_builder.rb

@@ -16,18 +16,20 @@ module CacheCrispies
     #
     # @return [Hash]
     def call
+      return unless @serializer.model
+
       hash = {}
 
       serializer.attributes.each do |attrib|
         deepest_hash = hash
 
+        next unless show?(attrib)
+
         attrib.nesting.each do |key|
           deepest_hash[key] ||= {}
           deepest_hash = deepest_hash[key]
         end
 
-        next unless show?(attrib)
-
         value = value_for(attrib)
 
         if attrib.key

data/lib/cache_crispies/version.rb

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

data/spec/cache_crispies/base_spec.rb

@@ -69,6 +69,26 @@ describe CacheCrispies::Base do
         parent_company: 'Disney probably'
       )
     end
+
+    context 'when nutrition_info is nil' do
+      before { model.nutrition_info = nil }
+
+      it 'serializes to a hash' do
+        expect(subject.as_json).to eq(
+          id: '42',
+          name: 'Cookie Crisp',
+          company: 'General Mills',
+          nested: {
+            nested_again: {
+              deeply_nested: 'TRUE'
+            }
+          },
+          nutrition_info: nil,
+          organic: true,
+          parent_company: 'Disney probably'
+        )
+      end
+    end
   end
 
   describe '.key' do

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

data/spec/cache_crispies/hash_builder_spec.rb

@@ -85,8 +85,7 @@ describe CacheCrispies::HashBuilder do
               { name: 'Other Kind of Sugar' },
             ]
           }
-        },
-        health: {}
+        }
       })
     end
 

data/spec/cache_crispies/plan_spec.rb

@@ -20,7 +20,7 @@ describe CacheCrispies::Plan do
   let(:model) { OpenStruct.new(name: 'Sugar Smacks', cache_key: model_cache_key) }
   let(:cacheable) { model }
   let(:options) { {} }
-  let(:instance) { described_class.new(serializer, cacheable, options) }
+  let(:instance) { described_class.new(serializer, cacheable, **options) }
   subject { instance }
 
   before do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_crispies
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.4
 platform: ruby
 authors:
 - Adam Crownoble
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -19,7 +19,7 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
         version: 5.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -134,7 +134,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.17'
-description: 
+description:
 email: adam@codenoble.com
 executables: []
 extensions: []
@@ -168,7 +168,7 @@ homepage: https://github.com/codenoble/cache-crispies
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,8 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Fast Rails serializer with built-in caching
 test_files: