cache_crispies 1.2.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 144a9a90f1bceced6d4197add1047b29352f7cba8b89c19dd92e57411672d7c4
-  data.tar.gz: d6ad1a658628441972010ff169f56fe779b0edc2a8990522b4f49ff765b6f4ee
+  metadata.gz: 1a93c5ab1a386306488b41307cb945164dcf1a0d0646cd5b02f828b87b2836d8
+  data.tar.gz: dadb16037bb994b1a17157cc7568afbd962d446a007838ba003a0fea29e7745f
 SHA512:
-  metadata.gz: f35f5dd51753129083e2ea3c6664709d1977e0255bd60d0a316d275ca6197de1b43cad1fd79bff13ffa9b7183a445f5de4955c45d66ff93a5bd8e30f26f8d37c
-  data.tar.gz: f29c05d0fd636e7648b6d4f14bbdd597fc91519669eb841797a1934e667653fa8706b276e3b592ea66217d7bf0c93d8294a259003d060de1d4b15f15f090878a
+  metadata.gz: '078816fce3ff0dc88fd45dd378dec482843229bdc28b83c188dd0ae04e984b18b14e81ab1d62f5930e26d3724133df3b6aac2033fbd647acad278409ce77c47b'
+  data.tar.gz: 26ec8aa1c7f4a55c1e58b76606ca0cafb1384ce2579b0131d3f9a2fa09391da8c0882524a379420c92c13eda3e0173b2c4fbad3356bdd529eb35c1beb1348e18

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

data/lib/cache_crispies/collection.rb

@@ -41,7 +41,7 @@ module CacheCrispies
 
     def cached_json
       models_by_cache_key = collection.each_with_object({}) do |model, hash|
-        plan = Plan.new(serializer, model, options)
+        plan = Plan.new(serializer, model, **options)
 
         hash[plan.cache_key] = model
       end

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

@@ -51,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/version.rb

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

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/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

data/spec/cache_crispies/collection_spec.rb

@@ -58,11 +58,11 @@ describe CacheCrispies::Collection do
 
         it 'fetches the cache for each object in the collection' do
           expect(CacheCrispies::Plan).to receive(:new).with(
-            serializer, model1, options
+            serializer, model1
           ).and_return double('plan-dbl-1', cache_key: 'cereal-key-1')
 
           expect(CacheCrispies::Plan).to receive(:new).with(
-            serializer, model2, options
+            serializer, model2
           ).and_return double('plan-dbl-2', cache_key: 'cereal-key-2')
 
           expect(CacheCrispies).to receive_message_chain(

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/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: '*' } }
@@ -141,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cache_crispies
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-12 00:00:00.000000000 Z
+date: 2022-06-07 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.2'
+        version: '8.0'
   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.2'
+        version: '8.0'
 - !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.2'
+        version: '8.0'
   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.2'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -164,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
@@ -197,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Fast Rails serializer with built-in caching