db_text_search 0.2.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0b93fa5e6feaef447c7bd1e8580b42aafa2cca3d
-  data.tar.gz: d1ddab5bfe8ef8cb544c711ab1b4792882578eab
+SHA256:
+  metadata.gz: f1cd1c9c3fac9de18b145e38bbb51b61bb686aa7c4a750bb3857170ee29afdd0
+  data.tar.gz: 2b87d5dc1d79444fffe06eb5686de7f8bf52d2e1a1cfb650ddcc61ff1328e6c8
 SHA512:
-  metadata.gz: ffe48a13416b0dd7d820584d411c5a4e22806738e1bc3c36fd2be0121f890b621269f62a058b3791e0322e5f51edc05c255ab0ee87958c8b4e0e1846dba41ca9
-  data.tar.gz: b07cce34cda731a695d59da849cb0e62a0f2c2247584c32a21cf23c75afeba4382cad4d3fe2cff945e4ccd05bedcd114af44ed5248c1775c2fe5e4c3e148a016
+  metadata.gz: cb396b8558c1f6bce6ed3eb9f2c1c70179a729d0f22578fbadbf85503eeeef098596fb7c9dbb26e3a81bc099dcd708ba9746ff69245968de7cda9aea03aba6e1
+  data.tar.gz: bfaff15b9d3e0bb7416d190723e54e9900239421af12faa329f9d8bf2dd9161d9e22b6e17b402b079bd103d3218a689f0b45fa123fba0b526a764691192d2a14

data/CHANGES.md

@@ -1,3 +1,26 @@
+## v0.3.2
+
+* Allow Ruby 3.0
+
+## v0.3.1
+
+* Rails 6 support.
+  [ff16189f](https://github.com/thredded/db_text_search/commit/ff16189fdc7b1bf7b66e4bedc27483aaf3e75414)
+
+## v0.3.0
+
+* **Feature** Case insensitive sorting via the new `CaseInsensitive#column_for_order(asc_or_desc)` method. Use it like `SomeModel.some_scope.order(CaseInsensitive.new(SomeModel, :some_field).column_for_order(:asc))`
+
+## v0.2.2
+
+* Raises a more helpful error if the column is not found when calling
+  `DbTextSearch::CaseInsensitive`.
+
+## v0.2.1
+
+* Support for PostGIS adapters.
+  [#2](https://github.com/thredded/db_text_search/issues/2)
+
 ## v0.2.0
 
 * **Feature** Prefix matching via the new `CaseInsensitive#prefix` method.

data/README.md

@@ -11,7 +11,7 @@ DbTextSearch provides a unified interface on top of ActiveRecord for SQLite, MyS
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'db_text_search', '~> 0.2.0'
+gem 'db_text_search', '~> 0.3.2'
 ```
 
 ## Usage

data/RELEASE-CHECKLIST.md

@@ -0,0 +1,17 @@
+The checklist for releasing a new version of db_text_search.
+
+Pre-requisites for the releaser:
+
+* Push access to RubyGems.
+
+Release checklist:
+
+- [ ] Update gem version in `version.rb` and `README.md`.
+- [ ] Update `CHANGELOG.md`.
+- [ ] Wait for the Travis build to come back green.
+- [ ] Tag the release and push it to rubygems:
+
+  ```bash
+  rake release
+  ```
+- [ ] Copy the release notes from the changelog to [GitHub Releases](https://github.com/thredded/thredded/releases).

data/db_text_search.gemspec

@@ -20,15 +20,15 @@ Gem::Specification.new do |s|
   s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|bin|script)/|^\.|Rakefile|Gemfile}) }
 
   s.require_paths         = ['lib']
-  s.required_ruby_version = '~> 2.1'
+  s.required_ruby_version = '>= 2.1', '< 4.0'
 
-  s.add_dependency 'activerecord', '>= 4.1.15', '< 6.0'
+  s.add_dependency 'activerecord', '>= 4.1.15', '< 7.0'
 
   s.add_development_dependency 'mysql2', '>= 0.3.20'
   s.add_development_dependency 'pg', '>= 0.18.4'
   s.add_development_dependency 'sqlite3', '>= 1.3.11'
 
-  s.add_development_dependency 'bundler', '~> 1.11'
-  s.add_development_dependency 'rake', '~> 11.0'
+  s.add_development_dependency 'rake', '~> 13.0'
   s.add_development_dependency 'rspec', '~> 3.4'
+  s.add_development_dependency 'simplecov'
 end

data/lib/db_text_search.rb

@@ -24,7 +24,7 @@ module DbTextSearch
     case connection.adapter_name
       when /mysql/i
         mysql.call
-      when /postgres/i
+      when /postg/i # match all postgres and postgis adapters
         postgres.call
       when /sqlite/i
         sqlite.call

data/lib/db_text_search/case_insensitive.rb

@@ -29,13 +29,20 @@ module DbTextSearch
       @adapter.prefix(query)
     end
 
+    # @param asc_or_desc [Symbol]
+    # @return [Arel::Collectors::SQLString] a string to be used within an `.order()`
+    def column_for_order(asc_or_desc)
+      fail 'Pass either :asc or :desc' unless %i[asc desc].include?(asc_or_desc)
+      @adapter.column_for_order(asc_or_desc)
+    end
+
     # Adds a case-insensitive column to the given table.
     # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
     # @param table_name [String, Symbol]
     # @param column_name [String, Symbol]
     # @param options [Hash] passed to ActiveRecord::ConnectionAdapters::SchemaStatements#add_index
     def self.add_ci_text_column(connection, table_name, column_name, options = {})
-      connection.add_column table_name, column_name, *DbTextSearch.match_adapter(
+      type, options = DbTextSearch.match_adapter(
           connection,
           mysql:    -> { [:text, options] },
           postgres: -> {
@@ -48,7 +55,9 @@ module DbTextSearch
             else
               ['TEXT COLLATE NOCASE', options]
             end
-          })
+          }
+      )
+      connection.add_column table_name, column_name, type, **options
     end
 
     # Add an index for case-insensitive string search.
@@ -78,7 +87,8 @@ module DbTextSearch
           postgres: lower_or_insensitive,
           # Always use COLLATE NOCASE for SQLite, as we can't check if the column is case-sensitive.
           # It has no performance impact apart from slightly longer query strings for case-insensitive columns.
-          sqlite:   -> { CollateNocaseAdapter })
+          sqlite:   -> { CollateNocaseAdapter }
+      )
     end
 
     # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
@@ -87,13 +97,15 @@ module DbTextSearch
     # @return [Boolean]
     # @note sqlite not supported.
     # @api private
-    def self.column_case_sensitive?(connection, table_name, column_name)
+    def self.column_case_sensitive?(connection, table_name, column_name) # rubocop:disable Metrics/AbcSize
       column = connection.schema_cache.columns(table_name).detect { |c| c.name == column_name.to_s }
+      fail "Column #{column_name.to_s.inspect} not found on table #{table_name.inspect}" if column.nil?
       DbTextSearch.match_adapter(
           connection,
           mysql:    -> { column.case_sensitive? },
           postgres: -> { column.sql_type !~ /citext/i },
-          sqlite:   -> { DbTextSearch.unsupported_adapter! connection })
+          sqlite:   -> { DbTextSearch.unsupported_adapter! connection }
+      )
     end
   end
 end

data/lib/db_text_search/case_insensitive/abstract_adapter.rb

@@ -30,6 +30,13 @@ module DbTextSearch
         fail 'abstract'
       end
 
+      # @param asc_or_desc [Symbol]
+      # @return [Arel::Collectors::SQLString]
+      # @abstract
+      def column_for_order(asc_or_desc)
+        fail 'abstract'
+      end
+
       # Add an index for case-insensitive string search.
       #
       # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]

data/lib/db_text_search/case_insensitive/collate_nocase_adapter.rb

@@ -22,6 +22,11 @@ module DbTextSearch
                      escaped_query
       end
 
+      # (see AbstractAdapter#column_for_order)
+      def column_for_order(asc_or_desc)
+        Arel.sql("#{quoted_scope_column} COLLATE NOCASE #{asc_or_desc}")
+      end
+
       # (see AbstractAdapter.add_index)
       def self.add_index(connection, table_name, column_name, options = {})
         # TODO: Switch to the native Rails solution once it's landed, as the current one requires SQL dump format.

data/lib/db_text_search/case_insensitive/insensitive_column_adapter.rb

@@ -16,9 +16,14 @@ module DbTextSearch
         @scope.where "#{quoted_scope_column} LIKE ?", "#{sanitize_sql_like(query)}%"
       end
 
+      # (see AbstractAdapter#column_for_order)
+      def column_for_order(asc_or_desc)
+        Arel.sql("#{quoted_scope_column} #{asc_or_desc}")
+      end
+
       # (see AbstractAdapter.add_index)
       def self.add_index(connection, table_name, column_name, options = {})
-        connection.add_index table_name, column_name, options
+        connection.add_index table_name, column_name, **options
       end
     end
   end

data/lib/db_text_search/case_insensitive/lower_adapter.rb

@@ -17,6 +17,11 @@ module DbTextSearch
         @scope.where "LOWER(#{quoted_scope_column}) LIKE LOWER(?)", "#{sanitize_sql_like(query)}%"
       end
 
+      # (see AbstractAdapter#column_for_order)
+      def column_for_order(asc_or_desc)
+        Arel.sql("LOWER(#{quoted_scope_column}) #{asc_or_desc}")
+      end
+
       # (see AbstractAdapter.add_index)
       def self.add_index(connection, table_name, column_name, options = {})
         unsupported = -> { DbTextSearch.unsupported_adapter! connection }
@@ -31,7 +36,8 @@ module DbTextSearch
               connection.exec_query(quoted_create_index(connection, table_name, **options))
             },
             mysql:    unsupported,
-            sqlite:   unsupported)
+            sqlite:   unsupported
+        )
       end
     end
   end

data/lib/db_text_search/full_text.rb

@@ -49,7 +49,8 @@ module DbTextSearch
           connection,
           mysql:    -> { MysqlAdapter },
           postgres: -> { PostgresAdapter },
-          sqlite:   -> { SqliteAdapter })
+          sqlite:   -> { SqliteAdapter }
+      )
     end
   end
 end

data/lib/db_text_search/full_text/sqlite_adapter.rb

@@ -20,8 +20,7 @@ module DbTextSearch
       end
 
       # A no-op, as we just use LIKE for sqlite.
-      def self.add_index(_connection, _table_name, _column_name, name:, pg_ts_config:)
-      end
+      def self.add_index(_connection, _table_name, _column_name, name:, pg_ts_config:); end
     end
   end
 end

data/lib/db_text_search/version.rb

@@ -2,5 +2,5 @@
 
 module DbTextSearch
   # Gem version
-  VERSION = '0.2.0'
+  VERSION = '0.3.2'
 end

data/rubocop.gemfile

@@ -0,0 +1 @@
+gem 'rubocop', '= 0.49.1'

data/shared.gemfile

@@ -1,9 +1,4 @@
-if ENV['TRAVIS']
-  group :test do
-    gem 'codeclimate-test-reporter', require: false
-    gem 'codeclimate_batch', require: false
-  end
-else
+unless ENV['TRAVIS']
   group :test, :development do
     gem 'byebug', platform: :mri, require: false
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: db_text_search
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Gleb Mazovetskiy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2021-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: 4.1.15
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 4.1.15
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -73,47 +73,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.3.11
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '0'
 description: Different relational databases treat text search very differently. DbTextSearch
   provides a unified interface on top of ActiveRecord for SQLite, MySQL, and PostgreSQL
   to do case-insensitive string-in-set querying and CI index creation, and basic full-text
@@ -128,6 +128,7 @@ files:
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
+- RELEASE-CHECKLIST.md
 - db_text_search.gemspec
 - lib/db_text_search.rb
 - lib/db_text_search/case_insensitive.rb
@@ -142,31 +143,33 @@ files:
 - lib/db_text_search/full_text/sqlite_adapter.rb
 - lib/db_text_search/query_building.rb
 - lib/db_text_search/version.rb
+- rubocop.gemfile
 - shared.gemfile
 homepage: https://github.com/thredded/db_text_search
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.1'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A unified interface on top of ActiveRecord for SQLite, MySQL, and PostgreSQLfor
   case-insensitive string search and basic full-text search.
 test_files: []
-has_rdoc: