thinking-sphinx 5.3.0 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55eace64045aea4431c8a86005e70485efacfb15cc6768098c19fa89c4098d8c
-  data.tar.gz: e13db8a3a331535dd73aed4ffb965a130fdf8ae57df4241cafb4c6e1b421305f
+  metadata.gz: 329b223375314de077fdec7d3cd62296d2adfe4a8e55edb8e69277c0b7c87d85
+  data.tar.gz: 4cbe73eb983ecc5f381f9acb381ad65df467804165f821d3a9b4214c236c6de6
 SHA512:
-  metadata.gz: 7a9d79a7a86ca0c6f9968bae9c980049174626d12d44b8cafa73139be5bf24c66d3675a5e16a3a104d5b04ce76b1a0e136e2cc788338c142107af9354eca8e7d
-  data.tar.gz: be890cb3de5d4a5885c6bcc213349bfb656567f2b4cc63decabbd608bf7004126358fd13b42e6b3a6271e25db19f85c2dc061ed2c1b862e7f968276fa7632377
+  metadata.gz: 1f7d91602bbe643ae99c2c9cfd70c9fb0aa446948eb2dfb19afbf78ed9b879ec2a817e59e7965051147e94fe574c4df398e68256a720f5f0946f0f474e1e671e
+  data.tar.gz: 97ab152f9f16acb69a59f0a3935882306923658ef628873b0ec7913bd3a872f8f8a2739c6ed31d1b73907ed746149f23f925e1fdace06b7688a202920ab96dad

data/.circleci/config.yml

@@ -7,77 +7,23 @@ workflows:
   test:
     jobs:
       - test:
-          name: "Sphinx 2.2.11 with MySQL"
-          database: mysql2
+          name: "Sphinx 2.2"
           sphinx_version: 2.2.11
           sphinx_engine: sphinx
           debian: jessie
           ruby: '2.4.6'
-      - test:
-          name: "Sphinx 2.2.11 with PostgreSQL"
-          database: postgresql
-          sphinx_version: 2.2.11
-          sphinx_engine: sphinx
-          debian: jessie
-          ruby: '2.4.6'
-      - test:
-          name: "Sphinx 3.3.1 with MySQL"
-          database: mysql2
-          sphinx_version: 3.3.1
-          sphinx_engine: sphinx
-          debian: buster
-          matrix:
-            parameters:
-              ruby: [ '2.4.9', '2.5.8', '2.6.6', '2.7.2', '3.0.0' ]
-      # - test:
-      #     database: postgresql
-      #     sphinx_version: 3.3.1
-      #     sphinx_engine: sphinx
-      #     matrix:
-      #       parameters:
-      #         ruby: [ '2.4', '2.5', '2.6', '2.7' ]
-      - test:
-          name: "Manticore 2.8.2 with MySQL"
-          database: mysql2
-          sphinx_version: 2.8.2
-          sphinx_engine: manticore
-          debian: stretch
           matrix:
             parameters:
-              ruby: [ '2.4.9', '2.5.8', '2.6.6' ]
-      - test:
-          name: "Manticore 2.8.2 with PostgreSQL"
-          database: postgresql
-          sphinx_version: 2.8.2
-          sphinx_engine: manticore
-          debian: stretch
-          matrix:
-            parameters:
-              ruby: [ '2.4.9', '2.5.8', '2.6.6' ]
-      - test:
-          name: "Manticore 3.5.4 with MySQL"
-          database: mysql2
-          sphinx_version: 3.5.4
-          sphinx_engine: manticore
-          debian: buster
-          matrix:
-            parameters:
-              ruby: [ '2.4.9', '2.5.8', '2.6.6', '2.7.2', '3.0.0' ]
-      - test:
-          name: "Manticore 3.5.4 with PostgreSQL"
-          database: postgresql
-          sphinx_version: 3.5.4
-          sphinx_engine: manticore
-          debian: buster
-          matrix:
-            parameters:
-              ruby: [ '2.4.9', '2.5.8', '2.6.6', '2.7.2', '3.0.0' ]
+              database: [ 'mysql2', 'postgresql' ]
+              rails: [ '4_2', '5_0', '5_1', '5_2' ]
 
 jobs:
   test:
     parameters:
       ruby:
         type: string
+      rails:
+        type: string
       database:
         type: string
       sphinx_version:
@@ -108,18 +54,12 @@ jobs:
 
       - restore_cache:
           keys:
-            - v1-dependencies-<< parameters.ruby >>
+            - v1-dependencies-<< parameters.ruby >>-<< parameters.rails >>
 
       - run:
           name: install bundler
           command: |
-            if [ "<< parameters.ruby >>" == "2.7.2" ]; then
-              export BUNDLER_VERSION=2.1.4
-            elif [ "<< parameters.ruby >>" == "3.0.0" ]; then
-              export BUNDLER_VERSION=2.1.4
-            else
-              export BUNDLER_VERSION=1.17.3
-            fi
+            export BUNDLER_VERSION=1.17.3
             export BUNDLE_PATH=vendor/bundle
             gem install bundler:$BUNDLER_VERSION
 
@@ -131,12 +71,18 @@ jobs:
 
       - run:
           name: set up appraisal
-          command: bundle exec appraisal update
+          command: bundle exec appraisal generate
+
+      - run:
+          name: update gems
+          environment:
+            BUNDLE_GEMFILE: "./gemfiles/rails_<< parameters.rails >>.gemfile"
+          command: bundle update
 
       - save_cache:
           paths:
             - ./vendor/bundle
-          key: v1-dependencies-<< parameters.ruby >>
+          key: v1-dependencies-<< parameters.ruby >>-<< parameters.rails >>
 
       - run:
           name: set up sphinx
@@ -149,4 +95,5 @@ jobs:
             DATABASE: << parameters.database >>
             SPHINX_VERSION: << parameters.sphinx_version >>
             SPHINX_ENGINE: << parameters.sphinx_engine >>
-          command: bundle exec appraisal rspec
+            BUNDLE_GEMFILE: "./gemfiles/rails_<< parameters.rails >>.gemfile"
+          command: bundle exec rspec

data/.github/actions/test/action.yml

@@ -0,0 +1,46 @@
+name: "Test"
+description: "Run RSpec in given environment"
+inputs:
+  ruby-version:
+    description: "Ruby version"
+    required: true
+  rails-version:
+    description: "Rails version"
+    required: true
+  sphinx-version:
+    description: "Sphinx version"
+    required: true
+  sphinx-engine:
+    description: "Sphinx engine"
+    required: true
+  database:
+    description: "Database engine"
+    required: true
+runs:
+  using: "composite"
+  steps:
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ inputs.ruby-version }}
+        bundler-cache: true
+    - name: Set up Sphinx
+      shell: bash
+      run: |
+        ./bin/loadsphinx ${{ inputs.sphinx-version }} ${{ inputs.sphinx-engine }}
+    - name: Set up Appraisal
+      shell: bash
+      run: "bundle exec appraisal generate"
+    - name: Install Appraisal's gems
+      shell: bash
+      env:
+        BUNDLE_GEMFILE: "gemfiles/rails_${{ inputs.rails-version }}.gemfile"
+      run: bundle install
+    - name: Test
+      shell: bash
+      env:
+        CI: "true"
+        DATABASE: ${{ inputs.database }}
+        SPHINX_VERSION: ${{ inputs.sphinx-version }}
+        SPHINX_ENGINE: ${{ inputs.sphinx-engine }}
+        BUNDLE_GEMFILE: "gemfiles/rails_${{ inputs.rails-version }}.gemfile"
+      run: "bundle exec rspec"

data/.github/workflows/ci.yml

@@ -0,0 +1,122 @@
+name: test
+
+on: [push, pull_request]
+
+jobs:
+  sphinx:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ 'ubuntu-18.04' ]
+        ruby: [ '2.7', '3.0', '3.1', '3.2' ]
+        rails: [ '5_0', '5_1', '5_2', '6_0', '6_1', '7_0' ]
+        database: [ 'mysql2', 'postgresql' ]
+        sphinx_version: [ '3.4.1' ]
+        sphinx_engine: [ 'sphinx' ]
+        exclude:
+          - database: 'postgresql'
+            sphinx_version: '3.4.1'
+            sphinx_engine: 'sphinx'
+          - ruby: '3.0'
+            rails: '5_0'
+          - ruby: '3.0'
+            rails: '5_1'
+          - ruby: '3.0'
+            rails: '5_2'
+          - ruby: '3.1'
+            rails: '5_0'
+          - ruby: '3.1'
+            rails: '5_1'
+          - ruby: '3.1'
+            rails: '5_2'
+          - ruby: '3.2'
+            rails: '5_0'
+          - ruby: '3.2'
+            rails: '5_1'
+          - ruby: '3.2'
+            rails: '5_2'
+
+    services:
+      postgres:
+        image: postgres:10
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: thinking_sphinx
+          POSTGRES_DB: thinking_sphinx
+        ports: ['5432:5432']
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+      mysql:
+        image: mysql:5.7
+        env:
+          MYSQL_ROOT_PASSWORD: thinking_sphinx
+          MYSQL_DATABASE: thinking_sphinx
+        ports: ['3306:3306']
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./.github/actions/test
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          rails-version: ${{ matrix.rails }}
+          sphinx-version: ${{ matrix.sphinx_version }}
+          sphinx-engine: ${{ matrix.sphinx_engine }}
+          database: ${{ matrix.database }}
+        timeout-minutes: 12
+
+  manticore:
+    runs-on: ubuntu-20.04
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
+        rails: [ '5_0', '5_1', '5_2', '6_0', '6_1', '7_0' ]
+        database: [ 'mysql2', 'postgresql' ]
+        sphinx_version: [ '3.5.4', '4.0.2' ]
+        sphinx_engine: [ 'manticore' ]
+        exclude:
+          - ruby: '2.5'
+            rails: '7_0'
+          - ruby: '2.6'
+            rails: '7_0'
+          - ruby: '3.0'
+            rails: '5_0'
+          - ruby: '3.0'
+            rails: '5_1'
+          - ruby: '3.0'
+            rails: '5_2'
+
+    services:
+      postgres:
+        image: postgres:10
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: thinking_sphinx
+          POSTGRES_DB: thinking_sphinx
+        ports: ['5432:5432']
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+      mysql:
+        image: mysql:8.0
+        env:
+          MYSQL_ROOT_PASSWORD: thinking_sphinx
+          MYSQL_DATABASE: thinking_sphinx
+        ports: ['3306:3306']
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./.github/actions/test
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          rails-version: ${{ matrix.rails }}
+          sphinx-version: ${{ matrix.sphinx_version }}
+          sphinx-engine: ${{ matrix.sphinx_engine }}
+          database: ${{ matrix.database }}
+        timeout-minutes: 12

data/.gitignore

@@ -1,11 +1,13 @@
 *.gem
+*.sublime-*
 .bundle
+.overmind.env
 .rbx
 .rspec
 .tool-versions
+data/*
 gemfiles
 Gemfile.lock
-*.sublime-*
 pkg/*
 spec/internal/config/test.sphinx.conf
 spec/internal/db/sphinx

data/Appraisals

@@ -39,3 +39,9 @@ appraise 'rails_6_1' do
   gem 'mysql2', '~> 0.5.0', :platform => :ruby
   gem 'pg',     '~> 1.0',   :platform => :ruby
 end if RUBY_PLATFORM != 'java' && RUBY_VERSION.to_f >= 2.5
+
+appraise 'rails_7_0' do
+  gem 'rails',  '~> 7.0.0'
+  gem 'mysql2', '~> 0.5.0', :platform => :ruby
+  gem 'pg',     '~> 1.0',   :platform => :ruby
+end if RUBY_PLATFORM != 'java' && RUBY_VERSION.to_f >= 2.7

data/CHANGELOG.markdown

@@ -2,6 +2,42 @@
 
 All notable changes to this project (at least, from v3.0.0 onwards) are documented in this file.
 
+## 5.5.0 - 2022-12-30
+
+[Release Notes](https://github.com/pat/thinking-sphinx/releases/tag/v5.5.0)
+
+### Added
+
+* ThinkingSphinx::Processor, a public interface to perform index-related operations on model instances or model name/id combinations. In collaboration with @akostadinov ([#1215](https://github.com/pat/thinking-sphinx/issues/1215)).
+
+### Changed
+
+* Confirmed support by testing against Ruby 3.1 and 3.2 by @jdelStrother ([#1237](https://github.com/pat/thinking-sphinx/pull/1237)).
+
+### Fixed
+
+* Fix YAML loading, by @aepyornis ([#1217](https://github.com/pat/thinking-sphinx/pull/1217)).
+* Further fixes for File.exist? instead of the deprecated File.exists?, by @funsim ([#1221](https://github.com/pat/thinking-sphinx/pull/1221)) and @graaf ([1233](https://github.com/pat/thinking-sphinx/pull/1233)).
+* Treat unknown column errors as QueryErrors, so retrying the query occurs automatically.
+* Fix MariaDB error handling.
+
+## 5.4.0 - 2021-12-21
+
+[Release Notes](https://github.com/pat/thinking-sphinx/releases/tag/v5.4.0)
+
+### Added
+
+* Rails 7 support, including contributions from @anthonyshull in [#1205](https://github.com/pat/thinking-sphinx/pull/1205).
+
+### Changed
+
+* Confirmed support by testing against Manticore 4.0 and Sphinx 3.4.
+
+### Fixed
+
+* Include instance_exec in ThinkingSphinx::Search::CORE_METHODS by @jdelStrother in [#1210](https://github.com/pat/thinking-sphinx/pull/1210).
+* Use File.exist? instead of the deprecated File.exists? ([#1211](https://github.com/pat/thinking-sphinx/issues/1211)).
+
 ## 5.3.0 - 2021-08-19
 
 [Release Notes](https://github.com/pat/thinking-sphinx/releases/tag/v5.3.0)

data/Gemfile

@@ -7,6 +7,8 @@ gemspec
 gem 'mysql2', '~> 0.5.0',  :platform => :ruby
 gem 'pg',     '~> 0.18.4', :platform => :ruby
 
+gem 'activerecord', '< 7' if RUBY_VERSION.to_f <= 2.4
+
 if RUBY_PLATFORM == 'java'
   gem 'jdbc-mysql',                          '5.1.35',    :platform => :jruby
   gem 'activerecord-jdbcmysql-adapter',      '>= 1.3.23', :platform => :jruby

data/Procfile.support

@@ -0,0 +1,2 @@
+postgres: postgres -D data/postgres -p ${POSTGRES_PORT:-5432}
+mysql: $(brew --prefix mysql@5.7)/bin/mysqld --datadir=$(PWD)/data/mysql --port ${MYSQL_PORT:-3306} --socket=mysql.sock

data/README.textile

@@ -1,6 +1,6 @@
 h1. Thinking Sphinx
 
-Thinking Sphinx is a library for connecting ActiveRecord to the Sphinx full-text search tool, and integrates closely with Rails (but also works with other Ruby web frameworks). The current release is v5.3.0.
+Thinking Sphinx is a library for connecting ActiveRecord to the Sphinx full-text search tool, and integrates closely with Rails (but also works with other Ruby web frameworks). The current release is v5.5.0.
 
 h2. Upgrading
 
@@ -14,7 +14,7 @@ It's a gem, so install it like you would any other gem. You will also need to sp
 
 <pre><code>gem 'mysql2',          '~> 0.4',    :platform => :ruby
 gem 'jdbc-mysql',      '~> 5.1.35', :platform => :jruby
-gem 'thinking-sphinx', '~> 5.3'</code></pre>
+gem 'thinking-sphinx', '~> 5.5'</code></pre>
 
 The MySQL gems mentioned are required for connecting to Sphinx, so please include it even when you're using PostgreSQL for your database.
 
@@ -29,10 +29,10 @@ h2. Requirements
 The current release of Thinking Sphinx works with the following versions of its dependencies:
 
 |_. Library |_. Minimum |_. Tested Against |
-| Ruby | v2.4 | v2.4, v2.5, v2.6, v2.7, v3.0 |
-| Sphinx | v2.2.11 | v2.2.11, v3.3.1 |
-| Manticore | v2.8 | v2.8, v3.5 |
-| ActiveRecord | v4.2 | v4.2..v6.1 |
+| Ruby | v2.4 | v2.4, v2.5, v2.6, v2.7, v3.0, v3.1, v3.2 |
+| Sphinx | v2.2.11 | v2.2.11, v3.4.1 |
+| Manticore | v2.8 | v3.5, v4.0 |
+| ActiveRecord | v4.2 | v4.2..v7.0 |
 
 It _might_ work with older versions of Ruby, but it's highly recommended to update to a supported release.
 
@@ -40,7 +40,9 @@ It should also work with JRuby, but the test environment for that in CI has been
 
 h3. Sphinx or Manticore
 
-Thinking Sphinx is currently built for Sphinx 2.2.11 or newer, or Manticore v2.8+.
+If you're using Sphinx, v2.2.11 is recommended even though it's quite old, as it works well with PostgreSQL databases (but if you're using MySQL - or real-time indices - then v3.3.1 should also be fine).
+
+If you're opting for Manticore instead, v2.8 or newer works, but v3 or newer is recommended as that's what is actively tested against.
 
 h3. Rails and ActiveRecord
 
@@ -79,4 +81,4 @@ You can then run the unit tests with @rake spec:unit@, the acceptance tests with
 
 h2. Licence
 
-Copyright (c) 2007-2020, Thinking Sphinx is developed and maintained by Pat Allan, and is released under the open MIT Licence. Many thanks to "all who have contributed patches":https://github.com/pat/thinking-sphinx/contributors.
+Copyright (c) 2007-2022, Thinking Sphinx is developed and maintained by Pat Allan, and is released under the open MIT Licence. Many thanks to "all who have contributed patches":https://github.com/pat/thinking-sphinx/contributors.

data/bin/loadsphinx

@@ -28,6 +28,9 @@ load_sphinx () {
     3.3.1)
       url="http://sphinxsearch.com/files/sphinx-3.3.1-b72d67b-linux-amd64.tar.gz"
       format="gz";;
+    3.4.1)
+      url="http://sphinxsearch.com/files/sphinx-3.4.1-efbcc65-linux-amd64.tar.gz"
+      format="gz";;
     *)
       echo "No Sphinx version $version available"
       exit 1;;
@@ -63,12 +66,15 @@ load_manticore () {
     3.4.2)
       url="https://github.com/manticoresoftware/manticoresearch/releases/download/3.4.2/manticore_3.4.2-200410-6903305-release.xenial_amd64-bin.deb";;
     3.5.4)
-      url="https://repo.manticoresearch.com/repository/manticoresearch_buster/pool/m/manticore/manticore_3.5.4-201211-13f8d08d_amd64.deb";;
+      url="https://repo.manticoresearch.com/repository/manticoresearch_focal/dists/focal/main/binary-amd64/manticore_3.5.4-210107-f70faec5_amd64.deb";;
+    4.0.2)
+      url="https://repo.manticoresearch.com/repository/manticoresearch_focal/dists/focal/main/binary-amd64/manticore_4.0.2-210921-af497f245_amd64.deb";;
     *)
       echo "No Manticore version $version available"
       exit 1;;
   esac
 
+  sudo apt-get install default-libmysqlclient-dev
   curl --location $url -o manticore.deb
   sudo dpkg -i ./manticore.deb
   sudo apt-get install -f

data/lib/thinking_sphinx/active_record/callbacks/delete_callbacks.rb

@@ -20,18 +20,8 @@ class ThinkingSphinx::ActiveRecord::Callbacks::DeleteCallbacks <
   private
 
   def delete_from_sphinx
-    return if ThinkingSphinx::Callbacks.suspended? || instance.new_record?
+    return if ThinkingSphinx::Callbacks.suspended?
 
-    indices.each { |index|
-      ThinkingSphinx::Deletion.perform(
-        index, instance.public_send(index.primary_key)
-      )
-    }
-  end
-
-  def indices
-    ThinkingSphinx::Configuration.instance.index_set_class.new(
-      :instances => [instance], :classes => [instance.class]
-    ).to_a
+    ThinkingSphinx::Processor.new(instance: instance).delete
   end
 end

data/lib/thinking_sphinx/commands/clear_real_time.rb

@@ -7,7 +7,7 @@ class ThinkingSphinx::Commands::ClearRealTime < ThinkingSphinx::Commands::Base
       Dir["#{index.path}.*"].each { |path| FileUtils.rm path }
     end
 
-    FileUtils.rm_r(binlog_path) if File.exists?(binlog_path)
+    FileUtils.rm_r(binlog_path) if File.exist?(binlog_path)
   end
 
   private

data/lib/thinking_sphinx/configuration/minimum_fields.rb

@@ -6,8 +6,6 @@ class ThinkingSphinx::Configuration::MinimumFields
   end
 
   def reconcile
-    return unless no_inheritance_columns?
-
     field_collections.each do |collection|
       collection.fields.delete_if do |field|
         field.name == 'sphinx_internal_class_name'
@@ -20,7 +18,7 @@ class ThinkingSphinx::Configuration::MinimumFields
   attr_reader :indices
 
   def field_collections
-    indices_of_type('plain').collect(&:sources).flatten +
+    plain_indices_without_inheritance.collect(&:sources).flatten +
     indices_of_type('rt')
   end
 
@@ -28,10 +26,11 @@ class ThinkingSphinx::Configuration::MinimumFields
     indices.select { |index| index.type == type }
   end
 
-  def no_inheritance_columns?
-    indices.select { |index|
-      index.model.table_exists? &&
-      index.model.column_names.include?(index.model.inheritance_column)
-    }.empty?
+  def inheritance_columns?(index)
+    index.model.table_exists? && index.model.column_names.include?(index.model.inheritance_column)
+  end
+
+  def plain_indices_without_inheritance
+    indices_of_type('plain').reject(&method(:inheritance_columns?))
   end
 end

data/lib/thinking_sphinx/errors.rb

@@ -9,11 +9,11 @@ class ThinkingSphinx::SphinxError < StandardError
       replacement = ThinkingSphinx::ParseError.new(error.message)
     when /syntax error/
       replacement = ThinkingSphinx::SyntaxError.new(error.message)
-    when /query error/
+    when /query error/, /unknown column/
       replacement = ThinkingSphinx::QueryError.new(error.message)
-    when /Can't connect to MySQL server/,
+    when /Can't connect to( MySQL)? server/,
       /Communications link failure/,
-      /Lost connection to MySQL server/
+      /Lost connection to( MySQL)? server/
       replacement = ThinkingSphinx::ConnectionError.new(
         "Error connecting to Sphinx via the MySQL protocol. #{error.message}"
       )

data/lib/thinking_sphinx/guard/file.rb

@@ -12,7 +12,7 @@ class ThinkingSphinx::Guard::File
   end
 
   def locked?
-    File.exists? path
+    File.exist? path
   end
 
   def path

data/lib/thinking_sphinx/processor.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class ThinkingSphinx::Processor
+  def initialize(instance: nil, model: nil, id: nil)
+    raise ArgumentError if instance.nil? && (model.nil? || id.nil?)
+
+    @instance = instance
+    @model = model || instance.class
+    @id = id
+  end
+
+  def delete
+    return if instance&.new_record?
+
+    indices.each { |index|
+      ThinkingSphinx::Deletion.perform(
+        index, id || instance.public_send(index.primary_key)
+      )
+    }
+  end
+
+  def upsert
+    real_time_indices.each do |index|
+      ThinkingSphinx::RealTime::Transcriber.new(index).copy loaded_instance
+    end
+  end
+
+  private
+
+  attr_reader :instance, :model, :id
+
+  def indices
+    ThinkingSphinx::Configuration.instance.index_set_class.new(
+      :instances => [instance].compact, :classes => [model]
+    ).to_a
+  end
+
+  def loaded_instance
+    @loaded_instance ||= instance || model.find(id)
+  end
+
+  def real_time_indices
+    indices.select { |index| index.is_a? ThinkingSphinx::RealTime::Index }
+  end
+end

data/lib/thinking_sphinx/railtie.rb

@@ -14,8 +14,7 @@ class ThinkingSphinx::Railtie < Rails::Railtie
       require 'thinking_sphinx/active_record'
     end
 
-    if ActiveSupport::VERSION::MAJOR > 5 &&
-      Rails.application.config.autoloader == :zeitwerk
+    if zeitwerk?
       ActiveSupport::Dependencies.autoload_paths.delete(
         Rails.root.join("app", "indices").to_s
       )
@@ -29,4 +28,11 @@ class ThinkingSphinx::Railtie < Rails::Railtie
   rake_tasks do
     load File.expand_path('../tasks.rb', __FILE__)
   end
+
+  def zeitwerk?
+    return true if ActiveSupport::VERSION::MAJOR >= 7
+    return false if ActiveSupport::VERSION::MAJOR <= 5
+
+    Rails.application.config.autoloader == :zeitwerk
+  end
 end

data/lib/thinking_sphinx/search.rb

@@ -2,7 +2,7 @@
 
 class ThinkingSphinx::Search < Array
   CORE_METHODS = %w( == class class_eval extend frozen? id instance_eval
-    instance_of? instance_values instance_variable_defined?
+    instance_exec instance_of? instance_values instance_variable_defined?
     instance_variable_get instance_variable_set instance_variables is_a?
     kind_of? member? method methods nil? object_id respond_to?
     respond_to_missing? send should should_not type )

data/lib/thinking_sphinx/settings.rb

@@ -22,6 +22,9 @@ class ThinkingSphinx::Settings
     "maximum_statement_length" => (2 ** 23) - 5,
     "real_time_tidy"           => false
   }.freeze
+  YAML_SAFE_LOAD = YAML.method(:safe_load).parameters.any? do |parameter|
+    parameter == [:key, :aliases]
+  end
 
   def self.call(configuration)
     new(configuration).call
@@ -32,7 +35,7 @@ class ThinkingSphinx::Settings
   end
 
   def call
-    return defaults unless File.exists? file
+    return defaults unless File.exist? file
 
     merged.inject({}) do |hash, (key, value)|
       if absolute_key?(key)
@@ -97,11 +100,7 @@ class ThinkingSphinx::Settings
   end
 
   def original
-    input = File.read file
-    input = ERB.new(input).result if defined?(ERB)
-
-    contents = YAML.load input
-    contents && contents[framework.environment] || {}
+    yaml_contents && yaml_contents[framework.environment] || {}
   end
 
   def real_path(base, nonexistent = nil)
@@ -112,4 +111,17 @@ class ThinkingSphinx::Settings
       real_path components.first, join(components.last, nonexistent)
     end
   end
+
+  def yaml_contents
+    @yaml_contents ||= begin
+      input = File.read file
+      input = ERB.new(input).result if defined?(ERB)
+
+      if YAML_SAFE_LOAD
+        YAML.safe_load(input, aliases: true)
+      else
+        YAML.load(input)
+      end
+    end
+  end
 end

data/lib/thinking_sphinx/test.rb

@@ -42,7 +42,7 @@ class ThinkingSphinx::Test
       config.indices_location,
       config.searchd.binlog_path
     ].each do |path|
-      FileUtils.rm_r(path) if File.exists?(path)
+      FileUtils.rm_r(path) if File.exist?(path)
     end
   end
 

data/lib/thinking_sphinx.rb

@@ -86,6 +86,7 @@ require 'thinking_sphinx/interfaces'
 require 'thinking_sphinx/masks'
 require 'thinking_sphinx/middlewares'
 require 'thinking_sphinx/panes'
+require 'thinking_sphinx/processor'
 require 'thinking_sphinx/query'
 require 'thinking_sphinx/rake_interface'
 require 'thinking_sphinx/scopes'

data/spec/acceptance/attribute_access_spec.rb

@@ -20,7 +20,11 @@ describe 'Accessing attributes directly via search results', :live => true do
     search = Book.search 'gods', :select => "*, weight()"
     search.context[:panes] << ThinkingSphinx::Panes::WeightPane
 
-    expect(search.first.weight).to eq(2500)
+    if ENV["SPHINX_ENGINE"] == "sphinx" && ENV["SPHINX_VERSION"].to_f > 3.3
+      expect(search.first.weight).to eq(20_000.0)
+    else
+      expect(search.first.weight).to eq(2500)
+    end
   end
 
   it "provides direct access to the weight with alternative primary keys" do
@@ -39,7 +43,11 @@ describe 'Accessing attributes directly via search results', :live => true do
     search = Book.search 'gods', :select => "*, weight()"
     search.masks << ThinkingSphinx::Masks::WeightEnumeratorMask
 
-    expectations = [[gods, 2500]]
+    if ENV["SPHINX_ENGINE"] == "sphinx" && ENV["SPHINX_VERSION"].to_f > 3.3
+      expectations = [[gods, 20_000.0]]
+    else
+      expectations = [[gods, 2500]]
+    end
     search.each_with_weight do |result, weight|
       expectation = expectations.shift
 

data/spec/acceptance/paginating_search_results_spec.rb

@@ -4,13 +4,22 @@ require 'acceptance/spec_helper'
 
 describe 'Paginating search results', :live => true do
   it "tracks how many results there are in total" do
+    expect(Article.search.total_entries).to be_zero
+
     21.times { |number| Article.create :title => "Article #{number}" }
     index
 
-    expect(Article.search.total_entries).to eq(21)
+    if ENV["SPHINX_ENGINE"] == "manticore" && ENV["SPHINX_VERSION"].to_f >= 4.0
+      # I suspect this is a bug in Manticore?
+      expect(Article.search.total_entries).to eq(22)
+    else
+      expect(Article.search.total_entries).to eq(21)
+    end
   end
 
   it "paginates the result set by default" do
+    expect(Article.search.total_entries).to be_zero
+
     21.times { |number| Article.create :title => "Article #{number}" }
     index
 
@@ -18,9 +27,16 @@ describe 'Paginating search results', :live => true do
   end
 
   it "tracks the number of pages" do
+    expect(Article.search.total_entries).to be_zero
+
     21.times { |number| Article.create :title => "Article #{number}" }
     index
 
-    expect(Article.search.total_pages).to eq(2)
+    if ENV["SPHINX_ENGINE"] == "manticore" && ENV["SPHINX_VERSION"].to_f >= 4.0
+      # I suspect this is a bug in Manticore?
+      expect(Article.search.total_pages).to eq(1)
+    else
+      expect(Article.search.total_pages).to eq(2)
+    end
   end
 end

data/spec/acceptance/real_time_updates_spec.rb

@@ -27,4 +27,29 @@ describe 'Updates to records in real-time indices', :live => true do
     expect(Admin::Person.search('Death').to_a).to be_empty
     expect(Admin::Person.search('Mort').to_a).to eq([person])
   end
+
+  it "can use a direct interface for processing records" do
+    Admin::Person.connection.execute <<~SQL
+      INSERT INTO admin_people (name, created_at, updated_at)
+      VALUES ('Pat', now(), now());
+    SQL
+
+    expect(Admin::Person.search('Pat').to_a).to be_empty
+
+    instance = Admin::Person.find_by(:name => 'Pat')
+    ThinkingSphinx::Processor.new(instance: instance).upsert
+
+    expect(Admin::Person.search('Pat').to_a).to eq([instance])
+
+    Admin::Person.connection.execute <<~SQL
+      UPDATE admin_people SET name = 'Patrick' WHERE name = 'Pat';
+    SQL
+
+    expect(Admin::Person.search('Patrick').to_a).to be_empty
+
+    instance.reload
+    ThinkingSphinx::Processor.new(model: Admin::Person, id: instance.id).upsert
+
+    expect(Admin::Person.search('Patrick').to_a).to eq([instance])
+  end
 end

data/spec/acceptance/remove_deleted_records_spec.rb

@@ -72,4 +72,28 @@ describe 'Hiding deleted records from search results', :live => true do
 
     expect(Bird.search_for_ids('duck')).to be_empty
   end
+
+  it "can use a direct interface for processing records" do
+    pancakes = Article.create! :title => 'Pancakes'
+    index
+    expect(Article.search('pancakes')).not_to be_empty
+
+    Article.connection.execute "DELETE FROM articles WHERE id = #{pancakes.id}"
+    expect(Article.search_for_ids('pancakes')).not_to be_empty
+
+    ThinkingSphinx::Processor.new(instance: pancakes).delete
+    expect(Article.search_for_ids('pancakes')).to be_empty
+  end
+
+  it "can use a direct interface for processing records without an instance" do
+    pancakes = Article.create! :title => 'Pancakes'
+    index
+    expect(Article.search('pancakes')).not_to be_empty
+
+    Article.connection.execute "DELETE FROM articles WHERE id = #{pancakes.id}"
+    expect(Article.search_for_ids('pancakes')).not_to be_empty
+
+    ThinkingSphinx::Processor.new(model: Article, id: pancakes.id).delete
+    expect(Article.search_for_ids('pancakes')).to be_empty
+  end
 end

data/spec/acceptance/searching_with_filters_spec.rb

@@ -17,7 +17,7 @@ describe 'Searching with filters', :live => true do
     grave = Book.create! :title => 'The Graveyard Book', :year => 2009
     index
 
-    expect(Book.search(:with => {:year => [2001, 2005]}).to_a).to eq([gods, boys])
+    expect(Book.search(:with => {:year => [2001, 2005]}).to_a).to match_array([gods, boys])
   end
 
   it "limits results by a ranged filter" do
@@ -31,7 +31,7 @@ describe 'Searching with filters', :live => true do
     index
 
     expect(Book.search(:with => {:created_at => 6.days.ago..2.days.ago}).to_a).
-      to eq([gods, boys])
+      to match_array([gods, boys])
   end
 
   it "limits results by exclusive filters on single values" do
@@ -154,6 +154,6 @@ describe 'Searching with filters', :live => true do
     expect(products.to_a).to eq([pancakes])
 
     products = Product.search :with => {"options.sugar" => 1}
-    expect(products.to_a).to eq([pancakes, waffles])
+    expect(products.to_a).to match_array([pancakes, waffles])
   end if JSONColumn.call
 end

data/spec/acceptance/support/sphinx_controller.rb

@@ -12,11 +12,13 @@ class SphinxController
 
     ThinkingSphinx::Configuration.reset
 
-    ActiveSupport::Dependencies.loaded.each do |path|
-      $LOADED_FEATURES.delete "#{path}.rb"
-    end
+    if Rails::VERSION::MAJOR < 7
+      ActiveSupport::Dependencies.loaded.each do |path|
+        $LOADED_FEATURES.delete "#{path}.rb"
+      end
 
-    ActiveSupport::Dependencies.clear
+      ActiveSupport::Dependencies.clear
+    end
 
     config.searchd.mysql41 = 9307
     config.settings['quiet_deltas']      = true

data/spec/fixtures/database.yml

@@ -1,4 +1,4 @@
 username: root
-password:
+password: thinking_sphinx
 host: localhost
 database: thinking_sphinx

data/spec/internal/app/indices/tee_index.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 ThinkingSphinx::Index.define :tee, :with => :active_record do
-  index colour.name
+  indexes colour.name
   has colour_id, :facet => true
 end

data/spec/internal/config/database.yml

@@ -2,7 +2,13 @@ test:
   adapter:      <%= ENV['DATABASE'] || 'mysql2' %>
   database:     thinking_sphinx
   username:     <%= ENV['DATABASE'] == 'postgresql' ? 'postgres' : 'root' %>
-<% if ENV["CI"] %>
+<% if ENV["DATABASE_PASSWORD"] %>
+  password:     <%= ENV["DATABASE_PASSWORD"] %>
+<% end %>
+<% if ENV["DATABASE_PORT"] %>
+  host:         127.0.0.1
+  port:         <%= ENV["DATABASE_PORT"] %>
+<% elsif ENV["CI"] %>
   password:     thinking_sphinx
   host:         127.0.0.1
   port:         <%= ENV['DATABASE'] == 'postgresql' ? 5432 : 3306 %>

data/spec/support/sphinx_yaml_helpers.rb

@@ -2,7 +2,12 @@
 
 module SphinxYamlHelpers
   def write_configuration(hash)
-    allow(File).to receive_messages :read => {'test' => hash}.to_yaml, :exists? => true
+    allow(File).to receive(:read).and_return({'test' => hash}.to_yaml)
+    allow(File).to receive(:exist?).and_wrap_original do |original, path|
+      next true if path.to_s == File.absolute_path("config/thinking_sphinx.yml", Rails.root.to_s)
+
+      original.call(path)
+    end
   end
 end
 

data/spec/thinking_sphinx/commands/clear_real_time_spec.rb

@@ -19,7 +19,7 @@ RSpec.describe ThinkingSphinx::Commands::ClearRealTime do
 
     allow(FileUtils).to receive_messages :rm_r => true,
       :rm => true
-    allow(File).to receive_messages :exists? => true
+    allow(File).to receive_messages :exist? => true
   end
 
   it 'finds each file for real-time indices' do

data/spec/thinking_sphinx/commands/clear_sql_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe ThinkingSphinx::Commands::ClearSQL do
       and_return(['/path/to/indices/ts-foo.tmp'])
 
     allow(FileUtils).to receive_messages :rm_r => true, :rm => true
-    allow(File).to receive_messages :exists? => true
+    allow(File).to receive_messages :exist? => true
   end
 
   it 'finds each file for sql-backed indices' do

data/spec/thinking_sphinx/configuration/minimum_fields_spec.rb

@@ -38,13 +38,13 @@ RSpec.describe ThinkingSphinx::Configuration::MinimumFields do
     expect(index_b.fields).to eq([field_b2])
   end
 
-  it 'keeps the class name fields when one index model has a type column' do
+  it 'removes the class name fields only for the indices without type column' do
     allow(model_a).to receive(:column_names).and_return(['id', 'name', 'type'])
     allow(model_b).to receive(:column_names).and_return(['id', 'name'])
 
     subject.reconcile
 
     expect(index_a.sources.first.fields).to eq([field_a1, field_a2])
-    expect(index_b.fields).to eq([field_b1, field_b2])
+    expect(index_b.fields).to eq([field_b2])
   end
 end

data/spec/thinking_sphinx/configuration_spec.rb

@@ -38,7 +38,12 @@ describe ThinkingSphinx::Configuration do
     end
 
     it 'does not cache settings after reset' do
-      allow(File).to receive_messages :exists? => true
+      allow(File).to receive(:exist?).and_wrap_original do |original, path|
+        next true if path.to_s == File.absolute_path("config/thinking_sphinx.yml", Rails.root)
+
+        original.call(path)
+      end
+
       allow(File).to receive_messages :read => {
         'test'       => {'foo' => 'bugs'},
         'production' => {'foo' => 'bar'}
@@ -165,8 +170,8 @@ describe ThinkingSphinx::Configuration do
         File.join(config.framework.root, "my/index/files")
       )
 
-      FileUtils.rm local_path
-      FileUtils.rmdir linked_path
+      FileUtils.rm_rf local_path
+      FileUtils.rm_rf linked_path
     end
   end
 
@@ -504,7 +509,11 @@ describe ThinkingSphinx::Configuration do
   describe '#settings' do
     context 'YAML file exists' do
       before :each do
-        allow(File).to receive_messages :exists? => true
+        allow(File).to receive(:exist?).and_wrap_original do |original, path|
+          next true if path.to_s == File.absolute_path("config/thinking_sphinx.yml", Rails.root)
+
+          original.call(path)
+        end
       end
 
       it "reads from the YAML file" do
@@ -540,7 +549,11 @@ describe ThinkingSphinx::Configuration do
 
     context 'YAML file does not exist' do
       before :each do
-        allow(File).to receive_messages :exists? => false
+        allow(File).to receive(:exist?).and_wrap_original do |original, path|
+          next false if path.to_s == File.absolute_path("config/thinking_sphinx.yml", Rails.root)
+
+          original.call(path)
+        end
       end
 
       it "does not read the file" do

data/spec/thinking_sphinx/errors_spec.rb

@@ -47,6 +47,15 @@ describe ThinkingSphinx::SphinxError do
       allow(error).to receive_messages :message => "Lost connection to MySQL server"
       expect(ThinkingSphinx::SphinxError.new_from_mysql(error)).
         to be_a(ThinkingSphinx::ConnectionError)
+
+      # MariaDB has removed mention of MySQL in error messages:
+      allow(error).to receive_messages :message => "Can't connect to server on '127.0.0.1' (61)"
+      expect(ThinkingSphinx::SphinxError.new_from_mysql(error)).
+        to be_a(ThinkingSphinx::ConnectionError)
+
+      allow(error).to receive_messages :message => "Lost connection to server"
+      expect(ThinkingSphinx::SphinxError.new_from_mysql(error)).
+        to be_a(ThinkingSphinx::ConnectionError)
     end
 
     it 'translates out-of-bounds errors' do

data/thinking-sphinx.gemspec

@@ -5,7 +5,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'thinking-sphinx'
-  s.version     = '5.3.0'
+  s.version     = '5.5.0'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Pat Allan"]
   s.email       = ["pat@freelancing-gods.com"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thinking-sphinx
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.5.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2022-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -175,12 +175,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/actions/test/action.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.markdown
 - Gemfile
 - LICENCE
+- Procfile.support
 - README.textile
 - Rakefile
 - bin/console
@@ -321,6 +324,7 @@ files:
 - lib/thinking_sphinx/panes/distance_pane.rb
 - lib/thinking_sphinx/panes/excerpts_pane.rb
 - lib/thinking_sphinx/panes/weight_pane.rb
+- lib/thinking_sphinx/processor.rb
 - lib/thinking_sphinx/query.rb
 - lib/thinking_sphinx/railtie.rb
 - lib/thinking_sphinx/rake_interface.rb
@@ -526,7 +530,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A smart wrapper over Sphinx for ActiveRecord