search_magic 0.0.3 → 0.0.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    search_magic (0.0.2)
+    search_magic (0.0.3)
       mongoid (>= 2.0.0.rc.7)
 
 GEM

data/README.textile

@@ -29,10 +29,14 @@ 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*_ method:
 
 bc. Address.search("state:ca")
 
+It is also possible to sort models on fields which have been marked as searchable through the _*:arrange*_ method:
+
+bc. Address.arrange(:state, :asc)
+
 h3. :search_on
 
 Fields that are made searchable by :search_on have their values cached in an embedded array within each document. This array, *:searchable_values*, should contain entries of the form *field_name:value*. The selector, *field_name*, represents a filter which can be used when searching to narrow the search space; it can be manually renamed by passing the *:as* option to :search_on:
@@ -124,6 +128,18 @@ 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"
 
+h3. :arrange
+
+SearchMagic also provides a utility scope for arranging the model by the searchables defined within it. This method, _*:arrange*_, has one required parameter specifying the searchable to sort on and one optional parameter specifying the sort direction. (If the second parameter is omitted, it will default to ascending.)
+
+bc. Part.arrange(:serial)
+Part.arrange(:serial, :asc) # same as last example
+Part.arrange(:category_name, :desc) # arrange the parts in descending order by :category_name
+
+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)
+
 h2. Problems? Comments?
 
 Feel free to add an "issue on GitHub":search_magic/issues or fork the project and send a pull request. I'm always looking for new ways of bending hardware to my will, so suggestions are welcome.

data/lib/search_magic/full_text_search.rb

@@ -5,7 +5,9 @@ module SearchMagic
         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 = {})
@@ -31,6 +33,10 @@ module SearchMagic
         end
       end
       
+      def arrange(arrangeable, direction = :asc)
+        arrangeable.blank? || !searchables.keys.include?(arrangeable) ? criteria : order_by(["arrangeable_values.#{arrangeable}", direction])
+      end
+      
       private 
       
       def create_searchables
@@ -38,9 +44,10 @@ module SearchMagic
           if association = reflect_on_association(field_name)
             options[:as] ||= nil
             only = [options[:only]].flatten.compact
-            except = [options[:except]].flatten.compact
-            associated = association.class_name.constantize.searchables.reject {|key, value| except.include?(key) }.select {|key, value| only.blank? ? true : only.include?(key) }
-            associated.map do |name, metadata|
+            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)
@@ -62,36 +69,12 @@ module SearchMagic
         self.searchable_values = self.class.searchables.values.map {|metadata| metadata.searchable_value_for(self)}.flatten
       end
       
-      def find_searchable_value(name)
-        matches = self.searchable_values.grep(/^#{name}:(.*)/){$1}
-        matches.count == 1 ? matches.first : matches
-      end
-    end
-    
-    class Metadata
-      attr_accessor :type, :through, :prefix, :field_name, :options
-
-      def initialize(attributes = {})
-        attributes.each do |key, value|
-          send(:"#{key}=", value)
+      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
-      
-      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
-      end
-      
-      def value_for(obj)
-        v = self.through.call(obj)
-        v = v.is_a?(Array) ? v.join(" ") : v.to_s
-        v = v.gsub(/[[:punct:]]/, ' ') unless options[:keep_punctuation]
-        v
-      end
-      
-      def searchable_value_for(obj)
-        value_for(obj).downcase.split.map {|word| [name, word].join(":")}
-      end
     end
   
     def self.included(receiver)

data/lib/search_magic/metadata.rb

@@ -0,0 +1,31 @@
+module SearchMagic
+  class Metadata
+    attr_accessor :type, :through, :prefix, :field_name, :options
+
+    def initialize(attributes = {})
+      attributes.each do |key, value|
+        send(:"#{key}=", value)
+      end
+    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
+    end
+  
+    def value_for(obj, keep_punctuation)
+      v = self.through.call(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)
+    end
+  
+    def searchable_value_for(obj)
+      value_for(obj, options[:keep_punctuation]).downcase.split.map {|word| [name, word].join(":")}
+    end
+  end
+end

data/lib/search_magic/version.rb

@@ -1,3 +1,3 @@
 module SearchMagic
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/search_magic.rb

@@ -1,3 +1,4 @@
 module SearchMagic
+  require 'search_magic/metadata'
   require 'search_magic/full_text_search'
 end

data/spec/models/developer.rb

@@ -0,0 +1,10 @@
+class Developer
+  include Mongoid::Document
+  include SearchMagic::FullTextSearch
+  field :name
+  field :opened_on, :type => Date
+  references_many :games
+  
+  search_on :name
+  search_on :opened_on
+end

data/spec/models/game.rb

@@ -0,0 +1,15 @@
+class Game
+  include Mongoid::Document
+  include SearchMagic::FullTextSearch
+  field :title
+  field :price, :type => Float
+  field :high_score, :type => Integer
+  field :released_on, :type => Date
+  references_and_referenced_in_many :players
+  referenced_in :developer
+  
+  search_on :title
+  search_on :price
+  search_on :high_score
+  search_on :developer, :except => :opened_on
+end

data/spec/models/player.rb

@@ -0,0 +1,9 @@
+class Player
+  include Mongoid::Document
+  include SearchMagic::FullTextSearch
+  field :name
+  references_and_referenced_in_many :games
+  
+  search_on :name
+  search_on :games, :only => [:title, :developer]
+end

data/spec/unit/search_magic/arrangements_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe SearchMagic::FullTextSearch do
+  context "when included in a model without :searchables" do
+    subject { NoSearchables }
+    its("fields.keys") { should include("arrangeable_values") }
+    describe "arrangeable_values" do
+      subject { NoSearchables.fields["arrangeable_values"] }
+      its(:type) { should == Hash }
+      its(:default) { should == {} }
+    end
+    
+    it { should respond_to(:arrange).with(2).argument }
+  end
+  
+  describe "saving a model should run the :update_arrangeable_values callback" do
+    subject { Asset.new }
+    after(:each) { subject.save }
+    it { subject.should_receive :update_arrangeable_values }
+  end
+  
+  context "when a model is saved, its :arrangeable_values update" do
+    subject { Asset.new(:title => "Foo Bar: The Bazzening", :description => "Sequel to last years hit summer blockbuster.", :tags => ["movies", "foo.bar", "the-bazzening"], :uuid => "ae9d14ee-be93-11df-9fec-78ca39fffe11")}
+    before(:each) { subject.save }
+    its(:arrangeable_values) { should_not be_empty }
+    its(:arrangeable_values) { should include(:title => "Foo Bar: The Bazzening") }
+    its(:arrangeable_values) { should include(:description => "Sequel to last years hit summer blockbuster.", ) }
+    its(:arrangeable_values) { should include(:tag => ["movies", "foo.bar", "the-bazzening"]) }
+    its("arrangeable_values.keys") { should_not include(:uuid) }
+  end
+  
+  context "when :arrange is performed on a model with :searchables" do
+    before(:each) do
+      Asset.create(:title => "Foo Bar: The Bazzening", :description => "Sequel to last years hit summer blockbuster.", :tags => ["movies", "suspense", "foo.bar", "the-bazzening"])
+      Asset.create(:title => "Undercover Foo", :description => "When a foo goes undercover, how far will he go to protect those he loves?", :tags => ["movies", "action", "undercover.foo"])
+      Asset.create(:title => "Cheese of the Damned", :description => "This is not your father's munster.", :tags => ["movies", "horror", "cheese", "munster"])
+    end
+    
+    context "when arranging a model by nil" do
+      subject { Asset.arrange(nil) }
+      it { should be_a(Mongoid::Criteria) }
+      its(:options) { should be_empty }
+      its("options.keys") { should_not include(:sort) }
+    end
+    
+    context "when arranging a model by ''" do
+      subject { Asset.arrange("") }
+      it { should be_a(Mongoid::Criteria) }
+      its(:options) { should be_empty }
+      its("options.keys") { should_not include(:sort) }
+    end
+    
+    context "when arranging a model by a non searchable" do
+      subject { Asset.arrange(:is_not_searchable) }
+      it { should be_a(Mongoid::Criteria) }
+      its(:options) { should be_empty }
+      its("options.keys") { should_not include(:sort) }
+    end
+    
+    context "when arranging a model by a searchable" do
+      subject { Asset.arrange(:title) }
+      it { should be_a(Mongoid::Criteria) }
+      its(:options) { should_not be_empty }
+      its(:options) { should include(:sort => ["arrangeable_values.title", :asc]) }
+    end
+    
+    shared_examples_for "arranged assets" do |arrangeable, direction, expected_order|
+      context "when arranging a model by '#{arrangeable}' => '#{direction || 'nil'}'" do
+        subject { (direction.present? ? Asset.arrange(arrangeable, direction) : Asset.arrange(arrangeable)).map(&:title) }
+        it { should == expected_order }
+      end      
+    end
+    
+    it_should_behave_like "arranged assets", :title, nil, ["Cheese of the Damned", "Foo Bar: The Bazzening", "Undercover Foo"]
+    it_should_behave_like "arranged assets", :description, nil, ["Foo Bar: The Bazzening", "Cheese of the Damned", "Undercover Foo"]
+    it_should_behave_like "arranged assets", :tag, nil, ["Undercover Foo", "Cheese of the Damned", "Foo Bar: The Bazzening"]
+    
+    it_should_behave_like "arranged assets", :title, :asc, ["Cheese of the Damned", "Foo Bar: The Bazzening", "Undercover Foo"]
+    it_should_behave_like "arranged assets", :description, :asc, ["Foo Bar: The Bazzening", "Cheese of the Damned", "Undercover Foo"]
+    it_should_behave_like "arranged assets", :tag, :asc, ["Undercover Foo", "Cheese of the Damned", "Foo Bar: The Bazzening"]
+    
+    it_should_behave_like "arranged assets", :title, :desc, ["Undercover Foo", "Foo Bar: The Bazzening", "Cheese of the Damned"]
+    it_should_behave_like "arranged assets", :description, :desc, ["Undercover Foo", "Cheese of the Damned", "Foo Bar: The Bazzening"]
+    it_should_behave_like "arranged assets", :tag, :desc, ["Foo Bar: The Bazzening", "Cheese of the Damned", "Undercover Foo"]
+  end
+end

data/spec/unit/search_magic/associations_spec.rb

@@ -16,6 +16,18 @@ describe SearchMagic::FullTextSearch do
     its("searchables.keys") { should include(:part_number, :category_name) }
   end
   
+  context "when a model excludes an associated documents fields" do
+    subject { Game }
+    its("searchables.keys") { should include(:title, :price, :high_score, :developer_name) }
+    its("searchables.keys") { should_not include(:developer_opened_on) }
+  end
+  
+  context "when a model only includes certain fields from an associated document" do
+    subject { Player }
+    its("searchables.keys") { should include(:name, :game_title, :game_developer_name) }
+    its("searchables.keys") { should_not include(:game_price, :game_high_score, :game_developer_opened_on)}
+  end
+  
   context "when a model embeds one other document" 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"}])

data/spec/unit/search_magic/fields_spec.rb

@@ -35,7 +35,7 @@ describe SearchMagic::FullTextSearch do
     it { subject.should_receive :update_searchable_values }
   end
   
-  context "when a model is saved, its :_searchable_values update" do
+  context "when a model is saved, its :searchable_values update" do
     subject { Asset.new(:title => "Foo Bar: The Bazzening", :description => "Sequel to last years hit summer blockbuster.", :tags => ["movies", "foo.bar", "the-bazzening"], :uuid => "ae9d14ee-be93-11df-9fec-78ca39fffe11")}
     before(:each) { subject.save }
     its(:searchable_values) { should_not be_empty }

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Joshua Bowers
@@ -90,17 +90,22 @@ files:
 - Rakefile
 - lib/search_magic.rb
 - lib/search_magic/full_text_search.rb
+- lib/search_magic/metadata.rb
 - lib/search_magic/version.rb
 - search_magic.gemspec
 - spec/models/address.rb
 - spec/models/asset.rb
+- spec/models/developer.rb
+- spec/models/game.rb
 - spec/models/no_searchables.rb
 - spec/models/part.rb
 - spec/models/part_category.rb
 - spec/models/part_number.rb
 - spec/models/person.rb
 - spec/models/phone.rb
+- spec/models/player.rb
 - spec/spec_helper.rb
+- spec/unit/search_magic/arrangements_spec.rb
 - spec/unit/search_magic/associations_spec.rb
 - spec/unit/search_magic/fields_spec.rb
 has_rdoc: true
@@ -138,12 +143,16 @@ summary: SearchMagic provides scoped full text search and sort capabilities to M
 test_files: 
 - spec/models/address.rb
 - spec/models/asset.rb
+- spec/models/developer.rb
+- spec/models/game.rb
 - spec/models/no_searchables.rb
 - spec/models/part.rb
 - spec/models/part_category.rb
 - spec/models/part_number.rb
 - spec/models/person.rb
 - spec/models/phone.rb
+- spec/models/player.rb
 - spec/spec_helper.rb
+- spec/unit/search_magic/arrangements_spec.rb
 - spec/unit/search_magic/associations_spec.rb
 - spec/unit/search_magic/fields_spec.rb