nano-store 0.2.4 → 0.3.0

data/vendor/Pods/NanoStore/Classes/Advanced/NSFNanoResult.h

@@ -0,0 +1,137 @@
+/*
+     NSFNanoResult.h
+     NanoStore
+     
+     Copyright (c) 2010 Webbo, L.L.C. 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.
+     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions
+     and the following disclaimer in the documentation and/or other materials provided with the distribution.
+     * Neither the name of Webbo 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.
+ */
+
+/*! @file NSFNanoResult.h
+ @brief A unit that describes the result of a search.
+ */
+
+/** @class NSFNanoResult
+ * A unit that describes the result of a search.
+ *
+ * @note
+ * The NanoResult is the object representation of a SQL result set. From it, you can obtain the number of rows, the column names and their
+ * associated values.
+ *
+ * @par
+ * After obtaining a NanoResult, it's always a good idea to check whether the <i>error</i> property is nil. If so, the result can be assumed to be
+ * correct. Otherwise, <i>error</i> will point to the main cause of failure.
+ *
+ * @details <b>Example:</b>
+ @code
+ // Instantiate a NanoStore and open it
+ NSFNanoStore *nanoStore = [NSFNanoStore createAndOpenStoreWithType:NSFMemoryStoreType path:nil error:nil];
+ 
+ // Add some data to the document store
+ NSDictionary *info = ...;
+ NSFNanoBag *bag = [NSFNanoBag bag];
+ NSFNanoObject *obj1 = [NSFNanoObject nanoObjectWithDictionary:info];
+ NSFNanoObject *obj2 = [NSFNanoObject nanoObjectWithDictionary:info];
+ [nanoStore addObjectsFromArray:[NSArray arrayWithObjects:obj1, obj2, nil] error:nil];
+ 
+ // Instantiate a search and execute the SQL statement
+ NSFNanoSearch *search = [NSFNanoSearch searchWithStore:nanoStore];
+ NSFNanoResult *result = [search executeSQL:@"SELECT COUNT(*) FROM NSFKEYS"];
+ 
+ // Obtain the result (given as an NSString)
+ NSString *value = [result firstValue];
+ 
+ // Close the document store
+ [nanoStore closeWithError:nil];
+ @endcode
+ */
+
+#import <Foundation/Foundation.h>
+
+@class NSFNanoStore;
+
+@interface NSFNanoResult : NSObject
+
+/** * Number of rows contained in the result set. */
+@property (nonatomic, assign, readonly) NSUInteger numberOfRows;
+/** * A reference to the error encountered while processing the request, otherwise nil if the request was successful. */
+@property (nonatomic, strong, readonly) NSError *error;
+
+/** @name Accessors
+ */
+
+//@{
+
+/** * Returns a new array containing the columns.
+ * @returns An array with the columns retrieved from the result set.
+ */
+
+- (NSArray *)columns;
+
+/** * Returns a new array containing the values for a given column.
+ * @param theIndex is the index of the value in the result set.
+ * @param theColumn is the name of the column in the result set.
+ * @returns An array with the values associated with a given column.
+ * @throws NSRangeException is thrown if the index is out of bounds.
+ */
+
+- (NSString *)valueAtIndex:(NSUInteger)theIndex forColumn:(NSString *)theColumn;
+
+/** * Returns a new array containing the values for a given column.
+ * @param theColumn is the name of the column in the result set.
+ * @returns An array with the values associated with a given column.
+ */
+
+- (NSArray *)valuesForColumn:(NSString *)theColumn;
+
+/** * Returns the first value.
+ * @returns The value of the first element from the result set.
+ */
+
+- (NSString *)firstValue;
+
+//@}
+
+/** @name Exporting the Results to a File
+ */
+
+//@{
+
+/** * Saves the result to a file.
+ * @param thePath is the location where the result will be saved to a file.
+ */
+
+- (void)writeToFile:(NSString *)thePath;
+
+//@}
+
+/** @name Miscellaneous
+ */
+
+//@{
+
+/** * Returns a string representation of the result.
+ */
+
+- (NSString *)description;
+
+//@}
+
+@end

data/vendor/Pods/NanoStore/Classes/Advanced/NSFNanoResult.m

@@ -0,0 +1,265 @@
+/*
+     NSFNanoResult.m
+     NanoStore
+     
+     Copyright (c) 2010 Webbo, L.L.C. 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.
+     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions
+     and the following disclaimer in the documentation and/or other materials provided with the distribution.
+     * Neither the name of Webbo 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 "NSFNanoResult.h"
+#import "NanoStore_Private.h"
+
+@implementation NSFNanoResult
+{
+@protected
+    /** \cond */
+    NSDictionary    *results;
+    /** \endcond */
+}
+
+@synthesize numberOfRows;
+@synthesize error;
+
+/** \cond */
+
+- (id)init
+{
+    if ((self = [super init])) {
+        [self _reset];
+    }
+    
+    return self;
+}
+
+- (void)dealloc
+{
+    [self _reset];
+}
+/** \endcond */
+
+- (NSString *)description
+{
+    NSUInteger numberOfColumns = [[results allKeys]count];
+    
+    NSMutableString *description = [NSMutableString string];
+    [description appendString:@"\n"];
+    [description appendString:[NSString stringWithFormat:@"Result address     : 0x%x\n", self]];
+    [description appendString:[NSString stringWithFormat:@"Number of columns  : %ld\n", numberOfColumns]];
+    if (nil == error)
+        if ([[self columns]count] > 0)
+            [description appendString:[NSString stringWithFormat:@"Columns            : %@\n", [[self columns]componentsJoinedByString:@", "]]];
+        else
+            [description appendString:[NSString stringWithFormat:@"Columns            : %@\n", @"()"]];
+        else
+            [description appendString:[NSString stringWithFormat:@"Columns            : %@\n", @"<column info not available>"]];
+    [description appendString:[NSString stringWithFormat:@"Number of rows     : %ld\n", numberOfRows]];
+    if (nil == error)
+        [description appendString:[NSString stringWithFormat:@"Error              : %@\n", @"<no error>"]];
+    else
+        [description appendString:[NSString stringWithFormat:@"Error              : %@\n", [error localizedDescription]]];
+    
+    // Print up to the first ten rows to help visualize the cursor
+    if (0 != numberOfColumns) {
+        [description appendString:@"Preview of contents:\n                     "];
+        NSUInteger i;
+        NSArray *columns = [self columns];
+        
+        // Print the names of the columns
+        [description appendString:[NSString stringWithFormat:@"%-15@ | ", @"Row #          "]];
+        for (i = 0; i < numberOfColumns; i++) {
+            const char *value = [[columns objectAtIndex:i]UTF8String];
+            if (numberOfColumns - 1 > i) {
+                [description appendString:[NSString stringWithFormat:@"%-15s | ", value]];
+            } else {
+                [description appendString:[NSString stringWithFormat:@"%-15s\n                     ", value]];
+            }
+        }
+        
+        // Print the underline
+        const char *value = "===============";
+        [description appendString:[NSString stringWithFormat:@"%-15s | ", value]];
+        for (i = 0; i < numberOfColumns; i++) {
+            if (numberOfColumns - 1 > i) {
+                [description appendString:[NSString stringWithFormat:@"%-15s | ", value]];
+            } else {
+                [description appendString:[NSString stringWithFormat:@"%-15s\n                     ", value]];
+            }
+        }
+        
+        // Print the preview of the contents
+        if (numberOfRows > 0) {
+            NSInteger numberOfRowsToPrint = numberOfRows;
+            NSUInteger j;
+            
+            if (numberOfRows > 100) {
+                numberOfRowsToPrint = 100;
+            }
+            
+            for (i = 0; i < numberOfRowsToPrint; i++) {
+                [description appendString:[NSString stringWithFormat:@"%-15ld | ", i]];
+                for (j = 0; j < numberOfColumns; j++) {
+                    NSString *columnName = [columns objectAtIndex:j];
+                    const char *value = "<plist data>    ";
+                    if (NO == [columnName hasSuffix:@"NSFPlist"]) {
+                        value = [[self valueAtIndex:i forColumn:columnName]UTF8String];
+                    }
+                    
+                    if (numberOfColumns - 1 > j) {
+                        [description appendString:[NSString stringWithFormat:@"%-15s | ", value]];
+                    } else {
+                        [description appendString:[NSString stringWithFormat:@"%-15s", value]];
+                    }
+                }
+                
+                [description appendString:@"\n                     "];
+            }
+        } else {
+            [description appendString:@"<no data available>"];
+        }
+    }
+    
+    return description;
+}
+
+#pragma mark -
+
+- (NSArray *)columns
+{
+    return [results allKeys];
+}
+
+- (NSString *)valueAtIndex:(NSUInteger)index forColumn:(NSString *)column
+{
+    return [[results objectForKey:column]objectAtIndex:index];
+}
+
+- (NSArray *)valuesForColumn:(NSString *)column
+{
+    NSArray *values = [results objectForKey:column];
+    
+    if (nil == values)
+        values = [NSArray array];
+    
+    return values;
+}
+
+- (NSString *)firstValue
+{
+    NSArray *columns = [results allKeys];
+    if (([columns count] > 0) && (numberOfRows > 0)) {
+        return [[results objectForKey:[columns objectAtIndex:0]]objectAtIndex:0];
+    }
+    
+    return nil;
+}
+
+- (NSError *)error
+{
+    return [error copy];
+}
+
+- (void)writeToFile:(NSString *)path;
+{
+    [results writeToFile:[path stringByExpandingTildeInPath] atomically:YES];
+}
+
+#pragma mark - Private Methods
+#pragma mark -
+
+/** \cond */
++ (NSFNanoResult *)_resultWithDictionary:(NSDictionary *)theResults
+{
+    return [[self alloc]_initWithDictionary:theResults];
+}
+
++ (NSFNanoResult *)_resultWithError:(NSError *)theError
+{
+    return [[self alloc]_initWithError:theError];
+}
+
+- (id)_initWithDictionary:(NSDictionary *)theResults
+{
+    if (nil == theResults)
+        [[NSException exceptionWithName:NSFUnexpectedParameterException
+                                 reason:[NSString stringWithFormat:@"*** -[%@ %s]: theResults is nil.", [self class], _cmd]
+                               userInfo:nil]raise];
+    
+    if ([theResults respondsToSelector:@selector(objectForKey:)] == NO)
+        [[NSException exceptionWithName:NSFUnexpectedParameterException
+                                 reason:[NSString stringWithFormat:@"*** -[%@ %s]: theResults is not of type NSDictionary.", [self class], _cmd]
+                               userInfo:nil]raise];
+    
+    if ((self = [self init])) {
+        results = theResults;
+        [self _calculateNumberOfRows];
+    }
+    
+    return self;
+}
+
+- (id)_initWithError:(NSError *)theError
+{
+    if (nil == theError)
+        [[NSException exceptionWithName:NSFUnexpectedParameterException
+                                 reason:[NSString stringWithFormat:@"*** -[%@ %s]: theError is nil.", [self class], _cmd]
+                               userInfo:nil]raise];
+    
+    if ([theError respondsToSelector:@selector(localizedDescription)] == NO)
+        [[NSException exceptionWithName:NSFUnexpectedParameterException
+                                 reason:[NSString stringWithFormat:@"*** -[%@ %s]: theError is not of type NSError.", [self class], _cmd]
+                               userInfo:nil]raise];
+    
+    if ((self = [self init])) {
+        error = theError;
+        [self _calculateNumberOfRows];
+    }
+    
+    return self;
+}
+
+- (void)_setError:(NSError *)theError
+{
+    if (error != theError) {
+        error = theError;
+    }
+}
+
+- (void)_reset
+{
+    numberOfRows = -1;
+    results = nil;
+    error = nil;
+}
+
+- (void)_calculateNumberOfRows
+{
+    // We cache the value once, for performance reasons
+    if (-1 == numberOfRows) {
+        NSArray *allKeys = [results allKeys];
+        if ([allKeys count] == 0)
+            numberOfRows = 0;
+        else
+            numberOfRows = [[results objectForKey:[allKeys lastObject]]count];
+    }
+}
+/** \endcond */
+
+@end

data/vendor/Pods/NanoStore/Classes/Private/NSFNanoBag_Private.h

@@ -0,0 +1,37 @@
+/*
+     NSFNanoBag_Private.h
+     NanoStore
+     
+     Copyright (c) 2010 Webbo, L.L.C. 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.
+     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions
+     and the following disclaimer in the documentation and/or other materials provided with the distribution.
+     * Neither the name of Webbo 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 "NSFNanoBag.h"
+
+/** \cond */
+
+@interface NSFNanoBag (Private)
+- (void)_setStore:(NSFNanoStore *)aStore;
+- (BOOL)_saveInStore:(NSFNanoStore *)someStore error:(out NSError **)outError;
+- (void)_inflateObjectsWithKeys:(NSArray *)someKeys;
+@end
+
+/** \endcond */

data/vendor/Pods/NanoStore/Classes/Private/NSFNanoEngine_Private.h

@@ -0,0 +1,69 @@
+/*
+ *  NSFNanoEngine_Private.h
+ *  A lightweight Cocoa wrapper for SQLite
+ *  
+ *  Written by Tito Ciuro (21-Jan-2003)
+
+	Copyright (c) 2004, Tito Ciuro
+	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.
+	• 	Redistributions in binary form must reproduce the above copyright notice, this list of conditions
+		and the following disclaimer in the documentation and/or other materials provided with the distribution.
+	• 	Neither the name of Tito Ciuro 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 "NSFNanoEngine.h"
+#import "NSFNanoGlobals_Private.h"
+#import "NSFNanoResult.h"
+
+/** \cond */
+
+@interface NSFNanoEngine (Private)
++ (NSArray *)NSFP_sharedROWIDKeywords;
+- (NSString *)NSFP_cacheMethodToString;
+- (NSString*)NSFP_nestedDescriptionWithPrefixedSpace:(NSString *)prefixedSpace;
++ (NSDictionary *)_plistToDictionary:(NSString *)aPlist;
+- (NSFNanoDatatype)NSFP_datatypeForTable:(NSString *)table column:(NSString *)column;
++ (void)NSFP_decodeQuantum:(unsigned char *)dest andSource:(const char *)src;
+- (void)NSFP_setFullColumnNamesEnabled;
+- (NSArray *)NSFP_flattenAllTables;
+- (NSInteger)NSFP_prepareSQLite3Statement:(sqlite3_stmt **)aStatement theSQLStatement:(NSString *)aSQLQuery;
+- (NSFNanoDatatype)NSFP_datatypeForColumn:(NSString *)tableAndColumn;
++ (int)NSFP_stripBitsFromExtendedResultCode:(int)extendedResult;
+
+- (BOOL)NSFP_beginTransactionMode:(NSString *)theSQLStatement;
+- (BOOL)NSFP_createTable:(NSString *)table withColumns:(NSArray *)tableColumns datatypes:(NSArray *)tableDatatypes isTemporary:(BOOL)isTemporaryFlag;
+- (BOOL)NSFP_removeColumn:(NSString *)column fromTable:(NSString *)table;
+- (void)NSFP_rebuildDatatypeCache;
+- (BOOL)NSFP_insertStringValues:(NSArray *)values forColumns:(NSArray *)columns table:(NSString *)table;
+
+- (void)NSFP_sqlString:(NSMutableString*)theSQLStatement appendingTags:(NSArray *)tags quoteTags:(BOOL)flag;
+- (void)NSFP_sqlString:(NSMutableString*)theSQLStatement appendingTags:(NSArray *)columns;
+- (BOOL)NSFP_sqlString:(NSMutableString*)theSQLStatement forTable:(NSString *)table withColumns:(NSArray *)columns datatypes:(NSArray *)datatypes;
+
+- (NSInteger)NSFP_ROWIDPresenceLocation:(NSArray *)tableColumns datatypes:(NSArray *)datatypes;
+- (BOOL)NSFP_isColumnROWIDAlias:(NSString *)column forTable:(NSString *)table;
+
+- (NSString *)NSFP_prefixWithDotDelimiter:(NSString *)tableAndColumn;
+- (NSString *)NSFP_suffixWithDotDelimiter:(NSString *)tableAndColumn;
+
+- (void)NSFP_installCommitCallback;
+- (void)NSFP_uninstallCommitCallback;
+@end
+
+/** \endcond */