Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow backup opt out #121

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Allow backup opt out #121

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3874614
Add option for excluding the cache directory from backup
aodh-spt Jan 16, 2020
01899eb
Set the 'do not backup' resource value for the directory
aodh-spt Jan 16, 2020
3337742
Bump version strings
aodh-spt Jan 17, 2020
30f0da1
Add new option to description
aodh-spt Jan 17, 2020
ece3d0a
Make comment clearer
aodh-spt Jan 17, 2020
228adb1
Set the resource value each time
aodh-spt Jan 22, 2020
c8988ee
Bump version
aodh-spt Jan 22, 2020
defb567
Update change log
aodh-spt Jan 22, 2020
4346242
Fix error in example
aodh-spt Jan 22, 2020
e87d87a
Update version
aodh-spt Jan 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion Sources/SPTPersistentCacheFileManager.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,16 @@ - (BOOL)createCacheDirectory
return NO;
}
}


NSError *error = nil;
[[NSURL fileURLWithPath:self.options.cachePath] setResourceValue:@(self.options.shouldExcludeFromBackup) forKey:NSURLIsExcludedFromBackupKey error:&error];

if (error) {
SPTPersistentCacheSafeDebugCallback([NSString stringWithFormat:
@"PersistentDataCache: Resource value: %@ could not be set for key 'NSURLIsExcludedFromBackupKey' because: %@",
@(self.options.shouldExcludeFromBackup), error], self.debugOutput);
}

return YES;
}

Expand Down
3 changes: 3 additions & 0 deletions Sources/SPTPersistentCacheOptions.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ - (instancetype)init
_cachePath = [NSTemporaryDirectory() stringByAppendingPathComponent:@"/com.spotify.temppersistent.image.cache"];
_cacheIdentifier = @"persistent.cache";
_useDirectorySeparation = YES;
_shouldExcludeFromBackup = NO;
Copy link

@SPTElyasn SPTElyasn Jan 17, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aodhol You probably need to provide the deep copy of this. You have it down there in copyWithZone

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not super important but would be nice to include it in debugDescription.


_garbageCollectionInterval = SPTPersistentCacheDefaultGCIntervalSec;
_defaultExpirationPeriod = SPTPersistentCacheDefaultExpirationTimeSec;
Expand Down Expand Up @@ -113,6 +114,7 @@ - (id)copyWithZone:(NSZone *)zone
copy.cacheIdentifier = self.cacheIdentifier;
copy.cachePath = self.cachePath;
copy.useDirectorySeparation = self.useDirectorySeparation;
copy.shouldExcludeFromBackup = self.shouldExcludeFromBackup;

copy.garbageCollectionInterval = self.garbageCollectionInterval;
copy.defaultExpirationPeriod = self.defaultExpirationPeriod;
Expand Down Expand Up @@ -146,6 +148,7 @@ - (NSString *)debugDescription
return SPTPersistentCacheObjectDescription(self,
self.cacheIdentifier, @"cache-identifier",
self.cachePath, @"cache-path",
self.shouldExcludeFromBackup, @"exclude-from-backup",
self.identifierForQueue, @"identifier-for-queue",
@(self.useDirectorySeparation), @"use-directory-separation",
@(self.garbageCollectionInterval), @"garbage-collection-interval",
Expand Down
4 changes: 2 additions & 2 deletions Tests/Info.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
<key>CFBundlePackageType</key>
<string>BNDL</string>
<key>CFBundleShortVersionString</key>
<string>1.1.1</string>
<string>1.1.2</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.1.1</string>
<string>1.1.2</string>
</dict>
</plist>
6 changes: 6 additions & 0 deletions include/SPTPersistentCache/SPTPersistentCacheOptions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,12 @@ FOUNDATION_EXPORT const NSUInteger SPTPersistentCacheMinimumExpirationLimit;
*/
@property (nonatomic, copy) NSString *cachePath;

/**
Excludes the cache directory from backup.
@discussion Some users may wish to have the cache directory excluded from backup.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aodhol In order to avoid any confusion, would be nice to mention the default value here maybe.

*/
@property (nonatomic, assign) BOOL shouldExcludeFromBackup;

/**
Whether directory separation of cache records should be used.
@discussion When enabled cached records are separate into direcectories based on the first two (2) characters in
Expand Down