activesearch 0.0.7 → 0.0.8

data/README.md

@@ -21,12 +21,24 @@ It works by storing keywords taken from the specified fields and storing them in
 
 ##Configuration
 
-Add this to your model:
+call "search_by" from your model:
       
-    search_by :title, :body, store: [:slug]
-    
-the :store option allows you to retrieve that value but it won't be used for search.
+    search_by [:title, :body, store: [:slug]], if: :its_friday
+
+**IMPORTANT: the first parameter must be either an array, or a symbol.
+The second parameter must be a conditions hash.**
+
+the :store option allows you to store that value in the index but it won't be used for search.
 You can also add :if or :unless conditions in the same way you would do with ActiveModel callbacks.
+If you need dynamic options, pass a symbol instead:
+
+    search_by :options_for_search
+    
+And define an instance method with that name which must return an array with the options, ie:
+
+    def options_for_search
+      [:field, :another_field]
+    end
 
 ## Querying
   
@@ -34,6 +46,11 @@ You can also add :if or :unless conditions in the same way you would do with Act
   
 You can access the stored fields with to_hash, so you don't need to fetch the real document.
 
+## Why?
+
+You might wonder why you would like to use ActiveSearch instead of a specific option for your fulltext search index.
+ActiveSearch provides an uniform API, which is in itself a drop-in replacement in case you want to move from an engine to another.
+
 ## Testing
 
 Run specs with this command:

data/activesearch.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec-mocks"
   gem.add_development_dependency "bson_ext"
   gem.add_development_dependency "active_attr"
   gem.add_development_dependency "mongoid", "~> 2"

data/lib/activesearch/base.rb

@@ -1,29 +1,35 @@
 module ActiveSearch
   module Base
-    def search_by(*params)
-      @search_parameters = params
-      self.after_save    :reindex, self.search_conditions
-      self.after_destroy :deindex, self.search_conditions
+    def self.included(parent)
+      parent.extend ClassMethods
     end
     
     def search_options
       search_parameters.last.is_a?(Hash) ? search_parameters.last : {}
     end
     
-    def search_conditions
-      {}.tap do |conditions|
-        conditions.merge!(if: search_options[:if]) if search_options.has_key?(:if)
-        conditions.merge!(unless: search_options[:unless]) if search_options.has_key?(:unless)
-      end
-    end
-    
     def search_fields
       search_parameters.last.is_a?(Hash) ? search_parameters[0...-1] : search_parameters
     end
     
-    protected
     def search_parameters
-      @search_parameters.first.respond_to?(:call) ? @search_parameters.first.call : @search_parameters
+      if self.class.search_parameters.is_a?(Symbol)
+        self.send(self.class.search_parameters)
+      else
+        self.class.search_parameters
+      end
+    end
+    
+    module ClassMethods
+      def search_by(params, conditions = {})
+        after_save    :reindex, conditions
+        after_destroy :deindex, conditions
+        @search_parameters = params
+      end
+      
+      def search_parameters
+        @search_parameters
+      end
     end
   end
 end

data/lib/activesearch/elastic_search.rb

@@ -11,8 +11,9 @@ module ActiveSearch
   
   module ElasticSearch
     def self.included(base)
-      base.extend Base
-      base.extend ClassMethods
+      base.class_eval do
+        include ActiveSearch::Base
+      end
     end
     
     def to_indexable
@@ -30,7 +31,7 @@ module ActiveSearch
     
     def reindex
       doc = self.to_indexable
-      properties = self.class.elastic_properties
+      properties = self.elastic_properties
       
       elastic_index do
         unless exists?
@@ -47,20 +48,18 @@ module ActiveSearch
       end
     end
     
-    module ClassMethods
-      def elastic_properties
-        props = {}
-        
-        search_fields.each_with_object(props) do |field,hash|
-          hash[field] = {type: 'string'}
-        end
-        
-        (Array(search_options[:store]) - search_fields).each_with_object(props) do |field,hash|
-          hash[field] = {type: 'string', :index => :no}
-        end
-        
-        props
+    def elastic_properties
+      props = {}
+      
+      search_fields.each_with_object(props) do |field,hash|
+        hash[field] = {type: 'string'}
       end
+      
+      (Array(search_options[:store]) - search_fields).each_with_object(props) do |field,hash|
+        hash[field] = {type: 'string', :index => :no}
+      end
+      
+      props
     end
   end
 end

data/lib/activesearch/mongoid.rb

@@ -11,12 +11,14 @@ module ActiveSearch
   
   module Mongoid
     def self.included(base)
-      base.extend Base
+      base.class_eval do
+        include Base
+      end
     end
     
     protected
     def reindex
-      ActiveSearch::Mongoid::Model.reindex(self, self.class.search_fields, self.class.search_options)
+      ActiveSearch::Mongoid::Model.reindex(self, self.search_fields, self.search_options)
     end
     
     def deindex

data/lib/activesearch/version.rb

@@ -1,3 +1,3 @@
 module ActiveSearch
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/base_spec.rb

@@ -0,0 +1,68 @@
+require 'activesearch/base'
+
+describe ActiveSearch::Base do
+  before do
+    @klass = Class.new do
+      include ActiveSearch::Base
+      
+      def self.after_save(*args); end
+      def self.after_destroy(*args); end
+      
+    end
+  end
+  
+  context "search_by" do
+    let(:call_search_by) do
+      @klass.class_eval do
+        search_by [:field], if: :something_happens, unless: :its_friday
+      end
+    end
+    
+    it "should rely on after_save and after_destroy callbacks passing conditions" do
+      @klass.should_receive(:after_save).with(:reindex, if: :something_happens, unless: :its_friday)
+      @klass.should_receive(:after_destroy).with(:deindex, if: :something_happens, unless: :its_friday)
+      call_search_by
+    end
+    
+    it "should store the parameters in search_parameters" do
+      call_search_by
+      @klass.send(:search_parameters).should == [:field]
+    end
+  end
+  
+  context "utility methods with options" do
+    before do
+      @klass.stub(:search_parameters).and_return([:field, store: [:another_field]])
+    end
+    
+    it "search_options should return the hash at the end of the parameters" do
+      @klass.new.search_options.should == {store: [:another_field]}
+    end
+    
+    it "search_fields should return all parameters except the options" do
+      @klass.new.search_fields.should == [:field]
+    end
+  end
+  
+  context "search_by with dynamic parameters" do
+    before do
+      @klass.class_eval do
+        def options_for_search
+          [@field]
+        end
+        
+        def initialize(field)
+          @field = field
+        end
+        
+        search_by :options_for_search
+      end
+    end
+    
+    it "should work" do
+      @klass.new(:first).send(:search_parameters).should == [:first]
+      @klass.new(:second).send(:search_parameters).should == [:second]
+    end
+  end
+
+end

data/spec/models/elastic_search.rb

@@ -20,7 +20,7 @@ class ElasticSearchModel < ActiveMimic
   attribute :junk
   attribute :special, default: false
   
-  search_by :title, :text, store: [:title, :junk], if: lambda { !self.special }
+  search_by [:title, :text, store: [:title, :junk]], if: lambda { !self.special }
 
 end
 
@@ -29,5 +29,5 @@ class AnotherElasticSearchModel < ActiveMimic
   include ElasticSearchRefresh
   
   attribute :title, type: String
-  search_by :title, store: [:title]
+  search_by [:title, store: [:title]]
 end

data/spec/models/mongoid.rb

@@ -11,7 +11,7 @@ class MongoidModel
   field :text,  type: String
   field :junk,  type: String
   field :special, type: Boolean, default: false
-  search_by :title, :text, store: [:title, :junk], unless: :special
+  search_by [:title, :text, store: [:title, :junk]], unless: :special
 end
 
 class AnotherMongoidModel
@@ -19,7 +19,11 @@ class AnotherMongoidModel
   include ActiveSearch::Mongoid
   
   field :title, type: String
-  search_by lambda { [:title, :text, store: [:title]] } # Simulating dynamic options
+  search_by :options_for_search
+  
+  def options_for_search
+    [:title, :text, store: [:title]]
+  end
 end
 
 
@@ -29,5 +33,5 @@ class LocalizedMongoidModel
   
   field :title, localize: true
   field :special_type
-  search_by :title, store: [:title]
+  search_by [:title, store: [:title]]
 end

data/spec/mongoid_spec.rb

@@ -10,7 +10,7 @@ class LocalizedMongoidModel
   include ActiveSearch::Mongoid
   
   field :title, localize: true
-  search_by :title, store: [:title]
+  search_by [:title, store: [:title]]
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activesearch
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bson_ext
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +144,7 @@ files:
 - lib/activesearch/mongoid/model.rb
 - lib/activesearch/result.rb
 - lib/activesearch/version.rb
+- spec/base_spec.rb
 - spec/config/mongoid.yml
 - spec/engines_spec.rb
 - spec/models/elastic_search.rb
@@ -160,6 +177,7 @@ specification_version: 3
 summary: ActiveSearch lets you plug in a ruby module in any class that will allow
   you to do full text searches.
 test_files:
+- spec/base_spec.rb
 - spec/config/mongoid.yml
 - spec/engines_spec.rb
 - spec/models/elastic_search.rb