searchable-by 0.5.5 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b2c3092a9a334ae2ea2256953e9a1fa3198d6b6aa8d8f5fe7eb841920782dce
-  data.tar.gz: 6e6ba3ee470d96063a91e24c3fdcbe2be411a13a567828b57c39d74dc1a8133a
+  metadata.gz: 2e2f1b8d0d05abf263dc93c1bd81ab818a88eedf135ff10cd5414d54d3ae17a1
+  data.tar.gz: 04d1e040390dcf8c77adbc1bf5bd491505373147798b1c95e4e4cc6c259daab5
 SHA512:
-  metadata.gz: 52a694bb37c67c2f4a8905e41d0affa729f1ddf0a595428278af25f8d97e986fe6bb5aa8cb462932dee1258032f4f3adb8b2f4f1c804f3c049482b7ef64493b0
-  data.tar.gz: ea1c883f1f9636c0baf7575918bf89330b22503efc132a65084a49a6e9ff63c96313efcc69259d4e26175b8f75744a65b8f6c39bfb130a9e4532a189aa19ed3f
+  metadata.gz: e6bcafc69897951760eba1a9fb049664aa3360536525d31e6f5b1d9094ce274cc82c6936aa69e19b8ece975e1f74d42f424646d5a6e4de4bc4c12b29b24a4b33
+  data.tar.gz: a5762fcbf915002a781e6d1996cae4df2ce80fc62d0948c0cb5965c97b07d0d5a9030cb7acf360bba4482a4f05026f1e082254f5f545a8fa5ba1bdb946ef520e

data/Gemfile.lock

@@ -1,35 +1,36 @@
 PATH
   remote: .
   specs:
-    searchable-by (0.5.5)
+    searchable-by (0.5.6)
       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.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)
       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)
+    ast (2.4.1)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
+    minitest (5.14.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
+    regexp_parser (1.7.1)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -44,25 +45,26 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.84.0)
+    rubocop (0.91.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 0.4.0, < 1.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)
+    rubocop-ast (0.4.1)
+      parser (>= 2.7.1.4)
+    rubocop-performance (1.8.0)
+      rubocop (>= 0.87.0)
     ruby-progressbar (1.10.1)
     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)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
@@ -77,4 +79,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

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

@@ -15,7 +15,8 @@ class Post < ActiveRecord::Base
   # Limit the number of terms per query to 3.
   searchable_by max_terms: 3 do
     # Allow to search strings.
-    column :title
+    # Use btree index-friendly prefix match, e.g. `ILIKE 'term%'` instead of default `ILIKE '%term%'`.
+    column :title, match: :prefix
 
     # ... 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)
 end
+
+ActiveRecord::Base.extend SearchableBy::Concern if defined?(::ActiveRecord::Base)

data/lib/searchable_by/column.rb

@@ -0,0 +1,34 @@
+module SearchableBy
+  class Column
+    attr_reader :attr, :type, :match
+    attr_accessor :node
+
+    def initialize(attr, type: :string, match: :all)
+      @attr  = attr
+      @type  = type.to_sym
+      @match = match
+    end
+
+    def build_condition(value)
+      case type
+      when :int, :integer
+        begin
+          node.not_eq(nil).and(node.eq(Integer(value.term)))
+        rescue ArgumentError
+          nil
+        end
+      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))
+      end
+    end
+  end
+end

data/lib/searchable_by/concern.rb

@@ -0,0 +1,43 @@
+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, **options, &block)
+      _searchable_by_config.instance_eval(&block)
+      _searchable_by_config.max_terms = max_terms if max_terms
+      _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)
+      columns = _searchable_by_config.columns
+      return all if columns.empty?
+
+      values = Util.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 = Util.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

data/lib/searchable_by/config.rb

@@ -0,0 +1,31 @@
+module SearchableBy
+  class Config
+    attr_reader :columns, :scoping, :options
+    attr_accessor :max_terms
+
+    def initialize
+      @columns = []
+      @max_terms = 5
+      @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,46 @@
+module SearchableBy
+  module Util
+    def self.norm_values(query)
+      values = []
+      query  = query.to_s.dup
+
+      # capture any terms 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?
+        ''
+      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|
+          column.build_condition(value)
+        end
+        grouping.compact!
+        next if grouping.empty?
+
+        clause = grouping.inject(&:or)
+        clause = clause.not if value.negate
+        clause
+      end
+      clauses.compact!
+      clauses
+    end
+  end
+end

data/searchable-by.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'searchable-by'
-  s.version     = '0.5.5'
+  s.version     = '0.5.6'
   s.authors     = ['Dimitrij Denissenko']
   s.email       = ['dimitrij@blacksquaremedia.com']
   s.summary     = 'Generate search scopes'

data/spec/searchable_by/util_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe SearchableBy::Util 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
+end

data/spec/searchable_by_spec.rb

@@ -1,38 +1,6 @@
 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
-
+describe SearchableBy do
   it 'should ignore bad inputs' do
     expect(Post.search_by(nil).count).to eq(5)
     expect(Post.search_by('').count).to eq(5)
@@ -69,6 +37,17 @@ describe ActiveRecord::SearchableBy do
     expect(Post.search_by('bob +"her recipe"').pluck(:title)).to match_array(%w[b1])
   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])
+    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])
+  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[])

data/spec/spec_helper.rb

@@ -35,7 +35,7 @@ class Post < AbstractModel
 
   searchable_by do
     column :title, :body
-    column { User.arel_table[:name] }
+    column proc { User.arel_table[:name] }, match: :prefix
     column { User.arel_table.alias('reviewers_posts')[:name] }
 
     scope do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchable-by
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 2020-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -139,7 +139,12 @@ 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
@@ -166,5 +171,6 @@ 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