pose 1.0.0 → 1.1.0

data/README.md

@@ -1,4 +1,4 @@
-# Pose
+# Pose [![Build Status](https://secure.travis-ci.org/kevgo/pose.png)](http://travis-ci.org/#!/kevgo/pose)
 
 Pose  ("Polymorphic Search") allows fulltext search for ActiveRecord objects.
 
@@ -113,6 +113,16 @@ In this example, it found two results of type _MyClass_ and no results of type _
 Happy searching!  :)
 
 
+## Search options
+
+```ruby
+result = Pose.search 'foo',
+                     MyClass,
+                     :limit => 3,            # Limit the result count to 3.
+                     :result_type => :ids    # Don't load the resulting objects, return just their ids instead.
+```
+
+
 # Autocomplete support
 
 Because the search index contains a list of all the words known to the search engine,

data/lib/pose.rb

@@ -6,5 +6,5 @@ require 'pose/static_helpers'
 require 'pose/base_additions'
 require 'pose/model_additions'
 require 'pose/railtie' if defined? Rails
-require 'pose_assignment'
-require 'pose_word'
+require 'pose/models/pose_assignment'
+require 'pose/models/pose_word'

data/lib/pose/base_additions.rb

@@ -2,8 +2,9 @@ module Pose
   module BaseAdditions
 
     def posify &block
+      raise "You must provide a block that returns the searchable content to 'posify'." unless block_given?
       include Pose::ModelAdditions
-      self.pose_content = block_given? ? block : :pose_content.to_proc
+      self.pose_content = block
     end
 
   end

data/lib/pose/static_helpers.rb

@@ -90,10 +90,10 @@ module Pose
     #
     # @param [String] query
     # @param (Class|[Array<Class>]) classes
-    # @param [Number?] limit Optional limit.
+    # @param [Hash?] options Additional options.
     #
     # @return [Hash<Class, ActiveRecord::Relation>]
-    def search query, classes, limit = nil
+    def search query, classes, options = {}
 
       # Turn 'classes' into an array.
       classes = [classes].flatten
@@ -106,11 +106,16 @@ module Pose
         current_word_classes_and_ids = {}
         classes.each { |clazz| current_word_classes_and_ids[clazz.name] = [] }
         query = PoseAssignment.joins(:pose_word) \
+                              .select('pose_assignments.posable_id, pose_assignments.posable_type') \
                               .where('pose_words.text LIKE ?', "#{query_word}%") \
                               .where('posable_type IN (?)', classes_names)
-        query.each do |pose_assignment|
-          current_word_classes_and_ids[pose_assignment.posable_type] << pose_assignment.posable_id
+        PoseAssignment.connection.select_all(query.to_sql).each do |pose_assignment|
+          current_word_classes_and_ids[pose_assignment['posable_type']] << pose_assignment['posable_id']
         end
+        # This is the old ActiveRecord way. Removed for performance reasons.
+        # query.each do |pose_assignment|
+        #   current_word_classes_and_ids[pose_assignment.posable_type] << pose_assignment.posable_id
+        # end
 
         current_word_classes_and_ids.each do |class_name, ids|
           if result_classes_and_ids.has_key? class_name
@@ -127,8 +132,8 @@ module Pose
           result_class = Kernel.const_get class_name
 
           if ids.any? && classes.include?(result_class)
-            ids = ids.slice(0, limit) if limit
-            result[result_class] = result_class.where :id => ids
+            ids = ids.slice(0, options[:limit]) if options[:limit]
+            result[result_class] = options[:result_type] == :ids ? ids : result_class.where(:id => ids)
           else
             result[result_class] = []
           end

data/lib/pose/version.rb

@@ -1,3 +1,3 @@
 module Pose
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/pose_assignment_spec.rb

@@ -9,8 +9,8 @@ describe PoseAssignment do
   describe "delete_class_index" do
     
     before :each do
-      Factory :pose_assignment, :posable_id => 1, :posable_type => 'PosableOne'
-      Factory :pose_assignment, :posable_id => 2, :posable_type => 'PosableTwo'
+      FactoryGirl.create :pose_assignment, :posable_id => 1, :posable_type => 'PosableOne'
+      FactoryGirl.create :pose_assignment, :posable_id => 2, :posable_type => 'PosableTwo'
       PoseAssignment.delete_class_index PosableOne
     end
     
@@ -26,20 +26,20 @@ describe PoseAssignment do
   describe "cleanup_orphaned_pose_assignments" do
     
     it "deletes the assignment if the posable object doesn't exist" do
-      Factory :pose_assignment, :posable_id => 2, :posable_type => 'PosableOne'
+      FactoryGirl.create :pose_assignment, :posable_id => 2, :posable_type => 'PosableOne'
       PoseAssignment.count.should > 0
       PoseAssignment.cleanup_orphaned_pose_assignments
       PoseAssignment.should have(0).items
     end
     
     it "deletes the assignment if the pose_word doesn't exist" do
-      assignment = Factory :pose_assignment, :pose_word => nil, :pose_word_id => 27
+      assignment = FactoryGirl.create :pose_assignment, :pose_word => nil, :pose_word_id => 27
       PoseAssignment.cleanup_orphaned_pose_assignments
       PoseAssignment.find_by_id(assignment.id).should be_nil
     end
     
     it "doesn't delete the assignment if it is still used" do
-      assignment = Factory :pose_assignment
+      assignment = FactoryGirl.create :pose_assignment
       PoseAssignment.cleanup_orphaned_pose_assignments
       PoseAssignment.find_by_id(assignment.id).should_not be_nil
     end

data/spec/pose_spec.rb

@@ -208,7 +208,7 @@ describe Pose do
       result[PosableOne][0].should == pos1
     end
 
-    context 'classes parameter' do
+    describe 'classes parameter' do
       it 'returns all different classes by default' do
         pos1 = PosableOne.create :text => 'foo'
         pos2 = PosableTwo.create :text => 'foo'
@@ -242,7 +242,7 @@ describe Pose do
       end
     end
 
-    context 'query parameter' do
+    describe 'query parameter' do
 
       it 'returns an empty array if nothing matches' do
         pos1 = PosableOne.create :text => 'one'
@@ -273,19 +273,40 @@ describe Pose do
       end
     end
 
-    context "'limit' parameter" do
+    describe "'limit' parameter" do
 
       it 'works' do
-        Factory :posable_one, :text => 'foo one'
-        Factory :posable_one, :text => 'foo two'
-        Factory :posable_one, :text => 'foo three'
-        Factory :posable_one, :text => 'foo four'
+        FactoryGirl.create :posable_one, :text => 'foo one'
+        FactoryGirl.create :posable_one, :text => 'foo two'
+        FactoryGirl.create :posable_one, :text => 'foo three'
+        FactoryGirl.create :posable_one, :text => 'foo four'
 
-        result = Pose.search 'foo', PosableOne, 3
+        result = Pose.search 'foo', PosableOne, :limit => 3
 
         result[PosableOne].should have(3).items
       end
     end
+
+    describe "'result_type' parameter" do
+
+      before :each do
+        @foo_one = FactoryGirl.create :posable_one, :text => 'foo one'
+      end
+
+      describe 'default behavior' do
+        it 'returns full objects' do
+          result = Pose.search 'foo', PosableOne
+          result[PosableOne][0].should == @foo_one
+        end
+      end
+
+      context ':ids given' do
+        it 'returns ids instead of objects' do
+          result = Pose.search 'foo', PosableOne, :result_type => :ids
+          result[PosableOne][0].should == @foo_one.id
+        end
+      end
+    end
   end
 
   describe 'autocomplete_words' do

data/spec/pose_word_spec.rb

@@ -9,13 +9,13 @@ describe PoseWord do
   describe 'remove_unused_words' do
 
     it 'removes unused words' do
-      Factory :pose_word
+      FactoryGirl.create :pose_word
       PoseWord.remove_unused_words
       PoseWord.count.should == 0
     end
     
     it "doesn't remove used words" do
-      snippet = Factory :posable_one
+      snippet = FactoryGirl.create :posable_one
       PoseWord.remove_unused_words
       PoseWord.count.should > 0
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pose
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-02 00:00:00.000000000 Z
+date: 2012-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70121989270460 !ruby/object:Gem::Requirement
+  requirement: &70182202899340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70121989270460
+  version_requirements: *70182202899340
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70121989278420 !ruby/object:Gem::Requirement
+  requirement: &70182202897100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70121989278420
+  version_requirements: *70182202897100
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
-  requirement: &70121993362680 !ruby/object:Gem::Requirement
+  requirement: &70182202895340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70121993362680
+  version_requirements: *70182202895340
 - !ruby/object:Gem::Dependency
   name: factory_girl
-  requirement: &70121993370180 !ruby/object:Gem::Requirement
+  requirement: &70182202890340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121993370180
+  version_requirements: *70182202890340
 - !ruby/object:Gem::Dependency
   name: faker
-  requirement: &70121993367740 !ruby/object:Gem::Requirement
+  requirement: &70182202708040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121993367740
+  version_requirements: *70182202708040
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70121993380460 !ruby/object:Gem::Requirement
+  requirement: &70182202704860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121993380460
+  version_requirements: *70182202704860
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70121993397120 !ruby/object:Gem::Requirement
+  requirement: &70182202700960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121993397120
+  version_requirements: *70182202700960
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70121993395560 !ruby/object:Gem::Requirement
+  requirement: &70182202696980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70121993395560
+  version_requirements: *70182202696980
 description: Pose ('Polymorphic Search') allows fulltext search for ActiveRecord objects.
 email:
 - kevin.goslar@gmail.com
@@ -129,12 +129,12 @@ files:
 - lib/generators/templates/migration.rb
 - lib/pose/base_additions.rb
 - lib/pose/model_additions.rb
+- lib/pose/models/pose_assignment.rb
+- lib/pose/models/pose_word.rb
 - lib/pose/railtie.rb
 - lib/pose/static_helpers.rb
 - lib/pose/version.rb
 - lib/pose.rb
-- lib/pose_assignment.rb
-- lib/pose_word.rb
 - lib/tasks/pose_tasks.rake
 - MIT-LICENSE
 - Rakefile
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A polymorphic, storage-system independent search engine for Ruby on Rails.