activesearch 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,4 @@
-# Activesearch
+# ActiveSearch
 
 This gem allows any class to be indexed by the chosen fulltext search engine.
 
@@ -22,7 +22,8 @@ Or install it yourself as:
 
 This is not a fulltext search engine, but it's a good solution for those users that don't have access to anything else.
 It works by storing keywords taken from the specified fields and storing them in an Array field, which would be indexed.
-fts() method will return a Mongod::Criteria, so you can chain it with further scopes.
+search() method will return a Mongod::Criteria, so you can chain it with further scopes, like pagination.
+You won't get original documents though.
 
 ## Usage
 
@@ -30,10 +31,11 @@ fts() method will return a Mongod::Criteria, so you can chain it with further sc
       # [...] field definitions if needed
       include ActiveSearch::Engine # "Engine" being your chosen engine ie. "Mongoid"
   
-      search_on :title, :body
+      search_on :title, :body, store: [:title]
     end
     
-    SomeModel.fts("some words") # "fts" for full text search
+    # Access the stored fields so you don't need to fetch the real document
+    SomeModel.search("some words").first.stored["title"]
 
 
 ## Contributing

data/activesearch.gemspec

@@ -5,7 +5,7 @@ require 'activesearch/version'
 
 Gem::Specification.new do |gem|
   gem.name          = "activesearch"
-  gem.version       = Activesearch::VERSION
+  gem.version       = ActiveSearch::VERSION
   gem.authors       = ["Rodrigo Alvarez"]
   gem.email         = ["papipo@gmail.com"]
   gem.description   = %q{ORM agnostic full text search}

data/lib/activesearch.rb

@@ -1,4 +1 @@
 require "activesearch/version"
-
-module Activesearch
-end

data/lib/activesearch/mongoid.rb

@@ -1,4 +1,12 @@
+require 'activesearch/mongoid/model'
+
 module ActiveSearch
+  
+  # TODO: Wrap this so all engines behave consistently
+  def self.search(text)
+    Mongoid::Model.all_in(keywords: text.split)
+  end
+  
   module Mongoid
     def self.included(base)
       base.extend ClassMethods
@@ -6,20 +14,15 @@ module ActiveSearch
     
     module ClassMethods
       def search_on(*fields)
-        field :_keywords, type: Array
-        index :_keywords
-        
-        before_save do
-          self._keywords = []
-          
-          fields.each do |f|
-            self._keywords = self._keywords | self[f].downcase.split if self[f]
+        # TODO: Use inheritable class variables, so ActiveSearch::Mongoid::Model can get fields and options from there
+        self.class_eval <<-EOV
+          after_save do
+            fields = #{fields}
+            options = fields.pop if fields.last.is_a?(Hash)
+            return unless fields.any? { |f| self.send("\#{f}_changed?") }
+            ActiveSearch::Mongoid::Model.reindex(self, fields, options)
           end
-        end
-      end
-      
-      def fts(query)
-        all_in(_keywords: query.split)
+        EOV
       end
     end
   end

data/lib/activesearch/mongoid/model.rb

@@ -0,0 +1,36 @@
+module ActiveSearch
+  module Mongoid
+    class Model
+      include ::Mongoid::Document
+      
+      field :type, type: String
+      field :original_id, type: BSON::ObjectId
+      field :keywords
+      field :stored, type: Hash, default: {}
+      
+      index :keywords
+      index [:type, :original_id], unique: true
+      
+      def store_fields(original, fields, options)
+        if options && options[:store]
+          (fields & options[:store]).each do |f|
+            self.stored[f] = original[f] if original.send("#{f}_changed?")
+          end
+        end
+      end
+      
+      def refresh_keywords(original, fields)
+        self.keywords = fields.inject([]) do |memo,f|
+          original[f] ? memo | original[f].downcase.split : memo
+        end
+      end
+      
+      def self.reindex(original, fields, options)
+        doc = self.find_or_initialize_by(type: original.class.to_s, original_id: original.id)
+        doc.store_fields(original, fields, options)
+        doc.refresh_keywords(original, fields)
+        doc.save
+      end
+    end
+  end
+end

data/lib/activesearch/version.rb

@@ -1,3 +1,3 @@
-module Activesearch
-  VERSION = "0.0.1"
+module ActiveSearch
+  VERSION = "0.0.2"
 end

data/spec/mongoid_spec.rb

@@ -10,26 +10,40 @@ class MongoidModel
   field :title, type: String
   field :text,  type: String
   field :junk,  type: String
-  search_on :title, :text
+  search_on :title, :text, store: [:title]
+end
+
+class AnotherMongoidModel
+  include Mongoid::Document
+  include ActiveSearch::Mongoid
+  
+  field :title, type: String
+  search_on :title, :text, store: [:title]
 end
 
 describe ActiveSearch::Mongoid do
   before do
-    MongoidModel.delete_all
+    Mongoid.master.collections.select { |c| c.name != 'system.indexes' }.each(&:drop)
+    
     @findable = MongoidModel.create!(title: "Findable")
     @quite_findable = MongoidModel.create!(title: "Some title", text: "Findable text")
-    MongoidModel.create!(title: "Junk", junk: "Findable junk")
+    @another = AnotherMongoidModel.create!(title: "Another findable title")
+    @junk = MongoidModel.create!(title: "Junk", junk: "Findable junk")
   end
   
   it "should find the expected documents" do
-    MongoidModel.fts("findable").to_a.should == [@findable, @quite_findable]
+    ActiveSearch.search("findable").map { |r| r.stored["title"] }.should == ["Findable", "Some title", "Another findable title"]
   end
   
   it "should store the proper keywords" do
-    @quite_findable._keywords.should == %w{some title findable text}
+    ActiveSearch::Mongoid::Model.where(type: "MongoidModel", original_id: @quite_findable.id).first.keywords.should == %w{some title findable text}
   end
   
   it "should be chainable" do
-    MongoidModel.fts("findable").should respond_to(:where)
+    ActiveSearch.search("findable").should respond_to(:where)
+  end
+  
+  it "should store the specified fields" do
+    ActiveSearch::Mongoid::Model.where(type: "MongoidModel", original_id: @findable.id).first.stored.should == {"title" => "Findable"}
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activesearch
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -74,6 +74,7 @@ files:
 - activesearch.gemspec
 - lib/activesearch.rb
 - lib/activesearch/mongoid.rb
+- lib/activesearch/mongoid/model.rb
 - lib/activesearch/version.rb
 - spec/config/mongoid.yml
 - spec/mongoid_spec.rb