activerecord-mysql-search 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c41e02668032b01baac019990ad3ecd0c71ffb344c7f0a91fac8fce768228fb
-  data.tar.gz: e489ceecc065d10b4ce3091d52d9a5d3df34900e9e8ee26aff73632ba131bfff
+  metadata.gz: bf223abbfa9e47d49642b4f8f52d05eb60256749f6f1ca22b40f9a17db7aad57
+  data.tar.gz: 197c6c7c9c15de41a0ed7bd3578a988be3beb366acac94f249e1aa0315747728
 SHA512:
-  metadata.gz: 8d9e87974524b8389599b691b7180a7c0d674e76960e6f28478abc7d6d3d28ab577a303294436f48aff8cb6521dd1ea3536fbc99a04ca54912d574b2b7754b87
-  data.tar.gz: 0b58f3cbe89df20425d5181469f12b00ca07e5642217c355ddf805b9586272c49957c6fc5a472d0f552fdff24c2a47996c83d6549d8c7b8ec87fec102167a0e4
+  metadata.gz: 225730631d733499a6fe947fc8c90ed27f61441939206516f54b5bc951c520130692ffdab155ca072a2986fc9c6d6e2f4bd6e1d10f302be15aca133402dd2d5e
+  data.tar.gz: 5475a8bd4aaf08b71c694814abcee48ca74bbf28514e20085ab34cf12ae4f1418e0dee2b57578a97134de1d687d7efd6d79f004bc429b2c2fe7dabc01b6f30de

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,5 +1,31 @@
 ## [Unreleased]
 
+## [0.2.1] - 2026-07-15
+
+- 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.2.0] - 2025-09-25
+
+- 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.1.2] - 2025-08-12
+
+- 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,9 @@ gem 'database_cleaner-active_record'
 gem 'rspec'
 
 gem 'rubocop'
+gem 'rubocop-performance'
 gem 'rubocop-rails'
 gem 'rubocop-rake'
 gem 'rubocop-rspec'
+
+gem 'ruby-lsp'

data/README.md

@@ -89,14 +89,23 @@ class ArticleSource < MySQL::Search::Source
 end
 ```
 
-**Available Formatters **
+#### Available Formatters
 
 - **`:text`** - Extracts text content from the field
 - **`:date`** - Formats dates using the configured date format (e.g., "12.01.2025", format is configurable)
 - **`:calendar_week`** - Extracts calendar week information (e.g., "week 42", format is configurable)
 - **`Proc`** - Custom extraction logic with access to the attribute value
 - **Nested Associations** - Supports nested associations
-- **Your formatters**. Check the [source code](lib/mysql/search/utils/formatter.rb) for more details.
+
+#### Registering new formatters
+
+You can register new formatters using the `register_format` method:
+
+```ruby
+MySQL::Search.configure do |config|
+  config.register_format(:upcase) { |value| value.to_s.upcase }
+end
+```
 
 ### Step 6: Index Existing Data
 
@@ -204,6 +213,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
 
@@ -215,6 +231,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
 ```
 

data/activerecord-mysql-search.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = 'activerecord-mysql-search'
-  spec.version = '0.1.3'
+  spec.version = '0.2.1'
   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,28 @@
+# 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
+
+  module Nodes
+    # Represents the `AGAINST` clause used in MySQL full-text search queries.
+    class Against < Arel::Nodes::Matches
+    end
+  end
+
+  # 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

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
@@ -59,7 +30,6 @@ module MySQL
         private
 
         def search_expression(search_term, search_column)
-          search_term = ::MySQL::Search::Utils::TextNormalizer.normalize(search_term)
           search_indices = ::MySQL::Search.search_index_class_name.constantize.arel_table
           search_columns = Array.wrap(search_column).map { |col| search_indices[col] }
 

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/utils/formatter.rb

@@ -7,6 +7,12 @@ module MySQL
       class Formatter
         attr_reader :value, :formatter
 
+        def self.register(name, &)
+          define_method(name) do
+            yield(value)
+          end
+        end
+
         def initialize(value, formatter)
           if formatter.instance_of?(Proc)
             @value = formatter.call(value)
@@ -20,13 +26,13 @@ module MySQL
         end
 
         def format
-          formatter ? send(formatter) : value
+          (formatter ? send(formatter) : value).to_s.strip
         end
 
         private
 
         def text
-          TextNormalizer.normalize(value.to_s)
+          value
         end
 
         def calendar_week

data/lib/mysql/search/utils.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'utils/formatter'
-require_relative 'utils/text_normalizer'
 require_relative 'utils/duration_parser'
 
 module MySQL

data/lib/mysql/search.rb

@@ -18,6 +18,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'
@@ -27,16 +28,25 @@ module MySQL
     mattr_accessor :calendar_week_format, default: 'week %V'
     mattr_accessor :date_format, default: '%d.%m.%Y'
 
+    def register_format(name, &)
+      Utils::Formatter.register(name, &)
+    end
+
     def search_index_class
       @search_index_class ||= search_index_class_name.constantize
     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.1.3
+  version: 0.2.1
 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,6 +43,7 @@ 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
@@ -55,7 +57,6 @@ files:
 - lib/mysql/search/utils.rb
 - lib/mysql/search/utils/duration_parser.rb
 - lib/mysql/search/utils/formatter.rb
-- lib/mysql/search/utils/text_normalizer.rb
 - lib/tasks/mysql/search/actualize.rake
 - lib/tasks/mysql/search/reindex.rake
 homepage: https://github.com/ddunicorn/activerecord-mysql-search.rubygem/blob/main/README.md
@@ -80,7 +81,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: []

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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module MySQL
-  module Search
-    module Utils
-      # Normalizes text by removing non-alphanumeric characters, except for spaces and hyphens.
-      class TextNormalizer
-        REGEXP = /[[:alnum:][:blank:]+\-*~<>()"@\.]/
-
-        def self.normalize(value)
-          value.to_s.scan(REGEXP).join.squish
-        end
-      end
-    end
-  end
-end