search_magic 0.0.8 → 0.0.9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    search_magic (0.0.8)
+    search_magic (0.0.9)
       mongoid (>= 2.0.0)
 
 GEM

data/README.textile

@@ -86,7 +86,27 @@ end
 
 p. Now all entries within *:searchable_values* for *:tags* will retain meaningful punctuation. The previous example is interesting for another reason: embedded arrays are handled specially. Specifically, the selector for an embedded array will be singularized. In the case of the previous example, this would result in a selector of "tag".
 
-Finally, it should be noted that nesting of searchable documents is possible. (Currently, cyclic searches, where, for documents A and B, A searching on B which also searches on A should be avoided. Doing so is not prohibited, but will likely cause the environment to crash.) If a given document searches on an association with another document which, in and of itself, searches on a third document, the first automatically has access to the third document's searchable fields.
+Two documents may search on each other's fields; doing so will cause each document to only search upon those fields stemming from itself once. Given the following example, _Foo_ would be able to search on @[:name, :bar_value]@, while _Bar_ would be able to search on @[:value, :foo_name]@.
+
+bc.. class Foo
+  include Mongoid::Document
+  include SearchMagic::FullTextSearch
+  field :name
+  references_many :bars
+  search_on :name
+  search_on :bars
+end
+
+class Bar
+  include Mongoid::Document
+  include SearchMagic::FullTextSearch
+  field :value
+  referenced_in :foo
+  search_on :value
+  search_on :foo
+end
+
+Finally, it should be noted that nesting of searchable documents is possible. If a given document searches on an association with another document which, in and of itself, searches on a third document, the first automatically has access to the third document's searchable fields.
 
 bc.. class Part
   include Mongoid::Document
@@ -119,7 +139,7 @@ class PartCategory
   search_on :name
 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_
+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_for
 

data/lib/search_magic/breadcrumb.rb

@@ -0,0 +1,20 @@
+module SearchMagic
+  class Breadcrumb
+    attr_accessor :field_name, :options
+    
+    def initialize(field_name, options)
+      self.field_name = field_name
+      self.options = options
+      self.options[:except] = Array.wrap(self.options[:except]).compact
+      self.options[:only] = Array.wrap(self.options[:only]).compact
+    end
+    
+    def term
+      @term ||= options[:skip_prefix].presence ? nil : (options[:as] || field_name.to_s.pluralize.singularize)
+    end
+    
+    def clone
+      Breadcrumb.new(field_name, options)
+    end
+  end
+end

data/lib/search_magic/full_text_search.rb

@@ -51,25 +51,24 @@ module SearchMagic
       private 
       
       def create_searchables
-        fields = searchable_fields.map do |field_name, options|
-          if association = reflect_on_association(field_name)
-            options[:as] ||= nil
-            only = [options[:only]].flatten.compact
-            except = [:_D_E_A_D_B_3_3_F_, options[:except]].flatten.compact
-            associated = association.class_name.constantize.searchables
-            wanted = associated.keys.grep(/^(?!.*?(#{except.join("|")})).*/).grep(/^#{only.join("|")}/)
-            associated.select {|key, value| wanted.include?(key)}.map do |name, metadata|
-              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, :relation_metadata => association, :options => metadata.options.merge(options))
+        stack, visited, fields = [StackFrame.new(self)], {}, []
+        until stack.empty?
+          current = stack.shift
+          unless visited.has_key?(current.type)
+            visited[current.type] = true
+            current.type.searchable_fields.each do |field_name, options|
+              next unless current.wants_field?(field_name)
+              path = current.path.clone + [Breadcrumb.new(field_name, options)]
+              if association = current.type.reflect_on_association(field_name)
+                stack << StackFrame.new(association.class_name.constantize, path)
+              else
+                fields << Metadata.new(:origin_type => current.type, :through => path, :options => options)
+              end
             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)
           end
-        end.flatten
+        end
         
-        Hash[*fields.map {|metadata| [metadata.name, metadata]}.flatten]
+        fields.index_by(&:name)
       end
     end
   

data/lib/search_magic/metadata.rb

@@ -1,7 +1,7 @@
 module SearchMagic
   class Metadata
-    attr_accessor :type, :through, :prefix, :field_name, :relation_metadata, :options
-
+    attr_accessor :origin_type, :through, :options
+    
     def initialize(attributes = {})
       attributes.each do |key, value|
         send(:"#{key}=", value)
@@ -9,23 +9,28 @@ module SearchMagic
     end
   
     def name
-      @name ||= [options[:skip_prefix].presence ? nil : (prefix.present? ? (options[:as] || prefix) : nil), 
-                prefix.present? ? field_name : (options[:as] || field_name)].compact.join("_").to_sym
+      @name ||= through.map(&:term).compact.join("_").to_sym
     end
   
     def value_for(obj, keep_punctuation)
-      v = self.through.call(obj)
+      v = get_value(obj)
       v = v.is_a?(Array) ? v.join(" ") : v.to_s
       v = v.gsub(/[[:punct:]]/, ' ') unless keep_punctuation
       v
     end
     
     def arrangeable_value_for(obj)
-      self.through.call(obj)
+      get_value(obj)
     end
   
     def searchable_value_for(obj)
       value_for(obj, options[:keep_punctuation]).downcase.split.map {|word| [name, word].join(":")}
     end
+    
+    private
+    
+    def get_value(obj)
+      self.through.map(&:field_name).inject(obj) {|memo, method| memo.is_a?(Array) ? memo.map{|o| o.send(method)} : memo.send(method)}
+    end
   end
 end

data/lib/search_magic/stack_frame.rb

@@ -0,0 +1,28 @@
+module SearchMagic
+  class StackFrame
+    attr_accessor :type, :path
+    
+    def initialize(type, path = [])
+      self.type = type
+      self.path = path
+    end
+    
+    def wants_field?(field_name)
+      !field_excluded?(field_name) && field_included?(field_name)
+    end
+    
+    private
+    
+    def field_included?(field_name)
+      options[:only].blank? || options[:only].include?(field_name)
+    end
+    
+    def field_excluded?(field_name)
+      options[:except].present? && options[:except].include?(field_name)
+    end
+    
+    def options
+      @options ||= (path.last.try(:options) || {})
+    end    
+  end
+end

data/lib/search_magic/version.rb

@@ -1,3 +1,3 @@
 module SearchMagic
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/search_magic.rb

@@ -1,4 +1,6 @@
 module SearchMagic
+  require 'search_magic/breadcrumb'
+  require 'search_magic/stack_frame'
   require 'search_magic/metadata'
   require 'search_magic/full_text_search'
 end

data/spec/models/graph_1_model_a.rb

@@ -0,0 +1,8 @@
+class Graph1ModelA
+  include Mongoid::Document
+  include SearchMagic::FullTextSearch
+  field :foo
+  references_and_referenced_in_many :graph_1_model_bs
+  search_on :foo
+  search_on :graph_1_model_bs
+end

data/spec/models/graph_1_model_b.rb

@@ -0,0 +1,8 @@
+class Graph1ModelB
+  include Mongoid::Document
+  include SearchMagic::FullTextSearch
+  field :bar
+  references_and_referenced_in_many :graph_1_model_as
+  search_on :bar
+  search_on :graph_1_model_as
+end

data/spec/unit/search_magic/graph_searches_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe SearchMagic::FullTextSearch do
+  context "when given two models which search on each other" do
+    describe "calculating searchables from the first model" do
+      subject { Graph1ModelA }
+      it("should not raise an error") { expect { subject.searchables }.to_not raise_error }
+      its("searchables.keys") { should include(:foo, :graph_1_model_b_bar) }
+      its("searchables.keys") { should_not include(:graph_1_model_b_graph_1_model_a, :graph_1_model_b_graph_1_model_a_foo) }
+    end
+    
+    describe "calculating searchables from the second model" do
+      subject { Graph1ModelB }
+      it("should not raise an error") { expect { subject.searchables }.to_not raise_error }
+      its("searchables.keys") { should include(:bar, :graph_1_model_a_foo) }
+      its("searchables.keys") { should_not include(:graph_1_model_a_graph_1_model_b, :graph_1_model_a_graph_1_model_b_bar) }
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: search_magic
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors: 
 - Joshua Bowers
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-03 00:00:00 -07:00
+date: 2011-04-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,8 +73,10 @@ files:
 - README.textile
 - Rakefile
 - lib/search_magic.rb
+- lib/search_magic/breadcrumb.rb
 - lib/search_magic/full_text_search.rb
 - lib/search_magic/metadata.rb
+- lib/search_magic/stack_frame.rb
 - lib/search_magic/version.rb
 - search_magic.gemspec
 - spec/models/absolutely_not_searchable.rb
@@ -82,6 +84,8 @@ files:
 - spec/models/asset.rb
 - spec/models/developer.rb
 - spec/models/game.rb
+- spec/models/graph_1_model_a.rb
+- spec/models/graph_1_model_b.rb
 - spec/models/is_searchable.rb
 - spec/models/no_searchables.rb
 - spec/models/part.rb
@@ -94,6 +98,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/graph_searches_spec.rb
 - spec/unit/search_magic/model_updates_spec.rb
 has_rdoc: true
 homepage: http://github.com/joshuabowers/search_magic
@@ -129,6 +134,8 @@ test_files:
 - spec/models/asset.rb
 - spec/models/developer.rb
 - spec/models/game.rb
+- spec/models/graph_1_model_a.rb
+- spec/models/graph_1_model_b.rb
 - spec/models/is_searchable.rb
 - spec/models/no_searchables.rb
 - spec/models/part.rb
@@ -141,4 +148,5 @@ 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/graph_searches_spec.rb
 - spec/unit/search_magic/model_updates_spec.rb