alchemy-pg_search 5.0.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1896b14c7a0f65b1b14ca0f2de751ee14c68219bbd24893f6561725ab69fd622
-  data.tar.gz: 8e5759cd3d6f12f57c544ba5a2290d98f5600808f61b9e03e9ae3530a9e6aaaf
+  metadata.gz: bd79aeea752492e2162f8338e15726c51af184f2ee0025cffd6f7eb98914eb8c
+  data.tar.gz: 5b8bd8894f18350baffdb0537bcbdebc9e781f8aa86251919972b6a076c3171f
 SHA512:
-  metadata.gz: 6fb5a90e1e4a562dd4c71cabbb91dc173be473e2eb2100fe83b0d317f6c6120bf2af66589a369fd0a39355f3996811e80e2399320c7e19c44eb6f1ac8e5c0830
-  data.tar.gz: cc3d81d2e4e798b57e47109890b8e97f40a12c16e33446887789ee3f5aa377d68ab4c58430834adfc2e75f2b12f4a57afa6348d2372af9464a91658dc5d84570
+  metadata.gz: c0333bfcb6a05dc82aa69c7147429bbe337315d90c61bcbbf3ae6d4ef3d11b28137e934dde2d38f98ce02288dcfb4d08cadc099b6d2d998da0c69abe044d3089
+  data.tar.gz: f1b6ac52bdfc1cb2199344eca5f691c03063b1d9d1a56d28236512621650640390adf093842c8111998992a26bfed2b2927360f2bddcbc286e9bc0910226ec5e

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

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [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)
+
+**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)

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/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,6 +30,12 @@ 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 `Ingredient` will be indexed unless you tell Alchemy to not index a specific content.
@@ -87,11 +99,23 @@ The same works for `ingredients` as well
 Configure the gem in an initializer. The default configurations are:
 
 ```ruby
-Alchemy::PgSearch.config = {
-  paginate_per: 10, # amount of results per page
-}
+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). 
+ 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 +131,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 +143,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 +152,22 @@ 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
+  ingredients:
+    - role: search_string
+      hint: The is only for presentational purposes in the Alchemy preview
+      default: lorem
+      type: Text
 ```
 
-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,6 +12,8 @@ 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"]

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

@@ -34,9 +34,7 @@ module Alchemy
       # @see Alchemy::PagesHelper#render_search_form
       #
       def perform_search
-        if self.class == Alchemy::Admin::PagesController && params[:query].blank?
-          params[:query] = "lorem"
-        end
+        set_preview_query
         return if params[:query].blank?
         @search_results = search_results
         if paginate_per
@@ -83,6 +81,16 @@ module Alchemy
       def paginate_per
         Alchemy::PgSearch.config[:paginate_per]
       end
+
+      private
+
+      def set_preview_query
+        if self.class == Alchemy::Admin::PagesController && params[:query].blank?
+          element = search_result_page.draft_version.elements.named(:searchresults).first
+          
+          params[:query] = element&.value_for("search_string") || "lorem"
+        end
+      end
     end
   end
 end

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

@@ -12,11 +12,14 @@ module Alchemy
         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
+        Alchemy::PagesController.send(:include, Alchemy::PgSearch::ControllerMethods)
+        Alchemy::Admin::PagesController.send(:include, Alchemy::PgSearch::ControllerMethods)
 
+        # 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
 
@@ -24,7 +27,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/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
   module PgSearch
-    VERSION = "5.0.0"
+    VERSION = "5.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-pg_search
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-01 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -134,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
@@ -154,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.4.17
+requirements:
+- PostgreSQL >= 12.x
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: This gem provides PostgreSQL full text search to Alchemy