scoped_search 4.1.4 → 4.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf2c98d3eed66905e04497673572661d98ca832a
-  data.tar.gz: 5cda23768c0ffef857dc038d74abd2539bf8881c
+  metadata.gz: 25198636d3a83a3be37b174722b43786bfb66c40
+  data.tar.gz: 2d51410c045dd98edffd782900a960f5111c47f4
 SHA512:
-  metadata.gz: 96425ef732825dfb333d977f55a55be95ef3ac9dfda0ba9c4353fc97227d5caebfc4977b8cbdb786eb5929db84885f74435b7ca8795e449dcd2f7b432b0abbf5
-  data.tar.gz: '068d65cd7fe9e1d4e58b0080d92a22a9216ed879e17275aec5bce2651ce6cced96251803f062113c6ab66135a3ae90e478cf7b90bd2ea7b0437f5f83a96516ce'
+  metadata.gz: 467be1c841cb5a0ce8eff10af66df07db0527a8b7423f386ad8a5ea29bea2ab4e3d02edb0b480ff427bfbdc0078ca1ac138690866db4fb67f13c31322334320b
+  data.tar.gz: fbc5a32d17479d8e919ca7b9e198416a0acb60bcbf0e1b2b3b7b850ad97af135a7cb5d57b0f93d3fee7a1b27c8ee7b47871367506ebe100e8beb58179041c01d

data/CHANGELOG.rdoc

@@ -6,7 +6,11 @@ Please add an entry to the "Unreleased changes" section in your pull requests.
 
 === Unreleased changes
 
-*Nothing yet*
+- Nothing yet
+
+=== Version 4.1.5
+
+- Bugfix related to auto-completion of virtual fields (#182)
 
 === Version 4.1.4
 

data/lib/scoped_search/auto_complete_builder.rb

@@ -270,7 +270,7 @@ module ScopedSearch
 
     # This method complete infix operators by field type
     def complete_operator(node)
-      definition.operator_by_field_name(node.value)
+      definition.operator_by_field_name(node.value).map { |o| o.end_with?(' ') ? o : "#{o} " }
     end
   end
 end

data/lib/scoped_search/definition.rb

@@ -107,6 +107,11 @@ module ScopedSearch
         end
       end
 
+      # Returns true if this is a virtual field.
+      def virtual?
+        !ext_method.nil?
+      end
+
       # Returns the ActiveRecord column definition that corresponds to this field.
       def column
         @column ||= begin
@@ -120,15 +125,15 @@ module ScopedSearch
 
       # Returns the column type of this field.
       def type
-        @type ||= column.type
+        @type ||= virtual? ? :virtual : column.type
       end
 
-      # Returns true if this field is a datetime-like column
+      # Returns true if this field is a datetime-like column.
       def datetime?
         [:datetime, :time, :timestamp].include?(type)
       end
 
-      # Returns true if this field is a date-like column
+      # Returns true if this field is a date-like column.
       def date?
         type == :date
       end
@@ -167,7 +172,7 @@ module ScopedSearch
         return "#{field} #{order}"
       end
 
-      # Return 'table'.'column' with the correct database quotes
+      # Return 'table'.'column' with the correct database quotes.
       def quoted_field
         c = klass.connection
         "#{c.quote_table_name(klass.table_name)}.#{c.quote_column_name(field)}"
@@ -231,11 +236,12 @@ module ScopedSearch
     def operator_by_field_name(name)
       field = field_by_name(name)
       return [] if field.nil?
-      return field.operators                                      if field.operators
-      return ['= ', '!= ']                                        if field.set?
-      return ['= ', '> ', '< ', '<= ', '>= ','!= ', '^ ', '!^ ']  if field.numerical?
-      return ['= ', '!= ', '~ ', '!~ ', '^ ', '!^ ']              if field.textual?
-      return ['= ', '> ', '< ']                                   if field.temporal?
+      return field.operators                                          if field.operators
+      return ['=', '!=', '>', '<', '<=', '>=', '~', '!~', '^', '!^']  if field.virtual?
+      return ['=', '!=']                                              if field.set?
+      return ['=', '>', '<', '<=', '>=', '!=', '^', '!^']             if field.numerical?
+      return ['=', '!=', '~', '!~', '^', '!^']                        if field.textual?
+      return ['=', '>', '<']                                          if field.temporal?
       raise ScopedSearch::QueryNotSupported, "Unsupported type '#{field.type.inspect}')' for field '#{name}'. This can be a result of a search definition problem."
     end
 
@@ -245,7 +251,7 @@ module ScopedSearch
     # Returns a list of appropriate fields to search in given a search keyword and operator.
     def default_fields_for(value, operator = nil)
 
-      column_types  = []
+      column_types  = [:virtual]
       column_types += [:string, :text]                if [nil, :like, :unlike, :ne, :eq].include?(operator)
       column_types += [:double, :float, :decimal]     if value =~ NUMERICAL_REGXP
       column_types += [:integer]                      if value =~ INTEGER_REGXP

data/lib/scoped_search/query_builder.rb

@@ -113,7 +113,7 @@ module ScopedSearch
     # By default, it will simply look up the correct SQL operator in the SQL_OPERATORS
     # hash, but this can be overridden by a database adapter.
     def sql_operator(operator, field)
-      raise ScopedSearch::QueryNotSupported, "the operator '#{operator}' is not supported for field type '#{field.type}'" if !field.ext_method and [:like, :unlike].include?(operator) and !field.textual?
+      raise ScopedSearch::QueryNotSupported, "the operator '#{operator}' is not supported for field type '#{field.type}'" if !field.virtual? and [:like, :unlike].include?(operator) and !field.textual?
       SQL_OPERATORS[operator]
     end
 
@@ -210,7 +210,7 @@ module ScopedSearch
     # <tt>operator</tt>:: The operator used for comparison.
     # <tt>value</tt>:: The value to compare the field with.
     def sql_test(field, operator, value, lhs, &block) # :yields: finder_option_type, value
-      return field.to_ext_method_sql(lhs, sql_operator(operator, field), value, &block) if field.ext_method
+      return field.to_ext_method_sql(lhs, sql_operator(operator, field), value, &block) if field.virtual?
 
       yield(:keyparameter, lhs.sub(/^.*\./,'')) if field.key_field
 
@@ -403,7 +403,7 @@ module ScopedSearch
       def to_ext_method_sql(key, operator, value, &block)
         raise ScopedSearch::QueryNotSupported, "'#{definition.klass}' doesn't respond to '#{ext_method}'" unless definition.klass.respond_to?(ext_method)
         begin
-          conditions = definition.klass.send(ext_method.to_sym, key, operator, value) 
+          conditions = definition.klass.send(ext_method.to_sym, key, operator, value)
         rescue StandardError => e
           raise ScopedSearch::QueryNotSupported, "external method '#{ext_method}' failed with error: #{e}"
         end
@@ -554,7 +554,7 @@ module ScopedSearch
       # Switches out the default LIKE operator in the default <tt>sql_operator</tt>
       # method for ILIKE or @@ if full text searching is enabled.
       def sql_operator(operator, field)
-        raise ScopedSearch::QueryNotSupported, "the operator '#{operator}' is not supported for field type '#{field.type}'" if !field.ext_method and [:like, :unlike].include?(operator) and !field.textual?
+        raise ScopedSearch::QueryNotSupported, "the operator '#{operator}' is not supported for field type '#{field.type}'" if !field.virtual? and [:like, :unlike].include?(operator) and !field.textual?
         return '@@' if [:like, :unlike].include?(operator) && field.full_text_search
         case operator
           when :like   then 'ILIKE'

data/lib/scoped_search/version.rb

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

data/spec/unit/auto_complete_builder_spec.rb

@@ -2,9 +2,11 @@ require "spec_helper"
 
 describe ScopedSearch::AutoCompleteBuilder do
 
+  let(:klass) { Class.new(ActiveRecord::Base) }
+
   before(:each) do
     @definition = double('ScopedSearch::Definition')
-    @definition.stub(:klass).and_return(Class.new(ActiveRecord::Base))
+    @definition.stub(:klass).and_return(klass)
     @definition.stub(:profile).and_return(:default)
     @definition.stub(:profile=).and_return(true)
   end
@@ -17,4 +19,18 @@ describe ScopedSearch::AutoCompleteBuilder do
     ScopedSearch::AutoCompleteBuilder.auto_complete(@definition, "").should == []
   end
 
+  context "with ext_method" do
+    before do
+      @definition = ScopedSearch::Definition.new(klass)
+      @definition.define(:test_field, ext_method: :ext_test)
+      @definition.klass.stub(:connection).and_return(double())
+      @definition.klass.stub(:columns_hash).and_return({})
+    end
+
+    it "should support operator auto-completion on a virtual field" do
+      klass.should_receive(:ext_test).with('', '=', 'test_field').and_return(conditions: '')
+      ScopedSearch::AutoCompleteBuilder.auto_complete(@definition, 'test_field ').should eq(["test_field  = ", "test_field  != ", "test_field  > ", "test_field  < ", "test_field  <= ", "test_field  >= ", "test_field  ~ ", "test_field  !~ ", "test_field  ^ ", "test_field  !^ "])
+    end
+  end
+
 end

data/spec/unit/query_builder_spec.rb

@@ -38,6 +38,7 @@ describe ScopedSearch::QueryBuilder do
 
   it "should validate value if validator selected" do
     field = double('field')
+    field.stub(:virtual?).and_return(false)
     field.stub(:only_explicit).and_return(true)
     field.stub(:field).and_return(:test_field)
     field.stub(:validator).and_return(->(_value) { false })
@@ -49,6 +50,7 @@ describe ScopedSearch::QueryBuilder do
 
   it "should validate value if validator selected" do
     field = double('field')
+    field.stub(:virtual?).and_return(false)
     field.stub(:only_explicit).and_return(true)
     field.stub(:field).and_return(:test_field)
     field.stub(:ext_method).and_return(nil)
@@ -65,6 +67,7 @@ describe ScopedSearch::QueryBuilder do
 
   it "should display custom error from validator" do
     field = double('field')
+    field.stub(:virtual?).and_return(false)
     field.stub(:only_explicit).and_return(true)
     field.stub(:field).and_return(:test_field)
     field.stub(:validator).and_return(->(_value) { raise ScopedSearch::QueryNotSupported, 'my custom message' })
@@ -90,7 +93,7 @@ describe ScopedSearch::QueryBuilder do
       ScopedSearch::QueryBuilder.build_query(@definition, 'test_field = test_val').should eq(include: ['test1'], joins: ['test2'])
     end
 
-    it "should support LIKE query even if database field doesn't exist" do
+    it "should support LIKE query on a virtual field" do
       klass.should_receive(:ext_test).with('test_field', 'LIKE', 'test_val').and_return(conditions: 'field LIKE ?', parameter: ['%test_val%'])
       ScopedSearch::QueryBuilder.build_query(@definition, 'test_field ~ test_val').should eq(conditions: ['(field LIKE ?)', '%test_val%'])
     end
@@ -100,7 +103,7 @@ describe ScopedSearch::QueryBuilder do
       lambda { ScopedSearch::QueryBuilder.build_query(@definition, 'test_field = test_val') }.should raise_error(ScopedSearch::QueryNotSupported, /should return hash/)
     end
 
-    it "should raise error when method doesn't exist" do
+    it "should raise error when ext_method doesn't exist" do
       lambda { ScopedSearch::QueryBuilder.build_query(@definition, 'test_field = test_val') }.should raise_error(ScopedSearch::QueryNotSupported, /doesn't respond to 'ext_test'/)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scoped_search
 version: !ruby/object:Gem::Version
-  version: 4.1.4
+  version: 4.1.5
 platform: ruby
 authors:
 - Amos Benari
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2018-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Easily search you ActiveRecord models with a simple query language using