Skip to content

@johankool /NSURL+PathParameters.h
Created

Embed URL

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
NSURL+PathParameters
//
// NSURL+PathParameters.h
//
// Created by Johan Kool on 27/9/2011.
// Copyright 2011 Koolistov Pte. Ltd. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this list of
// conditions and the following disclaimer.
// * Neither the name of KOOLISTOV PTE. LTD. nor the names of its contributors may be used to
// endorse or promote products derived from this software without specific prior written
// permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
// THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
// OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
#import <Foundation/Foundation.h>
@interface NSURL (PathParameters)
- (NSURL *)URLByReplacingPathWithPath:(NSString *)path;
- (NSURL *)URLByAppendingPathWithRelativePath:(NSString *)path;
- (NSURL *)URLByAppendingParameters:(NSDictionary *)parameters;
- (NSURL *)URLByAppendingParameterName:(NSString *)parameter value:(id)value;
@end
//
// NSURL+PathParameters.m
//
// Created by Johan Kool on 27/9/2011.
// Copyright 2011 Koolistov Pte. Ltd. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this list of
// conditions and the following disclaimer.
// * Neither the name of KOOLISTOV PTE. LTD. nor the names of its contributors may be used to
// endorse or promote products derived from this software without specific prior written
// permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
// THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
// OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
#import "NSURL+PathParameters.h"
@interface NSString (URLParameters)
- (NSString *)stringByEscapingForURLArgument;
@end
@implementation NSString (URLParameters)
- (NSString *)stringByEscapingForURLArgument {
// Encode all the reserved characters, per RFC 3986 (<http://www.ietf.org/rfc/rfc3986.txt>)
NSString *escapedString = (NSString *)CFURLCreateStringByAddingPercentEscapes(kCFAllocatorDefault,
(CFStringRef)self,
NULL,
(CFStringRef)@"!*'\"();:@&=+$,/?%#[] ",
kCFStringEncodingUTF8);
return [escapedString autorelease];
}
@end
@implementation NSURL (PathParameters)
- (NSURL *)URLByReplacingPathWithPath:(NSString *)path {
// scheme://username:password@domain:port/path?query_string#fragment_id
// Chop off path, query and fragment from absoluteString, then add new path and put back query and fragment
NSString *absoluteString = [self absoluteString];
NSUInteger endIndex = [absoluteString length];
NSString *fragment = [self fragment];
if (fragment) {
endIndex -= [fragment length];
endIndex--; // The # character
}
NSString *query = [self query];
if (query) {
endIndex -= [query length];
endIndex--; // The ? character
}
// Check if the last character of the path is a slash (range must be valid as endIndex must be smaller or equal to length)
BOOL trailingSlashOnPath = [[absoluteString substringWithRange:NSMakeRange(endIndex - 1, 1)] isEqualToString:@"/"];
NSString *originalPath = [self path]; // This method strips any trailing slash "/"
if (originalPath) {
endIndex -= [originalPath length];
if (trailingSlashOnPath && [originalPath length] > 1) { // Don't get confused with the starting slash
endIndex--;
}
}
absoluteString = [absoluteString substringToIndex:endIndex];
absoluteString = [absoluteString stringByAppendingString:path];
if (query) {
absoluteString = [absoluteString stringByAppendingString:@"?"];
absoluteString = [absoluteString stringByAppendingString:query];
}
if (fragment) {
absoluteString = [absoluteString stringByAppendingString:@"#"];
absoluteString = [absoluteString stringByAppendingString:fragment];
}
return [NSURL URLWithString:absoluteString];
}
- (NSURL *)URLByAppendingPathWithRelativePath:(NSString *)path {
NSString *originalPath = [self path];
NSString *combinedPath = [[originalPath stringByAppendingPathComponent:path] stringByStandardizingPath];
// Don't standardize away a trailing slash
if ([path length] > 1 && [path hasSuffix:@"/"]) {
combinedPath = [combinedPath stringByAppendingString:@"/"];
}
return [self URLByReplacingPathWithPath:combinedPath];
}
- (NSURL *)URLByAppendingParameters:(NSDictionary *)parameters {
NSMutableString *query = [[[self query] mutableCopy] autorelease];
if (!query) {
query = [NSMutableString stringWithString:@""];
}
// Sort parameters to be appended so that our solution is stable (and testable)
NSArray *parameterNames = [parameters allKeys];
parameterNames = [parameterNames sortedArrayUsingSelector:@selector(compare:)];
for (NSString *parameterName in parameterNames) {
id value = [parameters objectForKey:parameterName];
NSAssert3([parameterName isKindOfClass:[NSString class]], @"Got '%@' of type %@ as key for parameter with value '%@'. Expected an NSString.", parameterName, NSStringFromClass([parameterName class]), value);
// The value needs to be an NSString, or be able to give us an NSString
if (![value isKindOfClass:[NSString class]]) {
if ([value respondsToSelector:@selector(stringValue)]) {
value = [value stringValue];
} else {
// Fallback to simply giving the description
value = [value description];
}
}
if ([query length] == 0) {
[query appendFormat:@"%@=%@", [parameterName stringByEscapingForURLArgument], [value stringByEscapingForURLArgument]];
} else {
[query appendFormat:@"&%@=%@", [parameterName stringByEscapingForURLArgument], [value stringByEscapingForURLArgument]];
}
}
// scheme://username:password@domain:port/path?query_string#fragment_id
// Chop off query and fragment from absoluteString, then add new query and put back fragment
NSString *absoluteString = [self absoluteString];
NSUInteger endIndex = [absoluteString length];
NSString *fragment = [self fragment];
if (fragment) {
endIndex -= [fragment length];
endIndex--; // The # character
}
NSString *originalQuery = [self query];
if (originalQuery) {
endIndex -= [originalQuery length];
endIndex--; // The ? character
}
absoluteString = [absoluteString substringToIndex:endIndex];
absoluteString = [absoluteString stringByAppendingString:@"?"];
absoluteString = [absoluteString stringByAppendingString:query];
if (fragment) {
absoluteString = [absoluteString stringByAppendingString:@"#"];
absoluteString = [absoluteString stringByAppendingString:fragment];
}
return [NSURL URLWithString:absoluteString];
}
- (NSURL *)URLByAppendingParameterName:(NSString *)parameter value:(id)value {
return [self URLByAppendingParameters:[NSDictionary dictionaryWithObjectsAndKeys:value, parameter, nil]];
}
@end
//
// NSURL+PathParametersTest.h
//
// Created by Johan Kool on 27/9/2011.
// Copyright 2011 Koolistov Pte. Ltd. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this list of
// conditions and the following disclaimer.
// * Neither the name of KOOLISTOV PTE. LTD. nor the names of its contributors may be used to
// endorse or promote products derived from this software without specific prior written
// permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
// THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
// OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// See Also: http://developer.apple.com/iphone/library/documentation/Xcode/Conceptual/iphone_development/135-Unit_Testing_Applications/unit_testing_applications.html
// Application unit tests contain unit test code that must be injected into an application to run correctly.
// Define USE_APPLICATION_UNIT_TEST to 0 if the unit test code is designed to be linked into an independent test executable.
#import <SenTestingKit/SenTestingKit.h>
#import <UIKit/UIKit.h>
#import "NSURL+PathParameters.h"
@interface NSURL_PathParametersTest : SenTestCase
- (void)testPath;
- (void)testParameters;
@end
//
// NSURL+PathParametersTest.m
//
// Created by Johan Kool on 27/9/2011.
// Copyright 2011 Koolistov Pte. Ltd. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are
// permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this list of
// conditions and the following disclaimer.
// * Neither the name of KOOLISTOV PTE. LTD. nor the names of its contributors may be used to
// endorse or promote products derived from this software without specific prior written
// permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
// THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
// OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
#import "NSURL+PathParametersTest.h"
@implementation NSURL_PathParametersTest
- (void)testPath {
NSURL *URL = nil;
URL = [NSURL URLWithString:@"http://www.koolistov.net/"];
URL = [URL URLByReplacingPathWithPath:@"/action"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/action"], @"Expected URLs to match");
URL = [NSURL URLWithString:@"http://www.koolistov.net"];
URL = [URL URLByReplacingPathWithPath:@"/action"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/action"], @"Expected URLs to match");
URL = [NSURL URLWithString:@"http://www.koolistov.net/?key=123"];
URL = [URL URLByReplacingPathWithPath:@"/action"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/action?key=123"], @"Expected URLs to match");
URL = [NSURL URLWithString:@"http://www.koolistov.net/#anchor1"];
URL = [URL URLByReplacingPathWithPath:@"/action"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/action#anchor1"], @"Expected URLs to match");
URL = [NSURL URLWithString:@"http://www.koolistov.net/#anchor1"];
URL = [URL URLByReplacingPathWithPath:@"/action/"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/action/#anchor1"], @"Expected URLs to match");
URL = [NSURL URLWithString:@"http://www.koolistov.net/oldaction/?key=123#anchor1"];
URL = [URL URLByReplacingPathWithPath:@"/action/"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/action/?key=123#anchor1"], @"Expected URLs to match");
URL = [NSURL URLWithString:@"http://www.koolistov.net/"];
URL = [URL URLByAppendingPathWithRelativePath:@"action"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/action"], @"Expected URLs to match");
URL = [NSURL URLWithString:@"http://www.koolistov.net/test/"];
URL = [URL URLByAppendingPathWithRelativePath:@"../action"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/action"], @"Expected URLs to match");
URL = [NSURL URLWithString:@"http://www.koolistov.net/test"];
URL = [URL URLByAppendingPathWithRelativePath:@"../action"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/action"], @"Expected URLs to match");
URL = [NSURL URLWithString:@"http://www.koolistov.net/test/"];
URL = [URL URLByAppendingPathWithRelativePath:@"action1/action2"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/test/action1/action2"], @"Expected URLs to match");
URL = [NSURL URLWithString:@"http://www.koolistov.net/test/"];
URL = [URL URLByAppendingPathWithRelativePath:@"/action1/action2/"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/test/action1/action2/"], @"Expected URLs to match");
}
- (void)testParameters {
NSDictionary *parameters = nil;
NSURL *URL = nil;
parameters = [NSDictionary dictionaryWithObjectsAndKeys:@"!@#$%^&* ()'\"", @"key1", nil];
URL = [NSURL URLWithString:@"http://www.koolistov.net/"];
URL = [URL URLByAppendingParameters:parameters];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/?key1=%21%40%23%24%25%5E%26%2A%20%28%29%27%22"], @"Expected URLs to match");
parameters = [NSDictionary dictionaryWithObjectsAndKeys:@"abc", @"key1", @"456", @"key2", nil];
URL = [NSURL URLWithString:@"http://www.koolistov.net/"];
URL = [URL URLByAppendingParameters:parameters];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/?key1=abc&key2=456"], @"Expected URLs to match");
parameters = [NSDictionary dictionaryWithObjectsAndKeys:@"abc", @"key1", @"456", @"key2", nil];
URL = [NSURL URLWithString:@"http://www.koolistov.net"];
URL = [URL URLByAppendingParameters:parameters];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net?key1=abc&key2=456"], @"Expected URLs to match");
parameters = [NSDictionary dictionaryWithObjectsAndKeys:@"abc", @"key1", @"456", @"key2", nil];
URL = [NSURL URLWithString:@"http://johan@www.koolistov.net/?"];
URL = [URL URLByAppendingParameters:parameters];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://johan@www.koolistov.net/?key1=abc&key2=456"], @"Expected URLs to match");
parameters = [NSDictionary dictionaryWithObjectsAndKeys:@"abc", @"key1", @"456", @"key2", nil];
URL = [NSURL URLWithString:@"http://www.koolistov.net/#"];
URL = [URL URLByAppendingParameters:parameters];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/?key1=abc&key2=456#"], @"Expected URLs to match");
parameters = [NSDictionary dictionaryWithObjectsAndKeys:@"abc", @"key1", @"456", @"key2", nil];
URL = [NSURL URLWithString:@"http://www.koolistov.net/?key1=123#anchor1"];
URL = [URL URLByAppendingParameters:parameters];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/?key1=123&key1=abc&key2=456#anchor1"], @"Expected URLs to match");
parameters = [NSDictionary dictionaryWithObjectsAndKeys:@"abc", @"key1", @"456", @"key2", nil];
URL = [NSURL URLWithString:@"http://www.koolistov.net/#anchor1"];
URL = [URL URLByAppendingParameters:parameters];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/?key1=abc&key2=456#anchor1"], @"Expected URLs to match");
URL = [NSURL URLWithString:@"http://www.koolistov.net/"];
URL = [URL URLByAppendingParameterName:@"key1" value:@"abc"];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/?key1=abc"], @"Expected URLs to match");
parameters = [NSDictionary dictionaryWithObjectsAndKeys:[NSNumber numberWithBool:YES], @"key1", [NSNumber numberWithInteger:456], @"key2", nil];
URL = [NSURL URLWithString:@"http://www.koolistov.net/#anchor1"];
URL = [URL URLByAppendingParameters:parameters];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/?key1=1&key2=456#anchor1"], @"Expected URLs to match");
parameters = [NSDictionary dictionaryWithObjectsAndKeys:[NSDate dateWithTimeIntervalSinceReferenceDate:0], @"key1", nil];
URL = [NSURL URLWithString:@"http://www.koolistov.net/#anchor1"];
URL = [URL URLByAppendingParameters:parameters];
STAssertEqualObjects(URL, [NSURL URLWithString:@"http://www.koolistov.net/?key1=2001-01-01%2000%3A00%3A00%20%2B0000#anchor1"], @"Expected URLs to match");
}
@end
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.