pose 1.2.0 → 1.2.1

data/spec/pose_api_spec.rb

@@ -0,0 +1,279 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Pose do
+  subject { PosableOne.new }
+
+  describe 'associations' do
+    it 'allows to access the associated words of a posable object directly' do
+      subject.should have(0).pose_words
+      subject.pose_words << PoseWord.new(text: 'one')
+      subject.should have_pose_words(['one'])
+    end
+  end
+
+  describe '#update_pose_index' do
+
+    context "in the 'test' environment" do
+      # Set global env configuration.
+      before :each do
+        Pose::CONFIGURATION[:search_in_tests] = search_in_tests
+      end
+
+      # Restores global configuration to default.
+      after :each do
+        Pose::CONFIGURATION[:search_in_tests] = true
+      end
+
+      context "search_in_tests flag is not enabled" do
+        let(:search_in_tests) { false }
+
+        it "doesn't call update_pose_words" do
+          subject.should_not_receive :update_pose_words
+          subject.update_pose_index
+        end
+      end
+
+      context "search_in_tests flag is enabled" do
+        let(:search_in_tests) { true }
+
+        it "calls update_pose_words" do
+          subject.should_receive :update_pose_words
+          subject.update_pose_index
+        end
+      end
+    end
+
+    # TODO(REMOVE).
+    context "in the 'production' environment' do" do
+      before :each do
+        @old_env = Rails.env
+        Rails.env = 'production'
+        Pose::CONFIGURATION[:search_in_tests] = false
+      end
+
+      after :each do
+        Rails.env = @old_env
+        Pose::CONFIGURATION[:search_in_tests] = true
+      end
+
+      it "always calls update_pose_words, even when search_in_tests is disabled" do
+        subject.should_receive :update_pose_words
+        subject.update_pose_index
+      end
+    end
+  end
+
+
+  describe '#update_pose_words' do
+
+    it 'saves the words for search' do
+      subject.text = 'foo bar'
+      subject.update_pose_words
+      subject.should have_pose_words ['foo', 'bar']
+    end
+
+    it 'updates the search index when the text is changed' do
+      subject.text = 'foo'
+      subject.save!
+
+      subject.text = 'other text'
+      subject.update_pose_words
+
+      subject.should have_pose_words ['other', 'text']
+    end
+
+    it "doesn't create duplicate words" do
+      subject.text = 'foo foo'
+      subject.save!
+      subject.should have(1).pose_words
+    end
+  end
+
+
+  describe 'search' do
+
+    it 'works' do
+      pos = PosableOne.create text: 'foo'
+      result = Pose.search 'foo', PosableOne
+      result.should == { PosableOne => [pos] }
+    end
+
+    describe 'classes parameter' do
+
+      before :each do
+        @pos1 = PosableOne.create text: 'foo'
+        @pos2 = PosableTwo.create text: 'foo'
+      end
+
+      it 'returns all requested classes' do
+        result = Pose.search 'foo', [PosableOne, PosableTwo]
+
+        result.keys.should have(2).items
+        result.keys.should include PosableOne
+        result.keys.should include PosableTwo
+      end
+
+      it 'returns all matching instances of each requested class' do
+        result = Pose.search 'foo', [PosableOne, PosableTwo]
+
+        result[PosableOne].should == [@pos1]
+        result[PosableTwo].should == [@pos2]
+      end
+
+      it 'returns only instances of the given classes' do
+        result = Pose.search 'foo', PosableOne
+        result.keys.should include PosableOne
+        result.keys.should_not include PosableTwo
+      end
+    end
+
+    describe 'query parameter' do
+
+      it 'returns an empty array if nothing matches' do
+        pos1 = PosableOne.create text: 'one'
+        result = Pose.search 'two', PosableOne
+        result[PosableOne].should be_empty
+      end
+
+      it 'returns only objects that match all given query words' do
+        pos1 = PosableOne.create text: 'one two'
+        pos2 = PosableOne.create text: 'one three'
+        pos3 = PosableOne.create text: 'two three'
+
+        result = Pose.search 'two one', PosableOne
+
+        result[PosableOne].should == [pos1]
+      end
+
+      it 'returns nothing if searching for a non-existing word' do
+        pos1 = PosableOne.create text: 'one two'
+        result = Pose.search 'one zonk', PosableOne
+        result[PosableOne].should be_empty
+      end
+
+      it 'works if the query is given in uppercase' do
+        pos1 = PosableOne.create text: 'one two'
+        result = Pose.search 'OnE TwO', PosableOne
+        result[PosableOne].should == [pos1]
+      end
+    end
+
+
+    describe "'limit' parameter" do
+
+      it 'works' do
+        FactoryGirl.create :posable_one, text: 'foo one'
+        FactoryGirl.create :posable_one, text: 'foo two'
+        FactoryGirl.create :posable_one, text: 'foo three'
+
+        result = Pose.search 'foo', PosableOne, limit: 2
+
+        result[PosableOne].should have(2).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].first.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].first.should == @foo_one.id
+        end
+      end
+    end
+
+
+    describe "'scopes' parameter" do
+
+      before :each do
+        @one = FactoryGirl.create :posable_one, text: 'foo one', private: true
+        @bar = FactoryGirl.create :posable_one, text: 'bar one', private: true
+        @two = FactoryGirl.create :posable_one, text: 'foo two', private: false
+      end
+
+      context 'with result type :classes' do
+
+        it 'limits the result set by the given scope' do
+          result = Pose.search 'foo', PosableOne, scope: [ private: true ]
+          result[PosableOne].should have(1).item
+          result[PosableOne].should include @one
+        end
+
+        it 'allows to use the hash syntax for queries' do
+          result = Pose.search 'foo', PosableOne, scope: [ private: true ]
+          result[PosableOne].should have(1).item
+          result[PosableOne].should include @one
+        end
+
+        it 'allows to use the string syntax for queries' do
+          result = Pose.search 'foo', PosableOne, scope: [ ['private = ?', true] ]
+          result[PosableOne].should have(1).item
+          result[PosableOne].should include @one
+        end
+
+        it 'allows to combine several scopes' do
+          @three = FactoryGirl.create :posable_one, text: 'foo two', private: true
+          result = Pose.search 'foo', PosableOne, scope: [ {private: true}, ['text = ?', 'foo two'] ]
+          result[PosableOne].should have(1).item
+          result[PosableOne].should include @three
+        end
+      end
+
+      context 'with result type :ids' do
+
+        it 'limits the result set by the given scope' do
+          result = Pose.search 'foo', PosableOne, result_type: :ids, scope: [ private: true ]
+          result[PosableOne].should have(1).item
+          result[PosableOne].should include @one.id
+        end
+      end
+    end
+  end
+
+
+  describe 'autocomplete_words' do
+
+    it 'returns words that start with the given phrase' do
+      PosableOne.create text: 'great green pine tree'
+
+      result = Pose::Helpers.autocomplete_words 'gr'
+
+      result.should have(2).words
+      result.should include 'great'
+      result.should include 'green'
+    end
+
+    it 'returns words that match the given phrase exactly' do
+      PoseWord.create text: 'cat'
+      result = Pose::Helpers.autocomplete_words 'cat'
+      result.should == ['cat']
+    end
+
+    it 'stems the search query' do
+      PosableOne.create text: 'car'
+      result = Pose::Helpers.autocomplete_words 'cars'
+      result.should have(1).words
+      result[0].should == 'car'
+    end
+
+    it 'returns nothing if the search query is empty' do
+      PosableOne.create text: 'foo bar'
+      result = Pose::Helpers.autocomplete_words ''
+      result.should be_empty
+    end
+  end
+end

data/spec/pose_assignment_spec.rb

@@ -2,47 +2,44 @@ require 'spec_helper'
 
 describe PoseAssignment do
 
-  before :each do
-    PoseAssignment.delete_all
-  end
-  
   describe "delete_class_index" do
-    
+
     before :each do
       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
-    
+
     it "deletes all PoseAssignments for the given class" do
       PoseAssignment.where(posable_type: 'PosableOne').should have(0).items
     end
-    
+
     it "doesn't delete PoseAssignments for other classes" do
       PoseAssignment.where(posable_type: 'PosableTwo').should have(1).items
     end
   end
-    
+
+
   describe "cleanup_orphaned_pose_assignments" do
-    
+
     it "deletes the assignment if the posable object doesn't exist" do
       FactoryGirl.create :pose_assignment, posable_id: 2, posable_type: 'PosableOne'
       PoseAssignment.count.should > 0
       PoseAssignment.cleanup_orphaned_pose_assignments
-      PoseAssignment.should have(0).items
+      PoseAssignment.count.should == 0
     end
-    
+
     it "deletes the assignment if the pose_word doesn't exist" do
       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 = FactoryGirl.create :pose_assignment
       PoseAssignment.cleanup_orphaned_pose_assignments
       PoseAssignment.find_by_id(assignment.id).should_not be_nil
     end
   end
-  
+
 end

data/spec/pose_word_spec.rb

@@ -1,23 +1,26 @@
 require 'spec_helper'
 
 describe PoseWord do
-  
-  before :all do
-    PoseWord.delete_all
-  end
-  
-  describe 'remove_unused_words' do
 
-    it 'removes unused words' do
-      FactoryGirl.create :pose_word
-      PoseWord.remove_unused_words
-      PoseWord.count.should == 0
-    end
-    
-    it "doesn't remove used words" do
-      snippet = FactoryGirl.create :posable_one
-      PoseWord.remove_unused_words
-      PoseWord.count.should > 0
+  describe 'class methods' do
+    subject { PoseWord }
+
+    describe '::remove_unused_words' do
+
+      before :each do
+        instantiate_objects
+        PoseWord.remove_unused_words
+      end
+
+      context 'having unused words' do
+        let(:instantiate_objects) { FactoryGirl.create :pose_word }
+        its(:count) { should == 0 }
+      end
+
+      context 'having used words' do
+        let(:instantiate_objects) { FactoryGirl.create :posable_one }
+        its(:count) { should > 0 }
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -9,6 +9,8 @@ require 'active_support/core_ext/string'
 require 'pose'
 require 'faker'
 require 'factory_girl'
+require 'database_cleaner'
+
 FactoryGirl.find_definitions
 
 # Configure Rails Environment
@@ -16,7 +18,7 @@ ENV["RAILS_ENV"] = "test"
 Rails = Hashie::Mash.new({env: 'test'})
 
 # We have no Railtie in these tests --> load Pose manually.
-ActiveRecord::Base.send :extend, Pose::BaseAdditions
+ActiveRecord::Base.send :extend, Pose::ActiveRecordBaseAdditions
 
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
@@ -35,51 +37,21 @@ RSpec.configure do |config|
   # If you're not using ActiveRecord, or you'd prefer not to run each of your
   # examples within a transaction, remove the following line or assign false
   # instead of true.
-#  config.use_transactional_fixtures = true
+  # config.use_transactional_fixtures = true
 
   config.before :suite do
     setup_db
     Pose::CONFIGURATION[:search_in_tests] = true
+    DatabaseCleaner.strategy = :deletion
   end
-  
-  config.after :suite do 
-    teardown_db
-  end
-end
 
-
-#####################
-# MATCHERS
-#
-
-# Verifies that a taggable object has the given tags.
-RSpec::Matchers.define :have_pose_words do |expected|
-  match do |actual|
-    actual.should have(expected.size).pose_words
-    texts = actual.pose_words.map &:text
-    expected.each do |expected_word|
-      # Note (KG): Can't use text.should include(expected_word) here 
-      #            because Ruby thinks I want to include a Module for some reason.
-      texts.include?(expected_word).should be_true
-    end
-  end
-  failure_message_for_should do |actual|
-    texts = actual.pose_words.map &:text
-    "expected that subject would have pose words [#{expected.join ', '}], but it has [#{texts.join ', '}]"
+  config.before :each do
+    DatabaseCleaner.start
   end
-end
-
 
-#####################
-# TEST CLASSES
-#
-
-class PosableOne < ActiveRecord::Base
-  posify { text }
-end
-
-class PosableTwo < ActiveRecord::Base
-  posify { text }
+  config.after :each do
+    DatabaseCleaner.clean
+  end
 end
 
 
@@ -88,32 +60,37 @@ end
 #
 
 def setup_db
-  ActiveRecord::Schema.define(version: 1) do
+  ActiveRecord::Base.establish_connection adapter:      'postgresql',
+                                          database:     'pose_test',
+                                          min_messages: 'INFO'
 
-    create_table 'posable_ones' do |t|
-      t.string 'text'
-      t.boolean 'private'
+  ActiveRecord::Schema.define(version: 1) do
+    unless table_exists? 'posable_ones'
+      create_table 'posable_ones' do |t|
+        t.string 'text'
+        t.boolean 'private'
+      end
     end
 
-    create_table 'posable_twos' do |t|
-      t.string 'text'
-      t.boolean 'private'
+    unless table_exists? 'posable_twos'
+      create_table 'posable_twos' do |t|
+        t.string 'text'
+        t.boolean 'private'
+      end
     end
 
-    create_table "pose_assignments" do |t|
-      t.integer "pose_word_id",            null: false
-      t.integer "posable_id",              null: false
-      t.string  "posable_type", limit: 20, null: false
+    unless table_exists? 'pose_assignments'
+      create_table "pose_assignments" do |t|
+        t.integer "pose_word_id",            null: false
+        t.integer "posable_id",              null: false
+        t.string  "posable_type", limit: 20, null: false
+      end
     end
 
-    create_table "pose_words" do |t|
-      t.string "text", limit: 80, null: false
+    unless table_exists? 'pose_words'
+      create_table "pose_words" do |t|
+        t.string "text", limit: 80, null: false
+      end
     end
   end
 end
-
-def teardown_db
-  ActiveRecord::Base.connection.tables.each do |table|
-    ActiveRecord::Base.connection.drop_table(table)
-  end
-end