cache_crispies 1.0.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7be596f4546279c27b355a83a6c87b5d986cbcc65779def4310df106c3017557
-  data.tar.gz: e7b5ceb4ac6c68d7149bb45246bdba99864c5fbd289277d054b22c5c622f748d
+  metadata.gz: 35d549e631ed6401a8d401b28e77f192ffc0661ed7ad4afd5f6e70b7e85770a0
+  data.tar.gz: 2b118175b85d5d5be47c43c8c9359be7dd496502c056ec5694fb2cbad7778d04
 SHA512:
-  metadata.gz: ac4fe247753da8c9afa3e2d5a27d8f673c780b6bbb0d71a8777e736e9b9761be4791c33e5370a3f6a1ade8df2ff65befd648c9004908f1d4ebaafb3ce3678aa1
-  data.tar.gz: 823e1a06a9a007e74cb148751f765cf506e96849b5947e5132b2fffadfbaaa447a3c379cbd805d72fb03ceffd2bb8daf12a8649e282020d1d91b98656af97e82
+  metadata.gz: a3279adc9b9e20800159b2cdcf0aaa173d58d030d22027dcb62818b3fafa12aa2ed5776f824261daf184d8a83cb011e74f617d71bd2d36d5e16aa46ce7446ed0
+  data.tar.gz: '0030582a6e0bc880adff6e350a0f38412dc04f40e04a902ef0aeb5b93d2f6eb5206e6d0960ed414e978d3c3604a789c0d199a93d95cf3da85f4fcc463ba70029'

data/lib/cache_crispies/attribute.rb

@@ -14,6 +14,7 @@ module CacheCrispies
     # @param from [Symbol] the method on the model to call to get the value
     # @param with [CacheCrispies::Base] a serializer to use to serialize the
     # @param to [Class, Symbol] the data type to coerce the value into
+    # @param collection [Boolean] force rendering as single or collection
     # @param nesting [Array<Symbol>] the JSON keys this attribute will be
     #    nested inside
     # @param conditions [Array<CacheCrispies::Condition>] the show_if condition
@@ -22,7 +23,8 @@ module CacheCrispies
     #   argument's value
     def initialize(
       key,
-      from: nil, with: nil, through: nil, to: nil, nesting: [], conditions: [],
+      from: nil, with: nil, through: nil, to: nil, collection: nil,
+      nesting: [], conditions: [],
       &block
     )
       @key = key
@@ -30,6 +32,7 @@ module CacheCrispies
       @serializer = with
       @through = through
       @coerce_to = to
+      @collection = collection
       @nesting = Array(nesting)
       @conditions = Array(conditions)
       @block = block
@@ -41,6 +44,7 @@ module CacheCrispies
       :serializer,
       :through,
       :coerce_to,
+      :collection,
       :nesting,
       :conditions,
       :block
@@ -66,8 +70,6 @@ module CacheCrispies
       serializer ? serialize(value, options) : coerce(value)
     end
 
-
-
     private
 
     def through?
@@ -81,7 +83,9 @@ module CacheCrispies
     # Here we'll render the attribute with a given serializer and attempt to
     # cache the results for better cache reusability
     def serialize(value, options)
-      plan = CacheCrispies::Plan.new(serializer, value, options)
+      plan = CacheCrispies::Plan.new(
+        serializer, value, collection: collection, **options
+      )
 
       if plan.collection?
         plan.cache { Collection.new(value, serializer, options).as_json }

data/lib/cache_crispies/base.rb

@@ -220,10 +220,11 @@ module CacheCrispies
 
     def self.serialize(
       *attribute_names,
-      from: nil, with: nil, through: nil, to: nil,
+      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
 
@@ -234,6 +235,7 @@ module CacheCrispies
             with: with,
             through: through,
             to: to,
+            collection: collection,
             nesting: current_nesting,
             conditions: current_conditions,
             &block

data/lib/cache_crispies/controller.rb

@@ -16,17 +16,30 @@ 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, options = {})
-      plan = CacheCrispies::Plan.new(serializer, cacheable, options)
+    def cache_render(
+      serializer,
+      cacheable,
+      key: nil, collection: nil, status: nil,
+      meta: {}, meta_key: :meta,
+      **options
+    )
+      plan = CacheCrispies::Plan.new(
+        serializer,
+        cacheable,
+        key: key, collection: collection,
+        **options
+      )
 
       if CacheCrispies.config.etags?
         response.weak_etag = plan.etag
@@ -43,8 +56,11 @@ module CacheCrispies
           plan.cache { serializer.new(cacheable, options).as_json }
         end
 
-      render_hash = { json: Oj.dump(plan.wrap(serializer_json), mode: OJ_MODE) }
-      render_hash[:status] = options[:status] if options.key?(:status)
+      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
     end

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/plan.rb

@@ -16,14 +16,13 @@ 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, options = {})
+    def initialize(serializer, cacheable, key: nil, collection: nil, **options)
       @serializer = serializer
       @cacheable = cacheable
 
-      opts = options.dup
-      @key = opts.delete(:key)
-      @collection = opts.delete(:collection)
-      @options = opts
+      @key = key
+      @collection = collection
+      @options = options
     end
 
     # Whether or not the cacheable should be treated like a collection

data/lib/cache_crispies/version.rb

@@ -2,5 +2,5 @@
 
 module CacheCrispies
   # The version of the gem
-  VERSION = '1.0.1'
+  VERSION = '1.1.3'
 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.1
+  version: 1.1.3
 platform: ruby
 authors:
 - Adam Crownoble
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-12 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -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
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Fast Rails serializer with built-in caching
 test_files: