alchemy-pg_search 4.2.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b24390ba290061c913ce244c49cf38352d303bbd50e0855d2144517105ce6b53
-  data.tar.gz: 963ed8b25276155ce526186eb07b12b8d616b60df0d0d98100c713ed12eddc1c
+  metadata.gz: efbd69f49a2b6dd894da769c73bf8336f257d14f1c59b5a6ec3e45cc1f01ba45
+  data.tar.gz: 30712617a4a1142d232da68753c74a71b86c6c9fa8904bca03b461ff980c1fd4
 SHA512:
-  metadata.gz: 3acc723b3ae261ae52de6c1d59a6e2f727d870bb6849aa8ec461dd2eceaa8578cbc45df4562b5820316ff948210395921287b8391dc675ddaef8448012c980a9
-  data.tar.gz: b203d53773796999d6f04fd27c8834121e872f359342eeec9cf97737cd487ddae1505f3df8c5f3c83793d9b406ad13f7f88ca1d184d8b1bf72f0d5600c6eb4ea
+  metadata.gz: 52d1d223c67ce3edea17aa2c9ab81858102abe50d0e61b8bdf58b48bf208e6ff46914e76dd766bf5b506f1b0e9a374eb341a8638680f972eaf0bbf5022f5531b
+  data.tar.gz: 36b0f2f6fe63cd2a77d2a719d62f80e5f1e09944ed67944304c0017e157f5789ca6bf24803f0891f9a81d6dee332a0d10af9784a195b334ac0b5b6fbf643943b

data/.github/workflows/ci.yml

@@ -9,7 +9,7 @@ jobs:
       RAILS_ENV: test
     services:
       postgres:
-        image: postgres:11
+        image: postgres:12
         env:
           POSTGRES_USER: postgres
           POSTGRES_PASSWORD: password
@@ -21,7 +21,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: 3.2
           bundler-cache: true
       - name: Prepare database
         run: bundle exec rake alchemy:spec:prepare

data/.gitignore

@@ -6,6 +6,8 @@ Gemfile.lock
 spec/dummy/log/*.log
 spec/dummy/db/*.sqlite3*
 spec/dummy/tmp/*
+spec/dummy/public/*
+spec/dummy/uploads/*
 .ruby-*
 node_modules
 yarn.lock

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [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)
+
+**Merged pull requests:**
+
+- Improve search speed [\#42](https://github.com/AlchemyCMS/alchemy-pg_search/pull/42) ([sascha-karnatz](https://github.com/sascha-karnatz))
+- Make migrations more error tolerant [\#41](https://github.com/AlchemyCMS/alchemy-pg_search/pull/41) ([sascha-karnatz](https://github.com/sascha-karnatz))
+
+## [v5.0.0](https://github.com/AlchemyCMS/alchemy-pg_search/tree/v5.0.0) (2023-09-01)
+
+[Full Changelog](https://github.com/AlchemyCMS/alchemy-pg_search/compare/v4.2.0...v5.0.0)
+
+**Merged pull requests:**
+
+- Update to Alchemy 7.0 [\#39](https://github.com/AlchemyCMS/alchemy-pg_search/pull/39) ([sascha-karnatz](https://github.com/sascha-karnatz))
+
 ## [v4.2.0](https://github.com/AlchemyCMS/alchemy-pg_search/tree/v4.2.0) (2023-01-23)
 
 [Full Changelog](https://github.com/AlchemyCMS/alchemy-pg_search/compare/v4.1.1...v4.2.0)

data/Gemfile

@@ -2,13 +2,11 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "rails", "~> 6.0.0"
-ENV.fetch("ALCHEMY_BRANCH", "6.1-stable").tap do |branch|
-  gem "alchemy_cms", github: "AlchemyCMS/alchemy_cms", branch: branch
-end
+gem "rails", "~> 7.0.0"
+gem "alchemy_cms", "~> 7.0.0"
+
 gem "sassc-rails"
 gem "sassc", "~> 2.4.0"
-gem "webpacker"
 gem "pg", "~> 1.0"
 gem "puma"
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014, magic labs GmbH
+Copyright (c) Blish GmbH
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/README.md

@@ -4,6 +4,12 @@
 
 This gem provides full text search for projects using postgresql databases to Alchemy CMS 6.0 and above.
 
+## Requirements
+
+* Ruby 3.0 or newer
+* Alchemy CMS 7.0 or newer
+* PostgreSQL 12.x or newer
+
 ## Installation
 
 Add this line to your application's `Gemfile`:
@@ -24,9 +30,15 @@ Run install script:
 $ bin/rails g alchemy:pg_search:install
 ```
 
+> [!NOTE]  
+> The installation will generate an autogenerated column which can be configured with a language. The default
+> value should work for the most languages. If you wish to change this behavior you should add
+> the `Alchemy::PgSearch.config`
+> into the project initializer before running the install script. (See [Configure Behavior](#configure-behavior))
+
 ## Usage
 
-Every `EssenceText`, `EssenceRichtext` and `EssencePicture` will be indexed unless you tell Alchemy to not index a specific content.
+Every `Ingredient` will be indexed unless you tell Alchemy to not index a specific content.
 
 ### Disable Indexing
 
@@ -51,7 +63,7 @@ Pass `searchable: false` to your element definitions and Alchemy will not index
 - name: secret_sauce
   searchable: false
   ingredients:
-    - name: sauce
+    - role: sauce
       type: Text
       default: 'This is my secret sauce.'
 ```
@@ -63,9 +75,9 @@ Pass `searchable: false` to your content definitions and Alchemy will not index
 ```yaml
 # elements.yml
 - name: secrets
-  contents:
-    - name: passwords
-      type: EssenceText
+  ingredients:
+    - role: passwords
+      type: Text
       searchable: false
       default: 'This is my secret password.'
 ```
@@ -76,7 +88,7 @@ The same works for `ingredients` as well
 # elements.yml
 - name: secrets
   ingredients:
-    - name: passwords
+    - role: passwords
       type: Text
       searchable: false
       default: 'This is my secret password.'
@@ -88,10 +100,16 @@ Configure the gem in an initializer. The default configurations are:
 
 ```ruby
 Alchemy::PgSearch.config = {
-  paginate_per: 10, # amount of results per page
+  dictionary: 'simple',
+  paginate_per: 10
 }
 ```
 
+ 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). 
+ paginate_per       | 10            | Amount of results per page. The value can be set to `nil` to disable the pagination.                                                                                                                                                                                                                        
+
 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).
 
@@ -107,7 +125,8 @@ end
 
 ### Rendering search results.
 
-In order to render the search results, you'll need a page layout that represents the search result page. Simply mark a page layout as `searchresults: true`. The search form will pick this page as result page.
+In order to render the search results, you'll need a page layout that represents the search result page. Simply mark a
+page layout as `searchresults: true`. The search form will pick this page as result page.
 
 #### Search Results Page
 
@@ -118,7 +137,8 @@ In order to render the search results, you'll need a page layout that represents
   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.
+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.
 
 ```yaml
 # page_layouts.yml
@@ -126,16 +146,17 @@ Tip: For maximum flexibility you could also add an element that represents the s
   searchresults: true
   unique: true
   elements:
-  - searchresults
+    - searchresults
   autogenerate:
-  - searchresults
+    - searchresults
 
 # elements.yml
 - name: searchresults
   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 and the search results on the element
+view partial.
 
 ### View Helpers
 

data/alchemy-pg_search.gemspec

@@ -12,11 +12,13 @@ Gem::Specification.new do |spec|
   spec.summary = "This gem provides PostgreSQL full text search to Alchemy"
   spec.homepage = "https://alchemy-cms.com"
   spec.license = "BSD-3-Clause"
+  spec.required_ruby_version = ">= 3.0.0"
+  spec.requirements << 'PostgreSQL >= 12.x'
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "alchemy_cms", [">= 6.1", "< 7"]
+  spec.add_runtime_dependency "alchemy_cms", [">= 7.0", "< 8"]
   spec.add_runtime_dependency "pg_search", ["~> 2.1"]
   spec.add_runtime_dependency "pg"
 

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

@@ -1,13 +1,18 @@
 module Alchemy::PgSearch::IngredientExtension
-  def self.prepended(base)
-    base.include PgSearch::Model
-    base.multisearchable(
+
+  def self.multisearch_config
+    {
       against: [
         :value,
       ],
       additional_attributes: ->(ingredient) { { page_id: ingredient.element.page.id } },
-      if: :searchable?,
-    )
+      if: :searchable?
+    }
+  end
+
+  def self.prepended(base)
+    base.include PgSearch::Model
+    base.multisearchable(multisearch_config)
   end
 
   def searchable?
@@ -17,4 +22,8 @@ module Alchemy::PgSearch::IngredientExtension
   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 +1,5 @@
-class AddSearchableToAlchemyEssenceTexts < ActiveRecord::Migration[5.1]
+class AddSearchableToAlchemyEssenceTexts < ActiveRecord::Migration[6.1]
   def change
-    add_column :alchemy_essence_texts, :searchable, :boolean, default: true
+    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 +1,5 @@
-class AddSearchableToAlchemyEssenceRichtexts < ActiveRecord::Migration[5.1]
+class AddSearchableToAlchemyEssenceRichtexts < ActiveRecord::Migration[6.1]
   def change
-    add_column :alchemy_essence_richtexts, :searchable, :boolean, default: true
+    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 +1,5 @@
-class AddSearchableToAlchemyEssencePictures < ActiveRecord::Migration[5.1]
+class AddSearchableToAlchemyEssencePictures < ActiveRecord::Migration[6.1]
   def change
-    add_column :alchemy_essence_pictures, :searchable, :boolean, default: true
+    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,5 +1,9 @@
-class MoveSearchableToContents < ActiveRecord::Migration[5.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
 
     {

data/db/migrate/20220826125413_add_page_id_column_to_pg_search_documents.rb

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

data/db/migrate/20231218165617_add_searchable_content.rb

@@ -0,0 +1,9 @@
+class AddSearchableContent < ActiveRecord::Migration[7.0]
+  def change
+    add_column :pg_search_documents, :searchable_content, :virtual,
+      type: :tsvector,
+      as: "to_tsvector('#{Alchemy::PgSearch.config.fetch(:dictionary, "simple")}', coalesce(content, ''))",
+      stored: true,
+      if_not_exists: true
+  end
+end

data/lib/alchemy/pg_search/config.rb

@@ -2,6 +2,7 @@ module Alchemy
   module PgSearch
     module Config
       @@config = {
+        dictionary: 'simple',
         paginate_per: 10
       }
 

data/lib/alchemy/pg_search/engine.rb

@@ -24,7 +24,11 @@ module Alchemy
         # @link https://github.com/Casecommons/pg_search#searching-using-different-search-features
         ::PgSearch.multisearch_options = {
           using: {
-            tsearch: { prefix: true }
+            tsearch: {
+              prefix: true,
+              dictionary: Alchemy::PgSearch.config.fetch(:dictionary, "simple"),
+              tsvector_column: 'searchable_content'
+            }
           }
         }
       end

data/lib/alchemy/pg_search/search.rb

@@ -5,7 +5,7 @@ module Alchemy
       ##
       # index all supported Alchemy models
       def self.rebuild
-        ([Alchemy::Page, Alchemy::Ingredient] + Alchemy::PgSearch.searchable_essence_classes).each do |model|
+        [Alchemy::Page, Alchemy::Ingredient].each do |model|
           ::PgSearch::Multisearch.rebuild(model)
         end
       end
@@ -19,20 +19,16 @@ module Alchemy
       end
 
       ##
-      # index a single page and indexable essences
+      # 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, 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)
+        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

data/lib/alchemy/pg_search/version.rb

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

data/lib/alchemy-pg_search.rb

@@ -9,18 +9,11 @@ module Alchemy
     extend Config
 
     ##
-    # is essence or ingredient searchable?
-    # @param essence_type [string]
+    # is ingredient searchable?
+    # @param ingredient_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_INGREDIENTS.map { |k| "Alchemy::Essence#{k.classify}".constantize }
+    def self.is_searchable?(ingredient_type)
+      SEARCHABLE_INGREDIENTS.include?(ingredient_type.gsub(/Alchemy::Ingredients::/, ""))
     end
 
     ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-pg_search
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-23 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: pg_search
   requirement: !ruby/object:Gem::Requirement
@@ -116,11 +116,7 @@ files:
 - 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
@@ -138,6 +134,7 @@ files:
 - 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
 - lib/alchemy-pg_search.rb
 - lib/alchemy/pg_search/config.rb
 - lib/alchemy/pg_search/engine.rb
@@ -158,14 +155,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
-rubygems_version: 3.1.6
+requirements:
+- PostgreSQL >= 12.x
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: This gem provides PostgreSQL full text search to Alchemy

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

@@ -1,19 +0,0 @@
-module Alchemy::PgSearch::ContentExtension
-  module ClassMethods
-    def new(attributes)
-      super.tap do |content|
-        content.searchable = content.definition.key?(:searchable) ? content.definition[:searchable] : true
-      end
-    end
-
-    Alchemy::Content.singleton_class.prepend self
-  end
-
-  module InstanceMethods
-    def searchable?
-      searchable && element.searchable?
-    end
-
-    Alchemy::Content.prepend self
-  end
-end

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

@@ -1,19 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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)
-