flo

<!DOCTYPE html> <html> <head> <title>index.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> index.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> <a href="https://github.com/FLOChip/flo">flo</a> is an redis powered node.js autocompleter inspired by <a href="https://github.com/seatgeek/soulmate">soulmate</a>. You can check out some examples <a href="https://github.com/FLOChip/flo/tree/master/examples">here</a>. </td> <td class="code"> <div class="highlight"><pre>_ = require "underscore" async = require "async"</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> Sets up a new Redis Connection. options - Optional Hash of options. <ul> <li><code>redis</code> - An existing redis connection to use.</li> <li><code>host</code> - String Redis host. (Default: Redis' default)</li> <li><code>port</code> - Integer Redis port. (Default: Redis' default)</li> <li><code>password</code> - String Redis password.</li> <li><code>namespace</code> - String namespace prefix for Redis keys. (Default: flo).</li> <li><code>mincomplete</code> - Minimum completion of keys required for auto completion. (Default: 1)</li> <li><code>database</code> - Integer of the Redis database to select.</li> </ul> Returns a Connection instance. </td> <td class="code"> <div class="highlight"><pre>exports.connect = (options) -> new exports.Connection options || {}</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> Handles the connection to the Redis server. </td> <td class="code"> <div class="highlight"><pre>class Connection constructor: (options) -> @helper = new Helper @redis = options.redis || connectToRedis options @namespace = options.namespace || 'flo' @mincomplete = options.mincomplete || 1 @redis.select options.database if options.database?</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> Public: Get all prefixes for a phrase <ul> <li><code>phrase</code> - the phrase that needs to be parsed into many prefixes</li> </ul> Returns an array of unique prefixes for the phrase </td> <td class="code"> <div class="highlight"><pre> prefixes_for_phrase: (phrase) -> words = @helper.normalize(phrase).split(' ') _.uniq( _.flatten( _.map(words, (w) => _.map([(@mincomplete-1)..(w.length-1)], (l) -> w[0..l] ) ) ) )</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> Public: Search for a term <ul> <li><code>types</code> - types of term that you are looking for (Array of Strina)</li> <li><code>phrase</code> - the phrase or phrases you want to be autocompleted</li> <li><code>limit</code> - the count of the number you want to return (optional, default: 5)</li> <li><code>callback(err, result)</code> - err is the error and results is the results</li> </ul> </td> <td class="code"> <div class="highlight"><pre> search_term: (types, phrase, args...) -> if typeof(args[0]) == 'number' limit = args[0] else limit = 5 callback = args[args.length-1] async.map types, (type, callb) => words = _.uniq( @helper.normalize(phrase).split(' ') ).sort()</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> for caching purpose </td> <td class="code"> <div class="highlight"><pre> cachekey = @key(type, "cache", words.join('|')) async.waterfall([ ((cb) => @redis.exists cachekey, cb ), ((exists, cb) => if !exists interkeys = _.map(words, (w) => @key(type, "index", w) ) @redis.zinterstore cachekey, interkeys.length, interkeys..., (err, count) => @redis.expire cachekey, 10 * 60, -> # expire after 10 minutes cb() else cb() ), ((cb) => @redis.zrevrange cachekey, 0, (limit - 1), (err, ids) => if ids.length > 0 @redis.hmget @key(type, "data"), ids..., cb else cb(null, []) ) ], (err, results) -> data = {} data[type] = results callb(err, data) ) , (err, results) -> results = _.extend results... results.term = phrase callback(err, results)</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> Public: Add a new term <ul> <li><code>type</code> - the type of data of this term (String)</li> <li><code>id</code> - unique identifier(within the specific type)</li> <li><code>term</code> - the phrase you wish to provide completions for</li> <li><code>score</code> - user specified ranking metric (redis will order things lexicographically for items with the same score)</li> <li><code>data</code> - container for metadata that you would like to return when this item is matched (optional)</li> <li><code>callback</code> - callback to be run (optional)</li> </ul> Returns nothing. </td> <td class="code"> <div class="highlight"><pre> add_term: (type, id, term, score, data, callback) -></pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> store the data in parallel </td> <td class="code"> <div class="highlight"><pre> async.parallel([ ((callb) => @redis.hset @key(type, "data"), id, JSON.stringify term: term, score: score, data: (data || []), -> callb() ), ((callb) => async.forEach @prefixes_for_phrase(term), ((w, cb) => @redis.zadd @key(type, "index", w), score, id, # sorted set -> cb() ), -> callb() ) ], -> callback() if callback? )</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> Public: Get the redis instance Returns the redis instance. </td> <td class="code"> <div class="highlight"><pre> redis: -> @redis</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> Public: Quits the connection to the Redis server. Returns nothing. </td> <td class="code"> <div class="highlight"><pre> end: -> @redis.quit()</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> Builds a namespaced Redis key with the given arguments. <ul> <li><code>type</code> - Type of the param</li> <li><code>args</code> - Array of Strings.</li> </ul> Returns an assembled String key. </td> <td class="code"> <div class="highlight"><pre> key: (args...) -> args.unshift @namespace args.join ":" class Helper</pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> Public: Normalize a term to remove all other characters than a-z and 0-9. <ul> <li><code>term</code> - the term to be normalized</li> </ul> Returns a normalized term. </td> <td class="code"> <div class="highlight"><pre> normalize: (term) -> @strip(@gsub(term.toLowerCase(), /[^a-z0-9 ]/i, ''))</pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> Public: This function partially simulates the Ruby's String gsub method. <ul> <li><code>source</code> - the source string</li> <li><code>pattern</code> - the Regex pattern</li> <li><code>replacement</code> - the replacement text</li> </ul> Example: <pre><code>gsub("-abc-abc-", /[^a-z0-9 ]/i, '') # returns "abcabc" gsub("-abc-abc-", /[^a-z0-9 ]/i, '*') # returns "*abc*abc*" </code></pre> Returns the modified string. </td> <td class="code"> <div class="highlight"><pre> gsub: (source, pattern, replacement) -> unless pattern? and replacement? return source result = '' while source.length > 0 if (match = source.match(pattern)) result += source.slice(0, match.index) result += replacement source = source.slice(match.index + match[0].length) else result += source source = '' result</pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> Public: Strip out leading and trailing whitespaces. <ul> <li><code>source</code> - string to be stripped</li> </ul> Returns a copy of str with leading and trailing whitespace removed. </td> <td class="code"> <div class="highlight"><pre> strip: (source) -> source.replace(/^\s+/, '').replace(/\s+$/, '') connectToRedis = (options) -> redis = require('redis').createClient options.port, options.host redis.auth options.password if options.password? redis exports.Helper = new Helper exports.Connection = Connection </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>