vinova_sunspot_autocomplete 1.0.1

data/lib/autocomplete_view_helpers.rb

@@ -0,0 +1,126 @@
+#= Sunspot Autocomplete
+#
+#Sunspot Autocomplete is a Rails plugin that lets you use Solr and Sunspot for handy autocompletion of your html text inputs.
+#
+#=== Features:
+#
+#* Autocomplete: Typing "clo" will yield results that start with "clo", like "cloudy with a chance of meatballs".
+#* Autosuggest: Typing "clo" will yield results that contain (or start with) "clo", like "cloudy with a chance of meatballs" and "Jumping like Clowns".
+#* Both features are case insenitive.
+#* A CSS based view. You can override some style rules to force your look and feel.
+#
+#== Prerequisites
+#
+#You should have solr, sunspot and sunspot_rails ON and running.
+#
+#http://outoftime.github.com/sunspot
+#
+#== Installation
+#
+#Download the plugin and place it under vendor/plugins.
+#
+#Run the following rake task to copy the plugin's assets to your public directory. This will copy jquery.js and solr-autocompleter to your public/javascripts.
+#
+#  rake sunspot_autocomplete:copy_assets
+#
+#== Usage
+#
+# In your solr schema.xml, in addition to field types added by sunspot, add the following field types inside the <types> tag:
+#
+#  <fieldType name="autocomplete" class="solr.TextField" positionIncrementGap="100">
+#    <analyzer type="index">
+#      <tokenizer class="solr.KeywordTokenizerFactory"/>
+#      <filter class="solr.LowerCaseFilterFactory"/>
+#      <filter class="solr.EdgeNGramFilterFactory" minGramSize="1" maxGramSize="25" />
+#    </analyzer>
+#    <analyzer type="query">
+#      <tokenizer class="solr.KeywordTokenizerFactory"/>
+#      <filter class="solr.LowerCaseFilterFactory"/>
+#    </analyzer>
+#  </fieldType>
+#  <fieldType name="autosuggest" class="solr.TextField" positionIncrementGap="100">
+#    <analyzer type="index">
+#      <tokenizer class="solr.LetterTokenizerFactory"/>
+#      <filter class="solr.LowerCaseFilterFactory"/>
+#      <filter class="solr.EdgeNGramFilterFactory" minGramSize="1" maxGramSize="25" />
+#    </analyzer>
+#    <analyzer type="query">
+#      <tokenizer class="solr.LetterTokenizerFactory"/>
+#      <filter class="solr.LowerCaseFilterFactory"/>
+#    </analyzer>
+#  </fieldType>
+#
+#Also in your solr schema.xml, in addition to fields added by sunspot, add the following fields inside thw <fields> tag.
+#
+#  <dynamicField name="*_ac" type="autocomplete" indexed="true"  stored="true"/>
+#  <dynamicField name="*_as" type="autosuggest" indexed="true"  stored="true"/>
+#
+#To be able to autocomplete/autosuggest a model's attribute, call 'autocomplete'/'autosuggest' on it in its 'searchable' block. the field_name used (post_title and post_author in the following example) must be unique across all your autocomplete fields of the application.
+#
+#  class Post < ActiveRecord::Base
+#    searchable do
+#      autocomplete :post_title, :using => :title
+#      autosuggest :post_author, :using => :author
+#    end
+#  end
+#
+#In your view, Add the following script tags (in the given order) to be able to use the view helpers.
+#
+#  <script type="text/javascript" src="/javascripts/jquery.js"></script>
+#  <script type="text/javascript" src="/javascripts/solr-autocomplete/ajax-solr/core/Core.js"></script>
+#  <script type="text/javascript" src="/javascripts/solr-autocomplete/ajax-solr/core/AbstractManager.js"></script>
+#  <script type="text/javascript" src="/javascripts/solr-autocomplete/ajax-solr/managers/Manager.jquery.js"></script>
+#  <script type="text/javascript" src="/javascripts/solr-autocomplete/ajax-solr/core/Parameter.js"></script>
+#  <script type="text/javascript" src="/javascripts/solr-autocomplete/ajax-solr/core/ParameterStore.js"></script>
+#  <script type="text/javascript" src="/javascripts/solr-autocomplete/jquery-autocomplete/jquery.autocomplete.js"></script>
+#
+#Also, add the following stylesheet to use the basic style included. Alternatively, you can override those style rules to force your design's look and feel.
+#
+#  <link type="text/css" rel="stylesheet" href="/javascripts/solr-autocomplete/jquery-autocomplete/jquery.autocomplete.css" />
+#
+#In your view, to create a text field with autocomplete:
+#
+#  <%=autocomplete_text_field "post", "title", "http://127.0.0.1:8983/solr/", "post_title"%>
+#
+#And to create a text field with autosuggest:
+#
+#  <%=autosuggest_text_field "post", "author", "http://127.0.0.1:8983/solr/", "post_author"%>
+#
+#You can view documentation for more advanced features of the helpers.
+#
+#  
+module AutocompleteViewHelpers
+  
+  # Generates a text input using the given <code>object_name</code> and <code>method</code>.
+  # The generated text field autocompletes given <code>solr_url</code>: the url to your solr instance (e.g. http://127.0.0.1:8983/solr/)
+  # Autocompletion is fetching results that only begins with the given part of word.
+  # <code>autocomplete_field_name</code> is the unique field_name assigned in your model's searchable block
+  # <code>html_options</code> are regular HTML options like :class and :id
+  # <code>autocomplete_options</code> are advanced options for autocompletion http://docs.jquery.com/Plugins/Autocomplete/autocomplete#toptions
+  def autocomplete_text_field(object_name, method, solr_url, autocomplete_field_name, html_options={}, autocomplete_options={})
+    autocomplete_stub object_name, method, solr_url, autocomplete_field_name, false, html_options, autocomplete_options
+  end
+  
+  # Generates a text input using the given <code>object_name</code> and <code>method</code>.
+  # The generated text field autosuggests given <code>solr_url</code>: the url to your solr instance (e.g. http://127.0.0.1:8983/solr/)
+  # Autosuggestion is fetching results that begins with/ends with/contains the given part of word.
+  # <code>autocomplete_field_name</code> is the unique field_name assigned in your model's searchable block
+  # <code>html_options</code> are regular HTML options like :class and :id
+  # <code>autocomplete_options</code> are advanced options for autocompletion http://docs.jquery.com/Plugins/Autocomplete/autocomplete#toptions
+  def autosuggest_text_field(object_name, method, solr_url, autocomplete_field_name, html_options={}, autocomplete_options={})
+    autocomplete_stub object_name, method, solr_url, autocomplete_field_name, true, html_options, autocomplete_options
+  end
+  
+  private
+  
+  def autocomplete_stub(object_name, method, url, field_name, suggest=false, html_options={}, autocomplete_options={})
+    ac_js_options = "{" + autocomplete_options.collect{|k,v| "#{k.to_s}: #{ v.kind_of?(Numeric) ? v : "'" + v + "'" }"}.join(" , ") + "}"
+    result = []
+    result << text_field(object_name, method, html_options)
+    result << "<script>$('##{object_name}_#{method}').#{suggest ? 'autosuggest' : 'autocomplete'}('#{url.ends_with?('/') ? url : url + '/'}', '#{field_name}', #{ac_js_options});</script>"
+    result.join " "
+  end
+  
+end
+
+ActiveSupport.on_load(:action_view) { include AutocompleteViewHelpers }

data/lib/sunspot_autocomplete.rb

@@ -0,0 +1,38 @@
+require "sunspot"
+
+module Sunspot
+  module Type
+    
+    #Auto Completion
+    class AutocompleteType < AbstractType
+      def indexed_name(name) #:nodoc:
+        "#{name}_ac"
+      end
+
+      def to_indexed(value) #:nodoc:
+        value.to_s if value
+      end
+
+      def cast(string) #:nodoc:
+        string
+      end
+    end
+    
+    #Auto Suggestion
+    class AutosuggestType < AbstractType
+      def indexed_name(name) #:nodoc:
+        "#{name}_as"
+      end
+
+      def to_indexed(value) #:nodoc:
+        value.to_s if value
+      end
+
+      def cast(string) #:nodoc:
+        string
+      end
+    end
+    
+    
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require "sunspot"
+require File.join(File.dirname(__FILE__), *%w{.. lib sunspot_autocomplete})
+require File.join(File.dirname(__FILE__), *%w{.. lib autocomplete_view_helpers})

data/rdoc/classes/AutocompleteViewHelpers.html

@@ -0,0 +1,322 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: AutocompleteViewHelpers</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">AutocompleteViewHelpers</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/autocomplete_view_helpers_rb.html">
+                lib/autocomplete_view_helpers.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <h1><a href="Sunspot.html">Sunspot</a> Autocomplete</h1>
+<p>
+<a href="Sunspot.html">Sunspot</a> Autocomplete is a Rails plugin that lets
+you use Solr and <a href="Sunspot.html">Sunspot</a> for handy
+autocompletion of your html text inputs.
+</p>
+<h3>Features:</h3>
+<ul>
+<li>Autocomplete: Typing &quot;clo&quot; will yield results that start with
+&quot;clo&quot;, like &quot;cloudy with a chance of meatballs&quot;.
+
+</li>
+<li>Autosuggest: Typing &quot;clo&quot; will yield results that contain (or
+start with) &quot;clo&quot;, like &quot;cloudy with a chance of
+meatballs&quot; and &quot;Jumping like Clowns&quot;.
+
+</li>
+<li>Both features are case insenitive.
+
+</li>
+<li>A CSS based view. You can override some style rules to force your look and
+feel.
+
+</li>
+</ul>
+<h2>Prerequisites</h2>
+<p>
+You should have solr, sunspot and sunspot_rails ON and running.
+</p>
+<p>
+<a
+href="http://outoftime.github.com/sunspot">outoftime.github.com/sunspot</a>
+</p>
+<h2>Installation</h2>
+<p>
+Download the plugin and place it under vendor/plugins.
+</p>
+<p>
+Run the following rake task to copy the plugin&#8216;s assets to your
+public directory. This will copy jquery.js and solr-autocompleter to your
+public/javascripts.
+</p>
+<pre>
+  rake sunspot_autocomplete:copy_assets
+</pre>
+<h2>Usage</h2>
+<pre>
+ In your solr schema.xml, in addition to field types added by sunspot, add the following field types inside the &lt;types&gt; tag:
+
+  &lt;fieldType name=&quot;autocomplete&quot; class=&quot;solr.TextField&quot; positionIncrementGap=&quot;100&quot;&gt;
+    &lt;analyzer type=&quot;index&quot;&gt;
+      &lt;tokenizer class=&quot;solr.KeywordTokenizerFactory&quot;/&gt;
+      &lt;filter class=&quot;solr.LowerCaseFilterFactory&quot;/&gt;
+      &lt;filter class=&quot;solr.EdgeNGramFilterFactory&quot; minGramSize=&quot;1&quot; maxGramSize=&quot;25&quot; /&gt;
+    &lt;/analyzer&gt;
+    &lt;analyzer type=&quot;query&quot;&gt;
+      &lt;tokenizer class=&quot;solr.KeywordTokenizerFactory&quot;/&gt;
+      &lt;filter class=&quot;solr.LowerCaseFilterFactory&quot;/&gt;
+    &lt;/analyzer&gt;
+  &lt;/fieldType&gt;
+  &lt;fieldType name=&quot;autosuggest&quot; class=&quot;solr.TextField&quot; positionIncrementGap=&quot;100&quot;&gt;
+    &lt;analyzer type=&quot;index&quot;&gt;
+      &lt;tokenizer class=&quot;solr.LetterTokenizerFactory&quot;/&gt;
+      &lt;filter class=&quot;solr.LowerCaseFilterFactory&quot;/&gt;
+      &lt;filter class=&quot;solr.EdgeNGramFilterFactory&quot; minGramSize=&quot;1&quot; maxGramSize=&quot;25&quot; /&gt;
+    &lt;/analyzer&gt;
+    &lt;analyzer type=&quot;query&quot;&gt;
+      &lt;tokenizer class=&quot;solr.LetterTokenizerFactory&quot;/&gt;
+      &lt;filter class=&quot;solr.LowerCaseFilterFactory&quot;/&gt;
+    &lt;/analyzer&gt;
+  &lt;/fieldType&gt;
+</pre>
+<p>
+Also in your solr schema.xml, in addition to fields added by sunspot, add
+the following fields inside thw &lt;fields&gt; tag.
+</p>
+<pre>
+  &lt;dynamicField name=&quot;*_ac&quot; type=&quot;autocomplete&quot; indexed=&quot;true&quot;  stored=&quot;true&quot;/&gt;
+  &lt;dynamicField name=&quot;*_as&quot; type=&quot;autosuggest&quot; indexed=&quot;true&quot;  stored=&quot;true&quot;/&gt;
+</pre>
+<p>
+To be able to autocomplete/autosuggest a model&#8216;s attribute, call
+&#8216;autocomplete&#8217;/&#8217;autosuggest&#8217; on it in its
+&#8216;searchable&#8217; block. the field_name used (post_title and
+post_author in the following example) must be unique across all your
+autocomplete fields of the application.
+</p>
+<pre>
+  class Post &lt; ActiveRecord::Base
+    searchable do
+      autocomplete :post_title, :using =&gt; :title
+      autosuggest :post_author, :using =&gt; :author
+    end
+  end
+</pre>
+<p>
+In your view, Add the following script tags (in the given order) to be able
+to use the view helpers.
+</p>
+<pre>
+  &lt;script type=&quot;text/javascript&quot; src=&quot;/javascripts/jquery.js&quot;&gt;&lt;/script&gt;
+  &lt;script type=&quot;text/javascript&quot; src=&quot;/javascripts/solr-autocomplete/ajax-solr/core/Core.js&quot;&gt;&lt;/script&gt;
+  &lt;script type=&quot;text/javascript&quot; src=&quot;/javascripts/solr-autocomplete/ajax-solr/core/AbstractManager.js&quot;&gt;&lt;/script&gt;
+  &lt;script type=&quot;text/javascript&quot; src=&quot;/javascripts/solr-autocomplete/ajax-solr/managers/Manager.jquery.js&quot;&gt;&lt;/script&gt;
+  &lt;script type=&quot;text/javascript&quot; src=&quot;/javascripts/solr-autocomplete/ajax-solr/core/Parameter.js&quot;&gt;&lt;/script&gt;
+  &lt;script type=&quot;text/javascript&quot; src=&quot;/javascripts/solr-autocomplete/ajax-solr/core/ParameterStore.js&quot;&gt;&lt;/script&gt;
+  &lt;script type=&quot;text/javascript&quot; src=&quot;/javascripts/solr-autocomplete/jquery-autocomplete/jquery.autocomplete.js&quot;&gt;&lt;/script&gt;
+</pre>
+<p>
+Also, add the following stylesheet to use the basic style included.
+Alternatively, you can override those style rules to force your
+design&#8216;s look and feel.
+</p>
+<pre>
+  &lt;link type=&quot;text/css&quot; rel=&quot;stylesheet&quot; href=&quot;/javascripts/solr-autocomplete/jquery-autocomplete/jquery.autocomplete.css&quot; /&gt;
+</pre>
+<p>
+In your view, to create a text field with autocomplete:
+</p>
+<pre>
+  &lt;%=autocomplete_text_field &quot;post&quot;, &quot;title&quot;, &quot;http://127.0.0.1:8983/solr/&quot;, &quot;post_title&quot;%&gt;
+</pre>
+<p>
+And to create a text field with autosuggest:
+</p>
+<pre>
+  &lt;%=autosuggest_text_field &quot;post&quot;, &quot;author&quot;, &quot;http://127.0.0.1:8983/solr/&quot;, &quot;post_author&quot;%&gt;
+</pre>
+<p>
+You can view documentation for more advanced features of the helpers.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">autocomplete_text_field</a>&nbsp;&nbsp;
+      <a href="#M000002">autosuggest_text_field</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="#M000001" class="method-signature">
+          <span class="method-name">autocomplete_text_field</span><span class="method-args">(object_name, method, solr_url, autocomplete_field_name, html_options={}, autocomplete_options={})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Generates a text input using the given <tt>object_name</tt> and
+<tt>method</tt>. The generated text field autocompletes given
+<tt>solr_url</tt>: the url to your solr instance (e.g. <a
+href="http://127.0.0.1:8983/solr">127.0.0.1:8983/solr</a>/) Autocompletion
+is fetching results that only begins with the given part of word.
+<tt>autocomplete_field_name</tt> is the unique field_name assigned in your
+model&#8216;s searchable block <tt>html_options</tt> are regular HTML
+options like :class and :id <tt>autocomplete_options</tt> are advanced
+options for autocompletion <a
+href="http://docs.jquery.com/Plugins/Autocomplete/autocomplete#toptions">docs.jquery.com/Plugins/Autocomplete/autocomplete#toptions</a>
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000001-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/autocomplete_view_helpers.rb, line 100</span>
+100:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">autocomplete_text_field</span>(<span class="ruby-identifier">object_name</span>, <span class="ruby-identifier">method</span>, <span class="ruby-identifier">solr_url</span>, <span class="ruby-identifier">autocomplete_field_name</span>, <span class="ruby-identifier">html_options</span>={}, <span class="ruby-identifier">autocomplete_options</span>={})
+101:     <span class="ruby-identifier">autocomplete_stub</span> <span class="ruby-identifier">object_name</span>, <span class="ruby-identifier">method</span>, <span class="ruby-identifier">solr_url</span>, <span class="ruby-identifier">autocomplete_field_name</span>, <span class="ruby-keyword kw">false</span>, <span class="ruby-identifier">html_options</span>, <span class="ruby-identifier">autocomplete_options</span>
+102:   <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="#M000002" class="method-signature">
+          <span class="method-name">autosuggest_text_field</span><span class="method-args">(object_name, method, solr_url, autocomplete_field_name, html_options={}, autocomplete_options={})</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Generates a text input using the given <tt>object_name</tt> and
+<tt>method</tt>. The generated text field autosuggests given
+<tt>solr_url</tt>: the url to your solr instance (e.g. <a
+href="http://127.0.0.1:8983/solr">127.0.0.1:8983/solr</a>/) Autosuggestion
+is fetching results that begins with/ends with/contains the given part of
+word. <tt>autocomplete_field_name</tt> is the unique field_name assigned in
+your model&#8216;s searchable block <tt>html_options</tt> are regular HTML
+options like :class and :id <tt>autocomplete_options</tt> are advanced
+options for autocompletion <a
+href="http://docs.jquery.com/Plugins/Autocomplete/autocomplete#toptions">docs.jquery.com/Plugins/Autocomplete/autocomplete#toptions</a>
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000002-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/autocomplete_view_helpers.rb, line 110</span>
+110:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">autosuggest_text_field</span>(<span class="ruby-identifier">object_name</span>, <span class="ruby-identifier">method</span>, <span class="ruby-identifier">solr_url</span>, <span class="ruby-identifier">autocomplete_field_name</span>, <span class="ruby-identifier">html_options</span>={}, <span class="ruby-identifier">autocomplete_options</span>={})
+111:     <span class="ruby-identifier">autocomplete_stub</span> <span class="ruby-identifier">object_name</span>, <span class="ruby-identifier">method</span>, <span class="ruby-identifier">solr_url</span>, <span class="ruby-identifier">autocomplete_field_name</span>, <span class="ruby-keyword kw">true</span>, <span class="ruby-identifier">html_options</span>, <span class="ruby-identifier">autocomplete_options</span>
+112:   <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>