customized-mongomapper-search 0.1.4 → 1.0.0

data/CHANGE_LOG

@@ -1,3 +1,8 @@
+1.0.0
+------
+- Major refactoring was done to modularize search.  This should minimize the code that needs to be changed in the model if the modeling framework is to be switched.  The search code is more generalized to accommodate Rails 3 attribute access that isn't specific to Mongo Mapper.
+- Added support for indexing :many associations.  This implementation is specific to Mongo Mapper but can be easily modified if the modeling framework is swapped.  
+
 0.1.4
 ------
 - Added a way to specify the Solr document id (uniqueKey) field that the MongoMapper document _id key maps to.

data/Manifest

@@ -2,5 +2,6 @@ CHANGE_LOG
 README.rdoc
 Rakefile
 lib/customized-mongomapper-search.rb
-lib/search.rb
+lib/search/indexable.rb
+lib/search/searchable.rb
 Manifest

data/README.rdoc

@@ -1,37 +1,76 @@
 = tsxn-mongomapper-search
 
-Easily integrate mongo mapper with enterprise search like solr.  MODIFIED/CUSTOMIZED to use a specified Solr URL in the model.  
+Easily integrate Mongo Mapper with with Solr search.  
 
 == Credits
 
-The original gem was written by Fernando Meyer and can be found at http://github.com/fmeyer/mongomapper-search.
+Earlier versions < 1.0.0 were based off the mongomapper-search gem written by Fernando Meyer that can be found at http://github.com/fmeyer/mongomapper-search.
 
-== Usage
+== Usage 
+== Version 1.0.0
 
-Within the model that includes MongoMapper::Document add the following:
+To make a MongoMapper::Document indexable add the following line to include the functionality:
 
-  class << self; attr_accessor :SOLR_URL end
-  @SOLR_URL = "{SOLR URL}"   # {SOLR URL} should be replaced with the actual solr url if that wasn't apparent
+	include Search::Indexable
 
-Example:
+The Solr URL must be specified using the :solr_url method.  e.g.
 
-  class Foo
-    include MongoMapper::Document
-    include Search::SolrDocument
-  
-    class << self; attr_accessor :SOLR_URL end
-    @SOLR_URL = "http://localhost:8080/solr/foo.core"
-  
-    key :name, String, :fulltext => true
-  end
+	solr_url "http://localhost/solr/some.core"
 
-The name of the index document fields can be also be specified if the name of the keys aren't desired.
+To specify which attributes that need to be indexable pass hashes with the attributes and the corresponding indexed names to the :idx_attr method.  e.g.
 
-Example:
+  	idx_attr :_id => "object_id", :name => "title", :foo => "bar"
 
-  key :name, String, :fulltext => true, :solr_field_name => "object_name"
+To specify which :many associations that need to be indexable pass hashes with the name of the associations and the namespace the attributes of the association should be indexed under to the :idx_assoc method.  A blank namespace will result in no namespace to be pre-appended to the association attribute names.  e.g.
 
-The name of the Solr document id/uniqueKey name can be specified that the MongoMapper document _id maps to.  Within the model that includes MongoMapper::Document add the folowing:
+	idx_assoc :object_relations => "foo" 
+	
+To add search functionality add the following line to include:
 
-  class << self; attr_accessor :SOLR_DOC_ID_FIELD end
-  @SOLR_DOC_ID_FIELD = "preexisting_index_id"
+	include Search::Searchable
+
+== An indexing example
+
+Define a EmbeddedDocument model and specify the indexable fields.  The following model does not specify the Solr URL because it is a not a first class document.
+	
+	class Project
+		include MongoMapper::EmbeddedDocument
+		include Search::Indexable
+		
+		idx_attr :name => "proj_name"
+		
+		key :name
+	end
+	
+Define a Document model and specify the indexable fields and associations.	
+
+	class Employee
+		include MongoMapper::Document
+		include Search::Indexable
+		include Search::Searchable
+		
+		solr_url "http://search-api.search.com/solr/employee.core"
+		idx_attr :_id => "emp_id", :name => "emp_name"
+		idx_assoc :projects => "emp_project"
+		
+		key :name
+		many :projects
+	end
+
+Saving an instance of Employee causes that employee to be indexed in Solr.  The Lucene document that's indexed would appear something like:
+
+	employee doc
+		emp_id	= val
+		emp_name = val
+		emp_project.proj_name = val1
+		emp_project.proj_name = val2
+		emp_project.proj_name = ....
+		emp_project.proj_name = valN
+
+== A searching example
+
+	Employee.search('emp_name:"John Doe" emp_project.proj_name:"search"', :qt => 'dismax')
+	
+== Feedback & Contributions
+
+If the documentation here is not very clear please email me any suggested improvements.  Also if you would like me to pull changes from a fork to the master let me know.

data/Rakefile

@@ -2,10 +2,10 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('customized-mongomapper-search', '0.1.4') do |p|
-  p.description    = "Easily integreate mongo mapper with enterprise search like solr.  CUSTOMIZED to use a specified Solr URL in the model.  Original mongomapper-search gem (version 0.1.0) was written by Fernando Meyer and can be found at http://github.com/fmeyer/mongomapper-search."
+Echoe.new('customized-mongomapper-search', '1.0.0') do |p|
+  p.description    = "Easily integreate mongo mapper with enterprise search like solr.  Based off of the original mongomapper-search gem (version 0.1.0) that written by Fernando Meyer and can be found at http://github.com/fmeyer/mongomapper-search."
   p.url            = "http://github.com/tsxn26/customized-mongomapper-search"
-  p.author         = ["Fernando Meyer", "Thomas Nguyen"]
+  p.author         = ["Thomas Nguyen"]
   p.email          = "tsxn26@gmail.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
   p.runtime_dependencies = ["oauth-rsolr >=0.12.1", "mongo_mapper >=0.7.0", "will_paginate >=2.3.11"]

data/customized-mongomapper-search.gemspec

@@ -2,27 +2,27 @@
 
 Gem::Specification.new do |s|
   s.name = %q{customized-mongomapper-search}
-  s.version = "0.1.4"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Fernando Meyer, Thomas Nguyen"]
-  s.date = %q{2010-04-29}
-  s.description = %q{Easily integreate mongo mapper with enterprise search like solr.  CUSTOMIZED to use a specified Solr URL in the model.  Original mongomapper-search gem (version 0.1.0) was written by Fernando Meyer and can be found at http://github.com/fmeyer/mongomapper-search.}
+  s.authors = ["Thomas Nguyen"]
+  s.date = %q{2010-06-01}
+  s.description = %q{Easily integreate mongo mapper with enterprise search like solr.  Based off of the original mongomapper-search gem (version 0.1.0) that written by Fernando Meyer and can be found at http://github.com/fmeyer/mongomapper-search.}
   s.email = %q{tsxn26@gmail.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/customized-mongomapper-search.rb", "lib/search.rb"]
-  s.files = ["CHANGE_LOG", "README.rdoc", "Rakefile", "lib/customized-mongomapper-search.rb", "lib/search.rb", "Manifest", "customized-mongomapper-search.gemspec"]
+  s.extra_rdoc_files = ["README.rdoc", "lib/customized-mongomapper-search.rb", "lib/search/indexable.rb", "lib/search/searchable.rb"]
+  s.files = ["CHANGE_LOG", "README.rdoc", "Rakefile", "lib/customized-mongomapper-search.rb", "lib/search/indexable.rb", "lib/search/searchable.rb", "Manifest", "customized-mongomapper-search.gemspec"]
   s.homepage = %q{http://github.com/tsxn26/customized-mongomapper-search}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Customized-mongomapper-search", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{customized-mongomapper-search}
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Easily integreate mongo mapper with enterprise search like solr.  CUSTOMIZED to use a specified Solr URL in the model.  Original mongomapper-search gem (version 0.1.0) was written by Fernando Meyer and can be found at http://github.com/fmeyer/mongomapper-search.}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Easily integreate mongo mapper with enterprise search like solr.  Based off of the original mongomapper-search gem (version 0.1.0) that written by Fernando Meyer and can be found at http://github.com/fmeyer/mongomapper-search.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<oauth-rsolr>, [">= 0.12.1"])
       s.add_runtime_dependency(%q<mongo_mapper>, [">= 0.7.0"])
       s.add_runtime_dependency(%q<will_paginate>, [">= 2.3.11"])

data/lib/customized-mongomapper-search.rb

@@ -1,11 +1,8 @@
-require 'rubygems'
-require 'active_support'
-require 'mongo_mapper'
 require 'rsolr'
 require 'will_paginate/collection'
 
 module Search
-  mattr_accessor :connection  
-end 
+end
 
-require 'search'
+require 'search/indexable'
+require 'search/searchable'

data/lib/search/indexable.rb

@@ -0,0 +1,131 @@
+module Search
+  module Indexable
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      end
+      base.after_save :index_to_solr
+      base.before_destroy :delete_from_solr
+      
+      super
+    end
+
+    module ClassMethods
+      # Hash where keys are the attributes and the values are the name that attributes are indexed as in Solr
+      #
+      # e.g. :id => "employee_id" will have the effect where the :id attribute is indexed as "employee_id" in Solr
+      def idx_attr(*args)
+        @idx_attrs = {}
+        args.each { |x| @idx_attrs.merge!(x) }
+      end
+
+      # Hash where keys are the associations and the values are the namespace attached to the association attribute names that 
+      # are indexed as Solr fields.  If a hash value is nil or a blank string then no namespace is attached to attribute names.
+      #
+      # e.g. Employee has a one-to-many association with Project and Project has an attribute :deadline
+      #       :projects => "awesome_project" will have the effect where the :deadline attribute is indexed as "awesome_project.deadline"
+      def idx_assoc(*args)
+        @idx_assocs = {}
+        args.each { |x| @idx_assocs.merge!(x) }
+      end
+
+      def solr_url(arg = nil)
+        if(arg != nil)
+          @solr_url = arg
+        end
+        @solr_url
+      end
+
+      def idx_attrs
+        if @idx_attrs == nil
+          @idx_attrs = {}
+        end
+        @idx_attrs
+      end
+
+      def idx_assocs
+        if @idx_assocs == nil
+          @idx_assocs = {}
+        end
+        @idx_assocs
+      end
+    end
+
+    module InstanceMethods
+      def index_to_solr(commit = true)
+        if(!self.class.solr_url.nil?)   # There's no point in attempting to index if the solr url isn't specified
+          fields = get_indexable_fields
+          if(!fields.empty?)            # There's no point in indexing nothing
+            solr_conn = RSolr.connect(:url => self.class.solr_url)
+            solr_conn.add(fields)
+            if commit
+              solr_conn.commit
+            end
+          end
+        end
+      end
+      
+      def delete_from_solr(commit = true)
+        if(!self.class.solr_url.nil?)
+          solr_conn = RSolr.connect(:url => self.class.solr_url)
+          solr_conn.delete_by_id(self._id)
+          if commit
+            solr_conn.commit
+          end
+        end
+      end
+
+      protected
+      def get_indexable_fields
+        fields = get_indexable_attributes
+        if self.respond_to?(:associations) 
+          fields.merge!(get_indexable_associations)
+        end
+        fields
+      end
+
+      def get_indexable_attributes
+        fields = {}
+        if self.class.idx_attrs != nil
+          self.class.idx_attrs.each_pair do |x,y|
+            fields[y] = self.attributes[x]
+          end
+        end
+        fields
+      end
+
+      # This implementation is specific to MongoMapper
+      def get_indexable_associations
+        fields = {}
+        self.class.idx_assocs.each_pair do |name, namespace|
+          v = self.associations[name]
+          type = v.type
+          klass = Kernel.const_get(v.class_name)
+          namespace = namespace.blank? ? "" : namespace + "."
+
+          assocs = self.send(name)
+          if type == :many
+            assocs.each do |x|
+              if x.respond_to?("get_indexable_fields")
+                x_fields = x.get_indexable_fields
+                x_fields.each_pair do |field_name, field_value|
+                  if fields[namespace + field_name.to_s] == nil
+                    fields[namespace + field_name.to_s] = []
+                  end 
+                  fields[namespace + field_name.to_s].push(field_value)
+                end
+              end
+            end
+          end
+        end
+
+        # Dedupe values and get rid of nils
+        fields.each_pair do |x, y| 
+          y.uniq! 
+          y.compact!
+        end
+      end
+    end
+  end
+end

data/lib/search/searchable.rb

@@ -0,0 +1,41 @@
+module Search
+  module Searchable
+    def self.included(base)
+      base.class_eval do
+        base.extend ClassMethods
+      end
+      
+      super
+    end
+
+    module ClassMethods
+      def search(query, page = 1, opts = {})
+        WillPaginate::Collection.create(page, 20) do |pager|
+          result = search_engine_query(query, opts)
+          if(result.class == Array)
+            result.compact!
+          end
+          pager.replace(result)
+          pager.total_entries = result.length
+        end
+      end
+
+      protected
+      def search_engine_query(query, opts = {})
+        opts.reverse_merge!(:limit => 20, :offset => 0)   
+        solr_conn = RSolr.connect(:url => self.solr_url)   
+        resp = solr_conn.select(:q => query, :rows  => opts[:limit], :start => opts[:offset], :qt => !opts[:qt].blank? ? opts[:qt] : "standard", :fl => '*,score')['response']
+
+        id_name = self.idx_attrs[:_id].to_s
+
+        return resp['docs'].map do |doc| 
+          id = doc[id_name]
+          if id.class == Array
+            id = id[0]
+          end
+          find(id)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,29 +1,32 @@
 --- !ruby/object:Gem::Specification 
 name: customized-mongomapper-search
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
-  - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
-- Fernando Meyer, Thomas Nguyen
+- Thomas Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 -07:00
+date: 2010-06-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: oauth-rsolr
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 45
         segments: 
         - 0
         - 12
@@ -35,9 +38,11 @@ dependencies:
   name: mongo_mapper
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         - 7
@@ -49,9 +54,11 @@ dependencies:
   name: will_paginate
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 21
         segments: 
         - 2
         - 3
@@ -59,7 +66,7 @@ dependencies:
         version: 2.3.11
   type: :runtime
   version_requirements: *id003
-description: Easily integreate mongo mapper with enterprise search like solr.  CUSTOMIZED to use a specified Solr URL in the model.  Original mongomapper-search gem (version 0.1.0) was written by Fernando Meyer and can be found at http://github.com/fmeyer/mongomapper-search.
+description: Easily integreate mongo mapper with enterprise search like solr.  Based off of the original mongomapper-search gem (version 0.1.0) that written by Fernando Meyer and can be found at http://github.com/fmeyer/mongomapper-search.
 email: tsxn26@gmail.com
 executables: []
 
@@ -68,13 +75,15 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 - lib/customized-mongomapper-search.rb
-- lib/search.rb
+- lib/search/indexable.rb
+- lib/search/searchable.rb
 files: 
 - CHANGE_LOG
 - README.rdoc
 - Rakefile
 - lib/customized-mongomapper-search.rb
-- lib/search.rb
+- lib/search/indexable.rb
+- lib/search/searchable.rb
 - Manifest
 - customized-mongomapper-search.gemspec
 has_rdoc: true
@@ -92,16 +101,20 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 11
       segments: 
       - 1
       - 2
@@ -109,9 +122,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: customized-mongomapper-search
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Easily integreate mongo mapper with enterprise search like solr.  CUSTOMIZED to use a specified Solr URL in the model.  Original mongomapper-search gem (version 0.1.0) was written by Fernando Meyer and can be found at http://github.com/fmeyer/mongomapper-search.
+summary: Easily integreate mongo mapper with enterprise search like solr.  Based off of the original mongomapper-search gem (version 0.1.0) that written by Fernando Meyer and can be found at http://github.com/fmeyer/mongomapper-search.
 test_files: []
 

data/lib/search.rb

@@ -1,86 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-module Search::SolrDocument
-  module ClassMethods
-    def init_connection
-      @Solr ||= RSolr.connect(:url => instance_variable_get(:@SOLR_URL))
-    end
-    
-    def show_url
-      @test ||= instance_variable_get(:@SOLR_URL)
-    end
-    
-    def search(query, page = 1, opts = {})
-      init_connection()
-      WillPaginate::Collection.create(page, 20) do |pager|
-        result = search_engine_query(query, opts)
-        if(result.class == Array)
-          result.compact!
-        end
-        pager.replace(result)
-        pager.total_entries = result.length
-      end
-    end
-    
-    protected
-    def search_engine_query(query, opts = {})
-      opts.reverse_merge!(:limit => 20, :offset => 0)      
-      resp = @Solr.select(:q => query, :rows  => opts[:limit], :start => opts[:offset], :qt => !opts[:qt].blank? ? opts[:qt] : "standard", :fl => '*,score')['response']
-      
-      if(instance_variable_defined?(:@SOLR_DOC_ID_FIELD) && !instance_variable_get(:@SOLR_DOC_ID_FIELD).blank?)
-        id_name = instance_variable_get(:@SOLR_DOC_ID_FIELD)
-      else  
-        id_name = 'id'
-      end
-      
-      return resp['docs'].map do |doc| 
-        id = doc[id_name]
-        if id.class == Array
-          id = id[0]
-        end
-        find(id)
-      end
-    end    
-  end
-
-  module InstanceMethods
-    def to_index
-      if(self.class.instance_variable_defined?(:@SOLR_DOC_ID_FIELD) && !self.class.SOLR_DOC_ID_FIELD.blank?)
-        attrs = {self.class.SOLR_DOC_ID_FIELD => self._id}
-      else  
-        attrs = {'id' => self._id}
-      end
-      
-      self.keys.each_pair do |name, key|
-        field_name = key.options[:solr_field_name]
-        field_name ||= name
-        attrs.merge!(field_name => self[name]) if key.options[:fulltext] && self[name] != nil
-      end
-      attrs
-    end
-    
-    def init_connection
-      @Solr ||= RSolr.connect(:url => self.class.SOLR_URL)
-    end
-    
-    protected
-    def save_on_search_engine
-      init_connection
-      @Solr.add(to_index)
-      @Solr.commit
-    end
-    
-    def delete_from_search_engine
-      init_connection
-      @Solr.delete_by_id(self._id)
-      @Solr.commit
-    end
-  end
-
-  def self.included(receiver)
-    receiver.extend ClassMethods
-    receiver.send :include, InstanceMethods
-    receiver.after_save :save_on_search_engine
-    receiver.before_destroy :delete_from_search_engine
-  end
-end