searchable-by 0.5.6 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e2f1b8d0d05abf263dc93c1bd81ab818a88eedf135ff10cd5414d54d3ae17a1
-  data.tar.gz: 04d1e040390dcf8c77adbc1bf5bd491505373147798b1c95e4e4cc6c259daab5
+  metadata.gz: 2137729d80e65107cadf27ede26a60887b6888c41f6940caea9828e3416f137f
+  data.tar.gz: 6edd61ef3f32e0fa6e882b07f5d24004a5c7a4cd5ec2f9c99ba2e6e12332f5e2
 SHA512:
-  metadata.gz: e6bcafc69897951760eba1a9fb049664aa3360536525d31e6f5b1d9094ce274cc82c6936aa69e19b8ece975e1f74d42f424646d5a6e4de4bc4c12b29b24a4b33
-  data.tar.gz: a5762fcbf915002a781e6d1996cae4df2ce80fc62d0948c0cb5965c97b07d0d5a9030cb7acf360bba4482a4f05026f1e082254f5f545a8fa5ba1bdb946ef520e
+  metadata.gz: 704a8beb8c791dc20e6d156f73a3c3b21f6aed0df0d94d0cc7dda78440d9051f4a9f9a3d076fa3afa5af54a4312e9251335d2ab2911c228506c23d877ef67789
+  data.tar.gz: '0906f2424988065b3d22a177ab260d42029ad3e531a8b5e051fc7170d87e87784fa18225eba4f6631416af7a0c9a3df5c1b3e464babdb8d56ace5f226b18ee39'

data/.rubocop.yml

@@ -1,4 +1,8 @@
-require: rubocop-performance
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 inherit_from:
   - https://gitlab.com/bsm/misc/raw/master/rubocop/default.yml
 

data/Gemfile.lock

@@ -1,70 +1,75 @@
 PATH
   remote: .
   specs:
-    searchable-by (0.5.6)
+    searchable-by (0.5.7)
       activerecord
       activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (6.0.3.3)
-      activesupport (= 6.0.3.3)
-    activerecord (6.0.3.3)
-      activemodel (= 6.0.3.3)
-      activesupport (= 6.0.3.3)
-    activesupport (6.0.3.3)
+    activemodel (6.1.1)
+      activesupport (= 6.1.1)
+    activerecord (6.1.1)
+      activemodel (= 6.1.1)
+      activesupport (= 6.1.1)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.1)
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
-    i18n (1.8.5)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.2)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    minitest (5.14.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
     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)
+    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.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.91.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (1.8.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.4.0, < 1.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.4.1)
-      parser (>= 2.7.1.4)
-    rubocop-performance (1.8.0)
-      rubocop (>= 0.87.0)
-    ruby-progressbar (1.10.1)
+      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 (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.1.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.4.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -75,6 +80,8 @@ DEPENDENCIES
   rspec
   rubocop
   rubocop-performance
+  rubocop-rake
+  rubocop-rspec
   searchable-by!
   sqlite3
 

data/README.md

@@ -14,9 +14,10 @@ class Post < ActiveRecord::Base
 
   # Limit the number of terms per query to 3.
   searchable_by max_terms: 3 do
-    # Allow to search strings.
+    # Allow to search strings with custom match type.
     # Use btree index-friendly prefix match, e.g. `ILIKE 'term%'` instead of default `ILIKE '%term%'`.
-    column :title, match: :prefix
+    # 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
 
     # ... and integers.
     column :id, type: :integer

data/lib/searchable_by.rb

@@ -6,7 +6,7 @@ module SearchableBy
   autoload :Config, 'searchable_by/config'
   autoload :Util, 'searchable_by/util'
 
-  Value = Struct.new(:term, :negate)
+  Value = Struct.new(:term, :negate, :phrase)
 end
 
 ActiveRecord::Base.extend SearchableBy::Concern if defined?(::ActiveRecord::Base)

data/lib/searchable_by/column.rb

@@ -1,33 +1,50 @@
 module SearchableBy
   class Column
-    attr_reader :attr, :type, :match
+    attr_reader :attr, :type, :match, :match_phrase
     attr_accessor :node
 
-    def initialize(attr, type: :string, match: :all)
+    def initialize(attr, type: :string, match: :all, match_phrase: nil)
       @attr  = attr
       @type  = type.to_sym
       @match = match
+      @match_phrase = match_phrase || match
     end
 
     def build_condition(value)
+      scope = node.not_eq(nil)
+
       case type
       when :int, :integer
-        begin
-          node.not_eq(nil).and(node.eq(Integer(value.term)))
-        rescue ArgumentError
-          nil
-        end
+        int_condition(scope, value)
+      else
+        str_condition(scope, value)
+      end
+    end
+
+    private
+
+    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 = value.term.dup
         term.gsub!('%', '\%')
         term.gsub!('_', '\_')
-        case match
-        when :prefix
-          term << '%'
-        else
-          term = "%#{term}%"
-        end
-        node.not_eq(nil).and(node.matches(term))
+        scope.and(node.matches("%#{term}%"))
       end
     end
   end

data/lib/searchable_by/util.rb

@@ -4,23 +4,23 @@ module SearchableBy
       values = []
       query  = query.to_s.dup
 
-      # capture any terms inside double quotes
+      # 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) unless term.blank?
+        values.push Value.new(term, negate, true) 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|
+      query.split.each do |term|
         negate = term[0] == '-'
         term.slice!(0) if negate || term[0] == '+'
 
-        values.push Value.new(term, negate) unless term.blank?
+        values.push Value.new(term, negate, false) unless term.blank?
       end
 
       values.uniq!

data/searchable-by.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'searchable-by'
-  s.version     = '0.5.6'
+  s.version     = '0.5.7'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Generate search scopes'
@@ -21,5 +21,7 @@ Gem::Specification.new do |s|
   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 'sqlite3'
 end

data/spec/searchable_by/util_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
 describe SearchableBy::Util do
-  context 'norm_values' do
+  context 'with 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
+    it 'tokenises strings' do
       expect(norm(nil)).to eq({})
       expect(norm('""')).to eq({})
       expect(norm('-+""')).to eq({})
@@ -17,7 +17,7 @@ describe SearchableBy::Util do
       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('""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)

data/spec/searchable_by_spec.rb

@@ -1,59 +1,72 @@
 require 'spec_helper'
 
 describe SearchableBy do
-  it 'should ignore bad inputs' 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%'))
   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 '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 'should search across multiple words' do
-    expect(Post.search_by('ALICE your').pluck(:title)).to match_array(%w[a2])
+  it 'searches across multiple words' do
+    expect(Post.search_by('ALICE your').pluck(:title)).to match_array(%w[ax2])
   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 '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 respect match options' do
-    # name uses match: :prefix
-    expect(Post.search_by('alice').pluck(:title)).to match_array(%w[a1 a2 ab])
-    expect(Post.search_by('ali').pluck(:title)).to match_array(%w[a1 a2 ab])
+  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: :all (default)
-    expect(Post.search_by('recip').pluck(:title)).to match_array(%w[a1 a2 b1 b2 ab])
+    # 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 '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 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 integers' do
-    expect(Post.search_by(POSTS[:ab].id.to_s).count).to eq(1)
+  it 'searches integers' do
+    expect(Post.search_by(POSTS[:ab1].id.to_s).count).to eq(1)
   end
 end

data/spec/spec_helper.rb

@@ -34,8 +34,9 @@ class Post < AbstractModel
   belongs_to :reviewer, class_name: 'User'
 
   searchable_by do
-    column :title, :body
-    column proc { User.arel_table[:name] }, match: :prefix
+    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
@@ -50,9 +51,9 @@ USERS = {
 }.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.6
+  version: 0.5.7
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2021-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -108,6 +108,34 @@ dependencies:
     - - ">="
       - !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
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Generate search scopes