activerecord-mysql-search 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dec7afc185ebe9baa4de931681c27b4718d138126111fbeb1467819b958e5883
-  data.tar.gz: 21d49c730ea6064c0c6ba1a1993dd24e09273463e082d5a1d57fff9fe2ad17a9
+  metadata.gz: 19cb0101f1cfe861ccdf0defa71c17f4608e17e99e7428f5e5ad00aa2a646be5
+  data.tar.gz: 758c80b143460cc517d826af5fd701d19adbe46dddbec49aa1e245cf48f37201
 SHA512:
-  metadata.gz: 706aa3813e15aa8814ab3f2c908de266db1ab65d09a7b96f00bc6234cabcc6579dd8413db97bcd6b4754c6375e1464156dcc5c930345cc193eaa532ee4794f03
-  data.tar.gz: 0ce9414a415f48805420657fbc14c9e7b7f7111d2e4641dd6b127601c5100915ffaba100fea62023c9a0735d044d9362e436761e39f5c98e6632fdf3d324528b
+  metadata.gz: 5c0d1de1bdcf4d17b6b30826fcd7f38eb6f81410fe8d27794379e71d7b67cadb7d5c78f465ecc143bc0b7a23dbea022edefb44f90cf558e61791180b336aaf1d
+  data.tar.gz: 8c70d839e870efe25a3525baa34053e0b951bdb32b12ebc8c0e84fbc8ab52ca9a8658d68a4a4c9ddc6fcbff0a533b096745ed0ea9fd6aade945c30090d4cca5c

data/Appraisals

@@ -16,3 +16,11 @@ end
 appraise 'rails_8.0' do
   gem 'rails', '~> 8.0.0'
 end
+
+appraise 'rails_8.0' do
+  gem 'rails', '~> 8.0.0'
+end
+
+appraise 'rails_8.1' do
+  gem 'rails', '~> 8.1.0'
+end

data/CHANGELOG.md

@@ -1,23 +1,36 @@
 ## [Unreleased]
 
-## [0.1.0] - 2025-07-22
+## [0.2.3] - 2026-09-11
 
-- Initial release
+- Adds the `boolean_full_text_search` scope for MySQL boolean full-text queries
+- Adds integration coverage for required (`+`) and excluded (`-`) search terms
 
-## [0.1.1] - 2025-08-05
+## [0.2.1] - 2026-07-15
 
-- Fixes load paths to rake tasks
+- Adds automatic loading of source classes on Rails startup via new `autoload_sources` configuration option (default: true)
+- Adds `load_source_classes!` method for manually loading source classes
+- Fixes source actualization query composition to preserve base STI scope while appending OR conditions for associated updates
+- Adds regression coverage for STI subclass source relations with associated updates
+- Extracts Arel `AGAINST` integration into a dedicated extension file
 
-## [0.1.2] - 2025-08-12
+## [0.2.0] - 2025-09-25
 
-- Removes code of conduct
+- Removes text normalization from default `:text` formatter
+- Search term passed as argument to the scope `.full_text_search` is not pre-normalized anymore
+- Adds `register_format` method to register custom formatters
 
 ## [0.1.3] - 2025-08-06
 
 - Move rake tasks to the proper place + explicit tasks load
 
-## [0.2.0] - 2025-09-25
+## [0.1.2] - 2025-08-12
 
-- Removes text normalization from default `:text` formatter
-- Search term passed as argument to the scope `.full_text_search` is not pre-normalized anymore
-- Adds `register_format` method to register custom formatters
+- Removes code of conduct
+
+## [0.1.1] - 2025-08-05
+
+- Fixes load paths to rake tasks
+
+## [0.1.0] - 2025-07-22
+
+- Initial release

data/Gemfile

@@ -16,6 +16,7 @@ gem 'database_cleaner-active_record'
 gem 'rspec'
 
 gem 'rubocop'
+gem 'rubocop-performance'
 gem 'rubocop-rails'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'

data/README.md

@@ -121,6 +121,24 @@ This command populates the `search_indices` table with existing data from your m
 results = Article.full_text_search("Ruby on Rails")
 ```
 
+`full_text_search` uses MySQL's natural-language full-text search. Use
+`boolean_full_text_search` when you need operators such as `+` for required
+terms, `-` for excluded terms, or quotes and wildcards supported by MySQL's
+boolean full-text syntax:
+
+```ruby
+results = Article.boolean_full_text_search("+Ruby +Rails -legacy")
+```
+
+Both scopes support searching one or more search-index columns:
+
+```ruby
+results = Product.boolean_full_text_search(
+  "+Ruby +Rails",
+  search_column: %i[content seller_extra]
+)
+```
+
 **That’s it!** Users now get fast, scalable, and relevant search—no complex SQL, external services, or maintenance headaches.
 
 ## Advanced Scenarios: Multi-Column Search for Roles and Contexts
@@ -213,6 +231,13 @@ MySQL::Search.configure do |config|
   # Path to search source classes (default: 'app/search_sources')
   config.sources_path = 'app/search_sources'
 
+  # Automatically load source classes on Rails startup (default: true)
+  # Loading of source classes assigns callbacks to the target models
+  # to keep the search index updated. In case of loading issue you can load
+  # the source classes manually with `MySQL::Search.load_source_classes!`
+  # and disable automatic initialization.
+  config.autoload_sources = true
+
   # Automatically update search index when models change (default: true)
   config.automatic_update = true
 
@@ -224,6 +249,9 @@ MySQL::Search.configure do |config|
 
   # Calendar week format (default: 'week %V')
   config.calendar_week_format = 'week %V'
+
+  # Register custom formatters
+  config.register_format(:upcase) { |value| value.to_s.upcase }
 end
 ```
 
@@ -237,7 +265,7 @@ end
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update `spec.version` in `activerecord-mysql-search.gemspec`, commit the change, and then run `bundle exec rake release`. This creates a git tag for the version, pushes the commit and tag, and pushes the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/activerecord-mysql-search.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = 'activerecord-mysql-search'
-  spec.version = '0.2.0'
+  spec.version = '0.2.3'
   spec.authors = ['Daydream Unicorn GmbH & Co. KG']
   spec.email = ['hello@daydreamunicorn.com']
 

data/gemfiles/rails_7.0.gemfile

@@ -13,8 +13,10 @@ gem 'rails', '~> 7.0.0'
 gem 'rake', '~> 13.0'
 gem 'rspec'
 gem 'rubocop'
+gem 'rubocop-performance'
 gem 'rubocop-rails'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
+gem 'ruby-lsp'
 
 gemspec path: '../'

data/gemfiles/rails_7.1.gemfile

@@ -12,8 +12,10 @@ gem 'rails', '~> 7.1.0'
 gem 'rake', '~> 13.0'
 gem 'rspec'
 gem 'rubocop'
+gem 'rubocop-performance'
 gem 'rubocop-rails'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
+gem 'ruby-lsp'
 
 gemspec path: '../'

data/gemfiles/rails_7.2.gemfile

@@ -12,8 +12,10 @@ gem 'rails', '~> 7.2.0'
 gem 'rake', '~> 13.0'
 gem 'rspec'
 gem 'rubocop'
+gem 'rubocop-performance'
 gem 'rubocop-rails'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
+gem 'ruby-lsp'
 
 gemspec path: '../'

data/gemfiles/rails_8.0.gemfile

@@ -12,8 +12,10 @@ gem 'rails', '~> 8.0.0'
 gem 'rake', '~> 13.0'
 gem 'rspec'
 gem 'rubocop'
+gem 'rubocop-performance'
 gem 'rubocop-rails'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
+gem 'ruby-lsp'
 
 gemspec path: '../'

data/gemfiles/rails_8.1.gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This file was generated by Appraisal
+
+source 'https://rubygems.org'
+
+gem 'appraisal'
+gem 'database_cleaner-active_record'
+gem 'mysql2'
+gem 'pry'
+gem 'rails', '~> 8.1.0'
+gem 'rake', '~> 13.0'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-performance'
+gem 'rubocop-rails'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'ruby-lsp'
+
+gemspec path: '../'

data/lib/generators/mysql/search/templates/config/initializers/active_record_ext.rb

@@ -15,11 +15,7 @@ module ActiveRecord
         add_column table_name, :updated_at, 'DATETIME ON UPDATE CURRENT_TIMESTAMP', **options
       end
     end
-  end
-end
 
-module ActiveRecord
-  module ConnectionAdapters
     # Overrides the `timestamps` method in `TableDefinition` to use MySQL's `DATETIME ON UPDATE CURRENT_TIMESTAMP`
     # for the `updated_at` column.
     # This allows the `updated_at` column to automatically update its value whenever the row is updated.

data/lib/generators/mysql/search/templates/config/initializers/mysql_search.rb

@@ -2,21 +2,31 @@
 
 # Configure MySQL::Search settings
 MySQL::Search.configure do |config|
-  # Defines the name of the search index activerecord model.
-  config.search_index_class_name = 'SearchIndex'
+  # Model class name for search indices (default: 'SearchIndex')
+  # config.search_index_class_name = 'SearchIndex'
 
-  # Location of the search sources folder
-  config.sources_path = 'app/search_sources'
+  # Path to search source classes (default: 'app/search_sources')
+  # config.sources_path = 'app/search_sources'
 
-  # Enables the search index to be automatically updated via source and nested models callbacks "on save"
-  config.automatic_update = true
+  # Automatically load source classes on Rails startup (default: true)
+  # Loading of source classes assigns callbacks to the target models
+  # to keep the search index updated. In case of loading issue you can load
+  # the source classes manually with `MySQL::Search.load_source_classes!`
+  # and disable automatic initialization.
+  # config.autoload_sources = true
 
-  # Use ActiveJob to update the search index in the background
-  config.update_asyncronously = true
+  # Automatically update search index when models change (default: true)
+  # config.automatic_update = true
 
-  # Defines the format for `calendar_week` formatter.
-  config.calendar_week_format = 'week %W'
+  # Process index updates asynchronously (default: false)
+  # config.update_asyncronously = false
 
-  # Defines the format for `date` formater.
-  config.date_format = '%d.%m.%Y'
+  # Date format for date fields (default: '%d.%m.%Y')
+  # config.date_format = '%d.%m.%Y'
+
+  # Calendar week format (default: 'week %V')
+  # config.calendar_week_format = 'week %V'
+
+  # Register custom formatters
+  # config.register_format(:upcase) { |value| value.to_s.upcase }
 end

data/lib/mysql/search/extensions/arel_against.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'arel'
+
+module Arel
+  module Visitors
+    # Custom visitor for MySQL to handle the `AGAINST` clause in full-text search.
+    class MySQL
+      def visit_Arel_Nodes_Against(node, collector) # rubocop:disable Naming/MethodName
+        visit(node.left, collector) << ' AGAINST ('
+        visit(node.right, collector)
+        collector << ' IN BOOLEAN MODE' if node.boolean_mode?
+        collector << ')'
+      end
+    end
+  end
+
+  module Nodes
+    # Represents the `AGAINST` clause used in MySQL full-text search queries.
+    class Against < Arel::Nodes::Matches
+      def initialize(left, right, boolean_mode: false)
+        super(left, right)
+        @boolean_mode = boolean_mode
+      end
+
+      def boolean_mode?
+        @boolean_mode
+      end
+    end
+  end
+
+  # Adds a method to the `Arel::Nodes::Node` class to allow for full-text search queries.
+  module Predications
+    def against(other, boolean_mode: false)
+      Arel::Nodes::Against.new(self, quoted_node(other), boolean_mode: boolean_mode)
+    end
+  end
+end

data/lib/mysql/search/queries/boolean_full_text_search_query.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'full_text_search_query'
+
+module MySQL
+  module Search
+    module Queries
+      # BooleanFullTextSearchQuery builds MySQL boolean full-text search queries.
+      class BooleanFullTextSearchQuery < FullTextSearchQuery
+        private
+
+        def search_expression(search_term, search_column)
+          search_indices = ::MySQL::Search.search_index_class_name.constantize.arel_table
+          search_columns = Array.wrap(search_column).map { |col| search_indices[col] }
+
+          Arel::Nodes::NamedFunction.new('MATCH', search_columns).against(search_term, boolean_mode: true)
+        end
+      end
+    end
+  end
+end

data/lib/mysql/search/queries/full_text_search_query.rb

@@ -1,35 +1,6 @@
 # frozen_string_literal: true
 
-require 'arel'
-
-module Arel
-  module Visitors
-    # Custom visitor for MySQL to handle the `AGAINST` clause in full-text search.
-    class MySQL
-      def visit_Arel_Nodes_Against(node, collector) # rubocop:disable Naming/MethodName
-        visit(node.left, collector) << ' AGAINST ('
-        visit(node.right, collector) << ')'
-      end
-    end
-  end
-end
-
-module Arel
-  module Nodes
-    # Represents the `AGAINST` clause used in MySQL full-text search queries.
-    class Against < Arel::Nodes::Matches
-    end
-  end
-end
-
-module Arel
-  # Adds a method to the `Arel::Nodes::Node` class to allow for full-text search queries.
-  module Predications
-    def against(other)
-      Arel::Nodes::Against.new(self, quoted_node(other))
-    end
-  end
-end
+require_relative '../extensions/arel_against'
 
 module MySQL
   module Search

data/lib/mysql/search/queries/updated_sources_query.rb

@@ -14,24 +14,37 @@ module MySQL
 
         def call(time_ago)
           joins_args = source_class_name.constantize.joins_args
-          relation = source_relation.left_joins(joins_args).where(updated_at: time_ago..)
+          base_relation = source_relation.left_joins(joins_args)
+          relation = base_relation.where(source_relation.klass.arel_table[:updated_at].gteq(time_ago))
 
-          append_conditions(relation, source_relation, joins_args, time_ago)
+          append_conditions(relation, source_relation.klass, joins_args, time_ago, base_relation)
         end
 
         private
 
-        def append_conditions(relation, root_class, config, time_ago)
+        def append_conditions(relation, root_class, config, time_ago, base_relation)
           case config
-          when Array then config.reduce(relation) { |rel, item| append_conditions(rel, root_class, item, time_ago) }
+          when Array
+            append_array_conditions(relation, root_class, config, time_ago, base_relation)
           when Hash
-            relation = append_conditions(relation, root_class, config.keys, time_ago)
-
-            config.reduce(relation) do |rel, (root_association, nested_config)|
-              append_conditions(rel, association_class(root_class, root_association), nested_config, time_ago)
-            end
+            append_hash_conditions(relation, root_class, config, time_ago, base_relation)
           else
-            append_or(relation, association_class(root_class, config), time_ago)
+            append_or(relation, association_class(root_class, config), time_ago, base_relation)
+          end
+        end
+
+        def append_array_conditions(relation, root_class, config, time_ago, base_relation)
+          config.reduce(relation) do |rel, item|
+            append_conditions(rel, root_class, item, time_ago, base_relation)
+          end
+        end
+
+        def append_hash_conditions(relation, root_class, config, time_ago, base_relation)
+          relation = append_conditions(relation, root_class, config.keys, time_ago, base_relation)
+
+          config.reduce(relation) do |rel, (root_association, nested_config)|
+            append_conditions(rel, association_class(root_class, root_association), nested_config, time_ago,
+                              base_relation)
           end
         end
 
@@ -39,10 +52,10 @@ module MySQL
           root_class.reflect_on_association(association).klass
         end
 
-        def append_or(relation, model, time_ago)
+        def append_or(relation, model, time_ago, base_relation)
           return relation unless model.column_names.include?('updated_at')
 
-          relation.or(model.where(updated_at: time_ago..))
+          relation.or(base_relation.where(model.arel_table[:updated_at].gteq(time_ago)))
         end
       end
     end

data/lib/mysql/search/railtie.rb

@@ -6,6 +6,10 @@ module MySQL
     class Railtie < Rails::Railtie
       railtie_name :mysql_search
 
+      config.to_prepare do
+        MySQL::Search.load_source_classes! if MySQL::Search.autoload_sources
+      end
+
       rake_tasks do
         load 'tasks/mysql/search/actualize.rake'
         load 'tasks/mysql/search/reindex.rake'

data/lib/mysql/search/searchable.rb

@@ -18,6 +18,10 @@ module MySQL
         scope :full_text_search, lambda { |search_term, search_column: :content|
           ::MySQL::Search::Queries::FullTextSearchQuery.new(self).call(search_term, search_column: search_column)
         }
+
+        scope :boolean_full_text_search, lambda { |search_term, search_column: :content|
+          ::MySQL::Search::Queries::BooleanFullTextSearchQuery.new(self).call(search_term, search_column: search_column)
+        }
       end
     end
   end

data/lib/mysql/search/utils/formatter.rb

@@ -7,9 +7,9 @@ module MySQL
       class Formatter
         attr_reader :value, :formatter
 
-        def self.register(name, &block)
+        def self.register(name, &)
           define_method(name) do
-            block.call(value)
+            yield(value)
           end
         end
 

data/lib/mysql/search.rb

@@ -7,6 +7,7 @@ require_relative 'search/searchable'
 require_relative 'search/source'
 require_relative 'search/queries/updated_sources_query'
 require_relative 'search/queries/full_text_search_query'
+require_relative 'search/queries/boolean_full_text_search_query'
 require_relative 'search/updater'
 require_relative 'search/utils'
 
@@ -18,6 +19,7 @@ module MySQL
     # Runtime configuration
     mattr_accessor :automatic_update, default: true
     mattr_accessor :update_asyncronously, default: false
+    mattr_accessor :autoload_sources, default: true
 
     # Search Index & Sources
     mattr_accessor :search_index_class_name, default: 'SearchIndex'
@@ -36,11 +38,16 @@ module MySQL
     end
 
     def source_classes
-      @source_classes ||= Dir.glob("#{sources_path}/**/*.rb").filter_map do |file|
+      Dir.glob("#{sources_path}/**/*.rb").filter_map do |file|
         file.sub("#{sources_path}/", '').sub('.rb', '').camelize.safe_constantize
       end
     end
 
+    # Keep a separate API entrypoint used by the Railtie initialization hook.
+    def load_source_classes!
+      source_classes
+    end
+
     def configure
       yield self
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-mysql-search
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Daydream Unicorn GmbH & Co. KG
@@ -32,6 +32,7 @@ files:
 - gemfiles/rails_7.1.gemfile
 - gemfiles/rails_7.2.gemfile
 - gemfiles/rails_8.0.gemfile
+- gemfiles/rails_8.1.gemfile
 - lib/activerecord-mysql-search.rb
 - lib/generators/mysql/search/create_trigger_generator.rb
 - lib/generators/mysql/search/install_generator.rb
@@ -42,10 +43,12 @@ files:
 - lib/generators/mysql/search/templates/db/migrate/enable_auto_update_of_updated_at.rb
 - lib/mysql/search.rb
 - lib/mysql/search/callbacks.rb
+- lib/mysql/search/extensions/arel_against.rb
 - lib/mysql/search/grabber.rb
 - lib/mysql/search/jobs.rb
 - lib/mysql/search/jobs/scheduled_updater_job.rb
 - lib/mysql/search/jobs/updater_job.rb
+- lib/mysql/search/queries/boolean_full_text_search_query.rb
 - lib/mysql/search/queries/full_text_search_query.rb
 - lib/mysql/search/queries/updated_sources_query.rb
 - lib/mysql/search/railtie.rb
@@ -79,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Full Text Search for ActiveRecord with MySQL
 test_files: []