//
//  GBCommentsProcessor-PreprocessingTesting.m
//  appledoc
//
//  Created by Tomaz Kragelj on 14.2.11.
//  Copyright (C) 2011 Gentle Bytes. All rights reserved.
//

#import "GBApplicationSettingsProvider.h"
#import "GBDataObjects.h"
#import "GBStore.h"
#import "GBCommentsProcessor.h"

@interface GBCommentsProcessor (PrivateAPI)
- (NSString *)stringByPreprocessingString:(NSString *)string withFlags:(NSUInteger)flags;
- (NSString *)stringByConvertingCrossReferencesInString:(NSString *)string withFlags:(NSUInteger)flags;
@end

#pragma mark -

@interface GBCommentsProcessorPreprocessingTesting : GBObjectsAssertor

- (GBCommentsProcessor *)defaultProcessor;
- (GBCommentsProcessor *)processorWithStore:(id)store;
- (GBCommentsProcessor *)processorWithStore:(id)store context:(id)context;

@end

#pragma mark -

@implementation GBCommentsProcessorPreprocessingTesting

#pragma mark Formatting markers conversion

- (void)testStringByPreprocessingString_shouldConvertAppledocBoldMarkersToTemporarySyntax {
	// setup
	GBCommentsProcessor *processor = [self defaultProcessor];
	// execute
	NSString *result1 = [processor stringByPreprocessingString:@"*bold1* *bold text* * bolder text *" withFlags:0];
	NSString *result2 = [processor stringByPreprocessingString:@"*bold1* Middle *bold text*" withFlags:0];
	// verify
	assertThat(result1, is(@"**~!#bold1#!~** **~!#bold text#!~** **~!# bolder text #!~**"));
	assertThat(result2, is(@"**~!#bold1#!~** Middle **~!#bold text#!~**"));
}

- (void)testStringByPreprocessingString_shouldLeaveItalicsMarkers {
	// setup
	GBCommentsProcessor *processor = [self defaultProcessor];
	// execute
	NSString *result1 = [processor stringByPreprocessingString:@"_bold1_ _bold text_ _ bolder text _" withFlags:0];
	NSString *result2 = [processor stringByPreprocessingString:@"_bold1_ Middle _bold text_" withFlags:0];
	// verify
	assertThat(result1, is(@"_bold1_ _bold text_ _ bolder text _"));
	assertThat(result2, is(@"_bold1_ Middle _bold text_"));
}

- (void)testStringByPreprocessingString_shouldLeaveBoldItalicsMarkers {
	// setup
	GBCommentsProcessor *processor = [self defaultProcessor];
	// execute
	NSString *result = [processor stringByPreprocessingString:@"_*text1*_ *_marked text_* _* text2 *_" withFlags:0];
	// verify
	assertThat(result, is(@"_*text1*_ *_marked text_* _* text2 *_"));
}

- (void)testStringByPreprocessingString_shouldHandleMonospaceMarkers {
	// setup
	GBCommentsProcessor *processor = [self defaultProcessor];
	// execute
	NSString *result = [processor stringByPreprocessingString:@"`mono` ` monoer `" withFlags:0];
	// verify
	assertThat(result, is(@"`mono` ` monoer `"));
}

- (void)testStringByPreprocessingString_shouldHandleMarkdownBoldMarkers {
	// setup
	GBCommentsProcessor *processor = [self defaultProcessor];
	// execute
	NSString *result1 = [processor stringByPreprocessingString:@"__text1__ __ marked __" withFlags:0];
	NSString *result2 = [processor stringByPreprocessingString:@"**text1** ** marked **" withFlags:0];
	// verify
	assertThat(result1, is(@"__text1__ __ marked __"));
	assertThat(result2, is(@"**text1** ** marked **"));
}

- (void)testStringByPreprocessingString_shouldLeaveMarkdownBoldItalicsMarkers {
	// setup
	GBCommentsProcessor *processor = [self defaultProcessor];
	// execute
	NSString *result1 = [processor stringByPreprocessingString:@"__*text1*__ __* marked *__" withFlags:0];
	NSString *result2 = [processor stringByPreprocessingString:@"_**text1**_ _** marked **_" withFlags:0];
	NSString *result3 = [processor stringByPreprocessingString:@"*__text1__* *__ marked __*" withFlags:0];
	NSString *result4 = [processor stringByPreprocessingString:@"**_text1_** **_ marked _**" withFlags:0];
	NSString *result5 = [processor stringByPreprocessingString:@"___text1___ ___ marked ___" withFlags:0];
	NSString *result6 = [processor stringByPreprocessingString:@"***text1*** *** marked ***" withFlags:0];
	// verify
	assertThat(result1, is(@"__*text1*__ __* marked *__"));
	assertThat(result2, is(@"_**text1**_ _** marked **_"));
	assertThat(result3, is(@"*__text1__* *__ marked __*"));
	assertThat(result4, is(@"**_text1_** **_ marked _**"));
	assertThat(result5, is(@"___text1___ ___ marked ___"));
	assertThat(result6, is(@"***text1*** *** marked ***"));
}

#pragma mark Class, category and protocol cross references detection

- (void)testStringByConvertingCrossReferencesInString_shouldConvertClass {
	// setup
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:[GBClassData classDataWithName:@"Class"], nil];
	GBCommentsProcessor *processor = [self processorWithStore:store];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"Class" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<Class>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"Unknown" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<Unknown>" withFlags:0];
	// verify
	assertThat(result1, is(@"[Class](Classes/Class.html)"));
	assertThat(result2, is(@"[Class](Classes/Class.html)"));
	assertThat(result3, is(@"Unknown"));
	assertThat(result4, is(@"<Unknown>"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertCategory {
	// setup
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:[GBCategoryData categoryDataWithName:@"Category" className:@"Class"], nil];
	GBCommentsProcessor *processor = [self processorWithStore:store];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"Class(Category)" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<Class(Category)>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"Class(Unknown)" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<Class(Unknown)>" withFlags:0];
	// verify
	assertThat(result1, is(@"[Class(Category)](Categories/Class(Category).html)"));
	assertThat(result2, is(@"[Class(Category)](Categories/Class(Category).html)"));
	assertThat(result3, is(@"Class(Unknown)"));
	assertThat(result4, is(@"<Class(Unknown)>"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertProtocol {
	// setup
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:[GBProtocolData protocolDataWithName:@"Protocol"], nil];
	GBCommentsProcessor *processor = [self processorWithStore:store];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"Protocol" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<Protocol>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"Unknown" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<Unknown>" withFlags:0];
	// verify
	assertThat(result1, is(@"[Protocol](Protocols/Protocol.html)"));
	assertThat(result2, is(@"[Protocol](Protocols/Protocol.html)"));
	assertThat(result3, is(@"Unknown"));
	assertThat(result4, is(@"<Unknown>"));
}

#pragma mark Local members cross references detection

- (void)testStringByConvertingCrossReferencesInString_shouldConvertClassLocalInstanceMethod {
	// setup
	GBClassData *class = [GBTestObjectsRegistry classWithName:@"Class" methods:[GBTestObjectsRegistry instanceMethodWithNames:@"method", nil], nil];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:class, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store context:class];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"method:" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<method:>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"-method:" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<-method:>" withFlags:0];
	NSString *result5 = [processor stringByConvertingCrossReferencesInString:@"another:" withFlags:0];
	NSString *result6 = [processor stringByConvertingCrossReferencesInString:@"<another:>" withFlags:0];
	// verify
	assertThat(result1, is(@"[method:](#//api/name/method:)"));
	assertThat(result2, is(@"[method:](#//api/name/method:)"));
	assertThat(result3, is(@"[method:](#//api/name/method:)"));
	assertThat(result4, is(@"[method:](#//api/name/method:)"));
	assertThat(result5, is(@"another:"));
	assertThat(result6, is(@"<another:>"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertClassLocalClassMethod {
	// setup
	GBClassData *class = [GBTestObjectsRegistry classWithName:@"Class" methods:[GBTestObjectsRegistry classMethodWithNames:@"method", nil], nil];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:class, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store context:class];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"method:" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<method:>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"+method:" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<+method:>" withFlags:0];
	NSString *result5 = [processor stringByConvertingCrossReferencesInString:@"another:" withFlags:0];
	NSString *result6 = [processor stringByConvertingCrossReferencesInString:@"<another:>" withFlags:0];
	// verify
	assertThat(result1, is(@"[method:](#//api/name/method:)"));
	assertThat(result2, is(@"[method:](#//api/name/method:)"));
	assertThat(result3, is(@"[method:](#//api/name/method:)"));
	assertThat(result4, is(@"[method:](#//api/name/method:)"));
	assertThat(result5, is(@"another:"));
	assertThat(result6, is(@"<another:>"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertClassLocalProperty {
	// setup
	GBClassData *class = [GBTestObjectsRegistry classWithName:@"Class" methods:[GBTestObjectsRegistry propertyMethodWithArgument:@"method"], nil];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:class, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store context:class];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"method" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<method>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"method:" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<method:>" withFlags:0];
	NSString *result5 = [processor stringByConvertingCrossReferencesInString:@"another" withFlags:0];
	NSString *result6 = [processor stringByConvertingCrossReferencesInString:@"<another>" withFlags:0];
	// verify
	assertThat(result1, is(@"[method](#//api/name/method)"));
	assertThat(result2, is(@"[method](#//api/name/method)"));
	assertThat(result3, is(@"method:"));
	assertThat(result4, is(@"<method:>"));
	assertThat(result5, is(@"another"));
	assertThat(result6, is(@"<another>"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertCategoryAndProtocolLocalInstanceMethod {
	// setup
	id method1 = [GBTestObjectsRegistry instanceMethodWithNames:@"method1", nil];
	id method2 = [GBTestObjectsRegistry instanceMethodWithNames:@"method2", nil];
	GBCategoryData *category = [GBTestObjectsRegistry categoryWithName:@"Category" className:@"Class" methods:method1, nil];
	GBProtocolData *protocol = [GBTestObjectsRegistry protocolWithName:@"Protocol" methods:method2, nil];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:category, protocol, nil];
	GBCommentsProcessor *processor1 = [self processorWithStore:store context:category];
	GBCommentsProcessor *processor2 = [self processorWithStore:store context:protocol];
	// execute
	NSString *result1 = [processor1 stringByConvertingCrossReferencesInString:@"method1:" withFlags:0];
	NSString *result2 = [processor1 stringByConvertingCrossReferencesInString:@"<method1:>" withFlags:0];
	NSString *result3 = [processor1 stringByConvertingCrossReferencesInString:@"method2:" withFlags:0];
	NSString *result4 = [processor2 stringByConvertingCrossReferencesInString:@"method2:" withFlags:0];
	NSString *result5 = [processor2 stringByConvertingCrossReferencesInString:@"<method2:>" withFlags:0];
	NSString *result6 = [processor2 stringByConvertingCrossReferencesInString:@"method1:" withFlags:0];
	// verify
	assertThat(result1, is(@"[method1:](#//api/name/method1:)"));
	assertThat(result2, is(@"[method1:](#//api/name/method1:)"));
	assertThat(result3, is(@"method2:"));
	assertThat(result4, is(@"[method2:](#//api/name/method2:)"));
	assertThat(result5, is(@"[method2:](#//api/name/method2:)"));
	assertThat(result6, is(@"method1:"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertCategoryAndProtocolLocalClassMethod {
	// setup
	id method1 = [GBTestObjectsRegistry classMethodWithNames:@"method1", nil];
	id method2 = [GBTestObjectsRegistry classMethodWithNames:@"method2", nil];
	GBCategoryData *category = [GBTestObjectsRegistry categoryWithName:@"Category" className:@"Class" methods:method1, nil];
	GBProtocolData *protocol = [GBTestObjectsRegistry protocolWithName:@"Protocol" methods:method2, nil];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:category, protocol, nil];
	GBCommentsProcessor *processor1 = [self processorWithStore:store context:category];
	GBCommentsProcessor *processor2 = [self processorWithStore:store context:protocol];
	// execute
	NSString *result1 = [processor1 stringByConvertingCrossReferencesInString:@"method1:" withFlags:0];
	NSString *result2 = [processor1 stringByConvertingCrossReferencesInString:@"<method1:>" withFlags:0];
	NSString *result3 = [processor1 stringByConvertingCrossReferencesInString:@"method2:" withFlags:0];
	NSString *result4 = [processor2 stringByConvertingCrossReferencesInString:@"method2:" withFlags:0];
	NSString *result5 = [processor2 stringByConvertingCrossReferencesInString:@"<method2:>" withFlags:0];
	NSString *result6 = [processor2 stringByConvertingCrossReferencesInString:@"method1:" withFlags:0];
	// verify
	assertThat(result1, is(@"[method1:](#//api/name/method1:)"));
	assertThat(result2, is(@"[method1:](#//api/name/method1:)"));
	assertThat(result3, is(@"method2:"));
	assertThat(result4, is(@"[method2:](#//api/name/method2:)"));
	assertThat(result5, is(@"[method2:](#//api/name/method2:)"));
	assertThat(result6, is(@"method1:"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertCategoryAndProtocolLocalProperty {
	// setup
	id method1 = [GBTestObjectsRegistry propertyMethodWithArgument:@"method1"];
	id method2 = [GBTestObjectsRegistry propertyMethodWithArgument:@"method2"];
	GBCategoryData *category = [GBTestObjectsRegistry categoryWithName:@"Category" className:@"Class" methods:method1, nil];
	GBProtocolData *protocol = [GBTestObjectsRegistry protocolWithName:@"Protocol" methods:method2, nil];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:category, protocol, nil];
	GBCommentsProcessor *processor1 = [self processorWithStore:store context:category];
	GBCommentsProcessor *processor2 = [self processorWithStore:store context:protocol];
	// execute
	NSString *result1 = [processor1 stringByConvertingCrossReferencesInString:@"method1" withFlags:0];
	NSString *result2 = [processor1 stringByConvertingCrossReferencesInString:@"<method1>" withFlags:0];
	NSString *result3 = [processor1 stringByConvertingCrossReferencesInString:@"method2" withFlags:0];
	NSString *result4 = [processor2 stringByConvertingCrossReferencesInString:@"method2" withFlags:0];
	NSString *result5 = [processor2 stringByConvertingCrossReferencesInString:@"<method2>" withFlags:0];
	NSString *result6 = [processor2 stringByConvertingCrossReferencesInString:@"method1" withFlags:0];
	// verify
	assertThat(result1, is(@"[method1](#//api/name/method1)"));
	assertThat(result2, is(@"[method1](#//api/name/method1)"));
	assertThat(result3, is(@"method2"));
	assertThat(result4, is(@"[method2](#//api/name/method2)"));
	assertThat(result5, is(@"[method2](#//api/name/method2)"));
	assertThat(result6, is(@"method1"));
}

#pragma mark Remote members cross references detection

- (void)testStringByConvertingCrossReferencesInString_shouldConvertClassRemoteInstanceMethod {
	// setup
	GBClassData *class1 = [GBTestObjectsRegistry classWithName:@"Class1" methods:[GBTestObjectsRegistry instanceMethodWithNames:@"method", nil], nil];
	GBClassData *class2 = [GBClassData classDataWithName:@"Class2"];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:class1, class2, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store context:class2];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"[Class1 method:]" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<[Class1 method:]>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"-[Class1 method:]" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<-[Class1 method:]>" withFlags:0];
	NSString *result5 = [processor stringByConvertingCrossReferencesInString:@"[Unknown method:]" withFlags:0];
	NSString *result6 = [processor stringByConvertingCrossReferencesInString:@"method:" withFlags:0];
	// verify
	assertThat(result1, is(@"[[Class1 method:]](../Classes/Class1.html#//api/name/method:)"));
	assertThat(result2, is(@"[[Class1 method:]](../Classes/Class1.html#//api/name/method:)"));
	assertThat(result3, is(@"[[Class1 method:]](../Classes/Class1.html#//api/name/method:)"));
	assertThat(result4, is(@"[[Class1 method:]](../Classes/Class1.html#//api/name/method:)"));
	assertThat(result5, is(@"[Unknown method:]"));
	assertThat(result6, is(@"method:"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertCategoryRemoteInstanceMethod {
	// setup
	GBCategoryData *category = [GBTestObjectsRegistry categoryWithName:@"Category" className:@"Class" methods:[GBTestObjectsRegistry instanceMethodWithNames:@"method", nil], nil];
	GBClassData *class = [GBClassData classDataWithName:@"Class"];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:category, class, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store context:class];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"[Class(Category) method:]" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<[Class(Category) method:]>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"-[Class(Category) method:]" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<-[Class(Category) method:]>" withFlags:0];
	NSString *result5 = [processor stringByConvertingCrossReferencesInString:@"[Class(Unknown) method:]" withFlags:0];
	NSString *result6 = [processor stringByConvertingCrossReferencesInString:@"[Unknown(Category) method:]" withFlags:0];
	// verify
	assertThat(result1, is(@"[[Class(Category) method:]](../Categories/Class(Category).html#//api/name/method:)"));
	assertThat(result2, is(@"[[Class(Category) method:]](../Categories/Class(Category).html#//api/name/method:)"));
	assertThat(result3, is(@"[[Class(Category) method:]](../Categories/Class(Category).html#//api/name/method:)"));
	assertThat(result4, is(@"[[Class(Category) method:]](../Categories/Class(Category).html#//api/name/method:)"));
	assertThat(result5, is(@"[Class(Unknown) method:]"));
	assertThat(result6, is(@"[Unknown(Category) method:]"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertProtocolRemoteInstanceMethod {
	// setup
	GBProtocolData *protocol = [GBTestObjectsRegistry protocolWithName:@"Protocol" methods:[GBTestObjectsRegistry instanceMethodWithNames:@"method", nil], nil];
	GBClassData *class = [GBClassData classDataWithName:@"Class"];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:protocol, class, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store context:class];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"[Protocol method:]" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<[Protocol method:]>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"-[Protocol method:]" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<-[Protocol method:]>" withFlags:0];
	NSString *result5 = [processor stringByConvertingCrossReferencesInString:@"[Unknown method:]" withFlags:0];
	NSString *result6 = [processor stringByConvertingCrossReferencesInString:@"method:" withFlags:0];
	// verify
	assertThat(result1, is(@"[[Protocol method:]](../Protocols/Protocol.html#//api/name/method:)"));
	assertThat(result2, is(@"[[Protocol method:]](../Protocols/Protocol.html#//api/name/method:)"));
	assertThat(result3, is(@"[[Protocol method:]](../Protocols/Protocol.html#//api/name/method:)"));
	assertThat(result4, is(@"[[Protocol method:]](../Protocols/Protocol.html#//api/name/method:)"));
	assertThat(result5, is(@"[Unknown method:]"));
	assertThat(result6, is(@"method:"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldKeepUnknownRemoteMemberEvenIfObjectIsKnown {
	// setup
	GBClassData *class1 = [GBTestObjectsRegistry classWithName:@"Class1" methods:[GBTestObjectsRegistry instanceMethodWithNames:@"method", nil], nil];
	GBClassData *class2 = [GBClassData classDataWithName:@"Class2"];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:class1, class2, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store context:class2];
	// execute
	NSString *result = [processor stringByConvertingCrossReferencesInString:@"[Class1 unknown:]" withFlags:0];
	// verify
	assertThat(result, is(@"[Class1 unknown:]"));
}

#pragma mark Document references detection

- (void)testStringByConvertingCrossReferencesInString_shouldConvertDocument {
	// setup
	GBDocumentData *document = [GBDocumentData documentDataWithContents:@"c" path:@"Document1.html"];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:document, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store context:nil];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"Document1" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<Document1>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"Document12" withFlags:0];
	// verify
	assertThat(result1, is(@"[Document1](docs/Document1.html)"));
	assertThat(result2, is(@"[Document1](docs/Document1.html)"));
	assertThat(result3, is(@"Document12"));
}

#pragma mark URL cross references detection

- (void)testStringByConvertingCrossReferencesInString_shouldConvertHTML {
	// setup
	GBCommentsProcessor *processor = [self defaultProcessor];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"http://gentlebytes.com" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"https://gentlebytes.com" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"<http://gentlebytes.com>" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<https://gentlebytes.com>" withFlags:0];
	NSString *result5 = [processor stringByConvertingCrossReferencesInString:@"http://gentlebytes.com https://gentlebytes.com" withFlags:0];
	NSString *result6 = [processor stringByConvertingCrossReferencesInString:@"https://gentlebytes.com http://gentlebytes.com" withFlags:0];
	// verify
	assertThat(result1, is(@"[http://gentlebytes.com](http://gentlebytes.com)"));
	assertThat(result2, is(@"[https://gentlebytes.com](https://gentlebytes.com)"));
	assertThat(result3, is(@"[http://gentlebytes.com](http://gentlebytes.com)"));
	assertThat(result4, is(@"[https://gentlebytes.com](https://gentlebytes.com)"));
	assertThat(result5, is(@"[http://gentlebytes.com](http://gentlebytes.com) [https://gentlebytes.com](https://gentlebytes.com)"));
	assertThat(result6, is(@"[https://gentlebytes.com](https://gentlebytes.com) [http://gentlebytes.com](http://gentlebytes.com)"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertFTP {
	// setup
	GBCommentsProcessor *processor = [self defaultProcessor];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"ftp://gentlebytes.com" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"ftps://gentlebytes.com" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"<ftp://gentlebytes.com>" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<ftps://gentlebytes.com>" withFlags:0];
	NSString *result5 = [processor stringByConvertingCrossReferencesInString:@"ftp://gentlebytes.com ftps://gentlebytes.com" withFlags:0];
	NSString *result6 = [processor stringByConvertingCrossReferencesInString:@"ftps://gentlebytes.com ftp://gentlebytes.com" withFlags:0];
	// verify
	assertThat(result1, is(@"[ftp://gentlebytes.com](ftp://gentlebytes.com)"));
	assertThat(result2, is(@"[ftps://gentlebytes.com](ftps://gentlebytes.com)"));
	assertThat(result3, is(@"[ftp://gentlebytes.com](ftp://gentlebytes.com)"));
	assertThat(result4, is(@"[ftps://gentlebytes.com](ftps://gentlebytes.com)"));
	assertThat(result5, is(@"[ftp://gentlebytes.com](ftp://gentlebytes.com) [ftps://gentlebytes.com](ftps://gentlebytes.com)"));
	assertThat(result6, is(@"[ftps://gentlebytes.com](ftps://gentlebytes.com) [ftp://gentlebytes.com](ftp://gentlebytes.com)"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertNewsAndRSS {
	// setup
	GBCommentsProcessor *processor = [self defaultProcessor];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"news://gentlebytes.com" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"rss://gentlebytes.com" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"<news://gentlebytes.com>" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"<rss://gentlebytes.com>" withFlags:0];
	NSString *result5 = [processor stringByConvertingCrossReferencesInString:@"rss://gentlebytes.com news://gentlebytes.com" withFlags:0];
	NSString *result6 = [processor stringByConvertingCrossReferencesInString:@"news://gentlebytes.com rss://gentlebytes.com" withFlags:0];
	// verify
	assertThat(result1, is(@"[news://gentlebytes.com](news://gentlebytes.com)"));
	assertThat(result2, is(@"[rss://gentlebytes.com](rss://gentlebytes.com)"));
	assertThat(result3, is(@"[news://gentlebytes.com](news://gentlebytes.com)"));
	assertThat(result4, is(@"[rss://gentlebytes.com](rss://gentlebytes.com)"));
	assertThat(result5, is(@"[rss://gentlebytes.com](rss://gentlebytes.com) [news://gentlebytes.com](news://gentlebytes.com)"));
	assertThat(result6, is(@"[news://gentlebytes.com](news://gentlebytes.com) [rss://gentlebytes.com](rss://gentlebytes.com)"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertFile {
	// setup
	GBCommentsProcessor *processor = [self defaultProcessor];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"file://gentlebytes.com" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<file://gentlebytes.com>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"file://first file://second" withFlags:0];
	// verify
	assertThat(result1, is(@"[file://gentlebytes.com](file://gentlebytes.com)"));
	assertThat(result2, is(@"[file://gentlebytes.com](file://gentlebytes.com)"));
	assertThat(result3, is(@"[file://first](file://first) [file://second](file://second)"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertMailto {
	// setup
	GBCommentsProcessor *processor = [self defaultProcessor];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"mailto:appledoc@gentlebytes.com" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"<mailto:appledoc@gentlebytes.com>" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"mailto:a@b.com mailto:c@d.com" withFlags:0];
	// verify
	assertThat(result1, is(@"[appledoc@gentlebytes.com](mailto:appledoc@gentlebytes.com)"));
	assertThat(result2, is(@"[appledoc@gentlebytes.com](mailto:appledoc@gentlebytes.com)"));
	assertThat(result3, is(@"[a@b.com](mailto:a@b.com) [c@d.com](mailto:c@d.com)"));
}

#pragma mark Combinations detection testing

- (void)testStringByConvertingCrossReferencesInString_shouldConvertClassAndProtocol {
	// setup
	GBClassData *class = [GBClassData classDataWithName:@"Class"];
	GBProtocolData *protocol = [GBProtocolData protocolDataWithName:@"Protocol"];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:protocol, class, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"Class Protocol" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"Protocol Class" withFlags:0];
	// verify
	assertThat(result1, is(@"[Class](Classes/Class.html) [Protocol](Protocols/Protocol.html)"));
	assertThat(result2, is(@"[Protocol](Protocols/Protocol.html) [Class](Classes/Class.html)"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertCategoryAndClass {
	// setup
	GBCategoryData *category = [GBCategoryData categoryDataWithName:@"Category" className:@"Class"];
	GBClassData *class = [GBClassData classDataWithName:@"Class"];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:category, class, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"Class(Category) Class" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"Class Class(Category)" withFlags:0];
	// verify
	assertThat(result1, is(@"[Class(Category)](Categories/Class(Category).html) [Class](Classes/Class.html)"));
	assertThat(result2, is(@"[Class](Classes/Class.html) [Class(Category)](Categories/Class(Category).html)"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldConvertCategoryAndProtocol {
	// setup - although it's not possible to do categories on protocols, we still test to properly cover these...
	GBCategoryData *category = [GBCategoryData categoryDataWithName:@"Category" className:@"Protocol"];
	GBProtocolData *protocol = [GBProtocolData protocolDataWithName:@"Protocol"];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:category, protocol, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"Protocol(Category) Protocol" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"Protocol Protocol(Category)" withFlags:0];
	// verify
	assertThat(result1, is(@"[Protocol(Category)](Categories/Protocol(Category).html) [Protocol](Protocols/Protocol.html)"));
	assertThat(result2, is(@"[Protocol](Protocols/Protocol.html) [Protocol(Category)](Categories/Protocol(Category).html)"));
}

#pragma mark Manual links detection testing

- (void)testStringByConvertingCrossReferencesInString_shouldKeepManualLinks {
	// setup
	GBCommentsProcessor *processor = [self processorWithStore:nil];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"[text](something)" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"[multi word](more words)" withFlags:0];
	// verify
	assertThat(result1, is(@"[text](something)"));
	assertThat(result2, is(@"[multi word](more words)"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldKeepManualURLLinks {
	// setup
	GBCommentsProcessor *processor = [self processorWithStore:nil];
	// execute
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"[text](http://ab.com)" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"[text](https://ab.com)" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"[text](ftp://ab.com)" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"[text](ftps://ab.com)" withFlags:0];
	NSString *result5 = [processor stringByConvertingCrossReferencesInString:@"[text](news://ab.com)" withFlags:0];
	NSString *result6 = [processor stringByConvertingCrossReferencesInString:@"[text](rss://ab.com)" withFlags:0];
	NSString *result7 = [processor stringByConvertingCrossReferencesInString:@"[text](mailto:a@b.com)" withFlags:0];
	// verify
	assertThat(result1, is(@"[text](http://ab.com)"));
	assertThat(result2, is(@"[text](https://ab.com)"));
	assertThat(result3, is(@"[text](ftp://ab.com)"));
	assertThat(result4, is(@"[text](ftps://ab.com)"));
	assertThat(result5, is(@"[text](news://ab.com)"));
	assertThat(result6, is(@"[text](rss://ab.com)"));
	assertThat(result7, is(@"[text](mailto:a@b.com)"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldKeepManualObjectLinksAndUpdateAddress {
	// setup
	GBClassData *class = [GBClassData classDataWithName:@"Class"];
	GBCategoryData *category = [GBCategoryData categoryDataWithName:@"Category" className:@"Class"];
	GBProtocolData *protocol = [GBProtocolData protocolDataWithName:@"Protocol"];
	GBDocumentData *document = [GBDocumentData documentDataWithContents:@"c" path:@"document.ext"];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:class, category, protocol, document, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store];
	// setup
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"[text](Class)" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"[text](Class(Category))" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"[text](Protocol)" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"[text](document)" withFlags:0];
	// verify
	assertThat(result1, is(@"[text](Classes/Class.html)"));
	assertThat(result2, is(@"[text](Categories/Class(Category).html)"));
	assertThat(result3, is(@"[text](Protocols/Protocol.html)"));
	assertThat(result4, is(@"[text](docs/document.html)"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldIgnoreKnownObjectsInManualLinkDescriptionOrTitle {
	// setup
	GBClassData *class = [GBClassData classDataWithName:@"Class"];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:class, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store];
	// setup
	NSString *result = [processor stringByConvertingCrossReferencesInString:@"[Class](Class \"Class\")" withFlags:0];
	// verify
	assertThat(result, is(@"[Class](Classes/Class.html \"Class\")"));
}

- (void)testStringByConvertingCrossReferencesInString_shouldHandleMarkdownLinkReferences {
	// setup
	GBClassData *class = [GBClassData classDataWithName:@"Class"];
	GBStore *store = [GBTestObjectsRegistry storeWithObjects:class, nil];
	GBCommentsProcessor *processor = [self processorWithStore:store];
	// setup
	NSString *result1 = [processor stringByConvertingCrossReferencesInString:@"[1]: http://ab.com" withFlags:0];
	NSString *result2 = [processor stringByConvertingCrossReferencesInString:@"[1]: http://ab.com \"title\"" withFlags:0];
	NSString *result3 = [processor stringByConvertingCrossReferencesInString:@"[1]: Class" withFlags:0];
	NSString *result4 = [processor stringByConvertingCrossReferencesInString:@"[1]: Class \"title\"" withFlags:0];
	NSString *result5 = [processor stringByConvertingCrossReferencesInString:@"[Class]: something" withFlags:0];
	NSString *result6 = [processor stringByConvertingCrossReferencesInString:@"[1]: something \"Class\"" withFlags:0];
	// verify
	assertThat(result1, is(@"[1]: http://ab.com"));
	assertThat(result2, is(@"[1]: http://ab.com \"title\""));
	assertThat(result3, is(@"[1]: Classes/Class.html"));
	assertThat(result4, is(@"[1]: Classes/Class.html \"title\""));
	assertThat(result5, is(@"[Class]: something"));
	assertThat(result6, is(@"[1]: something \"Class\""));
}

#pragma mark Creation methods

- (GBCommentsProcessor *)defaultProcessor {
	// Creates a new GBCommentsProcessor using real settings. Note that we disable embedding cross references to make test strings more readable.
	id settings = [GBTestObjectsRegistry realSettingsProvider];
	[settings setEmbedCrossReferencesWhenProcessingMarkdown:NO];
	return [GBCommentsProcessor processorWithSettingsProvider:settings];
}

- (GBCommentsProcessor *)processorWithStore:(id)store {
	// Creates a new GBCommentsProcessor using real settings and the given store.
	return [self processorWithStore:store context:nil];
}

- (GBCommentsProcessor *)processorWithStore:(id)store context:(id)context {
	// Creates a new GBCommentsProcessor using real settings and the given store and context. Note that we disable embedding cross references to make test strings more readable.
	id settings = [GBTestObjectsRegistry realSettingsProvider];
	[settings setEmbedCrossReferencesWhenProcessingMarkdown:NO];
	GBCommentsProcessor *result = [self defaultProcessor];
	[result setValue:store forKey:@"store"];
	[result setValue:context forKey:@"currentContext"];
	return result;
}

@end