alchemy-pg_search 5.1.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efbd69f49a2b6dd894da769c73bf8336f257d14f1c59b5a6ec3e45cc1f01ba45
-  data.tar.gz: 30712617a4a1142d232da68753c74a71b86c6c9fa8904bca03b461ff980c1fd4
+  metadata.gz: '009bedc83da970afa4e20ea64375695711b50ef37027b4e4cbe08a7add274070'
+  data.tar.gz: c324b6915704b0ef189d539510d57ff80962be5f6244907bbfd9d82e0d13eec8
 SHA512:
-  metadata.gz: 52d1d223c67ce3edea17aa2c9ab81858102abe50d0e61b8bdf58b48bf208e6ff46914e76dd766bf5b506f1b0e9a374eb341a8638680f972eaf0bbf5022f5531b
-  data.tar.gz: 36b0f2f6fe63cd2a77d2a719d62f80e5f1e09944ed67944304c0017e157f5789ca6bf24803f0891f9a81d6dee332a0d10af9784a195b334ac0b5b6fbf643943b
+  metadata.gz: 0eda59775b10f840a97362c244beb387e259e104d18f03e855984ea15437649d78c1a397a4a2f443e62c62bbd74f42288b77ce7ede6401d090ae28b1d3844d06
+  data.tar.gz: 6245d3b156a31fe0459fc9372de9c3ffc8ab7f123dd717402a7dc3aeb206876912069f88ae4d20a127039ee1754d45f87c6391633490f8363dde101a2cb8fb10

data/.gitignore

@@ -7,6 +7,7 @@ spec/dummy/log/*.log
 spec/dummy/db/*.sqlite3*
 spec/dummy/tmp/*
 spec/dummy/public/*
+spec/dummy/db/migrate/*
 spec/dummy/uploads/*
 .ruby-*
 node_modules

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## [v6.0.0](https://github.com/AlchemyCMS/alchemy-pg_search/tree/v6.0.0) (2024-12-03)
+
+[Full Changelog](https://github.com/AlchemyCMS/alchemy-pg_search/compare/v5.2.0...v6.0.0)
+
+**Merged pull requests:**
+
+- Use an inner select for CanCanCan abilities [\#61](https://github.com/AlchemyCMS/alchemy-pg_search/pull/61) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Use public\_on instead of published\_at for pg\_search\_documents [\#60](https://github.com/AlchemyCMS/alchemy-pg_search/pull/60) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Add searchable\_created\_at field [\#59](https://github.com/AlchemyCMS/alchemy-pg_search/pull/59) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Add search page module and remove controller extension [\#58](https://github.com/AlchemyCMS/alchemy-pg_search/pull/58) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Rearrange page search [\#57](https://github.com/AlchemyCMS/alchemy-pg_search/pull/57) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Introduce a search\_class configuration into Alchemy [\#55](https://github.com/AlchemyCMS/alchemy-pg_search/pull/55) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Remove search module [\#54](https://github.com/AlchemyCMS/alchemy-pg_search/pull/54) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Use stripped\_body field for Richtext ingredient [\#51](https://github.com/AlchemyCMS/alchemy-pg_search/pull/51) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Mark page id as optional on pg\_search\_document [\#50](https://github.com/AlchemyCMS/alchemy-pg_search/pull/50) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Remove old migrations [\#49](https://github.com/AlchemyCMS/alchemy-pg_search/pull/49) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Add view partial examples to README [\#48](https://github.com/AlchemyCMS/alchemy-pg_search/pull/48) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Fix preview if search\_result\_page is nil [\#47](https://github.com/AlchemyCMS/alchemy-pg_search/pull/47) ([sascha-karnatz](https://github.com/sascha-karnatz))
+
+## [v5.2.0](https://github.com/AlchemyCMS/alchemy-pg_search/tree/v5.2.0) (2024-02-05)
+
+[Full Changelog](https://github.com/AlchemyCMS/alchemy-pg_search/compare/v5.1.0...v5.2.0)
+
+**Merged pull requests:**
+
+- Allow different search strings in preview [\#46](https://github.com/AlchemyCMS/alchemy-pg_search/pull/46) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Add support for Rails 7.1 [\#45](https://github.com/AlchemyCMS/alchemy-pg_search/pull/45) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Update configuration section in README [\#44](https://github.com/AlchemyCMS/alchemy-pg_search/pull/44) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Avoid duplicating Alchemy.publish\_targets in development environment [\#40](https://github.com/AlchemyCMS/alchemy-pg_search/pull/40) ([dbwinger](https://github.com/dbwinger))
+
 ## [v5.1.0](https://github.com/AlchemyCMS/alchemy-pg_search/tree/v5.1.0) (2023-12-20)
 
 [Full Changelog](https://github.com/AlchemyCMS/alchemy-pg_search/compare/v5.0.0...v5.1.0)

data/Gemfile

@@ -2,7 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "rails", "~> 7.0.0"
+gem "rails", "~> 7.1.0"
 gem "alchemy_cms", "~> 7.0.0"
 
 gem "sassc-rails"

data/README.md

@@ -2,7 +2,7 @@
 
 # Alchemy CMS Postgresql Fulltext Search
 
-This gem provides full text search for projects using postgresql databases to Alchemy CMS 6.0 and above.
+This gem provides full text search for projects using postgresql databases to Alchemy CMS 7.0 and above.
 
 ## Requirements
 
@@ -99,12 +99,18 @@ The same works for `ingredients` as well
 Configure the gem in an initializer. The default configurations are:
 
 ```ruby
-Alchemy::PgSearch.config = {
-  dictionary: 'simple',
-  paginate_per: 10
-}
+Rails.application.config.before_initialize do
+  Alchemy::PgSearch.config = {
+    dictionary: 'simple',
+    paginate_per: 10
+  }
+end
 ```
 
+> [!NOTE]  
+> Be aware that `before_initialize` is used. Otherwise the configuration will not have an effect, because of the load
+> order in Rails.
+
  Configuration Name | Default Value | Description                                                                                                                                                                                                                                                                                                 
 --------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
  dictionary         | simple        | Dictionary for the multisearch tsearch - config, which is used to find the content. The dictionary can impact the amout found documents, because it removes language specific stop words. See more in the [PostgreSQL documentation](https://www.postgresql.org/docs/current/textsearch-dictionaries.html). 
@@ -129,16 +135,9 @@ In order to render the search results, you'll need a page layout that represents
 page layout as `searchresults: true`. The search form will pick this page as result page.
 
 #### Search Results Page
-
-```yaml
-# page_layouts.yml
-- name: search
-  searchresults: true
-  unique: true
-```
-
-Tip: For maximum flexibility you could also add an element that represents the search results. This lets your editors to
-place additional elements (maybe a header image or additional text blocks) on the search result page.
+                          
+Add a search layout to the `page_layout.yml` and mark it with a `searchresults` flag. These flag is used to find the 
+correct page path for search form.
 
 ```yaml
 # page_layouts.yml
@@ -155,8 +154,18 @@ place additional elements (maybe a header image or additional text blocks) on th
   unique: true
 ```
 
-and then use the view helpers to render the search form on the page layout partial and the search results on the element
-view partial.
+and then use the view helpers to render the search form on the page layout partial.
+
+```erb
+<!-- app/views/alchemy/page_layouts/_search.html.erb -->
+<%= render_elements %>
+
+<!-- app/views/alchemy/elements/_searchresults.html.erb -->
+<%= element_view_for(searchresults) do |el| -%>
+  <% search_results = Alchemy::Search::SearchPage.perform_search(params, ability: current_ability) %>
+  <%= render "alchemy/search/results", search_results: search_results %>
+<% end %>
+```
 
 ### View Helpers
 
@@ -165,9 +174,6 @@ This gem provides some helper methods that let you render the form and the searc
 * Render the search form:
   `render_search_form`
 
-* Render the search results:
-  `render_search_results`
-
 ### Customize Views
 
 If you want to override the search form and search result views please use this generator.
@@ -214,7 +220,7 @@ and reindex your database in your Rails console
 
 ```rb
 # rails console
-$ Alchemy::PgSearch::Search.rebuild
+$ Alchemy::PgSearch.rebuild
 ```
 
 ## Contributing

data/app/extensions/alchemy/pg_search/page_extension.rb

@@ -10,7 +10,7 @@ module Alchemy::PgSearch::PageExtension
         :meta_keywords,
         :name,
       ],
-      additional_attributes: ->(page) { { page_id: page.id } },
+      additional_attributes: ->(page) { { page_id: page.id, searchable_created_at: page.public_on } },
       if: :searchable?,
     )
   end
@@ -23,7 +23,7 @@ module Alchemy::PgSearch::PageExtension
   private
 
   def remove_unpublished_page
-    Alchemy::PgSearch::Search.remove_page(self) unless searchable?
+    Alchemy::PgSearch.remove_page(self) unless searchable?
   end
 end
 

data/app/extensions/alchemy/pg_search/pg_search_document_extension.rb

@@ -1,20 +1,6 @@
 module Alchemy::PgSearch::PgSearchDocumentExtension
   def self.prepended(base)
-    base.belongs_to :page, class_name: "::Alchemy::Page", foreign_key: "page_id"
-  end
-
-  ##
-  # get a list of excerpts of the searched phrase
-  # The JSON_AGG - method will transform the grouped content entries into json which have to be "unpacked".
-  # @return [array<string>]
-  def excerpts
-    return [] if content.blank?
-    begin
-      parsed_content = JSON.parse content
-      parsed_content.kind_of?(Array) ? parsed_content : []
-    rescue JSON::ParserError
-      []
-    end
+    base.belongs_to :page, class_name: "::Alchemy::Page", foreign_key: "page_id", optional: true
   end
 end
 

data/app/extensions/alchemy/{pg_search → search}/element_extension.rb

@@ -1,4 +1,4 @@
-module Alchemy::PgSearch::ElementExtension
+module Alchemy::Search::ElementExtension
   def self.prepended(base)
     base.attr_writer :searchable
   end
@@ -12,4 +12,4 @@ module Alchemy::PgSearch::ElementExtension
   end
 end
 
-Alchemy::Element.prepend(Alchemy::PgSearch::ElementExtension)
+Alchemy::Element.prepend(Alchemy::Search::ElementExtension)

data/app/extensions/alchemy/search/ingredient_extension.rb

@@ -0,0 +1,14 @@
+module Alchemy::Search::IngredientExtension
+  def searchable_content
+    send(Alchemy.searchable_ingredients[type.to_sym])&.squish
+  end
+
+  def searchable?
+    Alchemy.searchable_ingredients.has_key?(type.to_sym) &&
+      (definition.key?(:searchable) ? definition[:searchable] : true) &&
+      !!element&.searchable?
+  end
+end
+
+# add the PgSearch model to all ingredients
+Alchemy::Ingredient.prepend(Alchemy::Search::IngredientExtension)

data/app/extensions/alchemy/search/page_extension.rb

@@ -0,0 +1,10 @@
+# Enable Postgresql full text indexing.
+#
+module Alchemy::Search::PageExtension
+  def searchable?
+    (definition.key?(:searchable) ? definition[:searchable] : true) &&
+      searchable && public? && !layoutpage?
+  end
+end
+
+Alchemy::Page.prepend(Alchemy::Search::PageExtension)

data/app/helpers/alchemy/pg_search/search_helper.rb

@@ -29,20 +29,8 @@ module Alchemy
           class: "fulltext_search",
           id: "search",
         }
-        render "alchemy/search/form", options: default_options.merge(options), search_result_page: search_result_page
-      end
-
-      # Renders the search results partial within +app/views/alchemy/search/_results.html+
-      #
-      # @option options show_result_count [Boolean] (true) Should the count of results be displayed or not?
-      # @option options show_heading [Boolean] (true) Should the heading be displayed or not?
-      #
-      def render_search_results(options = {})
-        default_options = {
-          show_result_count: true,
-          show_heading: true,
-        }
-        render "alchemy/search/results", options: default_options.merge(options)
+        search_result_page = Alchemy::Search::SearchPage.search_result_page
+        render "alchemy/search/form", options: default_options.merge(options), search_result_page:
       end
 
       def highlighted_excerpt(text, phrase, radius = 50)

data/app/jobs/alchemy/pg_search/index_page_job.rb

@@ -2,7 +2,7 @@ module Alchemy
   module PgSearch
     class IndexPageJob < BaseJob
       def perform(page)
-        Search.index_page(page)
+        PgSearch.index_page(page)
       end
     end
   end

data/app/services/alchemy/search/search_page.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Search
+    module SearchPage
+      def self.perform_search(params, ability: nil)
+        search_results = Alchemy.search_class.search(params[:query], ability:)
+        search_results = search_results&.page(params[:page])&.per(paginate_per) if paginate_per.present?
+
+        # order the documents by searchable_created_at and use the ranking order as second order argument
+        if params[:sort] == "date"
+          search_results.order_values.unshift("pg_search_documents.searchable_created_at DESC")
+        end
+
+        search_results
+      end
+
+      def self.paginate_per
+        Alchemy::PgSearch.config[:paginate_per]
+      end
+
+      def self.search_result_page
+        @search_result_page ||= begin
+          page_layouts = PageLayout.all.select do |page_layout|
+            page_layout.key?(:searchresults) && page_layout[:searchresults].to_s.casecmp(true.to_s).zero?
+          end
+
+          if page_layouts.nil?
+            raise "No searchresults page layout found. Please add page layout with `searchresults: true` into your `page_layouts.yml` file."
+          end
+
+          page = Page.published.find_by(
+            page_layout: page_layouts.first["name"],
+            language_id: Language.current.id,
+          )
+          if page.nil?
+            logger.warn "\n++++++\nNo published search result page found. Please create one or publish your search result page.\n++++++\n"
+          end
+          page
+        end
+      end
+    end
+  end
+end

data/app/views/alchemy/search/_result.html.erb

@@ -1,12 +1,6 @@
 <li class="search_result">
-  <% page = result.page %>
+  <% page = result.searchable %>
   <h3><%= link_to page.name, show_alchemy_page_path(page) %></h3>
-  <% if result.excerpts.any? %>
-    <% result.excerpts.each do |excerpt| %>
-    <p><%= highlighted_excerpt(excerpt, params[:query]) %></p>
-    <% end %>
-  <% else %>
-    <p><%= page.meta_description %></p>
-  <% end %>
+  <p><%= highlighted_excerpt(result.content, params[:query]) %></p>
   <p><%= link_to page.urlname, show_alchemy_page_path(page) %></p>
 </li>

data/app/views/alchemy/search/_results.html.erb

@@ -1,5 +1,5 @@
 <div class="search_results">
-  <% if @search_results.blank? %>
+  <% if search_results.blank? %>
     <h2 class="no_search_results">
       <%= raw Alchemy.t('search_result_page.no_results', query: h(params[:query])) %>
     </h2>
@@ -7,14 +7,14 @@
     <h2 class="search_results_heading">
       <%= raw Alchemy.t("search_result_page.result_heading", query: h(params[:query])) %>
       <%= Alchemy.t("search_result_page.result_count",
-                    count: @search_results.try(:total_count) || @search_results.size) %>
+                    count: search_results.try(:total_count) || search_results.size) %>
     </h2>
     <ul class="search_result_list">
-      <%= render(partial: 'alchemy/search/result', collection: @search_results) %>
+      <%= render(partial: 'alchemy/search/result', collection: search_results) %>
     </ul>
   <% end %>
 </div>
 
-<% if @search_results.try(:total_pages) %>
-  <%= paginate @search_results %>
+<% if search_results.try(:total_pages) %>
+  <%= paginate search_results %>
 <% end %>

data/db/migrate/20241105092236_add_document_created_at_to_pg_search_documents.rb

@@ -0,0 +1,6 @@
+class AddDocumentCreatedAtToPgSearchDocuments < ActiveRecord::Migration[7.1]
+  def change
+    add_column :pg_search_documents, :searchable_created_at, :datetime, if_not_exists: true
+    add_index :pg_search_documents, :searchable_created_at, if_not_exists: true
+  end
+end

data/lib/alchemy/pg_search/engine.rb

@@ -11,12 +11,11 @@ module Alchemy
           require_dependency(c)
         end
 
-        # We need to have the search methods present in all Alchemy controllers
-        Alchemy::BaseController.send(:include, Alchemy::PgSearch::ControllerMethods)
-
-        # reindex the page after it was published
-        Alchemy.publish_targets << Alchemy::PgSearch::IndexPageJob
-
+        # In development environment, this runs on every code reload, so avoid multiple reindexing jobs
+        unless Alchemy.publish_targets.map(&:name).include? 'Alchemy::PgSearch::IndexPageJob'
+          # reindex the page after it was published
+          Alchemy.publish_targets << Alchemy::PgSearch::IndexPageJob
+        end
         # enable searchable flag in page form
         Alchemy.enable_searchable = true
 

data/lib/alchemy/pg_search/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
   module PgSearch
-    VERSION = "5.1.0"
+    VERSION = "6.0.0"
   end
 end

data/lib/alchemy-pg_search.rb

@@ -1,19 +1,53 @@
 require "alchemy/pg_search/engine"
 require "alchemy/pg_search/config"
-require "alchemy/pg_search/search"
 
 module Alchemy
-  module PgSearch
-    SEARCHABLE_INGREDIENTS = %w[Text Richtext Picture]
+  mattr_accessor :search_class
+  @@search_class = PgSearch
+
+  mattr_accessor :searchable_ingredients
+  @@searchable_ingredients = {
+    "Alchemy::Ingredients::Text": :value,
+    "Alchemy::Ingredients::Headline": :value,
+    "Alchemy::Ingredients::Richtext": :stripped_body,
+    "Alchemy::Ingredients::Picture": :caption,
+  }
 
+  module PgSearch
     extend Config
 
     ##
-    # is ingredient searchable?
-    # @param ingredient_type [string]
-    # @return [boolean]
-    def self.is_searchable?(ingredient_type)
-      SEARCHABLE_INGREDIENTS.include?(ingredient_type.gsub(/Alchemy::Ingredients::/, ""))
+    # index all supported Alchemy pages
+    def self.rebuild
+      ActiveRecord::Base.transaction do
+        ::PgSearch::Document.delete_all
+        Alchemy::Page.all.each{ |page| index_page(page) }
+      end
+    end
+
+    ##
+    # remove the whole index for the page
+    #
+    # @param page [Alchemy::Page]
+    def self.remove_page(page)
+      ::PgSearch::Document.delete_by(page_id: page.id)
+    end
+
+    ##
+    # index a single page and indexable ingredients
+    #
+    # @param page [Alchemy::Page]
+    def self.index_page(page)
+      page.update_pg_search_document
+
+      document = page.pg_search_document
+      return if document.nil?
+
+      ingredient_content = page.all_elements.includes(ingredients: {element: :page}).map do |element|
+        element.ingredients.select { |i| i.searchable? }.map(&:searchable_content).join(" ")
+      end.join(" ")
+
+      document.update_column(:content, "#{document.content} #{ingredient_content}".squish)
     end
 
     ##
@@ -23,13 +57,14 @@ module Alchemy
     # @param ability [nil|CanCan::Ability]
     # @return [ActiveRecord::Relation]
     def self.search(query, ability: nil)
-      Search.search(query, ability: ability)
-    end
+      query = ::PgSearch.multisearch(query).includes(:searchable)
 
-    ##
-    # index all supported Alchemy models
-    def self.rebuild
-      Search.rebuild
+      if ability
+        inner_ability_select = Alchemy::Page.select(:id).merge(Alchemy::Page.accessible_by(ability, :read))
+        query = query.where("page_id IS NULL OR page_id IN (#{inner_ability_select.to_sql})")
+      end
+
+      query
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-pg_search
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2024-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -115,13 +115,14 @@ files:
 - README.md
 - Rakefile
 - alchemy-pg_search.gemspec
-- app/controller/alchemy/pg_search/controller_methods.rb
-- app/extensions/alchemy/pg_search/element_extension.rb
-- app/extensions/alchemy/pg_search/ingredient_extension.rb
 - app/extensions/alchemy/pg_search/page_extension.rb
 - app/extensions/alchemy/pg_search/pg_search_document_extension.rb
+- app/extensions/alchemy/search/element_extension.rb
+- app/extensions/alchemy/search/ingredient_extension.rb
+- app/extensions/alchemy/search/page_extension.rb
 - app/helpers/alchemy/pg_search/search_helper.rb
 - app/jobs/alchemy/pg_search/index_page_job.rb
+- app/services/alchemy/search/search_page.rb
 - app/views/alchemy/search/_form.html.erb
 - app/views/alchemy/search/_result.html.erb
 - app/views/alchemy/search/_results.html.erb
@@ -129,16 +130,12 @@ files:
 - bin/rspec
 - config/locales/alchemy.search.de.yml
 - config/locales/alchemy.search.en.yml
-- db/migrate/20141211105526_add_searchable_to_alchemy_essence_texts.rb
-- db/migrate/20141211105942_add_searchable_to_alchemy_essence_richtexts.rb
-- db/migrate/20141211110126_add_searchable_to_alchemy_essence_pictures.rb
-- db/migrate/20210923081905_move_searchable_to_contents.rb
 - db/migrate/20220826125413_add_page_id_column_to_pg_search_documents.rb
 - db/migrate/20231218165617_add_searchable_content.rb
+- db/migrate/20241105092236_add_document_created_at_to_pg_search_documents.rb
 - lib/alchemy-pg_search.rb
 - lib/alchemy/pg_search/config.rb
 - lib/alchemy/pg_search/engine.rb
-- lib/alchemy/pg_search/search.rb
 - lib/alchemy/pg_search/version.rb
 - lib/generators/alchemy/pg_search/install/install_generator.rb
 - lib/generators/alchemy/pg_search/views/views_generator.rb
@@ -163,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - PostgreSQL >= 12.x
-rubygems_version: 3.4.17
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: This gem provides PostgreSQL full text search to Alchemy

data/app/controller/alchemy/pg_search/controller_methods.rb

@@ -1,88 +0,0 @@
-module Alchemy
-  module PgSearch
-
-    # Provides full text search methods in your controller
-    #
-    module ControllerMethods
-
-      # Adds a +before_action+ to your controller
-      #
-      def self.included(controller)
-        controller.send(:before_action, :perform_search, only: :show)
-        controller.send(:helper_method, :search_result_page)
-        controller.send(:helper, Alchemy::PgSearch::SearchHelper)
-      end
-
-      private
-
-      # Performs a full text search with +PgSearch+.
-      #
-      # Gets invoked everytime 'query' is given in params.
-      #
-      # This method only sets the +@search_results+ instance variable.
-      #
-      # You have to redirect to the search result page within a search form.
-      #
-      # === Alchemy provides a handy helper for rendering the search form:
-      #
-      #  render_search_form
-      #
-      # === Note
-      #
-      # If in preview mode a fake search value "lorem" will be set.
-      #
-      # @see Alchemy::PagesHelper#render_search_form
-      #
-      def perform_search
-        if self.class == Alchemy::Admin::PagesController && params[:query].blank?
-          params[:query] = "lorem"
-        end
-        return if params[:query].blank?
-        @search_results = search_results
-        if paginate_per
-          @search_results = @search_results.page(params[:page]).per(paginate_per)
-        end
-      end
-
-      # Find Pages that have what is provided in "query" param with PgSearch
-      #
-      # @return [Array]
-      #
-      def search_results
-        Alchemy::PgSearch.search params[:query], ability: current_ability
-      end
-
-      # A view helper that loads the search result page.
-      #
-      # @return [Alchemy::Page,nil]
-      #
-      def search_result_page
-        @search_result_page ||= begin
-            page = Page.published.find_by(
-              page_layout: search_result_page_layout["name"],
-              language_id: Language.current.id,
-            )
-            if page.nil?
-              logger.warn "\n++++++\nNo published search result page found. Please create one or publish your search result page.\n++++++\n"
-            end
-            page
-          end
-      end
-
-      def search_result_page_layout
-        # search for page layout with the attribute `searchresults: true`
-        page_layouts = PageLayout.all.select do |page_layout|
-          page_layout.key?(:searchresults) && page_layout[:searchresults].to_s.casecmp(true.to_s).zero?
-        end
-        if page_layouts.nil?
-          raise "No searchresults page layout found. Please add page layout with `searchresults: true` into your `page_layouts.yml` file."
-        end
-        page_layouts.first
-      end
-
-      def paginate_per
-        Alchemy::PgSearch.config[:paginate_per]
-      end
-    end
-  end
-end

data/app/extensions/alchemy/pg_search/ingredient_extension.rb

@@ -1,29 +0,0 @@
-module Alchemy::PgSearch::IngredientExtension
-
-  def self.multisearch_config
-    {
-      against: [
-        :value,
-      ],
-      additional_attributes: ->(ingredient) { { page_id: ingredient.element.page.id } },
-      if: :searchable?
-    }
-  end
-
-  def self.prepended(base)
-    base.include PgSearch::Model
-    base.multisearchable(multisearch_config)
-  end
-
-  def searchable?
-    Alchemy::PgSearch.is_searchable?(type) &&
-      (definition.key?(:searchable) ? definition[:searchable] : true) &&
-      value.present? && !!element&.searchable?
-  end
-end
-
-# add the PgSearch model to all ingredients
-Alchemy::Ingredient.prepend(Alchemy::PgSearch::IngredientExtension)
-
-# only enable the search for Text, Richtext, and Picture
-Alchemy::Ingredients::Picture.multisearchable(Alchemy::PgSearch::IngredientExtension.multisearch_config.merge({against: [:caption]}))

data/db/migrate/20141211105526_add_searchable_to_alchemy_essence_texts.rb

@@ -1,5 +0,0 @@
-class AddSearchableToAlchemyEssenceTexts < ActiveRecord::Migration[6.1]
-  def change
-    add_column :alchemy_essence_texts, :searchable, :boolean, default: true, if_not_exists: true
-  end
-end

data/db/migrate/20141211105942_add_searchable_to_alchemy_essence_richtexts.rb

@@ -1,5 +0,0 @@
-class AddSearchableToAlchemyEssenceRichtexts < ActiveRecord::Migration[6.1]
-  def change
-    add_column :alchemy_essence_richtexts, :searchable, :boolean, default: true, if_not_exists: true
-  end
-end

data/db/migrate/20141211110126_add_searchable_to_alchemy_essence_pictures.rb

@@ -1,5 +0,0 @@
-class AddSearchableToAlchemyEssencePictures < ActiveRecord::Migration[6.1]
-  def change
-    add_column :alchemy_essence_pictures, :searchable, :boolean, default: true, if_not_exists: true
-  end
-end

data/db/migrate/20210923081905_move_searchable_to_contents.rb

@@ -1,45 +0,0 @@
-class MoveSearchableToContents < ActiveRecord::Migration[6.1]
-  def change
-    if column_exists? :alchemy_contents, :searchable
-      return
-    end
-
-    add_column :alchemy_contents, :searchable, :boolean, default: true
-
-    {
-      Text: "texts",
-      Richtext: "richtexts",
-      Picture: "pictures",
-    }.each do |klass, table|
-      reversible do |dir|
-        dir.up do
-          Alchemy::Content.connection.execute <<~SQL
-            UPDATE alchemy_contents
-            SET searchable = alchemy_essence_#{table}.searchable
-            FROM alchemy_essence_#{table}
-            WHERE
-              alchemy_contents.essence_type = 'Alchemy::Essence#{klass}'
-            AND
-              alchemy_contents.essence_id = alchemy_essence_#{table}.id
-          SQL
-        end
-
-        dir.down do
-          Alchemy::Content.connection.execute <<~SQL
-            UPDATE alchemy_essence_#{table}
-            SET searchable = alchemy_contents.searchable
-            FROM alchemy_contents
-            WHERE
-              alchemy_contents.essence_type = 'Alchemy::Essence#{klass}'
-            AND
-              alchemy_contents.essence_id = alchemy_essence_#{table}.id
-          SQL
-        end
-      end
-
-      remove_column "alchemy_essence_#{table}", :searchable, default: true
-    end
-
-    change_column_null :alchemy_contents, :searchable, false, true
-  end
-end

data/lib/alchemy/pg_search/search.rb

@@ -1,55 +0,0 @@
-module Alchemy
-  module PgSearch
-    module Search
-
-      ##
-      # index all supported Alchemy models
-      def self.rebuild
-        [Alchemy::Page, Alchemy::Ingredient].each do |model|
-          ::PgSearch::Multisearch.rebuild(model)
-        end
-      end
-
-      ##
-      # remove the whole index for the page
-      #
-      # @param page [Alchemy::Page]
-      def self.remove_page(page)
-        ::PgSearch::Document.delete_by(page_id: page.id)
-      end
-
-      ##
-      # index a single page and indexable ingredients
-      #
-      # @param page [Alchemy::Page]
-      def self.index_page(page)
-        remove_page page
-
-        page.update_pg_search_document
-        page.all_elements.includes(:ingredients).find_each do |element|
-          element.ingredients.select { |i| Alchemy::PgSearch.is_searchable?(i.type) }.each do |ingredient|
-            ingredient.update_pg_search_document
-          end
-        end
-      end
-
-      ##
-      # search for page results
-      #
-      # @param query [string]
-      # @param ability [nil|CanCan::Ability]
-      # @return [ActiveRecord::Relation]
-      def self.search(query, ability: nil)
-        query = ::PgSearch.multisearch(query)
-                  .select("JSON_AGG(content) as content", :page_id)
-                  .reorder("")
-                  .group(:page_id)
-                  .joins(:page)
-
-        query = query.merge(Alchemy::Page.accessible_by(ability, :read)) if ability
-
-        query
-      end
-    end
-  end
-end