scoped_search 4.1.13 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbd1e857e3b248d6d585ac7c41679b536949dc945f4c7e067b2b16e86ce325b2
-  data.tar.gz: b4c1dc92102ff1d56b1f23406b16cf0523c6bdc17ab336ee92300993de5fd7f9
+  metadata.gz: bdc9b9ee45ee99807b1c22a0da4cef71c6ce539292213ee47c012c020f866368
+  data.tar.gz: 5b4b0acd6e86a3f3e3c940f537a854c193983ebf57019687eac6bf5b33728b42
 SHA512:
-  metadata.gz: 1fe965444b5640251c4ca34c5fc1fca34857f2c8cc96a8f759096165391490ca7deb7f5b3f9d8ed8c9219a5ddfa82716660e2739adb5d7dfdb2d61ca95a968a7
-  data.tar.gz: f9ce7c87b95ceec5f3f5d1cc46f6401ef121870bf58a8cffe1b07cb7de597b8bcd3bcd1069e98ef52007df2209b26998f3f1c05a9719eefe17351d1f6da1eebf
+  metadata.gz: 395e4bf94443d76d67c642fe27f92eaf14b2d240b23c5f784e412cfec811cb1900041ea04388ea4c086a2184cb1c771c6f1f4bf6a1ede7a8065920c2fbb7ab41
+  data.tar.gz: 3662b759dde0bb5c9584de7e9fc2cfdf22ae2244c6889f1c88b343950ad5ff0b8ad51b2b07505e05d0eb59a51efbb887ef6dabd80343fbceb99859528f8c6cb0

data/CHANGELOG.rdoc

@@ -6,6 +6,13 @@ Please add an entry to the "Unreleased changes" section in your pull requests.
 
 === Unreleased changes
 
+=== Version 4.3.0
+
+- Prevent scoped_search from modifying an empty string on newer rubies (#229)
+- Autocomplete now wraps all strings in quotes, not just those containing whitespace (#230)
+- UUID search is now case insensitive (#232)
+- Autocomplete now honors scopes set on associations (#231)
+
 === Version 4.1.10
 
 - Fix querying through associations in Rails 6.1 (undefined method join_keys) (#201)

data/lib/scoped_search/auto_complete_builder.rb

@@ -215,12 +215,18 @@ module ScopedSearch
         .distinct
         .map(&field.field)
         .compact
-        .map { |v| v.to_s =~ /\s/ ? "\"#{v.gsub('"', '\"')}\"" : v }
+        .map { |v| v.is_a?(String) ? "\"#{v.gsub('"', '\"')}\"" : v }
     end
 
     def completer_scope(field)
-      klass = field.klass
-      scope = klass.respond_to?(:completer_scope) ? klass.completer_scope(@options) : klass
+      scope = field.klass
+      scope = scope.completer_scope(@options) if scope.respond_to?(:completer_scope)
+
+      if field.klass != field.definition.klass
+        reflection = field.definition.reflection_by_name(field.definition.klass, field.relation)
+        scope = scope.instance_exec(&reflection.scope) if reflection.try(:has_scope?)
+      end
+
       scope.respond_to?(:reorder) ? scope.reorder(Arel.sql(field.quoted_field)) : scope.scoped(:order => field.quoted_field)
     end
 

data/lib/scoped_search/definition.rb

@@ -260,7 +260,7 @@ module ScopedSearch
 
     NUMERICAL_REGXP = /^\-?\d+(\.\d+)?$/
     INTEGER_REGXP = /^\-?\d+$/
-    UUID_REGXP = /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/
+    UUID_REGXP = /^[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$/i
 
     # Returns a list of appropriate fields to search in given a search keyword and operator.
     def default_fields_for(value, operator = nil)

data/lib/scoped_search/query_builder.rb

@@ -146,8 +146,22 @@ module ScopedSearch
       # but the field is of datetime type. Change the comparison to return
       # more logical results.
       if field.datetime?
-        span = 1.minute if(value =~ /\A\s*\d+\s+\bminutes?\b\s+\bago\b\s*\z/i)
-        span ||= (timestamp.day_fraction == 0) ? 1.day : 1.hour
+        if value =~ time_unit_regex("minutes?|hours?")
+          span = 1.minute
+        elsif value =~ time_unit_regex("days?|weeks?|months?|years?") || value =~ /\b(today|tomorrow|yesterday)\b/i
+          span = 1.day
+        else
+          tokens = DateTime._parse(value)
+          # find the smallest unit of time given in input and determine span for further adjustment of the search query
+          span = {
+            sec: 1.second,
+            min: 1.minute,
+            hour: 1.hour,
+            mday: 1.day,
+            mon: 1.month
+          }.find { |key, _| tokens[key] }&.last || 1.year
+        end
+
         if [:eq, :ne].include?(operator)
           # Instead of looking for an exact (non-)match, look for dates that
           # fall inside/outside the range of timestamps of that day.
@@ -155,13 +169,13 @@ module ScopedSearch
           field_sql = field.to_sql(operator, &block)
           return ["#{negate}(#{field_sql} >= ? AND #{field_sql} < ?)", timestamp, timestamp + span]
 
-        elsif operator == :gt
+        elsif span >= 1.day && operator == :gt
           # Make sure timestamps on the given date are not included in the results
           # by moving the date to the next day.
           timestamp += span
           operator = :gte
 
-        elsif operator == :lte
+        elsif span >= 1.day && operator == :lte
           # Make sure the timestamps of the given date are included by moving the
           # date to the next date.
           timestamp += span
@@ -320,6 +334,12 @@ module ScopedSearch
       definition.reflection_by_name(reflection.klass, as).options[:polymorphic]
     end
 
+    private
+
+    def time_unit_regex(time_unit)
+      /\A\s*\d+\s+\b(?:#{time_unit})\b\s+\b(ago|from\s+now)\b\s*\z/i
+    end
+
     # This module gets included into the Field class to add SQL generation.
     module Field
 

data/lib/scoped_search/query_language/tokenizer.rb

@@ -69,7 +69,7 @@ module ScopedSearch::QueryLanguage::Tokenizer
   # Tokenizes a keyword that is quoted using double quotes. Allows escaping
   # of double quote characters by backslashes.
   def tokenize_quoted_keyword(&block)
-    keyword = ""
+    keyword = String.new
     until next_char.nil? || current_char == '"'
       keyword << (current_char == "\\" ? next_char : current_char)
     end

data/lib/scoped_search/version.rb

@@ -1,3 +1,3 @@
 module ScopedSearch
-  VERSION = "4.1.13"
+  VERSION = "4.3.0"
 end

data/lib/scoped_search.rb

@@ -1,3 +1,4 @@
+require 'logger' # a workaround for https://github.com/rails/rails/issues/54263
 require 'active_record'
 
 # ScopedSearch is the base module for the scoped_search plugin. This file

data/scoped_search.gemspec

@@ -34,6 +34,13 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('rspec', '~> 3.0')
   gem.add_development_dependency('rake')
 
+  # Rails require these, but don't explicitly depend on them
+  gem.add_development_dependency('base64')
+  gem.add_development_dependency('benchmark')
+  gem.add_development_dependency('bigdecimal')
+  gem.add_development_dependency('logger')
+  gem.add_development_dependency('mutex_m')
+
   gem.rdoc_options << '--title' << gem.name << '--main' << 'README.rdoc' << '--line-numbers' << '--inline-source'
   gem.extra_rdoc_files = ['README.rdoc', 'CHANGELOG.rdoc', 'CONTRIBUTING.rdoc', 'LICENSE']
 end

data/spec/integration/auto_complete_spec.rb

@@ -41,6 +41,10 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         end
       end
 
+      ActiveRecord::Migration.create_table(:bazs, :force => true) do |t|
+        t.integer :foo_id
+      end
+
       class ::Bar < ActiveRecord::Base
         belongs_to :foo
       end
@@ -65,6 +69,12 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         scoped_search :on => :other_c, :relation => :bars, :rename => 'bars.other_c'.to_sym
       end
 
+      class ::Baz < ActiveRecord::Base
+        belongs_to :foo, -> { where(string: 'foo') }
+
+        scoped_search :on => :string, :relation => :foo, :complete_value => true
+      end
+
       class ::Infoo < ::Foo
       end
 
@@ -83,9 +93,11 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
     after(:all) do
       ActiveRecord::Migration.drop_table(:foos)
       ActiveRecord::Migration.drop_table(:bars)
+      ActiveRecord::Migration.drop_table(:bazs)
 
       Object.send :remove_const, :Foo
       Object.send :remove_const, :Bar
+      Object.send :remove_const, :Baz
       Object.send :remove_const, :Infoo
 
       ScopedSearch::RSpec::Database.close_connection
@@ -169,10 +181,10 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
       end
 
       it "should complete values should contain baz" do
-        Foo.complete_for('explicit = ').should contain('explicit =  baz')
+        Foo.complete_for('explicit = ').should contain('explicit =  "baz"')
       end
 
-      it "should complete values with quotes where required" do
+      it "should complete values with quotes where value is a string" do
         Foo.complete_for('alias = ').should contain('alias =  "temp \"2\""')
       end
     end
@@ -267,5 +279,11 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         Foo.complete_for('int =', value_filter: { qux_id: 99 }).should == []
       end
     end
+
+    context 'autocompleting with scopes' do
+      it 'should honor the scope' do
+        ::Baz.complete_for('string =').should == ['string = foo']
+      end
+    end
   end
 end

data/spec/integration/uuid_query_spec.rb

@@ -43,8 +43,9 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         @class.search_for("uuid != #{@record3.uuid}").length.should == 2
       end
 
-      it "should find a record by just specifying the uuid" do
+      it "should find a record by just specifying the uuid (case insensitive)" do
         @class.search_for(@record1.uuid).first.uuid.should == @record1.uuid
+        @class.search_for(@record1.uuid.upcase).first.uuid.should == @record1.uuid
       end
 
       it "should not find a record if the uuid is not a valid uuid" do

data/spec/unit/query_builder_spec.rb

@@ -155,4 +155,65 @@ describe ScopedSearch::QueryBuilder do
       lambda { ScopedSearch::QueryBuilder.build_query(@definition, 'test_field = test_val') }.should raise_error(ScopedSearch::QueryNotSupported, /failed with error: test/)
     end
   end
+
+  context 'datetime_test' do
+    before(:each) do
+      @field = double('field')
+      @query_builder = ScopedSearch::QueryBuilder.new(@definition, nil, nil)
+
+      @field.stub(:datetime?).and_return(true)
+      @field.stub(:date?).and_return(false)
+      @field.stub(:to_sql).and_return('started_at')
+
+      [:virtual?, :set?, :temporal?, :relation, :offset].each { |key| @field.stub(key).and_return(false) }
+    end
+
+    it "should return correct SQL literal for equality operator" do
+      @definition.stub(:parse_temporal).and_return(DateTime.new(2023, 10, 10))
+      result = @query_builder.datetime_test(@field, :eq, '2023-10-10') { |type, value| }
+      result.should eq(["(started_at >= ? AND started_at < ?)", DateTime.new(2023, 10, 10), DateTime.new(2023, 10, 11)])
+    end
+
+    it "should return correct SQL literal for inequality operator" do
+      @definition.stub(:parse_temporal).and_return(DateTime.new(2023, 10, 10))
+      result = @query_builder.datetime_test(@field, :ne, '2023-10-10') { |type, value| }
+      result.should eq(["NOT (started_at >= ? AND started_at < ?)", DateTime.new(2023, 10, 10), DateTime.new(2023, 10, 11)])
+    end
+
+    it "should return correct SQL literal for greater operator" do
+      @definition.stub(:parse_temporal).and_return(DateTime.new(2023, 10, 9))
+      result = @query_builder.datetime_test(@field, :gt, '2023-10-9') { |type, value| }
+      result.should eq(["started_at >= ?", DateTime.new(2023, 10, 10)])
+    end
+
+    it "should return correct SQL literal for less than or equal operator" do
+      @definition.stub(:parse_temporal).and_return(DateTime.new(2023, 10, 10))
+      result = @query_builder.datetime_test(@field, :lte, '2023-10-10') { |type, value| }
+      result.should eq(["started_at < ?", DateTime.new(2023, 10, 11)])
+    end
+
+    it "should return empty array for invalid date" do
+      @definition.stub(:parse_temporal).and_return(nil)
+      result = @query_builder.datetime_test(@field, :eq, 'invalid-date') { |type, value| }
+      result.should eq([])
+    end
+
+    it "should count with 1 month deviation if only year and month is provided" do
+      @definition.stub(:parse_temporal).and_return(DateTime.new(2024, 1, 1))
+      result = @query_builder.datetime_test(@field, :gt, 'January 2024') { |type, value| }
+      result.should eq(["started_at >= ?", DateTime.new(2024, 2, 1)])
+    end
+
+    it "should not count with deviation if minute is the smallest unit provided" do
+      @definition.stub(:parse_temporal).and_return(DateTime.new(2023, 10, 10, 13, 0, 0))
+      result = @query_builder.datetime_test(@field, :gt, '2023-10-10 13:00') { |type, value| }
+      result.should eq(["started_at > ?", DateTime.new(2023, 10, 10, 13, 0, 0)])
+    end
+
+    it "should not count with deviation if second is the smallest unit provided" do
+      @definition.stub(:parse_temporal).and_return(DateTime.new(2023, 10, 10, 13, 0, 0, 1))
+      result = @query_builder.datetime_test(@field, :gt, '2023-10-10 13:00:01') { |type, value| }
+      result.should eq(["started_at > ?", DateTime.new(2023, 10, 10, 13, 0, 0, 1)])
+    end
+  end
 end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: scoped_search
 version: !ruby/object:Gem::Version
-  version: 4.1.13
+  version: 4.3.0
 platform: ruby
 authors:
 - Amos Benari
 - Willem van Bergen
 - Wes Hays
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-03 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -54,6 +53,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
       Scoped search makes it easy to search your ActiveRecord-based models.
 
@@ -72,10 +141,10 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
 - CHANGELOG.rdoc
 - CONTRIBUTING.rdoc
 - LICENSE
+- README.rdoc
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -144,7 +213,6 @@ homepage: https://github.com/wvanbergen/scoped_search/wiki
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--title"
 - scoped_search
@@ -165,8 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Easily search you ActiveRecord models with a simple query language using
   a named scope