pose 0.0.2

data/spec/pose_spec.rb

@@ -0,0 +1,256 @@
+require "spec_helper"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+class PosableOne < ActiveRecord::Base
+  posify { [text] }
+end
+
+class PosableTwo < ActiveRecord::Base
+  posify { [text] }
+end
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+
+    create_table 'posable_ones' do |t|
+      t.string 'text'
+    end
+
+    create_table 'posable_twos' do |t|
+      t.string 'text'
+    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
+    end
+
+    create_table "pose_words" do |t|
+      t.string "text", :limit => 80, :null => false
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+
+describe Pose do
+  subject { PosableOne.new }
+
+  before :all do
+    setup_db
+    Pose::CONFIGURATION[:search_in_tests] = true
+  end
+
+  after :all do
+    teardown_db
+    Pose::CONFIGURATION[:search_in_tests] = false
+  end
+  
+  before :each do
+    PosableOne.delete_all
+    PosableTwo.delete_all
+    PoseAssignment.delete_all
+    PoseWord.delete_all
+  end
+  
+  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
+      after :each do
+        Pose::CONFIGURATION[:search_in_tests] = true
+      end
+      
+      it "doesn't calls update_pose_words in tests if the test flag is not enabled" do
+        Pose::CONFIGURATION[:search_in_tests] = false
+        subject.should_not_receive :update_pose_words
+        subject.update_pose_index
+      end
+
+      it "calls update_pose_words in tests if the test flag is enabled" do
+        Pose::CONFIGURATION[:search_in_tests] = true
+        subject.should_receive :update_pose_words
+        subject.update_pose_index
+      end
+    end
+    
+    context "in the 'production' environment' do" do
+      before :each do
+        @old_env = Rails.env
+        Rails.env = 'production'
+      end
+      
+      after :each do
+        Rails.env = @old_env
+      end
+      
+      it "calls update_pose_words" 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(2).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 'get_words_to_remove' do
+
+    it "returns an array of word objects that need to be removed" do
+      word1 = PoseWord.new :text => 'one'
+      word2 = PoseWord.new :text => 'two'
+      existing_words = [word1, word2]
+      new_words = ['one', 'three']
+
+      result = Pose.get_words_to_remove existing_words, new_words
+
+      result.should eql([word2])
+    end
+
+    it 'returns an empty array if there are no words to be removed' do
+      word1 = PoseWord.new :text => 'one'
+      word2 = PoseWord.new :text => 'two'
+      existing_words = [word1, word2]
+      new_words = ['one', 'two']
+
+      result = Pose.get_words_to_remove existing_words, new_words
+
+      result.should eql([])
+    end
+  end
+
+  describe 'get_words_to_add' do
+
+    it 'returns an array with strings that need to be added' do
+      word1 = PoseWord.new :text => 'one'
+      word2 = PoseWord.new :text => 'two'
+      existing_words = [word1, word2]
+      new_words = ['one', 'three']
+
+      result = Pose.get_words_to_add existing_words, new_words
+
+      result.should eql(['three'])
+    end
+
+    it 'returns an empty array if there is nothing to be added' do
+      word1 = PoseWord.new :text => 'one'
+      word2 = PoseWord.new :text => 'two'
+      existing_words = [word1, word2]
+      new_words = ['one', 'two']
+
+      result = Pose.get_words_to_add existing_words, new_words
+
+      result.should eql([])
+    end
+  end
+
+  describe 'search' do
+    
+    it 'works' do
+      pos1 = PosableOne.create :text => 'one'
+      
+      result = Pose.search 'one', PosableOne
+      
+      result.should have(1).items
+      result[PosableOne].should have(1).items
+      result[PosableOne][0].should == pos1
+    end
+    
+    it 'returns an empty array if nothing matches' do
+      pos1 = PosableOne.create :text => 'one'
+      
+      result = Pose.search 'two', PosableOne
+      
+      result.should == { PosableOne => [] }
+    end
+    
+    it 'returns all different classes by default' do
+      pos1 = PosableOne.create :text => 'foo'
+      pos2 = PosableTwo.create :text => 'foo'
+      
+      result = Pose.search 'foo', [PosableOne, PosableTwo]
+      
+      result.should have(2).items
+      result[PosableOne].should == [pos1]
+      result[PosableTwo].should == [pos2]
+    end
+    
+    it 'allows to provide different classes to return' do
+      pos1 = PosableOne.create :text => 'foo'
+      pos2 = PosableTwo.create :text => 'foo'
+      
+      result = Pose.search 'foo', [PosableOne, PosableTwo]
+      
+      result.should have(2).items
+      result[PosableOne].should == [pos1]
+      result[PosableTwo].should == [pos2]
+    end
+    
+    it 'returns only instances of the given classes' do
+      pos1 = PosableOne.create :text => 'one'
+      pos2 = PosableTwo.create :text => 'one'
+      
+      result = Pose.search 'one', PosableOne
+      
+      result.should have(1).items
+      result[PosableOne].should == [pos1]
+    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.should have(1).items
+      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.should have(1).items
+      result[PosableOne].should == []
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+#require "rails/test_help"
+#require 'rspec/rails'
+require 'rubygems'
+require 'bundler/setup'
+require 'hashie'
+require 'active_record'
+require 'active_support/core_ext/module/aliasing'
+require "pose"
+require 'pose_word.rb'
+require 'pose_assignment.rb'
+require "pose/posifier.rb"
+require 'active_support/core_ext/string'
+require 'meta_where'
+
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+Rails = Hashie::Mash.new({:env => 'test'})
+
+
+#require 'your_gem_name' # and any other gems you need
+
+
+# Load support files
+#Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+#Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # 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
+end
+
+# 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 ', '}]"
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: pose
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Kevin Goslar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70121935615180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121935615180
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70121935614620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121935614620
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70121935614060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121935614060
+- !ruby/object:Gem::Dependency
+  name: meta_where
+  requirement: &70121935613620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121935613620
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70121935613160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70121935613160
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70121935612580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70121935612580
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70121935612140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70121935612140
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70121935611680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70121935611680
+description: Pose ('Polymorphic Search') allows fulltext search for ActiveRecord objects.
+email:
+- kevin.goslar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/Pose/InstanceMethods.html
+- doc/Pose.html
+- doc/PoseAssignment.html
+- doc/PoseGenerator.html
+- doc/PoseMigrations.html
+- doc/PoseWord.html
+- doc/top-level-namespace.html
+- lib/generators/pose_generator.rb
+- lib/generators/templates/migration.rb
+- lib/pose/posifier.rb
+- lib/pose/version.rb
+- lib/pose.rb
+- lib/pose_assignment.rb
+- lib/pose_word.rb
+- lib/tasks/pose_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- spec/pose_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kevgo/pose
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: A polymorphic, storage-system independent search engine for Ruby on Rails.
+test_files:
+- spec/pose_spec.rb
+- spec/spec_helper.rb