Added filter option, fixes #70

Author: dyve

CHANGES.txt

@@ -1,3 +1,8 @@
+2.4.0 @ 2012-11-12
+Deprecated filterResults, use filter instead
+Allow filter to take function as argument
+Added processData to docs
+
 2.3.1 @ 2012-11-12
 Changed preventDefaultReturn to an integer option.
 

Makefile

@@ -4,4 +4,4 @@
 #
 
 autocomplete:
-	uglifyjs -nc ./src/jquery.autocomplete.js > ./src/jquery.autocomplete.min.js
+	uglifyjs ./src/jquery.autocomplete.js > ./src/jquery.autocomplete.min.js

demo/index.html

@@ -96,6 +96,25 @@
 			return processed;
         }
     });
+
+    $("#ac7").autocomplete({
+        data: [
+            ['Chico Marx'],
+            ['Harpo Marx'],
+            ['Groucho Marx'],
+        ],
+        filter: function(result, filter) {
+            var s = result.value.toLowerCase();
+            var f = filter.toLowerCase();
+            var p = s.indexOf(f);
+            if (p >= 0) {
+                // Start of text or after a whitespace
+                return p === 0 || !$.trim(s.substr(p - 1, 1));
+            }
+            return false;
+        }
+    });
+
 });
 
     </script>
@@ -158,8 +177,15 @@ <h2>Demo 6 (custom JSON processor)</h2>
         <input type="text" id="ac6">
     </form>
 
+    <h2>Demo 7 (custom filter)</h2>
+
+    <p>This demo uses the Marx Brothers and a custom filter.</p>
+
+    <form>
+        <input type="text" id="ac7">
+    </form>
+
     <p style="height: 100px" class="spacer">&nbsp;</p>
-    
 
     <hr>
 

doc/jquery.autocomplete.txt

@@ -138,7 +138,15 @@ autoFill (default value: false)
 	If this is set to true, the autocompleter will automatically fill the search box with the
 	first entry in the results.
 
+filter (default value: true)
+	If this is set to false, the autocompleter will consider every result a valid response.
+	If this is set to a function, the autocompleter will call that function for each result object
+	and expect a true/false (include / leave out) response.
+	At any other setting (including true), the autocompleter will filter the results using its
+	standard filter.
+
 filterResults (default value: true)
+	DEPRECATED; use filter instead
 	If this is set to true, the autocompleter will filter the results presented by the server,
 	selecting only those that begin with the user input.
 	If this is set to false, the autocompleter will consider every result from the server a
@@ -182,9 +190,12 @@ autoWidth  (default value: "min-width")
 	from interfering with your results width. Other sensible values are "min-width" (default) and "width".
 
 useDelimiter  (default value: false)
-  Whether or not to delimit separate autocomplete strings within the same input field with a
-  comma.  For example, you may want to allow the user to enter a comma separated list of values--and
-  each value will autocomplete without erasing the other delimited values in the input field.
+    Whether or not to delimit separate autocomplete strings within the same input field with a
+    comma.  For example, you may want to allow the user to enter a comma separated list of values--and
+    each value will autocomplete without erasing the other delimited values in the input field.
+
+processData  (default value: null)
+    This function will process all incoming data before anything else. Use this to alter incoming data.
 
 onError  (default value: null)
   A JavaScript function that will be called if there is an error in the AJAX request to a remote

src/jquery.autocomplete.js

@@ -68,6 +68,7 @@
         preventDefaultTab: 0,
         autoFill: false,
         filterResults: true,
+        filter: true,
         sortResults: true,
         sortFunction: null,
         onItemSelect: null,
@@ -677,13 +678,13 @@
     };
 
     /**
-     * Filter result
+     * Default filter for results
      * @param {Object} result
      * @param {String} filter
      * @returns {boolean} Include this result
      * @private
      */
-    $.Autocompleter.prototype.filterResult = function(result, filter) {
+    $.Autocompleter.prototype.defaultFilter = function(result, filter) {
         if (!result.value) {
             return false;
         }
@@ -704,6 +705,26 @@
         return true;
     };
 
+    /**
+     * Filter result
+     * @param {Object} result
+     * @param {String} filter
+     * @returns {boolean} Include this result
+     * @private
+     */
+    $.Autocompleter.prototype.filterResult = function(result, filter) {
+        // No filter
+        if (this.options.filter === false) {
+            return true;
+        }
+        // Custom filter
+        if ($.isFunction(this.options.filter)) {
+            return this.options.filter(result, filter);
+        }
+        // Default filter
+        return this.defaultFilter(result, filter);
+    };
+
     /**
      * Filter results
      * @param results