searchable-by 0.5.8 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9577dc443c9400afd9bb866e8a53a351cf1e56420ce28b140c184e6647689411
-  data.tar.gz: 6a84939c7bb80af91d31b6d6bb3fd65acd672a4b41fbc25dbe08664e74d1f58d
+  metadata.gz: e3c6177e1001a078408b9466190f08df81a8dc812724903650ecd4a1b267fa09
+  data.tar.gz: 8c08713658466f75b21cac681a4dcce20bef6dc1544c4d7a935bb1eb285f54ea
 SHA512:
-  metadata.gz: 86367f8084de15d5d8e11568c1dadd5beddb090bf4dc4c334133197e15906e0bced5396a5c95f9434e6902d2ae0752698590f1b2fc1eacba26cb49a66a3e5697
-  data.tar.gz: ac9f4157b9a1705b50c95c9e1e3ee4f9c19b5ea7be9fec12a5a42df53eb0a2761a0c90c902dce641f15628ac48f2b3be4e1b504cfb36bebd6db00620dda4d787
+  metadata.gz: f384f6380a8124c6a8a5f1591d54b14cbce6def8766cbe0271f43f023c98d0a6622f99f0ac22d7537b497ea59ea10ff7412b005729159d6d3cbc78908c00e8a6
+  data.tar.gz: ae93c1ce199d6a6315d579346ddff7c04dd1673782c85c130d9c17def56aa94d1873cb44333a53937d789e76683436641fd4187f1b26fd89327079d9857aefe7

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/Gemfile.lock

@@ -1,38 +1,36 @@
 PATH
   remote: .
   specs:
-    searchable-by (0.5.8)
+    searchable-by (0.7.0)
       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.2)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
-    i18n (1.8.8)
+    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)
-    rack (2.2.3)
     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)
@@ -46,33 +44,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.9.1)
+    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.9.2)
-      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.3
+   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
@@ -32,6 +34,14 @@ class Post < ActiveRecord::Base
       joins(:author)
     end
   end
+
+  # Multiple profiles can be defined. This one only searches title and metadata.
+  searchable_by :metadata do
+    column :title, match: :prefix
+
+    # Allow custom wildcard replacement using a match e.g. searching for `"My*Post"` will query `ILIKE 'My%Post'`.
+    column :metadata, match: :prefix, wildcard: '*'
+  end
 end
 
 # Search for 'alice'
@@ -42,4 +52,7 @@ Post.search_by('alice "pie recipe"')
 
 # Search for 'alice' but NOT for 'pie recipe'
 Post.search_by('alice -"pie recipe"')
+
+# Search using metadata profile
+Post.search_by('meta', profile: :metadata)
 ```

data/lib/searchable_by.rb

@@ -4,6 +4,7 @@ module SearchableBy
   autoload :Column, 'searchable_by/column'
   autoload :Concern, 'searchable_by/concern'
   autoload :Config, 'searchable_by/config'
+  autoload :Profiles, 'searchable_by/profiles'
   autoload :Util, 'searchable_by/util'
 
   Value = Struct.new(:term, :negate, :phrase)

data/lib/searchable_by/column.rb

@@ -1,19 +1,22 @@
 module SearchableBy
   class Column
-    attr_reader :attr, :type, :match, :match_phrase, :min_length
+    VALID_MATCH_TYPES = %i[all prefix exact].freeze
+
+    attr_reader :attr, :type, :match, :match_phrase, :wildcard
     attr_accessor :node
 
-    def initialize(attr, type: :string, match: :all, match_phrase: nil, min_length: 0)
+    def initialize(attr, type: :string, match: :all, match_phrase: nil, wildcard: nil)
       @attr  = attr
       @type  = type.to_sym
       @match = match
       @match_phrase = match_phrase || match
-      @min_length = min_length
+      @wildcard = wildcard
+
+      raise ArgumentError, "invalid match option #{@match.inspect}" unless VALID_MATCH_TYPES.include? @match
+      raise ArgumentError, "invalid match_phrase option #{@match_phrase.inspect}" unless VALID_MATCH_TYPES.include? @match_phrase
     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
@@ -38,17 +41,26 @@ module SearchableBy
 
       case type
       when :exact
-        term.downcase!
-        scope.and(node.lower.eq(term))
+        if wildcard
+          escape_term!(term)
+          scope.and(node.matches(term))
+        else
+          term.downcase!
+          scope.and(node.lower.eq(term))
+        end
       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

@@ -1,30 +1,29 @@
 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
+      base.class_attribute :_searchable_by_profiles, instance_accessor: false, instance_predicate: false
+      base._searchable_by_profiles = Profiles.new
       super
     end
 
     def inherited(base) # :nodoc:
-      base._searchable_by_config = _searchable_by_config.dup
+      base._searchable_by_profiles = _searchable_by_profiles.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
+    def searchable_by(profile = :default, max_terms: nil, min_length: 0, **options, &block)
+      _searchable_by_profiles[profile].configure(max_terms, min_length, **options, &block)
+      _searchable_by_profiles
     end
 
     # @param [String] query the search query
     # @return [ActiveRecord::Relation] the scoped relation
-    def search_by(query)
-      columns = _searchable_by_config.columns
+    def search_by(query, profile: :default)
+      config  = _searchable_by_profiles[profile]
+      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 +32,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,15 +1,23 @@
 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
 
+    def configure(max_terms, min_length, **options, &block)
+      instance_eval(&block)
+      self.max_terms = max_terms if max_terms
+      self.min_length = min_length
+      self.options.update(options) unless options.empty?
+    end
+
     def initialize_copy(other)
       @columns = other.columns.dup
       super

data/lib/searchable_by/profiles.rb

@@ -0,0 +1,23 @@
+module SearchableBy
+  class Profiles
+    def initialize
+      @profiles = {}
+    end
+
+    def [](name)
+      name = name.to_sym
+      @profiles[name] ||= Config.new
+    end
+
+    def each(&block)
+      @profiles.each(&block)
+    end
+
+    def initialize_copy(other)
+      @profiles = {}
+      other.each do |name, config|
+        @profiles[name] = config.dup
+      end
+    end
+  end
+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,16 @@ module SearchableBy
     end
 
     def self.build_clauses(columns, values)
-      clauses = values.map do |value|
-        grouping = columns.map do |column|
+      values.map do |value|
+        group = columns.map do |column|
           column.build_condition(value)
-        end
-        grouping.compact!
-        next if grouping.empty?
+        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,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name        = 'searchable-by'
-  s.version     = '0.5.8'
+  s.version     = '0.7.0'
   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")
@@ -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

@@ -7,8 +7,8 @@ describe SearchableBy do
   end
 
   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(AbstractModel._searchable_by_profiles[:default].columns.size).to eq(1)
+    expect(Post._searchable_by_profiles[:default].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,13 +65,23 @@ 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' 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
@@ -74,4 +92,15 @@ describe SearchableBy do
   it 'searches integers' do
     expect(Post.search_by(POSTS[:ab1].id.to_s).count).to eq(1)
   end
+
+  it 'supports wildcards' 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
+
+  it 'supports profiles' do
+    expect(User.search_by('king', profile: :country_only)).to match_array(USERS.values_at(:a))
+    expect(User.search_by('Norris', profile: :country_only)).to be_empty
+  end
 end

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ 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
@@ -29,8 +30,13 @@ 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: '*', match: :exact
+  end
+
+  searchable_by :country_only do
+    column :country
   end
 end
 
@@ -42,6 +48,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: :exact
     column { User.arel_table.alias('reviewers_posts')[:name] }
 
     scope do
@@ -51,8 +58,8 @@ class Post < AbstractModel
 end
 
 USERS = {
-  a: User.create!(name: 'Alice', bio: 'First user'),
-  b: User.create!(name: 'Bob', bio: 'Second user'),
+  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.8
+  version: 0.7.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2021-08-11 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,9 +115,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -142,6 +128,7 @@ files:
 - lib/searchable_by/column.rb
 - lib/searchable_by/concern.rb
 - lib/searchable_by/config.rb
+- lib/searchable_by/profiles.rb
 - lib/searchable_by/util.rb
 - searchable-by.gemspec
 - spec/searchable_by/util_spec.rb
@@ -149,7 +136,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/bsm/sortable-by
 licenses:
-- MIT
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -166,7 +153,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

data/.travis.yml

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