modern_searchlogic 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c1285376c99c453d6e9af0bb21b1458c4f34d5ddd7cdec3ce4e14ceae3d5d6b
-  data.tar.gz: bce4a074d01473a88767f1ef8b11c77c8a127272a6dbd6907dc0d8977d489796
+  metadata.gz: 44a496fa5bb25e276f94a214cc3062ad69bf68d0bf07b0a38b70f154b27b5b2f
+  data.tar.gz: d45273f03b6ba86003fc9c5fe3c5d6f40a8c1eb1aaca43793f6c4e846e20b17b
 SHA512:
-  metadata.gz: 8dbd45af5b7a11758a6e3323b62697f746e275033cbc492c669967fb9c570a3c2d805682c1635eff6d49d91a9302812dc9e879eb824322a6372164588d8968b9
-  data.tar.gz: d68579d00786da93e3db22cfafeecc5440455f4e3f4a90e38ed7c5eb712ccac63a1123fabe22281e9bcb61355d11b5fe19903ec1a1bdf986cf8882559c66aebf
+  metadata.gz: 6e9ed70ffe2c01fff4b5283377127dd3910d7e6ead66504dd5242bd99179ce1494375644b5ce5251d868d7f2c8731ffd50bd644d445b8a78fb5b2a3d98f6d369
+  data.tar.gz: 75fdbeb934dec5345a106f29dcb886f853b142bc61fa32d74bd06a4602d75d88d980dfcc012780bb3a361b24d7d396a606519ce2ce61256d11320056d1382548

data/README.md

@@ -17,6 +17,37 @@ The gem *might* work on Ruby 2, but it is only tested against Ruby 3.3.
 Just add the Gem to your gemspec, and the searchlogic methods will be available.
 Refer to the searchlogic documentation for more details.
 
+## Configuration
+
+By default the gem installs itself into every model, by including `ModernSearchlogic::ActiveRecordMethods` into `ActiveRecord::Base` (and `ModernSearchlogic::Ordering` into `ActiveRecord::Relation`) once ActiveRecord loads.
+
+To opt-out and wire things up yourself, set the following in `config/application.rb` (it must be set before ActiveRecord loads, so an initializer is too late):
+
+```ruby
+config.modern_searchlogic.auto_include = false
+```
+
+With that off, nothing is included anywhere, and you pick the pieces you want:
+
+```ruby
+class User < ApplicationRecord
+  include ModernSearchlogic::ColumnConditions  # username_like, age_gt, ascend_by_username, ...
+  include ModernSearchlogic::ScopeProcedure    # scope_procedure :adults, -> { age_gte(18) }
+  include ModernSearchlogic::Searchable        # User.search(:username_like => 'bob')
+end
+```
+
+The modules pull in whatever they depend on (`Searchable` brings `ColumnConditions`, which brings `ScopeTracking`, and so on), so including only the one you want is safe.
+HOWEVER, `ModernSearchlogic::Ordering` patches `order` on relations rather than on a model, so if you want `Model.order(:ascend_by_username)` to work, you need:
+
+```ruby
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Relation.include(ModernSearchlogic::Ordering)
+end
+```
+
+Note that a module cannot be un-included from a class once it is in the ancestor chain, so `auto_include = false` is the only way to keep a model free of these methods.
+
 ## Contributing
 
 Optional, but required for running specs against Rails 3-5: a [Rails LTS](https://railslts.com) subscription.

data/lib/modern_searchlogic/column_conditions.rb

@@ -1,12 +1,16 @@
+# frozen_string_literal: true
+
 module ModernSearchlogic
   module ColumnConditions
+    extend ActiveSupport::Concern
+
     module ClassMethods
       def respond_to_missing?(method, *)
         super || valid_searchlogic_scope?(method)
       end
 
       def valid_searchlogic_scope?(method)
-        return false if connection.tables.empty? || method =~ /^define_method_/ || abstract_class?
+        return false if abstract_class? || method =~ /^define_method_/ || !searchlogic_schema_ready?
 
         searchlogic_scope_dynamically_defined?(method) ||
           !!searchlogic_column_condition_method_block(method.to_s) ||
@@ -15,7 +19,7 @@ module ModernSearchlogic
 
       def dynamically_define_searchlogic_method(method)
         return true if searchlogic_scope_dynamically_defined?(method)
-        return false unless searchlogic_scope = searchlogic_column_condition_method_block(method.to_s)
+        return false unless (searchlogic_scope = searchlogic_column_condition_method_block(method.to_s))
         singleton_class.__send__(:define_method, method, &searchlogic_scope[:block])
         self._dynamically_defined_searchlogic_scopes = self._dynamically_defined_searchlogic_scopes.merge(method => searchlogic_scope)
         true
@@ -33,6 +37,12 @@ module ModernSearchlogic
 
       private
 
+      def searchlogic_schema_ready?
+        return false if self == ActiveRecord::Base
+
+        @searchlogic_schema_ready ||= table_exists?
+      end
+
       def searchlogic_scope_dynamically_defined?(method)
         _dynamically_defined_searchlogic_scopes.key?(method)
       end
@@ -74,7 +84,7 @@ module ModernSearchlogic
         end
       end
 
-      def searchlogic_active_record_alias(searchlogic_suffix, options = {}, &block)
+      def searchlogic_active_record_alias(searchlogic_suffix, &block)
         searchlogic_suffix_condition "_#{searchlogic_suffix}" do |column_name, *args|
           raise ArgumentError, "wrong number of arguments (0 for >= 1)" if args.empty?
           raise ArgumentError, "unsupported searchlogic suffix #{searchlogic_suffix} passed" unless [:in, :not_in].include?(searchlogic_suffix)
@@ -90,8 +100,8 @@ module ModernSearchlogic
 
       def searchlogic_suffix_condition_match(method_name)
         suffix_regexp = searchlogic_suffix_conditions.keys.join('|')
-        if match = method_name.match(/\A(#{column_names_regexp}(?:_or_#{column_names_regexp})*)(#{suffix_regexp})\z/)
-          options, method_block = searchlogic_suffix_conditions.fetch(match[2])
+        if (match = method_name.match(/\A(#{column_names_regexp}(?:_or_#{column_names_regexp})*)(#{suffix_regexp})\z/))
+          _options, method_block = searchlogic_suffix_conditions.fetch(match[2])
           column_names = match[1].split('_or_')
 
           arity = calculate_arity(method_block)
@@ -111,7 +121,7 @@ module ModernSearchlogic
 
       def searchlogic_prefix_match(method_name)
         prefix_regexp = searchlogic_prefix_conditions.keys.join('|')
-        if match = method_name.match(/\A(#{prefix_regexp})(#{column_names_regexp})\z/)
+        if (match = method_name.match(/\A(#{prefix_regexp})(#{column_names_regexp})\z/))
           method_block = searchlogic_prefix_conditions.fetch(match[1])
 
           arity = calculate_arity(method_block)
@@ -123,7 +133,7 @@ module ModernSearchlogic
               instance_exec(match[2], *args, &method_block)
             end
           }
-        elsif match = method_name.match(/\A(#{prefix_regexp})(#{association_names_regexp})_(\S+)\z/)
+        elsif (match = method_name.match(/\A(#{prefix_regexp})(#{association_names_regexp})_(\S+)\z/))
           prefix, association_name, rest = match.to_a.drop(1)
 
           searchlogic_association_finder_method(association_by_name.fetch(association_name.to_sym), prefix + rest)
@@ -131,13 +141,13 @@ module ModernSearchlogic
       end
 
       def searchlogic_association_suffix_match(method_name)
-        if match = method_name.match(/\A(#{association_names_regexp})_(\S+)\z/)
+        if (match = method_name.match(/\A(#{association_names_regexp})_(\S+)\z/))
           searchlogic_association_finder_method(association_by_name.fetch(match[1].to_sym), match[2])
         end
       end
 
       def searchlogic_column_boolean_match(method_name)
-        if match = method_name.match(/^not_(.*)/)
+        if (match = method_name.match(/^not_(.*)/))
           column_name = match[1]
           if boolean_column?(column_name)
             {arity: 0, block: lambda { where(column_name => false) }}
@@ -191,7 +201,7 @@ module ModernSearchlogic
       end
 
       def method_missing(method, *args, &block)
-        return super if connection.tables.empty? || abstract_class?
+        return super if abstract_class? || !searchlogic_schema_ready?
         return super unless dynamically_define_searchlogic_method(method)
 
         __send__(method, *args, &block)
@@ -226,77 +236,73 @@ module ModernSearchlogic
       end
     end
 
-    def self.included(base)
-      base.extend ClassMethods
-
-      base.class_eval do
-        class_attribute :searchlogic_suffix_conditions
-        self.searchlogic_suffix_conditions = {}
-
-        class_attribute :searchlogic_prefix_conditions
-        self.searchlogic_prefix_conditions = {}
-
-        searchlogic_arel_alias :equals, :eq
-        searchlogic_arel_alias :eq, :eq
-        searchlogic_arel_alias :is, :eq
-        searchlogic_arel_alias :does_not_equal, :not_eq
-        searchlogic_arel_alias :ne, :not_eq
-        searchlogic_arel_alias :not_eq, :not_eq
-        searchlogic_arel_alias :not, :not_eq
-        searchlogic_arel_alias :is_not, :not_eq
-        searchlogic_arel_alias :greater_than, :gt
-        searchlogic_arel_alias :gt, :gt
-        searchlogic_arel_alias :less_than, :lt
-        searchlogic_arel_alias :lt, :lt
-        searchlogic_arel_alias :greater_than_or_equal_to, :gteq
-        searchlogic_arel_alias :gte, :gteq
-        searchlogic_arel_alias :less_than_or_equal_to, :lteq
-        searchlogic_arel_alias :lte, :lteq
-        searchlogic_active_record_alias :in do |column, values|
-          has_nil = values.include?(nil)
-          values = values.flatten.compact
-          subs = [values]
-          if has_nil
-            subs << nil
-          end
-          where(column => searchlogic_extract_arel_compatible_value(subs))
-        end
-        searchlogic_active_record_alias :not_in do |column, values|
-          values = searchlogic_extract_arel_compatible_value(values.flatten)
-          query = values.map { "#{connection.quote_table_name(arel_table.name)}.#{connection.quote_column_name(column)} != ?" }.join(" AND ")
-          where(query, *values)
-        end
+    included do
+      class_attribute :_dynamically_defined_searchlogic_scopes
+      self._dynamically_defined_searchlogic_scopes = {}
+
+      class_attribute :searchlogic_suffix_conditions
+      self.searchlogic_suffix_conditions = {}
+
+      class_attribute :searchlogic_prefix_conditions
+      self.searchlogic_prefix_conditions = {}
+
+      searchlogic_arel_alias :equals, :eq
+      searchlogic_arel_alias :eq, :eq
+      searchlogic_arel_alias :is, :eq
+      searchlogic_arel_alias :does_not_equal, :not_eq
+      searchlogic_arel_alias :ne, :not_eq
+      searchlogic_arel_alias :not_eq, :not_eq
+      searchlogic_arel_alias :not, :not_eq
+      searchlogic_arel_alias :is_not, :not_eq
+      searchlogic_arel_alias :greater_than, :gt
+      searchlogic_arel_alias :gt, :gt
+      searchlogic_arel_alias :less_than, :lt
+      searchlogic_arel_alias :lt, :lt
+      searchlogic_arel_alias :greater_than_or_equal_to, :gteq
+      searchlogic_arel_alias :gte, :gteq
+      searchlogic_arel_alias :less_than_or_equal_to, :lteq
+      searchlogic_arel_alias :lte, :lteq
+      searchlogic_active_record_alias :in do |column, values|
+        has_nil = values.include?(nil)
+        values = values.flatten.compact
+        values << nil if has_nil
+        where(column => searchlogic_extract_arel_compatible_value(values))
+      end
+      searchlogic_active_record_alias :not_in do |column, values|
+        values = searchlogic_extract_arel_compatible_value(values.flatten)
+        query = values.map { "#{connection.quote_table_name(arel_table.name)}.#{connection.quote_column_name(column)} != ?" }.join(" AND ")
+        where(query, *values)
+      end
 
-        searchlogic_arel_alias :like, :matches, :map_value => -> (val) { "%#{val}%" }
-        searchlogic_arel_alias :begins_with, :matches, :map_value => -> (val) { "#{val}%" }
-        searchlogic_arel_alias :ends_with, :matches, :map_value => -> (val) { "%#{val}" }
-        searchlogic_arel_alias :not_like, :does_not_match, :map_value => -> (val) { "%#{val}%" }
-        searchlogic_arel_alias :not_begin_with, :does_not_match, :map_value => -> (val) { "#{val}%" }
-        searchlogic_arel_alias :not_end_with, :does_not_match, :map_value => -> (val) { "%#{val}" }
+      searchlogic_arel_alias :like, :matches, :map_value => ->(val) { "%#{val}%" }
+      searchlogic_arel_alias :begins_with, :matches, :map_value => ->(val) { "#{val}%" }
+      searchlogic_arel_alias :ends_with, :matches, :map_value => ->(val) { "%#{val}" }
+      searchlogic_arel_alias :not_like, :does_not_match, :map_value => ->(val) { "%#{val}%" }
+      searchlogic_arel_alias :not_begin_with, :does_not_match, :map_value => ->(val) { "#{val}%" }
+      searchlogic_arel_alias :not_end_with, :does_not_match, :map_value => ->(val) { "%#{val}" }
 
-        searchlogic_suffix_condition '_blank' do |column_name|
-          arel_table[column_name].eq(nil).or(arel_table[column_name].eq(''))
-        end
+      searchlogic_suffix_condition '_blank' do |column_name|
+        arel_table[column_name].eq(nil).or(arel_table[column_name].eq(''))
+      end
 
-        searchlogic_suffix_condition '_present' do |column_name|
-          arel_table[column_name].not_eq(nil).and(arel_table[column_name].not_eq(''))
-        end
+      searchlogic_suffix_condition '_present' do |column_name|
+        arel_table[column_name].not_eq(nil).and(arel_table[column_name].not_eq(''))
+      end
 
-        null_matcher = lambda { |column_name| arel_table[column_name].eq(nil) }
-        searchlogic_suffix_condition '_null', &null_matcher
-        searchlogic_suffix_condition '_nil', &null_matcher
+      null_matcher = lambda { |column_name| arel_table[column_name].eq(nil) }
+      searchlogic_suffix_condition '_null', &null_matcher
+      searchlogic_suffix_condition '_nil', &null_matcher
 
-        not_null_matcher = lambda { |column_name| arel_table[column_name].not_eq(nil) }
-        searchlogic_suffix_condition '_not_null', &not_null_matcher
-        searchlogic_suffix_condition '_not_nil', &not_null_matcher
+      not_null_matcher = lambda { |column_name| arel_table[column_name].not_eq(nil) }
+      searchlogic_suffix_condition '_not_null', &not_null_matcher
+      searchlogic_suffix_condition '_not_nil', &not_null_matcher
 
-        searchlogic_prefix_condition 'descend_by_' do |column_name|
-          order(arel_table[column_name].desc)
-        end
+      searchlogic_prefix_condition 'descend_by_' do |column_name|
+        order(arel_table[column_name].desc)
+      end
 
-        searchlogic_prefix_condition 'ascend_by_' do |column_name|
-          order(arel_table[column_name].asc)
-        end
+      searchlogic_prefix_condition 'ascend_by_' do |column_name|
+        order(arel_table[column_name].asc)
       end
     end
   end

data/lib/modern_searchlogic/default_scoping.rb

@@ -1,13 +1,15 @@
 module ModernSearchlogic
   module DefaultScoping
+    extend ActiveSupport::Concern
+
     module ClassMethods
       def searchlogic_default_scope
-        respond_to?(:scoped) ? scoped : all
+        if Rails::VERSION::MAJOR < 4
+          scoped
+        else
+          all
+        end
       end
     end
-
-    def self.included(base)
-      base.extend ClassMethods
-    end
   end
 end

data/lib/modern_searchlogic/ordering.rb

@@ -1,20 +1,21 @@
 module ModernSearchlogic
   module Ordering
-    def self.included(base)
-      base.module_eval do
-        define_method(:order_with_modern_searchlogic) do |*args|
-          args.reduce(self) do |scope, arg|
-            expression = arg.to_s
-            if expression.match(/^(ascend|descend)_by_(.*)/) && respond_to?(expression)
-              scope.send(expression)
-            else
-              scope.order_without_modern_searchlogic(arg)
-            end
+    extend ActiveSupport::Concern
+
+    included do
+      define_method(:order_with_modern_searchlogic) do |*args|
+        args.reduce(self) do |scope, arg|
+          expression = arg.to_s
+          if expression.match(/^(ascend|descend)_by_(.*)/) && respond_to?(expression)
+            scope.send(expression)
+          else
+            scope.order_without_modern_searchlogic(arg)
           end
         end
-        alias_method :order_without_modern_searchlogic, :order
-        alias_method :order, :order_with_modern_searchlogic
       end
+
+      alias_method :order_without_modern_searchlogic, :order
+      alias_method :order, :order_with_modern_searchlogic
     end
   end
 end

data/lib/modern_searchlogic/railtie.rb

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 module ModernSearchlogic
   class Railtie < Rails::Railtie
-    initializer 'modern_searchlogic.setup_activerecord' do
+    config.modern_searchlogic = ActiveSupport::OrderedOptions.new
+    config.modern_searchlogic.auto_include = true
+
+    initializer 'modern_searchlogic.setup_activerecord' do |app|
       ActiveSupport.on_load(:active_record) do
-        ModernSearchlogic::ActiveRecordMethods.install
+        ModernSearchlogic::ActiveRecordMethods.install if app.config.modern_searchlogic.auto_include
       end
     end
   end

data/lib/modern_searchlogic/scope_procedure.rb

@@ -1,17 +1,19 @@
 module ModernSearchlogic
   module ScopeProcedure
-    def self.included(base)
-      base.singleton_class.class_eval do
-        def scope_procedure(name, options = nil)
-          if options.is_a?(Proc)
-            define_singleton_method(name, &options)
-          else
-            define_singleton_method(name) do |*args|
-              public_send(options, *args)
-            end
+    extend ActiveSupport::Concern
+
+    include ScopeTracking
+
+    module ClassMethods
+      def scope_procedure(name, options = nil)
+        if options.is_a?(Proc)
+          define_singleton_method(name, &options)
+        else
+          define_singleton_method(name) do |*args|
+            public_send(options, *args)
           end
-          self._defined_scopes << name.to_sym
         end
+        self._defined_scopes << name.to_sym
       end
     end
   end

data/lib/modern_searchlogic/scope_tracking.rb

@@ -1,5 +1,12 @@
 module ModernSearchlogic
   module ScopeTracking
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_defined_scopes
+      self._defined_scopes = Set.new
+    end
+
     module ClassMethods
       def scope(name, body, &block)
         super(name, body, &block).tap do |*|
@@ -7,15 +14,5 @@ module ModernSearchlogic
         end
       end
     end
-
-    def self.included(base)
-      base.extend ClassMethods
-      base.class_eval do
-        class_attribute :_defined_scopes
-        self._defined_scopes = Set.new
-        class_attribute :_dynamically_defined_searchlogic_scopes
-        self._dynamically_defined_searchlogic_scopes = {}
-      end
-    end
   end
 end

data/lib/modern_searchlogic/search.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ModernSearchlogic
   class Search
     def self.search(model_class, options = {})

data/lib/modern_searchlogic/searchable.rb

@@ -2,14 +2,15 @@ require_relative 'search'
 
 module ModernSearchlogic
   module Searchable
+    extend ActiveSupport::Concern
+
+    include DefaultScoping
+    include ColumnConditions
+
     module ClassMethods
       def search(options = {})
         Search.search(self, options)
       end
     end
-
-    def self.included(base)
-      base.extend ClassMethods
-    end
   end
 end

data/lib/modern_searchlogic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ModernSearchlogic
-  VERSION = "1.0.1"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: modern_searchlogic
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrew Warner
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-23 00:00:00.000000000 Z
+date: 2026-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails