pose 3.0.0 → 3.1.1

data/lib/tasks/pose_tasks.rake

@@ -1,38 +1,27 @@
-include Rake::DSL if defined?(Rake::DSL)
-require 'ruby-progressbar'
-
 namespace :pose do
 
-  desc "Cleans out unused data from the search index."
-  task :vacuum => :environment do |t, args|
-    puts "Cleaning Pose search index ...\n\n"
-    progress_bar = ProgressBar.create title: '  assignments', total: Pose::Assignment.count
-    Pose::Assignment.cleanup_orphaned_pose_assignments progress_bar
-    progress_bar.finish
+  desc "Creates the Pose tables in the database."
+  task :install => :environment do
+    Pose::Jobs::Install.new.perform
+  end
 
-    progress_bar = ProgressBar.create title: '  words', total: Pose::Word.count
-    Pose::Word.remove_unused_words progress_bar
-    progress_bar.finish
+  desc "Removes the Pose tables from the database."
+  task :uninstall => :environment do
+    Pose::Jobs::Uninstall.new.perform
+  end
 
-    puts "\nPose search index cleanup complete.\n\n"
+  desc "Cleans out unused data from the search index."
+  task :vacuum => :environment do
+    Pose::Jobs::Vacuum.new.perform
   end
 
   desc "Removes the search index for all instances of the given classes."
-  task :remove, [:class_name] => :environment do |t, args|
-    clazz = args.class_name.constantize
-    Pose::Assignment.delete_class_index clazz
-    puts "Search index for class #{clazz.name} deleted.\n\n"
+  task :remove, [:class_name] => :environment do |_, args|
+    Pose::Jobs::Remove.new(args.class_name).perform
   end
 
-  desc "Deletes and recreates the search index for all instances of the given class."
-  task :reindex_all, [:class_name] => [:environment] do |t, args|
-    clazz = args.class_name.constantize
-    progress_bar = ProgressBar.create title: "  reindexing", total: clazz.count
-    clazz.find_each do |instance|
-      instance.update_pose_words
-      progress_bar.increment
-    end
-    progress_bar.finish
+  desc "Recreates the search index for all instances of the given class from scratch."
+  task :reindex_all, [:class_name] => [:environment] do |_, args|
+    Pose::Jobs::ReindexAll.new(args.class_name).perform
   end
-
 end

data/spec/factories/posable_one.rb

@@ -1,5 +1,7 @@
 FactoryGirl.define do
+
   factory :posable_one do
     text { Faker::Lorem.words(2).join ' ' }
   end
+
 end

data/spec/factories/posable_three.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+
+  factory :posable_three do
+    text_1 { Faker::Lorem.words(2).join ' ' }
+    text_2 { Faker::Lorem.words(2).join ' ' }
+  end
+
+end

data/spec/factories/posable_two.rb

@@ -1,5 +1,7 @@
 FactoryGirl.define do
+
   factory :posable_two do
     text { Faker::Lorem.words(2).join ' ' }
   end
+
 end

data/spec/factories/user.rb

@@ -1,6 +1,8 @@
 FactoryGirl.define do
+
   factory :user do
     name 'foo'
   end
+
 end
 

data/spec/lib/pose/activerecord_base_additions_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Pose::ActiveRecordBaseAdditions do
+  describe "::posify" do
+    let(:posable) { create :posable_three, text_1: 't1', text_2: 't2' }
+
+    it 'includes all listed fields in index' do
+      posable.pose_fetch_content.should == 't1 t2 |custom text| |from pose block|'
+    end
+  end
+end

data/spec/{models → lib/pose}/assignment_spec.rb

@@ -6,8 +6,8 @@ module Pose
     describe :delete_class_index do
 
       before :each do
-        FactoryGirl.create :assignment, posable_id: 1, posable_type: 'PosableOne'
-        FactoryGirl.create :assignment, posable_id: 2, posable_type: 'PosableTwo'
+        create :assignment, posable_id: 1, posable_type: 'PosableOne'
+        create :assignment, posable_id: 2, posable_type: 'PosableTwo'
         Assignment.delete_class_index PosableOne
       end
 
@@ -24,20 +24,20 @@ module Pose
     describe :cleanup_orphaned_pose_assignments do
 
       it "deletes the assignment if the posable object doesn't exist" do
-        FactoryGirl.create :assignment, posable_id: 2, posable_type: 'PosableOne'
+        create :assignment, posable_id: 2, posable_type: 'PosableOne'
         expect(Assignment.count).to be > 0
         Assignment.cleanup_orphaned_pose_assignments
         expect(Assignment.count).to eql 0
       end
 
       it "deletes the assignment if the word doesn't exist" do
-        assignment = FactoryGirl.create :assignment, word: nil, word_id: 27
+        assignment = create :assignment, word: nil, word_id: 27
         Assignment.cleanup_orphaned_pose_assignments
         expect(Assignment.find_by_id(assignment.id)).to be_nil
       end
 
       it "doesn't delete the assignment if it is still used" do
-        assignment = FactoryGirl.create :assignment
+        assignment = create :assignment
         Assignment.cleanup_orphaned_pose_assignments
         expect(Assignment.find_by_id(assignment.id)).to_not be_nil
       end

data/spec/lib/pose/jobs/reindex_all_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+
+describe Pose::Jobs::ReindexAll do
+  let(:klass) { PosableOne }
+  subject { described_class.new(klass) }
+
+  describe "#initialize" do
+    its(:klass) { should == PosableOne }
+
+    context "string given" do
+      let(:klass) { 'PosableOne' }
+      its(:klass) { should == PosableOne }
+    end
+  end
+
+  describe "#perform" do
+    let(:posable_one_1) { create(:posable_one, text: '1') }
+    let(:posable_one_2) { create(:posable_one, text: '1 2') }
+
+    context "records were updated without running callbacks" do
+      before do
+        PosableOne.where(id: posable_one_1.id).update_all(text: '1 2')
+        PosableOne.where(id: posable_one_2.id).update_all(text: '1')
+      end
+
+      it { expect { subject.perform }.to change{ posable_one_1.pose_words.count }.from(1).to(2) }
+      it { expect { subject.perform }.to change{ posable_one_2.pose_words.count }.from(2).to(1) }
+    end
+  end
+end

data/spec/lib/pose/jobs/remove_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+
+describe Pose::Jobs::Remove do
+  let(:klass) { PosableOne }
+  subject { described_class.new(klass) }
+
+  describe "#initialize" do
+    its(:klass) { should == PosableOne }
+
+    context "string given" do
+      let(:klass) { 'PosableOne' }
+      its(:klass) { should == PosableOne }
+    end
+  end
+
+  describe "#perform" do
+    it { expect{ subject.perform }.not_to raise_error }
+  end
+end

data/spec/lib/pose/model_class_additions_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper'
+
+
+describe Pose::ModelClassAdditions do
+  subject { create :posable_one, text: 'one two'  }
+  let(:instance_2) { create :posable_one, text: 'two three four' }
+
+
+  it 'extends AR models' do
+    expect(subject).to be_a_kind_of described_class
+  end
+
+
+  describe 'creating an instance' do
+    it 'adds the instance data to the search index' do
+      expect(Pose::Assignment).to have(0).instances
+      expect(Pose::Word).to have(0).instances
+      subject
+      expect(Pose::Assignment).to have(2).instances
+      expect(Pose::Word).to have(2).instances
+    end
+  end
+
+  describe 'updating an instance' do
+    it 'updates the instance data in the search index' do
+      subject.text = 'two three four'
+      subject.save!
+      expect(subject).to have(3).pose_words
+      expect(Pose::Assignment).to have(3).instances
+    end
+  end
+
+  describe 'deleting an instance' do
+    it 'removes the instance data from the search index' do
+      subject ; instance_2
+      subject.destroy
+      expect(Pose::Assignment).to have(3).instances
+    end
+  end
+
+
+  describe '#pose_current_words' do
+    it 'returns all currently indexed words the instance' do
+      expect(subject.pose_current_words).to match_array %w[one two]
+    end
+  end
+
+
+  describe '#pose_fetch_content' do
+
+    context 'pristine object' do
+      it 'returns the searchable text snippet for this instance' do
+        expect(subject.pose_fetch_content).to eql 'one two'
+      end
+    end
+
+    context 'object with unsaved changes' do
+      it 'returns the new unsaved searchable text' do
+        subject.text = 'two three'
+        expect(subject.pose_fetch_content).to eql 'two three'
+      end
+    end
+  end
+
+
+  describe '#pose_fresh_words' do
+
+    context 'pristine object' do
+      it 'returns the words that this instance should have based on its current content' do
+        expect(subject.pose_fresh_words).to match_array %w[one two]
+      end
+    end
+
+    context 'after a content change in the instance' do
+      it 'returns only the current words' do
+        subject.text = 'two three'
+        expect(subject.pose_fresh_words true).to match_array %w[two three]
+      end
+    end
+
+    describe 'reload parameter' do
+      before :each do
+        subject.pose_fresh_words
+        subject.text = 'new text'
+      end
+
+      context 'given nothing' do
+        it 'caches the data' do
+          expect(subject.pose_fresh_words).to match_array %w[one two]
+        end
+      end
+
+      context 'given false' do
+        it 'caches the data' do
+          expect(subject.pose_fresh_words false).to match_array %w[one two]
+        end
+      end
+
+      context 'given true' do
+        it 'always recalculates the data' do
+          expect(subject.pose_fresh_words true).to match_array %w[new text]
+        end
+      end
+    end
+  end
+
+
+  describe 'pose_stale_words' do
+
+    context 'pristine object' do
+      it 'has no stale words' do
+        expect(subject.pose_stale_words).to be_empty
+      end
+    end
+
+    context 'object with unsaved changes' do
+      it 'returns the words that have to be removed from the search index' do
+        subject.text = 'two three'
+        expect(subject.pose_stale_words true).to match_array %w[one]
+      end
+    end
+  end
+
+
+  describe 'pose_words_to_add' do
+
+    context 'pristine object' do
+      it 'has no words to add' do
+        expect(subject.pose_words_to_add).to be_empty
+      end
+    end
+
+    context 'object with unsaved changes' do
+      it 'returns the words that are missing in the search index for this instance' do
+        subject.text = 'two three'
+        expect(subject.pose_words_to_add true).to match_array %w[three]
+      end
+    end
+  end
+
+
+  describe 'delete_pose_index' do
+    it 'removes the search index for this instance' do
+      subject ; instance_2
+      expect(Pose::Assignment).to have(5).instances
+      subject.delete_pose_index
+      expect(Pose::Assignment).to have(3).instances
+    end
+  end
+end

data/spec/lib/pose/query_spec.rb

@@ -2,10 +2,9 @@
 require "spec_helper"
 
 module Pose
-
   describe Query do
+    let(:subject) { Query.new [PosableOne, [PosableTwo]], 'query string' }
 
-    let(:subject) { Pose::Query.new [PosableOne, [PosableTwo]], 'query string' }
 
     describe :initialize do
 
@@ -14,15 +13,17 @@ module Pose
       end
     end
 
+
     describe :class_names do
 
       it 'returns the names of the given classes' do
-        expect(subject.class_names).to eql ['PosableOne', 'PosableTwo']
+        expect(subject.class_names).to eql %w[PosableOne PosableTwo]
       end
     end
 
 
     describe :has_joins? do
+
       it 'returns TRUE if the query has joins' do
         query = Query.new [], '', joins: :user
         expect(query).to have_joins
@@ -34,6 +35,39 @@ module Pose
       end
     end
 
+
+    describe 'is_url?' do
+
+      it 'returns TRUE if the given string is a URL' do
+        expect(Query.is_url? 'http://web.com').to be_true
+      end
+
+      it 'returns TRUE if the given string is localhost' do
+        expect(Query.is_url? 'http://localhost').to be_true
+      end
+
+      it 'returns TRUE if localhost has a port' do
+        expect(Query.is_url? 'http://localhost:3000').to be_true
+      end
+
+      it 'returns TRUE if the given url has a port' do
+        expect(Query.is_url? 'http://web.com:8080').to be_true
+      end
+
+      it 'returns TRUE if the given string is a HTTPS URL' do
+        expect(Query.is_url? 'https://web.com').to be_true
+      end
+
+      it 'returns FALSE if the given string is not a URL' do
+        expect(Query.is_url? 'foo').to be_false
+      end
+
+      it 'returns FALSE if the given string is a malformed URL' do
+        expect(Query.is_url? 'http://web').to be_false
+      end
+    end
+
+
     describe :joins do
 
       it 'returns the given joins' do
@@ -41,7 +75,7 @@ module Pose
         expect(query.joins).to eql [:foo, :bar]
       end
 
-      it 'returns the given join as an array' do
+      it 'returns a single given join as an array' do
         query = Query.new [], '', joins: :foo
         expect(query.joins).to eql [:foo]
       end
@@ -52,25 +86,89 @@ module Pose
       end
     end
 
+
     describe :query_words do
 
       it 'returns all individual words resulting from the given query' do
-        expect(Pose::Query.new([], 'foo bar').query_words).to eq ['foo', 'bar']
+        expect(Query.new([], 'foo bar').query_words).to eq ['foo', 'bar']
       end
 
       it 'converts the individual words into their root form' do
-        expect(Pose::Query.new([], 'bars').query_words).to eq ['bar']
+        expect(Query.new([], 'bars').query_words).to eq ['bar']
       end
 
       it 'splits complex words into separate terms' do
-        expect(Pose::Query.new([], 'one-two').query_words).to eq ['one', 'two']
+        expect(Query.new([], 'one-two').query_words).to eq ['one', 'two']
       end
 
       it 'removes duplicates' do
-        expect(Pose::Query.new([], 'foo-bar foo').query_words).to eq ['foo', 'bar']
+        expect(Query.new([], 'foo-bar foo').query_words).to eq ['foo', 'bar']
+      end
+    end
+
+
+    describe :root_word do
+
+      it 'converts words into singular' do
+        expect(Query.root_word('bars')).to eql(['bar'])
+      end
+
+      it 'removes special characters' do
+        expect(Query.root_word('(bar')).to eq ['bar']
+        expect(Query.root_word('bar)')).to eq ['bar']
+        expect(Query.root_word('(bar)')).to eq ['bar']
+        expect(Query.root_word('>foo')).to eq ['foo']
+        expect(Query.root_word('<foo')).to eq ['foo']
+        expect(Query.root_word('"foo"')).to eq ['foo']
+        expect(Query.root_word('"foo')).to eq ['foo']
+        expect(Query.root_word("'foo'")).to eq ['foo']
+        expect(Query.root_word("'foo's")).to eq ['foo']
+        expect(Query.root_word("foo?")).to eq ['foo']
+        expect(Query.root_word("foo!")).to eq ['foo']
+        expect(Query.root_word("foo/bar")).to eq ['foo', 'bar']
+        expect(Query.root_word("foo-bar")).to eq ['foo', 'bar']
+        expect(Query.root_word("foo--bar")).to eq ['foo', 'bar']
+        expect(Query.root_word("foo.bar")).to eq ['foo', 'bar']
+      end
+
+      it 'removes umlauts' do
+        expect(Query.root_word('fünf')).to eq ['funf']
+      end
+
+      it 'splits up numbers' do
+        expect(Query.root_word('11.2.2011')).to eq ['11', '2', '2011']
+        expect(Query.root_word('11-2-2011')).to eq ['11', '2', '2011']
+        expect(Query.root_word('30:4-5')).to eq ['30', '4', '5']
+      end
+
+      it 'converts into lowercase' do
+        expect(Query.root_word('London')).to eq ['london']
+      end
+
+      it "stores single-letter words" do
+        expect(Query.root_word('a b')).to eq ['a', 'b']
+      end
+
+      it "does't encode external URLs" do
+        expect(Query.root_word('http://web.com')).to eq ['http', 'web', 'com']
+      end
+
+      it "doesn't store empty words" do
+        expect(Query.root_word('  one two  ')).to eq ['one', 'two']
+      end
+
+      it "removes duplicates" do
+        expect(Query.root_word('one_one')).to eq ['one']
+        expect(Query.root_word('one one')).to eq ['one']
+      end
+
+      it "splits up complex URLs" do
+        expect(Query.root_word('books?id=p7uyWPcVGZsC&dq=closure%20definitive%20guide&pg=PP1#v=onepage&q&f=false')).to eql([
+          "book", "id", "p7uywpcvgzsc", "dq", "closure", "definitive", "guide", "pg", "pp1", "v", "onepage", "q", "f", "false"])
       end
     end
 
+
     describe :where do
 
       it 'returns the given simple WHERE clause as an iterable array' do

data/spec/lib/pose/search_spec.rb

@@ -4,13 +4,11 @@ module Pose
 
   describe Search do
     let(:subject) { Search.new [PosableOne, [PosableTwo]], 'query string' }
-    let(:arel) { double() }
+    let(:arel)   { double() }
     let(:arel_2) { double() }
     let(:arel_3) { double() }
 
-
     describe :add_join do
-
       it 'returns the new arel' do
         arel.should_receive(:joins).with('foo').and_return(arel_2)
         expect(subject.add_join arel, 'foo').to eql arel_2
@@ -39,9 +37,7 @@ module Pose
       end
     end
 
-
     describe :add_joins do
-
       it 'adds all joins to the given arel' do
         arel.should_receive(:joins).with('one').and_return(arel_2)
         arel_2.should_receive(:joins).with('two').and_return(arel_3)
@@ -57,9 +53,7 @@ module Pose
       end
     end
 
-
     describe :add_wheres do
-
       it 'adds all joins to the given arel' do
         arel.should_receive(:where).with(['one = ?', true]).and_return(arel_2)
         arel_2.should_receive(:where).with(['two = ?', false]).and_return(arel_3)
@@ -75,9 +69,7 @@ module Pose
       end
     end
 
-
     describe :empty_result do
-
       it 'returns a hash with classes and empty arrays for each class in the search query' do
         search = Search.new [PosableOne, PosableTwo], ''
         result = search.empty_result
@@ -87,7 +79,6 @@ module Pose
       end
     end
 
-
     describe :limit_ids do
       before :each do
         @search = Search.new nil, nil, limit: 2
@@ -129,7 +120,6 @@ module Pose
 
 
     describe :load_classes do
-
       context 'when the user wants ids' do
         it 'does nothing' do
           search = Search.new nil, nil, result_type: :ids
@@ -143,7 +133,7 @@ module Pose
         it 'loads the classes' do
           object_1 = create :posable_one
           object_2 = create :posable_one
-          result = { PosableOne => [1, 2] }
+          result = { PosableOne => [object_1.id, object_2.id] }
           search = Search.new nil, nil
           search.load_classes result
           expect(result[PosableOne]).to eq [object_1, object_2]
@@ -154,7 +144,6 @@ module Pose
 
     describe :merge_search_result_word_matches do
       context 'given a new class name' do
-
         before :each do
           @result = {}
         end
@@ -166,7 +155,6 @@ module Pose
       end
 
       context 'given a class name with already existing ids from another word' do
-
         before :each do
           @result = { 'class1' => [1, 2] }
         end
@@ -178,7 +166,6 @@ module Pose
       end
 
       context 'with an existing empty result set from a previous query' do
-
         before :each do
           @result = { 'class1' => [] }
         end
@@ -190,7 +177,6 @@ module Pose
       end
 
       context 'with a new empty result set' do
-
         before :each do
           @result = { 'class1' => [1, 2] }
         end
@@ -202,7 +188,6 @@ module Pose
       end
 
       context 'with a completely different result set' do
-
         before :each do
           @result = { 'class1' => [1, 2] }
         end
@@ -216,7 +201,6 @@ module Pose
 
 
     describe :search do
-
       it 'finds all matching instances of all classes' do
         posable_one_1 = create :posable_one, text: 'foo bar'
         posable_one_2 = create :posable_one, text: 'foo bar'
@@ -255,7 +239,6 @@ module Pose
       end
 
       describe 'result types' do
-
         it 'loads classes by default' do
           posable_one = create :posable_one, text: 'foo'
           search = Search.new PosableOne, 'foo'
@@ -292,7 +275,6 @@ module Pose
 
 
     describe :search_word do
-
       context 'search results' do
         it 'returns the ids of the matching instances for this class' do
           posable_one_1 = create :posable_one, text: 'foo'
@@ -323,9 +305,7 @@ module Pose
       end
     end
 
-
     describe :search_words do
-
       context 'search results' do
         it 'returns the ids of all instances that match all query words' do
           posable_one = create :posable_one, text: 'foo bar'