mebla 1.0.0 → 1.0.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mebla (1.0.0.rc2)
+    mebla (1.0.0)
       bson (= 1.2.0)
       bson_ext (= 1.2.0)
       mebla

data/TODO.md

@@ -1,3 +1,9 @@
+TODO for version 1.0.1
+==============
+
+* add ability to index embedded documents (as part of the parent document)
+* properly handle sub classes
+
 TODO for version 1.0.0
 ==============
 
@@ -7,6 +13,5 @@ TODO for version 1.0.0
 Future plan
 =======
 
-* add ability to index embedded documents (as part of the parent document)
 * optimize : should find a solution for not refreshing the index while indexing embedded documents in lib/mebla/context
 * optimize : refractor result_set

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/mebla/context.rb

@@ -129,6 +129,10 @@ module Mebla
             attrs = document.attributes.dup # make sure we dont modify the document it self
             attrs["id"] = attrs.delete("_id") # the id is already added in the meta data of the action part of the query
             
+            # only index search fields
+            attrs.select!{|field, value| document.class.search_fields.include?(field.to_sym)}
+            
+            # If embedded get the parent id
             if document.embedded?
               parent_id = document.send(document.class.embedded_parent_foreign_key.to_sym).id.to_s        
               attrs[(document.class.embedded_parent_foreign_key + "_id").to_sym] = parent_id
@@ -217,10 +221,10 @@ module Mebla
     # Builds a bulk index query
     # @return [String]
     def build_bulk_query(index_name, type, id, attributes, parent = nil)
-      attrs_to_json = attributes.collect{|k,v| "\"#{k}\" : \"#{v}\""}.join(", ")
+      attrs_to_json = ActiveSupport::JSON.encode(attributes).gsub(/\n/, " ")
       <<-eos
-        { "index" : { "_index" : "#{index_name}", "_type" : "#{type}", "_id" : "#{id}"#{", \"_parent\" : \"#{parent}\"" if parent}, "refresh" : "true"} }
-        {#{attrs_to_json}}
+        { "index" : { "_index" : "#{index_name}", "_type" : "#{type}", "_id" : "#{id}"#{", \"_parent\" : \"#{parent}\"" if parent}, "refresh" : "true"} }        
+        #{attrs_to_json}
       eos
     end
   end

data/lib/mebla/errors/mebla_configuration_exception.rb

@@ -4,7 +4,7 @@ module Mebla
   module Errors
     # Thrown when configuration fails
     # @note this is a fatal exception
-    class MeblaIndexException < MeblaFatal
+    class MeblaConfigurationException < MeblaFatal
     end  
   end
 end

data/lib/mebla/errors.rb

@@ -6,6 +6,6 @@ module Mebla
     autoload :MeblaFatal, 'mebla/errors/mebla_fatal'
     autoload :MeblaConfigurationException, 'mebla/errors/mebla_configuration_exception'
     autoload :MeblaIndexException, 'mebla/errors/mebla_index_exception'
-    autoload :MeblaSynchronizationException, 'mebla/errors/mebla_synchronization_exceptions'
+    autoload :MeblaSynchronizationException, 'mebla/errors/mebla_synchronization_exception'
   end
 end

data/lib/mebla/mongoid/mebla.rb

@@ -21,17 +21,16 @@ module Mongoid
           'Boolean' => 'boolean'          
         }
       end
-      
-      cattr_accessor  :embedded_as      
-      cattr_accessor  :embedded_parent
-      cattr_accessor  :embedded_parent_foreign_key      
-      cattr_accessor  :index_mappings
-      cattr_accessor  :index_options
-      cattr_accessor  :search_fields        
-      cattr_accessor  :whiny_indexing   # set to true to raise errors if indexing fails
-      
+            
+      class_inheritable_accessor :embedded_as      
+      class_inheritable_accessor :embedded_parent
+      class_inheritable_accessor :embedded_parent_foreign_key      
+      class_inheritable_accessor :slingshot_mappings      
+      class_inheritable_accessor :search_fields        
+      class_inheritable_accessor :whiny_indexing   # set to true to raise errors if indexing fails
+        
       # make sure critical data remain read only
-      private_class_method :"search_fields=", :"index_options=", :"index_mappings=",
+      private_class_method :"search_fields=", :"slingshot_mappings=",
                                           :"embedded_parent_foreign_key=", :"embedded_parent=", :"embedded_as="
       
       # add callbacks to synchronize modifications with elasticsearch
@@ -72,7 +71,7 @@ module Mongoid
       #   embedded_in :category
       #   search_in :title, :publish_date, :body => { :boost => 2.0, :analyzer => 'snowball' }, :embedded_in => :category
       #  end      
-      def search_in(*opts)
+      def search_in(*opts)        
         # Extract advanced indeces
         options = opts.extract_options!.symbolize_keys
         # Extract simple indeces
@@ -83,7 +82,7 @@ module Mongoid
         # Example::
         #  embedded in a regular class (e.g.: using the default convention for naming the foreign key)
         #    :embedded_in => :parent        
-        if self.embedded?
+        if self.embedded?          
           if (embedor = options.delete(:embedded_in))
             relation = self.relations[embedor.to_s]
             
@@ -101,7 +100,7 @@ module Mongoid
         end
         
         # Keep track of searchable fields (for indexing)
-        self.search_fields = attrs + options.keys
+        self.search_fields = attrs + options.keys        
         
         # Generate simple indeces' mappings
         attrs_mappings = {}
@@ -118,7 +117,7 @@ module Mongoid
         end
         
         # Merge mappings
-        self.index_mappings = {}.merge!(attrs_mappings).merge!(opts_mappings)        
+        self.slingshot_mappings = {}.merge!(attrs_mappings).merge!(opts_mappings)        
         
         # Keep track of indexed models (for bulk indexing)
         ::Mebla.context.add_indexed_model(self, self.slingshot_type_name.to_sym => prepare_mappings)
@@ -138,8 +137,8 @@ module Mongoid
       # Retrieves the type name of the model 
       # (used to populate the _type variable while indexing)
       # @return [String]
-      def slingshot_type_name #:nodoc:
-        "#{self.model_name.underscore}"
+      def slingshot_type_name
+        "#{self.name.underscore}"        
       end
       
       # Enables the modification of records without indexing
@@ -173,9 +172,9 @@ module Mongoid
         else
           mappings = {}
         end
-        
+                
         mappings.merge!({
-          :properties => self.index_mappings
+          :properties => self.slingshot_mappings
         })
       end
     end
@@ -183,7 +182,7 @@ module Mongoid
     private
     # Adds the document to the index
     # @return [Boolean] true if the operation is successful
-    def add_to_index
+    def add_to_index      
       return false unless ::Mebla.context.index_exists? # only try to index if the index exists      
       
       # Prepare attributes to hash
@@ -199,7 +198,7 @@ module Mongoid
       end
       
       # Add indexed fields to the hash
-      self.search_fields.each do |sfield|
+      self.class.search_fields.each do |sfield|
         to_index_hash[sfield] = self.attributes[sfield]
       end      
       

data/mebla.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mebla}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Omar Mekky"]
-  s.date = %q{2011-03-17}
+  s.date = %q{2011-03-18}
   s.description = %q{
     An elasticsearch wrapper for mongoid odm based on slingshot. Makes integration between ElasticSearch full-text 
     search engine and Mongoid documents seemless and simple.
@@ -146,6 +146,14 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<mongoid-rspec>, ["= 1.4.1"])
       s.add_development_dependency(%q<database_cleaner>, ["= 0.6.4"])
       s.add_development_dependency(%q<bluecloth>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<mongoid-rspec>, ["= 1.4.1"])
+      s.add_development_dependency(%q<database_cleaner>, ["= 0.6.4"])
+      s.add_development_dependency(%q<bluecloth>, ["~> 2.1.0"])
       s.add_runtime_dependency(%q<slingshot-rb>, ["~> 0.0.6"])
       s.add_runtime_dependency(%q<mongoid>, ["= 2.0.0.rc.7"])
       s.add_runtime_dependency(%q<bson>, ["= 1.2.0"])
@@ -225,6 +233,14 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<mongoid-rspec>, ["= 1.4.1"])
       s.add_dependency(%q<database_cleaner>, ["= 0.6.4"])
       s.add_dependency(%q<bluecloth>, ["~> 2.1.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<mongoid-rspec>, ["= 1.4.1"])
+      s.add_dependency(%q<database_cleaner>, ["= 0.6.4"])
+      s.add_dependency(%q<bluecloth>, ["~> 2.1.0"])
       s.add_dependency(%q<slingshot-rb>, ["~> 0.0.6"])
       s.add_dependency(%q<mongoid>, ["= 2.0.0.rc.7"])
       s.add_dependency(%q<bson>, ["= 1.2.0"])
@@ -305,6 +321,14 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<mongoid-rspec>, ["= 1.4.1"])
     s.add_dependency(%q<database_cleaner>, ["= 0.6.4"])
     s.add_dependency(%q<bluecloth>, ["~> 2.1.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<mongoid-rspec>, ["= 1.4.1"])
+    s.add_dependency(%q<database_cleaner>, ["= 0.6.4"])
+    s.add_dependency(%q<bluecloth>, ["~> 2.1.0"])
     s.add_dependency(%q<slingshot-rb>, ["~> 0.0.6"])
     s.add_dependency(%q<mongoid>, ["= 2.0.0.rc.7"])
     s.add_dependency(%q<bson>, ["= 1.2.0"])

data/spec/fixtures/models.rb

@@ -23,6 +23,12 @@ class MongoidBeta
   search_in :name => {:boost => 2.0, :analyzer => 'snowball'}
 end
 
+class MongoidTheta < MongoidAlpha
+  field :extra  
+  
+  search_in :extra
+end
+
 class MongoidGamma
   include Mongoid::Document
   include Mongoid::Mebla

data/spec/mebla/synchronization_spec.rb

@@ -22,15 +22,34 @@ describe "Mebla" do
     
     it "should update the index automatically when a document is updated" do      
       udocument = MongoidAlpha.first
-      udocument.update_attributes(:cost => 3.1)
+      udocument.update_attributes(:cost => 3.1).should == true
       
       result = Mebla.context.slingshot_index.retrieve(:mongoid_alpha, udocument.id.to_s)
       result[:cost].should == 3.1
     end    
   end
   
+  describe "sub classes" do
+    before(:each) do
+      Mebla.context.rebuild_index      
+      MongoidTheta.create! :extra => "Is this indexed?"
+    end
+    
+    it "should index sub-classed documents automatically under the sub-class type" do
+      mdocument = MongoidTheta.first
+      lambda {Mebla.context.slingshot_index.retrieve(:mongoid_theta, mdocument.id.to_s)}.should_not raise_error
+    end
+    
+    it "should index fields under sub-classed documents automatically and correctly" do
+      mdocument = MongoidTheta.first
+      result = Mebla.context.slingshot_index.retrieve(:mongoid_theta, mdocument.id.to_s)
+      result.extra.should == "Is this indexed?"      
+    end
+  end
+  
   describe "embedded documents" do
     before(:each) do
+      Mebla.context.rebuild_index
       beta = MongoidBeta.create! :name => "Embedor parent"
       beta.mongoid_gammas.create :name => "Embedded", :value => 1
     end

data/spec/mebla_spec.rb

@@ -9,6 +9,7 @@ describe "Mebla" do
     !(defined?(LogSubscriber).nil?).should == true
     !(defined?(ResultSet).nil?).should == true
     !(defined?(Errors).nil?).should == true
+    !(defined?(Search).nil?).should == true
     !(defined?(Mongoid::Mebla).nil?).should == true
   end
   

metadata

@@ -2,7 +2,7 @@
 name: mebla
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Omar Mekky
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-17 00:00:00 +02:00
+date: 2011-03-18 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -740,8 +740,96 @@ dependencies:
   prerelease: false
   version_requirements: *id066
 - !ruby/object:Gem::Dependency 
-  name: slingshot-rb
+  name: rspec
   requirement: &id067 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id067
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id068 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id068
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id069 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id069
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id070 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id070
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id071 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id071
+- !ruby/object:Gem::Dependency 
+  name: mongoid-rspec
+  requirement: &id072 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: *id072
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  requirement: &id073 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *id073
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  requirement: &id074 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id074
+- !ruby/object:Gem::Dependency 
+  name: slingshot-rb
+  requirement: &id075 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -749,10 +837,10 @@ dependencies:
         version: 0.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *id067
+  version_requirements: *id075
 - !ruby/object:Gem::Dependency 
   name: mongoid
-  requirement: &id068 !ruby/object:Gem::Requirement 
+  requirement: &id076 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -760,10 +848,10 @@ dependencies:
         version: 2.0.0.rc.7
   type: :runtime
   prerelease: false
-  version_requirements: *id068
+  version_requirements: *id076
 - !ruby/object:Gem::Dependency 
   name: bson
-  requirement: &id069 !ruby/object:Gem::Requirement 
+  requirement: &id077 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -771,10 +859,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *id069
+  version_requirements: *id077
 - !ruby/object:Gem::Dependency 
   name: bson_ext
-  requirement: &id070 !ruby/object:Gem::Requirement 
+  requirement: &id078 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -782,10 +870,10 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *id070
+  version_requirements: *id078
 - !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &id071 !ruby/object:Gem::Requirement 
+  requirement: &id079 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -793,10 +881,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *id071
+  version_requirements: *id079
 - !ruby/object:Gem::Dependency 
   name: yard
-  requirement: &id072 !ruby/object:Gem::Requirement 
+  requirement: &id080 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -804,10 +892,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *id072
+  version_requirements: *id080
 - !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &id073 !ruby/object:Gem::Requirement 
+  requirement: &id081 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -815,10 +903,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id073
+  version_requirements: *id081
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &id074 !ruby/object:Gem::Requirement 
+  requirement: &id082 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -826,10 +914,10 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *id074
+  version_requirements: *id082
 - !ruby/object:Gem::Dependency 
   name: rcov
-  requirement: &id075 !ruby/object:Gem::Requirement 
+  requirement: &id083 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -837,10 +925,10 @@ dependencies:
         version: "0"
   type: :development
   prerelease: false
-  version_requirements: *id075
+  version_requirements: *id083
 - !ruby/object:Gem::Dependency 
   name: mongoid-rspec
-  requirement: &id076 !ruby/object:Gem::Requirement 
+  requirement: &id084 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -848,10 +936,10 @@ dependencies:
         version: 1.4.1
   type: :development
   prerelease: false
-  version_requirements: *id076
+  version_requirements: *id084
 - !ruby/object:Gem::Dependency 
   name: database_cleaner
-  requirement: &id077 !ruby/object:Gem::Requirement 
+  requirement: &id085 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -859,10 +947,10 @@ dependencies:
         version: 0.6.4
   type: :development
   prerelease: false
-  version_requirements: *id077
+  version_requirements: *id085
 - !ruby/object:Gem::Dependency 
   name: bluecloth
-  requirement: &id078 !ruby/object:Gem::Requirement 
+  requirement: &id086 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -870,7 +958,7 @@ dependencies:
         version: 2.1.0
   type: :development
   prerelease: false
-  version_requirements: *id078
+  version_requirements: *id086
 description: "\n    An elasticsearch wrapper for mongoid odm based on slingshot. Makes integration between ElasticSearch full-text \n    search engine and Mongoid documents seemless and simple.\n  "
 email: omar.mekky@mashsolvents.com
 executables: []
@@ -933,7 +1021,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -646980475899686207
+      hash: 3644119659415680929
       segments: 
       - 0
       version: "0"