db_text_search 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b0172bff01c9eb57aab0b3946ef2b867bf998860
-  data.tar.gz: 4693691bcbeca4e5a0e8dedf9aac48fabc69d356
+SHA256:
+  metadata.gz: 2df07aa92536965de8e524cf332fa67ee9fd9ad6fbb2a2989755a03414047c28
+  data.tar.gz: 5aed016ea41bd0c7c7413273c8a4a55f39fa431f3e524ae110f1c8d72cb8d1b0
 SHA512:
-  metadata.gz: 84f63d51d4fcc3c92731101606036cd57253264c4bcbd376b03411d4a0a0e6d230702a481eb200c9d716e4f76e141ab2ce4e76971eecdc8f920aa83332b35050
-  data.tar.gz: 3f33248a25268519669f645d22a900f214a480eadd924bf0b1fe4bdbc59a2907d5e38458c8210f475d932ebe84745663aa45a3393a7b8c75d2388ce7f847b883
+  metadata.gz: c23fcfa34bfd7a6f3a552dfbdeaa2d742c165897590b86083448743f701763908ee912a225f48fd9d681d79086056efa50f7a80b663b5e6dd9564d61240f365d
+  data.tar.gz: 558815223c1e3782cebf0726ab115548cac6dae63a7e37e59f88828a545a45d0984cf311151a63b736bd85f76ef974d9d2592d7c5c563735d0aa48c54e41848c

data/CHANGES.md

@@ -1,3 +1,24 @@
+## Unreleased
+
+## v1.0.0
+
+* We test on Rails 5.2, 6.0, 6.1, 7.0, so we're pretty sure these work.
+* We test on Rails main, to find out about any impacts of new changes, this doesn't mean we know that 7.1 is supported yet.
+* We no longer test on Rails < 5.2, so please use v0.3.2 or lower for guaranteed Rails 4.2 etc (however we haven't yet removed it from the gemspec, because it might still work)
+
+## 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

data/README.md

@@ -1,4 +1,4 @@
-# DbTextSearch [![Build Status](https://travis-ci.org/thredded/db_text_search.svg?branch=master)](https://travis-ci.org/thredded/db_text_search) [![Code Climate](https://codeclimate.com/github/thredded/db_text_search/badges/gpa.svg)](https://codeclimate.com/github/thredded/db_text_search) [![Test Coverage](https://codeclimate.com/github/thredded/db_text_search/badges/coverage.svg)](https://codeclimate.com/github/thredded/db_text_search/coverage)
+# DbTextSearch [![Build Status](https://travis-ci.org/thredded/db_text_search.svg?branch=main)](https://travis-ci.org/thredded/db_text_search) [![Code Climate](https://codeclimate.com/github/thredded/db_text_search/badges/gpa.svg)](https://codeclimate.com/github/thredded/db_text_search) [![Test Coverage](https://codeclimate.com/github/thredded/db_text_search/badges/coverage.svg)](https://codeclimate.com/github/thredded/db_text_search/coverage)
 
 Different relational databases treat text search very differently.
 DbTextSearch provides a unified interface on top of ActiveRecord for SQLite, MySQL, and PostgreSQL to do:
@@ -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.2'
+gem 'db_text_search', '~> 1.0'
 ```
 
 ## 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,17 +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'
 
   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'
-  s.add_development_dependency 'rubocop', '= 0.49.1'
 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 }

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: -> {
@@ -50,6 +57,7 @@ module DbTextSearch
             end
           }
       )
+      connection.add_column table_name, column_name, type, **options
     end
 
     # Add an index for case-insensitive string search.

data/lib/db_text_search/version.rb

@@ -2,5 +2,5 @@
 
 module DbTextSearch
   # Gem version
-  VERSION = '0.2.2'
+  VERSION = '1.0.0'
 end

data/rubocop.gemfile

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

data/shared.gemfile

@@ -1,13 +1,4 @@
-if ENV['TRAVIS']
-  group :test do
-    gem 'codeclimate-test-reporter', require: false
-    gem 'codeclimate_batch', require: false,
-        # TODO: use the released version once a new release that supports
-        # codeclimate-test-reporter v1.0+ is out.
-        git: 'https://github.com/sethherr/codeclimate_batch',
-        branch: 'new_simplecov'
-  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.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Gleb Mazovetskiy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-06-10 00:00:00.000000000 Z
+date: 2022-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.15
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.15
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -72,34 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.11
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,20 +108,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.49.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.49.1
 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
@@ -156,6 +122,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
@@ -170,29 +137,32 @@ 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.6.12
-signing_key: 
+rubygems_version: 3.1.6
+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.