Merge branch 'itemFiltering' of https://github.com/NOLTELAUTH/XToDo into NOLTELAUTH-itemFiltering

Travis · Travis · commit 2262b1670aee · 2015-09-18T10:51:53.000+08:00
* 'itemFiltering' of https://github.com/NOLTELAUTH/XToDo: Added a search bar to the main interface that allows the user to filter through the results. All items containing either the whole search phrase or at least all the search words (separated by space) are retrieved and displayed.
diff --git a/XToDo.xcodeproj/project.pbxproj b/XToDo.xcodeproj/project.pbxproj
@@ -34,6 +34,8 @@
 		6EB64F0A18947A5D00EA6B86 /* XToDoPreferencesWindowController.xib in Resources */ = {isa = PBXBuildFile; fileRef = 6EFEA8AE1894757200FD9595 /* XToDoPreferencesWindowController.xib */; };
 		6EFEA8AF1894757200FD9595 /* XToDoPreferencesWindowController.m in Sources */ = {isa = PBXBuildFile; fileRef = 6EFEA8AD1894757200FD9595 /* XToDoPreferencesWindowController.m */; };
 		6EFEA8B01894757200FD9595 /* XToDoPreferencesWindowController.xib in Resources */ = {isa = PBXBuildFile; fileRef = 6EFEA8AE1894757200FD9595 /* XToDoPreferencesWindowController.xib */; };
+		814ABA721AD1A602004CD467 /* NSString+Additions.m in Sources */ = {isa = PBXBuildFile; fileRef = 816AE24E1AD1A44F003A8FCA /* NSString+Additions.m */; };
+		814ABA731AD1A603004CD467 /* NSString+Additions.m in Sources */ = {isa = PBXBuildFile; fileRef = 816AE24E1AD1A44F003A8FCA /* NSString+Additions.m */; };
 		C338F4DE18F4FBAF00EDE66E /* PathEditViewController.m in Sources */ = {isa = PBXBuildFile; fileRef = C338F4DD18F4FBAF00EDE66E /* PathEditViewController.m */; };
 		C338F4DF18F4FBAF00EDE66E /* PathEditViewController.m in Sources */ = {isa = PBXBuildFile; fileRef = C338F4DD18F4FBAF00EDE66E /* PathEditViewController.m */; };
 		C338F4E118F4FD8700EDE66E /* PathEditViewController.xib in Resources */ = {isa = PBXBuildFile; fileRef = C338F4E018F4FD8700EDE66E /* PathEditViewController.xib */; };
@@ -80,6 +82,8 @@
 		6EFEA8AC1894757200FD9595 /* XToDoPreferencesWindowController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = XToDoPreferencesWindowController.h; sourceTree = "<group>"; };
 		6EFEA8AD1894757200FD9595 /* XToDoPreferencesWindowController.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = XToDoPreferencesWindowController.m; sourceTree = "<group>"; };
 		6EFEA8AE1894757200FD9595 /* XToDoPreferencesWindowController.xib */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.xib; path = XToDoPreferencesWindowController.xib; sourceTree = "<group>"; };
+		816AE24D1AD1A44F003A8FCA /* NSString+Additions.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "NSString+Additions.h"; sourceTree = "<group>"; };
+		816AE24E1AD1A44F003A8FCA /* NSString+Additions.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "NSString+Additions.m"; sourceTree = "<group>"; };
 		C338F4DC18F4FBAF00EDE66E /* PathEditViewController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = PathEditViewController.h; sourceTree = "<group>"; };
 		C338F4DD18F4FBAF00EDE66E /* PathEditViewController.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = PathEditViewController.m; sourceTree = "<group>"; };
 		C338F4E018F4FD8700EDE66E /* PathEditViewController.xib */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.xib; path = PathEditViewController.xib; sourceTree = "<group>"; };
@@ -164,6 +168,8 @@
 				6EFEA8AE1894757200FD9595 /* XToDoPreferencesWindowController.xib */,
 				C360639F18EBDCE000F500EA /* NSData+Split.h */,
 				C36063A018EBDCE000F500EA /* NSData+Split.m */,
+				816AE24D1AD1A44F003A8FCA /* NSString+Additions.h */,
+				816AE24E1AD1A44F003A8FCA /* NSString+Additions.m */,
 			);
 			path = XToDo;
 			sourceTree = "<group>";
@@ -318,6 +324,7 @@
 			buildActionMask = 2147483647;
 			files = (
 				C36063A118EBDCE000F500EA /* NSData+Split.m in Sources */,
+				814ABA731AD1A603004CD467 /* NSString+Additions.m in Sources */,
 				1F67ED4A1846E54F00E9E6AD /* XToDo.m in Sources */,
 				C338F4DE18F4FBAF00EDE66E /* PathEditViewController.m in Sources */,
 				6EFEA8AF1894757200FD9595 /* XToDoPreferencesWindowController.m in Sources */,
@@ -334,6 +341,7 @@
 				C3417AF118F6A871003297B8 /* XToDo.m in Sources */,
 				6EB64F09189479D800EA6B86 /* XToDoPreferencesWindowController.m in Sources */,
 				C3F4610018F43BE10009D503 /* ProjectSetting.m in Sources */,
+				814ABA721AD1A602004CD467 /* NSString+Additions.m in Sources */,
 				C36063A218EBDCE000F500EA /* NSData+Split.m in Sources */,
 				1FCB6EB21851D481002E6BC3 /* XToDoWindowController.m in Sources */,
 				1FCB6E951851D45B002E6BC3 /* XTAppDelegate.m in Sources */,
diff --git a/XToDo/NSString+Additions.h b/XToDo/NSString+Additions.h
@@ -0,0 +1,16 @@
+//
+//  NSString+Additions.h
+//  XToDo
+//
+//  Created by Gregory Catellani on 05/04/15.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface NSString (Additions)
+
+#pragma mark - NSStringExtensionMethods
+
+- (BOOL) xtodo_containsStringOrSubstrings:(NSString *)string seperatedByString:(NSString *)separator;
+
+@end
diff --git a/XToDo/NSString+Additions.m b/XToDo/NSString+Additions.m
@@ -0,0 +1,54 @@
+//
+//  NSString+Additions.m
+//  XToDo
+//
+//  Created by Gregory Catellani on 05/04/15.
+//
+
+#import "NSString+Additions.h"
+
+@implementation NSString (Additions)
+
+#pragma mark - NSStringExtensionMethods
+
+- (BOOL) xtodo_containsStringOrSubstrings:(NSString *)string seperatedByString:(NSString *)separator
+{
+    NSParameterAssert(separator);
+
+    // Remove any trailing occurences of the separator
+    string = [string stringByTrimmingCharactersInSet:[NSCharacterSet characterSetWithCharactersInString:separator]];
+
+    BOOL result = YES;
+
+    if(string.length > 0)
+    {
+        // Check if self is entirely made of string => returns YES in that case
+        if ([self rangeOfString:string options:NSCaseInsensitiveSearch].location == NSNotFound)
+        {
+            // Check if self contains the substrings provided in string
+            NSArray *substrings = [string componentsSeparatedByString:separator];
+            if(substrings.count > 1)
+            {
+                for(NSString *substring in substrings)
+                {
+                    if([self rangeOfString:substring options:NSCaseInsensitiveSearch].location == NSNotFound)
+                    {
+                        result = NO;
+                        break;
+                    }
+                }
+            }
+            else
+            {
+                result = NO;
+            }
+        }
+    }
+    else
+    {
+        result = NO;
+    }
+    return result;
+}
+
+@end
diff --git a/XToDo/XToDo-Prefix.pch b/XToDo/XToDo-Prefix.pch
@@ -6,4 +6,7 @@
 
 #ifdef __OBJC__
     #import <Foundation/Foundation.h>
+
+    // Import common class additions
+    #import "NSString+Additions.h"
 #endif
diff --git a/XToDo/XToDoModel.h b/XToDo/XToDoModel.h
@@ -146,7 +146,7 @@
 + (IDEWorkspaceTabController*)tabController;
 + (IDESourceCodeEditor*)currentEditor;
 
-+ (NSArray*)findItemsWithProjectSetting:(ProjectSetting*)projectSetting projectPath:(NSString*)ProjectPath;
++ (NSArray*)findItemsWithProjectSetting:(ProjectSetting*)projectSetting projectPath:(NSString*)ProjectPath containingContentString:(NSString *)filterString;
 
 + (BOOL)openItem:(XToDoItem*)item;
 
diff --git a/XToDo/XToDoModel.m b/XToDo/XToDoModel.m
@@ -217,6 +217,7 @@ + (NSArray*)findItemsWithProjectPath:(NSString*)projectPath
                          excludeDirs:(NSArray*)excludeDirs
                            fileTypes:(NSSet*)fileTypes
                         tempFilePath:(NSString*)tempFilePath
+                        containingContentString:(NSString *)filterString
 {
     // find all files match dirs and extnames
     NSArray* filePaths = [XToDoModel findFileNameWithProjectPath:projectPath
@@ -267,10 +268,14 @@ + (NSArray*)findItemsWithProjectPath:(NSString*)projectPath
     NSMutableArray* arr = [NSMutableArray array];
     for (NSString* line in results) {
         if (line.length > 4) {
-            id anItem = [self itemFromLine:line];
+            XToDoItem *anItem = [self itemFromLine:line];
 
             if (nil != anItem) {
-                [arr addObject:anItem];
+                // Filter out items that do not contain our search string
+                if(!filterString || filterString.length == 0 || [anItem.content xtodo_containsStringOrSubstrings:filterString seperatedByString:@" "])
+                {
+                    [arr addObject:anItem];
+                }
             }
         }
     }
@@ -279,6 +284,7 @@ + (NSArray*)findItemsWithProjectPath:(NSString*)projectPath
 
 + (NSArray*)findItemsWithProjectSetting:(ProjectSetting*)projectSetting
                             projectPath:(NSString*)projectPath
+                            containingContentString:(NSString *)filterString
 {
     NSArray* includeDirs = [projectSetting includeDirs];
     if ([includeDirs count] == 0) {
@@ -296,7 +302,8 @@ + (NSArray*)findItemsWithProjectSetting:(ProjectSetting*)projectSetting
                            fileTypes:[NSSet setWithObjects:@"H", @"hpp", @"M",
                                                            @"Mm", @"c", @"cpp",
                                                            @"cc", @"swift", nil]
-                        tempFilePath:tempFilePath];
+                        tempFilePath:tempFilePath
+                        containingContentString:filterString];
     }
     @catch (NSException* exception)
     {
diff --git a/XToDo/XToDoWindowController.h b/XToDo/XToDoWindowController.h
@@ -21,4 +21,11 @@
 - (void)setSearchRootDir:(NSString*)searchRootDir projectName:(NSString*)projectName;
 
 - (IBAction)refresh:(id)sender;
+
+
+#pragma mark - Result filtering
+
+@property (weak) IBOutlet NSSearchField *filterResultsSearchField;
+- (IBAction)filterResults:(id)sender;
+
 @end
diff --git a/XToDo/XToDoWindowController.m b/XToDo/XToDoWindowController.m
@@ -138,6 +138,8 @@ - (void)windowDidLoad
                                              selector:@selector(_onNotifyProjectSettingChanged:)
                                                  name:kNotifyProjectSettingChanged
                                                object:nil];
+
+    [self.window makeFirstResponder:self.listView];
 }
 
 - (void)dealloc
@@ -210,10 +212,10 @@ - (IBAction)refresh:(id)sender
     [self.workingIndicator setHidden:NO];
     [self.workingIndicator startAnimation:nil];
 
+    __block NSString *filterString = self.filterResultsSearchField ? self.filterResultsSearchField.stringValue : @"";
     dispatch_async(dispatch_get_global_queue(0, 0), ^{
         ProjectSetting *projectSetting = [XToDoModel projectSettingByProjectName:self.projectName];
-        NSArray *items = [XToDoModel findItemsWithProjectSetting:projectSetting
-                                                     projectPath:self.projectPath];
+        NSArray *items = [XToDoModel findItemsWithProjectSetting:projectSetting projectPath:self.projectPath containingContentString:filterString];
         dispatch_async(dispatch_get_main_queue(), ^{
             self.items=items;
             [self.workingIndicator setHidden:YES];
@@ -326,4 +328,14 @@ - (void)outlineViewSelectionDidChange:(NSNotification*)notification
     }
 }
 
+
+#pragma mark - Result filtering
+
+- (IBAction)filterResults:(id)sender
+{
+    if(sender == self.filterResultsSearchField)
+    {
+        [self refresh:nil];
+    }
+}
 @end
diff --git a/XToDo/XToDoWindowController.xib b/XToDo/XToDoWindowController.xib
@@ -1,19 +1,20 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<document type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="3.0" toolsVersion="5053" systemVersion="13C64" targetRuntime="MacOSX.Cocoa" propertyAccessControl="none">
+<document type="com.apple.InterfaceBuilder3.Cocoa.XIB" version="3.0" toolsVersion="7528.3" systemVersion="14C1514" targetRuntime="MacOSX.Cocoa" propertyAccessControl="none">
     <dependencies>
-        <deployment defaultVersion="1080" identifier="macosx"/>
-        <plugIn identifier="com.apple.InterfaceBuilder.CocoaPlugin" version="5053"/>
+        <deployment identifier="macosx"/>
+        <plugIn identifier="com.apple.InterfaceBuilder.CocoaPlugin" version="7528.3"/>
     </dependencies>
     <objects>
         <customObject id="-2" userLabel="File's Owner" customClass="XToDoWindowController">
             <connections>
+                <outlet property="filterResultsSearchField" destination="ab7-DL-Ufn" id="Es3-AX-5qb"/>
                 <outlet property="listView" destination="IEj-77-EWU" id="htK-fg-Mgu"/>
                 <outlet property="window" destination="1" id="3"/>
                 <outlet property="workingIndicator" destination="LeC-Ui-Mbv" id="NsN-U2-NNt"/>
             </connections>
         </customObject>
         <customObject id="-1" userLabel="First Responder" customClass="FirstResponder"/>
-        <customObject id="-3" userLabel="Application"/>
+        <customObject id="-3" userLabel="Application" customClass="NSObject"/>
         <window title="ToDo List" allowsToolTipsWhenApplicationIsInactive="NO" autorecalculatesKeyViewLoop="NO" restorable="NO" oneShot="NO" releasedWhenClosed="NO" animationBehavior="default" id="1" customClass="NSPanel">
             <windowStyleMask key="styleMask" titled="YES" closable="YES" resizable="YES" texturedBackground="YES"/>
             <windowCollectionBehavior key="collectionBehavior" moveToActiveSpace="YES" transient="YES" fullScreenAuxiliary="YES"/>
@@ -25,17 +26,29 @@
                 <rect key="frame" x="0.0" y="0.0" width="320" height="400"/>
                 <autoresizingMask key="autoresizingMask"/>
                 <subviews>
-                    <scrollView borderType="none" autohidesScrollers="YES" horizontalLineScroll="24" horizontalPageScroll="10" verticalLineScroll="24" verticalPageScroll="10" usesPredominantAxisScrolling="NO" id="GTU-oT-VnD">
-                        <rect key="frame" x="0.0" y="0.0" width="320" height="400"/>
+                    <searchField wantsLayer="YES" verticalHuggingPriority="750" id="ab7-DL-Ufn">
+                        <rect key="frame" x="1" y="380" width="317" height="22"/>
+                        <autoresizingMask key="autoresizingMask" widthSizable="YES" flexibleMinY="YES"/>
+                        <searchFieldCell key="cell" scrollable="YES" lineBreakMode="clipping" selectable="YES" editable="YES" borderStyle="bezel" placeholderString="Filter results" usesSingleLineMode="YES" bezelStyle="round" sendsSearchStringImmediately="YES" maximumRecents="10" id="s1O-JS-boD">
+                            <font key="font" metaFont="system"/>
+                            <color key="textColor" name="controlTextColor" catalog="System" colorSpace="catalog"/>
+                            <color key="backgroundColor" name="textBackgroundColor" catalog="System" colorSpace="catalog"/>
+                        </searchFieldCell>
+                        <connections>
+                            <action selector="filterResults:" target="-2" id="o3r-MP-Jvc"/>
+                        </connections>
+                    </searchField>
+                    <scrollView borderType="none" autohidesScrollers="YES" horizontalLineScroll="26" horizontalPageScroll="10" verticalLineScroll="26" verticalPageScroll="10" usesPredominantAxisScrolling="NO" id="GTU-oT-VnD">
+                        <rect key="frame" x="0.0" y="0.0" width="320" height="378"/>
                         <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
-                        <clipView key="contentView" id="d4x-zJ-UU4">
+                        <clipView key="contentView" drawsBackground="NO" id="d4x-zJ-UU4">
                             <rect key="frame" x="0.0" y="0.0" width="320" height="400"/>
                             <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
                             <subviews>
-                                <outlineView verticalHuggingPriority="750" allowsExpansionToolTips="YES" columnAutoresizingStyle="lastColumnOnly" selectionHighlightStyle="sourceList" multipleSelection="NO" autosaveColumns="NO" rowHeight="24" rowSizeStyle="systemDefault" viewBased="YES" indentationPerLevel="16" outlineTableColumn="poP-lE-uPQ" id="IEj-77-EWU">
-                                    <rect key="frame" x="0.0" y="0.0" width="320" height="400"/>
+                                <outlineView appearanceType="vibrantLight" verticalHuggingPriority="750" allowsExpansionToolTips="YES" columnAutoresizingStyle="lastColumnOnly" selectionHighlightStyle="sourceList" multipleSelection="NO" autosaveColumns="NO" rowHeight="24" rowSizeStyle="systemDefault" viewBased="YES" indentationPerLevel="16" outlineTableColumn="poP-lE-uPQ" id="IEj-77-EWU">
+                                    <rect key="frame" x="0.0" y="0.0" width="320" height="0.0"/>
                                     <autoresizingMask key="autoresizingMask"/>
-                                    <size key="intercellSpacing" width="3" height="0.0"/>
+                                    <size key="intercellSpacing" width="3" height="2"/>
                                     <color key="backgroundColor" name="_sourceListBackgroundColor" catalog="System" colorSpace="catalog"/>
                                     <color key="gridColor" name="gridColor" catalog="System" colorSpace="catalog"/>
                                     <tableColumns>
@@ -79,19 +92,17 @@
                                     </connections>
                                 </outlineView>
                             </subviews>
-                            <color key="backgroundColor" name="controlBackgroundColor" catalog="System" colorSpace="catalog"/>
+                            <nil key="backgroundColor"/>
                         </clipView>
                         <scroller key="horizontalScroller" hidden="YES" verticalHuggingPriority="750" horizontal="YES" id="ubv-eb-ya8">
-                            <rect key="frame" x="0.0" y="-16" width="0.0" height="16"/>
                             <autoresizingMask key="autoresizingMask"/>
                         </scroller>
                         <scroller key="verticalScroller" hidden="YES" verticalHuggingPriority="750" horizontal="NO" id="1HN-5v-iEX">
-                            <rect key="frame" x="-16" y="0.0" width="16" height="0.0"/>
                             <autoresizingMask key="autoresizingMask"/>
                         </scroller>
                     </scrollView>
                     <progressIndicator hidden="YES" horizontalHuggingPriority="750" verticalHuggingPriority="750" maxValue="100" bezeled="NO" indeterminate="YES" controlSize="small" style="spinning" id="LeC-Ui-Mbv">
-                        <rect key="frame" x="292" y="382" width="16" height="16"/>
+                        <rect key="frame" x="292" y="362" width="16" height="16"/>
                         <autoresizingMask key="autoresizingMask" flexibleMaxX="YES" flexibleMinY="YES"/>
                     </progressIndicator>
                 </subviews>
@@ -132,11 +143,12 @@
             <connections>
                 <outlet property="delegate" destination="-2" id="4"/>
             </connections>
+            <point key="canvasLocation" x="149" y="435"/>
         </window>
     </objects>
     <resources>
         <image name="NSFolder" width="32" height="32"/>
-        <image name="NSFollowLinkFreestandingTemplate" width="10" height="10"/>
-        <image name="NSMenuOnStateTemplate" width="11" height="11"/>
+        <image name="NSFollowLinkFreestandingTemplate" width="14" height="14"/>
+        <image name="NSMenuOnStateTemplate" width="12" height="12"/>
     </resources>
 </document>
diff --git a/XToDoApp/XToDoApp-Prefix.pch b/XToDoApp/XToDoApp-Prefix.pch
@@ -6,4 +6,7 @@
 
 #ifdef __OBJC__
     #import <Cocoa/Cocoa.h>
+
+    // Import common class additions
+    #import "NSString+Additions.h"
 #endif

Original file line number	Diff line number	Diff line change
`@@ -217,6 +217,7 @@ + (NSArray)findItemsWithProjectPath:(NSString)projectPath`
`217`	`217`	`excludeDirs:(NSArray*)excludeDirs`
`218`	`218`	`fileTypes:(NSSet*)fileTypes`
`219`	`219`	`tempFilePath:(NSString*)tempFilePath`
	`220`	`+ containingContentString:(NSString *)filterString`
`220`	`221`	`{`
`221`	`222`	`// find all files match dirs and extnames`
`222`	`223`	`NSArray* filePaths = [XToDoModel findFileNameWithProjectPath:projectPath`
`@@ -267,10 +268,14 @@ + (NSArray)findItemsWithProjectPath:(NSString)projectPath`
`267`	`268`	`NSMutableArray* arr = [NSMutableArray array];`
`268`	`269`	`for (NSString* line in results) {`
`269`	`270`	`if (line.length > 4) {`
`270`		`- id anItem = [self itemFromLine:line];`
	`271`	`+ XToDoItem *anItem = [self itemFromLine:line];`
`271`	`272`
`272`	`273`	`if (nil != anItem) {`
`273`		`- [arr addObject:anItem];`
	`274`	`+ // Filter out items that do not contain our search string`
	`275`	`+ if(!filterString \|\| filterString.length == 0 \|\| [anItem.content xtodo_containsStringOrSubstrings:filterString seperatedByString:@" "])`
	`276`	`+ {`
	`277`	`+ [arr addObject:anItem];`
	`278`	`+ }`
`274`	`279`	`}`
`275`	`280`	`}`
`276`	`281`	`}`
`@@ -279,6 +284,7 @@ + (NSArray)findItemsWithProjectPath:(NSString)projectPath`
`279`	`284`
`280`	`285`	`+ (NSArray)findItemsWithProjectSetting:(ProjectSetting)projectSetting`
`281`	`286`	`projectPath:(NSString*)projectPath`
	`287`	`+ containingContentString:(NSString *)filterString`
`282`	`288`	`{`
`283`	`289`	`NSArray* includeDirs = [projectSetting includeDirs];`
`284`	`290`	`if ([includeDirs count] == 0) {`
`@@ -296,7 +302,8 @@ + (NSArray)findItemsWithProjectSetting:(ProjectSetting)projectSetting`
`296`	`302`	`fileTypes:[NSSet setWithObjects:@"H", @"hpp", @"M",`
`297`	`303`	`@"Mm", @"c", @"cpp",`
`298`	`304`	`@"cc", @"swift", nil]`
`299`		`- tempFilePath:tempFilePath];`
	`305`	`+ tempFilePath:tempFilePath`
	`306`	`+ containingContentString:filterString];`
`300`	`307`	`}`
`301`	`308`	`@catch (NSException* exception)`
`302`	`309`	`{`