alchemy-pg_search 3.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '041410896e0f98a81e3ead2437c7a5b02cb434e37d72ab5736db7ef3dbbaa5c0'
-  data.tar.gz: 8b93ed647898f4b0c5540d4674233565beb2dcb9fa41370f0d228de48a1fb852
+  metadata.gz: 366fce3505557ca67b0a956441bc78e27c2bac492a8a008359571b2e768f2b18
+  data.tar.gz: c30b0e00f6c8e6dbd32326fc569ee94aba2b2b9bf7acbfeb71ce0084c930f3f3
 SHA512:
-  metadata.gz: 2ede6256f9123b9bee9d13656c243a1ee3f370f40e04210674dd7ca2450ac83a66b2c3edda878ea6a0dca3b2aa64d042e6bdc4e0d2b3a676708455db4050db08
-  data.tar.gz: cecc52649b848c514ebd07fff4b4822d19233f8fb50def4ffcb99acf14d1ad2ba45a07fc0ec53d3385fa49f566d8250b80862f530ec40acfd9edc841b10f3c8f
+  metadata.gz: c43a3f9bc07488d00811cc028f0be916a92afe87836dfb6e5017d454fcd5da9cf361e220be56b063a9132ade82947491e909ea924c2b6762441ddfd065257c19
+  data.tar.gz: 2c991f3476b1b82d960255d2f6d4d4adfd4610d6e93caa59bf8235326e485f2d4d36f0bcd16b0517472038e47e76835791cf7699c125aa5c3fc4c0eed8d91a5a

data/.gitignore

@@ -7,3 +7,8 @@ spec/dummy/log/*.log
 spec/dummy/db/*.sqlite3*
 spec/dummy/tmp/*
 .ruby-*
+node_modules
+yarn.lock
+
+.idea
+.vscode

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+# Changelog
+
+## [v4.1.0](https://github.com/AlchemyCMS/alchemy-pg_search/tree/v4.1.0) (2022-09-19)
+
+[Full Changelog](https://github.com/AlchemyCMS/alchemy-pg_search/compare/v4.0.0...v4.1.0)
+
+**Closed issues:**
+
+- V4 issue [\#32](https://github.com/AlchemyCMS/alchemy-pg_search/issues/32)
+
+**Merged pull requests:**
+
+- Allow to exclude pages, elements and ingredients from search index [\#35](https://github.com/AlchemyCMS/alchemy-pg_search/pull/35) ([tvdeyen](https://github.com/tvdeyen))
+- Add multisearch configuration [\#34](https://github.com/AlchemyCMS/alchemy-pg_search/pull/34) ([kulturbande](https://github.com/kulturbande))
+- Remove old ferret upgrader [\#31](https://github.com/AlchemyCMS/alchemy-pg_search/pull/31) ([tvdeyen](https://github.com/tvdeyen))
+
+## 4.0.0 (2022-08-30)
+
+- Introduced new search module [#30](https://github.com/AlchemyCMS/alchemy-pg_search/pull/30) by [kulturbande](https://github.com/kulturbande)
+- Moved all extensions to a separate folder [#30](https://github.com/AlchemyCMS/alchemy-pg_search/pull/30) by [kulturbande](https://github.com/kulturbande)
+- Enable pg_search multisearch [#30](https://github.com/AlchemyCMS/alchemy-pg_search/pull/30) by [kulturbande](https://github.com/kulturbande)
+- Update Dummy App to Alchemy 6 [#30](https://github.com/AlchemyCMS/alchemy-pg_search/pull/30) by [kulturbande](https://github.com/kulturbande)
+
 ## 3.0.0 (2022-07-01)
 
 - Changed searchable option initialization [#29](https://github.com/AlchemyCMS/alchemy-pg_search/pull/29) by [kulturbande](https://github.com/kulturbande)
@@ -29,3 +52,6 @@
 
 - Rename the #search method into #full_text_search [#14](https://github.com/AlchemyCMS/alchemy-pg_search/pull/14) by [tvdeyen](https://github.com/tvdeyen)
 - Add a page search scope class [#13](https://github.com/AlchemyCMS/alchemy-pg_search/pull/13) by [tvdeyen](https://github.com/tvdeyen)
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "rails", "~> 6.0.0"
-ENV.fetch("ALCHEMY_BRANCH", "5.3-stable").tap do |branch|
+ENV.fetch("ALCHEMY_BRANCH", "6.0-stable").tap do |branch|
   gem "alchemy_cms", github: "AlchemyCMS/alchemy_cms", branch: branch
 end
 gem "sassc-rails"
@@ -18,3 +18,5 @@ group :test do
   gem "pry-byebug"
   gem "launchy"
 end
+
+gem "github_changelog_generator", "~> 1.16"

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 4.0 and above.
+This gem provides full text search for projects using postgresql databases to Alchemy CMS 6.0 and above.
 
 ## Installation
 
@@ -18,11 +18,10 @@ And then execute:
 $ bundle install
 ```
 
-Add migrations:
+Run install script:
 
 ```shell
-$ bin/rake alchemy_pg_search:install:migrations
-$ bin/rake db:migrate
+$ bin/rails g alchemy:pg_search:install
 ```
 
 ## Usage
@@ -31,16 +30,79 @@ Every `EssenceText`, `EssenceRichtext` and `EssencePicture` will be indexed unle
 
 ### Disable Indexing
 
-Simply pass `searchable: false` to your content definitions and Alchemy will not index results from that particular content.
+#### Exclude whole pages from the search index
+
+Pass `searchable: false` to your page layout definitions and Alchemy will not index that particular page.
+
+```yaml
+# page_layouts.yml
+- name: secret_page
+  searchable: false
+  elements:
+    - secret_sauce
+```
+
+#### Exclude whole elements from the search index
+
+Pass `searchable: false` to your element definitions and Alchemy will not index that particular element.
+
+```yaml
+# elements.yml
+- name: secret_sauce
+  searchable: false
+  ingredients:
+    - name: sauce
+      type: Text
+      default: 'This is my secret sauce.'
+```
+
+#### Exclude single contents from being indexed
+
+Pass `searchable: false` to your content definitions and Alchemy will not index that particular content.
 
 ```yaml
 # elements.yml
 - name: secrets
   contents:
-  - name: passwords
-    type: EssenceText
-    searchable: false
-    default: 'This is my secret password.'
+    - name: passwords
+      type: EssenceText
+      searchable: false
+      default: 'This is my secret password.'
+```
+
+The same works for `ingredients` as well
+
+```yaml
+# elements.yml
+- name: secrets
+  ingredients:
+    - name: passwords
+      type: Text
+      searchable: false
+      default: 'This is my secret password.'
+```
+
+### Configure Behavior
+
+Configure the gem in an initializer. The default configurations are:
+
+```ruby
+Alchemy::PgSearch.config = {
+  paginate_per: 10, # amount of results per page
+}
+```
+
+You can also overwrite the default multisearch configuration to use other search strategies. For more information take
+a look into the [PgSearch Readme](https://github.com/Casecommons/pg_search#configuring-multi-search).
+
+```ruby
+Rails.application.config.after_initialize do
+  ::PgSearch.multisearch_options = {
+    using: {
+      tsearch: { prefix: true }
+    }
+  }
+end
 ```
 
 ### Rendering search results.
@@ -120,13 +182,20 @@ en:
 
 ## Upgrading
 
-If you are upgrading from an old Alchemy < 4.0 based project that uses the ferret based full text search, please run this handy generator:
+If you are upgrading from v3.0.0 please run the install generator:
 
 ```shell
-$ bin/rails g alchemy:pg_search:upgrade
+$ bin/rails g alchemy:pg_search:install
 $ bin/rake db:migrate
 ```
 
+and reindex your database in your Rails console
+
+```rb
+# rails console
+$ Alchemy::PgSearch::Search.rebuild
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,46 +1,57 @@
 #!/usr/bin/env rake
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
 begin
-  require 'rdoc/task'
+  require "rdoc/task"
 rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
+  require "rdoc/rdoc"
+  require "rake/rdoctask"
   RDoc::Task = Rake::RDocTask
 end
 
-desc 'Generate documentation for Alchemy CMS.'
+desc "Generate documentation for Alchemy CMS."
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Alchemy PgSearch'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-  rdoc.rdoc_files.include('app/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "Alchemy PgSearch"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.rdoc_files.include("app/**/*.rb")
 end
 
 APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
+load "rails/tasks/engine.rake"
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "rspec/core"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => ['alchemy:spec:prepare', :spec]
+task :default => ["alchemy:spec:prepare", :spec]
 
 Bundler::GemHelper.install_tasks
 
 namespace :alchemy do
   namespace :spec do
-
     desc "Prepares database for testing"
     task :prepare do
-      system 'cd spec/dummy; RAILS_ENV=test bin/rake db:setup db:seed; cd -'
+      system "cd spec/dummy; RAILS_ENV=test bin/rake db:setup db:seed; cd -"
     end
   end
 end
+
+require "github_changelog_generator/task"
+require "alchemy/pg_search/version"
+
+namespace :changelog do
+  GitHubChangelogGenerator::RakeTask.new :update do |config|
+    config.user = "AlchemyCMS"
+    config.project = "alchemy-pg_search"
+    config.since_tag = "v4.0.0"
+    config.future_release = "v#{Alchemy::PgSearch::VERSION}"
+  end
+end

data/alchemy-pg_search.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "alchemy_cms", [">= 5.0", "< 6"]
+  spec.add_runtime_dependency "alchemy_cms", [">= 6.0", "< 7"]
   spec.add_runtime_dependency "pg_search", ["~> 2.1"]
   spec.add_runtime_dependency "pg"
 

data/{lib → app/controller}/alchemy/pg_search/controller_methods.rb

@@ -35,7 +35,7 @@ module Alchemy
       #
       def perform_search
         if self.class == Alchemy::Admin::PagesController && params[:query].blank?
-          params[:query] = 'lorem'
+          params[:query] = "lorem"
         end
         return if params[:query].blank?
         @search_results = search_results
@@ -49,31 +49,24 @@ module Alchemy
       # @return [Array]
       #
       def search_results
-        pages = Alchemy::PgSearch.config[:page_search_scope].pages
-        # Since CanCan cannot (oh the irony) merge +accessible_by+ scope with pg_search scopes,
-        # we need to fake a page object here
-        if can? :show, Alchemy::Page.new(restricted: true, public_on: Date.current)
-          pages.full_text_search(params[:query])
-        else
-          pages.not_restricted.full_text_search(params[:query])
-        end
+        Alchemy::PgSearch.search params[:query], ability: current_ability
       end
 
       # A view helper that loads the search result page.
       #
-      # @return [Alchemy::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"
+            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
-          page
-        end
       end
 
       def search_result_page_layout

data/{lib → app/extensions}/alchemy/pg_search/content_extension.rb

@@ -10,17 +10,8 @@ module Alchemy::PgSearch::ContentExtension
   end
 
   module InstanceMethods
-    def searchable_ingredient
-      case essence_type
-      when "Alchemy::EssencePicture"
-        essence.caption
-      when "Alchemy::EssenceRichtext"
-        essence.stripped_body
-      when "Alchemy::EssenceText"
-        essence.body
-      else
-        ingredient
-      end
+    def searchable?
+      searchable && element.searchable?
     end
 
     Alchemy::Content.prepend self

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

@@ -0,0 +1,8 @@
+module Alchemy::PgSearch::ElementExtension
+  def searchable?
+    (definition.key?(:searchable) ? definition[:searchable] : true) &&
+      public? && page.searchable? && page_version.public?
+  end
+end
+
+Alchemy::Element.prepend(Alchemy::PgSearch::ElementExtension)

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

@@ -0,0 +1,19 @@
+module Alchemy::PgSearch::EssencePictureExtension
+
+  def self.prepended(base)
+    base.include PgSearch::Model
+    base.multisearchable(
+      against: [
+        :caption
+      ],
+      additional_attributes: -> (essence_picture) { { page_id: essence_picture.page.id } },
+      if: :searchable?
+    )
+  end
+
+  def searchable?
+    caption.present? && !!content&.searchable?
+  end
+end
+
+Alchemy::EssencePicture.prepend(Alchemy::PgSearch::EssencePictureExtension)

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

@@ -0,0 +1,20 @@
+module Alchemy::PgSearch::EssenceRichtextExtension
+
+  def self.prepended(base)
+    base.include PgSearch::Model
+    base.multisearchable(
+      against: [
+        :stripped_body
+      ],
+      additional_attributes: -> (essence_richtext) { { page_id: essence_richtext.page.id } },
+      if: :searchable?
+    )
+  end
+
+  def searchable?
+    stripped_body.present? && !!content&.searchable?
+  end
+end
+
+Alchemy::EssenceRichtext.prepend(Alchemy::PgSearch::EssenceRichtextExtension)
+

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

@@ -0,0 +1,19 @@
+module Alchemy::PgSearch::EssenceTextExtension
+  def self.prepended(base)
+    base.include PgSearch::Model
+    base.multisearchable(
+      against: [
+        :body
+      ],
+      additional_attributes: -> (essence_text) { { page_id: essence_text.page.id } },
+      if: :searchable?
+    )
+  end
+
+  def searchable?
+    body.present? && !!content&.searchable?
+  end
+end
+
+Alchemy::EssenceText.prepend(Alchemy::PgSearch::EssenceTextExtension)
+

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

@@ -0,0 +1,20 @@
+module Alchemy::PgSearch::IngredientExtension
+  def self.prepended(base)
+    base.include PgSearch::Model
+    base.multisearchable(
+      against: [
+        :value,
+      ],
+      additional_attributes: ->(ingredient) { { page_id: ingredient.element.page.id } },
+      if: :searchable?,
+    )
+  end
+
+  def searchable?
+    Alchemy::PgSearch.is_searchable?(type) &&
+      (definition.key?(:searchable) ? definition[:searchable] : true) &&
+      value.present? && !!element&.searchable?
+  end
+end
+
+Alchemy::Ingredient.prepend(Alchemy::PgSearch::IngredientExtension)

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

@@ -0,0 +1,30 @@
+# Enable Postgresql full text indexing.
+#
+module Alchemy::PgSearch::PageExtension
+  def self.prepended(base)
+    base.include PgSearch::Model
+    base.after_save :remove_unpublished_page
+    base.multisearchable(
+      against: [
+        :meta_description,
+        :meta_keywords,
+        :name,
+      ],
+      additional_attributes: ->(page) { { page_id: page.id } },
+      if: :searchable?,
+    )
+  end
+
+  def searchable?
+    (definition.key?(:searchable) ? definition[:searchable] : true) &&
+      public? && !layoutpage?
+  end
+
+  private
+
+  def remove_unpublished_page
+    Alchemy::PgSearch::Search.remove_page(self) unless searchable?
+  end
+end
+
+Alchemy::Page.prepend(Alchemy::PgSearch::PageExtension)

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

@@ -0,0 +1,21 @@
+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
+  end
+end
+
+PgSearch::Document.prepend(Alchemy::PgSearch::PgSearchDocumentExtension)

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

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

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

@@ -1,10 +1,9 @@
 <li class="search_result">
+  <% page = result.page %>
   <h3><%= link_to page.name, show_alchemy_page_path(page) %></h3>
-  <% if elements.any? %>
-    <% elements.each do |element| %>
-      <% element.searchable_contents.each do |content| %>
-      <p><%= highlighted_excerpt(content.searchable_ingredient.to_s, params[:query]) %></p>
-      <% end %>
+  <% if result.excerpts.any? %>
+    <% result.excerpts.each do |excerpt| %>
+    <p><%= highlighted_excerpt(excerpt, params[:query]) %></p>
     <% end %>
   <% else %>
     <p><%= page.meta_description %></p>

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

@@ -7,16 +7,10 @@
     <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">
-      <% @search_results.each do |page| %>
-        <%= render('alchemy/search/result',
-          elements: page.element_search_results(params[:query]),
-          options: options,
-          page: page
-        ) %>
-      <% end %>
+      <%= render(partial: 'alchemy/search/result', collection: @search_results) %>
     </ul>
   <% end %>
 </div>

data/db/migrate/20220826125413_add_page_id_column_to_pg_search_documents.rb

@@ -0,0 +1,5 @@
+class AddPageIdColumnToPgSearchDocuments < ActiveRecord::Migration[6.0]
+  def change
+    add_reference :pg_search_documents, :page, index: true
+  end
+end

data/lib/alchemy/pg_search/engine.rb

@@ -7,13 +7,23 @@ module Alchemy
       engine_name "alchemy_pg_search"
 
       config.to_prepare do
-        require_relative "./content_extension"
-        require_relative "./controller_methods"
-        require_relative "./element_extension"
-        require_relative "./page_extension"
+        Dir.glob(Alchemy::PgSearch::Engine.root.join("app", "extensions", "**", "*_extension.rb")) do |c|
+          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
+
+        # configure multiselect to find also partial words
+        # @link https://github.com/Casecommons/pg_search#searching-using-different-search-features
+        ::PgSearch.multisearch_options = {
+          using: {
+            tsearch: { prefix: true }
+          }
+        }
       end
     end
   end

data/lib/alchemy/pg_search/search.rb

@@ -0,0 +1,59 @@
+module Alchemy
+  module PgSearch
+    module Search
+
+      ##
+      # index all supported Alchemy models
+      def self.rebuild
+        ([Alchemy::Page, Alchemy::Ingredient] + Alchemy::PgSearch.searchable_essence_classes).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 essences
+      #
+      # @param page [Alchemy::Page]
+      def self.index_page(page)
+        remove_page page
+
+        page.update_pg_search_document
+        page.all_elements.includes(:ingredients, contents: :essence).find_each do |element|
+          element.contents.each do |content|
+            content.essence.update_pg_search_document if Alchemy::PgSearch.is_searchable?(content.essence_type)
+          end
+
+          element.ingredients.each do |ingredient|
+            ingredient.update_pg_search_document if Alchemy::PgSearch.is_searchable?(ingredient.type)
+          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

data/lib/alchemy/pg_search/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
   module PgSearch
-    VERSION = "3.0.0"
+    VERSION = "4.1.0"
   end
 end

data/lib/alchemy-pg_search.rb

@@ -1,23 +1,42 @@
 require "alchemy/pg_search/engine"
 require "alchemy/pg_search/config"
-require "alchemy/pg_search/page_search_scope"
+require "alchemy/pg_search/search"
 
 module Alchemy
   module PgSearch
-    SEARCHABLE_ESSENCES = %w[EssenceText EssenceRichtext EssencePicture]
-    DEFAULT_CONFIG = {
-      page_search_scope: PageSearchScope.new,
-    }
+    SEARCHABLE_INGREDIENTS = %w[Text Richtext Picture]
 
     extend Config
-    self.config = DEFAULT_CONFIG
 
-    def self.is_searchable_essence?(essence_type)
-      SEARCHABLE_ESSENCES.include?(essence_type)
+    ##
+    # is essence or ingredient searchable?
+    # @param essence_type [string]
+    # @return [boolean]
+    def self.is_searchable?(essence_type)
+      SEARCHABLE_INGREDIENTS.include?(essence_type.gsub(/Alchemy::(Essence|Ingredients::)/, ""))
     end
 
+    ##
+    # generate an array of all supported essences classes
+    # @return [array]
     def self.searchable_essence_classes
-      SEARCHABLE_ESSENCES.map { |k| "Alchemy::#{k.classify}".constantize }
+      SEARCHABLE_INGREDIENTS.map { |k| "Alchemy::Essence#{k.classify}".constantize }
+    end
+
+    ##
+    # search for page results
+    #
+    # @param query [string]
+    # @param ability [nil|CanCan::Ability]
+    # @return [ActiveRecord::Relation]
+    def self.search(query, ability: nil)
+      Search.search(query, ability: ability)
+    end
+
+    ##
+    # index all supported Alchemy models
+    def self.rebuild
+      Search.rebuild
     end
   end
 end

data/lib/generators/alchemy/pg_search/install/install_generator.rb

@@ -0,0 +1,25 @@
+require "rails/generators"
+require "rails/generators/active_record/migration"
+
+module Alchemy
+  module PgSearch
+    class InstallGenerator < ::Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      desc "Install Alchemy PgSearch - Gem into Rails App."
+
+      source_root(File.expand_path("../../../..", __dir__))
+
+      def install_migrations
+        # Install pg_search multisearch - migration - the pg_search is not testing if the migration already exists
+        generate("pg_search:migration:multisearch", abort_on_failure: true) unless self.class.migration_exists?("db/migrate", 'create_pg_search_documents')
+
+        # Copy the migrations of the gem
+        rake("alchemy_pg_search:install:migrations", abort_on_failure: true)
+        
+        # run migrations
+        rake("db:migrate", abort_on_failure: true)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-pg_search
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-01 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: pg_search
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +115,17 @@ files:
 - README.md
 - Rakefile
 - alchemy-pg_search.gemspec
+- app/controller/alchemy/pg_search/controller_methods.rb
+- app/extensions/alchemy/pg_search/content_extension.rb
+- app/extensions/alchemy/pg_search/element_extension.rb
+- app/extensions/alchemy/pg_search/essence_picture_extension.rb
+- app/extensions/alchemy/pg_search/essence_richtext_extension.rb
+- app/extensions/alchemy/pg_search/essence_text_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/helpers/alchemy/pg_search/search_helper.rb
+- app/jobs/alchemy/pg_search/index_page_job.rb
 - app/views/alchemy/search/_form.html.erb
 - app/views/alchemy/search/_result.html.erb
 - app/views/alchemy/search/_results.html.erb
@@ -127,17 +137,13 @@ files:
 - 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
 - lib/alchemy-pg_search.rb
 - lib/alchemy/pg_search/config.rb
-- lib/alchemy/pg_search/content_extension.rb
-- lib/alchemy/pg_search/controller_methods.rb
-- lib/alchemy/pg_search/element_extension.rb
 - lib/alchemy/pg_search/engine.rb
-- lib/alchemy/pg_search/page_extension.rb
-- lib/alchemy/pg_search/page_search_scope.rb
+- lib/alchemy/pg_search/search.rb
 - lib/alchemy/pg_search/version.rb
-- lib/generators/alchemy/pg_search/upgrade/templates/migration.rb.tt
-- lib/generators/alchemy/pg_search/upgrade/upgrade_generator.rb
+- lib/generators/alchemy/pg_search/install/install_generator.rb
 - lib/generators/alchemy/pg_search/views/views_generator.rb
 - lib/tasks/alchemy/pg_search_tasks.rake
 homepage: https://alchemy-cms.com

data/lib/alchemy/pg_search/element_extension.rb

@@ -1,53 +0,0 @@
-Alchemy::Element.class_eval do
-  include PgSearch::Model
-
-  pg_search_scope :full_text_search,
-    associated_against: {
-      searchable_essence_texts: :body,
-      searchable_essence_richtexts: :stripped_body,
-      searchable_essence_pictures: :caption,
-    },
-    using: {
-      tsearch: { prefix: true },
-    }
-
-  has_many :searchable_essence_texts,
-    -> {
-      includes(:element)
-        .where(alchemy_contents: { searchable: true })
-        .where(alchemy_elements: { public: true })
-    },
-    class_name: "Alchemy::EssenceText",
-    source_type: "Alchemy::EssenceText",
-    through: :contents,
-    source: :essence
-
-  has_many :searchable_essence_richtexts,
-    -> {
-      includes(:element)
-        .where(alchemy_contents: { searchable: true })
-        .where(alchemy_elements: { public: true })
-    },
-    class_name: "Alchemy::EssenceRichtext",
-    source_type: "Alchemy::EssenceRichtext",
-    through: :contents,
-    source: :essence
-
-  has_many :searchable_essence_pictures,
-    -> {
-      includes(:element)
-        .where(alchemy_contents: { searchable: true })
-        .where(alchemy_elements: { public: true })
-    },
-    class_name: "Alchemy::EssencePicture",
-    source_type: "Alchemy::EssencePicture",
-    through: :contents,
-    source: :essence
-
-  has_many :searchable_contents,
-    -> {
-      where(essence_type: Alchemy::PgSearch::SEARCHABLE_ESSENCES.map { |k| "Alchemy::#{k}" })
-    },
-    class_name: "Alchemy::Content",
-    source: :contents
-end

data/lib/alchemy/pg_search/page_extension.rb

@@ -1,54 +0,0 @@
-# Enable Postgresql full text indexing.
-#
-module Alchemy::PgSearch::PageExtension
-  def self.extended(base)
-    base.include InstanceMethods
-    base.include PgSearch::Model
-
-    base.pg_search_scope(
-      :full_text_search,
-      against: {
-        meta_description: "B",
-        meta_keywords: "B",
-        title: "B",
-        name: "A",
-      },
-      associated_against: {
-        searchable_essence_texts: :body,
-        searchable_essence_richtexts: :stripped_body,
-        searchable_essence_pictures: :caption,
-      },
-      using: {
-        tsearch: { prefix: true },
-      },
-    )
-
-    base.has_many(
-      :searchable_contents,
-      -> {
-        where(alchemy_elements: { public: true })
-          .where(searchable: true)
-      },
-      class_name: "Alchemy::Content",
-      through: :all_elements,
-    )
-
-    Alchemy::PgSearch::SEARCHABLE_ESSENCES.each do |klass|
-      base.has_many(
-        :"searchable_#{klass.underscore.pluralize}",
-        class_name: "Alchemy::#{klass}",
-        source_type: "Alchemy::#{klass}",
-        through: :searchable_contents,
-        source: :essence,
-      )
-    end
-  end
-
-  module InstanceMethods
-    def element_search_results(query)
-      all_elements.full_text_search(query)
-    end
-  end
-
-  Alchemy::Page.extend self
-end

data/lib/alchemy/pg_search/page_search_scope.rb

@@ -1,9 +0,0 @@
-module Alchemy
-  module PgSearch
-    class PageSearchScope
-      def pages
-        Alchemy::Page.published.contentpages.with_language(Alchemy::Language.current.id)
-      end
-    end
-  end
-end

data/lib/generators/alchemy/pg_search/upgrade/templates/migration.rb.tt

@@ -1,31 +0,0 @@
-require 'yaml'
-
-class UpgradeFromAlchemyFerret < ActiveRecord::Migration
-  def up
-    not_searchable_elements.each do |element|
-      element['contents'].each do |content|
-        next unless Alchemy::PgSearch.is_searchable_essence?(content)
-        next if content['searchable'].nil?
-        "Alchemy::#{content['type'].classify}".constantize
-          .joins(content: :element)
-          .where(alchemy_contents: {name: content['name']})
-          .where(alchemy_elements: {name: element['name']})
-          .update_all(searchable: false)
-        say "Sets searchable to false for `#{content['name']}` contents of `#{element['name']}` elements."
-      end
-    end
-  end
-
-  private
-
-  def elements_yml
-    @elements_yml ||= YAML.load_file Rails.root.join('config/alchemy/elements.yml')
-  end
-
-  def not_searchable_elements
-    elements_yml.select do |element|
-      next if !element['contents']
-      element['contents'].any? { |content| content['searchable'] == false }
-    end
-  end
-end

data/lib/generators/alchemy/pg_search/upgrade/upgrade_generator.rb

@@ -1,20 +0,0 @@
-require 'rails'
-
-module Alchemy
-  module PgSearch
-    class UpgradeGenerator < ::Rails::Generators::Base
-      desc "This generator upgrades your project from alchemy-ferret based projects."
-      source_root File.expand_path('templates', File.dirname(__FILE__))
-
-      def replace_element_config
-        gsub_file Rails.root.join('config/alchemy/elements.yml'),
-          'do_not_index: true', 'searchable: false'
-      end
-
-      def copy_migration_file
-        timestamp = Time.now.strftime('%Y%m%d%H%M%S')
-        copy_file "migration.rb.tt", Rails.root.join("db/migrate/#{timestamp}_upgrade_from_alchemy_ferret.alchemy_pg_search.rb")
-      end
-    end
-  end
-end