db_text_search 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 874e1b8761af33f55c19c2a67c12dea616a80bc4
+  data.tar.gz: a874ec1e3e6160ef2e5ad01f14020966b43f7cf9
+SHA512:
+  metadata.gz: 81aae784b663e11355935fe800aefb4a377bbfa2c9adca47114ecc3ff7040cfd53361b2b809655b328b76bd085f04d49535da9b1143b4777789ea4a8394b6cdc
+  data.tar.gz: f6496edfa09ee256d0ef65f95ce87a3a365c3e5095b4f4d62c544bdf7f93c95698bacefe3a4179081ee77dad8f992e6e6f14ede94a11160647d64ae25acd511d

data/CHANGES.md

@@ -0,0 +1,3 @@
+## v0.1.1
+
+Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at glex.spb@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gleb Mazovetskiy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,113 @@
+# 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)
+
+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.
+* Basic full-text search for a list of terms, and FTS index creation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'db_text_search', '~> 0.1.1'
+```
+
+## Usage
+
+### Case-insensitive string matching
+
+Add an index in a migration to an existing CI or CS column:
+
+```ruby
+DbTextSearch::CaseInsensitiveEq.add_index connection, :users, :username
+# Options: name, unique
+```
+
+Or, create a new CI column:
+
+```ruby
+DbTextSearch::CaseInsensitiveEq.add_ci_text_column connection, :users, :username
+```
+
+Perform a search for records with column that case-insensitively equals to one of the strings in a given set:
+
+```ruby
+DbTextSearch::CaseInsensitiveEq.new(User.confirmed, :username).find(%w(Alice Bob))
+ #=> ActiveRecord::Relation
+```
+
+See also: [API documentation][api-docs].
+
+### Full text search
+
+Add an index:
+
+```ruby
+DbTextSearch::FullTextSearch.add_index connection, :posts, :content
+# Options: name
+```
+
+Perform a full-text search:
+
+```ruby
+DbTextSearch::FullTextSearch.new(Post.published, :content).find('peace')
+DbTextSearch::FullTextSearch.new(Post.published, :content).find(%w(love kaori))
+```
+
+## Under the hood
+
+<table>
+<caption>Case-insensitive string matching methods</caption>
+<thead>
+  <tr><th rowspan="2">Column type</th><th colspan="2">SQLite</th><th colspan="2">MySQL</th><th colspan="2">PostgreSQL</th>
+  <tr><th>Detected types</th><th>Search / index</th><th>Detected types</th><th>Search / index</th><th>Detected types</th><th>Search / index</th></tr>
+</thead>
+<tbody style="text-align: center">
+  <tr><th>CI</th>
+      <td rowspan="2">always treated as CS</td> <td rowspan="2"><code>COLLATE&nbsp;NOCASE</code></td>
+      <td><i>default</i></td> <td><i>default</i></td>
+      <td><code>CITEXT</code></td> <td><i>default</i></td>
+  <tr><th>CS</th>
+    <td>non-<code>ci</code> collations</td> <td><code>LOWER</code><br><b>no index</b></td>
+    <td><i>default</i></td> <td><code>LOWER</code></td>
+  </tr>
+  </tr>
+</tbody>
+</table>
+
+### Full-text search
+
+#### MySQL
+
+A `FULLTEXT` index, and a `MATCH AGAINST` query.
+
+#### PostgreSQL
+
+A `gist(to_tsvector(...))` index, and a `@@ plainto_tsquery` query.
+Methods also accept an optional `pg_ts_config` argument (default: `"'english'"`) that is ignored for other databases.
+
+#### SQLite
+
+**No index**, a `LIKE %term%` query for each term joined with `AND`.
+
+## Development
+
+Make sure you have a working installation of SQLite, MySQL, and PostgreSQL.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test_all` to run the tests with all databases and gemfiles.
+
+See the Rakefile for other available test tasks.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thredded/db_text_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[api-docs]: http://www.rubydoc.info/gems/db_text_search

data/db_text_search.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'db_text_search/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'db_text_search'
+  s.version       = DbTextSearch::VERSION
+  s.authors       = ['Gleb Mazovetskiy']
+  s.email         = ['glex.spb@gmail.com']
+
+  s.summary       = %q{A unified interface on top of ActiveRecord for SQLite, MySQL, and PostgreSQL for case-insensitive string search and basic full-text search.}
+  s.description   = %q{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.
+* Basic full-text search for a list of terms, and FTS index creation.
+}
+  s.homepage      = 'https://github.com/thredded/db_text_search'
+  s.license       = 'MIT'
+
+  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.add_dependency 'activerecord', '>= 4.1.15', '< 6.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 'rspec', '~> 3.4'
+end

data/lib/db_text_search/case_insensitive_eq/abstract_adapter.rb

@@ -0,0 +1,35 @@
+require 'db_text_search/query_building'
+module DbTextSearch
+  class CaseInsensitiveEq
+    # A base class for CaseInsensitiveStringFinder adapters.
+    class AbstractAdapter
+      include ::DbTextSearch::QueryBuilding
+
+      # @param scope [ActiveRecord::Relation, Class<ActiveRecord::Base>]
+      # @param column [Symbol] name
+      def initialize(scope, column)
+        @scope  = scope
+        @column = column
+      end
+
+      # @param values [Array<String>]
+      # @return [ActiveRecord::Relation]
+      # @abstract
+      def find(values)
+        fail 'abstract'
+      end
+
+      # Add an index for case-insensitive string search.
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
+      # @param table_name [String, Symbol]
+      # @param column_name [String, Symbol]
+      # @param options [Hash] passed down to ActiveRecord::ConnectionAdapters::SchemaStatements#add_index.
+      # @return (see ActiveRecord::ConnectionAdapters::SchemaStatements#add_index)
+      # @abstract
+      def self.add_index(connection, table_name, column_name, options = {})
+        fail 'abstract'
+      end
+    end
+  end
+end

data/lib/db_text_search/case_insensitive_eq/collate_nocase_adapter.rb

@@ -0,0 +1,26 @@
+require 'db_text_search/case_insensitive_eq/abstract_adapter'
+module DbTextSearch
+  class CaseInsensitiveEq
+    class CollateNocaseAdapter < AbstractAdapter
+      # (see AbstractAdapter#find)
+      def find(values)
+        conn = @scope.connection
+        @scope.where <<-SQL.strip
+          #{quoted_scope_column} COLLATE NOCASE IN (#{values.map { |v| conn.quote(v.to_s) }.join(', ')})
+        SQL
+      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.
+        # https://github.com/rails/rails/pull/18499
+        options.assert_valid_keys(:name, :unique)
+        index_name = options[:name] || options[:name] || "#{column_name}_nocase"
+        connection.exec_query <<-SQL.strip
+          CREATE #{'UNIQUE ' if options[:unique]}INDEX #{index_name} ON #{connection.quote_table_name(table_name)}
+            (#{connection.quote_column_name(column_name)} COLLATE NOCASE);
+        SQL
+      end
+    end
+  end
+end

data/lib/db_text_search/case_insensitive_eq/insensitive_column_adapter.rb

@@ -0,0 +1,16 @@
+require 'db_text_search/case_insensitive_eq/abstract_adapter'
+module DbTextSearch
+  class CaseInsensitiveEq
+    class InsensitiveColumnAdapter < AbstractAdapter
+      # (see AbstractAdapter#find)
+      def find(values)
+        @scope.where(@column => values)
+      end
+
+      # (see AbstractAdapter.add_index)
+      def self.add_index(connection, table_name, column_name, options = {})
+        connection.add_index table_name, column_name, options
+      end
+    end
+  end
+end

data/lib/db_text_search/case_insensitive_eq/lower_adapter.rb

@@ -0,0 +1,37 @@
+require 'db_text_search/case_insensitive_eq/abstract_adapter'
+module DbTextSearch
+  class CaseInsensitiveEq
+    class LowerAdapter < AbstractAdapter
+      # (see AbstractAdapter#find)
+      def find(values)
+        conn = @scope.connection
+        @scope.where <<-SQL.strip
+          LOWER(#{quoted_scope_column}) IN (#{values.map { |v| "LOWER(#{conn.quote(v.to_s)})" }.join(', ')})
+        SQL
+      end
+
+      # (see AbstractAdapter.add_index)
+      def self.add_index(connection, table_name, column_name, options = {})
+        if connection.adapter_name =~ /postgres/i
+          # TODO: Switch to native Rails support once it lands.
+          # https://github.com/rails/rails/pull/18499
+          index_name = options[:name] || "#{table_name}_#{column_name}_lower"
+          if defined?(SchemaPlus)
+            connection.add_index(table_name, column_name, options.merge(
+                name: index_name, expression: "LOWER(#{connection.quote_column_name(column_name)})"))
+          else
+            options.assert_valid_keys(:name, :unique)
+            connection.exec_query <<-SQL.strip
+              CREATE #{'UNIQUE ' if options[:unique]}INDEX #{index_name} ON #{connection.quote_table_name(table_name)}
+                (LOWER(#{connection.quote_column_name(column_name)}));
+            SQL
+          end
+        elsif connection.adapter_name =~ /mysql/i
+          fail 'MySQL case-insensitive index creation for case-sensitive columns is not supported.'
+        else
+          fail "Cannot create a case-insensitive index for case-sensitive column on #{connection.adapter_name}."
+        end
+      end
+    end
+  end
+end

data/lib/db_text_search/case_insensitive_eq.rb

@@ -0,0 +1,88 @@
+require 'db_text_search/case_insensitive_eq/insensitive_column_adapter'
+require 'db_text_search/case_insensitive_eq/lower_adapter'
+require 'db_text_search/case_insensitive_eq/collate_nocase_adapter'
+
+module DbTextSearch
+  # Provides case-insensitive string-in-set querying, and CI index creation.
+  class CaseInsensitiveEq
+    # (see AbstractAdapter)
+    def initialize(scope, column)
+      @adapter = self.class.adapter_class(scope.connection, scope.table_name, column).new(scope, column)
+      @scope   = scope
+    end
+
+    # @param value_or_values [String, Array<String>]
+    # @return (see AbstractAdapter#find)
+    def find(value_or_values)
+      values = Array(value_or_values)
+      return @scope.none if values.empty?
+      @adapter.find(values)
+    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]
+    def self.add_ci_text_column(connection, table_name, column_name, options = {})
+      case connection.adapter_name.downcase
+        when /mysql/
+          connection.add_column(table_name, column_name, :text, options)
+        when /postgres/
+          connection.enable_extension 'citext'
+          if ActiveRecord::VERSION::MAJOR >= 4 && ActiveRecord::VERSION::MINOR >= 2
+            connection.add_column(table_name, column_name, :citext, options)
+          else
+            connection.add_column(table_name, column_name, 'CITEXT', options)
+          end
+        when /sqlite/
+          if ActiveRecord::VERSION::MAJOR >= 5
+            connection.add_column(table_name, column_name, :text, options.merge(collation: 'NOCASE'))
+          else
+            connection.add_column(table_name, column_name, 'TEXT COLLATE NOCASE', options)
+          end
+        else
+          fail "Unsupported adapter #{connection.adapter_name}"
+      end
+    end
+
+    # (see AbstractAdapter.add_index)
+    def self.add_index(connection, table_name, column_name, options = {})
+      adapter_class(connection, table_name, column_name).add_index(connection, table_name, column_name, options)
+    end
+
+    # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
+    # @param table_name [String, Symbol]
+    # @param column_name [String, Symbol]
+    # @return [Class<AbstractAdapter>]
+    def self.adapter_class(connection, table_name, column_name)
+      if connection.adapter_name.downcase =~ /sqlite/
+        # 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.
+        CollateNocaseAdapter
+      elsif column_case_sensitive?(connection, table_name, column_name)
+        LowerAdapter
+      else
+        InsensitiveColumnAdapter
+      end
+    end
+
+    # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
+    # @param table_name [String, Symbol]
+    # @param column_name [String, Symbol]
+    # @return [Boolean]
+    # @note sqlite not supported.
+    # @api private
+    def self.column_case_sensitive?(connection, table_name, column_name)
+      column = connection.schema_cache.columns(table_name).detect { |c| c.name == column_name.to_s }
+      case connection.adapter_name.downcase
+        when /mysql/
+          column.case_sensitive?
+        when /postgres/
+          column.sql_type !~ /citext/i
+        else
+          fail "Unsupported adapter #{connection.adapter_name}"
+      end
+    end
+  end
+end

data/lib/db_text_search/full_text_search/abstract_adapter.rb

@@ -0,0 +1,50 @@
+module DbTextSearch
+  class FullTextSearch
+    # A base class for FullTextSearch adapters.
+    class AbstractAdapter
+      include ::DbTextSearch::QueryBuilding
+      DEFAULT_PG_TS_CONFIG = %q('english')
+
+      # @param scope [ActiveRecord::Relation, Class<ActiveRecord::Base>]
+      # @param column [Symbol] name
+      def initialize(scope, column)
+        @scope  = scope
+        @column = column
+      end
+
+      # @param terms [Array<String>]
+      # @return [ActiveRecord::Relation]
+      def find(terms)
+        @scope.where(*where_args(terms))
+      end
+
+      # @param terms [Array<String>]
+      # @param options [Hash]
+      # @option options pg_ts_config [String] a pg text search config. Default: 'english'
+      # @return [query fragment, binds]
+      # @abstract
+      def where_args(terms, options = {})
+        fail 'abstract'
+      end
+
+      # Add an index for full text search.
+      #
+      # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
+      # @param table_name [String, Symbol]
+      # @param column_name [String, Symbol]
+      # @param options [Hash] passed down to ActiveRecord::ConnectionAdapters::SchemaStatements#add_index.
+      # @return (see ActiveRecord::ConnectionAdapters::SchemaStatements#add_index)
+      # @abstract
+      def self.add_index(connection, table_name, column_name, options = {})
+        fail 'abstract'
+      end
+
+      protected
+
+      def parse_search_options(options = {})
+        options.assert_valid_keys(:pg_ts_config)
+        options.reverse_merge(pg_ts_config: DEFAULT_PG_TS_CONFIG)
+      end
+    end
+  end
+end

data/lib/db_text_search/full_text_search/mysql_adapter.rb

@@ -0,0 +1,19 @@
+require 'db_text_search/full_text_search/abstract_adapter'
+module DbTextSearch
+  class FullTextSearch
+    class MysqlAdapter < AbstractAdapter
+      # (see AbstractAdapter#where_args)
+      def where_args(terms, options = {})
+        parse_search_options(options)
+        conn = @scope.connection
+        ["MATCH (#{conn.quote_table_name(@scope.table_name)}.#{conn.quote_column_name(@column)}) AGAINST (?)",
+         terms.uniq.join(' ')]
+      end
+
+      # (see AbstractAdapter.add_index)
+      def self.add_index(connection, table_name, column_name, options = {})
+        connection.add_index table_name, column_name, options.merge(type: :fulltext)
+      end
+    end
+  end
+end

data/lib/db_text_search/full_text_search/postgres_adapter.rb

@@ -0,0 +1,25 @@
+require 'db_text_search/full_text_search/abstract_adapter'
+module DbTextSearch
+  class FullTextSearch
+    class PostgresAdapter < AbstractAdapter
+      # (see AbstractAdapter#where_args)
+      def where_args(terms, options = {})
+        options      = parse_search_options(options)
+        pg_ts_config = options[:pg_ts_config]
+        ["to_tsvector(#{pg_ts_config}, #{quoted_scope_column}::text) @@ plainto_tsquery(#{pg_ts_config}, ?)",
+         terms.uniq.join(' ')]
+      end
+
+      # (see AbstractAdapter.add_index)
+      def self.add_index(connection, table_name, column_name, options = {})
+        options.assert_valid_keys(:name, :pg_ts_config)
+        pg_ts_config    = options[:pg_ts_config] || DEFAULT_PG_TS_CONFIG
+        index_name      = options[:name] || "#{table_name}_#{column_name}_fts"
+        connection.exec_query <<-SQL.strip
+          CREATE INDEX #{index_name} ON #{connection.quote_table_name(table_name)}
+            USING gist(to_tsvector(#{pg_ts_config}, #{connection.quote_column_name column_name}))
+        SQL
+      end
+    end
+  end
+end

data/lib/db_text_search/full_text_search/sqlite_adapter.rb

@@ -0,0 +1,21 @@
+require 'db_text_search/full_text_search/abstract_adapter'
+module DbTextSearch
+  class FullTextSearch
+    class SqliteAdapter < AbstractAdapter
+      # (see AbstractAdapter.where_args)
+      def where_args(terms, options = {})
+        parse_search_options(options)
+        quoted_col = quoted_scope_column
+        term_args = terms.map(&:downcase).uniq.map do |term|
+          ["#{quoted_col} COLLATE NOCASE LIKE ?", "%#{sanitize_sql_like term}%"]
+        end
+        [term_args.map(&:first).join(' AND '), *term_args.map(&:second)]
+      end
+
+      # (see AbstractAdapter.add_index)
+      def self.add_index(connection, table_name, column_name, options = {})
+        # A no-op, as we just use LIKE for sqlite.
+      end
+    end
+  end
+end

data/lib/db_text_search/full_text_search.rb

@@ -0,0 +1,44 @@
+require 'db_text_search/full_text_search/postgres_adapter'
+require 'db_text_search/full_text_search/mysql_adapter'
+require 'db_text_search/full_text_search/sqlite_adapter'
+
+module DbTextSearch
+  # Provides case-insensitive string-in-set querying, and CI index creation.
+  class FullTextSearch
+    # (see AbstractAdapter)
+    def initialize(scope, column)
+      @adapter = self.class.adapter_class(scope.connection, scope.table_name, column).new(scope, column)
+      @scope   = scope
+    end
+
+    # @param term_or_terms [String, Array<String>]
+    # @return (see AbstractAdapter#find)
+    def find(term_or_terms)
+      values = Array(term_or_terms)
+      return @scope.none if values.empty?
+      @adapter.find(values)
+    end
+
+    # (see AbstractAdapter.add_index)
+    def self.add_index(connection, table_name, column_name, options = {})
+      adapter_class(connection, table_name, column_name).add_index(connection, table_name, column_name, options)
+    end
+
+    # @param connection [ActiveRecord::ConnectionAdapters::AbstractAdapter]
+    # @param _table_name [String, Symbol]
+    # @param _column_name [String, Symbol]
+    # @return [Class<AbstractAdapter>]
+    def self.adapter_class(connection, _table_name, _column_name)
+      case connection.adapter_name
+        when /mysql/i
+          MysqlAdapter
+        when /postgres/i
+          PostgresAdapter
+        when /sqlite/i
+          SqliteAdapter
+        else
+          fail "unknown adapter #{connection.adapter_name}"
+      end
+    end
+  end
+end

data/lib/db_text_search/query_building.rb

@@ -0,0 +1,22 @@
+module DbTextSearch
+  module QueryBuilding
+    protected
+
+    def quoted_scope_table
+      @scope.connection.quote_table_name(@scope.table_name)
+    end
+
+    def quoted_column
+      @scope.connection.quote_column_name(@column)
+    end
+
+    def quoted_scope_column
+      "#{quoted_scope_table}.#{quoted_column}"
+    end
+
+    def sanitize_sql_like(string, escape_character = "\\")
+      pattern = Regexp.union(escape_character, '%', '_')
+      string.gsub(pattern) { |x| [escape_character, x].join }
+    end
+  end
+end

data/lib/db_text_search/version.rb

@@ -0,0 +1,3 @@
+module DbTextSearch
+  VERSION = '0.1.1'
+end

data/lib/db_text_search.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+require 'active_support/core_ext/hash/keys'
+
+require 'db_text_search/version'
+require 'db_text_search/case_insensitive_eq'
+require 'db_text_search/full_text_search'
+
+module DbTextSearch
+end

data/shared.gemfile

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

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: db_text_search
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Gleb Mazovetskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+    requirements:
+    - - ">="
+      - !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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.20
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.20
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+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.
+  * Basic full-text search for a list of terms, and FTS index creation.
+email:
+- glex.spb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGES.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- db_text_search.gemspec
+- lib/db_text_search.rb
+- lib/db_text_search/case_insensitive_eq.rb
+- lib/db_text_search/case_insensitive_eq/abstract_adapter.rb
+- lib/db_text_search/case_insensitive_eq/collate_nocase_adapter.rb
+- lib/db_text_search/case_insensitive_eq/insensitive_column_adapter.rb
+- lib/db_text_search/case_insensitive_eq/lower_adapter.rb
+- lib/db_text_search/full_text_search.rb
+- lib/db_text_search/full_text_search/abstract_adapter.rb
+- lib/db_text_search/full_text_search/mysql_adapter.rb
+- lib/db_text_search/full_text_search/postgres_adapter.rb
+- lib/db_text_search/full_text_search/sqlite_adapter.rb
+- lib/db_text_search/query_building.rb
+- lib/db_text_search/version.rb
+- shared.gemfile
+homepage: https://github.com/thredded/db_text_search
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A unified interface on top of ActiveRecord for SQLite, MySQL, and PostgreSQL
+  for case-insensitive string search and basic full-text search.
+test_files: []