alchemy-pg_search 7.4.0 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e00888216dd93910987461a26a8638880587c9ada33cf2406216dea03e05554
-  data.tar.gz: 8c96b6b2bafec9df42017106b016587d62c51b33d462c0674218b39d06168033
+  metadata.gz: 60537a333404a16b364fc265db62b3a5a9ca50c50e84c98261fe3c663b5125ca
+  data.tar.gz: 976c0fa3b5f22cf18afc6f32e7273ad84028a3d3c4a4a4e3cb5a0d5698a94897
 SHA512:
-  metadata.gz: 19e2ac77874ac9a99110419d813f907ee8895f83cfc91140bf3c4af9451e95a722e10e5a87a3379caa30e65bff2c3ba6314e0fe7f719aec5029bd231638de00d
-  data.tar.gz: 7465ebc5e8b3080a3551e686ac31917da67bdd226ebe8e9aee49d15259b2eaa562f7d7ea6f97f387139e94cf28f48f91193af5afc0c0f1c2a7d2117c4c9dd1d6
+  metadata.gz: 8de6e63910d56e7b1aad533a81e8af1fa302a46daeda3a0218ded216b550a7972dec6bb9d5a9b016a3eb26446cbae6519f5cb5dcd84059ee06d425334cc84cd2
+  data.tar.gz: 001ed6c25e6f36737b6dd8cea5d10829ff734a4559cfaa66818ca94ff1b999bd7d7f925f3085b0ca1e0511c470a1865dc6f264693de337bcbc96333686ace593

data/.backportrc.json

@@ -0,0 +1,3 @@
+{
+  "prTitle": "[{{targetBranch}}] {{sourcePullRequest.title}}"
+}

data/.github/workflows/backport.yml

@@ -0,0 +1,46 @@
+name: Backport
+
+on:
+  pull_request_target:
+    types:
+      - closed
+      - labeled
+
+permissions:
+  pull-requests: write
+
+jobs:
+  backport:
+    name: Backport
+    runs-on: ubuntu-24.04
+    # Only react to merged PRs for security reasons.
+    # See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target.
+    if: |
+      github.event.pull_request.merged == true
+      && contains(
+           join(github.event.pull_request.labels.*.name, '---'),
+           'backport'
+         )
+      && (
+        (github.event.action == 'labeled' && startsWith(github.event.label.name, 'backport')) ||
+          (github.event.action == 'closed')
+      )
+    steps:
+      - name: Generate token
+        id: generate_token
+        uses: actions/create-github-app-token@v2
+        with:
+          app-id: ${{ vars.ALCHEMY_BOT_APP_ID }}
+          private-key: ${{ secrets.ALCHEMY_BOT_APP_PRIVATE_KEY }}
+      - name: Backport pull request
+        uses: sorenlouv/backport-github-action@v9.5.1
+        with:
+          github_token: ${{ steps.generate_token.outputs.token }}
+          auto_backport_label_prefix: backport-to-
+          add_original_reviewers: true
+      - name: Info log
+        if: ${{ success() }}
+        run: cat ~/.backport/backport.info.log
+      - name: Debug log
+        if: ${{ failure() }}
+        run: cat ~/.backport/backport.debug.log

data/.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby: ["3.2", "3.4"]
-        alchemy_cms: ["7.4"]
+        alchemy_cms: ["8.2"]
     env:
       RAILS_ENV: test
       ALCHEMY_CMS_VERSION: ${{ matrix.alchemy_cms }}

data/.github/workflows/release.yml

@@ -6,6 +6,7 @@ on:
     types: [closed]
     branches:
       - main
+      - '*-stable'
 
 jobs:
   publish:

data/.gitignore

@@ -15,3 +15,4 @@ yarn.lock
 
 .idea
 .vscode
+.claude/

data/CHANGELOG.md

@@ -1,14 +1,26 @@
 # Changelog
 
-## 7.4.0 (2026-03-17)
+## 8.2.0 (2026-05-22)
 
 ## What's Changed
-* Add reusable release workflows by @tvdeyen in https://github.com/AlchemyCMS/alchemy-pg_search/pull/64
-* Pass rubygems_api_key secret to release workflow by @tvdeyen in https://github.com/AlchemyCMS/alchemy-pg_search/pull/65
-* Update Alchemy to v7.4.x by @sascha-karnatz in https://github.com/AlchemyCMS/alchemy-pg_search/pull/68
+* Add bin/setup script by @sascha-karnatz in https://github.com/AlchemyCMS/alchemy-pg_search/pull/70
+* Upgrade Alchemy v8.0 by @sascha-karnatz in https://github.com/AlchemyCMS/alchemy-pg_search/pull/69
+* Release v8.0.0 by @alchemycms-bot[bot] in https://github.com/AlchemyCMS/alchemy-pg_search/pull/74
+* Start development of version 8.1.0.dev by @alchemycms-bot[bot] in https://github.com/AlchemyCMS/alchemy-pg_search/pull/75
+* Remove AlchemyCMS deprecations by @sascha-karnatz in https://github.com/AlchemyCMS/alchemy-pg_search/pull/76
+* [8.2-stable] Fix not searchable parent pages by @alchemycms-bot[bot] in https://github.com/AlchemyCMS/alchemy-pg_search/pull/79
 
 
-**Full Changelog**: https://github.com/AlchemyCMS/alchemy-pg_search/compare/v6.1.0...v7.4.0
+**Full Changelog**: https://github.com/AlchemyCMS/alchemy-pg_search/compare/v7.4.0...v8.2.0
+
+## 8.0.0 (2026-03-17)
+
+## What's Changed
+* Add bin/setup script by @sascha-karnatz in https://github.com/AlchemyCMS/alchemy-pg_search/pull/70
+* Upgrade Alchemy v8.0 by @sascha-karnatz in https://github.com/AlchemyCMS/alchemy-pg_search/pull/69
+
+
+**Full Changelog**: https://github.com/AlchemyCMS/alchemy-pg_search/compare/v7.4.0...v8.0.0
 
 ## [v6.1.0](https://github.com/AlchemyCMS/alchemy-pg_search/tree/v6.1.0) (2024-12-13)
 

data/Gemfile

@@ -2,8 +2,8 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "rails", "~> 7.1.0"
-gem "alchemy_cms", "~> #{ENV.fetch("ALCHEMY_CMS_VERSION", "7.4")}.0"
+gem "rails", "~> 8.1.0"
+gem "alchemy_cms", "~> #{ENV.fetch("ALCHEMY_CMS_VERSION", "8.2")}.0"
 
 gem "sassc-rails"
 gem "sassc", "~> 2.4.0"

data/README.md

@@ -236,6 +236,16 @@ and reindex your database in your Rails console
 $ Alchemy::PgSearch.rebuild
 ```
 
+## Local Development
+
+Run the setup script to install dependencies and prepare the dummy app:
+
+```shell
+$ bin/setup
+```
+
+This installs gems, runs the Alchemy and PgSearch installers, and clears temporary files.
+
 ## Contributing
 
 1. Fork it

data/alchemy-pg_search.gemspec

@@ -18,7 +18,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", [">= 7.4", "< 8"]
+  spec.add_runtime_dependency "alchemy_cms", [">= 8.2.0", "< 9"]
   spec.add_runtime_dependency "pg_search", ["~> 2.1"]
   spec.add_runtime_dependency "pg"
 

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

@@ -4,16 +4,20 @@ module Alchemy::Search::ElementExtension
   end
 
   def searchable
-    definition.key?(:searchable) ? definition[:searchable] : true
+    definition.searchable
   end
 
   def searchable?
-    searchable && public? && page.searchable? && page_version.public?
+    searchable && public? && page.searchable? && page_version.public? && parent_elements_searchable?
   end
 
   def searchable_content
     ingredients.select(&:searchable?).map(&:searchable_content).join(" ").squish
   end
+
+  def parent_elements_searchable?
+    parent_element.nil? || (parent_element.searchable && parent_element.public? && parent_element.parent_elements_searchable?)
+  end
 end
 
 Alchemy::Element.prepend(Alchemy::Search::ElementExtension)

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

@@ -5,7 +5,7 @@ module Alchemy::Search::IngredientExtension
 
   def searchable?
     Alchemy.searchable_ingredients.has_key?(type.to_sym) &&
-      (definition.key?(:searchable) ? definition[:searchable] : true) &&
+      definition.searchable &&
       !!element&.searchable?
   end
 end

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

@@ -2,12 +2,11 @@
 #
 module Alchemy::Search::PageExtension
   def searchable?
-    (definition.key?(:searchable) ? definition[:searchable] : true) &&
-      searchable && public? && !layoutpage?
+    definition.searchable && searchable && public? && !layoutpage?
   end
 
   def searchable_content
-    all_elements.includes(ingredients: {element: :page}).map(&:searchable_content).join(" ")
+    all_elements.includes(:page, :page_version, {parent_element: :parent_element}, ingredients: {element: :page}).map(&:searchable_content).join(" ")
   end
 end
 

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

@@ -21,17 +21,17 @@ module Alchemy
 
       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?
+          page_definitions = ::Alchemy::PageDefinition.all.select do |page_definition|
+            page_definition.searchresults
           end
 
-          if page_layouts.nil?
+          if page_definitions.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,
+            page_layout: page_definitions.first.name,
+            language_id: ::Alchemy::Current.language.id,
           )
           if page.nil?
             logger.warn "\n++++++\nNo published search result page found. Please create one or publish your search result page.\n++++++\n"

data/bin/setup

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+# path to dummy application root.
+APP_ROOT = File.expand_path("../spec/dummy", __dir__)
+
+# path to alchemy gem
+GEM_ROOT = File.expand_path("../", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir GEM_ROOT do
+  system! "gem install bundler --conservative"
+  system("bundle check") || system!("bundle install")
+end
+
+FileUtils.chdir APP_ROOT do
+  puts "\n== Remove migration files for dummy app =="
+  Dir.glob("db/migrate/*.rb")
+    .reject { |f| f.include?("create_users") || f.include?("pg_search_documents") }
+    .each { |f| FileUtils.rm(f) }
+
+  puts "\n== Create database for dummy app =="
+  system!("bin/rails db:drop")
+  system!("bin/rails db:create")
+
+  puts "\n== Installing Alchemy CMS into dummy app =="
+  system!("bin/rails g alchemy:install --skip --skip-demo-files --auto-accept")
+
+  puts "\n== Installing Alchemy PGSearch into dummy app =="
+  system!("bin/rails g alchemy:pg_search:install")
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "bin/rails log:clear tmp:clear"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! "RAILS_ENV=test bin/rails db:schema:load"
+end
+
+puts "\n== Alchemy PgSearch is ready 🎉 =="

data/lib/alchemy/pg_search/engine.rb

@@ -12,12 +12,12 @@ module Alchemy
         end
 
         # In development environment, this runs on every code reload, so avoid multiple reindexing jobs
-        unless Alchemy.publish_targets.map(&:name).include? 'Alchemy::PgSearch::IndexPageJob'
+        unless Alchemy.config.publish_targets.map(&:name).include? 'Alchemy::PgSearch::IndexPageJob'
           # reindex the page after it was published
-          Alchemy.publish_targets << Alchemy::PgSearch::IndexPageJob
+          Alchemy.config.publish_targets << "Alchemy::PgSearch::IndexPageJob"
         end
         # enable searchable flag in page form
-        Alchemy.enable_searchable = true
+        Alchemy.config.show_page_searchable_checkbox = true
 
         # configure multiselect to find also partial words
         # @link https://github.com/Casecommons/pg_search#searching-using-different-search-features

data/lib/alchemy/pg_search/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
   module PgSearch
-    VERSION = "7.4.0"
+    VERSION = "8.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-pg_search
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 8.2.0
 platform: ruby
 authors:
 - Thomas von Deyen
@@ -15,20 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.4'
+        version: 8.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.4'
+        version: 8.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: pg_search
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".backportrc.json"
+- ".github/workflows/backport.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/post-release.yml"
 - ".github/workflows/prepare-release.yml"
@@ -130,6 +132,7 @@ files:
 - app/views/alchemy/search/_results.html.erb
 - bin/rails
 - bin/rspec
+- bin/setup
 - config/locales/alchemy.search.de.yml
 - config/locales/alchemy.search.en.yml
 - db/migrate/20220826125413_add_page_id_column_to_pg_search_documents.rb
@@ -161,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - PostgreSQL >= 12.x
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: This gem provides PostgreSQL full text search to Alchemy
 test_files: []