-
Notifications
You must be signed in to change notification settings - Fork 256
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a CacheKey module that is mixed into Blacklight::Document
- Loading branch information
Showing
3 changed files
with
73 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# -*- encoding : utf-8 -*- | ||
# This module provides the cache key which can be used by rails | ||
# caching to determine when to expire a particular object's cache | ||
# See http://apidock.com/rails/ActiveRecord/Integration/cache_key | ||
# This key should be used in conjunction with additional data to | ||
# determine when a document can be cached (e.g. for different view | ||
# types in search results like gallery and list) | ||
module Blacklight::Document::CacheKey | ||
def cache_key | ||
case | ||
when new_record? | ||
"#{self.class.model_name.cache_key}/new" | ||
when cache_version_value = self[cache_version_key] | ||
"#{self.class.model_name.cache_key}/#{id}-#{Array(cache_version_value).join}" | ||
else | ||
"#{self.class.model_name.cache_key}/#{id}" | ||
end | ||
end | ||
|
||
def cache_version_key | ||
:_version_ | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
require 'spec_helper' | ||
|
||
describe Blacklight::Document::CacheKey do | ||
let(:attributes) { {} } | ||
let(:subject) { SolrDocument.new(attributes) } | ||
it 'SolrDocument includes the module' do | ||
expect(subject.class).to include(Blacklight::Document::CacheKey) | ||
end | ||
|
||
describe 'new record' do | ||
before do | ||
allow(subject).to receive_messages(new_record?: true) | ||
end | ||
it 'provides an acceptable cache key' do | ||
expect(subject.cache_key).to eq 'solr_documents/new' | ||
end | ||
end | ||
|
||
describe 'with version' do | ||
let(:attributes) { { id: '12345', _version_: '1497353774427013120' } } | ||
it 'provides a cache key with the id and version' do | ||
expect(subject.cache_key).to eq 'solr_documents/12345-1497353774427013120' | ||
end | ||
describe 'as array' do | ||
let(:attributes) { { id: '12345', _version_: ['1234', '4321'] } } | ||
it 'provides a cache key with the id and joined version array' do | ||
expect(subject.cache_key).to eq 'solr_documents/12345-12344321' | ||
end | ||
end | ||
end | ||
|
||
describe 'without version' do | ||
let(:attributes) { { id: '12345' } } | ||
it 'provides a cache key with just the id' do | ||
expect(subject.cache_key).to eq 'solr_documents/12345' | ||
end | ||
end | ||
|
||
describe '#cache_version_key' do | ||
let(:attributes) { { id: '12345', another_version_field: '1497353774427013120' } } | ||
before do | ||
allow(subject).to receive_messages(cache_version_key: :another_version_field) | ||
end | ||
it 'provides a cache key with the defined field' do | ||
expect(subject.cache_key).to eq 'solr_documents/12345-1497353774427013120' | ||
end | ||
end | ||
end |