cache_crispies 1.1.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50a80f969f0b9fc34f7c562df3ac6dc880503f1bc5aefd41ff1204b8b316bfb7
-  data.tar.gz: 56474213e7cc52191ebc4a4083a7c82e998639c2ad90eb3bbe2bc0ab9a1701ed
+  metadata.gz: 61b89840db0deaa5b7ab40ee7df2a84709a851104aa7b82bb4f95b58faaaa3d3
+  data.tar.gz: 7b6ca695376f955ff0170795abb91b733c6521fb6827975f66f9086f2f7d6a11
 SHA512:
-  metadata.gz: 3087ba57bb1db1bf7b27ae13d2e0ba9f11a31359218548b56c8e26555b6368b9f1c37bdd98529d56a9bc3d8b438fcaf97dea68734ebff9c6b25aac629346c463
-  data.tar.gz: 223e0010500a5dc2bc9edef1db6f99804c3fce19ca08e28d516f789ee3980ff7a59ee8b4e85ebda00eb336c61b3c9b76ebcacdbd7f60dc14eb679226f4ff23d2
+  metadata.gz: 82c7a2f92695a8d304eecb276d6ed29d436dea85e46eaa6b1dc18f1139df7bc8594498f7352d5e14856c2bbb00007a2e5ccffff2bc4cbe21d815f4efb7964c27
+  data.tar.gz: 4781943a5e5845cd72f0c99237b855fe65cc87b57bbb0554d76951a8296449db922e67d09da8a26a68443e5fd55614cbf0b4a655b90f1eaa6961bdf8affcdb6b

data/lib/cache_crispies.rb

@@ -19,6 +19,7 @@ module CacheCrispies
   autoload :Base,           'cache_crispies/base'
   autoload :Collection,     'cache_crispies/collection'
   autoload :Condition,      'cache_crispies/condition'
+  autoload :Optional,       'cache_crispies/optional'
   autoload :Configuration,  'cache_crispies/configuration'
   autoload :HashBuilder,    'cache_crispies/hash_builder'
   autoload :Memoizer,       'cache_crispies/memoizer'

data/lib/cache_crispies/attribute.rb

@@ -15,6 +15,8 @@ module CacheCrispies
     # @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 optional [Boolean] render only if included in the option's
+    #   `included` array
     # @param nesting [Array<Symbol>] the JSON keys this attribute will be
     #    nested inside
     # @param conditions [Array<CacheCrispies::Condition>] the show_if condition
@@ -24,6 +26,7 @@ module CacheCrispies
     def initialize(
       key,
       from: nil, with: nil, through: nil, to: nil, collection: nil,
+      optional: nil,
       nesting: [], conditions: [],
       &block
     )
@@ -36,6 +39,8 @@ module CacheCrispies
       @nesting = Array(nesting)
       @conditions = Array(conditions)
       @block = block
+
+      @conditions << Optional.new(key) if optional
     end
 
     attr_reader(

data/lib/cache_crispies/base.rb

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

data/lib/cache_crispies/condition.rb

@@ -19,24 +19,29 @@ module CacheCrispies
       block.object_id
     end
 
-    # Test the truthiness of the condition against a model and options
+    # Test the truthiness of the condition against the serializer instance
     #
-    # @param model [Object] typically ActiveRecord::Base, but could be anything
-    # @param options [Hash] any optional values from the serializer instance
+    # @param serializer [Object] CacheCrispies::Base serializer instance
     # @return [Boolean] the condition's truthiness
-    def true_for?(model, options = {})
-      !!case block.arity
-        when 0
-          block.call
-        when 1
-          block.call(model)
-        else
-          block.call(model, options)
-        end
+    def true_for?(serializer)
+      return !!serializer.public_send(block) if block.is_a?(Symbol)
+
+      !!execute_block(serializer.model, serializer.options)
     end
 
     private
 
     attr_reader :block
+
+    def execute_block(model, options)
+      case block.arity
+      when 0
+        block.call
+      when 1
+        block.call(model)
+      else
+        block.call(model, options)
+      end
+    end
   end
 end

data/lib/cache_crispies/configuration.rb

@@ -6,7 +6,8 @@ module CacheCrispies
   class Configuration
     SETTINGS = [
       :cache_store,
-      :etags
+      :etags,
+      :cache_key_method
     ].freeze
 
     SETTINGS.each do |setting|
@@ -18,11 +19,13 @@ module CacheCrispies
     end
 
     alias etags? etags
+    alias cache_key_method? cache_key_method
 
     # Resets all values to their defaults. Useful for testing.
     def reset!
       @cache_store = Rails.cache || ActiveSupport::Cache::NullStore.new
       @etags = false
+      @cache_key_method = :cache_key
     end
   end
 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
@@ -49,7 +51,7 @@ module CacheCrispies
       # show_if block
       attribute.conditions.all? do |cond|
         condition_results.fetch(cond.uid) do
-          cond.true_for?(serializer.model, serializer.options)
+          cond.true_for?(serializer)
         end
       end
     end

data/lib/cache_crispies/optional.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module CacheCrispies
+  # Represents an optional condition
+  class Optional
+    # Returns a new instance of Optional
+    #
+    # @param block [Proc] the key of the attribute to include
+    def initialize(key)
+      @key = key
+    end
+
+    # A system-wide unique ID used for memoizaiton
+    #
+    # @eturn [Integer] the unique ID for this condition
+    def uid
+      # Just reusing the key seems to make sense
+      key
+    end
+
+    # Test the truthiness of the optional condition against a model and options
+    #
+    # @param model [Object] typically ActiveRecord::Base, but could be anything
+    # @param options [Hash] any optional values from the serializer instance
+    # @return [Boolean] the condition's truthiness
+    def true_for?(serializer)
+      included = Array(serializer.options.fetch(:include, [])).map(&:to_sym)
+
+      included.include?(key) || included.include?(:*)
+    end
+
+    private
+
+    attr_reader :key
+  end
+end

data/lib/cache_crispies/plan.rb

@@ -58,7 +58,7 @@ module CacheCrispies
           serializer.cache_key_base,
           serializer.dependency_key,
           addons_key,
-          cacheable.cache_key
+          cacheable_cache_key
         ].flatten.compact.join(CACHE_KEY_SEPARATOR)
     end
 
@@ -101,7 +101,11 @@ module CacheCrispies
     end
 
     def cache?
-      serializer.do_caching? && cacheable.respond_to?(:cache_key)
+      serializer.do_caching? && cacheable.respond_to?(CacheCrispies.config.cache_key_method)
+    end
+
+    def cacheable_cache_key
+      cacheable.public_send(CacheCrispies.config.cache_key_method)
     end
 
     def addons_key

data/lib/cache_crispies/version.rb

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

data/spec/cache_crispies/base_spec.rb

@@ -11,7 +11,7 @@ describe CacheCrispies::Base do
 
     show_if -> { true } do
       show_if -> { true } do
-        show_if -> { true } do
+        show_if :visible? do
           serialize :name, from: :brand
         end
       end
@@ -33,6 +33,10 @@ describe CacheCrispies::Base do
     def id
       model.id.to_s
     end
+
+    def visible?
+      true
+    end
   end
 
   let(:model) do
@@ -69,6 +73,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/condition_spec.rb

@@ -1,7 +1,18 @@
 require 'spec_helper'
 
 describe CacheCrispies::Condition do
+  class TestSerializer < CacheCrispies::Base
+    show_if :boolean_method? do
+      serialize :name
+    end
+
+    def boolean_method?
+    end
+  end
+
   let(:block) { -> {} }
+  let(:model) { OpenStruct.new(name: 'Name') }
+  let(:serializer) { TestSerializer.new(model) }
   subject { described_class.new(block) }
 
   describe '#uid' do
@@ -17,7 +28,7 @@ describe CacheCrispies::Condition do
 
     it 'calls the block with model and options arguments' do
       expect(block).to receive(:call).with(model, options)
-      subject.true_for? model, options
+      subject.true_for? serializer
     end
 
     context 'when the block has one argument' do
@@ -25,7 +36,7 @@ describe CacheCrispies::Condition do
 
       it 'calls the block with the model only' do
         expect(block).to receive(:call).with(model)
-        subject.true_for? model, options
+        subject.true_for? serializer
       end
     end
 
@@ -34,12 +45,21 @@ describe CacheCrispies::Condition do
 
       it 'calls the block with no arguments' do
         expect(block).to receive(:call).with(no_args)
-        subject.true_for? model, options
+        subject.true_for? serializer
+      end
+    end
+
+    context 'when the block is a symbol' do
+      let(:block) { :boolean_method? }
+
+      it 'calls the method on serializer instance' do
+        expect(serializer).to receive(block).with(no_args)
+        subject.true_for? serializer
       end
     end
 
     it 'returns a boolean' do
-      expect(subject.true_for?(model, options)).to be true
+      expect(subject.true_for?(serializer)).to be true
     end
   end
 end

data/spec/cache_crispies/configuration_spec.rb

@@ -39,4 +39,16 @@ describe CacheCrispies::Configuration do
       }.to change { subject.etags }.to true
     end
   end
+
+  describe '#cache_key_method' do
+    it 'is cache_key by default' do
+      expect(subject.cache_key_method).to eq :cache_key
+    end
+
+    it 'can be changed' do
+      expect {
+        subject.cache_key_method = :other_cache_key
+      }.to change { subject.cache_key_method }.to eq :other_cache_key
+    end
+  end
 end

data/spec/cache_crispies/hash_builder_spec.rb

@@ -8,6 +8,10 @@ describe CacheCrispies::HashBuilder do
     serialize :name
   end
 
+  class AllergySerializer < CacheCrispies::Base
+    serialize :name
+  end
+
   class MarketingBsSerializer < CacheCrispies::Base
     serialize :tagline, :small_print
 
@@ -29,6 +33,8 @@ describe CacheCrispies::HashBuilder do
       nest_in :nutritional_information do
         serialize :calories
         serialize :ingredients, with: IngredientSerializer
+
+        serialize :allergies, with: AllergySerializer, optional: true
       end
     end
 
@@ -54,6 +60,12 @@ describe CacheCrispies::HashBuilder do
       OpenStruct.new(name: 'Other Kind of Sugar')
     ]
   }
+  let(:allergies) {
+    [
+      OpenStruct.new(name: 'Peanuts'),
+      OpenStruct.new(name: 'Lactose')
+    ]
+  }
   let(:model) {
     OpenStruct.new(
       id: 42,
@@ -62,7 +74,8 @@ describe CacheCrispies::HashBuilder do
       calories: 1_000,
       organic: organic,
       tagline: "Part of a balanced breakfast",
-      ingredients: ingredients
+      ingredients: ingredients,
+      allergies: allergies
     )
   }
   let(:options) { { footnote_marker: '*' } }
@@ -85,8 +98,7 @@ describe CacheCrispies::HashBuilder do
               { name: 'Other Kind of Sugar' },
             ]
           }
-        },
-        health: {}
+        }
       })
     end
 
@@ -142,5 +154,59 @@ describe CacheCrispies::HashBuilder do
         end
       end
     end
+
+    context 'when allergies are included' do
+      let(:options) { { footnote_marker: '*', include: :allergies } }
+
+      it 'includes the allergies' do
+        expect(subject.call).to eq ({
+          uid: '42',
+          name: 'Lucky Charms',
+          company: 'General Mills',
+          tagline: 'Part of a balanced breakfast*',
+          small_print: "*this doesn't mean jack-squat",
+          about: {
+            nutritional_information: {
+              calories: 1000,
+              ingredients: [
+                { name: 'Sugar' },
+                { name: 'Other Kind of Sugar' },
+              ],
+              allergies: [
+                { name: 'Peanuts' },
+                { name: 'Lactose' },
+              ]
+            }
+          }
+        })
+      end
+    end
+
+    context 'when everything is included' do
+      let(:options) { { footnote_marker: '*', include: '*' } }
+
+      it 'includes the allergies' do
+        expect(subject.call).to eq ({
+          uid: '42',
+          name: 'Lucky Charms',
+          company: 'General Mills',
+          tagline: 'Part of a balanced breakfast*',
+          small_print: "*this doesn't mean jack-squat",
+          about: {
+            nutritional_information: {
+              calories: 1000,
+              ingredients: [
+                { name: 'Sugar' },
+                { name: 'Other Kind of Sugar' },
+              ],
+              allergies: [
+                { name: 'Peanuts' },
+                { name: 'Lactose' },
+              ]
+            }
+          }
+        })
+      end
+    end
   end
 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
@@ -125,6 +125,17 @@ describe CacheCrispies::Plan do
         )
       end
     end
+
+    context 'with a configured cache_key_method' do
+      let(:custom_cache_key) { 'custom-cache-key' }
+      let(:model) { OpenStruct.new(name: 'Sugar Smacks', custom_cache_key: custom_cache_key) }
+
+      it "includes the cacheable #custom_cache_key" do
+        expect(CacheCrispies.config).to receive(:cache_key_method).and_return :custom_cache_key
+
+        expect(subject.cache_key).to include custom_cache_key
+      end
+    end
   end
 
   describe '#cache' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_crispies
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Adam Crownoble
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2021-06-13 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
@@ -121,20 +121,34 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.8.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
         version: '0.17'
-description: 
+description:
 email: adam@codenoble.com
 executables: []
 extensions: []
@@ -150,6 +164,7 @@ files:
 - lib/cache_crispies/controller.rb
 - lib/cache_crispies/hash_builder.rb
 - lib/cache_crispies/memoizer.rb
+- lib/cache_crispies/optional.rb
 - lib/cache_crispies/plan.rb
 - lib/cache_crispies/version.rb
 - spec/cache_crispies/attribute_spec.rb
@@ -168,7 +183,7 @@ homepage: https://github.com/codenoble/cache-crispies
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -183,8 +198,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.2.15
+signing_key:
 specification_version: 4
 summary: Fast Rails serializer with built-in caching
 test_files: