scoped_search 4.1.13 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbd1e857e3b248d6d585ac7c41679b536949dc945f4c7e067b2b16e86ce325b2
-  data.tar.gz: b4c1dc92102ff1d56b1f23406b16cf0523c6bdc17ab336ee92300993de5fd7f9
+  metadata.gz: 958718e625d5bbb80f93ea868abebac96d29a54e712c6c0275f9e6a1e44e07d3
+  data.tar.gz: 90f57db3c2009746a0beb9d843bee7a46d55d1b0ef02d796c12490d7b3e7f1b8
 SHA512:
-  metadata.gz: 1fe965444b5640251c4ca34c5fc1fca34857f2c8cc96a8f759096165391490ca7deb7f5b3f9d8ed8c9219a5ddfa82716660e2739adb5d7dfdb2d61ca95a968a7
-  data.tar.gz: f9ce7c87b95ceec5f3f5d1cc46f6401ef121870bf58a8cffe1b07cb7de597b8bcd3bcd1069e98ef52007df2209b26998f3f1c05a9719eefe17351d1f6da1eebf
+  metadata.gz: 2cc38b0ce04452df7b7205465621c0624d1173c9e9a95eb849f50eaa99fdcad9545a7411aec5fae2a3c787f348a3f440244c54e8623a3ed2589d47735110ef8b
+  data.tar.gz: 60ebb019e199a50505e0e934a1e2fd405a03c903350554c8f13ca62f85c5acc472b073a6bf1ebcdb1f44b15c54ec593dc31b9bf474782ff739803a0d94f43e81

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/version.rb

@@ -1,3 +1,3 @@
 module ScopedSearch
-  VERSION = "4.1.13"
+  VERSION = "4.2.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/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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scoped_search
 version: !ruby/object:Gem::Version
-  version: 4.1.13
+  version: 4.2.0
 platform: ruby
 authors:
 - Amos Benari
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-03 00:00:00.000000000 Z
+date: 2025-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -54,6 +54,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.