plok 1.1.2 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe8e289922e36071642ae46ff78b49eded873476b9721668a5c9df0f8d51bd4f
-  data.tar.gz: 06ee8edde78842db587ee3e0076b9a791cd78247d9987ba07a5441bd0f03c270
+  metadata.gz: 1f3ad1b023f6d523f5766b822fcc60d26cccb4983a46ec6e7efcc75d88fce4d0
+  data.tar.gz: 6ab0505a105e0534a15470b3b161ef23d6b49161ea2962af3dd34ff3c5819318
 SHA512:
-  metadata.gz: 562556d7edcf1db8f174203ba55fd3e7cf111ffdab3b1b63d0532a44f3d09d955c9ff7545e83a08e0ed7cf22dff9afd2b14fd5e0857217eae08448f47d8f2915
-  data.tar.gz: c2d565bdfdd0aae5244dd82d9e7bcd04dcb672a7cb7fcc7f8fe40bf5cdd87f3f085a4f33a51c912db353b76d633c0b53b9e5a98a40704b1d0e0d3640c78ec2de
+  metadata.gz: 418a0736b07848ff337b82ce1207ab4904810e6fd643ff15a93a44a125d7e35e676f981991e4d7f129f92d667d8602f976e3eddd72fb78c5b6c2d9d7b26e9b32
+  data.tar.gz: 9cac24540be3eafc2335cbb9b36e6bef87b65c80fcf9d3ea1850070b890cbd6840ea83e8b353ab977c73837049e93affbbbd1b96dcb77bfe3594ec6b50af3a22

data/app/models/concerns/plok/searchable.rb

@@ -3,7 +3,7 @@ module Plok::Searchable
   extend ActiveSupport::Concern
 
   included do
-    has_many :search_indices, as: :searchable
+    has_many :search_indices, as: :searchable, dependent: :destroy
 
     # The after_save block creates or saves indices for every indicated
     # searchable field. Takes both translations and flexible content into

data/lib/plok/version.rb

@@ -1,3 +1,3 @@
 module Plok
-  VERSION = '1.1.2'
+  VERSION = '1.1.4'
 end

data/lib/tasks/plok/search.rake

@@ -0,0 +1,47 @@
+namespace 'plok:search' do
+  # The official Rails way to pass arguments to Rake tasks is this:
+  #
+  #   task :rebuild_indices, [:modules] => :environment do |_t, args|
+  #     args.with_defaults(modules: SearchModule.searchable.pluck(:klass))
+  #   end
+  #
+  # The problem with that is that you can't comma-separate multiple modules
+  # unless you escape them. This is because commas denote multiple arguments.
+  #
+  # In short, this wouldn't work:
+  #
+  #   bin/rails plok:search:rebuild_indices[EmailTemplate,Article]
+  #
+  # And you'd need to do this:
+  #
+  #   bin/rails plok:search:rebuild_indices["EmailTemplate\,Article"]
+  #
+  # I don't agree with that notation, so instead I opted for ENV vars instead:
+  #
+  #   bin/rails plok:search:rebuild_indices modules=EmailTemplate,Article
+  #
+  desc 'Rebuild select search indices (or all of them without additional arguments).'
+  task rebuild_indices: :environment do
+    # Default to all searchable modules
+    modules = ENV['modules']&.split(',') || SearchModule.searchable.pluck(:klass)
+
+    # A safeguard to prevent mishaps
+    modules.select! do |m|
+      SearchModule.exists?(klass: m) && # Only known modules
+        Plok::Engine.class_exists?(m.constantize) # Only existing classes
+    end
+
+    SearchModule.where(klass: modules).each do |m|
+      puts "Removing existing #{m.klass} indices..."
+      # Faster than SearchIndex.where(searchable_type: modules).destroy_all
+      ActiveRecord::Base
+        .connection
+        .execute("DELETE FROM search_indices WHERE searchable_type = '#{m.klass}'")
+
+      puts "Rebuilding #{m.klass} indices..."
+      m.klass.constantize.all.each(&:trigger_indices_save!)
+    end
+
+    puts "Done."
+  end
+end

data/lib/tasks/plok_tasks.rake

@@ -1,46 +0,0 @@
-namespace 'plok:search' do
-  # The official Rails way to pass arguments to Rake tasks is this:
-  #
-  #   task :rebuild_indices, [:modules] => :environment do |_t, args|
-  #     args.with_defaults(modules: SearchModule.searchable.pluck(:klass))
-  #   end
-  #
-  # The problem with that is that you can't comma-separate multiple modules
-  # unless you escape them. This is because commas denote multiple arguments.
-  #
-  # In short, this wouldn't work:
-  #
-  #   bin/rails plok:search:rebuild_indices[EmailTemplate,Article]
-  #
-  # And you'd need to do this:
-  #
-  #   bin/rails plok:search:rebuild_indices["EmailTemplate\,Article"]
-  #
-  # I don't agree with that notation, so instead I opted for ENV vars instead:
-  #
-  #   bin/rails plok:search:rebuild_indices modules=EmailTemplate,Article
-  #
-  desc 'Rebuild select search indices (or all of them without additional arguments).'
-  task rebuild_indices: :environment do
-    # Default to all searchable modules
-    modules = ENV['modules']&.split(',') || SearchModule.searchable.pluck(:klass)
-
-    # A safeguard to prevent mishaps
-    modules.select! do |m|
-      SearchModule.exists?(klass: m) && # Only known modules
-        Plok::Engine.class_exists?(m.constantize) # Only existing classes
-    end
-
-    # Faster than SearchIndex.where(searchable_type: modules).destroy_all
-    ActiveRecord::Base
-      .connection
-      .execute("DELETE FROM search_indices WHERE searchable_type in ('#{modules.join("','")}')")
-
-    SearchModule.where(klass: modules).each do |m|
-      puts "Rebuilding #{m.klass} indices..."
-      m.klass.constantize.all.each(&:trigger_indices_save!)
-    end
-
-    puts "Done."
-  end
-end

data/spec/support/plok/searchable.rb

@@ -3,16 +3,34 @@ require 'rails_helper'
 shared_examples_for :searchable do
   let(:klass) { described_class.to_s.underscore.to_sym }
 
+  describe 'relations' do
+    context 'when destroying a searchable model' do
+      it 'deletes all linked SearchIndex records' do
+        subject = create(klass)
+        index = create(:search_index, searchable: subject)
+        expect { subject.destroy }.to change(SearchIndex, :count)
+      end
+    end
+  end
+
   describe 'after_save' do
     context 'non-translatable model' do
       before do
         # Because this is a spec/support included through it_behaves_like,
         # we have to mock the entry points of the data used in
         # Plok::Searchable.
-        allow(described_class).to receive(:searchable_fields_list) { [:foo] }
+        allow(described_class).to receive(:searchable_fields_list) do
+          {
+            backend: [
+              { name: :foo, conditions: [] }
+            ]
+          }
+        end
+
         if described_class.respond_to?(:translatable_fields_list)
           allow(described_class).to receive(:translatable_fields_list) { [] }
         end
+
         described_class.define_method(:foo) { 'bar' }
       end
 
@@ -27,7 +45,13 @@ shared_examples_for :searchable do
 
     if described_class.respond_to?(:translatable_fields)
       before do
-        allow(described_class).to receive(:searchable_fields_list) { [:foo] }
+        allow(described_class).to receive(:searchable_fields_list) do
+          {
+            backend: [
+              { name: :foo, conditions: [] }
+            ]
+          }
+        end
       end
 
       context 'translatable model' do
@@ -62,7 +86,14 @@ shared_examples_for :searchable do
           # Because this is a spec/support included through it_behaves_like,
           # we have to mock the entry points of the data used in
           # Plok::Searchable.
-          allow(described_class).to receive(:searchable_fields_list) { [:foo] }
+          allow(described_class).to receive(:searchable_fields_list) do
+            {
+              backend: [
+                { name: :foo, conditions: [] }
+              ]
+            }
+          end
+
           allow_any_subject_of(described_class).to receive(:foo) { 'bar' }
           allow_any_subject_of(Concerns::Storable::Collection).to receive(:foo) { 'bar' }
 
@@ -90,7 +121,7 @@ shared_examples_for :searchable do
 
   it '.respond_to?' do
     expect(described_class).to respond_to(
-      :searchable_field, :searchable_fields, :searchable_fields_list
+      :plok_searchable, :searchable_field, :searchable_fields_list
     )
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plok
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.4
 platform: ruby
 authors:
 - Davy Hellemans
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-09 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -67,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Some basics used for setting up rails projects
 email:
 - davy@blimp.be
@@ -125,6 +139,7 @@ files:
 - lib/plok/search/result_objects/base.rb
 - lib/plok/search/term.rb
 - lib/plok/version.rb
+- lib/tasks/plok/search.rake
 - lib/tasks/plok_tasks.rake
 - spec/factories/logs.rb
 - spec/factories/queued_tasks.rb