searchable-by 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b2c3092a9a334ae2ea2256953e9a1fa3198d6b6aa8d8f5fe7eb841920782dce
-  data.tar.gz: 6e6ba3ee470d96063a91e24c3fdcbe2be411a13a567828b57c39d74dc1a8133a
+  metadata.gz: 615602791390c9de0ab159cbbd0c81c52c0441f61ad559082dad189787c7606f
+  data.tar.gz: ad765f8a22cd76196f7a04b7a7e16f38b3bbccacda0f1c7bda659e3ab2783f4f
 SHA512:
-  metadata.gz: 52a694bb37c67c2f4a8905e41d0affa729f1ddf0a595428278af25f8d97e986fe6bb5aa8cb462932dee1258032f4f3adb8b2f4f1c804f3c049482b7ef64493b0
-  data.tar.gz: ea1c883f1f9636c0baf7575918bf89330b22503efc132a65084a49a6e9ff63c96313efcc69259d4e26175b8f75744a65b8f6c39bfb130a9e4532a189aa19ed3f
+  metadata.gz: ae524aa23d507f4339592c4c6a2955d3d0664e7f9829be7071ed1d28a065e1ad77ff9a810a800769cf417db4d315344a487b058530e168325403cb26a1832e12
+  data.tar.gz: 71a1349d3738997571306d5326cf81bef66b101bbd03b9451d3b3d9b5851c35f1d732486d96b29d73e1efce792a0c5c840c42442a2f83bd5be171a47be28a17c

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  ruby:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.6", "2.7", "3.0"]
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.rubocop.yml

@@ -1,9 +1,12 @@
-require: rubocop-performance
-inherit_from:
-  - https://gitlab.com/bsm/misc/raw/master/rubocop/default.yml
+inherit_gem:
+  rubocop-bsm:
+    - default.yml
+inherit_mode:
+  merge:
+    - Exclude
 
 AllCops:
-  TargetRubyVersion: "2.5"
+  TargetRubyVersion: "2.6"
 
 Naming/FileName:
   Exclude:

data/Gemfile.lock

@@ -1,68 +1,79 @@
 PATH
   remote: .
   specs:
-    searchable-by (0.5.5)
+    searchable-by (0.6.0)
       activerecord
-      activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activerecord (6.0.3.1)
-      activemodel (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activesupport (6.0.3.1)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.0)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    i18n (1.8.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
+    minitest (5.14.4)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.84.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.3)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    rubocop-performance (1.6.0)
-      rubocop (>= 0.71.0)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-bsm (0.6.0)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rake
+      rubocop-rspec
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
     sqlite3 (1.4.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -72,9 +83,9 @@ DEPENDENCIES
   rake
   rspec
   rubocop
-  rubocop-performance
+  rubocop-bsm
   searchable-by!
   sqlite3
 
 BUNDLED WITH
-   2.1.2
+   2.2.21

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019 Black Square Media Ltd
+Copyright 2020 Black Square Media Ltd
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,5 +1,7 @@
 # Searchable By
 
+[![Test](https://github.com/bsm/searchable-by/actions/workflows/test.yml/badge.svg)](https://github.com/bsm/searchable-by/actions/workflows/test.yml)
+
 ActiveRecord plugin to quickly create search scopes.
 
 ## Installation
@@ -13,9 +15,12 @@ class Post < ActiveRecord::Base
   belongs_to :author
 
   # Limit the number of terms per query to 3.
-  searchable_by max_terms: 3 do
-    # Allow to search strings.
-    column :title
+  # Ignore search terms shorter than 3 characters (useful for trigram indexes).
+  searchable_by max_terms: 3, min_length: 3 do
+    # Allow to search strings with custom match type.
+    column :title,
+      match: :prefix,       # Use btree index-friendly prefix match, e.g. `ILIKE 'term%'` instead of default `ILIKE '%term%'`.
+      match_phrase: :exact, # For phrases use exact match type, e.g. searching for `"My Post"` will query `WHERE LOWER(title) = 'my post'`.
 
     # ... and integers.
     column :id, type: :integer

data/lib/searchable_by.rb

@@ -1,149 +1,12 @@
 require 'active_record'
 
-module ActiveRecord
-  module SearchableBy
-    class Column
-      attr_reader :attr, :type
-      attr_accessor :node
+module SearchableBy
+  autoload :Column, 'searchable_by/column'
+  autoload :Concern, 'searchable_by/concern'
+  autoload :Config, 'searchable_by/config'
+  autoload :Util, 'searchable_by/util'
 
-      def initialize(attr, type: :string)
-        @attr = attr
-        @type = type.to_sym
-      end
-    end
-
-    class Config
-      attr_reader :columns, :scoping
-      attr_accessor :max_terms
-
-      def initialize
-        @columns = []
-        @max_terms = 5
-        scope { all }
-      end
-
-      def initialize_copy(other)
-        @columns = other.columns.dup
-        super
-      end
-
-      def column(*attrs, &block)
-        opts = attrs.extract_options!
-        attrs.each do |attr|
-          columns.push Column.new(attr, **opts)
-        end
-        columns.push Column.new(block, **opts) if block
-        columns
-      end
-
-      def scope(&block)
-        @scoping = block
-      end
-    end
-
-    Value = Struct.new(:term, :negate)
-
-    def self.norm_values(query)
-      values = []
-      query  = query.to_s.dup
-
-      # capture any terms inside double quotes
-      # exclude from seach if preceded by '-'
-      query.gsub!(/([\-\+]?)"+([^"]*)"+/) do |_|
-        term = Regexp.last_match(2)
-        negate = Regexp.last_match(1) == '-'
-
-        values.push Value.new(term, negate) unless term.blank?
-        ''
-      end
-
-      # for the remaining terms remove sign if precedes
-      # exclude term from search if sign preceding is '-'
-      query.split(' ').each do |term|
-        negate = term[0] == '-'
-        term.slice!(0) if negate || term[0] == '+'
-
-        values.push Value.new(term, negate) unless term.blank?
-      end
-
-      values.uniq!
-      values
-    end
-
-    def self.build_clauses(columns, values)
-      clauses = values.map do |value|
-        grouping = columns.map do |column|
-          build_condition(column, value)
-        end
-        grouping.compact!
-        next if grouping.empty?
-
-        clause = grouping.inject(&:or)
-        clause = clause.not if value.negate
-        clause
-      end
-      clauses.compact!
-      clauses
-    end
-
-    def self.build_condition(column, value)
-      case column.type
-      when :int, :integer
-        begin
-          column.node.not_eq(nil).and(column.node.eq(Integer(value.term)))
-        rescue ArgumentError
-          nil
-        end
-      else
-        term = value.term.dup
-        term.gsub!('%', '\%')
-        term.gsub!('_', '\_')
-        column.node.not_eq(nil).and(column.node.matches("%#{term}%"))
-      end
-    end
-
-    module ClassMethods
-      def self.extended(base) # :nodoc:
-        base.class_attribute :_searchable_by_config, instance_accessor: false, instance_predicate: false
-        base._searchable_by_config = Config.new
-        super
-      end
-
-      def inherited(base) # :nodoc:
-        base._searchable_by_config = _searchable_by_config.dup
-        super
-      end
-
-      def searchable_by(max_terms: 5, &block)
-        _searchable_by_config.instance_eval(&block)
-        _searchable_by_config.max_terms = max_terms if max_terms
-      end
-
-      # @param [String] query the search query
-      # @return [ActiveRecord::Relation] the scoped relation
-      def search_by(query)
-        columns = _searchable_by_config.columns
-        return all if columns.empty?
-
-        values = SearchableBy.norm_values(query).first(_searchable_by_config.max_terms)
-        return all if values.empty?
-
-        columns.each do |col|
-          col.node ||= col.attr.is_a?(Proc) ? col.attr.call : arel_table[col.attr]
-        end
-        clauses = SearchableBy.build_clauses(columns, values)
-        return all if clauses.empty?
-
-        scope = instance_exec(&_searchable_by_config.scoping)
-        clauses.each do |clause|
-          scope = scope.where(clause)
-        end
-        scope
-      end
-    end
-  end
-
-  class Base
-    extend SearchableBy::ClassMethods
-  end
+  Value = Struct.new(:term, :negate, :phrase)
 end
+
+ActiveRecord::Base.extend SearchableBy::Concern if defined?(::ActiveRecord::Base)

data/lib/searchable_by/column.rb

@@ -0,0 +1,66 @@
+module SearchableBy
+  class Column
+    attr_reader :attr, :type, :match, :match_phrase, :wildcard
+    attr_accessor :node
+
+    def initialize(attr, type: :string, match: :all, match_phrase: nil, wildcard: nil, **opts) # rubocop:disable Metrics/ParameterLists
+      if opts.key?(:min_length)
+        ActiveSupport::Deprecation.warn(
+          'Setting min_length for individual columns is deprecated and will be removed in the next release.' \
+          'Please pass it as an option to searchable_by instead',
+        )
+      end
+
+      @attr  = attr
+      @type  = type.to_sym
+      @match = match
+      @match_phrase = match_phrase || match
+      @min_length = opts[:min_length].to_i
+      @wildcard = wildcard
+    end
+
+    def build_condition(value)
+      scope = node.not_eq(nil)
+
+      case type
+      when :int, :integer
+        int_condition(scope, value)
+      else
+        str_condition(scope, value)
+      end
+    end
+
+    private
+
+    # TODO: remove when removing min_length option from columns
+    def usable?(value)
+      value.term.length >= @min_length
+    end
+
+    def int_condition(scope, value)
+      scope.and(node.eq(Integer(value.term)))
+    rescue ArgumentError
+      nil
+    end
+
+    def str_condition(scope, value)
+      term = value.term.dup
+      type = value.phrase ? match_phrase : match
+
+      case type
+      when :exact
+        term.downcase!
+        scope.and(node.lower.eq(term))
+      when :prefix
+        term.gsub!('%', '\%')
+        term.gsub!('_', '\_')
+        scope.and(node.matches("#{term}%"))
+      else
+        term.gsub!('%', '\%')
+        term.gsub!('_', '\_')
+        term.gsub!(wildcard, '%') if wildcard
+        scope.and(node.matches("%#{term}%"))
+      end
+    end
+  end
+end

data/lib/searchable_by/concern.rb

@@ -0,0 +1,45 @@
+module SearchableBy
+  module Concern
+    def self.extended(base) # :nodoc:
+      base.class_attribute :_searchable_by_config, instance_accessor: false, instance_predicate: false
+      base._searchable_by_config = Config.new
+      super
+    end
+
+    def inherited(base) # :nodoc:
+      base._searchable_by_config = _searchable_by_config.dup
+      super
+    end
+
+    def searchable_by(max_terms: nil, min_length: 0, **options, &block)
+      _searchable_by_config.instance_eval(&block)
+      _searchable_by_config.max_terms = max_terms if max_terms
+      _searchable_by_config.min_length = min_length
+      _searchable_by_config.options.update(options) unless options.empty?
+      _searchable_by_config
+    end
+
+    # @param [String] query the search query
+    # @return [ActiveRecord::Relation] the scoped relation
+    def search_by(query)
+      config  = _searchable_by_config
+      columns = config.columns
+      return all if columns.empty?
+
+      values = Util.norm_values(query, min_length: config.min_length).first(config.max_terms)
+      return all if values.empty?
+
+      columns.each do |col|
+        col.node ||= col.attr.is_a?(Proc) ? col.attr.call : arel_table[col.attr]
+      end
+      clauses = Util.build_clauses(columns, values)
+      return all if clauses.empty?
+
+      scope = instance_exec(&config.scoping)
+      clauses.each do |clause|
+        scope = scope.where(clause)
+      end
+      scope
+    end
+  end
+end

data/lib/searchable_by/config.rb

@@ -0,0 +1,32 @@
+module SearchableBy
+  class Config
+    attr_reader :columns, :scoping, :options
+    attr_accessor :max_terms, :min_length
+
+    def initialize
+      @columns = []
+      @max_terms = 5
+      @min_length = 0
+      @options = {}
+      scope { all }
+    end
+
+    def initialize_copy(other)
+      @columns = other.columns.dup
+      super
+    end
+
+    def column(*attrs, &block)
+      opts = attrs.extract_options!
+      attrs.each do |attr|
+        columns.push Column.new(attr, **@options, **opts)
+      end
+      columns.push Column.new(block, **@options, **opts) if block
+      columns
+    end
+
+    def scope(&block)
+      @scoping = block
+    end
+  end
+end

data/lib/searchable_by/util.rb

@@ -0,0 +1,49 @@
+module SearchableBy
+  module Util
+    def self.norm_values(query, min_length: 0)
+      values = []
+      query  = query.to_s.dup
+
+      # capture any phrases inside double quotes
+      # exclude from search if preceded by '-'
+      query.gsub!(/([\-+]?)"+([^"]*)"+/) do |_|
+        term = Regexp.last_match(2)
+        negate = Regexp.last_match(1) == '-'
+
+        values.push Value.new(term, negate, true) unless term.blank? || term.length < min_length
+        ''
+      end
+
+      # for the remaining terms remove sign if precedes
+      # exclude term from search if sign preceding is '-'
+      query.split.each do |term|
+        negate = term[0] == '-'
+        term.slice!(0) if negate || term[0] == '+'
+
+        values.push Value.new(term, negate, false) unless term.blank? || term.length < min_length
+      end
+
+      values.uniq!
+      values
+    end
+
+    def self.build_clauses(columns, values)
+      values.map do |value|
+        # TODO: remove when removing min_length option from columns
+        usable = columns.all? do |column|
+          column.send(:usable?, value)
+        end
+        next unless usable
+
+        group = columns.map do |column|
+          column.build_condition(value)
+        end.tap(&:compact!)
+        next if group.empty?
+
+        clause = group.inject(&:or)
+        clause = clause.not if value.negate
+        clause
+      end.tap(&:compact!)
+    end
+  end
+end

data/searchable-by.gemspec

@@ -1,25 +1,23 @@
 Gem::Specification.new do |s|
   s.name        = 'searchable-by'
-  s.version     = '0.5.5'
+  s.version     = '0.6.0'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Generate search scopes'
   s.description = 'ActiveRecord plugin'
   s.homepage    = 'https://github.com/bsm/sortable-by'
-  s.license     = 'MIT'
+  s.license     = 'Apache-2.0'
 
   s.files         = `git ls-files -z`.split("\x0").reject {|f| f.start_with?('spec/') }
   s.test_files    = `git ls-files -z -- spec/*`.split("\x0")
   s.require_paths = ['lib']
-  s.required_ruby_version = '>= 2.5'
+  s.required_ruby_version = '>= 2.6'
 
   s.add_dependency 'activerecord'
-  s.add_dependency 'activesupport'
-
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'rubocop-performance'
+  s.add_development_dependency 'rubocop-bsm'
   s.add_development_dependency 'sqlite3'
 end

data/spec/searchable_by/util_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe SearchableBy::Util do
+  context 'with norm_values' do
+    def norm(str, **opts)
+      described_class.norm_values(str, **opts).each_with_object({}) do |val, acc|
+        acc[val.term] = val.negate
+      end
+    end
+
+    it 'tokenises strings' do
+      expect(norm(nil)).to eq({})
+      expect(norm('""')).to eq({})
+      expect(norm('-+""')).to eq({})
+      expect(norm('simple words')).to eq('simple' => false, 'words' => false)
+      expect(norm(" with   \t spaces\n")).to eq('with' => false, 'spaces' => false)
+      expect(norm('with with duplicates with')).to eq('with' => false, 'duplicates' => false)
+      expect(norm('with "full term"')).to eq('full term' => false, 'with' => false)
+      expect(norm('"""odd double quotes around"""')).to eq('odd double quotes around' => false)
+      expect(norm('""even double quotes around""')).to eq('even double quotes around' => false)
+      expect(norm('with\'apostrophe')).to eq("with'apostrophe" => false)
+      expect(norm('with -minus')).to eq('minus' => true, 'with' => false)
+      expect(norm('with +plus')).to eq('plus' => false, 'with' => false)
+      expect(norm('with-minus')).to eq('with-minus' => false)
+      expect(norm('with+plus')).to eq('with+plus' => false)
+      expect(norm('with -"minus before"')).to eq('minus before' => true, 'with' => false)
+      expect(norm('with "-minus within"')).to eq('-minus within' => false, 'with' => false)
+      expect(norm('with +"plus before"')).to eq('plus before' => false, 'with' => false)
+      expect(norm('with "+plus within"')).to eq('+plus within' => false, 'with' => false)
+      expect(norm('+plus "in other term"')).to eq('in other term' => false, 'plus' => false)
+      expect(norm('with_blank \'\'')).to eq('with_blank' => false, '\'\'' => false)
+      expect(norm('with_blank_doubles ""')).to eq('with_blank_doubles' => false)
+      expect(norm('with min length', min_length: 4)).to eq('length' => false, 'with' => false)
+    end
+  end
+end

data/spec/searchable_by_spec.rb

@@ -1,80 +1,96 @@
 require 'spec_helper'
 
-describe ActiveRecord::SearchableBy do
-  context 'norm_values' do
-    def norm(str)
-      described_class.norm_values(str).each_with_object({}) do |val, acc|
-        acc[val.term] = val.negate
-      end
-    end
-
-    it 'should tokenise strings' do
-      expect(norm(nil)).to eq({})
-      expect(norm('""')).to eq({})
-      expect(norm('-+""')).to eq({})
-      expect(norm('simple words')).to eq('simple' => false, 'words' => false)
-      expect(norm(" with   \t spaces\n")).to eq('with' => false, 'spaces' => false)
-      expect(norm('with with duplicates with')).to eq('with' => false, 'duplicates' => false)
-      expect(norm('with "full term"')).to eq('full term' => false, 'with' => false)
-      expect(norm('"""odd double quotes around"""')).to eq('odd double quotes around' => false)
-      expect(norm('""even double quotes around""')).to eq('even double quotes around'=> false)
-      expect(norm('with\'apostrophe')).to eq("with'apostrophe" => false)
-      expect(norm('with -minus')).to eq('minus' => true, 'with' => false)
-      expect(norm('with +plus')).to eq('plus' => false, 'with' => false)
-      expect(norm('with-minus')).to eq('with-minus' => false)
-      expect(norm('with+plus')).to eq('with+plus' => false)
-      expect(norm('with -"minus before"')).to eq('minus before' => true, 'with' => false)
-      expect(norm('with "-minus within"')).to eq('-minus within' => false, 'with' => false)
-      expect(norm('with +"plus before"')).to eq('plus before' => false, 'with' => false)
-      expect(norm('with "+plus within"')).to eq('+plus within' => false, 'with' => false)
-      expect(norm('+plus "in other term"')).to eq('in other term' => false, 'plus' => false)
-      expect(norm('with_blank \'\'')).to eq('with_blank' => false, '\'\'' => false)
-      expect(norm('with_blank_doubles ""')).to eq('with_blank_doubles' => false)
-    end
-  end
-
-  it 'should ignore bad inputs' do
+describe SearchableBy do
+  it 'ignores bad inputs' do
     expect(Post.search_by(nil).count).to eq(5)
     expect(Post.search_by('').count).to eq(5)
   end
 
-  it 'should configure correctly' do
+  it 'configures correctly' do
     expect(AbstractModel._searchable_by_config.columns.size).to eq(1)
     expect(Post._searchable_by_config.columns.size).to eq(5)
   end
 
-  it 'should generate SQL' do
+  it 'generates SQL' do
     sql = Post.search_by('123').to_sql
-    expect(sql).to include(%("posts"."id" = 123))
-    expect(sql).to include(%("posts"."title" LIKE '%123%'))
+    expect(sql).to include(%("posts"."id" IS NOT NULL AND "posts"."id" = 123))
+    expect(sql).to include(%("posts"."title" IS NOT NULL AND "posts"."title" LIKE '123%'))
+    expect(sql).to include(%("posts"."body" IS NOT NULL AND "posts"."body" LIKE '%123%'))
+    expect(sql).to include(%("users"."name" IS NOT NULL AND LOWER("users"."name") = '123'))
 
     sql = Post.search_by('foo%bar').to_sql
     expect(sql).not_to include(%("posts"."id"))
-    expect(sql).to include(%("posts"."title" LIKE '%foo\\%bar%'))
+    expect(sql).to include(%("posts"."title" LIKE 'foo\\%bar%'))
+    expect(sql).to include(%("posts"."body" LIKE '%foo\\%bar%'))
+
+    sql = User.search_by('uni*dom').to_sql
+    expect(sql).to include(%("users"."country" LIKE '%uni%dom%'))
+
+    sql = User.search_by('"uni * dom"').to_sql
+    expect(sql).to include(%("users"."country" LIKE '%uni % dom%'))
+  end
+
+  it 'searches' do
+    expect(Post.search_by('ALICE').pluck(:title)).to match_array(%w[ax1 ax2 ab1])
+    expect(Post.search_by('bOb').pluck(:title)).to match_array(%w[bx1 bx2 ab1])
+  end
+
+  it 'searches across multiple words' do
+    expect(Post.search_by('ALICE your').pluck(:title)).to match_array(%w[ax2])
   end
 
-  it 'should search' do
-    expect(Post.search_by('ALICE').pluck(:title)).to match_array(%w[a1 a2 ab])
-    expect(Post.search_by('bOb').pluck(:title)).to match_array(%w[b1 b2 ab])
+  it 'supports search markers' do
+    expect(Post.search_by('aLiCe -your').pluck(:title)).to match_array(%w[ax1 ab1])
+    expect(Post.search_by('+alice "your recipe"').pluck(:title)).to match_array(%w[ax2])
+    expect(Post.search_by('bob -"her recipe"').pluck(:title)).to match_array(%w[bx2 ab1])
+    expect(Post.search_by('bob +"her recipe"').pluck(:title)).to match_array(%w[bx1])
   end
 
-  it 'should search across multiple words' do
-    expect(Post.search_by('ALICE your').pluck(:title)).to match_array(%w[a2])
+  it 'respects match options' do
+    # name uses match: :exact
+    expect(Post.search_by('alice').pluck(:title)).to match_array(%w[ax1 ax2 ab1])
+    expect(Post.search_by('ali').pluck(:title)).to be_empty
+    expect(Post.search_by('lice').pluck(:title)).to be_empty
+    expect(Post.search_by('li').pluck(:title)).to be_empty
+
+    # title uses match: :prefix
+    expect(Post.search_by('ax').pluck(:title)).to match_array(%w[ax1 ax2])
+    expect(Post.search_by('bx').pluck(:title)).to match_array(%w[bx1 bx2])
+    expect(Post.search_by('ab').pluck(:title)).to match_array(%w[ab1])
+    expect(Post.search_by('ba').pluck(:title)).to be_empty
+
+    # title uses match_phrase: :exact
+    expect(Post.search_by('"ab"').pluck(:title)).to be_empty
+    expect(Post.search_by('"ab1"').pluck(:title)).to match_array(%w[ab1])
+
+    # body uses match: :all (default)
+    expect(Post.search_by('recip').pluck(:title)).to match_array(%w[ax1 ax2 bx1 bx2 ab1])
+  end
+
+  it 'supports min term length in context' do
+    # values are discarded - too short for bio
+    expect(User.search_by('+be')).to match_array(USERS.values_at(:a, :b))
+    expect(User.search_by('is')).to match_array(USERS.values_at(:a, :b))
+
+    # value is used to scope
+    expect(User.search_by('ear')).to match_array(USERS.values_at(:a))
+
+    # one used, one discarded
+    expect(User.search_by('beard is')).to match_array(USERS.values_at(:a))
   end
 
-  it 'should support search markers' do
-    expect(Post.search_by('aLiCe -your').pluck(:title)).to match_array(%w[a1 ab])
-    expect(Post.search_by('+alice "your recipe"').pluck(:title)).to match_array(%w[a2])
-    expect(Post.search_by('bob -"her recipe"').pluck(:title)).to match_array(%w[b2 ab])
-    expect(Post.search_by('bob +"her recipe"').pluck(:title)).to match_array(%w[b1])
+  it 'searches within scopes' do
+    expect(Post.where(title: 'ax1').search_by('ALICE').pluck(:title)).to match_array(%w[ax1])
+    expect(Post.where(title: 'ax1').search_by('bOb').pluck(:title)).to be_empty
   end
 
-  it 'should search within scopes' do
-    expect(Post.where(title: 'a1').search_by('ALICE').pluck(:title)).to match_array(%w[a1])
-    expect(Post.where(title: 'a1').search_by('bOb').pluck(:title)).to match_array(%w[])
+  it 'searches integers' do
+    expect(Post.search_by(POSTS[:ab1].id.to_s).count).to eq(1)
   end
 
-  it 'should search integers' do
-    expect(Post.search_by(POSTS[:ab].id.to_s).count).to eq(1)
+  it 'supports wildcard searching' do
+    expect(User.search_by('uni*dom')).to match_array(USERS.values_at(:a))
+    expect(User.search_by('uni*o')).to match_array(USERS.values_at(:a, :b))
+    expect(User.search_by('uni*of*dom')).to be_empty
   end
 end

data/spec/spec_helper.rb

@@ -8,6 +8,8 @@ ActiveRecord::Base.establish_connection :test
 ActiveRecord::Base.connection.instance_eval do
   create_table :users do |t|
     t.string  :name
+    t.string  :bio
+    t.string  :country
   end
   create_table :posts do |t|
     t.integer :author_id, null: false
@@ -27,6 +29,11 @@ end
 
 class User < AbstractModel
   has_many :posts, foreign_key: :author_id
+
+  searchable_by min_length: 3 do
+    column :bio
+    column :country, wildcard: '*'
+  end
 end
 
 class Post < AbstractModel
@@ -34,8 +41,9 @@ class Post < AbstractModel
   belongs_to :reviewer, class_name: 'User'
 
   searchable_by do
-    column :title, :body
-    column { User.arel_table[:name] }
+    column :title, match: :prefix, match_phrase: :exact
+    column :body
+    column proc { User.arel_table[:name] }, match: :exact
     column { User.arel_table.alias('reviewers_posts')[:name] }
 
     scope do
@@ -45,14 +53,14 @@ class Post < AbstractModel
 end
 
 USERS = {
-  a: User.create!(name: 'Alice'),
-  b: User.create!(name: 'Bob'),
+  a: User.create!(name: 'Alice', bio: "Chuck Norris' beard is immutable.", country: 'United Kingdom'),
+  b: User.create!(name: 'Bob', bio: 'Chuck Norris can divide by zero.', country: 'United States of America'),
 }.freeze
 
 POSTS = {
-  a1: USERS[:a].posts.create!(title: 'a1', body: 'my recipe '),
-  a2: USERS[:a].posts.create!(title: 'a2', body: 'your recipe'),
-  b1: USERS[:b].posts.create!(title: 'b1', body: 'her recipe'),
-  b2: USERS[:b].posts.create!(title: 'b2', body: 'our recipe'),
-  ab: USERS[:a].posts.create!(title: 'ab', reviewer: USERS[:b], body: 'their recipe'),
+  ax1: USERS[:a].posts.create!(title: 'ax1', body: 'my recipe '),
+  ax2: USERS[:a].posts.create!(title: 'ax2', body: 'your recipe'),
+  bx1: USERS[:b].posts.create!(title: 'bx1', body: 'her recipe'),
+  bx2: USERS[:b].posts.create!(title: 'bx2', body: 'our recipe'),
+  ab1: USERS[:a].posts.create!(title: 'ab1', reviewer: USERS[:b], body: 'their recipe'),
 }.freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchable-by
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-bsm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,9 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -139,12 +125,17 @@ files:
 - Rakefile
 - lib/searchable-by.rb
 - lib/searchable_by.rb
+- lib/searchable_by/column.rb
+- lib/searchable_by/concern.rb
+- lib/searchable_by/config.rb
+- lib/searchable_by/util.rb
 - searchable-by.gemspec
+- spec/searchable_by/util_spec.rb
 - spec/searchable_by_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bsm/sortable-by
 licenses:
-- MIT
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -154,17 +145,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Generate search scopes
 test_files:
+- spec/searchable_by/util_spec.rb
 - spec/searchable_by_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 2.6
-  - 2.5
-cache: bundler
-before_install:
-  - gem install bundler