pose 1.2.5 → 1.3

data/README.md

@@ -55,7 +55,7 @@ end
 ```
 
 Note that you can return whatever content you want in the `posify` block,
-not only data from this object, but also data from related objects, class names, etc. 
+not only data from this object, but also data from related objects, class names, etc.
 
 Now that this class is posified, any `create`, `update`, or `delete` operation on any instance of this class will update the search index automatically.
 
@@ -106,7 +106,7 @@ result = Pose.search 'foo', MyClass
 
 ### Configure the result data
 
-By default, search results are the instances of the objects matching the search query. 
+By default, search results are the instances of the objects matching the search query.
 If you want to just get the ids of the search results, and not the full instances, use the parameter `:result_type`.
 
 ```ruby
@@ -126,25 +126,25 @@ result = Pose.search 'foo', MyClass, limit: 20    # Returns only 20 search resul
 
 ### Combine fulltext search with structured data search
 
-You can add your own ActiveRecord query clauses to a fulltext search operation. 
+You can add your own ActiveRecord query clauses to a fulltext search operation.
 For example, given a class `Note` that belongs to a `User` class and has a boolean attribute `public`,
 finding all public notes from other users containing "foo" is as easy as:
 
 ```ruby
-result = Pose.search 'foo', MyClass, where: [ public: true, ['user_id <> ?', @current_user.id] ]    
+result = Pose.search 'foo', MyClass, where: [ public: true, ['user_id <> ?', @current_user.id] ]
 ```
 
 
 ## Maintenance
 
-Besides an accasional search index cleanup, Pose is relatively maintenance free. 
+Besides an accasional search index cleanup, Pose is relatively maintenance free.
 The search index is automatically updated when objects are created, updated, or deleted.
 
 
 ### Optimizing the search index
 
 For performance reasons, the search index keeps all the words that were ever used around, in order to try to reuse them as much as possible.
-After deleting or changing a large number of objects, you can shrink the memory consumption of Pose's search index by 
+After deleting or changing a large number of objects, you can shrink the memory consumption of Pose's search index by
 removing no longer used search terms from it.
 
 ```bash
@@ -161,7 +161,7 @@ rake pose:index:recreate[MyClass]
 ```
 
 
-# Uninstalling
+## Uninstalling
 
 To remove all traces of Pose from your database, run:
 
@@ -174,14 +174,36 @@ Also don't forget to remove the `posify` block from your models as well as the g
 
 ## Use Pose in your tests
 
-By default, Pose doesn't run in Rails' `test` environment. This is to not slow down tests due to constant updating of the search index when objects are created.
-If you want to test your models search functionality, you need to enable searching in tests:
+Pose can slow down your tests, because it updates the search index on every `:create`, `:update`, and `:delete`
+operation in the database.
+If this becomes a problem, you can disable Pose in your `test` environments,
+and only enable it for the tests that actually need search functionality.
+
+To disable Pose for tests, add this line to `config/environments/test.rb`
 
 ```ruby
-Pose::CONFIGURATION[:search_in_tests] = true
+Pose::CONFIGURATION[:perform_search] = false
+```
+
+Now, with search disabled in the test environment, enable Pose in some of your tests by setting the same value to `true` inside the tests:
+
+```ruby
+
+context 'with search enabled' do
+
+  before :all do
+    Pose::CONFIGURATION[:perform_search] = true
+  end
+
+  after :all do
+    Pose::CONFIGURATION[:perform_search] = false
+  end
+
+  it 'has search enabled in this test here...'
+
+  it 'has search enabled in this test as well...'
+end
 ```
-    
-Please don't forget to set this value to `false` when you are done, or your remaining tests will be slow. A good place to enable/disable this flag is in before/after blocks of your test cases.
 
 
 ## Development
@@ -192,8 +214,8 @@ Or, clone the repository, make your changes, and submit a pull request.
 
 ### Run the unit tests for the Pose Gem
 
-Pose uses Postgresql for tests, since it is the most strict database.
-To run tests, first, create a test database.
+For now, Pose uses Postgresql for tests, since it is free, and one of the most strict databases.
+To run tests, first create a test database.
 
 ```bash
 createdb pose_test

data/lib/pose/models/pose_word.rb

@@ -9,7 +9,7 @@ class PoseWord < ActiveRecord::Base
       # Will generate something like:
       #
       # DELETE FROM "pose_words" WHERE "pose_words"."id" IN
-      # (SELECT "pose_words"."id" FROM "pose_words" INNER JOIN "pose_assignments" ON "pose_assignments"."id" = "pose_words"."user_id"
+      # (SELECT "pose_words"."id" FROM "pose_words" INNER JOIN "pose_assignments" ON "pose_assignments"."pose_word_id" = "pose_words"."id"
       # HAVING.... GROUP BY "pose_words"."id")
       PoseWord.delete_all(id: PoseWord.select("pose_words.id").
                           joins("LEFT OUTER JOIN pose_assignments ON pose_assignments.pose_word_id = pose_words.id").

data/lib/pose/static_api.rb

@@ -2,9 +2,11 @@
 
 module Pose
 
-  # By default, doesn't run in tests.
-  # Set this to true to test the search functionality.
-  CONFIGURATION = { search_in_tests: false }
+  # By default, performs search functionality everywhere.
+  # Since this can severely slow down your tests,
+  # disable this setting in your "test" environments,
+  # and enable it for tests that verify search functionality.
+  CONFIGURATION = { perform_search: true }
 
   class <<self
 
@@ -24,7 +26,7 @@ module Pose
     #
     # @return [false, true]
     def perform_search?
-      !(Rails.env == 'test' and !CONFIGURATION[:search_in_tests])
+      CONFIGURATION.has_key?(:perform_search) ? CONFIGURATION[:perform_search] : true
     end
 
 

data/lib/pose/version.rb

@@ -1,3 +1,3 @@
 module Pose
-  VERSION = "1.2.5"
+  VERSION = "1.3"
 end

data/spec/pose_api_spec.rb

@@ -18,16 +18,16 @@ describe Pose do
     context "in the 'test' environment" do
       # Set global env configuration.
       before :each do
-        Pose::CONFIGURATION[:search_in_tests] = search_in_tests
+        Pose::CONFIGURATION[:perform_search] = perform_search
       end
 
       # Restores global configuration to default.
       after :each do
-        Pose::CONFIGURATION[:search_in_tests] = true
+        Pose::CONFIGURATION.delete :perform_search
       end
 
       context "search_in_tests flag is not enabled" do
-        let(:search_in_tests) { false }
+        let(:perform_search) { false }
 
         it "doesn't call update_pose_words" do
           subject.should_not_receive :update_pose_words
@@ -36,7 +36,7 @@ describe Pose do
       end
 
       context "search_in_tests flag is enabled" do
-        let(:search_in_tests) { true }
+        let(:perform_search) { true }
 
         it "calls update_pose_words" do
           subject.should_receive :update_pose_words
@@ -249,10 +249,10 @@ describe Pose do
         end
 
         it 'allows to combine several conditions' do
-          @three = FactoryGirl.create :posable_one, text: 'foo two', private: true
+          three = FactoryGirl.create :posable_one, text: 'foo two', private: true
           result = Pose.search 'foo', PosableOne, where: [ {private: true}, ['text = ?', 'foo two'] ]
           result[PosableOne].should have(1).item
-          result[PosableOne].should include @three
+          result[PosableOne].should include three
         end
       end
 

data/spec/spec_helper.rb

@@ -41,7 +41,6 @@ RSpec.configure do |config|
 
   config.before :suite do
     setup_db
-    Pose::CONFIGURATION[:search_in_tests] = true
     DatabaseCleaner.strategy = :deletion
   end
 

data/spec/support/matchers.rb

@@ -2,19 +2,12 @@
 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
+    actual.pose_words.map(&:text).sort == expected.sort
   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 ', '}]"
   end
-
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pose
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: '1.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-09 00:00:00.000000000 Z
+date: 2012-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails