searchable-by 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 615602791390c9de0ab159cbbd0c81c52c0441f61ad559082dad189787c7606f
-  data.tar.gz: ad765f8a22cd76196f7a04b7a7e16f38b3bbccacda0f1c7bda659e3ab2783f4f
+  metadata.gz: a91aa1b24f6ea20f4568629c1d6cc4010c2a6754932ad1251500a702c2f79165
+  data.tar.gz: bbe553d775212b8bb0c076fac08fe10ed7912931a150b3c93c6becd7fa298e7d
 SHA512:
-  metadata.gz: ae524aa23d507f4339592c4c6a2955d3d0664e7f9829be7071ed1d28a065e1ad77ff9a810a800769cf417db4d315344a487b058530e168325403cb26a1832e12
-  data.tar.gz: 71a1349d3738997571306d5326cf81bef66b101bbd03b9451d3b3d9b5851c35f1d732486d96b29d73e1efce792a0c5c840c42442a2f83bd5be171a47be28a17c
+  metadata.gz: 958e8ebc7f8ee60f4531f75fdf5780f667986985f0392af3a303ad0f82f3a810e2bd8aa23171b25ee9d906a111cc4be8cd95a83b9c302f3fe55390e95112835d
+  data.tar.gz: 393536f83f00c301b2a2bcf9ae10a158f6ddd9cb642170c893e68d9d1c8bb967131de058c48414f20111c1a5cecf7c0eb98240028e9858a2c788918e38fd3642

data/.github/workflows/test.yml

@@ -11,7 +11,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ["2.6", "2.7", "3.0"]
+        ruby-version: ["2.7", "3.0", "3.1"]
+        gemfiles: ["Gemfile", "Gemfile.rails6"]
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1

data/.rubocop.yml

@@ -6,7 +6,7 @@ inherit_mode:
     - Exclude
 
 AllCops:
-  TargetRubyVersion: "2.6"
+  TargetRubyVersion: "2.7"
 
 Naming/FileName:
   Exclude:

data/Gemfile.lock

@@ -1,79 +1,76 @@
 PATH
   remote: .
   specs:
-    searchable-by (0.6.0)
+    searchable-by (0.7.1)
       activerecord
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (6.1.4)
-      activesupport (= 6.1.4)
-    activerecord (6.1.4)
-      activemodel (= 6.1.4)
-      activesupport (= 6.1.4)
-    activesupport (6.1.4)
+    activemodel (7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activerecord (7.0.2.3)
+      activemodel (= 7.0.2.3)
+      activesupport (= 7.0.2.3)
+    activesupport (7.0.2.3)
       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.9)
-    diff-lcs (1.4.4)
-    i18n (1.8.10)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.1)
     rexml (3.2.5)
-    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)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.18.3)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
     rubocop-bsm (0.6.0)
       rubocop (~> 1.0)
       rubocop-performance
       rubocop-rake
       rubocop-rspec
-    rubocop-performance (1.11.4)
+    rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.4.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     sqlite3 (1.4.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -88,4 +85,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.2.21
+   2.3.9

data/Gemfile.rails6

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'activerecord', '~> 6.1'

data/Gemfile.rails6.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    searchable-by (0.7.1)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4.7)
+      activesupport (= 6.1.4.7)
+    activerecord (6.1.4.7)
+      activemodel (= 6.1.4.7)
+      activesupport (= 6.1.4.7)
+    activesupport (6.1.4.7)
+      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.9)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.16.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
+    rubocop-bsm (0.6.0)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rake
+      rubocop-rspec
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    sqlite3 (1.4.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (~> 6.1)
+  bundler
+  rake
+  rspec
+  rubocop
+  rubocop-bsm
+  searchable-by!
+  sqlite3
+
+BUNDLED WITH
+   2.3.9

data/README.md

@@ -34,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'
@@ -44,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/column.rb

@@ -1,22 +1,19 @@
 module SearchableBy
   class Column
+    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, 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
-
+    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 = opts[:min_length].to_i
       @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)
@@ -32,11 +29,6 @@ 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
@@ -49,18 +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!('_', '\_')
-        term.gsub!(wildcard, '%') if wildcard
+      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,28 +1,25 @@
 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, 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
+    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)
-      config  = _searchable_by_config
+    def search_by(query, profile: :default)
+      config  = _searchable_by_profiles[profile]
       columns = config.columns
       return all if columns.empty?
 

data/lib/searchable_by/config.rb

@@ -11,6 +11,13 @@ module SearchableBy
       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

@@ -29,12 +29,6 @@ module SearchableBy
 
     def self.build_clauses(columns, values)
       values.map do |value|
-        # TODO: remove when removing min_length option from columns
-        usable = columns.all? do |column|
-          column.send(:usable?, value)
-        end
-        next unless usable
-
         group = columns.map do |column|
           column.build_condition(value)
         end.tap(&:compact!)

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/searchable-by.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'searchable-by'
-  s.version     = '0.6.0'
+  s.version     = '0.7.1'
   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.6'
+  s.required_ruby_version = '>= 2.7'
 
   s.add_dependency 'activerecord'
   s.add_development_dependency 'bundler'
@@ -20,4 +20,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rubocop-bsm'
   s.add_development_dependency 'sqlite3'
+  s.metadata = {
+    'rubygems_mfa_required' => 'true',
+  }
 end

data/spec/searchable_by_spec.rb

@@ -7,8 +7,9 @@ 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)
+    expect(User._searchable_by_profiles[:default].min_length).to eq(3)
   end
 
   it 'generates SQL' do
@@ -24,10 +25,12 @@ describe SearchableBy do
     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"."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"."country" LIKE 'uni % dom'))
+    expect(sql).to include(%("users"."bio" LIKE '%uni * dom%'))
   end
 
   it 'searches' do
@@ -63,6 +66,9 @@ 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
@@ -88,9 +94,14 @@ describe SearchableBy do
     expect(Post.search_by(POSTS[:ab1].id.to_s).count).to eq(1)
   end
 
-  it 'supports wildcard searching' 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
+  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

@@ -32,7 +32,11 @@ class User < AbstractModel
 
   searchable_by min_length: 3 do
     column :bio
-    column :country, wildcard: '*'
+    column :country, wildcard: '*', match: :exact
+  end
+
+  searchable_by :country_only do
+    column :country
   end
 end
 
@@ -44,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchable-by
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2022-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -120,6 +120,8 @@ files:
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
+- Gemfile.rails6
+- Gemfile.rails6.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -128,6 +130,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
@@ -136,7 +139,8 @@ files:
 homepage: https://github.com/bsm/sortable-by
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -145,14 +149,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Generate search scopes