searchable-by 0.5.7 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2137729d80e65107cadf27ede26a60887b6888c41f6940caea9828e3416f137f
-  data.tar.gz: 6edd61ef3f32e0fa6e882b07f5d24004a5c7a4cd5ec2f9c99ba2e6e12332f5e2
+  metadata.gz: 472133b9b419e573a1c87b721a5c368b3915ef28cb94e897424f55f7191f723f
+  data.tar.gz: d3c31e307f54b0545171e7e12b86d75d32f5874676af467399fdb2e533927c16
 SHA512:
-  metadata.gz: 704a8beb8c791dc20e6d156f73a3c3b21f6aed0df0d94d0cc7dda78440d9051f4a9f9a3d076fa3afa5af54a4312e9251335d2ab2911c228506c23d877ef67789
-  data.tar.gz: '0906f2424988065b3d22a177ab260d42029ad3e531a8b5e051fc7170d87e87784fa18225eba4f6631416af7a0c9a3df5c1b3e464babdb8d56ace5f226b18ee39'
+  metadata.gz: 1bd8dc39da51b94327d7912661cda9e2d38cdbf7d6e62eea1930e5d39a85c3bfd81c468477e8cfac48451b7dde055b9075a03686787c481c1cf2fcc5fa9d9c5f
+  data.tar.gz: e9881b0f0022a0f884d6780afb3f24daf53872a473e22571f1eed730c8c76083148dbec4e99825875a68bb425568776c04fb7ac5d7ad26b1aa9202be3160d357

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,13 +1,12 @@
-require:
-  - rubocop-performance
-  - rubocop-rake
-  - rubocop-rspec
-
-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,37 +1,36 @@
 PATH
   remote: .
   specs:
-    searchable-by (0.5.7)
+    searchable-by (0.6.1)
       activerecord
-      activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (6.1.1)
-      activesupport (= 6.1.1)
-    activerecord (6.1.1)
-      activemodel (= 6.1.1)
-      activesupport (= 6.1.1)
-    activesupport (6.1.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 (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    ast (2.4.1)
-    concurrent-ruby (1.1.7)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    i18n (1.8.7)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.3)
+    minitest (5.14.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
+    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)
@@ -41,27 +40,32 @@ GEM
     rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    rubocop (1.8.1)
+    rspec-support (3.10.2)
+    rubocop (1.18.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.0)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.9.2)
-      rubocop (>= 0.90.0, < 2.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.5.1)
-      rubocop
-    rubocop-rspec (2.1.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)
@@ -79,11 +83,9 @@ DEPENDENCIES
   rake
   rspec
   rubocop
-  rubocop-performance
-  rubocop-rake
-  rubocop-rspec
+  rubocop-bsm
   searchable-by!
   sqlite3
 
 BUNDLED WITH
-   2.1.4
+   2.2.21

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,11 +15,12 @@ class Post < ActiveRecord::Base
   belongs_to :author
 
   # Limit the number of terms per query to 3.
-  searchable_by max_terms: 3 do
+  # 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.
-    # Use btree index-friendly prefix match, e.g. `ILIKE 'term%'` instead of default `ILIKE '%term%'`.
-    # For phrases use exact match type, e.g. searching for `"My Post"` will query `WHERE LOWER(title) = 'my post'`.
-    column :title, match: :prefix, match_phrase: :exact
+    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/column.rb

@@ -1,13 +1,22 @@
 module SearchableBy
   class Column
-    attr_reader :attr, :type, :match, :match_phrase
+    attr_reader :attr, :type, :match, :match_phrase, :wildcard
     attr_accessor :node
 
-    def initialize(attr, type: :string, match: :all, match_phrase: nil)
+    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)
@@ -23,6 +32,11 @@ module SearchableBy
 
     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
@@ -37,15 +51,22 @@ module SearchableBy
       when :exact
         term.downcase!
         scope.and(node.lower.eq(term))
+      when :full
+        escape_term!(term)
+        scope.and(node.matches(term))
       when :prefix
-        term.gsub!('%', '\%')
-        term.gsub!('_', '\_')
+        escape_term!(term)
         scope.and(node.matches("#{term}%"))
-      else
-        term.gsub!('%', '\%')
-        term.gsub!('_', '\_')
+      else # :all (wraps term in wildcards)
+        escape_term!(term)
         scope.and(node.matches("%#{term}%"))
       end
     end
+
+    def escape_term!(term)
+      term.gsub!('%', '\%')
+      term.gsub!('_', '\_')
+      term.gsub!(wildcard, '%') if wildcard
+    end
   end
 end

data/lib/searchable_by/concern.rb

@@ -11,9 +11,10 @@ module SearchableBy
       super
     end
 
-    def searchable_by(max_terms: nil, **options, &block)
+    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
@@ -21,10 +22,11 @@ module SearchableBy
     # @param [String] query the search query
     # @return [ActiveRecord::Relation] the scoped relation
     def search_by(query)
-      columns = _searchable_by_config.columns
+      config  = _searchable_by_config
+      columns = config.columns
       return all if columns.empty?
 
-      values = Util.norm_values(query).first(_searchable_by_config.max_terms)
+      values = Util.norm_values(query, min_length: config.min_length).first(config.max_terms)
       return all if values.empty?
 
       columns.each do |col|
@@ -33,7 +35,7 @@ module SearchableBy
       clauses = Util.build_clauses(columns, values)
       return all if clauses.empty?
 
-      scope = instance_exec(&_searchable_by_config.scoping)
+      scope = instance_exec(&config.scoping)
       clauses.each do |clause|
         scope = scope.where(clause)
       end

data/lib/searchable_by/config.rb

@@ -1,11 +1,12 @@
 module SearchableBy
   class Config
     attr_reader :columns, :scoping, :options
-    attr_accessor :max_terms
+    attr_accessor :max_terms, :min_length
 
     def initialize
       @columns = []
       @max_terms = 5
+      @min_length = 0
       @options = {}
       scope { all }
     end

data/lib/searchable_by/util.rb

@@ -1,6 +1,6 @@
 module SearchableBy
   module Util
-    def self.norm_values(query)
+    def self.norm_values(query, min_length: 0)
       values = []
       query  = query.to_s.dup
 
@@ -10,7 +10,7 @@ module SearchableBy
         term = Regexp.last_match(2)
         negate = Regexp.last_match(1) == '-'
 
-        values.push Value.new(term, negate, true) unless term.blank?
+        values.push Value.new(term, negate, true) unless term.blank? || term.length < min_length
         ''
       end
 
@@ -20,7 +20,7 @@ module SearchableBy
         negate = term[0] == '-'
         term.slice!(0) if negate || term[0] == '+'
 
-        values.push Value.new(term, negate, false) unless term.blank?
+        values.push Value.new(term, negate, false) unless term.blank? || term.length < min_length
       end
 
       values.uniq!
@@ -28,19 +28,22 @@ module SearchableBy
     end
 
     def self.build_clauses(columns, values)
-      clauses = values.map do |value|
-        grouping = columns.map do |column|
-          column.build_condition(value)
+      values.map do |value|
+        # TODO: remove when removing min_length option from columns
+        usable = columns.all? do |column|
+          column.send(:usable?, value)
         end
-        grouping.compact!
-        next if grouping.empty?
+        next unless usable
+
+        group = columns.map do |column|
+          column.build_condition(value)
+        end.tap(&:compact!)
+        next if group.empty?
 
-        clause = grouping.inject(&:or)
+        clause = group.inject(&:or)
         clause = clause.not if value.negate
         clause
-      end
-      clauses.compact!
-      clauses
+      end.tap(&:compact!)
     end
   end
 end

data/searchable-by.gemspec

@@ -1,27 +1,23 @@
 Gem::Specification.new do |s|
   s.name        = 'searchable-by'
-  s.version     = '0.5.7'
+  s.version     = '0.6.1'
   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-rake'
-  s.add_development_dependency 'rubocop-rspec'
+  s.add_development_dependency 'rubocop-bsm'
   s.add_development_dependency 'sqlite3'
 end

data/spec/searchable_by/util_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe SearchableBy::Util do
   context 'with norm_values' do
-    def norm(str)
-      described_class.norm_values(str).each_with_object({}) do |val, acc|
+    def norm(str, **opts)
+      described_class.norm_values(str, **opts).each_with_object({}) do |val, acc|
         acc[val.term] = val.negate
       end
     end
@@ -30,6 +30,7 @@ describe SearchableBy::Util do
       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

@@ -8,7 +8,7 @@ describe SearchableBy 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)
+    expect(Post._searchable_by_config.columns.size).to eq(6)
   end
 
   it 'generates SQL' do
@@ -22,6 +22,14 @@ describe SearchableBy do
     expect(sql).not_to include(%("posts"."id"))
     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'))
+    expect(sql).to include(%("users"."bio" LIKE '%uni*dom%'))
+
+    sql = User.search_by('"uni * dom"').to_sql
+    expect(sql).to include(%("users"."country" LIKE 'uni % dom'))
+    expect(sql).to include(%("users"."bio" LIKE '%uni * dom%'))
   end
 
   it 'searches' do
@@ -57,10 +65,25 @@ describe SearchableBy do
     expect(Post.search_by('"ab"').pluck(:title)).to be_empty
     expect(Post.search_by('"ab1"').pluck(:title)).to match_array(%w[ab1])
 
+    # country uses match: :full in combination with wildcard: '*'
+    expect(Post.search_by('*kingdom').pluck(:title)).to match_array(%w[ax1 ax2 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 '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
@@ -69,4 +92,10 @@ describe SearchableBy do
   it 'searches integers' do
     expect(Post.search_by(POSTS[:ab1].id.to_s).count).to eq(1)
   end
+
+  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: '*', match: :full
+  end
 end
 
 class Post < AbstractModel
@@ -37,6 +44,7 @@ class Post < AbstractModel
     column :title, match: :prefix, match_phrase: :exact
     column :body
     column proc { User.arel_table[:name] }, match: :exact
+    column proc { User.arel_table[:country] }, wildcard: '*', match: :full
     column { User.arel_table.alias('reviewers_posts')[:name] }
 
     scope do
@@ -46,8 +54,8 @@ 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 = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchable-by
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.6.1
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-07-30 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,35 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop-bsm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -157,9 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -177,7 +135,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/bsm/sortable-by
 licenses:
-- MIT
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -187,14 +145,14 @@ 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.4
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Generate search scopes

data/.travis.yml

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