alchemy-pg_search 5.1.0 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efbd69f49a2b6dd894da769c73bf8336f257d14f1c59b5a6ec3e45cc1f01ba45
-  data.tar.gz: 30712617a4a1142d232da68753c74a71b86c6c9fa8904bca03b461ff980c1fd4
+  metadata.gz: bd79aeea752492e2162f8338e15726c51af184f2ee0025cffd6f7eb98914eb8c
+  data.tar.gz: 5b8bd8894f18350baffdb0537bcbdebc9e781f8aa86251919972b6a076c3171f
 SHA512:
-  metadata.gz: 52d1d223c67ce3edea17aa2c9ab81858102abe50d0e61b8bdf58b48bf208e6ff46914e76dd766bf5b506f1b0e9a374eb341a8638680f972eaf0bbf5022f5531b
-  data.tar.gz: 36b0f2f6fe63cd2a77d2a719d62f80e5f1e09944ed67944304c0017e157f5789ca6bf24803f0891f9a81d6dee332a0d10af9784a195b334ac0b5b6fbf643943b
+  metadata.gz: c0333bfcb6a05dc82aa69c7147429bbe337315d90c61bcbbf3ae6d4ef3d11b28137e934dde2d38f98ce02288dcfb4d08cadc099b6d2d998da0c69abe044d3089
+  data.tar.gz: f1b6ac52bdfc1cb2199344eca5f691c03063b1d9d1a56d28236512621650640390adf093842c8111998992a26bfed2b2927360f2bddcbc286e9bc0910226ec5e

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # 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)

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

@@ -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). 
@@ -153,6 +159,11 @@ place additional elements (maybe a header image or additional text blocks) on th
 # 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

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/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
 

data/lib/alchemy/pg_search/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
   module PgSearch
-    VERSION = "5.1.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.1.0
+  version: 5.2.0
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -163,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - PostgreSQL >= 12.x
-rubygems_version: 3.4.17
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: This gem provides PostgreSQL full text search to Alchemy