searchable-by 0.5.7 → 0.5.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2137729d80e65107cadf27ede26a60887b6888c41f6940caea9828e3416f137f
-  data.tar.gz: 6edd61ef3f32e0fa6e882b07f5d24004a5c7a4cd5ec2f9c99ba2e6e12332f5e2
+  metadata.gz: 9577dc443c9400afd9bb866e8a53a351cf1e56420ce28b140c184e6647689411
+  data.tar.gz: 6a84939c7bb80af91d31b6d6bb3fd65acd672a4b41fbc25dbe08664e74d1f58d
 SHA512:
-  metadata.gz: 704a8beb8c791dc20e6d156f73a3c3b21f6aed0df0d94d0cc7dda78440d9051f4a9f9a3d076fa3afa5af54a4312e9251335d2ab2911c228506c23d877ef67789
-  data.tar.gz: '0906f2424988065b3d22a177ab260d42029ad3e531a8b5e051fc7170d87e87784fa18225eba4f6631416af7a0c9a3df5c1b3e464babdb8d56ace5f226b18ee39'
+  metadata.gz: 86367f8084de15d5d8e11568c1dadd5beddb090bf4dc4c334133197e15906e0bced5396a5c95f9434e6902d2ae0752698590f1b2fc1eacba26cb49a66a3e5697
+  data.tar.gz: ac9f4157b9a1705b50c95c9e1e3ee4f9c19b5ea7be9fec12a5a42df53eb0a2761a0c90c902dce641f15628ac48f2b3be4e1b504cfb36bebd6db00620dda4d787

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/.travis.yml

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    searchable-by (0.5.7)
+    searchable-by (0.5.8)
       activerecord
       activesupport
 
@@ -19,15 +19,16 @@ GEM
       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.8)
     diff-lcs (1.4.4)
-    i18n (1.8.7)
+    i18n (1.8.8)
       concurrent-ruby (~> 1.0)
     minitest (5.14.3)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.0.3)
@@ -41,11 +42,11 @@ 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.9.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -54,14 +55,24 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
+    rubocop-bsm (0.5.4)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rails
+      rubocop-rake
+      rubocop-rspec
     rubocop-performance (1.9.2)
       rubocop (>= 0.90.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.1.0)
+    rubocop-rspec (2.2.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
@@ -79,11 +90,9 @@ DEPENDENCIES
   rake
   rspec
   rubocop
-  rubocop-performance
-  rubocop-rake
-  rubocop-rspec
+  rubocop-bsm
   searchable-by!
   sqlite3
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/README.md

@@ -15,9 +15,10 @@ class Post < ActiveRecord::Base
   # Limit the number of terms per query to 3.
   searchable_by max_terms: 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'`.
+      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,16 +1,19 @@
 module SearchableBy
   class Column
-    attr_reader :attr, :type, :match, :match_phrase
+    attr_reader :attr, :type, :match, :match_phrase, :min_length
     attr_accessor :node
 
-    def initialize(attr, type: :string, match: :all, match_phrase: nil)
+    def initialize(attr, type: :string, match: :all, match_phrase: nil, min_length: 0)
       @attr  = attr
       @type  = type.to_sym
       @match = match
       @match_phrase = match_phrase || match
+      @min_length = min_length
     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

data/searchable-by.gemspec

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

@@ -61,6 +61,11 @@ 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]])
+  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

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ ActiveRecord::Base.establish_connection :test
 ActiveRecord::Base.connection.instance_eval do
   create_table :users do |t|
     t.string  :name
+    t.string  :bio
   end
   create_table :posts do |t|
     t.integer :author_id, null: false
@@ -27,6 +28,10 @@ end
 
 class User < AbstractModel
   has_many :posts, foreign_key: :author_id
+
+  searchable_by do
+    column :bio, min_length: 3
+  end
 end
 
 class Post < AbstractModel
@@ -46,8 +51,8 @@ class Post < AbstractModel
 end
 
 USERS = {
-  a: User.create!(name: 'Alice'),
-  b: User.create!(name: 'Bob'),
+  a: User.create!(name: 'Alice', bio: 'First user'),
+  b: User.create!(name: 'Bob', bio: 'Second user'),
 }.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.5.8
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-13 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -95,35 +95,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:
     - - ">="
@@ -187,7 +159,7 @@ 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:
   - - ">="