search_magic 0.0.6 → 0.0.7

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    search_magic (0.0.5)
-      mongoid (>= 2.0.0.rc.7)
+    search_magic (0.0.7)
+      mongoid (>= 2.0.0.rc.8)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.4)
-      activesupport (= 3.0.4)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
       builder (~> 2.1.2)
       i18n (~> 0.4)
-    activesupport (3.0.4)
+    activesupport (3.0.5)
     bson (1.2.4)
     bson_ext (1.2.4)
     builder (2.1.2)
@@ -20,7 +20,7 @@ GEM
     i18n (0.5.0)
     mongo (1.2.4)
       bson (>= 1.2.4)
-    mongoid (2.0.0.rc.7)
+    mongoid (2.0.0.rc.8)
       activemodel (~> 3.0)
       mongo (~> 1.2)
       tzinfo (~> 0.3.22)
@@ -33,7 +33,7 @@ GEM
     rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.5.0)
-    tzinfo (0.3.24)
+    tzinfo (0.3.25)
     will_paginate (3.0.pre2)
 
 PLATFORMS
@@ -42,6 +42,6 @@ PLATFORMS
 DEPENDENCIES
   bson_ext
   database_cleaner
-  mongoid (>= 2.0.0.rc.7)
+  mongoid (>= 2.0.0.rc.8)
   rspec
   search_magic!

data/README.textile

@@ -4,7 +4,11 @@ SearchMagic provides full-text search capabilities to "mongoid":http://github.co
 
 h2. Installation
 
-SearchMagic is built on top of the latest pre-release version of mongoid; in all likelihood, it will only work with versions greater than or equal to _2.0.0.rc.7_. For environments where bundler is being used, it can be installed by adding the following to your Gemfile and running @bundle@.
+SearchMagic is built on top of the latest pre-release version of mongoid; in all likelihood, it will only work with versions greater than or equal to _2.0.0.rc.8_. The project can be installed as a gem on a target system:
+
+bc. gem install search_magic
+
+For environments where bundler is being used, it can be installed by adding the following to your Gemfile and running @bundle@.
 
 bc. gem 'search_magic'
 
@@ -29,9 +33,9 @@ bc.. class Address
   search_on :post_code
 end
 
-p. At this point, *Address* can be searched by calling its _*:search*_ method:
+p. At this point, *Address* can be searched by calling its _*:search_for*_ method:
 
-bc. Address.search("state:ca")
+bc. Address.search_for("state:ca")
 
 It is also possible to sort models on fields which have been marked as searchable through the _*:arrange*_ method:
 
@@ -86,6 +90,7 @@ Finally, it should be noted that nesting of searchable documents is possible. (C
 
 bc.. class Part
   include Mongoid::Document
+  include Mongoid::Timestamps
   include SearchMagic::FullTextSearch
   field :serial
   references_in :part_number
@@ -116,17 +121,25 @@ end
 
 p. *PartNumber* will be able to search on both _:number_ and _:category_name_. *Part*, on the other hand, will absorb all of the searchable fields of PartNumber, including its associations. So, it can be searched on _:serial_, _:number_, and _:category_name_
 
-h3. :search
+h3. :search_for
 
-Searching a model with SearchMagic is simple: each model gains a class method called _:search_ which accepts one parameter, the search pattern. This method is a "mongoid scope":http://mongoid.org/docs/querying/; it will always return a criteria object after executing. As such, it plays nicely with other scopes on your models.
+Searching a model with SearchMagic is simple: each model gains a class method called _*:search_for*_ which accepts one parameter, the search pattern. This method is a "mongoid scope":http://mongoid.org/docs/querying/; it will always return a criteria object after executing. As such, it plays nicely with other scopes on your models.
 
 SearchMagic expects the incoming _pattern_ to be a string containing whitespace delimited phrases. Each phrase can either be a single word, or a _selector:value_ pair. Multiple phrases will narrow the search field: each additional phrase places an additional requirement on a matching document. Single word phrases are matched across all entries in a model's _:searchable_values_ array. The pairs, on the other hand, restrict the search for _value_ against only those entries which match _selector_. In either case, _word_ or _value_ may contain fragments of whole entries stored within _:searchable_values_.
 
 Using the models defined in the previous section, the following searches are all perfectly valid:
 
-bc. Part.search("table") # full text search on "table"
-Part.search("category_name:table") # restricts the search for "table" to "category_name"
-Part.search("bike serial:b1234") # full text search on "bike", with an extra requirement that the serial be "b1234"
+bc. Part.search_for("table") # full text search on "table"
+Part.search_for("category_name:table") # restricts the search for "table" to "category_name"
+Part.search_for("bike serial:b1234") # full text search on "bike", with an extra requirement that the serial be "b1234"
+
+As _*:search_for*_ is a scope, it can be called on any previous scope within the call chain:
+
+bc. Part.where(:created_at.gt => 1.day.ago.time).search_for("table")
+
+_*:search_for*_ can be called multiple times within the same scope chain. Doing so will append each successive pattern to the previous searches. Effectively, this is the same as performing a single _*:search_for*_ with whitespace delimited terms in the pattern. To make such expressions slightly more readable, _*:search_for*_ is aliased as _*:and_for*_:
+
+bc. Part.search_for("bike").and_for("serial:b1234")
 
 h3. :arrange
 
@@ -138,7 +151,7 @@ Part.arrange(:category_name, :desc) # arrange the parts in descending order by :
 
 As mentioned, _*:arrange*_ is a scope, so it can be chained with other scopes on a given model:
 
-bc. Part.search("category_name:table").arrange(:serial, :asc)
+bc. Part.search_for("category_name:table").arrange(:serial, :asc)
 
 h2. Problems? Comments?
 

data/lib/search_magic/full_text_search.rb

@@ -1,15 +1,18 @@
 module SearchMagic
   module FullTextSearch
+    extend ActiveSupport::Concern
+    
+    included do
+      class_attribute :searchable_fields, :instance_writer => false
+      self.searchable_fields = {}
+      field :searchable_values, :type => Array, :default => []
+      field :arrangeable_values, :type => Hash, :default => {}
+      before_save :update_searchable_values
+      before_save :update_arrangeable_values
+      after_save :update_associated_documents
+    end
+    
     module ClassMethods
-      def self.extended(receiver)
-        receiver.send :class_attribute, :searchable_fields, :instance_writer => false
-        receiver.send :searchable_fields=, {}
-        receiver.send :field, :searchable_values, :type => Array, :default => []
-        receiver.send :field, :arrangeable_values, :type => Hash, :default => {}
-        receiver.send :before_save, :update_searchable_values
-        receiver.send :before_save, :update_arrangeable_values
-      end
-      
       def search_on(field_name, options = {})
         searchable_fields[field_name] = options
       end
@@ -18,7 +21,13 @@ module SearchMagic
         @searchables ||= create_searchables
       end
       
-      def search(pattern)
+      def inverse_searchables
+        @inverse_searchables ||= relations.values.
+          select {|metadata| metadata.class_name.constantize.searchable_fields.keys.include?(metadata.inverse_setter.chomp("=").to_sym)}.
+          map(&:name)
+      end
+      
+      def search_for(pattern)
         rval = /("[^"]+"|\S+)/
         rsearch = /(?:(#{searchables.keys.join('|')}):#{rval})|#{rval}/i
         unless pattern.blank?
@@ -32,6 +41,7 @@ module SearchMagic
           criteria
         end
       end
+      alias :and_for :search_for
       
       def arrange(arrangeable, direction = :asc)
         arrangeable.blank? || !searchables.keys.include?(arrangeable.to_sym) ? criteria : order_by([["arrangeable_values.#{arrangeable}", direction]])
@@ -51,7 +61,7 @@ module SearchMagic
               Metadata.new(:type => self, :through => lambda do |obj|
                 value = obj.send(field_name)
                 value.is_a?(Array) ? value.map {|item| metadata.through.call(item)} : metadata.through.call(value)
-              end, :prefix => field_name.to_s.singularize.to_sym, :field_name => name, :options => metadata.options.merge(options))
+              end, :prefix => field_name.to_s.singularize.to_sym, :field_name => name, :relation_metadata => association, :options => metadata.options.merge(options))
             end
           else
             Metadata.new(:type => self, :through => lambda {|obj| obj.send(field_name) }, :field_name => field_name.to_s.pluralize.singularize.to_sym, :options => options)
@@ -62,24 +72,23 @@ module SearchMagic
       end
     end
   
-    module InstanceMethods
-      private
-      
-      def update_searchable_values
-        self.searchable_values = self.class.searchables.values.map {|metadata| metadata.searchable_value_for(self)}.flatten
-      end
-      
-      def update_arrangeable_values
-        self.arrangeable_values = {}
-        self.class.searchables.values.each do |metadata|
-          self.arrangeable_values[metadata.name] = metadata.arrangeable_value_for(self)
-        end
-      end
+    private
+    
+    def update_searchable_values
+      self.searchable_values = self.class.searchables.values.map {|metadata| metadata.searchable_value_for(self)}.flatten
     end
-  
-    def self.included(receiver)
-      receiver.extend         ClassMethods
-      receiver.send :include, InstanceMethods
+    
+    def update_arrangeable_values
+      self.arrangeable_values = Hash[*self.class.searchables.map {|key, metadata|
+        [key, metadata.arrangeable_value_for(self)]
+        }.flatten(1)]
+    end
+    
+    def update_associated_documents
+      self.class.inverse_searchables.each do |relation_name|
+        relation = send(relation_name)
+        (relation.is_a?(Array) ? relation : [relation]).each(&:save!)
+      end
     end
   end
 end

data/lib/search_magic/metadata.rb

@@ -1,6 +1,6 @@
 module SearchMagic
   class Metadata
-    attr_accessor :type, :through, :prefix, :field_name, :options
+    attr_accessor :type, :through, :prefix, :field_name, :relation_metadata, :options
 
     def initialize(attributes = {})
       attributes.each do |key, value|
@@ -9,7 +9,7 @@ module SearchMagic
     end
   
     def name
-      @name ||= [options[:skip_prefix].presence ? nil : (prefix.present? ? options[:as] || prefix : nil), 
+      @name ||= [options[:skip_prefix].presence ? nil : (prefix.present? ? (options[:as] || prefix) : nil), 
                 prefix.present? ? field_name : (options[:as] || field_name)].compact.join("_").to_sym
     end
   

data/lib/search_magic/version.rb

@@ -1,3 +1,3 @@
 module SearchMagic
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/search_magic.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.summary     = %q{SearchMagic provides scoped full text search and sort capabilities to Mongoid documents}
   s.description = %q{Adds scopes to a Mongoid document providing search and sort capabilities on arbitrary fields and associations.}
   
-  s.add_dependency("mongoid", ">= 2.0.0.rc.7")
+  s.add_dependency("mongoid", ">= 2.0.0.rc.8")
   s.add_development_dependency("rspec")
   s.add_development_dependency("database_cleaner")
   s.add_development_dependency("bson_ext")

data/spec/unit/search_magic/associations_spec.rb

@@ -42,31 +42,31 @@ describe SearchMagic::FullTextSearch do
     end
     
     context "when searching for 'address_city:nowhereland'" do
-      subject { Person.search("address_city:nowhereland") }
+      subject { Person.search_for("address_city:nowhereland") }
       its("selector.keys") { should include(:searchable_values) }
       its(:count) { should == 1 }
       its("first.name") { should == "Joshua" }
     end
     
     context "when searching for 'arbitrary address_post_code:54321'" do
-      subject { Person.search("arbitrary address_post_code:54321") }
+      subject { Person.search_for("arbitrary address_post_code:54321") }
       its(:count) { should == 1 }
       its("first.name") { should == "Samuel" }
     end
     
     context "when searching for 'mobile_number:555-'" do
-      subject { Person.search("mobile_number:555-") }
+      subject { Person.search_for("mobile_number:555-") }
       its(:count) { should == 2 }
     end
     
     context "when searching for 'mobile_number:333-'" do
-      subject { Person.search("mobile_number:333-") }
+      subject { Person.search_for("mobile_number:333-") }
       its(:count) { should == 1 }
       its("first.name") { should == "Joshua" }
     end
     
     context "when searching for 'mobile_number:-0987'" do
-      subject { Person.search("mobile_number:-0987") }
+      subject { Person.search_for("mobile_number:-0987") }
       its(:count) { should == 1 }
       its("first.name") { should == "Samuel" }
     end
@@ -105,13 +105,13 @@ describe SearchMagic::FullTextSearch do
       end
     
       context "when searching for 'category_name:table'" do
-        subject { PartNumber.search("category_name:table").map(&:value) }
+        subject { PartNumber.search_for("category_name:table").map(&:value) }
         its(:count) { should == 2 }
         it { should include("T11001", "T11002") }
       end
     
       context "when searching for '11001'" do
-        subject { PartNumber.search("11001").map(&:value) }
+        subject { PartNumber.search_for("11001").map(&:value) }
         its(:count) { should == 2 }
         it { should include("T11001", "C11001") }
       end
@@ -127,19 +127,19 @@ describe SearchMagic::FullTextSearch do
       end
       
       context "when searching for 'category_name:table'" do
-        subject { Part.search("category_name:table").map(&:serial) }
+        subject { Part.search_for("category_name:table").map(&:serial) }
         its(:count) { should == 4 }
         it { should include("T0411001", "T0511010", "T0411037", "T0511178") }
       end
       
       context "when searching for 'broken chair'" do
-        subject { Part.search("broken chair").map(&:serial) }
+        subject { Part.search_for("broken chair").map(&:serial) }
         its(:count) { should == 2 }
         it { should include("C0511010", "C0511010") }
       end
       
       context "when searching for 'part_number:T11001'" do
-        subject { Part.search("part_number:T11001").map(&:serial) }
+        subject { Part.search_for("part_number:T11001").map(&:serial) }
         its(:count) { should == 2 }
         it { should include("T0411001", "T0511010") }
       end

data/spec/unit/search_magic/fields_spec.rb

@@ -17,7 +17,8 @@ describe SearchMagic::FullTextSearch do
       its(:default) { should == [] }
     end
     
-    it { should respond_to(:search).with(1).argument }
+    it { should respond_to(:search_for).with(1).argument }
+    it { should respond_to(:and_for).with(1).argument }
   end
   
   context "when :search_on called with [:title, :description, :tags]" do
@@ -46,7 +47,7 @@ describe SearchMagic::FullTextSearch do
   end
   
   context "when :search is performed on a model without :searchables" do
-    subject { NoSearchables.search("foo") }
+    subject { NoSearchables.search_for("foo") }
     it { should be_a(Mongoid::Criteria) }
     its(:count) { should == 0 }
   end
@@ -59,50 +60,74 @@ describe SearchMagic::FullTextSearch do
     end
 
     context "when searching for nil" do
-      subject { Asset.search(nil) }
+      subject { Asset.search_for(nil) }
       it { should be_a(Mongoid::Criteria) }
       its("selector.keys") { should_not include(:searchable_values) }
     end
     
     context "when searching on an empty string" do
-      subject { Asset.search("") }
+      subject { Asset.search_for("") }
       it { should be_a(Mongoid::Criteria) }
       its("selector.keys") { should_not include(:searchable_values) }
     end
     
     context "when searching for anything" do
-      subject { Asset.search("foo") }
+      subject { Asset.search_for("foo") }
       it { should be_a(Mongoid::Criteria) }
       its("selector.keys") { should include(:searchable_values) }
     end
     
     context "when searching for 'foo'" do
-      subject { Asset.search("foo").map(&:title) }
+      subject { Asset.search_for("foo").map(&:title) }
       its(:count) { should == 2 }
       it { should include("Foo Bar: The Bazzening", "Undercover Foo") }
     end
     
     context "when searching for 'title:foo'" do
-      subject { Asset.search("title:foo").map(&:title) }
+      subject { Asset.search_for("title:foo").map(&:title) }
       its(:count) { should == 2 }
       it { should include("Foo Bar: The Bazzening", "Undercover Foo") }
     end
     
     context "when searching for 'description:bazzening'" do
-      subject { Asset.search("description:bazzening") }
+      subject { Asset.search_for("description:bazzening") }
       its(:count) { should == 0 }
     end
     
     context "when searching for 'tag:foo.bar'" do
-      subject { Asset.search("tag:foo.bar").map(&:title) }
+      subject { Asset.search_for("tag:foo.bar").map(&:title) }
       its(:count) { should == 1 }
       its(:first) { should == "Foo Bar: The Bazzening" }
     end
     
     context "when searching for 'tag:movies cheese" do
-      subject { Asset.search("tag:movies cheese").map(&:title) }
+      subject { Asset.search_for("tag:movies cheese").map(&:title) }
       its(:count) { should == 1 }
       its(:first) { should == "Cheese of the Damned" }
     end
+    
+    context "when chaining a search for 'foo' off of :all" do
+      subject { Asset.all.search_for("foo").map(&:title) }
+      its(:count) { should == 2 }
+      it { should include("Foo Bar: The Bazzening", "Undercover Foo") }
+    end
+
+    context "when chaining a search for 'foo' off of a search for 'bar'" do
+      subject { Asset.search_for("bar").search_for("foo").map(&:title) }
+      its(:count) { should == 1 }
+      it { should == ["Foo Bar: The Bazzening"] }
+    end
+    
+    context "when chaining a search for 'foo' off of a search for 'bar' using :and_for" do
+      subject { Asset.search_for("bar").and_for("foo").map(&:title) }
+      its(:count) { should == 1 }
+      it { should == ["Foo Bar: The Bazzening"] }
+    end
+    
+    context "when chaining a search for 'foo' off of :arrange" do
+      subject { Asset.arrange(:title, :desc).search_for("foo").map(&:title) }
+      its(:count) { should == 2 }
+      it { should include("Undercover Foo", "Foo Bar: The Bazzening") }
+    end
   end
 end

data/spec/unit/search_magic/model_updates_spec.rb

@@ -0,0 +1,80 @@
+describe SearchMagic::FullTextSearch do
+  context "when included in a document without searchables" do
+    subject { NoSearchables }
+    it { should respond_to(:inverse_searchables) }
+    its(:inverse_searchables) { should be_a(Array)}
+    its(:inverse_searchables) { should be_blank }
+  end
+  
+  context "when included in a document which is not searched on from another document" do
+    subject { Person }
+    it { should respond_to(:inverse_searchables) }
+    its(:inverse_searchables) { should be_a(Array)}
+    its(:inverse_searchables) { should be_blank }
+  end
+  
+  context "when included in a document with embedded searchables" do
+    subject { Address }
+    it { should respond_to(:inverse_searchables) }
+    its(:inverse_searchables) { should be_a(Array) }
+    its(:inverse_searchables) { should_not be_blank }
+    its(:inverse_searchables) { should include(:person) }
+  end
+  
+  context "when included in a document with referenced searchables" do
+    subject { PartNumber }
+    it { should respond_to(:inverse_searchables) }
+    its(:inverse_searchables) { should be_a(Array) }
+    its(:inverse_searchables) { should_not be_blank }
+    its(:inverse_searchables) { should include(:parts) }
+    its(:inverse_searchables) { should_not include(:part_categories) }
+  end
+  
+  context "when included in a document which is searched on by another document, but which does not search on another" do
+    subject { PartCategory }
+    its(:inverse_searchables) { should include(:part_numbers) }
+  end
+  
+  context "when an embedded model is updated" do
+    before(:each) do
+      Person.create(:name => "Joshua", :address => {:street => "123 Example St.", :city => "Nowhereland", :state => "CA", :post_code => 12345}, :phones => [{:country_code => 1, :number => "555-1234"}, {:country_code => 2, :number => "333-7890"}])
+    end
+    
+    describe "the top-level document should have its :searchable_values and :arrangeable_values updated" do
+      subject { Person.first }
+      before(:each) { subject.address.update_attributes!(:city => "Nowhereville") && subject.reload }
+      its(:searchable_values) { should include("address_city:nowhereville") }
+      its(:searchable_values) { should_not include("address_city:nowhereland") }
+      its(:arrangeable_values) { should include("address_city" => "Nowhereville") }
+      its(:arrangeable_values) { should_not include("address_city" => "Nowhereland") }
+    end
+  end
+  
+  context "when a referenced model is updated the current model's :searchable_values should change" do
+    before(:each) do
+      PartCategory.create(:name => "Table").tap do |category|
+        category.part_numbers.create(:value => "T11001").tap do |number|
+          number.parts.create(:status => "available", :serial => "T0411001")
+        end
+      end
+    end
+    
+    describe "when a model is updated" do
+      subject { PartNumber.first }
+      before(:each) { subject.part_category.update_attributes!(:name => "Desk" ) && subject.reload }
+      its(:searchable_values) { should include("category_name:desk") }
+      its(:searchable_values) { should_not include("category_name:table") }
+      its(:arrangeable_values) { should include("category_name" => "Desk") }
+      its(:arrangeable_values) { should_not include("category_name" => "Table") }
+    end
+    
+    describe "when a deeply nested model is updated" do
+      subject { Part.first }
+      before(:each) { subject.part_number.part_category.update_attributes!(:name => "Desk" ) && subject.reload }
+      its(:searchable_values) { should include("category_name:desk") }
+      its(:searchable_values) { should_not include("category_name:table") }
+      its(:arrangeable_values) { should include("category_name" => "Desk") }
+      its(:arrangeable_values) { should_not include("category_name" => "Table") }
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Joshua Bowers
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-20 00:00:00 -07:00
+date: 2011-03-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,8 +30,8 @@ dependencies:
         - 0
         - 0
         - rc
-        - 7
-        version: 2.0.0.rc.7
+        - 8
+        version: 2.0.0.rc.8
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -108,6 +108,7 @@ files:
 - spec/unit/search_magic/arrangements_spec.rb
 - spec/unit/search_magic/associations_spec.rb
 - spec/unit/search_magic/fields_spec.rb
+- spec/unit/search_magic/model_updates_spec.rb
 has_rdoc: true
 homepage: http://github.com/joshuabowers/search_magic
 licenses: []
@@ -156,3 +157,4 @@ test_files:
 - spec/unit/search_magic/arrangements_spec.rb
 - spec/unit/search_magic/associations_spec.rb
 - spec/unit/search_magic/fields_spec.rb
+- spec/unit/search_magic/model_updates_spec.rb