searchable-by 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 472133b9b419e573a1c87b721a5c368b3915ef28cb94e897424f55f7191f723f
-  data.tar.gz: d3c31e307f54b0545171e7e12b86d75d32f5874676af467399fdb2e533927c16
+  metadata.gz: e3c6177e1001a078408b9466190f08df81a8dc812724903650ecd4a1b267fa09
+  data.tar.gz: 8c08713658466f75b21cac681a4dcce20bef6dc1544c4d7a935bb1eb285f54ea
 SHA512:
-  metadata.gz: 1bd8dc39da51b94327d7912661cda9e2d38cdbf7d6e62eea1930e5d39a85c3bfd81c468477e8cfac48451b7dde055b9075a03686787c481c1cf2fcc5fa9d9c5f
-  data.tar.gz: e9881b0f0022a0f884d6780afb3f24daf53872a473e22571f1eed730c8c76083148dbec4e99825875a68bb425568776c04fb7ac5d7ad26b1aa9202be3160d357
+  metadata.gz: f384f6380a8124c6a8a5f1591d54b14cbce6def8766cbe0271f43f023c98d0a6622f99f0ac22d7537b497ea59ea10ff7412b005729159d6d3cbc78908c00e8a6
+  data.tar.gz: ae93c1ce199d6a6315d579346ddff7c04dd1673782c85c130d9c17def56aa94d1873cb44333a53937d789e76683436641fd4187f1b26fd89327079d9857aefe7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    searchable-by (0.6.1)
+    searchable-by (0.7.0)
       activerecord
 
 GEM

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.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,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,11 +41,13 @@ module SearchableBy
 
       case type
       when :exact
-        term.downcase!
-        scope.and(node.lower.eq(term))
-      when :full
-        escape_term!(term)
-        scope.and(node.matches(term))
+        if wildcard
+          escape_term!(term)
+          scope.and(node.matches(term))
+        else
+          term.downcase!
+          scope.and(node.lower.eq(term))
+        end
       when :prefix
         escape_term!(term)
         scope.and(node.matches("#{term}%"))

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

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

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(6)
+    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
@@ -93,9 +93,14 @@ describe SearchableBy do
     expect(Post.search_by(POSTS[:ab1].id.to_s).count).to eq(1)
   end
 
-  it 'supports wildcard searching' do
+  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: '*', match: :full
+    column :country, wildcard: '*', match: :exact
+  end
+
+  searchable_by :country_only do
+    column :country
   end
 end
 
@@ -44,7 +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: :full
+    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.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -128,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