acts_as_searchable 0.1.0

data/lib/vendor/overview

@@ -0,0 +1,100 @@
+= Pure Ruby Interface of Hyper Estraier
+
+Hyper Estraier is a full-text search system for communities.
+
+== Introduction
+
+This is a package implementing the node API of {Hyper Estraier}[http://hyperestraier.sourceforge.net/].  This is a pure ruby package.  So, it works on Linux, Mac OS X, Windows, and so on.  It does not depend on the core library of Hyper Estraier.  Applications are implemented as clients of node servers running on local or remote machines.
+
+Though Hyper Estraier itself is released under the terms of the GNU LGPL, this package is released under the terms of a BSD-style license.
+
+== Setting
+
+Get the package of the latest version of Hyper Estraier.
+
+Extract the package and enter the sub directory `rubypure' and perform installation.
+
+ cd rubypure
+ ./configure
+ make
+ su
+ make install
+
+The package `estraierpure' should be required in each source file of application programs and include the module `EstraierPure' at pleasure.
+
+== Example of Gatherer
+
+The following is the simplest implementation of a gatherer.
+
+ require "estraierpure"
+ include EstraierPure
+
+ # create and configure the node connecton object
+ node = Node::new
+ node.set_url("http://localhost:1978/node/test1")
+ node.set_auth("admin", "admin")
+
+ # create a document object
+ doc = Document::new
+
+ # add attributes to the document object
+ doc.add_attr("@uri", "http://estraier.gov/example.txt")
+ doc.add_attr("@title", "Over the Rainbow")
+
+ # add the body text to the document object
+ doc.add_text("Somewhere over the rainbow.  Way up high.")
+ doc.add_text("There's a land that I heard of once in a lullaby.")
+
+ # register the document object to the node
+ unless node.put_doc(doc)
+   STDERR.printf("error: %d\n", node.status)
+ end
+
+==Example of Searcher
+
+The following is the simplest implementation of a searcher.
+
+ require "estraierpure"
+ include EstraierPure
+ 
+ # create and configure the node connecton object
+ node = Node::new
+ node.set_url("http://localhost:1978/node/test1")
+
+ # create a search condition object
+ cond = Condition::new
+
+ # set the search phrase to the search condition object
+ cond.set_phrase("rainbow AND lullaby")
+
+ # get the result of search
+ nres = node.search(cond, 0);
+ if nres
+   # for each document in the result
+   for i in 0...nres.doc_num
+     # get a result document object
+     rdoc = nres.get_doc(i)
+     # display attributes
+     value = rdoc.attr("@uri")
+     printf("URI: %s\n", value) if value
+     value = rdoc.attr("@title")
+     printf("Title: %s\n", value) if value
+     # display the snippet text */
+     printf("%s", rdoc.snippet)
+   end
+ else
+   STDERR.printf("error: %d\n", node.status)
+ end
+
+== License
+
+ Copyright (C) 2004-2006 Mikio Hirabayashi
+ 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 Mikio Hirabayashi 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.

data/rdoc/classes/ActiveRecord/Acts/Searchable.html

@@ -0,0 +1,182 @@
+<?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: ActiveRecord::Acts::Searchable</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">ActiveRecord::Acts::Searchable</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/acts_as_searchable_rb.html">
+                lib/acts_as_searchable.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+Specify this act if you want to provide fulltext search capabilities to
+your model via Hyper Estraier. This assumes a setup and running Hyper
+Estraier node accessible through the HTTP API provided by the EstraierPure
+Ruby module (which is bundled with this plugin).
+</p>
+<p>
+The act supplies appropriate hooks to insert, update and remove documents
+from the index when you update your model data, create new objects or
+remove them from your database. For the initial indexing a convenience
+class method <tt>reindex!</tt> is provided.
+</p>
+<p>
+Example:
+</p>
+<pre>
+  class Article &lt; ActiveRecord::Base
+    acts_as_searchable
+  end
+
+  Article.reindex!
+</pre>
+<p>
+As soon as your model data has been indexed you can make use of the
+<tt>fulltext_search</tt> class method to search the index and get back
+instantiated matches.
+</p>
+<pre>
+  results = Article.fulltext_search('rails')
+  results.size        # =&gt; 3
+
+  results.first.class # =&gt; Article
+  results.first.body  # =&gt; &quot;Ruby on Rails is an open-source web framework&quot;
+</pre>
+<p>
+Connectivity configuration can be either inherited from conventions or
+setup globally in the Rails database configuration file
+<tt>config/database.yml</tt>.
+</p>
+<p>
+Example:
+</p>
+<pre>
+  development:
+    adapter: mysql
+    database: rails_development
+    host: localhost
+    user: root
+    password:
+    estraier:
+      host: localhost
+      user: admin
+      password: admin
+      port: 1978
+      node: development
+</pre>
+<p>
+That way you can configure separate connections for each environment. The
+values shown above represent the defaults. If you don&#8217;t need to
+change any of these it is safe to not specify the <tt>estraier</tt> hash at
+all.
+</p>
+<p>
+See <a
+href="Searchable/ClassMethods.html#M000068">ActiveRecord::Acts::Searchable::ClassMethods#acts_as_searchable</a>
+for per-model configuration options
+</p>
+
+    </div>
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="Searchable/ActMethods.html" class="link">ActiveRecord::Acts::Searchable::ActMethods</a><br />
+Module <a href="Searchable/ClassMethods.html" class="link">ActiveRecord::Acts::Searchable::ClassMethods</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/rdoc/classes/ActiveRecord/Acts/Searchable/ActMethods.html

@@ -0,0 +1,233 @@
+<?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: ActiveRecord::Acts::Searchable::ActMethods</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">ActiveRecord::Acts::Searchable::ActMethods</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../../files/lib/acts_as_searchable_rb.html">
+                lib/acts_as_searchable.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000067">attribute_name</a>&nbsp;&nbsp;
+      <a href="#M000066">changed?</a>&nbsp;&nbsp;
+      <a href="#M000065">estraier_doc</a>&nbsp;&nbsp;
+      <a href="#M000064">update_index</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-M000066" class="method-detail">
+        <a name="M000066"></a>
+
+        <div class="method-heading">
+          <a href="#M000066" class="method-signature">
+          <span class="method-name">changed?</span><span class="method-args">(attr_name = nil)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+If called with no parameters, gets whether the current model has changed
+and needs to updated in the index. If called with a single parameter, gets
+whether the parameter has changed.
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000066-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000066-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/acts_as_searchable.rb, line 271</span>
+271:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">changed?</span>(<span class="ruby-identifier">attr_name</span> = <span class="ruby-keyword kw">nil</span>)
+272:           <span class="ruby-identifier">changed_attributes</span> <span class="ruby-keyword kw">and</span> (<span class="ruby-identifier">attr_name</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-value">?
+273: </span>            (<span class="ruby-keyword kw">not</span> <span class="ruby-identifier">changed_attributes</span>.<span class="ruby-identifier">length</span>.<span class="ruby-identifier">zero?</span>) <span class="ruby-operator">:</span> (<span class="ruby-identifier">changed_attributes</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">attr_name</span>.<span class="ruby-identifier">to_s</span>)) )
+274:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000065" class="method-detail">
+        <a name="M000065"></a>
+
+        <div class="method-heading">
+          <a href="#M000065" class="method-signature">
+          <span class="method-name">estraier_doc</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Retrieve index record for current model object
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000065-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000065-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/acts_as_searchable.rb, line 260</span>
+260:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">estraier_doc</span>
+261:           <span class="ruby-identifier">cond</span> = <span class="ruby-constant">EstraierPure</span><span class="ruby-operator">::</span><span class="ruby-constant">Condition</span><span class="ruby-operator">::</span><span class="ruby-identifier">new</span>
+262:           <span class="ruby-identifier">cond</span>.<span class="ruby-identifier">add_attr</span>(<span class="ruby-node">&quot;db_id STREQ #{self.id}&quot;</span>)
+263:           <span class="ruby-identifier">cond</span>.<span class="ruby-identifier">add_attr</span>(<span class="ruby-node">&quot;type STREQ #{self.class.to_s}&quot;</span>)
+264:           <span class="ruby-identifier">result</span> = <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">estraier_connection</span>.<span class="ruby-identifier">search</span>(<span class="ruby-identifier">cond</span>, <span class="ruby-value">1</span>)
+265:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">result</span> <span class="ruby-keyword kw">and</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">doc_num</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
+266:           <span class="ruby-identifier">get_doc_from</span>(<span class="ruby-identifier">result</span>)
+267:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000064" class="method-detail">
+        <a name="M000064"></a>
+
+        <div class="method-heading">
+          <a href="#M000064" class="method-signature">
+          <span class="method-name">update_index</span><span class="method-args">(force = false)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Update index for current instance
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000064-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000064-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/acts_as_searchable.rb, line 253</span>
+253:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">update_index</span>(<span class="ruby-identifier">force</span> = <span class="ruby-keyword kw">false</span>)
+254:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">changed?</span> <span class="ruby-keyword kw">or</span> <span class="ruby-identifier">force</span>
+255:           <span class="ruby-identifier">remove_from_index</span>
+256:           <span class="ruby-identifier">add_to_index</span>
+257:         <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Protected Instance methods</h3>
+
+      <div id="method-M000067" class="method-detail">
+        <a name="M000067"></a>
+
+        <div class="method-heading">
+          <a href="#M000067" class="method-signature">
+          <span class="method-name">attribute_name</span><span class="method-args">(attribute)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000067-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000067-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/acts_as_searchable.rb, line 324</span>
+324:         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">attribute_name</span>(<span class="ruby-identifier">attribute</span>)
+325:           <span class="ruby-constant">EstraierPure</span><span class="ruby-operator">::</span><span class="ruby-constant">SYSTEM_ATTRIBUTES</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">attribute</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-operator">?</span> <span class="ruby-node">&quot;@#{attribute}&quot;</span> <span class="ruby-operator">:</span> <span class="ruby-node">&quot;#{attribute}&quot;</span>
+326:         <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>