Skip to content

Remove deprecated interfaces #103

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

Open
JensAyton wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove deprecated interfaces #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 0 additions & 46 deletions Sources/SPTPersistentCacheOptions.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,52 +156,6 @@ - (NSString *)debugDescription
@end


@implementation SPTPersistentCacheOptions (Deprectated)

- (instancetype)initWithCachePath:(NSString *)cachePath
identifier:(NSString *)cacheIdentifier
defaultExpirationInterval:(NSUInteger)defaultExpirationInterval
garbageCollectorInterval:(NSUInteger)garbageCollectorInterval
debug:(nullable SPTPersistentCacheDebugCallback)debugCallback
{
self = [self init];

if (self) {
_cachePath = [cachePath copy];
_cacheIdentifier = [cacheIdentifier copy];

_defaultExpirationPeriod = SPTGuardedPropertyValue(defaultExpirationInterval, SPTPersistentCacheMinimumExpirationLimit, @selector(defaultExpirationPeriod), debugCallback);
_garbageCollectionInterval = SPTGuardedPropertyValue(garbageCollectorInterval, SPTPersistentCacheMinimumGCIntervalLimit, @selector(garbageCollectionInterval), debugCallback);

_debugOutput = [debugCallback copy];
}

return self;
}

- (BOOL)folderSeparationEnabled
{
return self.useDirectorySeparation;
}

- (void)setFolderSeparationEnabled:(BOOL)folderSeparationEnabled
{
self.useDirectorySeparation = folderSeparationEnabled;
}

- (NSUInteger)gcIntervalSec
{
return self.garbageCollectionInterval;
}

- (NSUInteger)defaultExpirationPeriodSec
{
return self.defaultExpirationPeriod;
}

@end


static NSUInteger SPTGuardedPropertyValue(NSUInteger proposedValue, NSUInteger minimumValue, SEL propertySelector, SPTPersistentCacheDebugCallback debugCallback)
{
if (proposedValue >= minimumValue) {
Expand Down
74 changes: 0 additions & 74 deletions Tests/SPTPersistentCacheOptionsTests.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,21 +48,6 @@ - (void)testDefaultInitializer
XCTAssertNotNil(self.dataCacheOptions.identifierForQueue, @"The identifier for queue shouldn't be nil");
}

- (void)testMinimumGarbageCollectorIntervalForDeprecatedInit
{
_Pragma("clang diagnostic push");
_Pragma("clang diagnostic ignored \"-Wdeprecated\"");
SPTPersistentCacheOptions *dataCacheOptions = [[SPTPersistentCacheOptions alloc] initWithCachePath:[NSTemporaryDirectory() stringByAppendingPathComponent:SPTPersistentCacheOptionsPathComponent]
identifier:@"test"
defaultExpirationInterval:1
garbageCollectorInterval:1
debug:nil];
_Pragma("clang diagnostic pop");

XCTAssertEqual(dataCacheOptions.garbageCollectionInterval,
SPTPersistentCacheMinimumGCIntervalLimit);
}

- (void)testMinimumGarbageCollectorInterval
{
__weak XCTestExpectation *expectation = [self expectationWithDescription:@"debugOuput is executed"];
Expand All @@ -82,21 +67,6 @@ - (void)testMinimumGarbageCollectorInterval
SPTPersistentCacheMinimumGCIntervalLimit);
}

- (void)testMinimumDefaultExpirationIntervalForDeprecatedInit
{
_Pragma("clang diagnostic push");
_Pragma("clang diagnostic ignored \"-Wdeprecated\"");
SPTPersistentCacheOptions *dataCacheOptions = [[SPTPersistentCacheOptions alloc] initWithCachePath:[NSTemporaryDirectory() stringByAppendingPathComponent:SPTPersistentCacheOptionsPathComponent]
identifier:@"test"
defaultExpirationInterval:1
garbageCollectorInterval:1
debug:nil];
_Pragma("clang diagnostic pop");

XCTAssertEqual(dataCacheOptions.defaultExpirationPeriod,
SPTPersistentCacheMinimumExpirationLimit);
}

- (void)testMinimumDefaultExpiration
{
__weak XCTestExpectation *expectation = [self expectationWithDescription:@"debugOuput is executed"];
Expand Down Expand Up @@ -150,50 +120,6 @@ - (void)testCopying
XCTAssertEqual(original.sizeConstraintBytes, copy.sizeConstraintBytes, @"The values of the property \"sizeConstraintBytes\" should be equal");
}

#pragma mark Compatibility Properties for Deprecated Properties

- (void)testFolderSeparationEnabled
{
_Pragma("clang diagnostic push");
_Pragma("clang diagnostic ignored \"-Wdeprecated\"");

SPTPersistentCacheOptions * const options = [SPTPersistentCacheOptions new];

XCTAssertEqual(options.folderSeparationEnabled, options.useDirectorySeparation);

options.folderSeparationEnabled = NO;
XCTAssertFalse(options.useDirectorySeparation, @"Setting the compatibility property should update the real property");
XCTAssertEqual(options.folderSeparationEnabled, options.useDirectorySeparation);

_Pragma("clang diagnostic pop");
}

- (void)testGcIntervalSec
{
_Pragma("clang diagnostic push");
_Pragma("clang diagnostic ignored \"-Wdeprecated\"");

SPTPersistentCacheOptions * const options = [SPTPersistentCacheOptions new];
options.garbageCollectionInterval = SPTPersistentCacheDefaultGCIntervalSec + 37;

XCTAssertEqual(options.gcIntervalSec, options.garbageCollectionInterval);

_Pragma("clang diagnostic pop");
}

- (void)testDefaultExpirationPeriodSec
{
_Pragma("clang diagnostic push");
_Pragma("clang diagnostic ignored \"-Wdeprecated\"");

SPTPersistentCacheOptions * const options = [SPTPersistentCacheOptions new];
options.defaultExpirationPeriod = SPTPersistentCacheDefaultExpirationTimeSec + 37;

XCTAssertEqual(options.defaultExpirationPeriodSec, options.defaultExpirationPeriod);

_Pragma("clang diagnostic pop");
}

#pragma mark Describing objects

- (void)testDescriptionAdheresToStyle
Expand Down
44 changes: 0 additions & 44 deletions include/SPTPersistentCache/SPTPersistentCacheOptions.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,48 +203,4 @@ FOUNDATION_EXPORT const NSUInteger SPTPersistentCacheMinimumExpirationLimit;

@end


#pragma mark - Deprecation Category

/**
* Methods on `SPTPersistentCacheOptions` that are deprecated and will be removed in a later release.
*/
@interface SPTPersistentCacheOptions (Deprectated)

/**
* Returns a new instance of the class setup with specific values.
* @deprecated
* @param cachePath Path in the system file for the cache.
* @param cacheIdentifier An identifier for the cache.
* @param defaultExpirationInterval Default time which have to pass since last file access so file could be candidate
* for pruning on next GC.
* @param garbageCollectorInterval It is guaranteed that once started GC runs with this interval.
* @param debugCallback A callback used for debugging purposes. May be nil.
*/
- (instancetype)initWithCachePath:(NSString *)cachePath
identifier:(NSString *)cacheIdentifier
defaultExpirationInterval:(NSUInteger)defaultExpirationInterval
garbageCollectorInterval:(NSUInteger)garbageCollectorInterval
debug:(nullable SPTPersistentCacheDebugCallback)debugCallback DEPRECATED_MSG_ATTRIBUTE("Configure the option instance’s properties instead.");

/**
* Compatibility alias for `useDirectorySeparation`.
* @seealso useDirectorySeparation
*/
@property (nonatomic, assign) BOOL folderSeparationEnabled DEPRECATED_MSG_ATTRIBUTE("Use the useDirectorySeparation property instead");
/**
* Compatibility alias for `garbageCollectionInterval`.
* @deprecated
* @seealso garbageCollectionInterval
*/
@property (nonatomic, assign, readonly) NSUInteger gcIntervalSec DEPRECATED_MSG_ATTRIBUTE("Use the garbageCollectionInterval property instead");
/**
* Compatibility alias for `defaultExpirationPeriod`.
* @deprecated
* @seealso defaultExpirationPeriod
*/
@property (nonatomic, assign, readonly) NSUInteger defaultExpirationPeriodSec DEPRECATED_MSG_ATTRIBUTE("Use the defaultExpirationPeriod property instead");

@end

NS_ASSUME_NONNULL_END