Add the beginnings of QueryKit.

9 files changed, 563 insertions, 0 deletions

diff --git a/Frameworks/QueryKit/QKQuery.h b/Frameworks/QueryKit/QKQuery.h
new file mode 100644
index 00000000..9fb7b0f2
--- /dev/null
+++ b/Frameworks/QueryKit/QKQuery.h
@@ -0,0 +1,83 @@
+//
+//  $Id$
+//
+//  QKQuery.h
+//  sequel-pro
+//
+//  Created by Stuart Connolly (stuconnolly.com) on September 4, 2011
+//  Copyright (c) 2011 Stuart Connolly. All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation; either version 2 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//
+//  More info at <http://code.google.com/p/sequel-pro/>
+
+#import "QKQueryTypes.h"
+#import "QKQueryOperators.h"
+
+@interface QKQuery : NSObject 
+{
+	NSString *_database;
+	NSString *_table;
+	
+	NSMutableString *_query;
+	NSMutableArray *_parameters;
+	NSMutableArray *_fields;
+	
+	QKQueryType _queryType;
+	
+	BOOL _quoteFields;
+}
+
+/**
+ *
+ */
+@property (readwrite, retain, getter=database, setter=setDatabase:) NSString *_database;
+
+/**
+ *
+ */
+@property (readwrite, retain, getter=table, setter=setTable:) NSString *_table; 
+
+/**
+ *
+ */
+@property (readwrite, retain, getter=parameters, setter=setParameters:) NSMutableArray *_parameters;
+
+/**
+ *
+ */
+@property (readwrite, retain, getter=fields, setter=setFields:) NSMutableArray *_fields;
+
+/**
+ *
+ */
+@property (readwrite, assign, getter=queryType, setter=setQueryType:) QKQueryType _queryType;
+
+/**
+ *
+ */
+@property (readwrite, assign, getter=quoteFields, setter=setQuoteFields:) BOOL _quoteFields;
+
++ (QKQuery *)queryTable:(NSString *)table;
++ (QKQuery *)selectQueryFromTable:(NSString *)table;
+
+- (id)initWithTable:(NSString *)table;
+
+- (NSString *)query;
+
+- (void)addField:(NSString *)field;
+- (void)addParameter:(NSString *)field operator:(QKQueryOperator *)op value:(id)value;
+
+@end
diff --git a/Frameworks/QueryKit/QKQuery.m b/Frameworks/QueryKit/QKQuery.m
new file mode 100644
index 00000000..1f0c5005
--- /dev/null
+++ b/Frameworks/QueryKit/QKQuery.m
@@ -0,0 +1,178 @@
+//
+//  $Id$
+//
+//  QKQuery.m
+//  sequel-pro
+//
+//  Created by Stuart Connolly (stuconnolly.com) on September 4, 2011
+//  Copyright (c) 2011 Stuart Connolly. All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation; either version 2 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//
+//  More info at <http://code.google.com/p/sequel-pro/>
+
+#import "QKQuery.h"
+
+static NSString *QKNoQueryTypeException = @"QKNoQueryType";
+
+@interface QKQuery ()
+
+- (NSString *)_buildQuery;
+- (NSString *)_buildFieldList;
+
+@end
+
+@implementation QKQuery
+
+@synthesize _database;
+@synthesize _table;
+@synthesize _parameters;
+@synthesize _queryType;
+@synthesize _fields;
+@synthesize _quoteFields;
+
+#pragma mark -
+#pragma mark Initialization
+
++ (QKQuery *)queryTable:(NSString *)table
+{
+	return [[[QKQuery alloc] initWithTable:table] autorelease];
+}
+
++ (QKQuery *)selectQueryFromTable:(NSString *)table
+{
+	QKQuery *query = [[[QKQuery alloc] initWithTable:table] autorelease];
+	
+	[query setQueryType:QKSelectQuery];
+	
+	return query;
+}
+
+- (id)initWithTable:(NSString *)table
+{
+	if ((self = [super init])) {
+		[self setTable:table];
+		[self setFields:[[NSMutableArray alloc] init]];
+		[self setParameters:[[NSMutableArray alloc] init]];
+		[self setQueryType:-1];
+		[self setQuoteFields:NO];
+		
+		_query = [[NSMutableString alloc] init];
+	}
+	
+	return self;
+}
+
+#pragma mark -
+#pragma mark Public API
+
+- (NSString *)query
+{
+	return _query ? [self _buildQuery] : @""; 
+}
+
+/**
+ * Shortcut for adding a new field to this query.
+ */
+- (void)addField:(NSString *)field
+{
+	[_fields addObject:field];
+}
+
+/**
+ * Shortcut for adding a new parameter to this query.
+ */
+- (void)addParameter:(NSString *)field operator:(QKQueryOperator *)op value:(id)value
+{
+	
+}
+
+#pragma mark -
+#pragma mark Private API
+
+/**
+ * Builds the actual query.
+ */
+- (NSString *)_buildQuery
+{
+	if (_queryType == -1) {
+		[NSException raise:QKNoQueryTypeException format:@"Attempt to build query with no query type specified."];
+	}
+	
+	if (_queryType == QKSelectQuery) {
+		[_query appendString:@"SELECT "];
+	}
+	
+	[_query appendString:[self _buildFieldList]];
+	
+	return _query;
+}
+
+/**
+ * Builds the string representation of the field list.
+ */
+- (NSString *)_buildFieldList
+{
+	NSMutableString *fields = [NSMutableString string];
+	
+	if ([_fields count] == 0) {
+		[fields appendString:@"*"];
+		
+		return fields;
+	}
+	
+	for (NSString *field in _fields)
+	{		
+		field = [field stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]];
+		
+		if ([field length] == 0) continue;
+		
+		if (_quoteFields) {
+			[fields appendString:@"`"];
+		}
+		
+		[fields appendString:field];
+		
+		if (_quoteFields) {
+			[fields appendString:@"`"];
+		}
+		
+		[fields appendString:@", "];
+	}
+	
+	if ([fields hasSuffix:@", "]) {
+		[fields setString:[fields substringToIndex:([fields length] - 2)]];
+	}
+	
+	return fields;
+}
+
+#pragma mark -
+
+- (NSString *)description
+{
+	return [self query];
+}
+
+#pragma mark -
+
+- (void)dealloc
+{
+	if (_query) [_query release], _query = nil;
+	
+	[super dealloc];
+}
+
+@end
diff --git a/Frameworks/QueryKit/QKQueryOperators.h b/Frameworks/QueryKit/QKQueryOperators.h
new file mode 100644
index 00000000..df9a88f9
--- /dev/null
+++ b/Frameworks/QueryKit/QKQueryOperators.h
@@ -0,0 +1,45 @@
+//
+//  $Id$
+//
+//  QKQueryOperators.h
+//  sequel-pro
+//
+//  Created by Stuart Connolly (stuconnolly.com) on September 4, 2011
+//  Copyright (c) 2011 Stuart Connolly. All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation; either version 2 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//
+//  More info at <http://code.google.com/p/sequel-pro/>
+
+/**
+ * Note that this is by no means complete list of available operators, only the most commonly used ones. Other
+ * operators can be added as and when they are required.
+ */
+typedef enum
+{
+	QKEqualityOperator,
+	QKNotEqualOperator,
+	QKLikeOperator,
+	QKNotLikeOperator,
+	QKInOperator,
+	QKNotInOperator,
+	QKIsNullOperator,
+	QKIsNotNullOperator,
+	QKGreaterThanOperator,
+	QKLessThanOperator,
+	QKGreaterThanOrEqualOperator,
+	QKLessThanOrEqualOperator
+}
+QKQueryOperator;
\ No newline at end of file
diff --git a/Frameworks/QueryKit/QKQueryParameter.h b/Frameworks/QueryKit/QKQueryParameter.h
new file mode 100644
index 00000000..781fbd87
--- /dev/null
+++ b/Frameworks/QueryKit/QKQueryParameter.h
@@ -0,0 +1,56 @@
+//
+//  $Id$
+//
+//  QKQueryParameter.h
+//  sequel-pro
+//
+//  Created by Stuart Connolly (stuconnolly.com) on September 4, 2011
+//  Copyright (c) 2011 Stuart Connolly. All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation; either version 2 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//
+//  More info at <http://code.google.com/p/sequel-pro/>
+
+#import "QKQueryOperators.h"
+
+@interface QKQueryParameter : NSObject 
+{
+	NSString *_field;
+	
+	QKQueryOperator _operator;
+	
+	id _value;
+}
+
+/**
+ *
+ */
+@property (readwrite, retain, getter=field, setter=setField:) NSString *_field;
+
+/**
+ *
+ */
+@property (readwrite, assign, getter=operator, setter=setOperator:) QKQueryOperator _operator;
+
+/**
+ *
+ */
+@property (readwrite, retain, getter=value, setter=setValue:) id _value;
+
++ (QKQueryParameter *)queryParamWithField:(NSString *)field operator:(QKQueryOperator)op value:(id)value;
+
+- (id)initParamWithField:(NSString *)field operator:(QKQueryOperator)op value:(id)value;
+
+@end
diff --git a/Frameworks/QueryKit/QKQueryParameter.m b/Frameworks/QueryKit/QKQueryParameter.m
new file mode 100644
index 00000000..c50cb5dd
--- /dev/null
+++ b/Frameworks/QueryKit/QKQueryParameter.m
@@ -0,0 +1,60 @@
+//
+//  $Id$
+//
+//  QKQueryParameter.m
+//  sequel-pro
+//
+//  Created by Stuart Connolly (stuconnolly.com) on September 4, 2011
+//  Copyright (c) 2011 Stuart Connolly. All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation; either version 2 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//
+//  More info at <http://code.google.com/p/sequel-pro/>
+
+#import "QKQueryParameter.h"
+
+@implementation QKQueryParameter
+
+@synthesize _field;
+@synthesize _operator;
+@synthesize _value;
+
++ (QKQueryParameter *)queryParamWithField:(NSString *)field operator:(QKQueryOperator)op value:(id)value
+{
+	return [[[QKQueryParameter alloc] initParamWithField:field operator:op value:value] autorelease];
+}
+
+- (id)initParamWithField:(NSString *)field operator:(QKQueryOperator)op value:(id)value
+{
+	if ((self = [super init])) {
+		[self setField:field];
+		[self setOperator:op];
+		[self setValue:value];
+	}
+	
+	return self;
+}
+
+#pragma mark -
+
+- (void)dealloc
+{
+	if (_field) [_field release], _field = nil;
+	if (_value) [_value release], _value = nil;
+	
+	[super dealloc];
+}
+
+@end
diff --git a/Frameworks/QueryKit/QKQueryTypes.h b/Frameworks/QueryKit/QKQueryTypes.h
new file mode 100644
index 00000000..51e918a9
--- /dev/null
+++ b/Frameworks/QueryKit/QKQueryTypes.h
@@ -0,0 +1,33 @@
+//
+//  $Id$
+//
+//  QKQueryTypes.h
+//  sequel-pro
+//
+//  Created by Stuart Connolly (stuconnolly.com) on September 4, 2011
+//  Copyright (c) 2011 Stuart Connolly. All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation; either version 2 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//
+//  More info at <http://code.google.com/p/sequel-pro/>
+
+typedef enum
+{
+	QKSelectQuery,
+	QKUpdateQuery,
+	QKInsertQuery,
+	QKDeleteQuery,
+}
+QKQueryType;
\ No newline at end of file
diff --git a/Frameworks/QueryKit/QKQueryUtilities.h b/Frameworks/QueryKit/QKQueryUtilities.h
new file mode 100644
index 00000000..f1a608cf
--- /dev/null
+++ b/Frameworks/QueryKit/QKQueryUtilities.h
@@ -0,0 +1,32 @@
+//
+//  $Id$
+//
+//  QKQueryUtilities.h
+//  sequel-pro
+//
+//  Created by Stuart Connolly (stuconnolly.com) on September 4, 2011
+//  Copyright (c) 2011 Stuart Connolly. All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation; either version 2 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//
+//  More info at <http://code.google.com/p/sequel-pro/>
+
+#import "QKQueryOperators.h"
+
+@interface QKQueryUtilities : NSObject 
+
++ (NSString *)operatorRepresentationForType:(QKQueryOperator)operator;
+
+@end
diff --git a/Frameworks/QueryKit/QKQueryUtilities.m b/Frameworks/QueryKit/QKQueryUtilities.m
new file mode 100644
index 00000000..f9f43f03
--- /dev/null
+++ b/Frameworks/QueryKit/QKQueryUtilities.m
@@ -0,0 +1,47 @@
+//
+//  $Id$
+//
+//  QKQueryUtilities.m
+//  sequel-pro
+//
+//  Created by Stuart Connolly (stuconnolly.com) on September 4, 2011
+//  Copyright (c) 2011 Stuart Connolly. All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation; either version 2 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//
+//  More info at <http://code.google.com/p/sequel-pro/>
+
+#import "QKQueryUtilities.h"
+
+@implementation QKQueryUtilities
+
++ (NSString *)operatorRepresentationForType:(QKQueryOperator)operator
+{
+	NSString *opString = nil;
+	
+	switch (operator) 
+	{
+		case QKEqualityOperator:
+			opString = @"=";
+			break;
+		default:
+			[NSException raise:@"" format:@"Unrecognised query operator type: %d", operator];
+			break;
+	}
+	
+	return opString;
+}
+
+@end
diff --git a/Frameworks/QueryKit/QueryKit.h b/Frameworks/QueryKit/QueryKit.h
new file mode 100644
index 00000000..8222fe28
--- /dev/null
+++ b/Frameworks/QueryKit/QueryKit.h
@@ -0,0 +1,29 @@
+//
+//  $Id$
+//
+//  QueryKit.h
+//  sequel-pro
+//
+//  Created by Stuart Connolly (stuconnolly.com) on September 4, 2011
+//  Copyright (c) 2011 Stuart Connolly. All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation; either version 2 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, write to the Free Software
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+//
+//  More info at <http://code.google.com/p/sequel-pro/>
+
+#import <QueryKit/QKQuery.h>
+#import <QueryKit/QKQueryTypes.h>
+#import <QueryKit/QKQueryOperators.h>
+#import <QueryKit/QKQueryParameter.h>