searchable-by 0.5.9 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b6f1b26859c89dfec031b51501c3f1dd6e8050d27bf7ae00bdb0ef9b8495422
-  data.tar.gz: a24dc8497c85648498fccffd56aaa4f995d7c31b48ab21e970356115a6a1ec50
+  metadata.gz: 615602791390c9de0ab159cbbd0c81c52c0441f61ad559082dad189787c7606f
+  data.tar.gz: ad765f8a22cd76196f7a04b7a7e16f38b3bbccacda0f1c7bda659e3ab2783f4f
 SHA512:
-  metadata.gz: 33f4d29187d4bf9545af72632b1c17742be5ceeb3b699d36dc6e0f251151dabb06877269378d17f72dcb152f4413265866b9e076c537f5f0e1cf3f12689d3492
-  data.tar.gz: 6cba46e2c5ee6bf164490d5f7e2b7c715ae19dcc51d6eafbc3e93283e4d02e887e926eadc821753cf4b25522b5adb4322ac37a89d678beb76c33b7fd79fb193a
+  metadata.gz: ae524aa23d507f4339592c4c6a2955d3d0664e7f9829be7071ed1d28a065e1ad77ff9a810a800769cf417db4d315344a487b058530e168325403cb26a1832e12
+  data.tar.gz: 71a1349d3738997571306d5326cf81bef66b101bbd03b9451d3b3d9b5851c35f1d732486d96b29d73e1efce792a0c5c840c42442a2f83bd5be171a47be28a17c

data/.github/workflows/{ruby.yml → test.yml}

@@ -1,4 +1,4 @@
-name: Ruby
+name: Test
 
 on:
   push:
@@ -7,7 +7,7 @@ on:
     branches: [main]
 
 jobs:
-  test:
+  ruby:
     runs-on: ubuntu-latest
     strategy:
       matrix:

data/Gemfile.lock

@@ -1,38 +1,36 @@
 PATH
   remote: .
   specs:
-    searchable-by (0.5.9)
+    searchable-by (0.6.0)
       activerecord
-      activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activesupport (6.1.3)
+    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.2)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     minitest (5.14.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
-    rack (2.2.3)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -46,33 +44,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.11.0)
+    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.1)
-      parser (>= 2.7.1.5)
-    rubocop-bsm (0.5.4)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    rubocop-bsm (0.6.0)
       rubocop (~> 1.0)
       rubocop-performance
-      rubocop-rails
       rubocop-rake
       rubocop-rspec
-    rubocop-performance (1.10.1)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-performance (1.11.4)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
-      activesupport (>= 4.2.0)
-      rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.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)
@@ -95,4 +88,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.2.5
+   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,12 +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.
     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'`.
-      min_length: 3         # Return no-match if search term is too short (useful for trigram indexes).
 
     # ... and integers.
     column :id, type: :integer

data/lib/searchable_by/column.rb

@@ -1,20 +1,25 @@
 module SearchableBy
   class Column
-    attr_reader :attr, :type, :match, :match_phrase, :min_length, :wildcard
+    attr_reader :attr, :type, :match, :match_phrase, :wildcard
     attr_accessor :node
 
-    def initialize(attr, type: :string, match: :all, match_phrase: nil, min_length: 0, wildcard: nil) # rubocop:disable Metrics/ParameterLists
+    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 = min_length
+      @min_length = opts[:min_length].to_i
       @wildcard = wildcard
     end
 
     def build_condition(value)
-      return Arel::Nodes::False.new if value.term.length < min_length # no-match
-
       scope = node.not_eq(nil)
 
       case type
@@ -27,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

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,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'searchable-by'
-  s.version     = '0.5.9'
+  s.version     = '0.6.0'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Generate search scopes'
@@ -14,8 +14,6 @@ Gem::Specification.new do |s|
   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'

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

@@ -67,9 +67,16 @@ describe SearchableBy do
     expect(Post.search_by('recip').pluck(:title)).to match_array(%w[ax1 ax2 bx1 bx2 ab1])
   end
 
-  it 'supports min term length' do
-    expect(User.search_by('+ir')).to be_empty
-    expect(User.search_by('irs')).to match_array([USERS[:a]])
+  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
@@ -82,8 +89,8 @@ describe SearchableBy do
   end
 
   it 'supports wildcard searching' do
-    expect(User.search_by('uni*dom')).to match_array([USERS[:a]])
-    expect(User.search_by('uni*o')).to match_array([USERS[:a], USERS[:b]])
+    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

@@ -30,8 +30,8 @@ end
 class User < AbstractModel
   has_many :posts, foreign_key: :author_id
 
-  searchable_by do
-    column :bio, min_length: 3
+  searchable_by min_length: 3 do
+    column :bio
     column :country, wildcard: '*'
   end
 end
@@ -53,8 +53,8 @@ class Post < AbstractModel
 end
 
 USERS = {
-  a: User.create!(name: 'Alice', bio: 'First user', country: 'United Kingdom'),
-  b: User.create!(name: 'Bob', bio: 'Second user', country: 'United States of America'),
+  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.9
+  version: 0.6.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-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
@@ -129,7 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ruby.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
@@ -166,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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