scoped_search 4.1.9 → 4.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1453ebb8fe2391f71ea35171f2115ed89bb7920a1a042d86a4393fe218888c
-  data.tar.gz: 61d2d0e948a952f7e955240747dae7e529103c5871ad3160cb2213574f0f155a
+  metadata.gz: 7a3be22acffe6a33b115957197a5eca96b2e9cf2abe445b657b302663594abbe
+  data.tar.gz: a97d2cd9a8db87347dee308b1340e87967a887dd6b3c5c7b2124f7d9859a9843
 SHA512:
-  metadata.gz: 04e61c564c6117d60b6f82b970df5c6c7a68362d828d89d1cf5d2bf7f6b7c9ea777cf641dbb2a21be895905305c0c7305105c9840d391aa702cd69eab706fd4d
-  data.tar.gz: 842c31b1714558d8bd4578d47b87bca4fa4298617a16168b66a77e6ff06ee1f43406b30be3557a9c50222ba5effaa9c5eec27832839e75bb11faf085f95bb7bc
+  metadata.gz: 840841fa78847d12b0f71ef620dbc73905e34a48325e10864ac56bf4aa746659d12f5cbbb18847c660e019bd42700700afb04928e7ccd48871bfe427ca8ba824
+  data.tar.gz: 11839160ebde29751173c28c718546d92a4378c316f081632f18eef2d688d569a4f1277caf14c40c4896f2168a7e4f42d0717af7482d430de13e9b04b3e77b9a

data/.github/workflows/ruby.yml

@@ -0,0 +1,76 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on: [pull_request]
+
+env:
+  TESTOPTS: --verbose
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+          - 2.7.1
+          - 3.0.0
+          - ruby-head
+          - jruby-head
+        gemfile:
+          - Gemfile.activerecord52
+          - Gemfile.activerecord52_with_activesupport52
+          - Gemfile.activerecord60
+          - Gemfile.activerecord60_with_activesupport60
+          - Gemfile.activerecord61
+          - Gemfile.activerecord61_with_activesupport61
+
+        exclude:
+          - ruby_version: 2.7.1
+            gemfile: Gemfile.activerecord52
+          - ruby_version: 2.7.1
+            gemfile: Gemfile.activerecord52_with_activesupport52
+          - ruby_version: 3.0.0
+            gemfile: Gemfile.activerecord52
+          - ruby_version: 3.0.0
+            gemfile: Gemfile.activerecord52_with_activesupport52
+          - ruby_version: ruby-head
+            gemfile: Gemfile.activerecord52
+          - ruby_version: ruby-head
+            gemfile: Gemfile.activerecord52_with_activesupport52
+    services:
+      postgres:
+        image: postgres:12.1
+        ports: ['5432:5432']
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+        env:
+          POSTGRES_DB: scoped_search_test
+      mariadb:
+        image: mariadb:10
+        ports: ['3306:3306']
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
+          MYSQL_DATABASE: scoped_search_test
+
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+        bundler-cache: true
+    # - name: Install dependencies
+    #   run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.travis.yml

@@ -22,6 +22,7 @@ rvm:
 - "2.5.1"
 - "2.6.0"
 - "2.7.1"
+- "3.0.2"
 - ruby-head
 - jruby-19mode
 - jruby-head
@@ -34,6 +35,8 @@ gemfile:
 - Gemfile.activerecord52_with_activesupport52
 - Gemfile.activerecord60
 - Gemfile.activerecord60_with_activesupport60
+- Gemfile.activerecord61
+- Gemfile.activerecord61_with_activesupport61
 
 matrix:
   allow_failures:
@@ -77,6 +80,26 @@ matrix:
       gemfile: Gemfile.activerecord60_with_activesupport60
     - rvm: "2.4.0"
       gemfile: Gemfile.activerecord60_with_activesupport60
+    - rvm: "2.0"
+      gemfile: Gemfile.activerecord61
+    - rvm: "2.1"
+      gemfile: Gemfile.activerecord61
+    - rvm: "2.2.2"
+      gemfile: Gemfile.activerecord61
+    - rvm: "2.3.7"
+      gemfile: Gemfile.activerecord61
+    - rvm: "2.4.0"
+      gemfile: Gemfile.activerecord61
+    - rvm: "2.0"
+      gemfile: Gemfile.activerecord61_with_activesupport61
+    - rvm: "2.1"
+      gemfile: Gemfile.activerecord61_with_activesupport61
+    - rvm: "2.2.2"
+      gemfile: Gemfile.activerecord61_with_activesupport61
+    - rvm: "2.3.7"
+      gemfile: Gemfile.activerecord61_with_activesupport61
+    - rvm: "2.4.0"
+      gemfile: Gemfile.activerecord61_with_activesupport61
     - rvm: "2.7.1"
       gemfile: Gemfile.activerecord42
     - rvm: "2.7.1"
@@ -87,3 +110,13 @@ matrix:
       gemfile: Gemfile.activerecord52
     - rvm: "2.7.1"
       gemfile: Gemfile.activerecord52_with_activesupport52
+    - rvm: "3.0.2"
+      gemfile: Gemfile.activerecord42
+    - rvm: "3.0.2"
+      gemfile: Gemfile.activerecord50
+    - rvm: "3.0.2"
+      gemfile: Gemfile.activerecord51
+    - rvm: "3.0.2"
+      gemfile: Gemfile.activerecord52
+    - rvm: "3.0.2"
+      gemfile: Gemfile.activerecord52_with_activesupport52

data/CHANGELOG.rdoc

@@ -6,7 +6,16 @@ Please add an entry to the "Unreleased changes" section in your pull requests.
 
 === Unreleased changes
 
-- Nothing yet
+=== Version 4.1.10
+
+- Fix querying through associations in Rails 6.1 (undefined method join_keys) (#201)
+- Fix query generation when going through STI associations (#211)
+- Properly support Ruby 3
+- Add support for postgres citext type
+
+=== Version 4.1.9
+- Fix querying on nested has-many associations (#196)
+- Abide "has_many ..., primary_key" overrides in relation searches
 
 === Version 4.1.8
 

data/Gemfile.activerecord61

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'actionview', '~> 6.1.0'
+gem 'activerecord', '~> 6.1.0'
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'activerecord-jdbcmysql-adapter'
+  gem 'activerecord-jdbcpostgresql-adapter'
+end
+
+platforms :ruby do
+  gem 'sqlite3', '~> 1.4'
+  gem 'mysql2', '> 0.5'
+  gem 'pg', '>= 0.18', '< 2.0'
+end

data/Gemfile.activerecord61_with_activesupport61

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'actionview', '~> 6.1.0'
+gem 'activerecord', '~> 6.1.0'
+gem 'activesupport', '~> 6.1.0'
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+  gem 'activerecord-jdbcmysql-adapter'
+  gem 'activerecord-jdbcpostgresql-adapter'
+end
+
+platforms :ruby do
+  gem 'sqlite3', '~> 1.4'
+  gem 'mysql2', '> 0.5'
+  gem 'pg', '>= 0.18', '< 2.0'
+end

data/lib/scoped_search/definition.rb

@@ -157,7 +157,7 @@ module ScopedSearch
 
       # Returns true if this is a textual column.
       def textual?
-        [:string, :text].include?(type)
+        [:string, :text, :citext].include?(type)
       end
 
       def uuid?
@@ -172,7 +172,7 @@ module ScopedSearch
       # Returns the default search operator for this field.
       def default_operator
         @default_operator ||= case type
-          when :string, :text then :like
+          when :string, :text, :citext then :like
           else :eq
         end
       end
@@ -266,7 +266,7 @@ module ScopedSearch
     def default_fields_for(value, operator = nil)
 
       column_types  = [:virtual]
-      column_types += [:string, :text]                if [nil, :like, :unlike, :ne, :eq].include?(operator)
+      column_types += [:string, :text, :citext]       if [nil, :like, :unlike, :ne, :eq].include?(operator)
       column_types += [:double, :float, :decimal]     if value =~ NUMERICAL_REGXP
       column_types += [:integer]                      if value =~ INTEGER_REGXP
       column_types += [:uuid]                         if value =~ UUID_REGXP
@@ -281,13 +281,13 @@ module ScopedSearch
     # In case Time responds to #zone, we know this is Rails environment and we can use Time.zone.parse. The benefit is that the
     # current timezone is respected and does not have to be specified explicitly. That way even relative dates work as expected.
     def parse_temporal(value)
-      return Date.current if value =~ /\btoday\b/i
-      return 1.day.ago.to_date if value =~ /\byesterday\b/i
-      return 1.day.from_now.to_date if value =~ /\btomorrow\b/i
+      return date_with_timezone(Date.current) if value =~ /\btoday\b/i
+      return date_with_timezone(1.day.ago) if value =~ /\byesterday\b/i
+      return date_with_timezone(1.day.from_now) if value =~ /\btomorrow\b/i
       return (eval($1.strip.gsub(/\s+/,'.').downcase)).to_datetime if value =~ /\A\s*(\d+\s+\b(?:hours?|minutes?)\b\s+\bago)\b\s*\z/i
-      return (eval($1.strip.gsub(/\s+/,'.').downcase)).to_date     if value =~ /\A\s*(\d+\s+\b(?:days?|weeks?|months?|years?)\b\s+\bago)\b\s*\z/i
+      return date_with_timezone(eval($1.strip.gsub(/\s+/,'.').downcase)) if value =~ /\A\s*(\d+\s+\b(?:days?|weeks?|months?|years?)\b\s+\bago)\b\s*\z/i
       return (eval($1.strip.gsub(/from\s+now/i,'from_now').gsub(/\s+/,'.').downcase)).to_datetime if value =~ /\A\s*(\d+\s+\b(?:hours?|minutes?)\b\s+\bfrom\s+now)\b\s*\z/i
-      return (eval($1.strip.gsub(/from\s+now/i,'from_now').gsub(/\s+/,'.').downcase)).to_date     if value =~ /\A\s*(\d+\s+\b(?:days?|weeks?|months?|years?)\b\s+\bfrom\s+now)\b\s*\z/i
+      return date_with_timezone(eval($1.strip.gsub(/from\s+now/i,'from_now').gsub(/\s+/,'.').downcase)) if value =~ /\A\s*(\d+\s+\b(?:days?|weeks?|months?|years?)\b\s+\bfrom\s+now)\b\s*\z/i
       if Time.respond_to?(:zone) && !Time.zone.nil?
         parsed = Time.zone.parse(value) rescue nil
         parsed && parsed.to_datetime
@@ -305,8 +305,8 @@ module ScopedSearch
     end
 
     # Defines a new search field for this search definition.
-    def define(*args)
-      Field.new(self, *args)
+    def define(*args, **kwargs)
+      Field.new(self, *args, **kwargs)
     end
 
     # Returns a reflection for a given klass and name
@@ -334,6 +334,14 @@ module ScopedSearch
 
         search_scope
       end
+
+      # This should get called only when the relative specifiers (1 day ago and
+      # so on), this code path is only viable when Rails are available
+      def date_with_timezone(datetime)
+        date = datetime.to_date
+        return datetime unless date.respond_to?(:in_time_zone)
+        date.in_time_zone.to_datetime
+      end
     end
 
     # Registers the complete_for method within the class that is used for searching.

data/lib/scoped_search/query_builder.rb

@@ -38,7 +38,9 @@ module ScopedSearch
 
     # Initializes the instance by setting the relevant parameters
     def initialize(definition, ast, profile)
-      @definition, @ast, @definition.profile = definition, ast, profile
+      @definition = definition
+      @ast = ast
+      @definition.profile = profile
     end
 
     # Actually builds the find parameters hash that should be used in the search_for
@@ -287,15 +289,20 @@ module ScopedSearch
       connection = many_class.connection
       sql = connection.quote_table_name(many_class.table_name)
       join_reflections = nested_has_many(many_class, field.relation)
-      table_names = [many_class.table_name] + join_reflections.map(&:table_name)
+      table_names = [[many_class.table_name, many_class.sti_name.tableize]] + join_reflections.map(&:table_name)
 
       join_reflections.zip(table_names.zip(join_reflections.drop(1))).reduce(sql) do |acc, (reflection, (previous_table, next_reflection))|
-        klass = reflection.method(:join_keys).arity == 1 ? [reflection.klass] : [] # ActiveRecord <5.2 workaround
-        fk1, pk1 = reflection.join_keys(*klass).values # We are joining the tables "in reverse", so the PK and FK are swapped
-
+        fk1, pk1 = if reflection.respond_to?(:join_keys)
+                     klass = reflection.method(:join_keys).arity == 1 ? [reflection.klass] : [] # ActiveRecord <5.2 workaround
+                     reflection.join_keys(*klass).values # We are joining the tables "in reverse", so the PK and FK are swapped
+                   else
+                     [reflection.join_primary_key, reflection.join_foreign_key] #ActiveRecord 6.1
+                   end
+
+        previous_table, sti_name = previous_table
         # primary and foreign keys + optional conditions for the joins
         join_condition = if with_polymorphism?(reflection)
-                           field.reflection_conditions(definition.reflection_by_name(next_reflection.klass, previous_table))
+                           field.reflection_conditions(definition.reflection_by_name(next_reflection.klass, sti_name || previous_table))
                          else
                            ''
                          end
@@ -443,7 +450,9 @@ module ScopedSearch
           field = definition.field_by_name(value)
           if field && field.set? && field.complete_value.values.include?(true)
             key = field.complete_value.map{|k,v| k if v == true}.compact.first
-            return builder.set_test(field, :eq, key, &block)
+            sql, *params = builder.set_test(field, :eq, key, &block)
+            params.each { |p| yield(:parameter, p) }
+            return sql
           end
           # Search keywords found without context, just search on all the default fields
           fragments = definition.default_fields_for(value).map do |field|

data/lib/scoped_search/version.rb

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

data/lib/scoped_search.rb

@@ -34,9 +34,9 @@ module ScopedSearch
 
       definitions.each do |definition|
         if definition[:on].kind_of?(Array)
-          definition[:on].each { |field| self.scoped_search_definition.define(definition.merge(:on => field)) }
+          definition[:on].each { |field| self.scoped_search_definition.define(**definition.merge(:on => field)) }
         else
-          self.scoped_search_definition.define(definition)
+          self.scoped_search_definition.define(**definition)
         end
       end
       return self.scoped_search_definition

data/spec/database.jruby.yml

@@ -4,7 +4,7 @@ sqlite:
 
 mysql:
   adapter: jdbcmysql
-  host: localhost
+  host: 127.0.0.1
   username: root
   database: scoped_search_test
 

data/spec/database.ruby.yml

@@ -4,7 +4,7 @@ sqlite:
 
 mysql:
   adapter: mysql2
-  host: localhost
+  host: 127.0.0.1
   port: 3306
   username: root
   database: scoped_search_test

data/spec/integration/ordinal_querying_spec.rb

@@ -210,6 +210,12 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
         @class.search_for('timestamp > "3 hours ago"').length.should == 4
       end
 
+      it "should take timezone into consideration" do
+        now = Time.now
+        expected = DateTime.new(now.year, now.month, now.day, 0, 0, 0, now.zone).utc.strftime('%Y-%m-%d %H:%M:%S')
+        @class.search_for('timestamp > yesterday').to_sql.should include(expected)
+      end
+
       it "should accept 1 week from now as date format" do
         @class.search_for('date < "1 week from now"').length.should == 6
       end

data/spec/integration/rails_helper_spec.rb

@@ -9,54 +9,54 @@ describe ScopedSearch::RailsHelper do
   let(:params) { HashWithIndifferentAccess.new(:controller => "resources", :action => "search") }
 
   it "should generate a link with the order param set" do
-    should_receive(:url_for).with(
+    should_receive(:url_for).with({
       "controller" => "resources",
       "action" => "search",
       "order" => "field ASC"
-    ).and_return("/example")
+    }).and_return("/example")
 
     sort("field")
   end
 
   it "should generate a link with order param set to alternative default sorting order" do
-    should_receive(:url_for).with(
+    should_receive(:url_for).with({
       "controller" => "resources",
       "action" => "search",
       "order" => "field DESC"
-    ).and_return("/example")
+    }).and_return("/example")
 
     sort("field", :default => "DESC")
   end
 
   it "should generate a link with the order param inverted" do
-    should_receive(:url_for).with(
+    should_receive(:url_for).with({
       "controller" => "resources",
       "action" => "search",
       "order" => "field DESC"
-    ).and_return("/example")
+    }).and_return("/example")
 
     params[:order] = "field ASC"
     sort("field")
   end
 
   it "should generate a link with other parameters retained" do
-    should_receive(:url_for).with(
+    should_receive(:url_for).with({
       "controller" => "resources",
       "action" => "search",
       "walrus" => "unicorns",
       "order" => "field ASC"
-    ).and_return("/example")
+    }).and_return("/example")
 
     params[:walrus] = "unicorns"
     sort("field")
   end
 
   it "should replace the current sorting order" do
-    should_receive(:url_for).with(
+    should_receive(:url_for).with({
       "controller" => "resources",
       "action" => "search",
       "order" => "other ASC"
-    ).and_return("/example")
+    }).and_return("/example")
 
     params[:order] = "field ASC"
     sort("other")
@@ -83,12 +83,12 @@ describe ScopedSearch::RailsHelper do
     let(:ac_params) { double('ActionController::Parameters') }
 
     it "should call to_h on passed params object" do
-      should_receive(:url_for).with(
+      should_receive(:url_for).with({
         "controller" => "resources",
         "action" => "search",
         "walrus" => "unicorns",
         "order" => "field ASC"
-      ).and_return("/example")
+      }).and_return("/example")
 
       params[:walrus] = "unicorns"
 

data/spec/integration/set_query_spec.rb

@@ -12,6 +12,7 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
       @class = ScopedSearch::RSpec::Database.create_model(:bool => :boolean, :status => :integer) do |klass|
         klass.scoped_search :on => :bool, :complete_value => {:yes => true, :no => false}
         klass.scoped_search :on => :status, :complete_value => {:unknown => 0, :up => 1, :down => 2}
+        klass.scoped_search :on => :bool, :rename => :bool2, :complete_value => {:true => true, :false => false}
       end
     end
 
@@ -71,6 +72,11 @@ ScopedSearch::RSpec::Database.test_databases.each do |db|
       it "should find two record with bool = false" do
         @class.search_for('bool != yes').length.should == 2
       end
+
+      it "should be able to search without value" do
+        @class.search_for('bool').length.should == 1
+        @class.search_for('bool2').length.should == 1
+      end
     end
   end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: scoped_search
 version: !ruby/object:Gem::Version
-  version: 4.1.9
+  version: 4.1.11
 platform: ruby
 authors:
 - Amos Benari
 - Willem van Bergen
 - Wes Hays
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2023-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -77,6 +77,7 @@ extra_rdoc_files:
 - CONTRIBUTING.rdoc
 - LICENSE
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.rdoc
@@ -89,6 +90,8 @@ files:
 - Gemfile.activerecord52_with_activesupport52
 - Gemfile.activerecord60
 - Gemfile.activerecord60_with_activesupport60
+- Gemfile.activerecord61
+- Gemfile.activerecord61_with_activesupport61
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -141,7 +144,7 @@ homepage: https://github.com/wvanbergen/scoped_search/wiki
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--title"
 - scoped_search
@@ -162,8 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.13
+signing_key:
 specification_version: 4
 summary: Easily search you ActiveRecord models with a simple query language using
   a named scope