cache_crispies 0.3.1 → 1.0.1

data/spec/{plan_spec.rb → cache_crispies/plan_spec.rb}

@@ -2,11 +2,10 @@ require 'spec_helper'
 
 describe CacheCrispies::Plan do
   class CerealSerializerForPlan < CacheCrispies::Base
-    def self.key
-      :cereal
-    end
+    key :cereal
+    dependency_key :'v1-beta'
 
-    def self.cache_key_addons(options)
+    cache_key_addons do |options|
       ['addon1', options[:extra_addon]]
     end
 
@@ -15,7 +14,7 @@ describe CacheCrispies::Plan do
 
   let(:serializer) { CerealSerializerForPlan }
   let(:serializer_file_path) {
-    File.expand_path('fixtures/test_serializer.rb', __dir__)
+    File.expand_path('../fixtures/test_serializer.rb', __dir__)
   }
   let(:model_cache_key) { 'model-cache-key' }
   let(:model) { OpenStruct.new(name: 'Sugar Smacks', cache_key: model_cache_key) }
@@ -86,6 +85,10 @@ describe CacheCrispies::Plan do
       expect(subject.cache_key).to include serializer.cache_key_base
     end
 
+    it "includes the serializer's #dependency_key" do
+      expect(subject.cache_key).to include 'v1-beta'
+    end
+
     it "includes the addons_key" do
       expect(subject.cache_key).to include(
         Digest::MD5.hexdigest('addon1|addon2')
@@ -104,6 +107,7 @@ describe CacheCrispies::Plan do
       expect(subject.cache_key).to eq(
         'cache-crispies' \
         "+CerealSerializerForPlan-#{Digest::MD5.file(serializer_file_path)}" \
+        '+v1-beta' \
         "+#{Digest::MD5.hexdigest('addon1|addon2')}" \
         '+model-cache-key'
       )
@@ -116,6 +120,7 @@ describe CacheCrispies::Plan do
         expect(subject.cache_key).to eq(
           'cache-crispies' \
           "+CerealSerializerForPlan-#{Digest::MD5.file(serializer_file_path)}" \
+          '+v1-beta' \
           '+model-cache-key'
         )
       end
@@ -125,7 +130,7 @@ describe CacheCrispies::Plan do
   describe '#cache' do
     context 'when the plan is not cacheable' do
       it "doesn't cache the results" do
-        expect(Rails).to_not receive(:cache)
+        expect(CacheCrispies).to_not receive(:cache)
         subject.cache {}
       end
     end
@@ -134,7 +139,7 @@ describe CacheCrispies::Plan do
       it "doesn't cache the results" do
         expect(subject).to receive(:cache?).and_return true
         expect(subject).to receive(:cache_key).and_return 'bar'
-        expect(Rails).to receive_message_chain(:cache, :fetch).with('bar')
+        expect(CacheCrispies).to receive_message_chain(:cache, :fetch).with('bar')
         subject.cache {}
       end
     end

data/spec/cache_crispies_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe CacheCrispies do
+  after { described_class.config.reset! }
+
+  describe '.configure and .config' do
+    it 'allows setting values' do
+      expect {
+        described_class.configure do |conf|
+          conf.etags = true
+        end
+      }.to change { described_class.config.etags }.from(false).to true
+    end
+  end
+
+  describe '.cache' do
+    it 'delegates to config.cache_store' do
+      cache_store = ActiveSupport::Cache::NullStore.new
+
+      expect {
+        described_class.configure do |conf|
+          conf.cache_store = cache_store
+        end
+      }.to change { described_class.cache }.to cache_store
+    end
+  end
+end

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: cache_crispies
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Adam Crownoble
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2019-10-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -34,7 +54,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.1'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -48,16 +68,16 @@ dependencies:
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -126,20 +146,23 @@ files:
 - lib/cache_crispies/base.rb
 - lib/cache_crispies/collection.rb
 - lib/cache_crispies/condition.rb
+- lib/cache_crispies/configuration.rb
 - lib/cache_crispies/controller.rb
 - lib/cache_crispies/hash_builder.rb
 - lib/cache_crispies/memoizer.rb
 - lib/cache_crispies/plan.rb
 - lib/cache_crispies/version.rb
-- spec/attribute_spec.rb
-- spec/base_spec.rb
-- spec/collection_spec.rb
-- spec/condition_spec.rb
-- spec/controller_spec.rb
+- spec/cache_crispies/attribute_spec.rb
+- spec/cache_crispies/base_spec.rb
+- spec/cache_crispies/collection_spec.rb
+- spec/cache_crispies/condition_spec.rb
+- spec/cache_crispies/configuration_spec.rb
+- spec/cache_crispies/controller_spec.rb
+- spec/cache_crispies/hash_builder_spec.rb
+- spec/cache_crispies/memoizer_spec.rb
+- spec/cache_crispies/plan_spec.rb
+- spec/cache_crispies_spec.rb
 - spec/fixtures/test_serializer.rb
-- spec/hash_builder_spec.rb
-- spec/memoizer_spec.rb
-- spec/plan_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/codenoble/cache-crispies
 licenses:
@@ -165,13 +188,15 @@ signing_key:
 specification_version: 4
 summary: Fast Rails serializer with built-in caching
 test_files:
-- spec/attribute_spec.rb
-- spec/base_spec.rb
-- spec/collection_spec.rb
-- spec/condition_spec.rb
-- spec/controller_spec.rb
+- spec/cache_crispies/attribute_spec.rb
+- spec/cache_crispies/base_spec.rb
+- spec/cache_crispies/collection_spec.rb
+- spec/cache_crispies/condition_spec.rb
+- spec/cache_crispies/configuration_spec.rb
+- spec/cache_crispies/controller_spec.rb
+- spec/cache_crispies/hash_builder_spec.rb
+- spec/cache_crispies/memoizer_spec.rb
+- spec/cache_crispies/plan_spec.rb
+- spec/cache_crispies_spec.rb
 - spec/fixtures/test_serializer.rb
-- spec/hash_builder_spec.rb
-- spec/memoizer_spec.rb
-- spec/plan_spec.rb
 - spec/spec_helper.rb

data/spec/base_spec.rb

@@ -1,186 +0,0 @@
-require 'spec_helper'
-require 'ostruct'
-
-describe CacheCrispies::Base do
-  class NutritionSerializer < CacheCrispies::Base
-    serialize :calories
-  end
-
-  class CacheCrispiesTestSerializer < CacheCrispies::Base
-    serialize :id, :company, to: String
-
-    show_if -> { true } do
-      show_if -> { true } do
-        show_if -> { true } do
-          serialize :name, from: :brand
-        end
-      end
-    end
-
-    nest_in :nested do
-      nest_in :nested_again do
-        serialize :deeply_nested
-      end
-    end
-
-    serialize :nutrition_info, with: NutritionSerializer
-
-    serialize :organic, to: :bool
-
-    def id
-      model.id.to_s
-    end
-  end
-
-  let(:model) do
-    OpenStruct.new(
-      id: 42,
-      brand: 'Cookie Crisp',
-      company: 'General Mills',
-      deeply_nested: true,
-      nutrition_info: OpenStruct.new(calories: 1_000),
-      organic: 'true'
-      )
-  end
-
-  let(:instance) { CacheCrispiesTestSerializer.new(model) }
-  subject { instance }
-
-  describe '#as_json' do
-    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: {
-          calories: 1000
-        },
-        organic: true
-      )
-    end
-  end
-
-  describe '.key' do
-    it 'underscores the demodulized class name' do
-      expect(subject.class.key).to eq :cache_crispies_test
-    end
-  end
-
-  describe '.collection_key' do
-    it 'pluralizes the #key' do
-      expect(subject.class.collection_key).to eq :cache_crispies_tests
-    end
-  end
-
-  describe '.do_caching?' do
-    it 'is false by default' do
-      expect(subject.class.do_caching?).to be false
-    end
-  end
-
-  describe '.cache_key_addons' do
-    it 'returns an empty array by default' do
-      expect(subject.class.cache_key_addons).to eq []
-    end
-  end
-
-  describe '.cache_key_base' do
-    let(:nested_serializer_digest) { 'nutrition-serializer-digest' }
-    let(:serializer_file_path) {
-      File.expand_path('fixtures/test_serializer.rb', __dir__)
-    }
-    let(:serializer_file_digest) {
-      Digest::MD5.file(serializer_file_path).to_s
-    }
-
-    before do
-      allow(NutritionSerializer).to receive(:file_hash).and_return(
-        nested_serializer_digest
-      )
-      allow(Rails).to receive_message_chain(:root, :join).and_return(
-        serializer_file_path
-      )
-    end
-
-    it 'includes the file name' do
-      expect(subject.class.cache_key_base).to include subject.class.to_s
-    end
-
-    it "includes a digest of the serializer class file's contents" do
-      expect(subject.class.cache_key_base).to include serializer_file_digest
-    end
-
-    it "includes a digest of the nested serializer class file's contents" do
-      expect(subject.class.cache_key_base).to include nested_serializer_digest
-    end
-
-    it 'correctly formats the key' do
-      expect(subject.class.cache_key_base).to eq(
-        "#{subject.class}-#{serializer_file_digest}+#{nested_serializer_digest}"
-      )
-    end
-  end
-
-  describe '.attributes' do
-    subject { instance.class.attributes }
-
-    it 'contains all the attributes' do
-      expect(subject.length).to eq 6
-    end
-
-    it 'preserves the attribute order' do
-      expect(subject.map(&:key)).to eq(
-        %i[id company name deeply_nested nutrition_info organic]
-      )
-    end
-
-    it 'contains the correct attribute values' do
-      expect(subject[0].method_name).to eq :id
-      expect(subject[0].key).to eq :id
-      expect(subject[0].serializer).to be nil
-      expect(subject[0].coerce_to).to be String
-      expect(subject[0].nesting).to eq []
-      expect(subject[0].conditions).to eq []
-
-      expect(subject[1].method_name).to eq :company
-      expect(subject[1].key).to eq :company
-      expect(subject[1].serializer).to be nil
-      expect(subject[1].coerce_to).to be String
-      expect(subject[1].nesting).to eq []
-      expect(subject[1].conditions).to eq []
-
-      expect(subject[2].method_name).to eq :brand
-      expect(subject[2].key).to eq :name
-      expect(subject[2].serializer).to be nil
-      expect(subject[2].coerce_to).to be nil
-      expect(subject[2].nesting).to eq []
-      expect(subject[2].conditions.length).to be 3
-
-      expect(subject[3].method_name).to eq :deeply_nested
-      expect(subject[3].key).to eq :deeply_nested
-      expect(subject[3].serializer).to be nil
-      expect(subject[3].coerce_to).to be nil
-      expect(subject[3].nesting).to eq %i[nested nested_again]
-      expect(subject[3].conditions).to eq []
-
-      expect(subject[4].method_name).to eq :nutrition_info
-      expect(subject[4].key).to eq :nutrition_info
-      expect(subject[4].serializer).to be NutritionSerializer
-      expect(subject[4].coerce_to).to be nil
-      expect(subject[4].nesting).to eq []
-      expect(subject[4].conditions).to eq []
-
-      expect(subject[5].method_name).to eq :organic
-      expect(subject[5].key).to eq :organic
-      expect(subject[5].serializer).to be nil
-      expect(subject[5].coerce_to).to be :bool
-      expect(subject[5].nesting).to eq []
-      expect(subject[5].conditions).to eq []
-    end
-  end
-end

data/spec/controller_spec.rb

@@ -1,69 +0,0 @@
-require 'spec_helper'
-require 'active_model'
-require 'action_controller'
-
-describe CacheCrispies::Controller do
-  class Cereal
-    include ActiveModel::Model
-    attr_accessor :name
-  end
-
-  class CerealController < ActionController::Base
-    include CacheCrispies::Controller
-  end
-
-  class CerealSerializerForController < CacheCrispies::Base
-    serialize :name
-
-    def self.key
-      'cereal'
-    end
-  end
-
-  let(:cereal_names) { ['Count Chocula', 'Eyeholes'] }
-  let(:collection) { cereal_names.map { |name| Cereal.new(name: name) } }
-
-  subject { CerealController.new }
-
-  before do
-    allow_any_instance_of(
-      CacheCrispies::Plan
-    ).to receive(:etag).and_return 'test-etag'
-    allow(subject).to receive_message_chain(:response, :weak_etag=).with 'test-etag'
-  end
-
-  describe '#cache_render' do
-    it 'renders a json collection' do
-      expect(subject).to receive(:render).with(
-        json: {
-          cereals: cereal_names.map { |name| { name: name } }
-        }.to_json
-      )
-
-      subject.cache_render CerealSerializerForController, collection
-    end
-
-    it 'renders a single json object' do
-      expect(subject).to receive(:render).with(
-        json: { cereal: { name: cereal_names.first } }.to_json
-      )
-
-      subject.cache_render CerealSerializerForController, collection.first
-    end
-
-    context 'with a status: option' do
-      it 'passes the status option to the Rails render call' do
-        expect(subject).to receive(:render).with(
-          json: { cereal: { name: cereal_names.first } }.to_json,
-          status: 418
-        )
-
-        subject.cache_render(
-          CerealSerializerForController,
-          collection.first,
-          status: 418
-        )
-      end
-    end
-  end
-end