couchrest_model_search 0.0.2 → 0.0.3

data/README.rdoc

@@ -13,13 +13,14 @@ This add search method calls to couchrest_model gem. Assuming you are using couc
   # by default, couchrest_model only update view_by functions.
   Article.update_search_doc    
 
-  @articles = Article.search 'by_content', "apple"  # search by keyword apple
+  @articles = Article.search "apple"  # search by keyword apple
   
-  # you can also custom the search function.
+  # you can also customize the search function.
   class CustomArticle < CouchRest::Model::Base
-    def self.fulltext
-      { "by_content" => {"index" => %(function(doc) {})}
-      }
-    end
-  end
-
+    search_by :fulltext,
+              :index => %(
+                 function(doc) {
+                   // ....
+                 }
+              )
+  end

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/couchrest_model_search.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{couchrest_model_search}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dorren Chen"]
-  s.date = %q{2010-10-13}
+  s.date = %q{2010-10-18}
   s.description = %q{Add search function to CouchRest Model, assuming you're using couchdb-lucene}
   s.email = %q{dorrenchen@gmail.com}
   s.extra_rdoc_files = [

data/lib/couchrest_model_search.rb

@@ -4,46 +4,62 @@ module CouchRest
   module Model
     module DesignDoc
       module ClassMethods
-        # the default search function
-        def fulltext
-          { "by_content" => {
-              "index" => %(
-                function(doc) {
-                  var ret = new Document();
-                  function idx(obj) {
-                    for (var key in obj){
-                      switch (typeof obj[key]) {
-                        case 'object':
-                          idx(obj[key]);
-                          break;
-                        case 'function':
-                          break;
-                        default:
-                          ret.add(obj[key]);
-                          break;
+        alias_method :orig_default_design_doc, :default_design_doc
+        def default_design_doc          
+          orig_default_design_doc.update "fulltext" => 
+            { "by_fulltext" => {
+                "index" => %(
+                  function(doc) {
+                    var ret = new Document();
+                    function idx(obj) {
+                      for (var key in obj){
+                        switch (typeof obj[key]) {
+                          case 'object':
+                            idx(obj[key]);
+                            break;
+                          case 'function':
+                            break;
+                          default:
+                            ret.add(obj[key]);
+                            break;
+                        }
                       }
-                    }
-                  };
+                    };
 
-                  if (doc['couchrest-type'] == '#{self.to_s}') {
-                    idx(doc);
+                    if (doc['couchrest-type'] == '#{self.to_s}') {
+                      idx(doc);
 
-                    if (doc._attachments) {
-                      for (var i in doc._attachments) {
-                        ret.attachment('attachment', i);
+                      if (doc._attachments) {
+                        for (var i in doc._attachments) {
+                          ret.attachment('attachment', i);
+                        }
                       }
                     }
+                    return ret;
                   }
-                  return ret;
-                }
-              )
+                )
+              }
             }
-          }
         end
-    
-        alias_method :orig_default_design_doc, :default_design_doc
-        def default_design_doc          
-          orig_default_design_doc.merge "fulltext" => fulltext
+        
+        def update_search_doc
+          saved = stored_design_doc
+          if saved
+            saved["fulltext"] = design_doc["fulltext"]
+            saved.save
+            saved
+          else
+            design_doc.delete("_rev")
+            design_doc.database = database
+            design_doc.save
+            design_doc
+          end
+        end
+        
+        alias_method :orig_save_design_doc, :save_design_doc
+        def save_design_doc(db = database, force = false)
+          orig_save_design_doc(db, force)
+          update_search_doc
         end
       end
     end
@@ -61,16 +77,28 @@ class CouchRest::Database
 end
 
 class CouchRest::Model::Base
-  def self.search(view_fn, query, options={})
+  def self.search(query, view_fn="by_fulltext", options={})
     options[:include_docs] = true
     ret = self.database.search(self.to_s, view_fn, query, options)
     ret['rows'].map {|r| self.new(r['doc'])}
   end
   
-  def self.update_search_doc
-    dbdoc = database.get "_design/#{self.to_s}"
-    dbdoc.update design_doc
-    dbdoc.save
+  # example search functions
+  #   class Aritlce
+  #     search_by :title,
+  #       :index => %(
+  #         function(doc) {
+  #           // ....
+  #         }
+  #       )
+  #
+  # now you can make search like
+  #   Article.search "apple"   # by default it uses "by_fulltext" search function      
+  #   Article.search "apple", :by_title       
+  def self.search_by(fn_name, fn)
+    design_doc["fulltext"] ||= {}
+    design_doc["fulltext"]["by_#{fn_name}"] = fn.stringify_keys!
+    req_design_doc_refresh
   end
 end
 

data/spec/couchrest_model_search_spec.rb

@@ -1,22 +1,52 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "CouchrestModelSearch" do
-  class Article < CouchRest::Model::Base
+class Article < CouchRest::Model::Base
+  use_database DB
+end
+
+describe "CouchrestModelSearch" do  
+  before :each do
+    if doc = Article.stored_design_doc
+      doc.database = Article.database
+      doc.destroy
+    end
   end
   
   it "should overwrite default_design_doc" do
     Article.design_doc["fulltext"].should_not be_nil
-  end
+  end  
 end
-
-describe "CouchrestModelSearch" do  
+  
+describe "overwrite design doc" do  
   class CustomArticle < CouchRest::Model::Base
-    def self.fulltext
-      { "by_content" => {"index" => %(function(doc) {})}}
+    use_database DB
+    search_by :fulltext,
+              {:index => %(function(doc) {})}
+  end
+   
+  before :each do
+    if doc = CustomArticle.stored_design_doc
+      doc.database = CustomArticle.database
+      doc.destroy
     end
   end
   
   it "should allow class to overwrite fulltext function" do
-    CustomArticle.design_doc["fulltext"].should == CustomArticle.fulltext
+    CustomArticle.update_search_doc
+    CustomArticle.stored_design_doc["fulltext"]["by_fulltext"]["index"].should ==  %(function(doc) {})
+  end
+  
+  it "should update search doc" do
+    CustomArticle.update_search_doc
+    CustomArticle.stored_design_doc["fulltext"]["by_fulltext"]["index"].should ==  %(function(doc) {})
+    
+    class CustomArticle < CouchRest::Model::Base
+      use_database DB
+      search_by :fulltext,
+                {:index => %(function(doc) {// hello})}
+    end
+    
+    CustomArticle.update_search_doc
+    CustomArticle.stored_design_doc["fulltext"]["by_fulltext"]["index"].should == %(function(doc) {// hello})
   end
 end

data/spec/spec_helper.rb

@@ -4,6 +4,9 @@ require 'couchrest_model_search'
 require 'rspec'
 require 'rspec/autorun'
 
+COUCHDB_SERVER  = CouchRest.new "http://admin:password@localhost:5984"
+DB         = COUCHDB_SERVER.database!('couchrest_model_search_test')
+
 RSpec.configure do |config|
   # == Mock Framework
   #

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: couchrest_model_search
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Dorren Chen
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-13 00:00:00 -04:00
+date: 2010-10-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency