scoped_search 4.1.12 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fe5811549cf2e222ac16ea429293269abdd0734793b9e83611e76527acd905b
-  data.tar.gz: 22463f4c28a03919dc7e42cd4942dcc3d66c0291bcb087fa5ad1688492726efd
+  metadata.gz: 958718e625d5bbb80f93ea868abebac96d29a54e712c6c0275f9e6a1e44e07d3
+  data.tar.gz: 90f57db3c2009746a0beb9d843bee7a46d55d1b0ef02d796c12490d7b3e7f1b8
 SHA512:
-  metadata.gz: 3e36707917762b0f2759da997bceb96b2f91b91bcbdb920d03a1738e408bc72a545e380f55bd5c35b9448d2916ac7ddb5dcc0ec623b6a36726d464ac818e15cb
-  data.tar.gz: 1b0e4c026cffd08a3851a5929dd8ee7244c041c27d282789bac19fb7af77e2b0641e8d80cf52fcf8f8318190f15c647bcdf76ac98b3576c537a65a5250ec7784
+  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/query_language/parser.rb

@@ -31,7 +31,7 @@ module ScopedSearch::QueryLanguage::Parser
     next_token if !root_node && peek_token == :lparen # skip starting :lparen
     expressions << parse_logical_expression until peek_token.nil? || peek_token == :rparen
     next_token if !root_node && peek_token == :rparen # skip final :rparen
-    
+
     return ScopedSearch::QueryLanguage::AST::LogicalOperatorNode.new(DEFAULT_SEQUENCE_OPERATOR, expressions, root_node)
   end
 
@@ -42,18 +42,23 @@ module ScopedSearch::QueryLanguage::Parser
       when :lparen;         parse_expression_sequence
       when :not;            parse_logical_not_expression
       when :null, :notnull; parse_null_expression
+      when *LOGICAL_INFIX_OPERATORS; parse_logical_infix_expression
       else;                 parse_comparison
     end
 
     if LOGICAL_INFIX_OPERATORS.include?(peek_token)
-      operator = next_token
-      rhs = parse_logical_expression
-      ScopedSearch::QueryLanguage::AST::LogicalOperatorNode.new(operator, [lhs, rhs])
+      parse_logical_infix_expression([lhs])
     else
       lhs
     end
   end
 
+  def parse_logical_infix_expression(previous = [])
+    operator = next_token
+    rhs = parse_logical_expression
+    ScopedSearch::QueryLanguage::AST::LogicalOperatorNode.new(operator, previous + [rhs])
+  end
+
   # Parses a NOT expression
   def parse_logical_not_expression
     next_token # = skip NOT operator
@@ -80,7 +85,24 @@ module ScopedSearch::QueryLanguage::Parser
 
   # Parses a prefix comparison, i.e. without an explicit field: <operator> <value>
   def parse_prefix_comparison
-    return ScopedSearch::QueryLanguage::AST::OperatorNode.new(next_token, [parse_value])
+    token = next_token
+    case token
+    when :in
+      parse_prefix_in(true)
+    when :notin
+      parse_prefix_in(false)
+    else
+      ScopedSearch::QueryLanguage::AST::OperatorNode.new(token, [parse_value])
+    end
+  end
+
+  def parse_prefix_in(inclusion)
+    cmp, log = inclusion ? [:eq, :or] : [:ne, :and]
+    leaves = parse_multiple_values.map do |x|
+      leaf = ScopedSearch::QueryLanguage::AST::LeafNode.new(x)
+      ScopedSearch::QueryLanguage::AST::OperatorNode.new(cmp, [leaf])
+    end
+    ScopedSearch::QueryLanguage::AST::LogicalOperatorNode.new(log, leaves)
   end
 
   # Parses an infix expression, i.e. <field> <operator> <value>
@@ -109,7 +131,7 @@ module ScopedSearch::QueryLanguage::Parser
     value = []
     value << current_token if String === next_token until peek_token.nil? || peek_token == :rparen
     next_token if peek_token == :rparen  # consume the :rparen
-    value.join(',')
+    value
   end
 
   # This can either be a constant value or a field name.
@@ -117,7 +139,7 @@ module ScopedSearch::QueryLanguage::Parser
     if String === peek_token
       ScopedSearch::QueryLanguage::AST::LeafNode.new(next_token)
     elsif ([:in, :notin].include? current_token)
-      value = parse_multiple_values()
+      value = parse_multiple_values().join(',')
       ScopedSearch::QueryLanguage::AST::LeafNode.new(value)
     else
       raise ScopedSearch::QueryNotSupported, "Value expected but found #{peek_token.inspect}"

data/lib/scoped_search/version.rb

@@ -1,3 +1,3 @@
 module ScopedSearch
-  VERSION = "4.1.12"
+  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/parser_spec.rb

@@ -102,7 +102,27 @@ describe ScopedSearch::QueryLanguage::Parser do
     'set? a b null? c'.should parse_to([:and, [:notnull, 'a'], 'b', [:null, 'c']])
   end
 
+  it 'should parse logical operators with a single argument' do
+    '& a'.should parse_to('a')
+    '& & & & a & b & & &'.should parse_to([:and, 'a', 'b'])
+  end
+
+  it 'should parse in and not in operators with no lhs' do
+    '^ a'.should parse_to([:eq, 'a'])
+    '^ a b'.should parse_to([:or, [:eq, 'a'], [:eq, 'b']])
+    '^ a,b'.should parse_to([:or, [:eq, 'a'], [:eq, 'b']])
+
+    '^ (a b)'.should parse_to([:or, [:eq, 'a'], [:eq, 'b']])
+    '^ (a,b)'.should parse_to([:or, [:eq, 'a'], [:eq, 'b']])
+
+    '!^ a'.should parse_to([:ne, 'a'])
+    '!^ a b'.should parse_to([:and, [:ne, 'a'], [:ne, 'b']])
+    '!^ a,b'.should parse_to([:and, [:ne, 'a'], [:ne, 'b']])
+    '!^ (a b)'.should parse_to([:and, [:ne, 'a'], [:ne, 'b']])
+    '!^ (a,b)'.should parse_to([:and, [:ne, 'a'], [:ne, 'b']])
+  end
+
   it "should refuse to parse an empty not expression" do
     lambda { ScopedSearch::QueryLanguage::Compiler.parse('!()|*') }.should raise_error(ScopedSearch::QueryNotSupported)
-  end  
+  end
 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,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: scoped_search
 version: !ruby/object:Gem::Version
-  version: 4.1.12
+  version: 4.2.0
 platform: ruby
 authors:
 - Amos Benari
 - Willem van Bergen
 - Wes Hays
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-26 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.
 
@@ -144,7 +214,7 @@ homepage: https://github.com/wvanbergen/scoped_search/wiki
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - scoped_search
@@ -165,8 +235,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Easily search you ActiveRecord models with a simple query language using
   a named scope