scoped_search 4.1.4 → 4.1.9

data/lib/scoped_search/version.rb

@@ -1,3 +1,3 @@
 module ScopedSearch
-  VERSION = "4.1.4"
+  VERSION = "4.1.9"
 end

data/spec/integration/auto_complete_spec.rb

@@ -17,6 +17,13 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         t.string :other_c
       end
 
+      ActiveRecord::Migration.create_table(:quxes, :force => true) do |t|
+        t.string :related
+        t.string :other_a
+        t.string :other_b
+        t.string :other_c
+      end
+
       ActiveRecord::Migration.create_table(:foos, :force => true) do |t|
         t.string  :string
         t.string  :another
@@ -25,17 +32,29 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         t.integer :int
         t.date    :date
         t.integer :unindexed
+        t.integer :qux_id
+
+        if on_postgresql?
+          t.uuid :uuid
+        else
+          t.string :uuid
+        end
       end
 
       class ::Bar < ActiveRecord::Base
         belongs_to :foo
       end
 
+      class ::Qux < ActiveRecord::Base
+        has_many :foos
+      end
+
       class ::Foo < ActiveRecord::Base
         has_many :bars
+        belongs_to :qux
         default_scope { order(:string) }
 
-        scoped_search :on => [:string, :date]
+        scoped_search :on => [:string, :date, :uuid]
         scoped_search :on => [:int], :complete_value => true
         scoped_search :on => :another,  :default_operator => :eq, :aliases => [:alias], :complete_value => true
         scoped_search :on => :explicit, :only_explicit => true, :complete_value => true
@@ -49,7 +68,10 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
       class ::Infoo < ::Foo
       end
 
-      @foo_1 = Foo.create!(:string => 'foo', :another => 'temp 1', :explicit => 'baz', :int => 9  , :date => 'February 8, 2011' , :unindexed => 10)
+      @qux_1 = Qux.create!()
+      @qux_2 = Qux.create!()
+      @foo_1 = Foo.create!(:string => 'foo', :another => 'temp 1', :explicit => 'baz', :int => 9  , :date => 'February 8, 2011' , :unindexed => 10, :qux => @qux_1)
+      @foo_2 = Foo.create!(:string => 'foo', :another => 'temp 2', :explicit => 'baz', :int => 10  , :date => 'February 8, 2011' , :unindexed => 10, :qux => @qux_2)
       Foo.create!(:string => 'bar', :another => 'temp "2"', :explicit => 'baz', :int => 22  , :date => 'February 10, 2011', :unindexed => 10)
       Foo.create!(:string => 'baz', :another => nil,      :explicit => nil  , :int => nil, :date => nil                 , :unindexed => nil)
       20.times { Foo.create!(:explicit => "aaa") }
@@ -90,6 +112,12 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         Foo.complete_for('date ').should =~ (["date  = ", "date  < ", "date  > "])
       end
 
+      it "should complete the uuid comparators" do
+        if on_postgresql?
+          Foo.complete_for('uuid ').should =~ (["uuid  = ", "uuid  != "])
+        end
+      end
+
       it "should complete when query is already distinct" do
         Foo.distinct.complete_for('int =').length.should > 0
       end
@@ -190,7 +218,7 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
     context 'exceptional search strings' do
 
       it "query that starts with 'or'" do
-        Foo.complete_for('or ').length.should == 9
+        Foo.complete_for('or ').length.should == 10
       end
 
       it "value completion with quotes" do
@@ -212,7 +240,7 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
     # the string.
     context 'dotted options in the completion list' do
       it "query that starts with space should not include the dotted options" do
-        Foo.complete_for(' ').length.should == 9
+        Foo.complete_for(' ').length.should == 10
       end
 
       it "query that starts with the dotted string should include the dotted options" do
@@ -230,5 +258,14 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         Foo.complete_for('int > 2').first.should match(/22/)
       end
     end
+
+    context 'autocompleting with value_filter' do
+      it 'should return filtered values' do
+        Foo.complete_for('int =', value_filter: { qux_id: @qux_1.id }).should == ['int = 9']
+      end
+      it 'should return filtered for invalid value' do
+        Foo.complete_for('int =', value_filter: { qux_id: 99 }).should == []
+      end
+    end
   end
 end

data/spec/integration/key_value_querying_spec.rb

@@ -33,6 +33,7 @@ require "spec_helper"
             has_many :keys, :through => :facts
 
             scoped_search :relation => :facts, :on => :value, :rename => :facts, :in_key => :keys, :on_key => :name, :complete_value => true
+            scoped_search :relation => :facts, :on => :value, :rename => 'myfacts.value', :aliases => ['prefixed', 'prefixed.value']
           end
           class ::MyItem < ::Item
           end
@@ -102,6 +103,20 @@ require "spec_helper"
         it "should find all bars with a fact name color and fact value gold of descendant class" do
           MyItem.search_for('facts.color = gold').first.name.should eql('barbary')
         end
+
+        describe 'with prefixed aliases' do
+          it 'should search by the prefix' do
+            Item.search_for('prefixed = green').length.should == 1
+          end
+
+          it 'should search by the full length variant' do
+            Item.search_for('prefixed.value = green').length.should == 1
+          end
+
+          it 'should not search by just any key with common prefix' do
+            proc { Item.search_for('prefixed.something_which_is_not_defined = green') }.should raise_error(ScopedSearch::QueryNotSupported)
+          end
+        end
       end
     end
   end

data/spec/integration/nested_has_many_through_querying_spec.rb

@@ -0,0 +1,100 @@
+require "spec_helper"
+
+# These specs will run on all databases that are defined in the spec/database.yml file.
+# Comment out any databases that you do not have available for testing purposes if needed.
+ScopedSearch::RSpec::Database.test_databases.each do |db|
+
+  describe ScopedSearch, "using a #{db} database" do
+
+    before(:all) do
+      ScopedSearch::RSpec::Database.establish_named_connection(db)
+    end
+
+    after(:all) do
+      ScopedSearch::RSpec::Database.close_connection
+    end
+
+    context 'quering on associations which are behind multiple has-many-through associations' do
+
+      before(:all) do
+        ActiveRecord::Migration.create_table(:sources) { |t| t.string :name }
+        ActiveRecord::Migration.create_table(:first_jumps) { |t| t.string :name; t.integer :source_id }
+        ActiveRecord::Migration.create_table(:join_jumps) { |t| t.string :name; t.integer :first_jump_id; t.integer :destination_id }
+        ActiveRecord::Migration.create_table(:destinations) { |t| t.string :name; }
+
+        class Source < ActiveRecord::Base
+          has_many :first_jumps
+          has_many :join_jumps, :through => :first_jumps
+          has_many :destinations, :through => :join_jumps
+
+          scoped_search :relation => :first_jumps, :on => :name, :rename => 'first_jump.name'
+          scoped_search :relation => :join_jumps, :on => :name, :rename => 'join_jump.name'
+          scoped_search :relation => :destinations, :on => :name, :rename => 'destination.name'
+        end
+
+        class FirstJump < ActiveRecord::Base
+          belongs_to :source
+          has_many :join_jumps
+          has_many :destinations, :through => :join_jumps
+        end
+
+        class JoinJump < ActiveRecord::Base
+          has_one :source, :through => :first_jump
+          belongs_to :first_jump
+          belongs_to :destination
+        end
+
+        class Destination < ActiveRecord::Base
+          has_many :join_jumps
+          has_many :first_jumps, :through => :join_jumps
+          has_many :sources, :through => :first_jumps
+        end
+
+        @destination1 = Destination.create!(:name => 'dest-1')
+        @destination2 = Destination.create!(:name => 'dest-2')
+        @destination3 = Destination.create!(:name => 'dest-3')
+        @source1 = Source.create!(:name => 'src1')
+        @first_jump1 = FirstJump.create!(:name => 'jump-1-1', :source => @source1)
+        @first_jump2 = FirstJump.create!(:name => 'jump-1-2', :source => @source1)
+
+        @source2 = Source.create!(:name => 'src2')
+        @first_jump_2_1 = FirstJump.create!(:name => 'jump-2-1', :source => @source2)
+        @first_jump_2_2 = FirstJump.create!(:name => 'jump-2-2', :source => @source2)
+        @first_jump_2_3 = FirstJump.create!(:name => 'jump-2-3', :source => @source2)
+        @first_jump_2_4 = FirstJump.create!(:name => 'jump-2-4', :source => @source2)
+
+        JoinJump.create!(:name => 'join-1-1', :destination => @destination1, :first_jump => @first_jump1)
+        JoinJump.create!(:name => 'join-1-2', :destination => @destination2, :first_jump => @first_jump2)
+
+        JoinJump.create!(:name => 'join-2-1', :destination => @destination1, :first_jump => @first_jump_2_1)
+        JoinJump.create!(:name => 'join-2-2', :destination => @destination2, :first_jump => @first_jump_2_2)
+        JoinJump.create!(:name => 'join-2-3', :destination => @destination2, :first_jump => @first_jump_2_3)
+        JoinJump.create!(:name => 'join-2-4', :destination => @destination3, :first_jump => @first_jump_2_4)
+      end
+
+      after(:all) do
+        ScopedSearch::RSpec::Database.drop_model(Source)
+        ScopedSearch::RSpec::Database.drop_model(FirstJump)
+        ScopedSearch::RSpec::Database.drop_model(JoinJump)
+        ScopedSearch::RSpec::Database.drop_model(Destination)
+        Object.send :remove_const, :Source
+        Object.send :remove_const, :FirstJump
+        Object.send :remove_const, :JoinJump
+        Object.send :remove_const, :Destination
+      end
+
+      it "allows searching on has many through has many" do
+        Source.search_for("join_jump.name = join-1-1").should == [@source1]
+        Source.search_for("join_jump.name = join-2-1").should == [@source2]
+        Source.search_for("join_jump.name ^ (join-1-1, join-2-1)").order(:id).should == [@source1, @source2]
+      end
+
+      it "allows searching on has many through has one through has many" do
+        Source.search_for("destination.name = dest-1").order(:id).should == [@source1, @source2]
+        Source.search_for("destination.name = dest-3").order(:id).should == [@source2]
+        Source.search_for("destination.name = dest-3 or destination.name = dest-2").order(:id).should == [@source1, @source2]
+        Source.search_for("destination.name = dest-3 and destination.name = dest-2").should == [@source2]
+      end
+    end
+  end
+end

data/spec/integration/relation_querying_spec.rb

@@ -351,9 +351,10 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
 
         # Create some tables
         ActiveRecord::Migration.create_table(:taggables) { |t| t.integer :taggable_id; t.string :taggable_type; t.integer :tag_id }
-        ActiveRecord::Migration.create_table(:dogs) { |t| t.string :related }
+        ActiveRecord::Migration.create_table(:dogs) { |t| t.string :related; t.integer :owner_id }
         ActiveRecord::Migration.create_table(:cats) { |t| t.string :related }
         ActiveRecord::Migration.create_table(:tags) { |t| t.string :foo }
+        ActiveRecord::Migration.create_table(:owners) { |t| t.string :name }
 
         # The related classes
         class Taggable < ActiveRecord::Base; belongs_to :tag; belongs_to :taggable, :polymorphic => true; end
@@ -369,6 +370,7 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         class Dog < ActiveRecord::Base
           has_many :taggables, :as => :taggable
           has_many :tags, :through => :taggables
+          belongs_to :owner
 
           scoped_search :relation => :tags, :on => :foo
         end
@@ -378,6 +380,14 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
           has_many :tags, :through => :taggables
         end
 
+        class Owner < ActiveRecord::Base
+          has_many :dogs
+          has_many :taggables, :as => :taggable, :through => :dogs
+          has_many :tags, :through => :taggables
+
+          scoped_search :relation => :tags, :on => :foo
+        end
+
         @tag_1 = Tag.create!(:foo => 'foo')
         @tag_2 = Tag.create!(:foo => 'foo too')
         @tag_3 = Tag.create!(:foo => 'foo three')
@@ -386,6 +396,8 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         @dog_2 = Dog.create(:related => 'baz too!')
         @cat_1 = Cat.create(:related => 'mitzi')
 
+        @owner_1 = Owner.create(:name => 'Fred', :dogs => [@dog_1])
+
         Taggable.create!(:tag => @tag_1, :taggable => @dog_1, :taggable_type => 'Dog' )
         Taggable.create!(:tag => @tag_1)
         Taggable.create!(:tag => @tag_2, :taggable => @dog_1 , :taggable_type => 'Dog')
@@ -400,12 +412,18 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         ActiveRecord::Migration.drop_table(:taggables)
         ActiveRecord::Migration.drop_table(:tags)
         ActiveRecord::Migration.drop_table(:cats)
+        ActiveRecord::Migration.drop_table(:owners)
       end
 
       it "should find the two records that are related to a tag that contains foo record" do
         Dog.search_for('foo').length.should == 2
       end
 
+      it "should find the only record that is related to a tag" do
+        Owner.search_for('foo').length.should == 1
+        Owner.search_for('foo').to_sql.should =~ /taggable_type = 'Dog'/
+      end
+
       it "should find one records that is related to both tags" do
         Dog.search_for('foo=foo AND foo="foo too"').length.should == 1
       end
@@ -720,5 +738,49 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         result.first.username.should == @usermat_1.username
       end
     end
+
+    context "querying on :has_many with primary key override" do
+
+      before do
+        ActiveRecord::Migration.create_table(:books) { |t| t.string :title; t.string :isbn }
+        ActiveRecord::Migration.create_table(:comments) { |t| t.string :comment; t.string :isbn }
+
+        class Book < ActiveRecord::Base
+          has_many :comments, foreign_key: 'isbn', primary_key: 'isbn'
+
+          scoped_search on: [:title]
+          scoped_search relation: :comments, on: [:comment]
+        end
+
+        class Comment < ActiveRecord::Base
+          belongs_to :book, foreign_key: 'isbn', primary_key: 'isbn'
+        end
+
+        @book1 = Book.create(:title => 'Eloquent Ruby', :isbn => '978-0321584106')
+        @book2 = Book.create(:title => 'The Well-Grounded Rubyist', :isbn => '978-1617295218')
+        Comment.create(:comment => 'Definitely worth a read', :isbn => @book1.isbn)
+        Comment.create(:comment => 'Wait what? I expected a book about gemstones', :isbn => @book1.isbn)
+        Comment.create(:comment => 'Cool book about ruby', :isbn => @book2.isbn)
+      end
+
+      after do
+        ActiveRecord::Migration.drop_table :comments
+        ActiveRecord::Migration.drop_table :books
+      end
+
+      it "correctly joins the tables" do
+        query = Book.search_for("test").to_sql
+        # On PostgreSQL and SQLite we use double quotes, on MySQL we use backticks
+        query.should =~ /LEFT OUTER JOIN ["`]comments["`] ON ["`]comments["`]\.["`]isbn["`] = ["`]books["`]\.["`]isbn["`]/
+        query.should =~ /["`]books["`]\.["`]isbn["`] IN \(SELECT ["`]isbn["`]/
+      end
+
+      it "finds the right results" do
+        Book.search_for('python').should == []
+        Book.search_for('comment ~ Wait').should == [@book1]
+        Book.search_for('comment ~ book').pluck(:id).sort.uniq.should == [@book1, @book2].map(&:id).sort
+        Book.search_for('comment ~ Cool').should == [@book2]
+      end
+    end
   end
 end

data/spec/integration/sti_querying_spec.rb

@@ -13,15 +13,18 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
 
       @parent_class = ScopedSearch::RSpec::Database.create_model(int: :integer, type: :string, related_id: :integer) do |klass|
         klass.scoped_search on: :int
+        klass.belongs_to @related_class.table_name.to_sym, foreign_key: :related_id
       end
       @subclass1 = ScopedSearch::RSpec::Database.create_sti_model(@parent_class)
       @subclass2 = ScopedSearch::RSpec::Database.create_sti_model(@parent_class) do |klass|
-        klass.belongs_to @related_class.table_name.to_sym, foreign_key: :related_id
         klass.scoped_search on: :int, rename: :other_int
         klass.scoped_search relation: @related_class.table_name, on: :int, rename: :related_int
       end
 
-      @related_class.has_many @subclass1.table_name.to_sym
+      @related_class.has_many @subclass1.table_name.to_sym, :foreign_key => :related_id
+      @related_class.has_many @subclass2.table_name.to_sym, :foreign_key => :related_id
+      @related_class.scoped_search :relation => @subclass1.table_name.to_sym, :on => :int, :rename => 'subclass1.id'
+      @related_class.scoped_search :relation => @subclass2.table_name.to_sym, :on => :int, :rename => 'subclass2.id'
 
       @record1 = @subclass1.create!(int: 7)
       @related_record1 = @related_class.create!(int: 42)
@@ -79,5 +82,12 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         @subclass2.search_for('related_int = 42').should eq([@record2])
       end
     end
+
+    context 'querying related records' do
+      it 'shuld find only relevant instances of STI subclasses' do
+        @related_class.search_for("subclass1.id ^ (#{@record1.int})").should eq([])
+        @related_class.search_for("subclass2.id ^ (#{@record1.int}, #{@record2.int})").should eq([@related_record1])
+      end
+    end
   end
 end

data/spec/integration/uuid_query_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+require 'securerandom'
+
+# These specs will run on all databases that are defined in the spec/database.yml file.
+# Comment out any databases that you do not have available for testing purposes if needed.
+ScopedSearch::RSpec::Database.test_databases.each do |db|
+  describe ScopedSearch, "using a #{db} database" do
+    before(:all) do
+      ScopedSearch::RSpec::Database.establish_named_connection(db)
+
+      columns = on_postgresql? ? { :uuid => :uuid } : { :uuid => :string }
+
+      @class = ScopedSearch::RSpec::Database.create_model(columns.merge(:string => :string)) do |klass|
+        klass.scoped_search :on => :uuid
+        klass.scoped_search :on => :string
+      end
+    end
+
+    after(:all) do
+      ScopedSearch::RSpec::Database.drop_model(@class)
+      ScopedSearch::RSpec::Database.close_connection
+    end
+
+    context 'querying boolean fields' do
+
+      before(:all) do
+        @record1 = @class.create!(:uuid => SecureRandom.uuid)
+        @record2 = @class.create!(:uuid => SecureRandom.uuid)
+        @record3 = @class.create!(:uuid => SecureRandom.uuid)
+      end
+
+      after(:all) do
+        @record1.destroy
+        @record2.destroy
+        @record3.destroy
+      end
+
+      it "should find the first record" do
+        @class.search_for("uuid = #{@record1.uuid}").length.should == 1
+      end
+
+      it "should find two records with negative match" do
+        @class.search_for("uuid != #{@record3.uuid}").length.should == 2
+      end
+
+      it "should find a record by just specifying the uuid" do
+        @class.search_for(@record1.uuid).first.uuid.should == @record1.uuid
+      end
+
+      it "should not find a record if the uuid is not a valid uuid" do
+        if on_postgresql?
+          @class.search_for(@record1.uuid[0..-2]).length.should == 0
+        end
+      end
+    end
+  end
+end

data/spec/lib/database.rb

@@ -48,7 +48,7 @@ module ScopedSearch::RSpec::Database
     ActiveRecord::Migration.create_table(table_name) do |t|
       fields.each do |name, field_type|
         options = (field_type == :decimal) ? { :scale => 2, :precision => 10 } : {}
-        t.send(field_type.to_s.gsub(/^unindexed_/, '').to_sym, name, options)
+        t.send(field_type.to_s.gsub(/^unindexed_/, '').to_sym, name, **options)
       end
     end